java.lang.Object
- javax.crypto.CipherSpi
- - com.ibm.crypto.hdwrCCA.provider.PBEWithMD2AndTripleDESCipher

```
public final class PBEWithMD2AndTripleDESCipher
extends javax.crypto.CipherSpi
```
This class implements a proprietary password-based encryption algorithm. It is based on password-based encryption as defined by the PKCS #5 standard, except that is uses triple DES instead of DES.

See Also:

Cipher

Field Summary

Fields
Modifier and Type Field Description

protected DESedeCipher desCipher

protected int iCount

protected byte[] salt

Constructor Summary

Constructors
Constructor Description

PBEWithMD2AndTripleDESCipher()
Creates an instance of this cipher, and initializes its mode (CBC) and padding (PKCS5).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.AlgorithmParameters params, java.security.SecureRandom random)`	Initializes this cipher with an opmode, akey, 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 an opmode, a key and a source of randomness.
`protected void`	`engineInit(int opmode, java.security.Key key, java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random)`	Initializes this cipher with an opmode, a key, a set of algorithm parameters, and a source of randomness.
`protected void`	`engineSetMode(java.lang.String mode)`	Sets the mode of this cipher.
`protected void`	`engineSetPadding(java.lang.String paddingScheme)`	Sets the padding mechanism of this cipher.
`protected java.security.Key`	`engineUnwrap(byte[] wrappedKey, java.lang.String wrappedKeyAlgorithm, int wrappedKeyType)`	Unwrap a previously wrapped key.
`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.
`protected byte[]`	`engineWrap(java.security.Key key)`	Wrap a key.

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

- Field Detail
  - desCipher
```
protected DESedeCipher desCipher
```
  - salt
```
protected byte[] salt
```
  - iCount
```
protected int iCount
```
- Constructor Detail
  - PBEWithMD2AndTripleDESCipher
```
public PBEWithMD2AndTripleDESCipher()
                             throws java.security.NoSuchAlgorithmException,
                                    javax.crypto.NoSuchPaddingException
```
    Creates an instance of this cipher, and initializes its mode (CBC) and padding (PKCS5). Verify the JCE framework in the constructor.
    
    Throws:
    
    java.security.NoSuchAlgorithmException - if the required cipher mode (CBC) is unavailable
    
    javax.crypto.NoSuchPaddingException - if the required padding mechanism (PKCS5Padding) is unavailable
    
    java.lang.SecurityException - if fails to verify the JCE framework.
- Method Detail
  - engineSetMode
```
protected void engineSetMode(java.lang.String mode)
                      throws java.security.NoSuchAlgorithmException
```
    Sets the mode of this cipher. This algorithm can only be run in CBC mode.
    
    Specified by:
    
    engineSetMode in class javax.crypto.CipherSpi
    
    Parameters:
    
    mode - the cipher mode
    
    Throws:
    
    java.security.NoSuchAlgorithmException - if the requested cipher mode is invalid
  - engineSetPadding
```
protected void engineSetPadding(java.lang.String paddingScheme)
                         throws javax.crypto.NoSuchPaddingException
```
    Sets the padding mechanism of this cipher. This algorithm only uses PKCS #5 padding.
    
    Specified by:
    
    engineSetPadding in class javax.crypto.CipherSpi
    
    Parameters:
    
    paddingScheme - the padding mechanism
    
    Throws:
    
    javax.crypto.NoSuchPaddingException - if the requested padding mechanism is invalid
  - engineGetBlockSize
```
protected int engineGetBlockSize()
```
    Returns the block size (in bytes).
    
    Specified by:
    
    engineGetBlockSize in class javax.crypto.CipherSpi
    
    Returns:
    
    the block size (in bytes)
  - engineGetOutputSize
```
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).
    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.
    
    Specified by:
    
    engineGetOutputSize in class javax.crypto.CipherSpi
    
    Parameters:
    
    inputLen - the input length (in bytes)
    
    Returns:
    
    the required output buffer size (in bytes)
  - engineGetIV
```
protected byte[] engineGetIV()
```
    Returns the initialization vector (IV) in a new buffer.
    This is useful in the case where a random IV has been created or in the context of password-based encryption or decryption, where the IV is derived from a user-supplied password.
    
    Specified by:
    
    engineGetIV in class javax.crypto.CipherSpi
    
    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.
  - engineGetParameters
```
protected java.security.AlgorithmParameters 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 the default set of parameters or a set of randomly generated parameters used by the underlying cipher implementation (provided that the underlying cipher implementation uses a default set of parameters or creates new parameters if it needs parameters but was not initialized with any).
    
    Specified by:
    
    engineGetParameters in class javax.crypto.CipherSpi
    
    Returns:
    
    the parameters used with this cipher, or null if this cipher does not use any parameters.
  - engineInit
```
protected void engineInit(int opmode,
                          java.security.Key key,
                          java.security.SecureRandom random)
                   throws java.security.InvalidKeyException
```
    Initializes this cipher with an opmode, a key and a source of randomness. 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 (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random.
    
    Specified by:
    
    engineInit in class javax.crypto.CipherSpi
    
    Parameters:
    
    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 key
    
    random - the source of randomness
    
    Throws:
    
    java.security.InvalidKeyException - if the given key is inappropriate for initializing this cipher
  - engineInit
```
protected void engineInit(int opmode,
                          java.security.Key key,
                          java.security.spec.AlgorithmParameterSpec params,
                          java.security.SecureRandom random)
                   throws java.security.InvalidKeyException,
                          java.security.InvalidAlgorithmParameterException
```
    Initializes this cipher with an opmode, a key, a set of algorithm parameters, and a source of randomness. 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 (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random.
    
    Specified by:
    
    engineInit in class javax.crypto.CipherSpi
    
    Parameters:
    
    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 key
    
    params - the algorithm parameter spec
    
    random - the source of randomness
    
    Throws:
    
    java.security.InvalidKeyException - if the given key is inappropriate for initializing this cipher
    
    java.security.InvalidAlgorithmParameterException - if the given algorithm parameters are inappropriate for this cipher
  - engineInit
```
protected void engineInit(int opmode,
                          java.security.Key key,
                          java.security.AlgorithmParameters params,
                          java.security.SecureRandom random)
                   throws java.security.InvalidKeyException,
                          java.security.InvalidAlgorithmParameterException
```
    Initializes this cipher with an opmode, akey, a set of algorithm parameters, and a source of randomness. 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 (including its underlying feedback or padding scheme) requires any random bytes, it will get them from random.
    
    Specified by:
    
    engineInit in class javax.crypto.CipherSpi
    
    Parameters:
    
    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 key
    
    params - the algorithm parameters
    
    random - the source of randomness
    
    Throws:
    
    java.security.InvalidKeyException - if the given key is inappropriate for initializing this cipher
    
    java.security.InvalidAlgorithmParameterException - if the given algorithm parameters are inappropriate for this cipher
  - engineUpdate
```
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.
    The first inputLen bytes in the input buffer, starting at inputOffset, are processed, and the result is stored in a new buffer.
    
    Specified by:
    
    engineUpdate in class javax.crypto.CipherSpi
    
    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
  - engineUpdate
```
protected int engineUpdate(byte[] input,
                           int inputOffset,
                           int inputLen,
                           byte[] output,
                           int outputOffset)
                    throws javax.crypto.ShortBufferException
```
    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.
    
    Specified by:
    
    engineUpdate in class javax.crypto.CipherSpi
    
    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:
    
    javax.crypto.ShortBufferException - if the given output buffer is too small to hold the result
  - engineDoFinal
```
protected byte[] engineDoFinal(byte[] input,
                               int inputOffset,
                               int inputLen)
                        throws javax.crypto.IllegalBlockSizeException,
                               javax.crypto.BadPaddingException
```
    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.
    
    Specified by:
    
    engineDoFinal in class javax.crypto.CipherSpi
    
    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:
    
    javax.crypto.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
    
    javax.crypto.BadPaddingException - if decrypting and padding is choosen, but the last input data does not have proper padding bytes.
  - engineDoFinal
```
protected int engineDoFinal(byte[] input,
                            int inputOffset,
                            int inputLen,
                            byte[] output,
                            int outputOffset)
                     throws javax.crypto.ShortBufferException,
                            javax.crypto.IllegalBlockSizeException,
                            javax.crypto.BadPaddingException
```
    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.
    
    Specified by:
    
    engineDoFinal in class javax.crypto.CipherSpi
    
    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:
    
    javax.crypto.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
    
    javax.crypto.ShortBufferException - if the given output buffer is too small to hold the result
    
    javax.crypto.BadPaddingException - if decrypting and padding is choosen, but the last input data does not have proper padding bytes.
  - engineGetKeySize
```
protected int engineGetKeySize(java.security.Key key)
```
    Returns the key size of the given key object.
    
    Overrides:
    
    engineGetKeySize in class javax.crypto.CipherSpi
    
    Parameters:
    
    key - the key object.
    
    Returns:
    
    the key size of the given key object as determined by the underlying DESede cipher implementation.
  - engineWrap
```
protected byte[] engineWrap(java.security.Key key)
                     throws javax.crypto.IllegalBlockSizeException,
                            java.security.InvalidKeyException
```
    Wrap a key.
    Overrides:
    
    engineWrap in class javax.crypto.CipherSpi
    
    Parameters:
    
    key - the key to be wrapped. This key must be a RAW Cipher.SECRET_KEY. This cipher does not support wrapping secret keys of type ICSFToken or type CKDSLabel, and does not support wrapping Cipher.PRIVATE_KEY or Cipher.PUBLIC_KEY.
    
    Returns:
    
    the wrapped key.
    
    Throws:
    
    javax.crypto.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.
    
    java.security.InvalidKeyException - if any of the following is true:
    
    it is impossible or unsafe to wrap the key with this cipher (for example, a hardware protected key is being passed to a software only cipher)
    the key is a Cipher.PRIVATE_KEY
    the key is a Cipher.PUBLIC_KEY
    the key is a Cipher.SECRET_KEY but is not type RAW key
  - engineUnwrap
```
protected java.security.Key engineUnwrap(byte[] wrappedKey,
                                         java.lang.String wrappedKeyAlgorithm,
                                         int wrappedKeyType)
                                  throws java.security.InvalidKeyException,
                                         java.security.NoSuchAlgorithmException
```
    Unwrap a previously wrapped key.
    Overrides:
    
    engineUnwrap in class javax.crypto.CipherSpi
    
    Parameters:
    
    wrappedKey - the key to be unwrapped.
    
    wrappedKeyAlgorithm - the algorithm the wrapped key is for.
    
    wrappedKeyType - the type of the wrapped key. This must be Cipher.SECRET_KEY. This cipher does not support unwrapping a key of type Cipher.PRIVATE_KEY or Cipher.PUBLIC_KEY.
    
    Returns:
    
    the unwrapped key.
    
    Throws:
    
    java.security.InvalidKeyException - if any of the following is true:
    
    wrappedKey does not represent a wrapped key
    the algorithm associated with the wrapped key is different from wrappedKeyAlgorithm
    its key type is different from wrappedKeyType
    the wrappedKeyType parameter is not Cipher.SECRET_KEY
    
    java.security.NoSuchAlgorithmException - if no installed providers can create keys for the wrappedKeyAlgorithm.

Modifier and Type	Field	Description
`protected DESedeCipher`	`desCipher`
`protected int`	`iCount`
`protected byte[]`	`salt`

Class PBEWithMD2AndTripleDESCipher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.crypto.CipherSpi

Methods inherited from class java.lang.Object

Field Detail

desCipher

salt

iCount

Constructor Detail

PBEWithMD2AndTripleDESCipher

Method Detail

engineSetMode

engineSetPadding

engineGetBlockSize

engineGetOutputSize

engineGetIV

engineGetParameters

engineInit

engineInit

engineInit

engineUpdate

engineUpdate

engineDoFinal

engineDoFinal

engineGetKeySize

engineWrap

engineUnwrap