Skip to content

Commit c4e013c

Browse files
committed
Added documentation for secure LDAP settings
See associated PR for implementation: opensearch-project/security#5323 Signed-off-by: Chris White <chriswhite199@gmail.com>
1 parent 0b6b352 commit c4e013c

File tree

1 file changed

+10
-1
lines changed
  • _security/authentication-backends

1 file changed

+10
-1
lines changed

_security/authentication-backends/ldap.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,16 @@ To configure the `bind_dn` and `password` that the Security plugin uses when iss
137137
```yml
138138
config:
139139
bind_dn: cn=admin,dc=example,dc=com
140+
# Deprecated - use password_secure in the keystore instead
140141
password: password
141142
```
142143

144+
For increased security, you should use the opensearch keystore and add a corresponding entry for your authn / authz setting via the `password_secure` property:
145+
146+
```bash
147+
./bin/opensearch-keystore add authc.ldap.authentication_backend.config.pasword_secure
148+
```
149+
143150
If your server supports anonymous authentication, both `bind_dn` and `password` can be set to `null`.
144151

145152

@@ -211,6 +218,7 @@ If you use TLS client authentication, the Security plugin sends the PEM certific
211218
```yml
212219
config:
213220
pemkey_filepath: /full/path/to/private.key.pem
221+
# Deprecated - use pemkey_password_secure in the keystore instead
214222
pemkey_password: private_key_password
215223
pemcert_filepath: /full/path/to/certificate.pem
216224
```
@@ -240,7 +248,8 @@ Name | Description
240248
:--- | :---
241249
`pemkey_filepath` | Absolute path to the file containing the private key of your certificate.
242250
`pemkey_content` | The content of the private key of your certificate. Cannot be used when `pemkey_filepath` is set.
243-
`pemkey_password` | The password of your private key, if any.
251+
`pemkey_password` | The password of your private key, if any (**deprecated** - use `pemkey_password_secure` instead).
252+
`pemkey_password_secure` | The password of your private key, if any (stored in the secure keystore).
244253
`pemcert_filepath` | Absolute path to the client certificate.
245254
`pemcert_content` | The content of the client certificate. Cannot be used when `pemcert_filepath` is set.
246255

0 commit comments

Comments
 (0)