org.bouncycastle.jcajce.provider.asymmetric.rsa

Class CipherSpi

java.lang.Object

javax.crypto.CipherSpi

org.bouncycastle.jcajce.provider.asymmetric.util.BaseCipherSpi

org.bouncycastle.jcajce.provider.asymmetric.rsa.CipherSpi

Direct Known Subclasses:

CipherSpi.NoPadding

public class CipherSpi
extends BaseCipherSpi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CipherSpi.NoPadding classes that inherit from us.

Field Summary

Fields inherited from class org.bouncycastle.jcajce.provider.asymmetric.util.BaseCipherSpi

wrapEngine

Constructor Summary

Constructors

Constructor and Description
CipherSpi(AsymmetricBlockCipher engine)
CipherSpi(boolean publicKeyOnly, boolean privateKeyOnly, AsymmetricBlockCipher engine)
CipherSpi(OAEPParameterSpec pSpec)

Method Summary

Modifier and Type	Method and Description
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 int	engineGetKeySize(Key key) Returns the size of a specified key object in bits.
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 void	engineSetMode(String mode) Sets the mode for this cipher.
protected void	engineSetPadding(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 int	engineUpdate(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

createParametersInstance, engineGetIV, engineUnwrap, engineWrap

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineUpdate, engineUpdateAAD, engineUpdateAAD

Methods inherited from class java.lang.Object

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

Constructor Detail

CipherSpi

public CipherSpi(AsymmetricBlockCipher engine)

CipherSpi

public CipherSpi(OAEPParameterSpec pSpec)

CipherSpi

public CipherSpi(boolean publicKeyOnly,
                 boolean privateKeyOnly,
                 AsymmetricBlockCipher engine)

Method Detail

engineGetBlockSize

protected int engineGetBlockSize()

Description copied from class: CipherSpi

Returns the block size of this cipher (in bytes)

Overrides:

engineGetBlockSize in class BaseCipherSpi

Returns:

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

engineGetKeySize

protected int engineGetKeySize(Key key)

Description copied from class: CipherSpi

Returns 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 an UnsupportedOperationException.

Overrides:

engineGetKeySize in class BaseCipherSpi

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: 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.

Overrides:

engineGetOutputSize in class BaseCipherSpi

Parameters:

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

Returns:

the size for a buffer (in bytes).

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 BaseCipherSpi

Returns:

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

engineSetMode

protected void engineSetMode(String mode)
                      throws NoSuchAlgorithmException

Description copied from class: CipherSpi

Sets the mode for this cipher.

Overrides:

engineSetMode in class BaseCipherSpi

Parameters:

mode - the name of the cipher mode.

Throws:

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

engineSetPadding

protected void engineSetPadding(String padding)
                         throws NoSuchPaddingException

Description copied from class: CipherSpi

Sets the padding method for this cipher.

Overrides:

engineSetPadding in class BaseCipherSpi

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

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.

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)

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.

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

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.