Skip to content

Commit a6c450a

Browse files
authored
Minor doc fixes for PKI realm (#103831) (#104143)
Remove the reference to the transport client and clarify the usage of username_pattern
1 parent e3edb22 commit a6c450a

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

docs/reference/security/authentication/configuring-pki-realm.asciidoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ the desired network layers (transport or http), and map the Distinguished Names
66
(DNs) from the Subject field in the user certificates to roles. You create the
77
mappings in a role mapping file or use the role mappings API.
88

9-
TIP: You can use a combination of PKI and username/password authentication. For
10-
example, you can enable SSL/TLS on the transport layer and define a PKI realm to
11-
require transport clients to authenticate with X.509 certificates, while still
12-
authenticating HTTP traffic using username and password credentials.
13-
149
. Add a realm configuration for a `pki` realm to `elasticsearch.yml` under the
1510
`xpack.security.authc.realms.pki` namespace. You must explicitly set the `order`
1611
attribute. See <<ref-pki-settings>> for all of the options you can set for a
@@ -42,7 +37,8 @@ realms you specify are used for authentication. If you also want to use the
4237

4338
--
4439

45-
. Optional: If you want to use something other than the CN of the Subject DN as
40+
. Optional: The username is defined by the <<ref-pki-settings, username_pattern>>.
41+
If you want to use something other than the CN of the Subject DN as
4642
the username, you can specify a regex to extract the desired username. The regex
4743
is applied on the Subject DN.
4844
+

docs/reference/settings/security-settings.asciidoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,8 +1010,10 @@ the following settings:
10101010
`username_pattern`::
10111011
(<<static-cluster-setting,Static>>)
10121012
The regular expression pattern used to extract the username from the
1013-
certificate DN. The first match group is the used as the username.
1014-
Defaults to `CN=(.*?)(?:,\|$)`.
1013+
certificate DN. The username is used for auditing and logging. The username can also be used
1014+
with the <<role-mapping-resources, role mapping API>> and <<configuring-authorization-delegation, authorization delegation>>.
1015+
The first match group is the used as the username.
1016+
Defaults to `CN=(.*?)(?:,|$)`.
10151017

10161018
`certificate_authorities`::
10171019
(<<static-cluster-setting,Static>>)

0 commit comments

Comments
 (0)