Top Description Inners Fields Constructors Methods
org.conscrypt

public abstract Class OpenSSLCipher

extends CipherSpi
Class Inheritance
Known Direct Subclasses
org.conscrypt.OpenSSLCipherChaCha20, org.conscrypt.OpenSSLEvpCipher, org.conscrypt.OpenSSLAeadCipher
Annotations
@Internal
Imports
java.security.AlgorithmParameters, .InvalidAlgorithmParameterException, .InvalidKeyException, .InvalidParameterException, .Key, .KeyFactory, .NoSuchAlgorithmException, .SecureRandom, java.security.spec.AlgorithmParameterSpec, .InvalidKeySpecException, .InvalidParameterSpecException, .PKCS8EncodedKeySpec, .X509EncodedKeySpec, java.util.Arrays, .Locale, javax.crypto.BadPaddingException, .Cipher, .CipherSpi, .IllegalBlockSizeException, .NoSuchPaddingException, .SecretKey, .ShortBufferException, javax.crypto.spec.IvParameterSpec, .SecretKeySpec
An implementation of Cipher using BoringSSL as the backing library.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
OpenSSLCipher.Mode

Modes that a block cipher may support.

pack-priv static enum
OpenSSLCipher.Padding

Paddings that a block cipher may support.

Field Summary

Modifier and TypeField and Description
private int
blockSize

The block size of the current cipher.

pack-priv byte[]
encodedKey

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

private boolean
encrypting

Current cipher mode: encrypting or decrypting.

pack-priv byte[]
iv

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

pack-priv OpenSSLCipher.Mode
mode

The current cipher mode.

private OpenSSLCipher.Padding
padding

The current cipher padding.

Constructor Summary

AccessConstructor and Description
pack-priv
OpenSSLCipher()

pack-priv
OpenSSLCipher(OpenSSLCipher.Mode mode, OpenSSLCipher.Padding padding)

Method Summary

Modifier and TypeMethod and Description
private byte[]
checkAndSetEncodedKey(int opmode, Key key)

pack-priv abstract void
checkSupportedKeySize(int keySize)

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

pack-priv abstract void
checkSupportedMode(OpenSSLCipher.Mode mode)

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

pack-priv abstract void
checkSupportedPadding(OpenSSLCipher.Padding padding)

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

pack-priv abstract int
doFinalInternal(byte[] output, int outputOffset, int maximumLen)

API-specific implementation of the final block.

protected byte[]
engineDoFinal(byte[]
the input buffer
input, int
the offset in input where the input starts
inputOffset, int
the input length
inputLen)

Implements abstract javax.crypto.CipherSpi.engineDoFinal.

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
protected int
engineDoFinal(byte[]
the input buffer
input, int
the offset in input where the input starts
inputOffset, int
the input length
inputLen, byte[]
the buffer for the result
output, int
the offset in output where the result is stored
outputOffset)

Implements abstract javax.crypto.CipherSpi.engineDoFinal.

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
protected int
engineGetBlockSize()

Implements abstract javax.crypto.CipherSpi.engineGetBlockSize.

Returns the block size (in bytes).
protected byte[]
engineGetIV()

Implements abstract javax.crypto.CipherSpi.engineGetIV.

Returns the initialization vector (IV) in a new buffer.
protected int
engineGetKeySize(Key
the key object
key)

Overrides javax.crypto.CipherSpi.engineGetKeySize.

Returns the key size of the given key object in bits.
protected int
engineGetOutputSize(int
the input length (in bytes)
inputLen)

Implements abstract javax.crypto.CipherSpi.engineGetOutputSize.

Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes).
protected AlgorithmParameters
engineGetParameters()

Implements abstract javax.crypto.CipherSpi.engineGetParameters.

Returns the parameters used with this cipher.
protected void
engineInit(int
the operation mode of this CipherSpi object (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)
opmode, Key
the encryption key
key, SecureRandom
the source of randomness
random)

Implements abstract javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key and a source of randomness.
protected void
engineInit(int
the operation mode of this CipherSpi object (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE, or UNWRAP_MODE)
opmode, Key
the encryption key
key, AlgorithmParameterSpec
the algorithm parameters
params, SecureRandom
the source of randomness
random)

Implements abstract javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key, a set of algorithm parameters, and a source of randomness.
protected void
engineInit(int
the operation mode of this CipherSpi object (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE, or UNWRAP_MODE)
opmode, Key
the encryption key
key, AlgorithmParameters
the algorithm parameters
params, SecureRandom
the source of randomness
random)

Implements abstract javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key, a set of algorithm parameters, and a source of randomness.
pack-priv abstract void
engineInitInternal(byte[] encodedKey, AlgorithmParameterSpec params, SecureRandom random)

API-specific implementation of initializing the cipher.

protected void
engineSetMode(String
the cipher mode
modeStr)

Implements abstract javax.crypto.CipherSpi.engineSetMode.

Sets the mode of this cipher.
protected void
engineSetPadding(String
the padding mechanism
paddingStr)

Implements abstract javax.crypto.CipherSpi.engineSetPadding.

Sets the padding mechanism of this cipher.
protected Key
engineUnwrap(byte[]
the key to be unwrapped
wrappedKey, String
the algorithm associated with the wrapped key
wrappedKeyAlgorithm, int
the type of the wrapped key. This is one of SECRET_KEY, PRIVATE_KEY, or PUBLIC_KEY.
wrappedKeyType)

Overrides javax.crypto.CipherSpi.engineUnwrap.

Unwrap a previously wrapped key.
protected byte[]
engineUpdate(byte[]
the input buffer
input, int
the offset in input where the input starts
inputOffset, int
the input length
inputLen)

Implements abstract javax.crypto.CipherSpi.engineUpdate.

Continues a multiple-part encryption or decryption operation (depending on how this CipherSpi object was initialized), processing another data part.
protected int
engineUpdate(byte[]
the input buffer
input, int
the offset in input where the input starts
inputOffset, int
the input length
inputLen, byte[]
the buffer for the result
output, int
the offset in output where the result is stored
outputOffset)

Implements abstract javax.crypto.CipherSpi.engineUpdate.

Continues a multiple-part encryption or decryption operation (depending on how this CipherSpi object was initialized), processing another data part.
protected byte[]
engineWrap(Key
the key to be wrapped
key)

Overrides javax.crypto.CipherSpi.engineWrap.

Wrap a key.
pack-priv abstract String
getBaseCipherName()

Returns the standard name for the particular algorithm.

pack-priv abstract int
getCipherBlockSize()

pack-priv abstract int
getOutputSizeForFinal(int inputLen)

The size of output if doFinal() is called with this inputLen.

pack-priv abstract int
getOutputSizeForUpdate(int inputLen)

The size of output if update() is called with this inputLen.

pack-priv OpenSSLCipher.Padding
getPadding()

Returns the padding type for which this cipher is initialized.

protected AlgorithmParameterSpec
getParameterSpec(AlgorithmParameters params)

pack-priv boolean
isEncrypting()

pack-priv boolean
supportsVariableSizeIv()

pack-priv boolean
supportsVariableSizeKey()

pack-priv abstract int
updateInternal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset, int maximumLen)

API-specific implementation of updating the cipher.

Inherited from javax.crypto.CipherSpi:
engineDoFinalengineUpdateengineUpdateAADengineUpdateAAD

Field Detail

blockSizeback to summary
private int blockSize

The block size of the current cipher.

encodedKeyback to summary
pack-priv byte[] encodedKey

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

encryptingback to summary
private boolean encrypting

Current cipher mode: encrypting or decrypting.

ivback to summary
pack-priv byte[] iv

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

modeback to summary
pack-priv OpenSSLCipher.Mode mode

The current cipher mode.

paddingback to summary
private OpenSSLCipher.Padding padding

The current cipher padding.

Constructor Detail

OpenSSLCipherback to summary
pack-priv OpenSSLCipher()
OpenSSLCipherback to summary
pack-priv OpenSSLCipher(OpenSSLCipher.Mode mode, OpenSSLCipher.Padding padding)

Method Detail

checkAndSetEncodedKeyback to summary
private byte[] checkAndSetEncodedKey(int opmode, Key key) throws InvalidKeyException
checkSupportedKeySizeback to summary
pack-priv abstract void checkSupportedKeySize(int keySize) throws InvalidKeyException

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

checkSupportedModeback to summary
pack-priv abstract void checkSupportedMode(OpenSSLCipher.Mode mode) throws NoSuchAlgorithmException

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

checkSupportedPaddingback to summary
pack-priv abstract void checkSupportedPadding(OpenSSLCipher.Padding padding) throws NoSuchPaddingException

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

doFinalInternalback to summary
pack-priv 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.

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

Implements abstract javax.crypto.CipherSpi.engineDoFinal.

Doc from javax.crypto.CipherSpi.engineDoFinal.

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this CipherSpi object was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode (such as GCM or CCM) is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in a new buffer.

Upon finishing, this method resets this CipherSpi object to the state it was in when previously initialized via a call to engineInit. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to engineInit) more data.

Note

if any exception is thrown, this CipherSpi object may need to be reset before it can be used again.

Parameters
input:byte[]

the input buffer

inputOffset:int

the offset in input where the input starts

inputLen:int

the input length

Returns:byte[]

the new buffer with the result

Annotations
@Override
Exceptions
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 CipherSpi object is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
engineDoFinalback to summary
protected int engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException

Implements abstract javax.crypto.CipherSpi.engineDoFinal.

Doc from javax.crypto.CipherSpi.engineDoFinal.

Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this CipherSpi object was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. If an AEAD mode such as GCM or CCM is being used, the authentication tag is appended in the case of encryption, or verified in the case of decryption. The result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown.

Upon finishing, this method resets this CipherSpi object to the state it was in when previously initialized via a call to engineInit. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to engineInit) more data.

Note

if any exception is thrown, this CipherSpi object may need to be reset before it can be used again.

Parameters
input:byte[]

the input buffer

inputOffset:int

the offset in input where the input starts

inputLen:int

the input length

output:byte[]

the buffer for the result

outputOffset:int

the offset in output where the result is stored

Returns:int

the number of bytes stored in output

Annotations
@Override
Exceptions
ShortBufferException:
if the given output buffer is too small to hold the result
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 CipherSpi object is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
engineGetBlockSizeback to summary
protected int engineGetBlockSize()

Implements abstract javax.crypto.CipherSpi.engineGetBlockSize.

Doc from javax.crypto.CipherSpi.engineGetBlockSize.

Returns the block size (in bytes).

Returns:int

the block size (in bytes), or 0 if the algorithm is not a block cipher

Annotations
@Override
engineGetIVback to summary
protected byte[] engineGetIV()

Implements abstract javax.crypto.CipherSpi.engineGetIV.

Doc from javax.crypto.CipherSpi.engineGetIV.

Returns the initialization vector (IV) in a new buffer.

This is useful in the context of password-based encryption or decryption, where the IV is derived from a user-provided passphrase.

Returns:byte[]

the initialization vector in a new buffer, or null if the algorithm does not use an IV, or if the IV has not yet been set

Annotations
@Override
engineGetKeySizeback to summary
protected int engineGetKeySize(Key key) throws InvalidKeyException

Overrides javax.crypto.CipherSpi.engineGetKeySize.

Doc from javax.crypto.CipherSpi.engineGetKeySize.

Returns the key size of the given key object in bits.

This concrete method has been added to this previously-defined abstract class. It throws an UnsupportedOperationException if it is not overridden by the provider.

Parameters
key:Key

the key object

Returns:int

the key size of the given key object

Annotations
@Override
Exceptions
InvalidKeyException:
if key is invalid
engineGetOutputSizeback to summary
protected int engineGetOutputSize(int inputLen)

Implements abstract javax.crypto.CipherSpi.engineGetOutputSize.

Doc from javax.crypto.CipherSpi.engineGetOutputSize.

Returns the length in bytes that an output buffer would need to be in order to hold the result of the next update or doFinal operation, given the input length inputLen (in bytes).

This call takes into account any unprocessed (buffered) data from a previous update call, padding, and AEAD tagging.

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

Parameters
inputLen:int

the input length (in bytes)

Returns:int

the required output buffer size (in bytes)

Annotations
@Override
engineGetParametersback to summary
protected AlgorithmParameters engineGetParameters()

Implements abstract javax.crypto.CipherSpi.engineGetParameters.

Doc from javax.crypto.CipherSpi.engineGetParameters.

Returns the parameters used with this cipher.

The returned parameters may be the same that were used to initialize this cipher, or may contain additional default or random parameter values used by the underlying cipher implementation. If the required parameters were not supplied and can be generated by the cipher, the generated parameters are returned. Otherwise, null is returned.

Returns:AlgorithmParameters

the parameters used with this cipher, or null

Annotations
@Override
engineInitback to summary
protected void engineInit(int opmode, Key key, SecureRandom random) throws InvalidKeyException

Implements abstract javax.crypto.CipherSpi.engineInit.

Doc from javax.crypto.CipherSpi.engineInit.

Initializes this CipherSpi object with a key and a source of randomness.

The CipherSpi object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters that cannot be derived from the given key, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidKeyException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using engineGetParameters or engineGetIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a CipherSpi object is initialized, it loses all previously-acquired state. In other words, initializing a CipherSpi object is equivalent to creating a new instance of that CipherSpi object and initializing it.

Parameters
opmode:int

the operation mode of this CipherSpi object (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE or UNWRAP_MODE)

key:Key

the encryption key

random:SecureRandom

the source of randomness

Annotations
@Override
Exceptions
InvalidKeyException:
if the given key is inappropriate for initializing this cipher, or requires algorithm parameters that cannot be determined from the given key
engineInitback to summary
protected void engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

Implements abstract javax.crypto.CipherSpi.engineInit.

Doc from javax.crypto.CipherSpi.engineInit.

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

The CipherSpi object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using engineGetParameters or engineGetIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a CipherSpi object is initialized, it loses all previously-acquired state. In other words, initializing a CipherSpi object is equivalent to creating a new instance of that CipherSpi object and initializing it.

Parameters
opmode:int

the operation mode of this CipherSpi object (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE, or UNWRAP_MODE)

key:Key

the encryption key

params:AlgorithmParameterSpec

the algorithm parameters

random:SecureRandom

the source of randomness

Annotations
@Override
Exceptions
InvalidKeyException:
if the given key is inappropriate for initializing this cipher
InvalidAlgorithmParameterException:
if the given algorithm parameters are inappropriate for this cipher, or if this cipher requires algorithm parameters and params is null
engineInitback to summary
protected void engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

Implements abstract javax.crypto.CipherSpi.engineInit.

Doc from javax.crypto.CipherSpi.engineInit.

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

The CipherSpi object is initialized for one of the following four operations: encryption, decryption, key wrapping or key unwrapping, depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption or key wrapping, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption or key unwrapping. The generated parameters can be retrieved using engineGetParameters or engineGetIV (if the parameter is an IV).

If this cipher requires algorithm parameters that cannot be derived from the input parameters, and there are no reasonable provider-specific default values, initialization will necessarily fail.

If this cipher (including its feedback or padding scheme) requires any random bytes (e.g., for parameter generation), it will get them from random.

Note that when a CipherSpi object is initialized, it loses all previously-acquired state. In other words, initializing a CipherSpi object is equivalent to creating a new instance of that CipherSpi object and initializing it.

Parameters
opmode:int

the operation mode of this CipherSpi object (this is one of the following: ENCRYPT_MODE, DECRYPT_MODE, WRAP_MODE, or UNWRAP_MODE)

key:Key

the encryption key

params:AlgorithmParameters

the algorithm parameters

random:SecureRandom

the source of randomness

