[DOCS] Merges duplicate pages for LDAP realms (#49203)
This commit is contained in:
parent
81a9d98a47
commit
b4f82c9cdb
|
@ -949,3 +949,23 @@ See <<ref-saml-ssl-settings>>.
|
||||||
=== Configuring a file realm
|
=== Configuring a file realm
|
||||||
|
|
||||||
See <<file-realm-configuration>>.
|
See <<file-realm-configuration>>.
|
||||||
|
|
||||||
|
[role="exclude",id="ldap-user-search"]
|
||||||
|
=== User search mode and user DN templates mode
|
||||||
|
|
||||||
|
See <<ldap-realm-configuration>>.
|
||||||
|
|
||||||
|
[role="exclude",id="configuring-ldap-realm"]
|
||||||
|
=== Configuring an LDAP realm
|
||||||
|
|
||||||
|
See <<ldap-realm-configuration>>.
|
||||||
|
|
||||||
|
[role="exclude",id="ldap-settings"]
|
||||||
|
=== LDAP realm settings
|
||||||
|
|
||||||
|
See <<ref-ldap-settings>>.
|
||||||
|
|
||||||
|
[role="exclude",id="ldap-ssl"]
|
||||||
|
=== Setting up SSL between Elasticsearch and LDAP
|
||||||
|
|
||||||
|
See <<tls-ldap>>.
|
||||||
|
|
|
@ -1,13 +1,5 @@
|
||||||
[role="xpack"]
|
To integrate with LDAP, you configure an `ldap` realm and map LDAP groups to
|
||||||
[[configuring-ldap-realm]]
|
user roles.
|
||||||
=== Configuring an LDAP realm
|
|
||||||
|
|
||||||
You can configure {es} to authenticate users by communicating with a Lightweight
|
|
||||||
Directory Access Protocol (LDAP) server. To integrate with LDAP, you configure
|
|
||||||
an `ldap` realm and map LDAP groups to user roles.
|
|
||||||
|
|
||||||
For more information about LDAP realms, see
|
|
||||||
<<ldap-realm>>.
|
|
||||||
|
|
||||||
. Determine which mode you want to use. The `ldap` realm supports two modes of
|
. Determine which mode you want to use. The `ldap` realm supports two modes of
|
||||||
operation, a user search mode and a mode with specific templates for user DNs.
|
operation, a user search mode and a mode with specific templates for user DNs.
|
||||||
|
@ -217,3 +209,5 @@ xpack:
|
||||||
metadata: cn
|
metadata: cn
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
--
|
--
|
||||||
|
|
||||||
|
. Set up SSL to encrypt communications between {es} and LDAP. See <<tls-ldap>>.
|
|
@ -3,9 +3,8 @@
|
||||||
=== LDAP user authentication
|
=== LDAP user authentication
|
||||||
|
|
||||||
You can configure the {stack} {security-features} to communicate with a
|
You can configure the {stack} {security-features} to communicate with a
|
||||||
Lightweight Directory Access Protocol (LDAP) server to authenticate users. To
|
Lightweight Directory Access Protocol (LDAP) server to authenticate users. See
|
||||||
integrate with LDAP, you configure an `ldap` realm and map LDAP groups to user
|
<<ldap-realm-configuration>>.
|
||||||
roles in the <<mapping-roles, role mapping file>>.
|
|
||||||
|
|
||||||
LDAP stores users and groups hierarchically, similar to the way folders are
|
LDAP stores users and groups hierarchically, similar to the way folders are
|
||||||
grouped in a file system. An LDAP directory's hierarchy is built from containers
|
grouped in a file system. An LDAP directory's hierarchy is built from containers
|
||||||
|
@ -20,25 +19,6 @@ for example `"cn=admin,dc=example,dc=com"` (white spaces are ignored).
|
||||||
The `ldap` realm supports two modes of operation, a user search mode
|
The `ldap` realm supports two modes of operation, a user search mode
|
||||||
and a mode with specific templates for user DNs.
|
and a mode with specific templates for user DNs.
|
||||||
|
|
||||||
[[ldap-user-search]]
|
|
||||||
==== User search mode and user DN templates mode
|
|
||||||
|
|
||||||
See {ref}/configuring-ldap-realm.html[Configuring an LDAP Realm].
|
|
||||||
|
|
||||||
[[ldap-load-balancing]]
|
|
||||||
==== Load balancing and failover
|
|
||||||
The `load_balance.type` setting can be used at the realm level to configure how
|
|
||||||
the {security-features} should interact with multiple LDAP servers. The
|
|
||||||
{security-features} support both failover and load balancing modes of operation.
|
|
||||||
|
|
||||||
See
|
|
||||||
{ref}/security-settings.html#load-balancing[Load balancing and failover settings].
|
|
||||||
|
|
||||||
[[ldap-settings]]
|
|
||||||
==== LDAP realm settings
|
|
||||||
|
|
||||||
See {ref}/security-settings.html#ref-ldap-settings[LDAP realm settings].
|
|
||||||
|
|
||||||
[[mapping-roles-ldap]]
|
[[mapping-roles-ldap]]
|
||||||
==== Mapping LDAP groups to roles
|
==== Mapping LDAP groups to roles
|
||||||
|
|
||||||
|
@ -52,12 +32,16 @@ supports the notion of groups, which often represent user roles for different
|
||||||
systems in the organization.
|
systems in the organization.
|
||||||
|
|
||||||
The `ldap` realm enables you to map LDAP users to roles via their LDAP
|
The `ldap` realm enables you to map LDAP users to roles via their LDAP
|
||||||
groups, or other metadata. This role mapping can be configured via the
|
groups or other metadata. This role mapping can be configured via the
|
||||||
{ref}/security-api-put-role-mapping.html[add role mapping API] or by using a
|
<<security-api-put-role-mapping,add role mapping API>> or by using a
|
||||||
file stored on each node. When a user authenticates with LDAP, the privileges
|
file stored on each node. When a user authenticates with LDAP, the privileges
|
||||||
for that user are the union of all privileges defined by the roles to which
|
for that user are the union of all privileges defined by the roles to which
|
||||||
the user is mapped. For more information, see
|
the user is mapped.
|
||||||
{ref}/configuring-ldap-realm.html[Configuring an LDAP realm].
|
|
||||||
|
[[ldap-realm-configuration]]
|
||||||
|
==== Configuring an LDAP realm
|
||||||
|
|
||||||
|
include::configuring-ldap-realm.asciidoc[]
|
||||||
|
|
||||||
[[ldap-user-metadata]]
|
[[ldap-user-metadata]]
|
||||||
==== User metadata in LDAP realms
|
==== User metadata in LDAP realms
|
||||||
|
@ -81,8 +65,10 @@ the `metadata` setting on the LDAP realm. This metadata is available for use
|
||||||
with the <<mapping-roles-api, role mapping API>> or in
|
with the <<mapping-roles-api, role mapping API>> or in
|
||||||
<<templating-role-query, templated role queries>>.
|
<<templating-role-query, templated role queries>>.
|
||||||
|
|
||||||
[[ldap-ssl]]
|
[[ldap-load-balancing]]
|
||||||
==== Setting up SSL between Elasticsearch and LDAP
|
==== Load balancing and failover
|
||||||
|
The `load_balance.type` setting can be used at the realm level to configure how
|
||||||
|
the {security-features} should interact with multiple LDAP servers. The
|
||||||
|
{security-features} support both failover and load balancing modes of operation.
|
||||||
|
|
||||||
See
|
See <<load-balancing>>.
|
||||||
{ref}/configuring-tls.html#tls-ldap[Encrypting communications between {es} and LDAP].
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ users, you can use the _run as_ mechanism to restrict data access according to
|
||||||
To "run as" (impersonate) another user, you must be able to retrieve the user from
|
To "run as" (impersonate) another user, you must be able to retrieve the user from
|
||||||
the realm you use to authenticate. Both the internal `native` and `file` realms
|
the realm you use to authenticate. Both the internal `native` and `file` realms
|
||||||
support this out of the box. The LDAP realm must be configured to run in
|
support this out of the box. The LDAP realm must be configured to run in
|
||||||
<<ldap-user-search, _user search_ mode>>. The Active Directory realm must be
|
<<ldap-realm-configuration,_user search_ mode>>. The Active Directory realm must be
|
||||||
<<ad-settings,configured with a `bind_dn` and `secure_bind_password`>> to support
|
<<ad-settings,configured with a `bind_dn` and `secure_bind_password`>> to support
|
||||||
_run as_. The PKI, Kerberos, and SAML realms do not support _run as_.
|
_run as_. The PKI, Kerberos, and SAML realms do not support _run as_.
|
||||||
|
|
||||||
|
|
|
@ -75,7 +75,7 @@ your subscription. For more information, see https://www.elastic.co/subscription
|
||||||
** <<configuring-ad-realm,Active Directory realms>>
|
** <<configuring-ad-realm,Active Directory realms>>
|
||||||
** <<file-realm,File realms>>
|
** <<file-realm,File realms>>
|
||||||
** <<configuring-kerberos-realm,Kerberos realms>>
|
** <<configuring-kerberos-realm,Kerberos realms>>
|
||||||
** <<configuring-ldap-realm,LDAP realms>>
|
** <<ldap-realm,LDAP realms>>
|
||||||
** <<native-realm,Native realms>>
|
** <<native-realm,Native realms>>
|
||||||
** <<configuring-pki-realm,PKI realms>>
|
** <<configuring-pki-realm,PKI realms>>
|
||||||
** <<saml-realm,SAML realms>>
|
** <<saml-realm,SAML realms>>
|
||||||
|
@ -146,7 +146,6 @@ include::securing-communications/enabling-cipher-suites.asciidoc[]
|
||||||
include::securing-communications/separating-node-client-traffic.asciidoc[]
|
include::securing-communications/separating-node-client-traffic.asciidoc[]
|
||||||
|
|
||||||
include::authentication/configuring-active-directory-realm.asciidoc[]
|
include::authentication/configuring-active-directory-realm.asciidoc[]
|
||||||
include::authentication/configuring-ldap-realm.asciidoc[]
|
|
||||||
include::authentication/configuring-pki-realm.asciidoc[]
|
include::authentication/configuring-pki-realm.asciidoc[]
|
||||||
include::authentication/configuring-kerberos-realm.asciidoc[]
|
include::authentication/configuring-kerberos-realm.asciidoc[]
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ contents of the connection are encrypted. Clients and nodes that connect via
|
||||||
TLS to the LDAP server need to have the LDAP server's certificate or the
|
TLS to the LDAP server need to have the LDAP server's certificate or the
|
||||||
server's root CA certificate installed in their keystore or truststore.
|
server's root CA certificate installed in their keystore or truststore.
|
||||||
|
|
||||||
For more information, see <<configuring-ldap-realm>>.
|
For more information, see <<ldap-realm>>.
|
||||||
|
|
||||||
. Configure the realm's TLS settings on each node to trust certificates signed
|
. Configure the realm's TLS settings on each node to trust certificates signed
|
||||||
by the CA that signed your LDAP server certificates. The following example
|
by the CA that signed your LDAP server certificates. The following example
|
||||||
|
|
|
@ -92,7 +92,7 @@ this error.
|
||||||
|
|
||||||
Groups are located by either an LDAP search or by the "memberOf" attribute on
|
Groups are located by either an LDAP search or by the "memberOf" attribute on
|
||||||
the user. Also, If subtree search is turned off, it will search only one
|
the user. Also, If subtree search is turned off, it will search only one
|
||||||
level deep. See the <<ldap-settings, LDAP Settings>> for all the options.
|
level deep. For all the options, see <<ref-ldap-settings>>.
|
||||||
There are many options here and sticking to the defaults will not work for all
|
There are many options here and sticking to the defaults will not work for all
|
||||||
scenarios.
|
scenarios.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue