org.apache.nifi.registry.security.crypto

Interface CryptoKeyProvider

All Known Implementing Classes:

BootstrapFileCryptoKeyProvider

public interface CryptoKeyProvider

A simple interface that wraps a key that can be used for encryption and decryption. This allows for more flexibility with the lifecycle of keys and how other classes can declare dependencies for keys, by depending on a CryptoKeyProvider that will provided at runtime.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_KEY A string literal that indicates the contents of a key are empty.

Method Summary

Modifier and Type	Method and Description
String	getKey()
default boolean	isEmpty()
String	toString() A string representation of this CryptoKeyProvider instance.

Field Detail

EMPTY_KEY

static final String EMPTY_KEY

A string literal that indicates the contents of a key are empty. Can also be used in contexts that a null key is undesirable.

See Also:

Constant Field Values

Method Detail

getKey

String getKey()
       throws MissingCryptoKeyException

Returns:

The crypto key known to this CryptoKeyProvider instance in hexadecimal format, or EMPTY_KEY if the key is empty.

Throws:

MissingCryptoKeyException - if the key cannot be provided or determined for any reason. If the key is known to be empty, EMPTY_KEY will be returned and a CryptoKeyMissingException will not be thrown

isEmpty

default boolean isEmpty()

Returns:

A boolean indicating if the key value held by this CryptoKeyProvider is empty, such as 'null' or empty string.

toString

String toString()

A string representation of this CryptoKeyProvider instance.

Note: Implementations of this interface should take care not to leak sensitive key material in any strings they emmit, including in the toString implementation.

Overrides:

toString in class Object

Returns:

A string representation of this CryptoKeyProvider instance.