org.apache.nifi.security.util.crypto

Class CipherUtility

java.lang.Object

org.apache.nifi.security.util.crypto.CipherUtility

public class CipherUtility
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE
private static Pattern	KEY_LENGTH_PATTERN
private static Map<String,Integer>	MAX_PASSWORD_LENGTH_BY_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
CipherUtility()

Method Summary

Modifier and Type	Method and Description
static byte[]	concatBytes(byte[]... arrays)
static String	encodeBase64NoPadding(byte[] bytes)
private static int	getDefaultKeyLengthForCipher(String cipher)
static int	getMaximumPasswordLengthForAlgorithmOnLimitedStrengthCrypto(EncryptionMethod encryptionMethod)
static List<Integer>	getValidKeyLengthsForAlgorithm(String algorithm)
static boolean	isValidKeyLength(int keyLength, String cipher) Returns true if the provided key length is a valid key length for the provided cipher family.
static boolean	isValidKeyLengthForAlgorithm(int keyLength, String algorithm) Returns true if the provided key length is a valid key length for the provided algorithm.
private static int	parseActualKeyLengthFromAlgorithm(String algorithm)
static String	parseCipherFromAlgorithm(String algorithm) Returns the cipher algorithm from the full algorithm name.
static int	parseKeyLengthFromAlgorithm(String algorithm) Returns the cipher key length from the full algorithm name.
static boolean	passwordLengthIsValidForAlgorithmOnLimitedStrengthCrypto(int passwordLength, EncryptionMethod encryptionMethod)
static void	processStreams(Cipher cipher, InputStream in, OutputStream out)
static byte[]	readBytesFromInputStream(InputStream in, String label, int limit, byte[] delimiter)
static void	writeBytesToOutputStream(OutputStream out, byte[] value, String label, byte[] delimiter)

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

KEY_LENGTH_PATTERN

private static final Pattern KEY_LENGTH_PATTERN

MAX_PASSWORD_LENGTH_BY_ALGORITHM

private static final Map<String,Integer> MAX_PASSWORD_LENGTH_BY_ALGORITHM

Constructor Detail

CipherUtility

public CipherUtility()

Method Detail

parseCipherFromAlgorithm

public static String parseCipherFromAlgorithm(String algorithm)

Returns the cipher algorithm from the full algorithm name. Useful for getting key lengths, etc.

Ex: PBEWITHMD5AND128BITAES-CBC-OPENSSL -> AES

Parameters:

algorithm - the full algorithm name

Returns:

the generic cipher name or the full algorithm if one cannot be extracted

parseKeyLengthFromAlgorithm

public static int parseKeyLengthFromAlgorithm(String algorithm)

Returns the cipher key length from the full algorithm name. Useful for getting key lengths, etc.

Ex: PBEWITHMD5AND128BITAES-CBC-OPENSSL -> 128

Parameters:

algorithm - the full algorithm name

Returns:

the key length or -1 if one cannot be extracted

parseActualKeyLengthFromAlgorithm

private static int parseActualKeyLengthFromAlgorithm(String algorithm)

isValidKeyLength

public static boolean isValidKeyLength(int keyLength,
                                       String cipher)

Returns true if the provided key length is a valid key length for the provided cipher family. Does not reflect if the Unlimited Strength Cryptography Jurisdiction Policies are installed. Does not reflect if the key length is correct for a specific combination of cipher and PBE-derived key length.

Ex:

256 is valid for AES/CBC/PKCS7Padding but not PBEWITHMD5AND128BITAES-CBC-OPENSSL. However, this method will return true for both because it only gets the cipher family, AES.

64, AES -> false [128, 192, 256], AES -> true

Parameters:

keyLength - the key length in bits

cipher - the cipher family

Returns:

true if this key length is valid

isValidKeyLengthForAlgorithm

public static boolean isValidKeyLengthForAlgorithm(int keyLength,
                                                   String algorithm)

Returns true if the provided key length is a valid key length for the provided algorithm. Does not reflect if the Unlimited Strength Cryptography Jurisdiction Policies are installed.

Ex:

256 is valid for AES/CBC/PKCS7Padding but not PBEWITHMD5AND128BITAES-CBC-OPENSSL.

64, AES/CBC/PKCS7Padding -> false [128, 192, 256], AES/CBC/PKCS7Padding -> true

128, PBEWITHMD5AND128BITAES-CBC-OPENSSL -> true [192, 256], PBEWITHMD5AND128BITAES-CBC-OPENSSL -> false

Parameters:

keyLength - the key length in bits

algorithm - the specific algorithm

Returns:

true if this key length is valid

getValidKeyLengthsForAlgorithm

public static List<Integer> getValidKeyLengthsForAlgorithm(String algorithm)

getDefaultKeyLengthForCipher

private static int getDefaultKeyLengthForCipher(String cipher)

processStreams

public static void processStreams(Cipher cipher,
                                  InputStream in,
                                  OutputStream out)

readBytesFromInputStream

public static byte[] readBytesFromInputStream(InputStream in,
                                              String label,
                                              int limit,
                                              byte[] delimiter)
                                       throws IOException,
                                              ProcessException

Throws:

IOException

ProcessException

writeBytesToOutputStream

public static void writeBytesToOutputStream(OutputStream out,
                                            byte[] value,
                                            String label,
                                            byte[] delimiter)
                                     throws IOException

Throws:

IOException

encodeBase64NoPadding

public static String encodeBase64NoPadding(byte[] bytes)

passwordLengthIsValidForAlgorithmOnLimitedStrengthCrypto

public static boolean passwordLengthIsValidForAlgorithmOnLimitedStrengthCrypto(int passwordLength,
                                                                               EncryptionMethod encryptionMethod)

getMaximumPasswordLengthForAlgorithmOnLimitedStrengthCrypto

public static int getMaximumPasswordLengthForAlgorithmOnLimitedStrengthCrypto(EncryptionMethod encryptionMethod)

concatBytes

public static byte[] concatBytes(byte[]... arrays)
                          throws IOException

Throws:

IOException