org.apache.nifi.security.repository

Class AbstractAESEncryptor

java.lang.Object

org.apache.nifi.security.repository.AbstractAESEncryptor

All Implemented Interfaces:

RepositoryObjectEncryptor

Direct Known Subclasses:

RepositoryObjectAESCTREncryptor, RepositoryObjectAESGCMEncryptor

public abstract class AbstractAESEncryptor
extends Object
implements RepositoryObjectEncryptor

Field Summary

Fields

Modifier and Type	Field and Description
protected AESKeyedCipherProvider	aesKeyedCipherProvider
private static String	ALGORITHM
private static byte[]	EM_END_SENTINEL
private static byte[]	EM_START_SENTINEL
protected static byte[]	EMPTY_IV
protected static int	IV_LENGTH
protected KeyProvider	keyProvider
private static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractAESEncryptor()

Method Summary

Modifier and Type	Method and Description
void	initialize(KeyProvider keyProvider) Initializes the encryptor with a KeyProvider.
static RepositoryObjectEncryptionMetadata	prepareObjectForDecryption(Object ciphertextSource, String identifier, String descriptor, List<String> supportedVersions) Utility method which extracts the RepositoryObjectEncryptionMetadata object from the byte[] or InputStream provided and verifies common validation across both streaming and block decryption.
(package private) void	setCipherProvider(AESKeyedCipherProvider cipherProvider) Available for dependency injection to override the default AESKeyedCipherProvider if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static final org.slf4j.Logger logger

EM_START_SENTINEL

private static final byte[] EM_START_SENTINEL

EM_END_SENTINEL

private static final byte[] EM_END_SENTINEL

ALGORITHM

private static String ALGORITHM

IV_LENGTH

protected static final int IV_LENGTH

See Also:

Constant Field Values

EMPTY_IV

protected static final byte[] EMPTY_IV

keyProvider

protected KeyProvider keyProvider

aesKeyedCipherProvider

protected AESKeyedCipherProvider aesKeyedCipherProvider

Constructor Detail

AbstractAESEncryptor

public AbstractAESEncryptor()

Method Detail

initialize

public void initialize(KeyProvider keyProvider)
                throws KeyManagementException

Initializes the encryptor with a KeyProvider.

Specified by:

initialize in interface RepositoryObjectEncryptor

Parameters:

keyProvider - the key provider which will be responsible for accessing keys

Throws:

KeyManagementException - if there is an issue configuring the key provider

setCipherProvider

void setCipherProvider(AESKeyedCipherProvider cipherProvider)

Available for dependency injection to override the default AESKeyedCipherProvider if necessary.

Parameters:

cipherProvider - the AES cipher provider to use

prepareObjectForDecryption

public static RepositoryObjectEncryptionMetadata prepareObjectForDecryption(Object ciphertextSource,
                                                                            String identifier,
                                                                            String descriptor,
                                                                            List<String> supportedVersions)
                                                                     throws EncryptionException

Utility method which extracts the RepositoryObjectEncryptionMetadata object from the byte[] or InputStream provided and verifies common validation across both streaming and block decryption. Returns the extracted metadata object.

Parameters:

ciphertextSource - the encrypted source -- can be byte[] or InputStream

identifier - the unique identifier for this source

descriptor - the generic name for this source type for logging/error messages

supportedVersions - the list of supported versions for the particular encryptor calling this method (see RepositoryObjectAESCTREncryptor and RepositoryObjectAESGCMEncryptor for SUPPORTED_VERSIONS)

Returns:

the extracted RepositoryObjectEncryptionMetadata object

Throws:

EncryptionException - if there is an exception parsing or validating the source