org.apache.nifi.security.util.crypto

Class KeyedCipherProvider

java.lang.Object

org.apache.nifi.security.util.crypto.KeyedCipherProvider

All Implemented Interfaces:

CipherProvider

Direct Known Subclasses:

AESKeyedCipherProvider

public abstract class KeyedCipherProvider
extends Object
implements CipherProvider

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static byte[]	IV_DELIMITER
(package private) static int	MAX_IV_LIMIT

Constructor Summary

Constructors

Constructor and Description
KeyedCipherProvider()

Method Summary

Modifier and Type	Method and Description
(package private) abstract byte[]	generateIV() Generates a new random IV of the correct length.
abstract Cipher	getCipher(EncryptionMethod encryptionMethod, SecretKey key, boolean encryptMode) Returns an initialized cipher for the specified algorithm.
abstract Cipher	getCipher(EncryptionMethod encryptionMethod, SecretKey key, byte[] iv, boolean encryptMode) Returns an initialized cipher for the specified algorithm.
byte[]	readIV(InputStream in)
void	writeIV(byte[] iv, OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

IV_DELIMITER

static final byte[] IV_DELIMITER

MAX_IV_LIMIT

static final int MAX_IV_LIMIT

See Also:

Constant Field Values

Constructor Detail

KeyedCipherProvider

public KeyedCipherProvider()

Method Detail

getCipher

public abstract Cipher getCipher(EncryptionMethod encryptionMethod,
                                 SecretKey key,
                                 byte[] iv,
                                 boolean encryptMode)
                          throws Exception

Returns an initialized cipher for the specified algorithm. The IV is provided externally to allow for non-deterministic IVs, as IVs deterministically derived from the password are a potential vulnerability and compromise semantic security. See Ilmari Karonen's answer on Crypto Stack Exchange

Parameters:

encryptionMethod - the EncryptionMethod

key - the key

iv - the IV or nonce

encryptMode - true for encrypt, false for decrypt

Returns:

the initialized cipher

Throws:

Exception - if there is a problem initializing the cipher

getCipher

public abstract Cipher getCipher(EncryptionMethod encryptionMethod,
                                 SecretKey key,
                                 boolean encryptMode)
                          throws Exception

Returns an initialized cipher for the specified algorithm. The IV will be generated internally (for encryption). If decryption is requested, it will throw an exception.

Parameters:

encryptionMethod - the EncryptionMethod

key - the key

encryptMode - true for encrypt, false for decrypt

Returns:

the initialized cipher

Throws:

Exception - if there is a problem initializing the cipher or if decryption is requested

generateIV

abstract byte[] generateIV()

Generates a new random IV of the correct length.

Returns:

the IV

readIV

public byte[] readIV(InputStream in)
              throws IOException,
                     ProcessException

Throws:

IOException

ProcessException

writeIV

public void writeIV(byte[] iv,
                    OutputStream out)
             throws IOException

Throws:

IOException