Skip to content

Update field-masking.md - add FIPS note #11542

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

Merged
merged 8 commits into from
Nov 20, 2025
Merged

Update field-masking.md - add FIPS note #11542

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b90ccda
Update field-masking.md for version 3.x
terryquigleysas Mar 12, 2025
02aa57b
Update field-masking.md for version 3.x
terryquigleysas Mar 12, 2025
439f360
Merge branch 'main' into main
terryquigleysas Mar 21, 2025
00ec3ad
Merge branch 'opensearch-project:main' into main
terryquigleysas Oct 24, 2025
c45e4a6
Merge branch 'opensearch-project:main' into main
terryquigleysas Nov 12, 2025
097cb36
Update field-masking.md - add FIPS note
terryquigleysas Nov 12, 2025
d370355
Update _security/access-control/field-masking.md
kolchfa-aws Nov 20, 2025
d30b016
Update _security/access-control/field-masking.md
natebower Nov 20, 2025
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
3 changes: 3 additions & 0 deletions _security/access-control/field-masking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@

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.

BLAKE2b and several other commonly available algorithms, such as MD5 and SHA-1, are not approved for use in FIPS 140-3-compliant environments. If your deployment requires FIPS compliance, configure the plugin to use a FIPS-approved algorithm such as SHA-256 or SHA-512, and make sure that the underlying cryptographic provider (for example, Bouncy Castle FIPS or another FIPS-validated JCE provider) is installed and configured correctly.

Check failure on line 99 in _security/access-control/field-masking.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.

Raw Output:
{"message": "[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.", "location": {"path": "_security/access-control/field-masking.md", "range": {"start": {"line": 99, "column": 114}}}, "severity": "ERROR"}

Check warning on line 99 in _security/access-control/field-masking.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.UnitsSpacing] Put a space between the number and the units in '2b '.

Raw Output:
{"message": "[OpenSearch.UnitsSpacing] Put a space between the number and the units in '2b '.", "location": {"path": "_security/access-control/field-masking.md", "range": {"start": {"line": 99, "column": 6}}}, "severity": "WARNING"}
{: .note}

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:

```yml
Expand Down
Loading