Skip to content

Commit 7b2f43d

Browse files
committed
[DOCS] Adds native realm security settings (#30186)
1 parent 286844b commit 7b2f43d

File tree

2 files changed

+57
-68
lines changed

2 files changed

+57
-68
lines changed

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

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[[native-realm]]
2-
=== Native User Authentication
2+
=== Native user authentication
33

44
The easiest way to manage and authenticate users is with the internal `native`
55
realm. You can use the REST APIs or Kibana to add and remove users, assign user roles, and
66
manage user passwords.
77

88
[[native-realm-configuration]]
99
[float]
10-
==== Configuring a Native Realm
10+
==== Configuring a native realm
1111

1212
The native realm is added to the realm chain by default. You don't need to
1313
explicitly configure a native realm to manage users through the REST APIs.
@@ -47,45 +47,12 @@ xpack:
4747
. Restart Elasticsearch.
4848

4949
[[native-settings]]
50-
.Native Realm Settings
51-
[cols="4,^3,10"]
52-
|=======================
53-
| Setting | Required | Description
54-
55-
| `type` | yes | Indicates the realm type. Must be set to `native`.
56-
57-
| `order` | no | Indicates the priority of this realm within
58-
the realm chain. Realms with a lower order
59-
are consulted first. Although not required,
60-
we recommend explicitly setting this value
61-
when you configure multiple realms. Defaults
62-
to `Integer.MAX_VALUE`.
63-
64-
| `enabled` | no | Indicates whether this realm is enabled or
65-
disabled. When set to `false`, the realm is
66-
not added to the realm chain and therefore
67-
is inactive. Defaults to `true`.
68-
69-
| `cache.ttl` | no | Specifies the time-to-live for cached user
70-
entries. A user's credentials are cached for
71-
this period of time. Specify the time period
72-
using the standard Elasticsearch
73-
{ref}/common-options.html#time-units[time units].
74-
Defaults to `20m`.
75-
76-
| `cache.max_users` | no | Specifies the maximum number of user entries
77-
that can be cached at any given time. Defaults
78-
to 100,000.
79-
80-
| `cache.hash_algo` | no | Specifies the hashing algorithm that is used
81-
for the cached user credentials. See
82-
<<cache-hash-algo, Cache hash algorithms>>
83-
for the possible values. (Expert Setting)
84-
|=======================
50+
==== Native realm settings
8551

52+
See {ref}/ref-native-settings.html[Native Realm Settings].
8653

8754
[[managing-native-users]]
88-
==== Managing Native Users
55+
==== Managing native users
8956

9057
{security} enables you to easily manage users in {kib} on the
9158
*Management / Security / Users* page.

x-pack/docs/en/settings/security-settings.asciidoc

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[role="xpack"]
22
[[security-settings]]
3-
=== Security Settings in Elasticsearch
3+
=== Security settings in {es}
44
++++
5-
<titleabbrev>Security Settings</titleabbrev>
5+
<titleabbrev>Security settings</titleabbrev>
66
++++
77

88
By default, {security} is disabled when you have a basic or trial license. To
@@ -23,14 +23,14 @@ For more information about creating and updating the {es} keystore, see
2323

2424
[float]
2525
[[general-security-settings]]
26-
==== General Security Settings
26+
==== General security settings
2727
`xpack.security.enabled`::
2828
Set to `true` to enable {security} on the node. +
2929
+
3030
If set to `false`, which is the default value for basic and trial licenses,
3131
{security} is disabled. It also affects all {kib} instances that connect to this
3232
{es} instance; you do not need to disable {security} in those `kibana.yml` files.
33-
For more information about disabling {security} in specific {kib} instances, see {kibana-ref}/security-settings-kb.html[{kib} Security Settings].
33+
For more information about disabling {security} in specific {kib} instances, see {kibana-ref}/security-settings-kb.html[{kib} security settings].
3434

3535
`xpack.security.hide_settings`::
3636
A comma-separated list of settings that are omitted from the results of the
@@ -42,16 +42,16 @@ sensitive nature of the information.
4242

4343
[float]
4444
[[password-security-settings]]
45-
==== Default Password Security Settings
45+
==== Default password security settings
4646
`xpack.security.authc.accept_default_password`::
4747
In `elasticsearch.yml`, set this to `false` to disable support for the default "changeme" password.
4848

4949
[float]
5050
[[anonymous-access-settings]]
51-
==== Anonymous Access Settings
52-
53-
For more information, see {xpack-ref}/anonymous-access.html[
54-
Enabling Anonymous Access].
51+
==== Anonymous access settings
52+
You can configure the following anonymous access settings in
53+
`elasticsearch.yml`. For more information, see {xpack-ref}/anonymous-access.html[
54+
Enabling anonymous access].
5555

5656
`xpack.security.authc.anonymous.username`::
5757
The username (principal) of the anonymous user. Defaults to `_es_anonymous_user`.
@@ -69,20 +69,20 @@ access. Defaults to `true`.
6969

7070
[float]
7171
[[field-document-security-settings]]
72-
==== Document and Field Level Security Settings
72+
==== Document and field level security settings
7373

7474
You can set the following document and field level security
7575
settings in `elasticsearch.yml`. For more information, see
76-
{xpack-ref}/field-and-document-access-control.html[Setting Up Document and Field
77-
Level Security].
76+
{xpack-ref}/field-and-document-access-control.html[Setting up document and field
77+
level security].
7878

7979
`xpack.security.dls_fls.enabled`::
8080
Set to `false` to prevent document and field level security
8181
from being configured. Defaults to `true`.
8282

8383
[float]
8484
[[token-service-settings]]
85-
==== Token Service Settings
85+
==== Token service settings
8686

8787
`xpack.security.authc.token.enabled`::
8888
Set to `false` to disable the built-in token service. Defaults to `true` unless
@@ -102,7 +102,7 @@ The length of time that a token is valid for. By default this value is `20m` or
102102

103103
[float]
104104
[[realm-settings]]
105-
==== Realm Settings
105+
==== Realm settings
106106

107107
You configure realm settings in the `xpack.security.authc.realms`
108108
namespace in `elasticsearch.yml`. For example:
@@ -129,10 +129,11 @@ xpack.security.authc.realms:
129129
----------------------------------------
130130

131131
The valid settings vary depending on the realm type. For more
132-
information, see {xpack-ref}/setting-up-authentication.html[Setting Up Authentication].
132+
information, see {xpack-ref}/setting-up-authentication.html[Setting up authentication].
133133

134134
[float]
135-
===== Settings Valid for All Realms
135+
[[ref-realm-settings]]
136+
===== Settings valid for all realms
136137

137138
`type`::
138139
The type of the realm: `native, `ldap`, `active_directory`, `pki`, or `file`. Required.
@@ -146,10 +147,31 @@ recommended when you configure multiple realms. Defaults to `Integer.MAX_VALUE`.
146147
Indicates whether a realm is enabled. You can use this setting to disable a
147148
realm without removing its configuration information. Defaults to `true`.
148149

150+
[[ref-native-settings]]
151+
[float]
152+
===== Native realm settings
153+
154+
For a native realm, the `type` must be set to `native`. In addition to the
155+
<<ref-realm-settings,settings that are valid for all realms>>, you can specify
156+
the following optional settings:
157+
158+
`cache.ttl`:: The time-to-live for cached user entries. User credentials are
159+
cached for this period of time. Specify the time period using the standard
160+
{es} <<time-units,time units>>. Defaults to `20m`.
161+
162+
`cache.max_users`:: The maximum number of user entries that can live in the
163+
cache at any given time. Defaults to 100,000.
164+
165+
`cache.hash_algo`:: (Expert Setting) The hashing algorithm that is used for the
166+
in-memory cached user credentials. For possible values, see
167+
{xpack-ref}/controlling-user-cache.html[Cache hash algorithms]. Defaults to
168+
`ssha256`.
169+
170+
149171
[[ref-users-settings]]
150172

151173
[float]
152-
===== File Realm Settings
174+
===== File realm settings
153175

154176
`cache.ttl`::
155177
The time-to-live for cached user entries--user credentials are cached for
@@ -168,7 +190,7 @@ all possible values. Defaults to `ssha256`.
168190

169191
[[ref-ldap-settings]]
170192
[float]
171-
===== LDAP Realm Settings
193+
===== LDAP realm settings
172194

173195
`url`::
174196
An LDAP URL in the format `ldap[s]://<server>:<port>`. Required.
@@ -399,7 +421,7 @@ table for all possible values). Defaults to `ssha256`.
399421

400422
[[ref-ad-settings]]
401423
[float]
402-
===== Active Directory Realm Settings
424+
===== Active Directory realm settings
403425

404426
`url`::
405427
A URL in the format `ldap[s]://<server>:<port>`. Defaults to `ldap://<domain_name>:389`.
@@ -611,7 +633,7 @@ the in-memory cached user credentials (see {xpack-ref}/controlling-user-cache.ht
611633

612634
[[ref-pki-settings]]
613635
[float]
614-
===== PKI Realm Settings
636+
===== PKI realm settings
615637

616638
`username_pattern`::
617639
The regular expression pattern used to extract the username from the
@@ -657,7 +679,7 @@ Defaults to `100000`.
657679

658680
[[ref-saml-settings]]
659681
[float]
660-
===== SAML Realm Settings
682+
===== SAML realm settings
661683

662684
`idp.entity_id`::
663685
The Entity ID of the SAML Identity Provider
@@ -922,11 +944,11 @@ cipher suites that should be supported.
922944

923945
[float]
924946
[[ssl-tls-settings]]
925-
==== Default TLS/SSL Settings
947+
==== Default TLS/SSL settings
926948

927949
You can configure the following TLS/SSL settings in
928950
`elasticsearch.yml`. For more information, see
929-
{xpack-ref}/encrypting-communications.html[Encrypting Communications]. These settings will be used
951+
{xpack-ref}/encrypting-communications.html[Encrypting communications]. These settings will be used
930952
for all of {xpack} unless they have been overridden by more specific
931953
settings such as those for HTTP or Transport.
932954

@@ -969,7 +991,7 @@ Jurisdiction Policy Files_ has been installed, the default value also includes `
969991

970992
[float]
971993
[[tls-ssl-key-settings]]
972-
===== Default TLS/SSL Key and Trusted Certificate Settings
994+
===== Default TLS/SSL key and trusted certificate settings
973995

974996
The following settings are used to specify a private key, certificate, and the
975997
trusted certificates that should be used when communicating over an SSL/TLS connection.
@@ -979,7 +1001,7 @@ trusted along with the certificate(s) from the <<tls-ssl-key-settings, key setti
9791001
for connections that require client authentication or when acting as a SSL enabled server.
9801002

9811003
[float]
982-
===== PEM Encoded Files
1004+
===== PEM encoded files
9831005

9841006
When using PEM encoded files, use the following settings:
9851007

@@ -1002,7 +1024,7 @@ that will be presented to clients when they connect.
10021024
List of paths to the PEM encoded certificate files that should be trusted.
10031025

10041026
[float]
1005-
===== Java Keystore Files
1027+
===== Java keystore files
10061028

10071029
When using Java keystore files (JKS), which contain the private key, certificate
10081030
and certificates that should be trusted, use the following settings:
@@ -1033,7 +1055,7 @@ Password to the truststore.
10331055
Password to the truststore.
10341056

10351057
[float]
1036-
===== PKCS#12 Files
1058+
===== PKCS#12 files
10371059

10381060
When using PKCS#12 container files (`.p12` or `.pfx`), which contain the
10391061
private key, certificate, and certificates that should be trusted, use
@@ -1090,7 +1112,7 @@ include::ssl-settings.asciidoc[]
10901112

10911113
[[ssl-tls-profile-settings]]
10921114
[float]
1093-
===== Transport Profile TLS/SSL Settings
1115+
===== Transport profile TLS/SSL settings
10941116

10951117
The same settings that are available for the <<transport-tls-ssl-settings, default transport>>
10961118
are also available for each transport profile. By default, the settings for a
@@ -1105,9 +1127,9 @@ setting, this would be `transport.profiles.$PROFILE.xpack.security.ssl.key`.
11051127

11061128
[float]
11071129
[[ip-filtering-settings]]
1108-
==== IP Filtering Settings
1130+
==== IP filtering settings
11091131

1110-
You can configure the following settings for {xpack-ref}/ip-filtering.html[IP filtering]:
1132+
You can configure the following settings for {xpack-ref}/ip-filtering.html[IP filtering].
11111133

11121134
`xpack.security.transport.filter.allow`::
11131135
List of IP addresses to allow.

0 commit comments

Comments
 (0)