Package org.apache.nifi.encrypt

Class KeyedCipherPropertyEncryptor

java.lang.Object

org.apache.nifi.encrypt.CipherPropertyEncryptor

org.apache.nifi.encrypt.KeyedCipherPropertyEncryptor

All Implemented Interfaces:

PropertyEncryptor

class KeyedCipherPropertyEncryptor
extends CipherPropertyEncryptor

Property Encryptor implementation using AES-GCM

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ARRAY_START
private static final String	CIPHER_ALGORITHM
private final String	description
private static final int	GCM_TAG_LENGTH_BITS
private static final int	INITIALIZATION_VECTOR_LENGTH
private final SecretKey	secretKey
private final SecureRandom	secureRandom

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyedCipherPropertyEncryptor(SecretKey secretKey)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)	Return object equality based on Secret Key
private Cipher	getCipher(byte[] initializationVector, int cipherMode)
protected byte[]	getCipherBinary(byte[] encryptedBinary)	Get Cipher Binary from encrypted binary
protected Cipher	getDecryptionCipher(byte[] encryptedBinary)	Get Cipher for Decryption based on encrypted binary
protected byte[]	getEncodedParameters()	Get Encoded Parameters returns a random initialization vector
protected Cipher	getEncryptionCipher(byte[] encodedParameters)	Get Cipher for Encryption using encoded parameters containing initialization vector
int	hashCode()	Return hash code based on Secret Key
private byte[]	readInitializationVector(byte[] binary)
String	toString()	Return String containing object description

Methods inherited from class org.apache.nifi.encrypt.CipherPropertyEncryptor

decrypt, encrypt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INITIALIZATION_VECTOR_LENGTH

private static final int INITIALIZATION_VECTOR_LENGTH

See Also:

• Constant Field Values

GCM_TAG_LENGTH_BITS

private static final int GCM_TAG_LENGTH_BITS

See Also:

• Constant Field Values

ARRAY_START

private static final int ARRAY_START

See Also:

• Constant Field Values

CIPHER_ALGORITHM

private static final String CIPHER_ALGORITHM

See Also:

• Constant Field Values

secretKey

private final SecretKey secretKey

secureRandom

private final SecureRandom secureRandom

description

private final String description

Constructor Details

KeyedCipherPropertyEncryptor

protected KeyedCipherPropertyEncryptor(SecretKey secretKey)

Method Details

getDecryptionCipher

protected Cipher getDecryptionCipher(byte[] encryptedBinary)

Get Cipher for Decryption based on encrypted binary

Specified by:

getDecryptionCipher in class CipherPropertyEncryptor

Parameters:

encryptedBinary - Encrypted Binary

Returns:

Cipher for Decryption

getEncryptionCipher

protected Cipher getEncryptionCipher(byte[] encodedParameters)

Get Cipher for Encryption using encoded parameters containing initialization vector

Specified by:

getEncryptionCipher in class CipherPropertyEncryptor

Parameters:

encodedParameters - Binary encoded parameters containing random initialization vector

Returns:

Cipher for Encryption

getCipherBinary

protected byte[] getCipherBinary(byte[] encryptedBinary)

Get Cipher Binary from encrypted binary

Specified by:

getCipherBinary in class CipherPropertyEncryptor

Parameters:

encryptedBinary - Encrypted Binary containing cipher binary and other information

Returns:

Cipher Binary for decryption

getEncodedParameters

protected byte[] getEncodedParameters()

Get Encoded Parameters returns a random initialization vector

Specified by:

getEncodedParameters in class CipherPropertyEncryptor

Returns:

Initialization Vector for encoded parameters

getCipher

private Cipher getCipher(byte[] initializationVector,
 int cipherMode)

readInitializationVector

private byte[] readInitializationVector(byte[] binary)

equals

public boolean equals(Object object)

Return object equality based on Secret Key

Overrides:

equals in class Object

Parameters:

object - Object for comparison

Returns:

Object equality status

hashCode

public int hashCode()

Return hash code based on Secret Key

Overrides:

hashCode in class Object

Returns:

Hash Code based on Secret Key

toString

public String toString()

Return String containing object description

Overrides:

toString in class Object

Returns:

Object description