h31591 s 00159/00536/00690 d D 1.3 97/12/09 15:24:40 luehe 4 3 c rm ,* e s 00002/00003/01224 d D 1.2 97/10/10 12:42:05 luehe 3 1 c fixed getProvider javadocs e s 00000/00000/00000 d R 1.2 97/10/09 09:58:13 Codemgr 2 1 c SunPro Code Manager data about conflicts, renames, etc... c Name history : 1 0 security/JCE1.2/earlyaccess/javax.crypto.Cipher.html e s 01227/00000/00000 d D 1.1 97/10/09 09:58:12 luehe 1 0 c date and time created 97/10/09 09:58:12 by luehe e u U f e 0 t T I 1 D 3 E 3 I 3 D 4 E 4 I 4 E 4 E 3 Class javax.crypto.Cipher
D 4
All Packages  Class Hierarchy  This Package  Previous  Next  Index
E 4 I 4 All Packages Class Hierarchy This Package Previous Next Index E 4

Class javax.crypto.Cipher

java.lang.Object
   |
   +----javax.crypto.Cipher

D 4
public abstract class Cipher E 4 I 4
public class Cipher E 4
extends Object D 4
implements Cloneable E 4
super class of:
NullCipher
This class provides the functionality of a cryptographic cipher for encryption and decryption. It forms the core of the Java Cryptographic Extension (JCE) framework. D 4

This class must be implemented by a provider who supports the above cryptographic services and wishes to register them with the Java Security Framework. E 4

In order to create a Cipher object, the application calls the Cipher's getInstance method, and passes the name of the requested transformation to it. Optionally, the name of a provider may be specified.

A transformation is a string that describes the operation (or set of operations) to be performed on the given input, to produce some output. A transformation always includes the name of a cryptographic algorithm (e.g., DES), and may be followed by a feedback mode and padding scheme. A transformation is of the form: D 4 algorithm or algorithm/mode/padding (in the former case, defaults are used for mode and padding). For example, DES/CBC/PKCS5Padding represents a valid transformation.

A provider may supply a separate class for each combination of algorithm/mode/padding, or may decide to provide more generic classes representing sub-transformations corresponding to algorithm or algorithm/mode, whose mode and/or padding schemes can be set using engineSetMode and engineSetPadding, respectively.

For example, a provider may supply a subclass of Cipher that implements DES/ECB/PKCS5Padding, one that implements DES/CBC/PKCS5Padding, one that implements DES/CFB/PKCS5Padding, and yet another one that implements DES/OFB/PKCS5Padding.

A different provider may implement a class for each of the above modes (i.e., one class for ECB, one for CBC, one for CFB, and one for OFB), one class for the PKCS5Padding scheme, and a generic DES class (subclass of Cipher), into which the above mode and padding classes can be "plugged into", using the engineSetMode and engineSetPadding methods.

The algorithm for instantiating a Cipher object (using one of the getInstance methods) when a transformation of the form algorithm is given is as follows:

  1. Check if the provider has registered a subclass of Cipher for the specified algorithm. If the answer is YES, instantiate this class, for whose mode and padding scheme default values (as supplied by the provider) are used. If the answer is NO, throw a NoSuchAlgorithmException exception.

The algorithm for instantiating a Cipher object when a transformation of the form algorithm/mode/padding is given is as follows:

  1. Check if the provider has registered a subclass of Cipher for the specified algorithm/mode/padding transformation. If the answer is YES, instantiate this class and return it to the user. If the answer is NO, go to the next step.
  2. Check if the provider has registered a subclass of Cipher for the sub-transformation algorithm/mode. If the answer is YES, instantiate this class, and call engineSetPadding(padding) on the new instance, before returning it to the user. If the answer is NO, go to the next step.
  3. Check if the provider has registered a subclass of Cipher for the sub-transformation algorithm. If the answer is YES, instantiate this class, and call engineSetMode(mode) and engineSetPadding(padding) on the new instance, before returning it to the user. If the answer is NO, throw a NoSuchAlgorithmException exception.

The methods of Cipher are divided into two groups:

Cipher API (Application Program Interface)
These are the public methods which are visible to applications requesting encryption or decryption.
Cipher SPI (Service Provider Interface)
These are the (abstract) methods that must be implemented by providers of ciphers. Each method in this group is prefixed by the keyword engine, and is called by a correspondingly-named public API method. For example, engineEncryptInit is called by init.
E 4 I 4 "algorithm" or "algorithm/mode/padding" (in the former case, provider-specific defaults are used for mode and padding). For example, "DES/CBC/PKCS5Padding" represents a valid transformation.

When requesting a block cipher in stream cipher mode (e.g., DES in CFB or OFB mode), the user may optionally specify the number of bits to be processed at a time, by appending this number to the mode name as shown in the "DES/CFB8/NoPadding" and "DES/OFB32/PKCS5Padding" transformations. If no such number is specified, a provider-specific default is used. (For example, the Sun JCE provider uses a default of 64 bits.) E 4

See Also:
KeyGenerator, SecretKey, KeyPairGenerator, PublicKey, PrivateKey, AlgorithmParameters, AlgorithmParameterSpec

Variable Index

 o DECRYPT_MODE
 o ENCRYPT_MODE

Constructor Index

 o D 4 Cipher()
E 4 I 4 Cipher(CipherSpi, Provider, String)
Creates a Cipher object. E 4

Method Index

 o doFinal()
Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.
 o doFinal(byte[])
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
 o doFinal(byte[], int)
Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.
 o doFinal(byte[], int, int)
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
 o doFinal(byte[], int, int, byte[])
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
 o doFinal(byte[], int, int, byte[], int)
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
 o D 4 engineDoFinal(byte[], int, int)
SPI: Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
 o engineDoFinal(byte[], int, int, byte[], int)
SPI: Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
 o engineGetBlockSize()
SPI: Returns the block size (in bytes).
 o engineGetIV()
SPI: Returns the initialization vector (IV) in a new buffer.
 o engineGetOutputSize(int)
SPI: 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).
 o engineInit(int, Key, AlgorithmParameterSpec, SecureRandom)
SPI: Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.
 o engineInit(int, Key, SecureRandom)
SPI: Initializes this cipher with a key and a source of randomness.
 o engineSetMode(String)
SPI: Sets the mode of this cipher.
 o engineSetPadding(String)
SPI: Sets the padding mechanism of this cipher.
 o engineUpdate(byte[], int, int)
SPI: Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
 o engineUpdate(byte[], int, int, byte[], int)
SPI: Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
 o E 4 getBlockSize()
Returns the block size (in bytes).
 o getInstance(String)
Creates a Cipher object that implements the specified D 4 algorithm, as supplied by the default provider. E 4 I 4 transformation, as supplied by the default provider. E 4
 o getInstance(String, String)
Creates a Cipher object that implements the specified D 4 algorithm, as supplied by the specified provider. E 4 I 4 transformation, as supplied by the specified provider. E 4
 o getIV()
Returns the initialization vector (IV) in a new buffer.
 o getOutputSize(int)
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).
 o getProvider()
Returns the provider of this Cipher object.
 o init(int, Key)
Initializes this cipher with a key.
 o init(int, Key, AlgorithmParameterSpec)
Initializes this cipher with a key and a set of algorithm parameters.
 o init(int, Key, AlgorithmParameterSpec, SecureRandom)
Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness.
 o init(int, Key, SecureRandom) D 4
Initializes this cipher with a key and a source of randomness. E 4 I 4
Initializes this cipher with a key and a source of randomness. E 4
 o update(byte[])
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
 o update(byte[], int, int)
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
 o update(byte[], int, int, byte[])
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.
 o update(byte[], int, int, byte[], int)
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

Variables

 o ENCRYPT_MODE
 public static final int ENCRYPT_MODE
 o DECRYPT_MODE
 public static final int DECRYPT_MODE

Constructors

D 4  o E 4 I 4  o E 4 Cipher
D 4
 public Cipher()
E 4
I 4
 protected Cipher(CipherSpi cipherSpi,
                  Provider provider,
                  String transformation)
E 4
I 4
Creates a Cipher object.

Parameters:
cipherSpi - the delegate
provider - the provider
transformation - the transformation
E 4

Methods

 o getInstance
D 4
 public static Cipher getInstance(String algorithm) throws NoSuchAlgorithmException, NoSuchPaddingException
E 4
I 4
 public static final Cipher getInstance(String transformation) throws NoSuchAlgorithmException, NoSuchPaddingException
E 4
Creates a Cipher object that implements the specified D 4 algorithm, as supplied by the default provider. E 4 I 4 transformation, as supplied by the default provider. E 4

Parameters: D 4
algorithm - the string representation of the requested algorithm, e.g., DES/CBC/PKCS5Padding E 4 I 4
transformation - the string representation of the requested transformation, e.g., DES/CBC/PKCS5Padding E 4
Returns: D 4
a cipher that implements the requested algorithm E 4 I 4
a cipher that implements the requested transformation E 4
Throws: NoSuchAlgorithmException
if the requested algorithm is not available
Throws: NoSuchPaddingException D 4
if the requested padding is not available E 4 I 4
if the requested padding mechanism is not available E 4
 o getInstance
D 4
 public static Cipher getInstance(String algorithm,
                                  String provider) throws NoSuchAlgorithmException, NoSuchProviderException, NoSuchPaddingException
E 4
I 4
 public static final Cipher getInstance(String transformation,
                                        String provider) throws NoSuchAlgorithmException, NoSuchProviderException, NoSuchPaddingException
E 4
Creates a Cipher object that implements the specified D 4 algorithm, as supplied by the specified provider. E 4 I 4 transformation, as supplied by the specified provider. E 4

Parameters: D 4
algorithm - the string representation of the requested algorithm, e.g., DES/CBC/PKCS5Padding E 4 I 4
transformation - the string representation of the requested transformation, e.g., DES/CBC/PKCS5Padding E 4
provider - the name of the cipher provider
Returns: D 4
a cipher that implements the requested algorithm E 4 I 4
a cipher that implements the requested transformation E 4
Throws: NoSuchAlgorithmException
if the requested algorithm is not available
Throws: NoSuchProviderException D 4
if the requested cipher provider is E 4 I 4
if the requested provider is E 4 not available
Throws: NoSuchPaddingException D 4
if the requested padding is not available E 4 I 4
if the requested padding mechanism is not available E 4
See Also:
Provider
 o getProvider
 public final Provider getProvider()
Returns the provider of this Cipher object.

Returns: D 3
the provider of this Cipher object, or null if the provider has not yet been set E 3 I 3
the provider of this Cipher object E 3
D 4  o engineSetMode
 public abstract void engineSetMode(String mode) throws NoSuchAlgorithmException
SPI: Sets the mode of this cipher.

Parameters:
mode - the cipher mode
Throws: NoSuchAlgorithmException
if the requested cipher mode does not exist
 o engineSetPadding
 public abstract void engineSetPadding(String padding) throws NoSuchPaddingException
SPI: Sets the padding mechanism of this cipher.

Parameters:
padding - the padding mechanism
Throws: NoSuchPaddingException
if the requested padding mechanism does not exist
E 4  o getBlockSize
D 4
 public int getBlockSize()
E 4
I 4
 public final int getBlockSize()
E 4
Returns the block size (in bytes).

Returns:
the block size (in bytes), or 0 if the underlying algorithm is not a block cipher
D 4  o engineGetBlockSize
 protected abstract int engineGetBlockSize()
SPI: Returns the block size (in bytes).

Returns:
the block size (in bytes), or 0 if the underlying algorithm is not a block cipher
E 4  o getOutputSize
D 4
 public int getOutputSize(int inputLen) throws IllegalStateException
E 4
I 4
 public final int getOutputSize(int inputLen) throws IllegalStateException
E 4
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, and padding.

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

Parameters:
inputLen - the input length (in bytes)
Returns:
the required output buffer size (in bytes)
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not yet been initialized)
D 4  o engineGetOutputSize
 protected abstract int engineGetOutputSize(int inputLen) throws IllegalStateException
SPI: 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, and padding.

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

Parameters:
inputLen - the input length (in bytes)
Returns:
the required output buffer size (in bytes)
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not yet been initialized)
E 4  o getIV
D 4
 public byte[] getIV()
E 4
I 4
 public final byte[] getIV()
E 4
Returns the initialization vector (IV) in a new buffer.

This is useful in the case where a random IV has been created (see init), or in the context of password-based encryption or decryption, where the IV is derived from a user-provided passphrase.

Returns:
the initialization vector in a new buffer, or null if the underlying algorithm does not use an IV, or if the IV has not yet been set.
D 4  o engineGetIV
 protected abstract byte[] engineGetIV()
SPI: 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:
the initialization vector in a new buffer, or null if the underlying algorithm does not use an IV, or if the IV has not yet been set.
E 4  o init
D 4
 public void init(int opmode,
                  Key key) throws IllegalStateException, InvalidKeyException
E 4
I 4
 public final void init(int opmode,
                        Key key) throws InvalidKeyException
E 4
Initializes this cipher with a key. D 4 The cipher is initialized for encryption or decryption, depending on E 4 I 4

The cipher is initialized for encryption or decryption, depending on E 4 the value of opmode. I 4

If this cipher requires an initialization vector (IV), it will get it from a system-provided source of randomness. The random IV can be retrieved using getIV. This behaviour should only be used in encryption mode, however. When initializing a cipher that requires an IV for decryption, the IV (same IV that was used for encryption) must be provided explicitly as a parameter, in order to get the correct result.

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. E 4

Parameters:
opmode - the operation mode of this cipher (this is either ENCRYPT_MODE or DECRYPT_MODE)
key - the key D 4
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has already been initialized) E 4
Throws: InvalidKeyException
if the given key is inappropriate for initializing this cipher
 o init
D 4
 public void init(int opmode,
                  Key key,
                  SecureRandom random) throws IllegalStateException, InvalidKeyException
E 4
I 4
 public final void init(int opmode,
                        Key key,
                        SecureRandom random) throws InvalidKeyException
E 4
D 4
Initializes this cipher with a key and a source of randomness. The cipher is initialized for encryption or decryption, depending on E 4 I 4
Initializes this cipher with a key and a source of randomness.

The cipher is initialized for encryption or decryption, depending on E 4 the value of opmode. D 4

If this cipher (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random. E 4 I 4

If this cipher requires an initialization vector (IV), it will get it from random. The random IV can be retrieved using getIV. This behaviour should only be used in encryption mode, however. When initializing a cipher that requires an IV for decryption, the IV (same IV that was used for encryption) must be provided explicitly as a parameter, in order to get the correct result.

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. E 4

Parameters:
opmode - the operation mode of this cipher (this is either ENCRYPT_MODE or DECRYPT_MODE)
key - the encryption key
random - the source of randomness D 4
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has already been initialized) E 4
Throws: InvalidKeyException
if the given key is inappropriate for initializing this cipher
D 4  o engineInit
 protected abstract void engineInit(int opmode,
                                    Key key,
                                    SecureRandom random) throws IllegalStateException, InvalidKeyException
SPI: Initializes this cipher with a key and a source of randomness. The cipher is initialized for encryption or decryption, depending on the value of opmode.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random.

Parameters:
opmode - the operation mode of this cipher (this is either ENCRYPT_MODE or DECRYPT_MODE)
key - the encryption key
random - the source of randomness
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has already been initialized)
Throws: InvalidKeyException
if the given key is inappropriate for initializing this cipher
E 4  o init
D 4
 public void init(int opmode,
                  Key key,
                  AlgorithmParameterSpec params) throws IllegalStateException, InvalidKeyException, InvalidAlgorithmParameterException
E 4
I 4
 public final void init(int opmode,
                        Key key,
                        AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException
E 4
Initializes this cipher with a key and a set of algorithm parameters. D 4 The cipher is initialized for encryption or decryption, depending on E 4 I 4

The cipher is initialized for encryption or decryption, depending on E 4 the value of opmode. I 4

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. E 4

Parameters:
opmode - the operation mode of this cipher (this is either ENCRYPT_MODE or DECRYPT_MODE)
key - the encryption key
params - the algorithm parameters D 4
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has already been initialized) E 4
Throws: InvalidKeyException
if the given key is inappropriate for initializing this cipher
Throws: InvalidAlgorithmParameterException
if the given algorithm parameters are inappropriate for this cipher
 o init
D 4
 public void init(int opmode,
                  Key key,
                  AlgorithmParameterSpec params,
                  SecureRandom random) throws IllegalStateException, InvalidKeyException, InvalidAlgorithmParameterException
E 4
I 4
 public final void init(int opmode,
                        Key key,
                        AlgorithmParameterSpec params,
                        SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException
E 4
Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness. D 4 The cipher is initialized for encryption or decryption, depending on E 4 I 4

The cipher is initialized for encryption or decryption, depending on E 4 the value of opmode.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random. I 4

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. E 4

Parameters:
opmode - the operation mode of this cipher (this is either ENCRYPT_MODE or DECRYPT_MODE)
key - the encryption key
params - the algorithm parameters
random - the source of randomness D 4
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has already been initialized) E 4
Throws: InvalidKeyException
if the given key is inappropriate for initializing this cipher
Throws: InvalidAlgorithmParameterException
if the given algorithm parameters are inappropriate for this cipher
D 4  o engineInit
 protected abstract void engineInit(int opmode,
                                    Key key,
                                    AlgorithmParameterSpec params,
                                    SecureRandom random) throws IllegalStateException, InvalidKeyException, InvalidAlgorithmParameterException
SPI: Initializes this cipher with a key, a set of algorithm parameters, and a source of randomness. The cipher is initialized for encryption or decryption, depending on the value of opmode.

If this cipher (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random.

Parameters:
opmode - the operation mode of this cipher (this is either ENCRYPT_MODE or DECRYPT_MODE)
key - the encryption key
params - the algorithm parameters
random - the source of randomness
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has already been initialized)
Throws: InvalidKeyException
if the given key is inappropriate for initializing this cipher
Throws: InvalidAlgorithmParameterException
if the given algorithm parameters are inappropriate for this cipher
E 4  o update
D 4
 public byte[] update(byte input[]) throws IllegalStateException
E 4
I 4
 public final byte[] update(byte input[]) throws IllegalStateException
E 4
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The bytes in the input buffer are processed, and the result is stored in a new buffer.

Parameters:
input - the input buffer
Returns: D 4
the new buffer with the result E 4 I 4
the new buffer with the result, or null if the underlying cipher is a block cipher and the input data is too short to result in a new block. E 4
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
 o update
D 4
 public byte[] update(byte input[],
                      int inputOffset,
                      int inputLen) throws IllegalStateException
E 4
I 4
 public final byte[] update(byte input[],
                            int inputOffset,
                            int inputLen) throws IllegalStateException
E 4
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

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

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
Returns: D 4
the new buffer with the result E 4 I 4
the new buffer with the result, or null if the underlying cipher is a block cipher and the input data is too short to result in a new block. E 4
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
D 4  o engineUpdate
 protected abstract byte[] engineUpdate(byte input[],
                                        int inputOffset,
                                        int inputLen) throws IllegalStateException
SPI: Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

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

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
Returns:
the new buffer with the result
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
E 4  o update
D 4
 public int update(byte input[],
                   int inputOffset,
                   int inputLen,
                   byte output[]) throws IllegalStateException, ShortBufferException
E 4
I 4
 public final int update(byte input[],
                         int inputOffset,
                         int inputLen,
                         byte output[]) throws IllegalStateException, ShortBufferException
E 4
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

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

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be. E 4

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
output - the buffer for the result
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: ShortBufferException
if the given output buffer is too small to hold the result
 o update
D 4
 public int update(byte input[],
                   int inputOffset,
                   int inputLen,
                   byte output[],
                   int outputOffset) throws IllegalStateException, ShortBufferException
E 4
I 4
 public final int update(byte input[],
                         int inputOffset,
                         int inputLen,
                         byte output[],
                         int outputOffset) throws IllegalStateException, ShortBufferException
E 4
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

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

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be. E 4

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
output - the buffer for the result
outputOffset - the offset in output where the result is stored
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: ShortBufferException
if the given output buffer is too small to hold the result
D 4  o engineUpdate
 protected abstract int engineUpdate(byte input[],
                                     int inputOffset,
                                     int inputLen,
                                     byte output[],
                                     int outputOffset) throws IllegalStateException, ShortBufferException
SPI: Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

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

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
output - the buffer for the result
outputOffset - the offset in output where the result is stored
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: ShortBufferException
if the given output buffer is too small to hold the result
E 4  o doFinal
D 4
 public byte[] doFinal() throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
E 4
I 4
 public final byte[] doFinal() throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
E 4
Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.

Input data that may have been buffered during a previous update operation is processed, with padding (if requested) being applied. The result is stored in a new buffer. D 4

The cipher is reset to its initial state (uninitialized) after this call. E 4

Returns:
the new buffer with the result
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: BadPaddingException
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
 o doFinal
D 4
 public int doFinal(byte output[],
                    int outputOffset) throws IllegalStateException, IllegalBlockSizeException, ShortBufferException, BadPaddingException
E 4
I 4
 public final int doFinal(byte output[],
                          int outputOffset) throws IllegalStateException, IllegalBlockSizeException, ShortBufferException, BadPaddingException
E 4
Finishes a multiple-part encryption or decryption operation, depending on how this cipher was initialized.

Input data that may have been buffered during a previous update operation is processed, with padding (if requested) being applied. The result is stored in the output buffer, starting at outputOffset. D 4

The cipher is reset to its initial state (uninitialized) after this call. E 4 I 4

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be. E 4

Parameters:
output - the buffer for the result
outputOffset - the offset in output where the result is stored
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: ShortBufferException
if the given output buffer is too small to hold the result
Throws: BadPaddingException
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
 o doFinal
D 4
 public byte[] doFinal(byte input[]) throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
E 4
I 4
 public final byte[] doFinal(byte input[]) throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
E 4
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 cipher was initialized.

The bytes in the input buffer, 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. D 4

The cipher is reset to its initial state (uninitialized) after this call. E 4

Parameters:
input - the input buffer
Returns:
the new buffer with the result
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: BadPaddingException
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
 o doFinal
D 4
 public byte[] doFinal(byte input[],
                       int inputOffset,
                       int inputLen) throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
E 4
I 4
 public final byte[] doFinal(byte input[],
                             int inputOffset,
                             int inputLen) throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
E 4
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 cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset, 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. D 4

The cipher is reset to its initial state (uninitialized) after this call. E 4

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
Returns:
the new buffer with the result
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: BadPaddingException
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
D 4  o engineDoFinal
 protected abstract byte[] engineDoFinal(byte input[],
                                         int inputOffset,
                                         int inputLen) throws IllegalStateException, IllegalBlockSizeException, BadPaddingException
SPI: 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 cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset, 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.

The cipher is reset to its initial state (uninitialized) after this call.

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
Returns:
the new buffer with the result
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: BadPaddingException
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
E 4  o doFinal
D 4
 public int doFinal(byte input[],
                    int inputOffset,
                    int inputLen,
                    byte output[]) throws IllegalStateException, ShortBufferException, IllegalBlockSizeException, BadPaddingException
E 4
I 4
 public final int doFinal(byte input[],
                          int inputOffset,
                          int inputLen,
                          byte output[]) throws IllegalStateException, ShortBufferException, IllegalBlockSizeException, BadPaddingException
E 4
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 cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset, 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. D 4

The cipher is reset to its initial state (uninitialized) after this call. E 4 I 4

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be. E 4

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
output - the buffer for the result
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: ShortBufferException
if the given output buffer is too small to hold the result
Throws: BadPaddingException
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
 o doFinal
D 4
 public int doFinal(byte input[],
                    int inputOffset,
                    int inputLen,
                    byte output[],
                    int outputOffset) throws IllegalStateException, ShortBufferException, IllegalBlockSizeException, BadPaddingException
E 4
I 4
 public final int doFinal(byte input[],
                          int inputOffset,
                          int inputLen,
                          byte output[],
                          int outputOffset) throws IllegalStateException, ShortBufferException, IllegalBlockSizeException, BadPaddingException
E 4
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 cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset, 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. D 4

The cipher is reset to its initial state (uninitialized) after this call. E 4 I 4

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer. Use getOutputSize to determine how big the output buffer should be. E 4

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
output - the buffer for the result
outputOffset - the offset in output where the result is stored
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: ShortBufferException
if the given output buffer is too small to hold the result
Throws: BadPaddingException
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
D 4  o engineDoFinal
 protected abstract int engineDoFinal(byte input[],
                                      int inputOffset,
                                      int inputLen,
                                      byte output[],
                                      int outputOffset) throws IllegalStateException, ShortBufferException, IllegalBlockSizeException, BadPaddingException
SPI: 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 cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset, 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.

The cipher is reset to its initial state (uninitialized) after this call.

Parameters:
input - the input buffer
inputOffset - the offset in input where the input starts
inputLen - the input length
output - the buffer for the result
outputOffset - the offset in output where the result is stored
Returns:
the number of bytes stored in output
Throws: IllegalStateException
if this cipher is in a wrong state (e.g., has not been initialized)
Throws: 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
Throws: ShortBufferException
if the given output buffer is too small to hold the result
Throws: BadPaddingException
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
E 4
D 4
All Packages  Class Hierarchy  This Package  Previous  Next  Index
E 4 I 4 All Packages Class Hierarchy This Package Previous Next Index E 4 E 1