org.apache.nifi.security.util.crypto

Interface PBECipherProvider

All Superinterfaces:

CipherProvider

All Known Implementing Classes:

Argon2CipherProvider, BcryptCipherProvider, NiFiLegacyCipherProvider, OpenSSLPKCS5CipherProvider, PBKDF2CipherProvider, RandomIVPBECipherProvider, ScryptCipherProvider

public interface PBECipherProvider
extends CipherProvider

Method Summary

Modifier and Type	Method and Description
byte[]	generateSalt() Returns a random salt suitable for this cipher provider.
Cipher	getCipher(EncryptionMethod encryptionMethod, String password, byte[] salt, int keyLength, boolean encryptMode) Returns an initialized cipher for the specified algorithm.
int	getDefaultSaltLength() Returns the default salt length for this implementation.
byte[]	readSalt(InputStream in) Returns the salt provided as part of the cipher stream, or throws an exception if one cannot be detected.
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.

Method Detail

getCipher

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

Returns an initialized cipher for the specified algorithm. The key (and IV if necessary) are derived by the KDF of the implementation.

The IV can be retrieved by the calling method using Cipher.getIV().

Parameters:

encryptionMethod - the EncryptionMethod

password - the secret input

salt - the salt

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

generateSalt

byte[] generateSalt()

Returns a random salt suitable for this cipher provider.

Returns:

a random salt

See Also:

getDefaultSaltLength()

getDefaultSaltLength

int getDefaultSaltLength()

Returns the default salt length for this implementation.

Returns:

the default salt length in bytes

readSalt

byte[] readSalt(InputStream in)
         throws IOException

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

Parameters:

in - the cipher InputStream

Returns:

the salt

Throws:

IOException

writeSalt

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

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

Parameters:

salt - the salt

out - the cipher OutputStream

Throws:

IOException