org.apache.nifi.security.util.crypto

Interface SecureHasher

All Known Implementing Classes:

AbstractSecureHasher, Argon2SecureHasher, BcryptSecureHasher, KeyDerivationBcryptSecureHasher, PBKDF2SecureHasher, ScryptSecureHasher

public interface SecureHasher

An interface which specifies that implementations should provide a cryptographic hash function (CHF) which accepts input and returns a deterministic, (mathematically-difficult) irreversible value. While SHA-256, SHA-512, and Blake2 are CHF implementations, this interface is intended to be used by password protection or key derivation functions (KDF) like PBKDF2CipherProvider, BcryptCipherProvider, ScryptCipherProvider, or Argon2SecureHasher. These classes implement iterative processes which make use of cryptographic primitives to return an irreversible value which can either securely store a password representation or be used as an encryption key derived from a password.

Method Summary

Modifier and Type	Method and Description
String	hashBase64(String input) Returns a String representation of CHF(input) in Base 64-encoded format.
String	hashBase64(String input, String salt) Returns a String representation of CHF(input) in Base 64-encoded format.
String	hashHex(String input) Returns a String representation of CHF(input) in hex-encoded format.
String	hashHex(String input, String salt) Returns a String representation of CHF(input) in hex-encoded format.
byte[]	hashRaw(byte[] input) Returns a byte[] representation of CHF(input).
byte[]	hashRaw(byte[] input, byte[] salt) Returns a byte[] representation of CHF(input).

Method Detail

hashHex

String hashHex(String input)

Returns a String representation of CHF(input) in hex-encoded format.

Parameters:

input - the input

Returns:

the hex-encoded hash

hashHex

String hashHex(String input,
               String salt)

Returns a String representation of CHF(input) in hex-encoded format.

Parameters:

input - the input

salt - the provided salt

Returns:

the hex-encoded hash

hashBase64

String hashBase64(String input)

Returns a String representation of CHF(input) in Base 64-encoded format.

Parameters:

input - the input

Returns:

the Base 64-encoded hash

hashBase64

String hashBase64(String input,
                  String salt)

Returns a String representation of CHF(input) in Base 64-encoded format.

Parameters:

input - the input

salt - the provided salt

Returns:

the Base 64-encoded hash

hashRaw

byte[] hashRaw(byte[] input)

Returns a byte[] representation of CHF(input).

Parameters:

input - the input

Returns:

the hash

hashRaw

byte[] hashRaw(byte[] input,
               byte[] salt)

Returns a byte[] representation of CHF(input).

Parameters:

input - the input

salt - the provided salt

Returns:

the hash