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
88By 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`::
2828Set to `true` to enable {security} on the node. +
2929+
3030If 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`::
3636A 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`::
4747In `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
51+ ==== Anonymous access settings
5252You can configure the following anonymous access settings in
5353`elasticsearch.yml`. For more information, see {xpack-ref}/anonymous-access.html[
54- Enabling Anonymous Access ].
54+ Enabling anonymous access ].
5555
5656`xpack.security.authc.anonymous.username`::
5757The 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
7474You can set the following document and field level security
7575settings 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`::
8080Set to `false` to prevent document and field level security
8181from being configured. Defaults to `true`.
8282
8383[float]
8484[[token-service-settings]]
85- ==== Token Service Settings
85+ ==== Token service settings
8686
8787You can set the following token service settings in
8888`elasticsearch.yml`.
@@ -98,7 +98,7 @@ The length of time that a token is valid for. By default this value is `20m` or
9898
9999[float]
100100[[realm-settings]]
101- ==== Realm Settings
101+ ==== Realm settings
102102You configure realm settings in the `xpack.security.authc.realms`
103103namespace in `elasticsearch.yml`. For example:
104104
@@ -124,10 +124,11 @@ xpack.security.authc.realms:
124124----------------------------------------
125125
126126The valid settings vary depending on the realm type. For more
127- information, see {xpack-ref}/setting-up-authentication.html[Setting Up Authentication ].
127+ information, see {xpack-ref}/setting-up-authentication.html[Setting up authentication ].
128128
129129[float]
130- ===== Settings Valid for All Realms
130+ [[ref-realm-settings]]
131+ ===== Settings valid for all realms
131132
132133`type`::
133134The type of the realm: `native, `ldap`, `active_directory`, `pki`, or `file`. Required.
@@ -141,10 +142,31 @@ recommended when you configure multiple realms. Defaults to `Integer.MAX_VALUE`.
141142Indicates whether a realm is enabled. You can use this setting to disable a
142143realm without removing its configuration information. Defaults to `true`.
143144
145+ [[ref-native-settings]]
146+ [float]
147+ ===== Native realm settings
148+
149+ For a native realm, the `type` must be set to `native`. In addition to the
150+ <<ref-realm-settings,settings that are valid for all realms>>, you can specify
151+ the following optional settings:
152+
153+ `cache.ttl`:: The time-to-live for cached user entries. User credentials are
154+ cached for this period of time. Specify the time period using the standard
155+ {es} <<time-units,time units>>. Defaults to `20m`.
156+
157+ `cache.max_users`:: The maximum number of user entries that can live in the
158+ cache at any given time. Defaults to 100,000.
159+
160+ `cache.hash_algo`:: (Expert Setting) The hashing algorithm that is used for the
161+ in-memory cached user credentials. For possible values, see
162+ {xpack-ref}/controlling-user-cache.html[Cache hash algorithms]. Defaults to
163+ `ssha256`.
164+
165+
144166[[ref-users-settings]]
145167
146168[float]
147- ===== File Realm Settings
169+ ===== File realm settings
148170
149171`cache.ttl`::
150172The time-to-live for cached user entries--user credentials are cached for
@@ -163,7 +185,7 @@ all possible values. Defaults to `ssha256`.
163185
164186[[ref-ldap-settings]]
165187[float]
166- ===== LDAP Realm Settings
188+ ===== LDAP realm settings
167189`url`::
168190An LDAP URL in the format `ldap[s]://<server>:<port>`. Required.
169191
@@ -393,7 +415,7 @@ table for all possible values). Defaults to `ssha256`.
393415
394416[[ref-ad-settings]]
395417[float]
396- ===== Active Directory Realm Settings
418+ ===== Active Directory realm settings
397419
398420`url`::
399421A URL in the format `ldap[s]://<server>:<port>`. Defaults to `ldap://<domain_name>:389`.
@@ -605,7 +627,7 @@ the in-memory cached user credentials (see {xpack-ref}/controlling-user-cache.ht
605627
606628[[ref-pki-settings]]
607629[float]
608- ===== PKI Realm Settings
630+ ===== PKI realm settings
609631
610632`username_pattern`::
611633The regular expression pattern used to extract the username from the
@@ -651,7 +673,7 @@ Defaults to `100000`.
651673
652674[[ref-saml-settings]]
653675[float]
654- ===== SAML Realm Settings
676+ ===== SAML realm settings
655677`idp.entity_id`::
656678The Entity ID of the SAML Identity Provider
657679
@@ -915,10 +937,10 @@ cipher suites that should be supported.
915937
916938[float]
917939[[ssl-tls-settings]]
918- ==== Default TLS/SSL Settings
940+ ==== Default TLS/SSL settings
919941You can configure the following TLS/SSL settings in
920942`elasticsearch.yml`. For more information, see
921- {xpack-ref}/encrypting-communications.html[Encrypting Communications ]. These settings will be used
943+ {xpack-ref}/encrypting-communications.html[Encrypting communications ]. These settings will be used
922944for all of {xpack} unless they have been overridden by more specific
923945settings such as those for HTTP or Transport.
924946
@@ -961,7 +983,7 @@ Jurisdiction Policy Files_ has been installed, the default value also includes `
961983
962984[float]
963985[[tls-ssl-key-settings]]
964- ===== Default TLS/SSL Key and Trusted Certificate Settings
986+ ===== Default TLS/SSL key and trusted certificate settings
965987
966988The following settings are used to specify a private key, certificate, and the
967989trusted certificates that should be used when communicating over an SSL/TLS connection.
@@ -971,7 +993,7 @@ trusted along with the certificate(s) from the <<tls-ssl-key-settings, key setti
971993for connections that require client authentication or when acting as a SSL enabled server.
972994
973995[float]
974- ===== PEM Encoded Files
996+ ===== PEM encoded files
975997
976998When using PEM encoded files, use the following settings:
977999
@@ -994,7 +1016,7 @@ that will be presented to clients when they connect.
9941016List of paths to the PEM encoded certificate files that should be trusted.
9951017
9961018[float]
997- ===== Java Keystore Files
1019+ ===== Java keystore files
9981020
9991021When using Java keystore files (JKS), which contain the private key, certificate
10001022and certificates that should be trusted, use the following settings:
@@ -1025,7 +1047,7 @@ Password to the truststore.
10251047Password to the truststore.
10261048
10271049[float]
1028- ===== PKCS#12 Files
1050+ ===== PKCS#12 files
10291051
10301052When using PKCS#12 container files (`.p12` or `.pfx`), which contain the
10311053private key, certificate, and certificates that should be trusted, use
@@ -1082,7 +1104,7 @@ include::ssl-settings.asciidoc[]
10821104
10831105[[ssl-tls-profile-settings]]
10841106[float]
1085- ===== Transport Profile TLS/SSL Settings
1107+ ===== Transport profile TLS/SSL settings
10861108The same settings that are available for the <<transport-tls-ssl-settings, default transport>>
10871109are also available for each transport profile. By default, the settings for a
10881110transport profile will be the same as the default transport unless they
@@ -1096,7 +1118,7 @@ setting, this would be `transport.profiles.$PROFILE.xpack.security.ssl.key`.
10961118
10971119[float]
10981120[[ip-filtering-settings]]
1099- ==== IP Filtering Settings
1121+ ==== IP filtering settings
11001122You can configure the following settings for {xpack-ref}/ip-filtering.html[IP filtering].
11011123
11021124`xpack.security.transport.filter.allow`::
0 commit comments