Class CipherSpi
- Direct Known Subclasses:
CipherSpi.NoPadding
public class CipherSpi extends BaseCipherSpi
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCipherSpi.NoPaddingclasses that inherit from us. -
Field Summary
Fields inherited from class org.bouncycastle.jcajce.provider.asymmetric.util.BaseCipherSpi
wrapEngine -
Constructor Summary
Constructors Constructor Description CipherSpi(boolean publicKeyOnly, boolean privateKeyOnly, AsymmetricBlockCipher engine)CipherSpi(OAEPParameterSpec pSpec)CipherSpi(AsymmetricBlockCipher engine) -
Method Summary
Modifier and Type Method Description protected byte[]engineDoFinal(byte[] input, int inputOffset, int inputLen)Finishes a multi-part transformation (encryption or decryption).protected intengineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)Finishes a multi-part transformation (encryption or decryption).protected intengineGetBlockSize()Returns the block size of this cipher (in bytes)protected intengineGetKeySize(Key key)Returns the size of a specified key object in bits.protected intengineGetOutputSize(int inputLen)Returns the size for a buffer (in bytes), that the next call toupdateofdoFinalwould return, taking into account any buffered data from previousupdatecalls and padding.protected AlgorithmParametersengineGetParameters()Returns the parameters that where used to create this cipher instance.protected voidengineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random)Initializes this cipher instance with the specified key, algorithm parameters and a source of randomness.protected voidengineInit(int opmode, Key key, SecureRandom random)Initializes this cipher instance with the specified key and a source of randomness.protected voidengineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random)Initializes this cipher instance with the specified key, algorithm parameters and a source of randomness.protected voidengineSetMode(String mode)Sets the mode for this cipher.protected voidengineSetPadding(String padding)Sets the padding method for this cipher.protected byte[]engineUpdate(byte[] input, int inputOffset, int inputLen)Continues a multi-part transformation (encryption or decryption).protected intengineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)Continues a multi-part transformation (encryption or decryption).Methods inherited from class org.bouncycastle.jcajce.provider.asymmetric.util.BaseCipherSpi
engineGetIV, engineUnwrap, engineWrapMethods inherited from class javax.crypto.CipherSpi
engineDoFinal, engineUpdate, engineUpdateAAD, engineUpdateAAD
-
Constructor Details
-
CipherSpi
-
CipherSpi
-
CipherSpi
-
-
Method Details
-
engineGetBlockSize
protected int engineGetBlockSize()Description copied from class:CipherSpiReturns the block size of this cipher (in bytes)- Overrides:
engineGetBlockSizein classBaseCipherSpi- Returns:
- the block size of this cipher, or zero if this cipher is not a block cipher.
-
engineGetKeySize
Description copied from class:CipherSpiReturns the size of a specified key object in bits. This method has been added to this class (for backwards compatibility, it cannot be abstract). If this method is not overridden, it throws anUnsupportedOperationException.- Overrides:
engineGetKeySizein classBaseCipherSpi- Parameters:
key- the key to get the size for.- Returns:
- the size of a specified key object in bits.
-
engineGetOutputSize
protected int engineGetOutputSize(int inputLen)Description copied from class:CipherSpiReturns the size for a buffer (in bytes), that the next call toupdateofdoFinalwould return, taking into account any buffered data from previousupdatecalls and padding.The actual output length of the next call to
updateordoFinalmay be smaller than the length returned by this method.- Overrides:
engineGetOutputSizein classBaseCipherSpi- Parameters:
inputLen- the length of the input (in bytes).- Returns:
- the size for a buffer (in bytes).
-
engineGetParameters
Description copied from class:CipherSpiReturns 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:
engineGetParametersin classBaseCipherSpi- Returns:
- the parameters that where used to create this cipher instance, or
nullif this cipher instance does not have any parameters at all.
-
engineSetMode
Description copied from class:CipherSpiSets the mode for this cipher.- Overrides:
engineSetModein classBaseCipherSpi- Parameters:
mode- the name of the cipher mode.- Throws:
NoSuchAlgorithmException- if the specified cipher mode is not supported by this provider.
-
engineSetPadding
Description copied from class:CipherSpiSets the padding method for this cipher.- Overrides:
engineSetPaddingin classBaseCipherSpi- Parameters:
padding- the name of the padding method.- Throws:
NoSuchPaddingException- if the specified padding method is not supported by this cipher.
-
engineInit
protected void engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterExceptionDescription copied from class:CipherSpiInitializes 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
paramsisnull, the underlying implementation of this cipher is supposed to generate the required parameters (using its provider or random values). Random values are generated usingrandom.When a cipher instance is initialized by a call to any of the
initmethods, the state of the instance is overridden, means it is equivalent to creating a new instance and calling itinitmethod.- Specified by:
engineInitin classCipherSpi- Parameters:
opmode- the operation this cipher instance should be initialized for (one of:ENCRYPT_MODE,DECRYPT_MODE,WRAP_MODEorUNWRAP_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, InvalidAlgorithmParameterExceptionDescription copied from class:CipherSpiInitializes 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
paramsisnull, the underlying implementation of this cipher is supposed to generate the required parameters (using its provider or random values). Random values are generated usingrandom.When a cipher instance is initialized by a call to any of the
initmethods, the state of the instance is overridden, means it is equivalent to creating a new instance and calling itinitmethod.- Specified by:
engineInitin classCipherSpi- Parameters:
opmode- the operation this cipher instance should be initialized for (one of:ENCRYPT_MODE,DECRYPT_MODE,WRAP_MODEorUNWRAP_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.
-
engineInit
Description copied from class:CipherSpiInitializes 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
initmethods, the state of the instance is overridden, means it is equivalent to creating a new instance and calling itinitmethod.- Specified by:
engineInitin classCipherSpi- Parameters:
opmode- the operation this cipher instance should be initialized for (one of:ENCRYPT_MODE,DECRYPT_MODE,WRAP_MODEorUNWRAP_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.
-
engineUpdate
protected byte[] engineUpdate(byte[] input, int inputOffset, int inputLen)Description copied from class:CipherSpiContinues a multi-part transformation (encryption or decryption). The transformed bytes are returned.- Specified by:
engineUpdatein classCipherSpi- 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
nullif the input has zero length.
-
engineUpdate
protected int engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)Description copied from class:CipherSpiContinues a multi-part transformation (encryption or decryption). The transformed bytes are stored in theoutputbuffer.If the size of the
outputbuffer is too small to hold the result, aShortBufferExceptionis thrown. UsegetOutputSizeto check for the size of the output buffer.- Specified by:
engineUpdatein classCipherSpi- 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.
-
engineDoFinal
protected byte[] engineDoFinal(byte[] input, int inputOffset, int inputLen) throws IllegalBlockSizeException, BadPaddingExceptionDescription copied from class:CipherSpiFinishes a multi-part transformation (encryption or decryption).Processes the
inputLenbytes ininputbuffer atinputOffset, and any bytes that have been buffered in previousupdatecalls.- Specified by:
engineDoFinalin classCipherSpi- 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 IllegalBlockSizeException, BadPaddingExceptionDescription copied from class:CipherSpiFinishes a multi-part transformation (encryption or decryption).Processes the
inputLenbytes ininputbuffer atinputOffset, and any bytes that have been buffered in previousupdatecalls.- Specified by:
engineDoFinalin classCipherSpi- 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:
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.
-