Field masking

If you don’t want to remove fields from a document using field-level security, you can mask their values. Currently, field masking is only available for string-based fields and replaces the field’s value with a cryptographic hash.

Field masking works alongside field-level security on the same per-role, per-index basis. You can allow certain roles to see sensitive fields in plain text and mask them for others. A search result with a masked field might look like this:

  1. {
  2.   "_index": "movies",
  3.   "_source": {
  4.     "year": 2013,
  5.     "directors": [
  6.       "Ron Howard"
  7.     ],
  8.     "title": "ca998e768dd2e6cdd84c77015feb29975f9f498a472743f159bec6f1f1db109e"
  9.   }
  10. }

Set the salt

You set the salt (a random string used to hash your data) in opensearch.yml:

  1. plugins.security.compliance.salt: abcdefghijklmnopqrstuvqxyz1234567890
PropertyDescription
plugins.security.compliance.saltThe salt to use when generating the hash value. Must be at least 32 characters. Only ASCII characters are allowed. Optional.

Setting the salt is optional, but we highly recommend it.

Configure field masking

You configure field masking using OpenSearch Dashboards, roles.yml, or the REST API.

OpenSearch Dashboards

  1. Choose a role.
  2. Choose an index permission.
  3. For Anonymization, specify one or more fields and press Enter.

roles.yml

  1. someonerole:
  2.   index_permissions:
  3.     - index_patterns:
  4.       - 'movies'
  5.       allowed_actions:
  6.         - read
  7.       masked_fields:
  8.         - "title"
  9.         - "genres"

REST API

See Create role.

(Advanced) Use an alternative hash algorithm

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.

To specify a different algorithm, add it after the masked field:

  1. someonerole:
  2.   index_permissions:
  3.     - index_patterns:
  4.       - 'movies'
  5.       allowed_actions:
  6.         - read
  7.       masked_fields:
  8.         - "title::SHA-512"
  9.         - "genres"

(Advanced) Pattern-based field masking

Rather than creating a hash, you can use one or more regular expressions and replacement strings to mask a field. The syntax is <field>::/<regular-expression>/::<replacement-string>. If you use multiple regular expressions, the results are passed from left to right, like piping in a shell:

  1. hr_employee:
  2.   index_permissions:
  3.     - index_patterns:
  4.       - 'humanresources'
  5.       allowed_actions:
  6.         - read
  7.       masked_fields:
  8.         - 'lastname::/.*/::*'
  9.         - '*ip_source::/[0-9]{1,3}$/::XXX::/^[0-9]{1,3}/::***'
  10. someonerole:
  11.   index_permissions:
  12.     - index_patterns:
  13.       - 'movies'
  14.       allowed_actions:
  15.         - read
  16.       masked_fields:
  17.         - "title::/./::*"
  18.         - "genres::/^[a-zA-Z]{1,3}/::XXX::/[a-zA-Z]{1,3}$/::YYY"

The title statement changes each character in the field to *, so you can still discern the length of the masked string. The genres statement changes the first three characters of the string to XXX and the last three characters to YYY.

Effect on audit logging

The read history feature lets you track read access to sensitive fields in your documents. For example, you might track access to the email field of your customer records. Access to masked fields are excluded from read history, because the user only saw the hash value, not the clear text value of the field.