org.apache.nifi.security.util.crypto

Class RandomIVPBECipherProvider

java.lang.Object

org.apache.nifi.security.util.crypto.RandomIVPBECipherProvider

All Implemented Interfaces:

CipherProvider, PBECipherProvider

Direct Known Subclasses:

Argon2CipherProvider, BcryptCipherProvider, PBKDF2CipherProvider, ScryptCipherProvider

public abstract class RandomIVPBECipherProvider
extends Object
implements PBECipherProvider

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RandomIVPBECipherProvider()

Method Summary

Modifier and Type	Method and Description
abstract Cipher	getCipher(EncryptionMethod encryptionMethod, String password, byte[] salt, byte[] iv, int keyLength, boolean encryptMode) Returns an initialized cipher for the specified algorithm.
(package private) abstract org.slf4j.Logger	getLogger()
byte[]	readIV(InputStream in)
byte[]	readSalt(InputStream in) Returns the salt provided as part of the cipher stream, or throws an exception if one cannot be detected.
void	writeIV(byte[] iv, OutputStream out)
void	writeSalt(byte[] salt, OutputStream out) Writes the salt provided as part of the cipher stream, or throws an exception if it cannot be written.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.security.util.crypto.PBECipherProvider

generateSalt, getCipher, getDefaultSaltLength

Field Detail

SALT_DELIMITER

public static final byte[] SALT_DELIMITER

MAX_SALT_LIMIT

static final int MAX_SALT_LIMIT

See Also:

Constant Field Values

IV_DELIMITER

public static final byte[] IV_DELIMITER

MAX_IV_LIMIT

static final int MAX_IV_LIMIT

See Also:

Constant Field Values

Constructor Detail

RandomIVPBECipherProvider

public RandomIVPBECipherProvider()

Method Detail

getCipher

public abstract Cipher getCipher(EncryptionMethod encryptionMethod,
                                 String password,
                                 byte[] salt,
                                 byte[] iv,
                                 int keyLength,
                                 boolean encryptMode)
                          throws Exception

Returns an initialized cipher for the specified algorithm. The key is derived by the KDF of the implementation. 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

password - the secret input

salt - the salt

iv - the IV

keyLength - the desired key length in bits

encryptMode - true for encrypt, false for decrypt

Returns:

the initialized cipher

Throws:

Exception - if there is a problem initializing the cipher

getLogger

abstract org.slf4j.Logger getLogger()

readSalt

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

Description copied from interface: PBECipherProvider

Returns the salt provided as part of the cipher stream, or throws an exception if one cannot be detected.

Specified by:

readSalt in interface PBECipherProvider

Parameters:

in - the cipher InputStream

Returns:

the salt

Throws:

IOException

ProcessException

writeSalt

public void writeSalt(byte[] salt,
                      OutputStream out)
               throws IOException

Description copied from interface: PBECipherProvider

Writes the salt provided as part of the cipher stream, or throws an exception if it cannot be written.

Specified by:

writeSalt in interface PBECipherProvider

Parameters:

salt - the salt

out - the cipher OutputStream

Throws:

IOException

readIV

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

Throws:

IOException

ProcessException

writeIV

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

Throws:

IOException