Skip to content

Added documentation for secure LDAP settings #9884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Added documentation for secure LDAP settings #9884

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion _security/authentication-backends/ldap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,16 @@ To configure the `bind_dn` and `password` that the Security plugin uses when iss
```yml
config:
bind_dn: cn=admin,dc=example,dc=com
# Deprecated - use password_secure in the keystore instead
password: password
```

For increased security, you should use the opensearch keystore and add a corresponding entry for your authn / authz setting via the `password_secure` property:

```bash
./bin/opensearch-keystore add authc.ldap.authentication_backend.config.pasword_secure
```

If your server supports anonymous authentication, both `bind_dn` and `password` can be set to `null`.


Expand Down Expand Up @@ -211,6 +218,7 @@ If you use TLS client authentication, the Security plugin sends the PEM certific
```yml
config:
pemkey_filepath: /full/path/to/private.key.pem
# Deprecated - use pemkey_password_secure in the keystore instead
pemkey_password: private_key_password
pemcert_filepath: /full/path/to/certificate.pem
```
Expand Down Expand Up @@ -240,7 +248,8 @@ Name | Description
:--- | :---
`pemkey_filepath` | Absolute path to the file containing the private key of your certificate.
`pemkey_content` | The content of the private key of your certificate. Cannot be used when `pemkey_filepath` is set.
`pemkey_password` | The password of your private key, if any.
`pemkey_password` | The password of your private key, if any (**deprecated** - use `pemkey_password_secure` instead).
`pemkey_password_secure` | The password of your private key, if any (stored in the secure keystore).
`pemcert_filepath` | Absolute path to the client certificate.
`pemcert_content` | The content of the client certificate. Cannot be used when `pemcert_filepath` is set.

Expand Down