iaik.security.cipher

Class PBES2

java.lang.Object

javax.crypto.CipherSpi

iaik.security.cipher.PBES2

public class PBES2
extends javax.crypto.CipherSpi

This class represents passwordbased encryption as defined by the PKCS #5 standard. These algorithms implement PBES2 with HmacSHA1/HmacSHA2family and AESCBC. Padding is done as described in PKCS #5. Is used by the engineInit methods and initializes the cipher.

salt - it should be at least eight octets (64 bits) long

iteration count - default to 10,000 and a minimum of 1,000 is recommended.

Key Derivation Function - PBKDF2 is recommended for new applications; PBKDF1 is included only for compatibility with existing applications. PBKDF2 with Pseudo-random Functions include HMAC with SHA-1, SHA-224, SHA-256, SHA-384, SHA512, SHA-512/224 and SHA-512/256.

Encryption Schemes - an underlying encryption scheme Encryption Schemes such as AES-CBC-Pad.

Since:

9.0

See Also:

PBES2Parameters, PBES2ParameterSpec

Field Summary

Fields

Modifier and Type	Field and Description
static int	AES_BLOCK_SIZE
static int	DEFAULT_COUNT
static int	DEFAULT_SALT_LENGTH
static int	GCM_IV_LENGTH
protected AlgorithmID	m_enc
protected AlgorithmID	m_kdf
protected java.security.AlgorithmParameters	m_params
protected AlgorithmID	m_prf
static int	MINIMUM_COUNT
static int	TAG_LENGTH_BIT

Method Summary

Modifier and Type	Method and Description
protected byte[]	engineDoFinal(byte[] input, int inputOffset, int inputLen)
protected int	engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
protected int	engineGetBlockSize()
protected byte[]	engineGetIV()
protected int	engineGetOutputSize(int inputLen)
protected java.security.AlgorithmParameters	engineGetParameters()
protected void	engineInit(int opmode, java.security.Key key, java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random)
protected void	engineInit(int opmode, java.security.Key key, java.security.AlgorithmParameters params, java.security.SecureRandom random)
protected void	engineInit(int opmode, java.security.Key key, java.security.SecureRandom random)
protected void	engineSetMode(java.lang.String mode)
protected void	engineSetPadding(java.lang.String padding)
protected byte[]	engineUpdate(byte[] input, int inputOffset, int inputLen)
protected int	engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
static java.lang.String	getEncName(AlgorithmID id)
static java.lang.String	getPRFName(AlgorithmID id) Return the pseudo-random function algorithm name for the PBKDF2.
static byte[]	getRandomNonce(int numBytes) Return random generated byte array for salt and IV with the provided length in bytes.
protected void	setEncryptionScheme(java.lang.String enc)
void	setPRFName(java.lang.String prf) Store the pseudo-random function algorithm name for the PBKDF2.

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineGetKeySize, engineUnwrap, engineUpdate, engineUpdateAAD, engineUpdateAAD, engineWrap

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SALT_LENGTH

public static final int DEFAULT_SALT_LENGTH

See Also:

Constant Field Values

MINIMUM_COUNT

public static final int MINIMUM_COUNT

See Also:

Constant Field Values

DEFAULT_COUNT

public static final int DEFAULT_COUNT

See Also:

Constant Field Values

AES_BLOCK_SIZE

public static final int AES_BLOCK_SIZE

See Also:

Constant Field Values

TAG_LENGTH_BIT

public static final int TAG_LENGTH_BIT

See Also:

Constant Field Values

GCM_IV_LENGTH

public static final int GCM_IV_LENGTH

See Also:

Constant Field Values

m_kdf

protected AlgorithmID m_kdf

m_prf

protected AlgorithmID m_prf

m_enc

protected AlgorithmID m_enc

m_params

protected java.security.AlgorithmParameters m_params

Method Detail

setEncryptionScheme

protected void setEncryptionScheme(java.lang.String enc)

getPRFName

public static java.lang.String getPRFName(AlgorithmID id)

Return the pseudo-random function algorithm name for the PBKDF2.

Parameters:

id -

Returns:

String

getEncName

public static java.lang.String getEncName(AlgorithmID id)

setPRFName

public void setPRFName(java.lang.String prf)

Store the pseudo-random function algorithm name for the PBKDF2.

Parameters:

prf -

getRandomNonce

public static byte[] getRandomNonce(int numBytes)

Return random generated byte array for salt and IV with the provided length in bytes.

Parameters:

numBytes -

Returns:

byte array

engineSetMode

protected void engineSetMode(java.lang.String mode)
                      throws java.security.NoSuchAlgorithmException

Specified by:

engineSetMode in class javax.crypto.CipherSpi

Throws:

java.security.NoSuchAlgorithmException

engineSetPadding

protected void engineSetPadding(java.lang.String padding)
                         throws javax.crypto.NoSuchPaddingException

Specified by:

engineSetPadding in class javax.crypto.CipherSpi

Throws:

javax.crypto.NoSuchPaddingException

engineGetBlockSize

protected int engineGetBlockSize()

Specified by:

engineGetBlockSize in class javax.crypto.CipherSpi

engineGetOutputSize

protected int engineGetOutputSize(int inputLen)

Specified by:

engineGetOutputSize in class javax.crypto.CipherSpi

engineGetIV

protected byte[] engineGetIV()

Specified by:

engineGetIV in class javax.crypto.CipherSpi

engineGetParameters

protected java.security.AlgorithmParameters engineGetParameters()

Specified by:

engineGetParameters in class javax.crypto.CipherSpi

engineInit

protected void engineInit(int opmode,
                          java.security.Key key,
                          java.security.SecureRandom random)
                   throws java.security.InvalidKeyException

Specified by:

engineInit in class javax.crypto.CipherSpi

Throws:

java.security.InvalidKeyException

engineInit

protected void engineInit(int opmode,
                          java.security.Key key,
                          java.security.spec.AlgorithmParameterSpec params,
                          java.security.SecureRandom random)
                   throws java.security.InvalidKeyException,
                          java.security.InvalidAlgorithmParameterException

Specified by:

engineInit in class javax.crypto.CipherSpi

Throws:

java.security.InvalidKeyException

java.security.InvalidAlgorithmParameterException

engineInit

protected void engineInit(int opmode,
                          java.security.Key key,
                          java.security.AlgorithmParameters params,
                          java.security.SecureRandom random)
                   throws java.security.InvalidKeyException,
                          java.security.InvalidAlgorithmParameterException

Specified by:

engineInit in class javax.crypto.CipherSpi

Throws:

java.security.InvalidKeyException

java.security.InvalidAlgorithmParameterException

engineUpdate

protected byte[] engineUpdate(byte[] input,
                              int inputOffset,
                              int inputLen)

Specified by:

engineUpdate in class javax.crypto.CipherSpi

engineUpdate

protected int engineUpdate(byte[] input,
                           int inputOffset,
                           int inputLen,
                           byte[] output,
                           int outputOffset)
                    throws javax.crypto.ShortBufferException

Specified by:

engineUpdate in class javax.crypto.CipherSpi

Throws:

javax.crypto.ShortBufferException

engineDoFinal

protected byte[] engineDoFinal(byte[] input,
                               int inputOffset,
                               int inputLen)
                        throws javax.crypto.IllegalBlockSizeException,
                               javax.crypto.BadPaddingException

Specified by:

engineDoFinal in class javax.crypto.CipherSpi

Throws:

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

engineDoFinal

protected int engineDoFinal(byte[] input,
                            int inputOffset,
                            int inputLen,
                            byte[] output,
                            int outputOffset)
                     throws javax.crypto.ShortBufferException,
                            javax.crypto.IllegalBlockSizeException,
                            javax.crypto.BadPaddingException

Specified by:

engineDoFinal in class javax.crypto.CipherSpi

Throws:

javax.crypto.ShortBufferException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException