You're viewing version 3.4 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Cryptographic functions

The following cryptographic functions are supported in PPL.

MD5

Usage: MD5(str)

Calculates the MD5 digest and returns the value as a 32-character hex string.

Parameters:

• str (Required): The string for which to calculate the MD5 digest.

Return type: STRING

Example

source=people
| eval `MD5('hello')` = MD5('hello')
| fields `MD5('hello')`

The query returns the following results:

SHA1

Usage: SHA1(str)

Returns the SHA-1 hash as a hex string.

Parameters:

• str (Required): The string for which to calculate the SHA-1 hash.

Return type: STRING

Example

source=people
| eval `SHA1('hello')` = SHA1('hello')
| fields `SHA1('hello')`

The query returns the following results:

SHA2

Usage: SHA2(str, numBits)

Returns the result of SHA-2 family hash functions (SHA-224, SHA-256, SHA-384, and SHA-512) as a hex string.

Parameters:

• str (Required): The string for which to calculate the SHA-2 hash.
• numBits (Required): The desired bit length of the result, which must be 224, 256, 384, or 512.

Return type: STRING

Example: SHA-256 hash

source=people
| eval `SHA2('hello',256)` = SHA2('hello',256)
| fields `SHA2('hello',256)`

The query returns the following results:

Example: SHA-512 hash

source=people
| eval `SHA2('hello',512)` = SHA2('hello',512)
| fields `SHA2('hello',512)`

The query returns the following results: