Top Inners Fields Constructors Methods
org.bouncycastle.jcajce.provider

pack-priv Class BaseCipher

extends CipherSpi
Class Inheritance
Imports
java.io.IOException, java.nio.ByteBuffer, java.security.AlgorithmParameters, .InvalidAlgorithmParameterException, .InvalidKeyException, .InvalidParameterException, .Key, .NoSuchAlgorithmException, .SecureRandom, java.security.spec.AlgorithmParameterSpec, java.util.Arrays, .HashMap, .HashSet, .Map, .Set, javax.crypto.BadPaddingException, .Cipher, .CipherSpi, .IllegalBlockSizeException, .NoSuchPaddingException, .SecretKey, .ShortBufferException, javax.crypto.interfaces.PBEKey, javax.crypto.spec.IvParameterSpec, .PBEParameterSpec, .SecretKeySpec, org.bouncycastle.asn1.DEROctetString, org.bouncycastle.asn1.cms.GCMParameters, org.bouncycastle.crypto.AEADOperatorFactory, .Algorithm, .AuthenticationParametersWithIV, .CryptoServicesRegistrar, .DigestAlgorithm, .IllegalKeyException, .OutputAEADDecryptor, .OutputAEADEncryptor, .OutputCipher, .OutputDecryptor, .OutputEncryptor, .Parameters, .ParametersWithIV, .PasswordBasedDeriver, .SymmetricKey, .SymmetricOperatorFactory, .UpdateOutputStream, org.bouncycastle.crypto.fips.FipsAEADOperatorFactory, .FipsAlgorithm, .FipsParameters, .FipsSHS, .FipsSymmetricOperatorFactory, .FipsUnapprovedOperationError, org.bouncycastle.jcajce.PBKDF1Key, .PBKDF2Key, .PBKDFKey, .PKCS12Key, org.bouncycastle.jcajce.spec.AEADParameterSpec, org.bouncycastle.util.Strings

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
BaseCipher.Builder

Field Summary

Modifier and TypeField and Description
private UpdateOutputStream
aadStream

private Set<Algorithm>
activeAlgorithmSet

private final Algorithm[]
algorithms

private byte[]
associatedData

private final Map<Algorithm, Parameters>
baseParametersMap

private final int
blockSizeInBits

private OutputCipher<Parameters>
cipher

private OutputDecryptor<Parameters>
decryptor

private OutputEncryptor<Parameters>
encryptor

private AlgorithmParameters
engineParams

private final FipsAEADOperatorFactory<T extends FipsParameters>
fipsAeadFactory

private final Class<T>[]
fipsAvailableSpecs

private final FipsSymmetricOperatorFactory<T extends Parameters>
fipsFactory

private final ParametersCreatorProvider<FipsParameters>
fipsParametersProvider

private final BouncyCastleFipsProvider
fipsProvider

private final AEADOperatorFactory<T extends Parameters>
generalAeadFactory

private final Class<T>[]
generalAvailableSpecs

private final SymmetricOperatorFactory<T extends Parameters>
generalFactory

private final ParametersCreatorProvider<Parameters>
generalParametersProvider

private final int
keySizeInBits

private String
modeName

private String
pbeAlgorithm

private PBEParameterSpec
pbeSpec

private final DigestAlgorithm
prf

private UpdateOutputStream
processingStream

private DataArrayOutputStream
resultStream

private final PBEScheme
scheme

Constructor Summary

AccessConstructor and Description
private
BaseCipher(BouncyCastleFipsProvider fipsProvider, int blockSizeInBits, int keySizeInBits, DigestAlgorithm prf, PBEScheme scheme, FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory, SymmetricOperatorFactory<T extends Parameters> generalFactory, FipsAEADOperatorFactory<T extends FipsParameters> fipsAeadFactory, AEADOperatorFactory<T extends Parameters> generalAeadFactory, Class<T>[] availableSpecs, ParametersCreatorProvider<T extends Parameters> fipsParametersCreatorProvider, ParametersCreatorProvider<T extends Parameters> generalParametersCreatorProvider, Map<Algorithm, Parameters> baseParametersMap, Algorithm... algorithms)

Method Summary

Modifier and TypeMethod and Description
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, 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.
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
engineSetMode(String
the cipher mode
mode)

Implements abstract javax.crypto.CipherSpi.engineSetMode.

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

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 void
engineUpdateAAD(byte[]
the buffer containing the AAD
input, int
the offset in src where the AAD input starts
offset, int
the number of AAD bytes
length)

Overrides javax.crypto.CipherSpi.engineUpdateAAD.

Continues a multipart update of the Additional Authentication Data (AAD), using a subset of the provided buffer.
protected void
engineUpdateAAD(ByteBuffer
the buffer containing the AAD
bytebuffer)

Overrides javax.crypto.CipherSpi.engineUpdateAAD.

Continues a multipart update of the Additional Authentication Data (AAD).
protected byte[]
engineWrap(Key
the key to be wrapped
key)

Overrides javax.crypto.CipherSpi.engineWrap.

Wrap a key.
private Algorithm
getAlgorithm()

private static boolean
isAEADMode(Algorithm algorithm)

Inherited from javax.crypto.CipherSpi:
engineDoFinalengineUpdate

Field Detail

aadStreamback to summary
private UpdateOutputStream aadStream
activeAlgorithmSetback to summary
private Set<Algorithm> activeAlgorithmSet
algorithmsback to summary
private final Algorithm[] algorithms
associatedDataback to summary
private byte[] associatedData
baseParametersMapback to summary
private final Map<Algorithm, Parameters> baseParametersMap
blockSizeInBitsback to summary
private final int blockSizeInBits
cipherback to summary
private OutputCipher<Parameters> cipher
decryptorback to summary
private OutputDecryptor<Parameters> decryptor
encryptorback to summary
private OutputEncryptor<Parameters> encryptor
engineParamsback to summary
private AlgorithmParameters engineParams
fipsAeadFactoryback to summary
private final FipsAEADOperatorFactory<T extends FipsParameters> fipsAeadFactory
fipsAvailableSpecsback to summary
private final Class<T>[] fipsAvailableSpecs
fipsFactoryback to summary
private final FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory
fipsParametersProviderback to summary
private final ParametersCreatorProvider<FipsParameters> fipsParametersProvider
fipsProviderback to summary
private final BouncyCastleFipsProvider fipsProvider
generalAeadFactoryback to summary
private final AEADOperatorFactory<T extends Parameters> generalAeadFactory
generalAvailableSpecsback to summary
private final Class<T>[] generalAvailableSpecs
generalFactoryback to summary
private final SymmetricOperatorFactory<T extends Parameters> generalFactory
generalParametersProviderback to summary
private final ParametersCreatorProvider<Parameters> generalParametersProvider
keySizeInBitsback to summary
private final int keySizeInBits
modeNameback to summary
private String modeName
pbeAlgorithmback to summary
private String pbeAlgorithm
pbeSpecback to summary
private PBEParameterSpec pbeSpec
prfback to summary
private final DigestAlgorithm prf
processingStreamback to summary
private UpdateOutputStream processingStream
resultStreamback to summary
private DataArrayOutputStream resultStream
schemeback to summary
private final PBEScheme scheme

Constructor Detail

BaseCipherback to summary
private BaseCipher(BouncyCastleFipsProvider fipsProvider, int blockSizeInBits, int keySizeInBits, DigestAlgorithm prf, PBEScheme scheme, FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory, SymmetricOperatorFactory<T extends Parameters> generalFactory, FipsAEADOperatorFactory<T extends FipsParameters> fipsAeadFactory, AEADOperatorFactory<T extends Parameters> generalAeadFactory, Class<T>[] availableSpecs, ParametersCreatorProvider<T extends Parameters> fipsParametersCreatorProvider, ParametersCreatorProvider<T extends Parameters> generalParametersCreatorProvider, Map<Algorithm, Parameters> baseParametersMap, Algorithm... algorithms)

Method Detail

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

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 IllegalBlockSizeException, BadPaddingException, ShortBufferException

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

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
ShortBufferException:
if the given output buffer is too small to hold the result
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

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

engineGetKeySizeback to summary
protected int engineGetKeySize(Key key)

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

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)

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

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

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

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, 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

Exceptions
InvalidKeyException:
if the given key is inappropriate for initializing this cipher, or requires algorithm parameters that cannot be determined from the given key
engineSetModeback to summary
protected void engineSetMode(String mode) throws NoSuchAlgorithmException

Implements abstract javax.crypto.CipherSpi.engineSetMode.

Doc from javax.crypto.CipherSpi.engineSetMode.

Sets the mode of this cipher.

Parameters
mode:String

the cipher mode

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

Implements abstract javax.crypto.CipherSpi.engineSetPadding.

Doc from javax.crypto.CipherSpi.engineSetPadding.

Sets the padding mechanism of this cipher.

Parameters
padding:String

the padding mechanism

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

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

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

Exceptions
ShortBufferException:
if the given output buffer is too small to hold the result
engineUpdateAADback to summary
protected void engineUpdateAAD(byte[] input, int offset, int length)

Overrides javax.crypto.CipherSpi.engineUpdateAAD.

Doc from javax.crypto.CipherSpi.engineUpdateAAD.

Continues a multipart update of the Additional Authentication Data (AAD), using a subset of the provided buffer.

Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM or CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

Parameters
input:byte[]

the buffer containing the AAD

offset:int

the offset in src where the AAD input starts

length:int

the number of AAD bytes

engineUpdateAADback to summary
protected void engineUpdateAAD(ByteBuffer bytebuffer)

Overrides javax.crypto.CipherSpi.engineUpdateAAD.

Doc from javax.crypto.CipherSpi.engineUpdateAAD.

Continues a multipart update of the Additional Authentication Data (AAD).

Calls to this method provide AAD to the cipher when operating in modes such as AEAD (GCM or CCM). If this cipher is operating in either GCM or CCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

All src.remaining() bytes starting at src.position() are processed. Upon return, the input buffer's position will be equal to its limit; its limit will not have changed.

Parameters
bytebuffer:ByteBuffer

the buffer containing the AAD

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

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)
getAlgorithmback to summary
private Algorithm getAlgorithm()
isAEADModeback to summary
private static boolean isAEADMode(Algorithm algorithm)
org.bouncycastle.jcajce.provider back to summary

pack-priv Class BaseCipher.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final Algorithm[]
algorithms

private Class<T>[]
availableSpecs

private final Map<Algorithm, Parameters>
baseParametersMap

private final int
blockSize

private FipsAEADOperatorFactory<T extends FipsParameters>
fipsAeadFactory

private FipsSymmetricOperatorFactory<T extends Parameters>
fipsFactory

private ParametersCreatorProvider<T extends Parameters>
fipsParametersProvider

private final BouncyCastleFipsProvider
fipsProvider

private AEADOperatorFactory<T extends Parameters>
generalAeadFactory

private SymmetricOperatorFactory<T extends Parameters>
generalFactory

private ParametersCreatorProvider<T extends Parameters>
generalParametersProvider

private int
keySizeInBits

private DigestAlgorithm
prf

private PBEScheme
scheme

Constructor Summary

AccessConstructor and Description
pack-priv
Builder(BouncyCastleFipsProvider fipsProvider, int blockSize, Parameters... parameters)

Method Summary

Modifier and TypeMethod and Description
pack-priv BaseCipher
build()

pack-priv BaseCipher.Builder
withFipsOperators(ParametersCreatorProvider<T extends Parameters> fipsParametersProvider, FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory)

pack-priv BaseCipher.Builder
withFipsOperators(ParametersCreatorProvider<T extends Parameters> fipsParametersProvider, FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory, FipsAEADOperatorFactory<T extends FipsParameters> fipsAeadFactory)

pack-priv BaseCipher.Builder
withFixedKeySize(int keySizeInBits)

pack-priv BaseCipher.Builder
withGeneralOperators(ParametersCreatorProvider<T extends Parameters> generalParametersProvider, SymmetricOperatorFactory<T extends Parameters> generalFactory, AEADOperatorFactory<T extends Parameters> generalAeadFactory)

pack-priv BaseCipher.Builder
withParameters(Class<T>[] availableSpecs)

pack-priv BaseCipher.Builder
withPrf(DigestAlgorithm prf)

pack-priv BaseCipher.Builder
withScheme(PBEScheme scheme)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmsback to summary
private final Algorithm[] algorithms
availableSpecsback to summary
private Class<T>[] availableSpecs
baseParametersMapback to summary
private final Map<Algorithm, Parameters> baseParametersMap
blockSizeback to summary
private final int blockSize
fipsAeadFactoryback to summary
private FipsAEADOperatorFactory<T extends FipsParameters> fipsAeadFactory
fipsFactoryback to summary
private FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory
fipsParametersProviderback to summary
private ParametersCreatorProvider<T extends Parameters> fipsParametersProvider
fipsProviderback to summary
private final BouncyCastleFipsProvider fipsProvider
generalAeadFactoryback to summary
private AEADOperatorFactory<T extends Parameters> generalAeadFactory
generalFactoryback to summary
private SymmetricOperatorFactory<T extends Parameters> generalFactory
generalParametersProviderback to summary
private ParametersCreatorProvider<T extends Parameters> generalParametersProvider
keySizeInBitsback to summary
private int keySizeInBits
prfback to summary
private DigestAlgorithm prf
schemeback to summary
private PBEScheme scheme

Constructor Detail

Builderback to summary
pack-priv Builder(BouncyCastleFipsProvider fipsProvider, int blockSize, Parameters... parameters)

Method Detail

buildback to summary
pack-priv BaseCipher build()
withFipsOperatorsback to summary
pack-priv BaseCipher.Builder withFipsOperators(ParametersCreatorProvider<T extends Parameters> fipsParametersProvider, FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory)
withFipsOperatorsback to summary
pack-priv BaseCipher.Builder withFipsOperators(ParametersCreatorProvider<T extends Parameters> fipsParametersProvider, FipsSymmetricOperatorFactory<T extends Parameters> fipsFactory, FipsAEADOperatorFactory<T extends FipsParameters> fipsAeadFactory)
withFixedKeySizeback to summary
pack-priv BaseCipher.Builder withFixedKeySize(int keySizeInBits)
withGeneralOperatorsback to summary
pack-priv BaseCipher.Builder withGeneralOperators(ParametersCreatorProvider<T extends Parameters> generalParametersProvider, SymmetricOperatorFactory<T extends Parameters> generalFactory, AEADOperatorFactory<T extends Parameters> generalAeadFactory)
withParametersback to summary
pack-priv BaseCipher.Builder withParameters(Class<T>[] availableSpecs)
withPrfback to summary
pack-priv BaseCipher.Builder withPrf(DigestAlgorithm prf)
withSchemeback to summary
pack-priv BaseCipher.Builder withScheme(PBEScheme scheme)