Calculates a secure hash of a field for storing in the event. See hashMatch() on how to search for events using hashes. Bits can reduce the width of the output if desired to keep the resulting strings short.

asstringoptional[a]  The name of output field, defaults to the input field.
bitsintegeroptional[a]256 Hash algorithm output bits to keep. Must be a multiple of 8.
field[b]stringrequired  The name of the field to hash.
hashstringoptional[a]sha256 Hash algorithm.
  Valid Values
replaceInRawstringbooleanoptional[a]true Replace all substrings in @rawstring that has the input value with the hash too.
saltstringrequired  The name of the secret salt to use.

[a] Optional parameters use their default value unless explicitly set

[b] The argument name field can be omitted.

Omitted Argument Names

The argument name for field can be omitted; the following forms of this function are equivalent:




These examples show basic structure only; full examples are provided below.

hashRewrite() Examples

Replace the value in the ssn field with the hash of the existing value, also replacing it in @rawstring

hashRewrite(ssn, salt="salt1")