Annotations
@Override
Exceptions
InvalidKeyException:
if the given key is inappropriate for initializing this cipher
InvalidAlgorithmParameterException:
if the given algorithm parameters are inappropriate for this cipher, or if this cipher requires algorithm parameters and params is null
engineInitInternalback to summary
pack-priv 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.

engineSetModeback to summary
protected void engineSetMode(String modeStr) throws NoSuchAlgorithmException

Implements abstract javax.crypto.CipherSpi.engineSetMode.

Doc from javax.crypto.CipherSpi.engineSetMode.

Sets the mode of this cipher.

Parameters
modeStr:String

the cipher mode

Annotations
@Override
Exceptions
NoSuchAlgorithmException:
if the requested cipher mode does not exist
engineSetPaddingback to summary
protected void engineSetPadding(String paddingStr) throws NoSuchPaddingException

Implements abstract javax.crypto.CipherSpi.engineSetPadding.

Doc from javax.crypto.CipherSpi.engineSetPadding.

Sets the padding mechanism of this cipher.

Parameters
paddingStr:String

the padding mechanism

Annotations
@Override
Exceptions
NoSuchPaddingException:
if the requested padding mechanism does not exist
engineUnwrapback to summary
protected Key engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType) throws InvalidKeyException, NoSuchAlgorithmException

Overrides javax.crypto.CipherSpi.engineUnwrap.

Doc from javax.crypto.CipherSpi.engineUnwrap.

Unwrap a previously wrapped key.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.) It may be overridden by a provider to unwrap a previously wrapped key. Such an override is expected to throw an InvalidKeyException if the given wrapped key cannot be unwrapped. If this method is not overridden, it always throws an UnsupportedOperationException.

Parameters
wrappedKey:byte[]

the key to be unwrapped

wrappedKeyAlgorithm:String

the algorithm associated with the wrapped key

wrappedKeyType:int

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

Returns:Key

the unwrapped key

Annotations
@Override
Exceptions
InvalidKeyException:
if wrappedKey does not represent a wrapped key of type wrappedKeyType for the wrappedKeyAlgorithm
NoSuchAlgorithmException:
if no installed providers can create keys of type wrappedKeyType for the wrappedKeyAlgorithm
engineUpdateback to summary
protected byte[] engineUpdate(byte[] input, int inputOffset, int inputLen)

Implements abstract javax.crypto.CipherSpi.engineUpdate.

Doc from javax.crypto.CipherSpi.engineUpdate.

Continues a multiple-part encryption or decryption operation (depending on how this CipherSpi object was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in a new buffer.

Parameters
input:byte[]

the input buffer

inputOffset:int

the offset in input where the input starts

inputLen:int

the input length

Returns:byte[]

the new buffer with the result, or null if the cipher is a block cipher and the input data is too short to result in a new block

Annotations
@Override
engineUpdateback to summary
protected int engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException

Implements abstract javax.crypto.CipherSpi.engineUpdate.

Doc from javax.crypto.CipherSpi.engineUpdate.

Continues a multiple-part encryption or decryption operation (depending on how this CipherSpi object was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown.

Parameters
input:byte[]

the input buffer

inputOffset:int

the offset in input where the input starts

inputLen:int

the input length

output:byte[]

the buffer for the result

outputOffset:int

the offset in output where the result is stored

Returns:int

the number of bytes stored in output

Annotations
@Override
Exceptions
ShortBufferException:
if the given output buffer is too small to hold the result
engineWrapback to summary
protected byte[] engineWrap(Key key) throws IllegalBlockSizeException, InvalidKeyException

Overrides javax.crypto.CipherSpi.engineWrap.

Doc from javax.crypto.CipherSpi.engineWrap.

Wrap a key.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.) It may be overridden by a provider to wrap a key. Such an override is expected to throw an IllegalBlockSizeException or InvalidKeyException (under the specified circumstances), if the given key cannot be wrapped. If this method is not overridden, it always throws an UnsupportedOperationException.

Parameters
key:Key

the key to be wrapped

Returns:byte[]

the wrapped key

Annotations
@Override
Exceptions
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)
getBaseCipherNameback to summary
pack-priv abstract String getBaseCipherName()

