|
Bouncy Castle Cryptography 1.11 API Specification: Class JCEBlockCipher
org.bouncycastle.jce.provider
|
Inner Class Summary | |
static class |
JCEBlockCipher.AES
AES |
static class |
JCEBlockCipher.Blowfish
Blowfish |
static class |
JCEBlockCipher.CAST5
CAST5 |
static class |
JCEBlockCipher.CAST6
CAST6 |
static class |
JCEBlockCipher.DES
DES |
static class |
JCEBlockCipher.DESede
DESede |
static class |
JCEBlockCipher.IDEA
IDEA |
static class |
JCEBlockCipher.PBEWithMD5AndDES
PBEWithMD5AndDES |
static class |
JCEBlockCipher.PBEWithMD5AndRC2
PBEWithMD5AndRC2 |
static class |
JCEBlockCipher.PBEWithSHA1AndDES
PBEWithSHA1AndDES |
static class |
JCEBlockCipher.PBEWithSHA1AndRC2
PBEWithSHA1AndRC2 |
static class |
JCEBlockCipher.PBEWithSHAAnd128BitRC2
PBEWithSHAAnd128BitRC2-CBC |
static class |
JCEBlockCipher.PBEWithSHAAnd40BitRC2
PBEWithSHAAnd40BitRC2-CBC |
static class |
JCEBlockCipher.PBEWithSHAAndDES2Key
PBEWithSHAAnd2-KeyTripleDES-CBC |
static class |
JCEBlockCipher.PBEWithSHAAndDES3Key
PBEWithSHAAnd3-KeyTripleDES-CBC |
static class |
JCEBlockCipher.PBEWithSHAAndIDEA
PBEWithSHAAndIDEA-CBC |
static class |
JCEBlockCipher.PBEWithSHAAndTwofish
PBEWithSHAAndTwofish-CBC |
static class |
JCEBlockCipher.RC2
RC2 |
static class |
JCEBlockCipher.RC5
RC5 |
static class |
JCEBlockCipher.RC564
RC564 |
static class |
JCEBlockCipher.RC6
RC6 |
static class |
JCEBlockCipher.Rijndael
Rijndael |
static class |
JCEBlockCipher.Serpent
Serpent |
static class |
JCEBlockCipher.Skipjack
SKIPJACK |
static class |
JCEBlockCipher.Twofish
Twofish |
Inner classes inherited from class org.bouncycastle.jce.provider.WrapCipherSpi |
WrapCipherSpi.AESWrap |
Inner classes inherited from class org.bouncycastle.jce.provider.PBE |
PBE.Util |
Fields inherited from class org.bouncycastle.jce.provider.WrapCipherSpi |
engineParams, pbeHash, pbeIvSize, pbeKeySize, pbeType |
Fields inherited from interface org.bouncycastle.jce.provider.PBE |
MD5, PKCS12, PKCS5S1, PKCS5S2, RIPEMD160, SHA1, TIGER |
Constructor Summary | |
protected |
JCEBlockCipher(BlockCipher engine)
|
protected |
JCEBlockCipher(BlockCipher engine,
int pbeType,
int pbeHash,
int pbeKeySize,
int pbeIvSize)
|
Method Summary | |
protected byte[] |
engineDoFinal(byte[] input,
int inputOffset,
int inputLen)
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. |
protected int |
engineDoFinal(byte[] input,
int inputOffset,
int inputLen,
byte[] output,
int outputOffset)
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. |
protected int |
engineGetBlockSize()
Returns the block size (in bytes). |
protected byte[] |
engineGetIV()
Returns the initialization vector (IV) in a new buffer. |
protected int |
engineGetKeySize(java.security.Key key)
Returns the key size of the given key object. |
protected int |
engineGetOutputSize(int inputLen)
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 java.security.AlgorithmParameters |
engineGetParameters()
Returns the parameters used with this cipher. |
protected void |
engineInit(int opmode,
java.security.Key key,
java.security.spec.AlgorithmParameterSpec params,
java.security.SecureRandom random)
Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness. |
protected void |
engineInit(int opmode,
java.security.Key key,
java.security.AlgorithmParameters params,
java.security.SecureRandom random)
Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness. |
protected void |
engineInit(int opmode,
java.security.Key key,
java.security.SecureRandom random)
Initializes this cipher with a key and a source of randomness. |
protected void |
engineSetMode(java.lang.String mode)
Sets the mode of this cipher. |
protected void |
engineSetPadding(java.lang.String padding)
Sets the padding mechanism of this cipher. |
protected byte[] |
engineUpdate(byte[] input,
int inputOffset,
int inputLen)
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part. |
protected int |
engineUpdate(byte[] input,
int inputOffset,
int inputLen,
byte[] output,
int outputOffset)
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part. |
Methods inherited from class org.bouncycastle.jce.provider.WrapCipherSpi |
engineUnwrap, engineWrap |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected JCEBlockCipher(BlockCipher engine)
protected JCEBlockCipher(BlockCipher engine, int pbeType, int pbeHash, int pbeKeySize, int pbeIvSize)
Method Detail |
protected int engineGetBlockSize()
CipherSpi
engineGetBlockSize
in class WrapCipherSpi
javax.crypto.CipherSpi
protected byte[] engineGetIV()
CipherSpi
This is useful in the context of password-based encryption or decryption, where the IV is derived from a user-provided passphrase.
engineGetIV
in class WrapCipherSpi
javax.crypto.CipherSpi
protected int engineGetKeySize(java.security.Key key)
CipherSpi
This concrete method has been added to this previously-defined
abstract class. It throws an UnsupportedOperationException
if it is not overridden by the provider.
engineGetKeySize
in class WrapCipherSpi
javax.crypto.CipherSpi
key
- the key object.java.security.InvalidKeyException
- if key
is invalid.protected int engineGetOutputSize(int inputLen)
CipherSpi
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, and padding.
The actual output length of the next update
or
doFinal
call may be smaller than the length returned by
this method.
engineGetOutputSize
in class WrapCipherSpi
javax.crypto.CipherSpi
inputLen
- the input length (in bytes)protected java.security.AlgorithmParameters engineGetParameters()
CipherSpi
The returned parameters may be the same that were used to initialize this cipher, or may contain a combination of default and random parameter values used by the underlying cipher implementation if this cipher requires algorithm parameters but was not initialized with any.
engineGetParameters
in class WrapCipherSpi
javax.crypto.CipherSpi
protected void engineSetMode(java.lang.String mode)
CipherSpi
engineSetMode
in class WrapCipherSpi
javax.crypto.CipherSpi
mode
- the cipher modejava.security.NoSuchAlgorithmException
- if the requested cipher mode does not existprotected void engineSetPadding(java.lang.String padding) throws NoSuchPaddingException
CipherSpi
engineSetPadding
in class WrapCipherSpi
javax.crypto.CipherSpi
padding
- the padding mechanismNoSuchPaddingException
- if the requested padding mechanism does not existprotected void engineInit(int opmode, java.security.Key key, java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random) throws java.security.InvalidKeyException, java.security.InvalidAlgorithmParameterException
CipherSpi
The cipher 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 (including its underlying feedback or padding scheme)
requires any random bytes (e.g., for parameter generation), it will get
them from random
.
Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.
engineInit
in class WrapCipherSpi
javax.crypto.CipherSpi
opmode
- the operation mode of this cipher (this is one of the following:
ENCRYPT_MODE
, DECRYPT_MODE
,
WRAP_MODE
or UNWRAP_MODE
)key
- the encryption keyparams
- the algorithm parametersrandom
- the source of randomnessjava.security.InvalidKeyException
- if the given key is inappropriate for initializing this cipherjava.security.InvalidAlgorithmParameterException
- if the given algorithm parameters are inappropriate
for this cipher, or if this cipher is being initialized for decryption and requires
algorithm parameters and params
is null.protected void engineInit(int opmode, java.security.Key key, java.security.AlgorithmParameters params, java.security.SecureRandom random) throws java.security.InvalidKeyException, java.security.InvalidAlgorithmParameterException
CipherSpi
The cipher 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 (including its underlying feedback or padding scheme)
requires any random bytes (e.g., for parameter generation), it will get
them from random
.
Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.
engineInit
in class WrapCipherSpi
javax.crypto.CipherSpi
opmode
- the operation mode of this cipher (this is one of the following:
ENCRYPT_MODE
, DECRYPT_MODE
, WRAP_MODE
or UNWRAP_MODE
)key
- the encryption keyparams
- the algorithm parametersrandom
- the source of randomnessjava.security.InvalidKeyException
- if the given key is inappropriate for initializing this cipherjava.security.InvalidAlgorithmParameterException
- if the given algorithm parameters are inappropriate
for this cipher, or if this cipher is being initialized for decryption and requires
algorithm parameters and params
is null.protected void engineInit(int opmode, java.security.Key key, java.security.SecureRandom random) throws java.security.InvalidKeyException
CipherSpi
The cipher 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 (including its underlying feedback or padding scheme)
requires any random bytes (e.g., for parameter generation), it will get
them from random
.
Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.
engineInit
in class WrapCipherSpi
javax.crypto.CipherSpi
opmode
- the operation mode of this cipher (this is one of
the following:
ENCRYPT_MODE
, DECRYPT_MODE
,
WRAP_MODE
or UNWRAP_MODE
)key
- the encryption keyrandom
- the source of randomnessjava.security.InvalidKeyException
- if the given key is inappropriate for
initializing this cipher, or if this cipher is being initialized for
decryption and requires algorithm parameters that cannot be
determined from the given key.protected byte[] engineUpdate(byte[] input, int inputOffset, int inputLen)
CipherSpi
The first inputLen
bytes in the input
buffer, starting at inputOffset
inclusive, are processed,
and the result is stored in a new buffer.
engineUpdate
in class WrapCipherSpi
javax.crypto.CipherSpi
input
- the input bufferinputOffset
- the offset in input
where the input startsinputLen
- the input lengthprotected int engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
CipherSpi
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.
engineUpdate
in class WrapCipherSpi
javax.crypto.CipherSpi
input
- the input bufferinputOffset
- the offset in input
where the input startsinputLen
- the input lengthoutput
- the buffer for the resultoutputOffset
- the offset in output
where the result is storedoutput
ShortBufferException
- if the given output buffer is too small to hold the resultprotected byte[] engineDoFinal(byte[] input, int inputOffset, int inputLen) throws IllegalBlockSizeException, BadPaddingException
CipherSpi
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.
The result is stored in a new buffer.
A call to this method resets this cipher 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.
engineDoFinal
in class WrapCipherSpi
javax.crypto.CipherSpi
input
- the input bufferinputOffset
- the offset in input
where the input startsinputLen
- the input lengthIllegalBlockSizeException
- 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 sizeBadPaddingException
- if this cipher is in decryption mode, and (un)padding has been requested,
but the decrypted data is not bounded by the appropriate padding bytesprotected int engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws IllegalBlockSizeException, BadPaddingException
CipherSpi
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.
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.
A call to this method resets this cipher 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.
engineDoFinal
in class WrapCipherSpi
javax.crypto.CipherSpi
input
- the input bufferinputOffset
- the offset in input
where the input startsinputLen
- the input lengthoutput
- the buffer for the resultoutputOffset
- the offset in output
where the result is storedoutput
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 sizeShortBufferException
- if the given output buffer is too small to hold the resultBadPaddingException
- if this cipher is in decryption mode, and (un)padding has been requested,
but the decrypted data is not bounded by the appropriate padding bytes
|
Bouncy Castle Cryptography 1.11 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |