Skip to content

Commit 2bb9227

Browse files
committed
[DOCS] Merges duplicate pages for PKI realms (#49206)
1 parent 748db0a commit 2bb9227

File tree

4 files changed

+27
-49
lines changed

4 files changed

+27
-49
lines changed

docs/reference/redirects.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -986,4 +986,13 @@ See:
986986
* {packetbeat-ref}/securing-beats.html[{packetbeat}]
987987
* {winlogbeat-ref}/securing-beats.html[{winlogbeat}]
988988

989+
[role="exclude",id="configuring-pki-realm"]
990+
=== Configuring a PKI realm
991+
992+
See <<pki-realm>>.
993+
994+
[role="exclude",id="pki-settings"]
995+
==== PKI realm settings
996+
997+
See <<ref-pki-settings>>.
989998

x-pack/docs/en/security/authentication/configuring-pki-realm.asciidoc

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,13 @@
1-
[role="xpack"]
2-
[[configuring-pki-realm]]
3-
=== Configuring a PKI realm
4-
5-
You can configure {es} to use Public Key Infrastructure (PKI) certificates to
6-
authenticate users. This requires clients connecting directly to {es} to
7-
present X.509 certificates. The certificates must first be accepted for
8-
authentication on the SSL/TLS layer on {es}. Only then they are optionally
9-
further validated by a PKI realm.
10-
11-
Users may also use PKI certificates to authenticate to {kib}, however this
12-
requires some <<pki-realm-for-proxied-clients,additional configuration>>. On
13-
{es}, this configuration enables {kib} to act as a proxy for SSL/TLS
14-
authentication and to submit the client certificates to {es} for further
15-
validation by a PKI realm.
16-
17-
For more general information, see <<pki-realm>>.
18-
19-
[float]
20-
[role="xpack"]
211
[[pki-realm-for-direct-clients]]
222
==== PKI authentication for clients connecting directly to {es}
233

244
To use PKI in {es}, you configure a PKI realm, enable client authentication on
25-
the desired network layers (transport or http), and map the Distinguished Name
26-
(DN) from the Subject field in the user certificate to roles by using the
27-
<<security-api-role-mapping,role-mapping API>> or the role-mapping file.
5+
the desired network layers (transport or http), and map the Distinguished Names
6+
(DNs) from the Subject field in the user certificates to roles. You create the mappings in a role mapping file or use the role mappings API.
7+
8+
If you want the same users to also be authenticated using certificates when they connect to {kib}, you must configure the {es} PKI realm to
9+
<<pki-realm-for-proxied-clients,allow delegation>> and to
10+
{kibana-ref}/kibana-authentication.html#pki-authentication[enable PKI authentication in {kib}].
2811

2912
You can also use a combination of PKI and username/password authentication. For
3013
example, you can enable SSL/TLS on the transport layer and define a PKI realm to
@@ -216,8 +199,6 @@ alternative to role mapping.
216199

217200
--
218201

219-
[float]
220-
[role="xpack"]
221202
[[pki-realm-for-proxied-clients]]
222203
==== PKI authentication for clients connecting to {kib}
223204

@@ -288,4 +269,3 @@ PUT /_security/role_mapping/direct_pki_only
288269

289270
<1> only when this metadata field is set (it is *not* `null`) the user has been
290271
authenticated in the delegation scenario.
291-

x-pack/docs/en/security/authentication/pki-realm.asciidoc

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,16 @@
22
[[pki-realm]]
33
=== PKI user authentication
44

5-
You can configure {stack} {security-features} to use Public Key Infrastructure
6-
(PKI) certificates to authenticate users in {es}. This requires clients to
7-
present X.509 certificates.
5+
You can configure {es} to use Public Key Infrastructure (PKI) certificates to
6+
authenticate users. This requires clients connecting directly to {es} to
7+
present X.509 certificates. The certificates must first be accepted for
8+
authentication on the SSL/TLS layer on {es}. Only then they are optionally
9+
further validated by a PKI realm. See <<pki-realm-for-direct-clients>>.
810

9-
You can use PKI certificates to authenticate users in {es} as well as {kib}.
11+
You can also use PKI certificates to authenticate to {kib}, however this
12+
requires some additional configuration. On {es}, this configuration enables {kib}
13+
to act as a proxy for SSL/TLS authentication and to submit the client
14+
certificates to {es} for further validation by a PKI realm. See
15+
<<pki-realm-for-proxied-clients>>.
1016

11-
To use PKI in {es}, you configure a PKI realm, enable client authentication on
12-
the desired network layers (transport or http), and map the Distinguished Names
13-
(DNs) from the user certificates to roles. You create the mappings in a <<pki-role-mapping, role
14-
mapping file>> or use the {ref}/security-api-put-role-mapping.html[create role mappings API]. If you want the same users to also be
15-
authenticated using certificates when they connect to {kib}, you must configure the {es} PKI
16-
realm to
17-
{ref}/configuring-pki-realm.html#pki-realm-for-proxied-clients[allow
18-
delegation] and to
19-
{kibana-ref}/kibana-authentication.html#pki-authentication[enable PKI
20-
authentication in {kib}].
21-
22-
See also {ref}/configuring-pki-realm.html[Configuring a PKI realm].
23-
24-
[[pki-settings]]
25-
==== PKI realm settings
26-
27-
See {ref}/security-settings.html#ref-pki-settings[PKI realm settings].
17+
include::configuring-pki-realm.asciidoc[]

x-pack/docs/en/security/configuring-es.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ your subscription. For more information, see https://www.elastic.co/subscription
7777
** <<kerberos-realm,Kerberos realms>>
7878
** <<ldap-realm,LDAP realms>>
7979
** <<native-realm,Native realms>>
80-
** <<configuring-pki-realm,PKI realms>>
80+
** <<pki-realm,PKI realms>>
8181
** <<saml-realm,SAML realms>>
8282

8383
. Set up roles and users to control access to {es}.
@@ -140,7 +140,6 @@ To walk through the configuration of {security-features} in {es}, {kib}, {ls}, a
140140

141141
include::securing-communications/separating-node-client-traffic.asciidoc[]
142142
include::authentication/configuring-active-directory-realm.asciidoc[]
143-
include::authentication/configuring-pki-realm.asciidoc[]
144143

145144
include::reference/files.asciidoc[]
146145
include::fips-140-compliance.asciidoc[]

0 commit comments

Comments
 (0)