Skip to content

Commit aa79358

Browse files
Update field-masking.md for version 3.x (#9395)
* Update field-masking.md for version 3.x Signed-off-by: Terry Quigley <[email protected]> * Update field-masking.md for version 3.x Signed-off-by: Terry Quigley <[email protected]> --------- Signed-off-by: Terry Quigley <[email protected]>
1 parent 6715dc6 commit aa79358

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

_security/access-control/field-masking.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,16 @@ See [Create role]({{site.url}}{{site.baseurl}}/security/access-control/api/#crea
7979

8080
By default, the Security plugin uses the BLAKE2b algorithm, but you can use any hashing algorithm that your JVM provides. This list typically includes MD5, SHA-1, SHA-384, and SHA-512.
8181

82-
You can override the default algorithm in `opensearch.yml` using the option default masking algorithm setting `plugins.security.masked_fields.algorithm.default`, as shown in the following example:
82+
You can override the default algorithm in `opensearch.yml` using the optional default masking algorithm setting `plugins.security.masked_fields.algorithm.default`, as shown in the following example:
8383

8484
```yml
8585
plugins.security.masked_fields.algorithm.default: SHA-256
8686
```
87+
OpenSearch 3.x contains a bug fix to apply the default BLAKE2b algorithm correctly. You can override the default algorithm in OpenSearch 3.x to continue to produce the same masked values as OpenSearch 1.x and 2.x in `opensearch.yml` using the optional default masking algorithm setting `plugins.security.masked_fields.algorithm.default`, as shown in the following example:
88+
89+
```yml
90+
plugins.security.masked_fields.algorithm.default: BLAKE2B_LEGACY_DEFAULT
91+
```
8792

8893
To specify a different algorithm, add it after the masked field in `roles.yml`, as shown in the following:
8994

0 commit comments

Comments
 (0)