org.conscrypt

Class OpenSSLCipher.EVP_AEAD

java.lang.Object

javax.crypto.CipherSpi

org.conscrypt.OpenSSLCipher

org.conscrypt.OpenSSLCipher.EVP_AEAD

Direct Known Subclasses:

OpenSSLCipher.EVP_AEAD.AES

Enclosing class:

OpenSSLCipher

public abstract static class OpenSSLCipher.EVP_AEAD
extends OpenSSLCipher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenSSLCipher.EVP_AEAD.AES

Nested classes/interfaces inherited from class org.conscrypt.OpenSSLCipher

OpenSSLCipher.EVP_AEAD, OpenSSLCipher.EVP_CIPHER, OpenSSLCipher.Mode, OpenSSLCipher.Padding

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf The byte array containing the bytes written.
protected int	bufCount The number of bytes written.
protected long	evpAead AEAD cipher reference.

Fields inherited from class org.conscrypt.OpenSSLCipher

encodedKey, iv, mode

Constructor Summary

Constructors

Constructor and Description
EVP_AEAD(OpenSSLCipher.Mode mode)

Method Summary

Modifier and Type	Method and Description
protected void	checkSupportedPadding(OpenSSLCipher.Padding padding) Checks whether the cipher supports this particular cipher padding and throws NoSuchPaddingException if it doesn't.
protected int	doFinalInternal(byte[] output, int outputOffset, int maximumLen) API-specific implementation of the final block.
protected AlgorithmParameters	engineGetParameters() Returns the parameters that where used to create this cipher instance.
protected void	engineInitInternal(byte[] encodedKey, AlgorithmParameterSpec params, SecureRandom random) API-specific implementation of initializing the cipher.
protected void	engineUpdateAAD(byte[] input, int inputOffset, int inputLen) Continues a multi-part transformation (encryption or decryption) with Authenticated Additional Data (AAD).
protected abstract long	getEVP_AEAD(int keyLength)
protected int	getOutputSizeForFinal(int inputLen) The size of output if doFinal() is called with this inputLen.
protected 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 org.conscrypt.OpenSSLCipher

checkSupportedKeySize, checkSupportedMode, engineDoFinal, engineDoFinal, engineGetBlockSize, engineGetIV, engineGetOutputSize, engineInit, engineInit, engineInit, engineSetMode, engineSetPadding, engineUnwrap, engineUpdate, engineUpdate, engineWrap, getBaseCipherName, getCipherBlockSize, getOutputSizeForUpdate, getPadding, isEncrypting, supportsVariableSizeIv, supportsVariableSizeKey

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineGetKeySize, engineUpdate, engineUpdateAAD

Methods inherited from class java.lang.Object

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

Field Detail

buf

protected byte[] buf

The byte array containing the bytes written.

bufCount

protected int bufCount

The number of bytes written.

evpAead

protected long evpAead

AEAD cipher reference.

Constructor Detail

EVP_AEAD

public EVP_AEAD(OpenSSLCipher.Mode mode)

Method Detail

engineInitInternal

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

Description copied from class: OpenSSLCipher

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

Specified by:

engineInitInternal in class OpenSSLCipher

Throws:

InvalidKeyException

InvalidAlgorithmParameterException

updateInternal

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

Description copied from class: OpenSSLCipher

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

Specified by:

updateInternal in class OpenSSLCipher

Throws:

ShortBufferException

doFinalInternal

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

Description copied from class: OpenSSLCipher

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

Specified by:

doFinalInternal in class OpenSSLCipher

Throws:

IllegalBlockSizeException

BadPaddingException

checkSupportedPadding

protected void checkSupportedPadding(OpenSSLCipher.Padding padding)
                              throws NoSuchPaddingException

Description copied from class: OpenSSLCipher

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

Specified by:

checkSupportedPadding in class OpenSSLCipher

Throws:

NoSuchPaddingException

getOutputSizeForFinal

protected int getOutputSizeForFinal(int inputLen)

Description copied from class: OpenSSLCipher

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.

Specified by:

getOutputSizeForFinal in class OpenSSLCipher

engineUpdateAAD

protected void engineUpdateAAD(byte[] input,
                               int inputOffset,
                               int inputLen)

Description copied from class: CipherSpi

Continues a multi-part transformation (encryption or decryption) with Authenticated Additional Data (AAD). AAD may only be added after the Cipher is initialized and before any data is passed to the instance.

This is only usable with cipher modes that support Authenticated Encryption with Additional Data (AEAD) such as Galois/Counter Mode (GCM).

Overrides:

engineUpdateAAD in class CipherSpi

Parameters:

input - bytes of AAD to use with the cipher

inputOffset - offset within bytes of additional data to add to cipher

inputLen - length of bytes of additional data to add to cipher

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.

Overrides:

engineGetParameters in class OpenSSLCipher

Returns:

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

getEVP_AEAD

protected abstract long getEVP_AEAD(int keyLength)
                             throws InvalidKeyException

Throws:

InvalidKeyException