Skip to content
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.

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

Add documentation for configuring the password hashing algorithm and its properties #7697

Merged
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,41 @@ The Security plugin supports the following expert-level settings:

- `plugins.security.check_snapshot_restore_write_privileges` (Static): Enforces write privilege evaluation when creating snapshots. Default is `true`.

If you change any of the following password hashing properties, you must rehash all internal passwords to ensure compatibility and security.
{: .warning}

- `plugins.security.password.hashing.algorithm`: (Static): Specifies the password hashing algorithm to use.

Valid values are:

- `BCrypt` (Default)
- `PBKDF2`

- `plugins.security.password.hashing.bcrypt.rounds` (Static): Specifies the number of rounds to use for password hashing with `BCrypt`. Valid values are from`4` to `31`, inclusive. Default is `12`.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

- `plugins.security.password.hashing.bcrypt.minor` (Static): Specifies the minor version of the `BCrypt` algorithm to use for password hashing.

Valid values are:

- `A`
- `B`
- `Y` (Default)

- `plugins.security.password.hashing.pbkdf2.function` (Static): Specifies the pseudo-random function applied to the password.

Valid values are:

- `SHA1`
- `SHA224`
- `SHA256` (Default)
- `SHA384`
- `SHA512`

- `plugins.security.password.hashing.pbkdf2.iterations` (Static): Specifies the number of times the pseudo-random function is applied to the password. Default is `600,000`.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

- `plugins.security.password.hashing.pbkdf2.length` (Static): Specifies the desired length of the final derived key. Default is `256`.


## Audit log settings

The Security plugin supports the following audit log settings:
Expand Down
Loading