com.microej.crypto.internal.cipher

Class AbstractAESWrapCipherSpi

java.lang.Object

javax.crypto.CipherSpi

com.microej.crypto.internal.cipher.AbstractAESWrapCipherSpi

Direct Known Subclasses:

NativeAESWrapCipherSpi

public abstract class AbstractAESWrapCipherSpi
extends CipherSpi

Implementation copied from com.sun.crypto.provider.AESWrapCipher.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAESWrapCipherSpi()

Method Summary

Modifier and Type	Method and Description
static int	addExact(int x, int y) Returns the sum of its arguments, throwing an exception if the result overflows an int.
protected byte[]	engineDoFinal(byte[] in, int inOffset, int inLen) This operation is not supported by this cipher.
protected int	engineDoFinal(byte[] in, int inOffset, int inLen, byte[] out, int outOffset) This operation is not supported by this cipher.
protected int	engineGetBlockSize() Returns the block size (in bytes).
protected byte[]	engineGetIV() Returns the initialization vector (IV) which is null for this cipher.
protected int	engineGetOutputSize(int inputLen) Returns the length in bytes that an output buffer would need to be given the input length inputLen (in bytes).
protected abstract void	engineInit(boolean decrypting, SecretKey key) Initializes the AES Key Wrap cipher with the given key.
protected void	engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.
protected void	engineInit(int opmode, Key key, SecureRandom random) Initializes this cipher with a key and a source of randomness.
protected Key	engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType) Unwrap a previously wrapped key.
protected byte[]	engineUpdate(byte[] in, int inOffset, int inLen) This operation is not supported by this cipher.
protected int	engineUpdate(byte[] in, int inOffset, int inLen, byte[] out, int outOffset) This operation is not supported by this cipher.
protected byte[]	engineWrap(Key key) Wrap a key.
protected abstract SecretKey	unwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType) Unwrap a previously wrapped key.
protected abstract byte[]	wrap(SecretKey key) Wrap a key.

Methods inherited from class javax.crypto.CipherSpi

engineUpdateAAD

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAESWrapCipherSpi

protected AbstractAESWrapCipherSpi()

Method Detail

addExact

public static int addExact(int x,
                           int y)

Returns the sum of its arguments, throwing an exception if the result overflows an int.

Parameters:

x - the first value

y - the second value

Returns:

the result

Throws:

ArithmeticException - if the result overflows an int

Since:

1.8

engineDoFinal

protected byte[] engineDoFinal(byte[] in,
                               int inOffset,
                               int inLen)
                        throws IllegalBlockSizeException,
                               BadPaddingException

This operation is not supported by this cipher. Since it's impossible to initialize this cipher given the current Cipher.engineInit(...) implementation, IllegalStateException will always be thrown upon invocation.

Specified by:

engineDoFinal in class CipherSpi

Parameters:

in - the input buffer

inOffset - the offset in in where the input starts

inLen - the input length.

Returns:

n/a.

Throws:

IllegalStateException - upon invocation of this method.

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

AEADBadTagException - if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

engineDoFinal

protected int engineDoFinal(byte[] in,
                            int inOffset,
                            int inLen,
                            byte[] out,
                            int outOffset)
                     throws IllegalBlockSizeException,
                            ShortBufferException,
                            BadPaddingException

This operation is not supported by this cipher. Since it's impossible to initialize this cipher given the current Cipher.engineInit(...) implementation, IllegalStateException will always be thrown upon invocation.

Specified by:

engineDoFinal in class CipherSpi

Parameters:

in - the input buffer.

inOffset - the offset in in where the input starts.

inLen - the input length.

out - the buffer for the result.

outOffset - the ofset in out where the result is stored.

Returns:

n/a.

Throws:

IllegalStateException - upon invocation of this method.

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

ShortBufferException - if the given output buffer is too small to hold the result

BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes

AEADBadTagException - if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

engineGetBlockSize

protected int engineGetBlockSize()

Returns the block size (in bytes). i.e. 16 bytes.

Specified by:

engineGetBlockSize in class CipherSpi

Returns:

the block size (in bytes), i.e. 16 bytes.

engineGetIV

protected byte[] engineGetIV()

Returns the initialization vector (IV) which is null for this cipher.

Specified by:

engineGetIV in class CipherSpi

Returns:

null for this cipher.

engineGetOutputSize

protected int engineGetOutputSize(int inputLen)

Returns the length in bytes that an output buffer would need to be given the input length inputLen (in bytes).

The actual output length of the next update or doFinal call may be smaller than the length returned by this method.

Specified by:

engineGetOutputSize in class CipherSpi

Parameters:

inputLen - the input length (in bytes)

Returns:

the required output buffer size (in bytes)

engineInit

protected abstract void engineInit(boolean decrypting,
                                   SecretKey key)
                            throws InvalidKeyException

Initializes the AES Key Wrap cipher with the given key.

Parameters:

decrypting - flag indicating wrap or unwrap mode

key - the key (never null)

Throws:

InvalidKeyException - if the given key is inappropriate for initializing this cipher

engineInit

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

Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.

The cipher only supports the following two operation modes: Cipher.WRAP_MODE and Cipher.UNWRAP_MODE.

For modes other than the above two, UnsupportedOperationException will be thrown.

Specified by:

engineInit in class CipherSpi

Parameters:

opmode - the operation mode of this cipher. Only WRAP_MODE or UNWRAP_MODE) are accepted.

key - the secret key.

params - the algorithm parameters; must be null for this cipher.

random - the source of randomness.

Throws:

InvalidKeyException - if the given key is inappropriate for initializing this cipher

InvalidAlgorithmParameterException - if the given algorithm parameters is not null.

engineInit

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

Initializes this cipher with a key and a source of randomness.

The cipher only supports the following two operation modes: Cipher.WRAP_MODE and Cipher.UNWRAP_MODE.

For modes other than the above two, UnsupportedOperationException will be thrown.

Specified by:

engineInit in class CipherSpi

Parameters:

opmode - the operation mode of this cipher. Only WRAP_MODE or UNWRAP_MODE) are accepted.

key - the secret key.

random - the source of randomness.

Throws:

InvalidKeyException - if the given key is inappropriate for initializing this cipher.

UnsupportedOperationException - if opmode is not WRAP_MODE or UNWRAP_MODE.

engineUnwrap

protected Key engineUnwrap(byte[] wrappedKey,
                           String wrappedKeyAlgorithm,
                           int wrappedKeyType)
                    throws InvalidKeyException,
                           NoSuchAlgorithmException

Unwrap a previously wrapped key.

Overrides:

engineUnwrap in class CipherSpi

Parameters:

wrappedKey - the key to be unwrapped.

wrappedKeyAlgorithm - the algorithm the wrapped key is for.

wrappedKeyType - the type of the wrapped key. This is one of Cipher.SECRET_KEY, Cipher.PRIVATE_KEY, or Cipher.PUBLIC_KEY.

Returns:

the unwrapped key.

Throws:

NoSuchAlgorithmException - if no installed providers can create keys of type wrappedKeyType for the wrappedKeyAlgorithm.

InvalidKeyException - if wrappedKey does not represent a wrapped key of type wrappedKeyType for the wrappedKeyAlgorithm.

engineUpdate

protected byte[] engineUpdate(byte[] in,
                              int inOffset,
                              int inLen)

This operation is not supported by this cipher. Since it's impossible to initialize this cipher given the current Cipher.engineInit(...) implementation, IllegalStateException will always be thrown upon invocation.

Specified by:

engineUpdate in class CipherSpi

Parameters:

in - the input buffer.

inOffset - the offset in in where the input starts.

inLen - the input length.

Returns:

n/a.

Throws:

IllegalStateException - upon invocation of this method.

engineUpdate

protected int engineUpdate(byte[] in,
                           int inOffset,
                           int inLen,
                           byte[] out,
                           int outOffset)
                    throws ShortBufferException

This operation is not supported by this cipher. Since it's impossible to initialize this cipher given the current Cipher.engineInit(...) implementation, IllegalStateException will always be thrown upon invocation.

Specified by:

engineUpdate in class CipherSpi

Parameters:

in - the input buffer.

inOffset - the offset in in where the input starts.

inLen - the input length.

out - the buffer for the result.

outOffset - the offset in out where the result is stored.

Returns:

n/a.

Throws:

IllegalStateException - upon invocation of this method.

ShortBufferException - if the given output buffer is too small to hold the result

engineWrap

protected byte[] engineWrap(Key key)
                     throws IllegalBlockSizeException,
                            InvalidKeyException

Wrap a key.

Overrides:

engineWrap in class CipherSpi

Parameters:

key - the key to be wrapped.

Returns:

the wrapped key.

Throws:

IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested, and the length of the encoding of the key to be wrapped is not a multiple of the block size.

InvalidKeyException - if it is impossible or unsafe to wrap the key with this cipher (e.g., a hardware protected key is being passed to a software only cipher).

unwrap

protected abstract SecretKey unwrap(byte[] wrappedKey,
                                    String wrappedKeyAlgorithm,
                                    int wrappedKeyType)
                             throws InvalidKeyException,
                                    NoSuchAlgorithmException

Unwrap a previously wrapped key.

Parameters:

wrappedKey - the key to be unwrapped.

wrappedKeyAlgorithm - the algorithm the wrapped key is for.

wrappedKeyType - the type of the wrapped key. This is one of Cipher.SECRET_KEY, Cipher.PRIVATE_KEY, or Cipher.PUBLIC_KEY.

Returns:

the unwrapped key.

Throws:

NoSuchAlgorithmException - if no installed providers can create keys of type wrappedKeyType for the wrappedKeyAlgorithm.

InvalidKeyException - if wrappedKey does not represent a wrapped key of type wrappedKeyType for the wrappedKeyAlgorithm.

wrap

protected abstract byte[] wrap(SecretKey key)
                        throws InvalidKeyException,
                               IllegalBlockSizeException

Wrap a key.

Parameters:

key - the key to be wrapped.

Returns:

the wrapped key.

Throws:

InvalidKeyException - if it is impossible to wrap the key with this cipher.

IllegalBlockSizeException - the length of the encoding of the key to be wrapped is not a multiple of the block size.