org.conscrypt

Class OpenSSLCipher

java.lang.Object

javax.crypto.CipherSpi

org.conscrypt.OpenSSLCipher

Direct Known Subclasses:

OpenSSLCipher.EVP_AEAD, OpenSSLCipher.EVP_CIPHER

public abstract class OpenSSLCipher
extends CipherSpi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenSSLCipher.EVP_AEAD
static class	OpenSSLCipher.EVP_CIPHER
protected static class	OpenSSLCipher.Mode Modes that a block cipher may support.
protected static class	OpenSSLCipher.Padding Paddings that a block cipher may support.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	encodedKey May be used when reseting the cipher instance after calling doFinal.
protected byte[]	iv The Initial Vector (IV) used for the current cipher.
protected OpenSSLCipher.Mode	mode The current cipher mode.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenSSLCipher()
protected	OpenSSLCipher(OpenSSLCipher.Mode mode, OpenSSLCipher.Padding padding)

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkSupportedKeySize(int keySize) Checks whether the cipher supports this particular keySize (in bytes) and throws InvalidKeyException if it doesn't.
protected abstract void	checkSupportedMode(OpenSSLCipher.Mode mode) Checks whether the cipher supports this particular cipher mode and throws NoSuchAlgorithmException if it doesn't.
protected abstract void	checkSupportedPadding(OpenSSLCipher.Padding padding) Checks whether the cipher supports this particular cipher padding and throws NoSuchPaddingException if it doesn't.
protected abstract int	doFinalInternal(byte[] output, int outputOffset, int maximumLen) API-specific implementation of the final block.
protected byte[]	engineDoFinal(byte[] input, int inputOffset, int inputLen) Finishes a multi-part transformation (encryption or decryption).
protected int	engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Finishes a multi-part transformation (encryption or decryption).
protected int	engineGetBlockSize() Returns the block size of this cipher (in bytes)
protected byte[]	engineGetIV() Returns the Initialization Vector (IV) that was used to initialize this cipher or null if none was used.
protected int	engineGetOutputSize(int inputLen) Returns the size for a buffer (in bytes), that the next call to update of doFinal would return, taking into account any buffered data from previous update calls and padding.
protected AlgorithmParameters	engineGetParameters() Returns the parameters that where used to create this cipher instance.
protected void	engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) Initializes this cipher instance with the specified key, algorithm parameters and a source of randomness.
protected void	engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random) Initializes this cipher instance with the specified key, algorithm parameters and a source of randomness.
protected void	engineInit(int opmode, Key key, SecureRandom random) Initializes this cipher instance with the specified key and a source of randomness.
protected abstract void	engineInitInternal(byte[] encodedKey, AlgorithmParameterSpec params, SecureRandom random) API-specific implementation of initializing the cipher.
protected void	engineSetMode(String modeStr) Sets the mode for this cipher.
protected void	engineSetPadding(String paddingStr) Sets the padding method for this cipher.
protected Key	engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType) Unwraps a key using this cipher instance.
protected byte[]	engineUpdate(byte[] input, int inputOffset, int inputLen) Continues a multi-part transformation (encryption or decryption).
protected int	engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) Continues a multi-part transformation (encryption or decryption).
protected byte[]	engineWrap(Key key) Wraps a key using this cipher instance.
protected abstract String	getBaseCipherName() Returns the standard name for the particular algorithm.
protected abstract int	getCipherBlockSize()
protected abstract int	getOutputSizeForFinal(int inputLen) The size of output if doFinal() is called with this inputLen.
protected abstract int	getOutputSizeForUpdate(int inputLen) The size of output if update() is called with this inputLen.
protected OpenSSLCipher.Padding	getPadding() Returns the padding type for which this cipher is initialized.
protected boolean	isEncrypting()
protected boolean	supportsVariableSizeIv()
protected boolean	supportsVariableSizeKey()
protected abstract int	updateInternal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset, int maximumLen) API-specific implementation of updating the cipher.

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineGetKeySize, engineUpdate, engineUpdateAAD, engineUpdateAAD

Methods inherited from class java.lang.Object

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

Field Detail

mode

protected OpenSSLCipher.Mode mode

The current cipher mode.

encodedKey

protected byte[] encodedKey

May be used when reseting the cipher instance after calling doFinal.

iv

protected byte[] iv

The Initial Vector (IV) used for the current cipher.

Constructor Detail

OpenSSLCipher

protected OpenSSLCipher()

OpenSSLCipher

protected OpenSSLCipher(OpenSSLCipher.Mode mode,
                        OpenSSLCipher.Padding padding)

Method Detail

engineInitInternal

protected abstract void engineInitInternal(byte[] encodedKey,
                                           AlgorithmParameterSpec params,
                                           SecureRandom random)
                                    throws InvalidKeyException,
                                           InvalidAlgorithmParameterException

API-specific implementation of initializing the cipher. The isEncrypting() function will tell whether it should be initialized for encryption or decryption. The encodedKey will be the bytes of a supported key size.

Throws:

InvalidKeyException

InvalidAlgorithmParameterException

updateInternal

protected abstract int updateInternal(byte[] input,
                                      int inputOffset,
                                      int inputLen,
                                      byte[] output,
                                      int outputOffset,
                                      int maximumLen)
                               throws ShortBufferException

API-specific implementation of updating the cipher. The maximumLen will be the maximum length of the output as returned by getOutputSizeForUpdate(int). The return value must be the number of bytes processed and placed into output. On error, an exception must be thrown.

Throws:

ShortBufferException

doFinalInternal

protected abstract int doFinalInternal(byte[] output,
                                       int outputOffset,
                                       int maximumLen)
                                throws IllegalBlockSizeException,
                                       BadPaddingException,
                                       ShortBufferException

API-specific implementation of the final block. The maximumLen will be the maximum length of the possible output as returned by getOutputSizeForFinal(int). The return value must be the number of bytes processed and placed into output. On error, an exception must be thrown.

Throws:

IllegalBlockSizeException

BadPaddingException

ShortBufferException

getBaseCipherName

protected abstract String getBaseCipherName()

Returns the standard name for the particular algorithm.

checkSupportedKeySize

protected abstract void checkSupportedKeySize(int keySize)
                                       throws InvalidKeyException

Checks whether the cipher supports this particular keySize (in bytes) and throws InvalidKeyException if it doesn't.

Throws:

InvalidKeyException

checkSupportedMode

protected abstract void checkSupportedMode(OpenSSLCipher.Mode mode)
                                    throws NoSuchAlgorithmException

Checks whether the cipher supports this particular cipher mode and throws NoSuchAlgorithmException if it doesn't.

Throws:

NoSuchAlgorithmException

checkSupportedPadding

protected abstract void checkSupportedPadding(OpenSSLCipher.Padding padding)
                                       throws NoSuchPaddingException

Checks whether the cipher supports this particular cipher padding and throws NoSuchPaddingException if it doesn't.

Throws:

NoSuchPaddingException

getCipherBlockSize

protected abstract int getCipherBlockSize()

supportsVariableSizeKey

protected boolean supportsVariableSizeKey()

supportsVariableSizeIv

protected boolean supportsVariableSizeIv()

engineSetMode

protected void engineSetMode(String modeStr)
                      throws NoSuchAlgorithmException

Description copied from class: CipherSpi

Sets the mode for this cipher.

Specified by:

engineSetMode in class CipherSpi

Parameters:

modeStr - the name of the cipher mode.

Throws:

NoSuchAlgorithmException - if the specified cipher mode is not supported by this provider.

engineSetPadding

protected void engineSetPadding(String paddingStr)
                         throws NoSuchPaddingException

Description copied from class: CipherSpi

Sets the padding method for this cipher.

Specified by:

engineSetPadding in class CipherSpi

Parameters:

paddingStr - the name of the padding method.

Throws:

NoSuchPaddingException - if the specified padding method is not supported by this cipher.

getPadding

protected OpenSSLCipher.Padding getPadding()

Returns the padding type for which this cipher is initialized.

engineGetBlockSize

protected int engineGetBlockSize()

Description copied from class: CipherSpi

Returns the block size of this cipher (in bytes)

Specified by:

engineGetBlockSize in class CipherSpi

Returns:

the block size of this cipher, or zero if this cipher is not a block cipher.

getOutputSizeForFinal

protected abstract int getOutputSizeForFinal(int inputLen)

The size of output if doFinal() is called with this inputLen. If padding is enabled and the size of the input puts it right at the block size, it will add another block for the padding.

getOutputSizeForUpdate

protected abstract int getOutputSizeForUpdate(int inputLen)

The size of output if update() is called with this inputLen. If padding is enabled and the size of the input puts it right at the block size, it will add another block for the padding.

engineGetOutputSize

protected int engineGetOutputSize(int inputLen)

Description copied from class: CipherSpi

Returns the size for a buffer (in bytes), that the next call to update of doFinal would return, taking into account any buffered data from previous update calls and padding.

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

Specified by:

engineGetOutputSize in class CipherSpi

Parameters:

inputLen - the length of the input (in bytes).

Returns:

the size for a buffer (in bytes).

engineGetIV

protected byte[] engineGetIV()

Description copied from class: CipherSpi

Returns the Initialization Vector (IV) that was used to initialize this cipher or null if none was used.

Specified by:

engineGetIV in class CipherSpi

Returns:

the Initialization Vector (IV), or null if none was used.

engineGetParameters

protected AlgorithmParameters engineGetParameters()

Description copied from class: CipherSpi

Returns the parameters that where used to create this cipher instance.

These may be a the same parameters that were used to create this cipher instance, or may be a combination of default and random parameters, depending on the underlying cipher implementation.

Specified by:

engineGetParameters in class CipherSpi

Returns:

the parameters that where used to create this cipher instance, or null if this cipher instance does not have any parameters at all.

engineInit

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

Description copied from class: CipherSpi

Initializes this cipher instance with the specified key and a source of randomness.

The cipher will be initialized for the specified operation (one of: encryption, decryption, key wrapping or key unwrapping) depending on opmode.

If this cipher instance needs any algorithm parameters or random values that the specified key cannot provide, the underlying implementation of this cipher is supposed to generate the required parameters (using its provider or random values). Random values will be generated using random;

When a cipher instance is initialized by a call to any of the init methods, the state of the instance is overridden, means it is equivalent to creating a new instance and calling it init method.

Specified by:

engineInit in class CipherSpi

Parameters:

opmode - the operation this cipher instance should be initialized for (one of: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE).

key - the input key for the operation.

random - the source of randomness to use.

Throws:

InvalidKeyException - if the specified key cannot be used to initialize this cipher instance.

engineInit

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

Description copied from class: CipherSpi

Initializes this cipher instance with the specified key, algorithm parameters and a source of randomness.

The cipher will be initialized for the specified operation (one of: encryption, decryption, key wrapping or key unwrapping) depending on opmode.

If this cipher instance needs any algorithm parameters and params is null, the underlying implementation of this cipher is supposed to generate the required parameters (using its provider or random values). Random values are generated using random.

When a cipher instance is initialized by a call to any of the init methods, the state of the instance is overridden, means it is equivalent to creating a new instance and calling it init method.

Specified by:

engineInit in class CipherSpi

Parameters:

opmode - the operation this cipher instance should be initialized for (one of: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE).

key - the input key for the operation.

params - the algorithm parameters.

random - the source of randomness to use.

Throws:

InvalidKeyException - if the specified key cannot be used to initialize this cipher instance.

InvalidAlgorithmParameterException - it the specified parameters are inappropriate for this cipher.

engineInit

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

Description copied from class: CipherSpi

Initializes this cipher instance with the specified key, algorithm parameters and a source of randomness.

The cipher will be initialized for the specified operation (one of: encryption, decryption, key wrapping or key unwrapping) depending on opmode.

If this cipher instance needs any algorithm parameters and params is null, the underlying implementation of this cipher is supposed to generate the required parameters (using its provider or random values). Random values are generated using random.

When a cipher instance is initialized by a call to any of the init methods, the state of the instance is overridden, means it is equivalent to creating a new instance and calling it init method.

Specified by:

engineInit in class CipherSpi

Parameters:

opmode - the operation this cipher instance should be initialized for (one of: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE).

key - the input key for the operation.

params - the algorithm parameters.

random - the source of randomness to use.

Throws:

InvalidKeyException - if the specified key cannot be used to initialize this cipher instance.

InvalidAlgorithmParameterException - if the specified parameters are inappropriate for this cipher.

engineUpdate

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

Description copied from class: CipherSpi

Continues a multi-part transformation (encryption or decryption). The transformed bytes are returned.

Specified by:

engineUpdate in class CipherSpi

Parameters:

input - the input bytes to transform.

inputOffset - the offset in the input to start.

inputLen - the length of the input to transform.

Returns:

the transformed bytes in a new buffer, or null if the input has zero length.

engineUpdate

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

Description copied from class: CipherSpi

Continues a multi-part transformation (encryption or decryption). The transformed bytes are stored in the output buffer.

If the size of the output buffer is too small to hold the result, a ShortBufferException is thrown. Use getOutputSize to check for the size of the output buffer.

Specified by:

engineUpdate in class CipherSpi

Parameters:

input - the input bytes to transform.

inputOffset - the offset in the input to start.

inputLen - the length of the input to transform.

output - the output buffer.

outputOffset - the offset in the output buffer.

Returns:

the number of bytes placed in output.

Throws:

ShortBufferException - if the size of the output buffer is too small.

engineDoFinal

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

Description copied from class: CipherSpi

Finishes a multi-part transformation (encryption or decryption).

Processes the inputLen bytes in input buffer at inputOffset, and any bytes that have been buffered in previous update calls.

Specified by:

engineDoFinal in class CipherSpi

Parameters:

input - the input buffer.

inputOffset - the offset in the input buffer.

inputLen - the length of the input.

Returns:

the final bytes from the transformation.

Throws:

IllegalBlockSizeException - if the size of the resulting bytes is not a multiple of the cipher block size.

BadPaddingException - if the padding of the data does not match the padding scheme.

engineDoFinal

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

Description copied from class: CipherSpi

Finishes a multi-part transformation (encryption or decryption).

Processes the inputLen bytes in input buffer at inputOffset, and any bytes that have been buffered in previous update calls.

Specified by:

engineDoFinal in class CipherSpi

Parameters:

input - the input buffer.

inputOffset - the offset in the input buffer.

inputLen - the length of the input.

output - the output buffer for the transformed bytes.

outputOffset - the offset in the output buffer.

Returns:

the number of bytes placed in the output buffer.

Throws:

ShortBufferException - if the size of the output buffer is too small.

IllegalBlockSizeException - if the size of the resulting bytes is not a multiple of the cipher block size.

BadPaddingException - if the padding of the data does not match the padding scheme.

engineWrap

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

Description copied from class: CipherSpi

Wraps a key using this cipher instance. This method has been added to this class (for backwards compatibility, it cannot be abstract). If this method is not overridden, it throws an UnsupportedOperationException.

Overrides:

engineWrap in class CipherSpi

Parameters:

key - the key to wrap.

Returns:

the wrapped key

Throws:

IllegalBlockSizeException - if the size of the resulting bytes is not a multiple of the cipher block size.

InvalidKeyException - if this cipher instance cannot wrap this key.

engineUnwrap

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

Description copied from class: CipherSpi

Unwraps a key using this cipher instance.

This method has been added to this class (for backwards compatibility, it cannot be abstract). If this method is not overridden, it throws an UnsupportedOperationException.

Overrides:

engineUnwrap in class CipherSpi

Parameters:

wrappedKey - the wrapped key to unwrap.

wrappedKeyAlgorithm - the algorithm for the wrapped key.

wrappedKeyType - the type of the wrapped key (one of: SECRET_KEY, PRIVATE_KEY or PUBLIC_KEY)

Returns:

the unwrapped key.

Throws:

InvalidKeyException - if the wrappedKey cannot be unwrapped to a key of type wrappedKeyType for the wrappedKeyAlgorithm.

NoSuchAlgorithmException - if no provider can be found that can create a key of type wrappedKeyType for the wrappedKeyAlgorithm.

isEncrypting

protected boolean isEncrypting()