Returns the standard name for the particular algorithm.

getCipherBlockSizeback to summary
pack-priv abstract int getCipherBlockSize()
getOutputSizeForFinalback to summary
pack-priv 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.

getOutputSizeForUpdateback to summary
pack-priv 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.

getPaddingback to summary
pack-priv OpenSSLCipher.Padding getPadding()

Returns the padding type for which this cipher is initialized.

getParameterSpecback to summary
protected AlgorithmParameterSpec getParameterSpec(AlgorithmParameters params) throws InvalidAlgorithmParameterException
isEncryptingback to summary
pack-priv boolean isEncrypting()
supportsVariableSizeIvback to summary
pack-priv boolean supportsVariableSizeIv()
supportsVariableSizeKeyback to summary
pack-priv boolean supportsVariableSizeKey()
updateInternalback to summary
pack-priv 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.

org.conscrypt back to summary

pack-priv final Enum OpenSSLCipher.Mode

extends Enum<OpenSSLCipher.Mode>
Class Inheritance
Modes that a block cipher may support.

Field Summary

Modifier and TypeField and Description
public static final OpenSSLCipher.Mode
CBC

public static final OpenSSLCipher.Mode
CTR

public static final OpenSSLCipher.Mode
ECB

public static final OpenSSLCipher.Mode
GCM

public static final OpenSSLCipher.Mode
GCM_SIV

public static final OpenSSLCipher.Mode
NONE

public static final OpenSSLCipher.Mode
POLY1305

Constructor Summary

AccessConstructor and Description
private
Mode()

Method Summary

Modifier and TypeMethod and Description
public static OpenSSLCipher.Mode
getNormalized(String modeString)

public static OpenSSLCipher.Mode
valueOf(String name)

public static OpenSSLCipher.Mode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CBCback to summary
public static final OpenSSLCipher.Mode CBC
CTRback to summary
public static final OpenSSLCipher.Mode CTR
ECBback to summary
public static final OpenSSLCipher.Mode ECB
GCMback to summary
public static final OpenSSLCipher.Mode GCM
GCM_SIVback to summary
public static final OpenSSLCipher.Mode GCM_SIV
NONEback to summary
public static final OpenSSLCipher.Mode NONE
POLY1305back to summary
public static final OpenSSLCipher.Mode POLY1305

Constructor Detail

Modeback to summary
private Mode()

Method Detail

getNormalizedback to summary
public static OpenSSLCipher.Mode getNormalized(String modeString)
valueOfback to summary
public static OpenSSLCipher.Mode valueOf(String name)
valuesback to summary
public static OpenSSLCipher.Mode[] values()
org.conscrypt back to summary

pack-priv final Enum OpenSSLCipher.Padding

extends Enum<OpenSSLCipher.Padding>
Class Inheritance
Paddings that a block cipher may support.

Field Summary

Modifier and TypeField and Description
public static final OpenSSLCipher.Padding
NOPADDING

public static final OpenSSLCipher.Padding
PKCS5PADDING

public static final OpenSSLCipher.Padding
PKCS7PADDING

Constructor Summary

AccessConstructor and Description
private
Padding()

Method Summary

Modifier and TypeMethod and Description
public static OpenSSLCipher.Padding
getNormalized(String value)

public static OpenSSLCipher.Padding
valueOf(String name)

public static OpenSSLCipher.Padding[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

NOPADDINGback to summary
public static final OpenSSLCipher.Padding NOPADDING
PKCS5PADDINGback to summary
public static final OpenSSLCipher.Padding PKCS5PADDING
PKCS7PADDINGback to summary
public static final OpenSSLCipher.Padding PKCS7PADDING

Constructor Detail

Paddingback to summary
private Padding()

Method Detail

getNormalizedback to summary
public static OpenSSLCipher.Padding getNormalized(String value)
valueOfback to summary
public static OpenSSLCipher.Padding valueOf(String name)
valuesback to summary
public static OpenSSLCipher.Padding[] values()