CAST128ParameterSpec ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- iaik.security.cipher.CAST128ParameterSpec

All Implemented Interfaces:

ASN1Type, java.security.spec.AlgorithmParameterSpec
```
public class CAST128ParameterSpec
extends java.lang.Object
implements java.security.spec.AlgorithmParameterSpec, ASN1Type
```
This class implements the CAST128 Parameter structure as defined in RFC 2144. It specifies the initialization vector(IV) and the length of the key (in bits), and is designed for use with Entrust's CAST128 (aka CAST5) symmetric block cipher implementation.
```
 CAST128Parameter ::= SEQUENCE {
     iv           OCTET STRING     DEFAULT 0,    -- Initialization vector
     keyLength    INTEGER                        -- Key length, in bits
 }
 
```
As defined in the structure, if no IV is set, a default one of all zeros is used.

Constructor Summary

Constructors
Constructor and Description
`CAST128ParameterSpec()` The default constructor.
`CAST128ParameterSpec(ASN1Object obj)` Creates a new `CAST128ParameterSpec` from an `ASN1Object`.
`CAST128ParameterSpec(int keyLength)` Creates a new `CAST128ParameterSpec` object with the specified component.
`CAST128ParameterSpec(int keyLength, byte[] iv)` Creates a new `CAST128ParameterSpec` object with the specified components.
`CAST128ParameterSpec(int keyLength, byte[] iv, int offset)` Creates a new `CAST128ParameterSpec` object with the specified components.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(ASN1Object obj)` Decodes a `CAST128ParameterSpec` from an `ASN1Object`.
`byte[]`	`getIV()` Returns a copy of the initialization vector(IV).
`int`	`getKeyLength()` Returns the length (size) of the key.
`void`	`setIV(byte[] iv, int offset)` Sets the initialization vector(IV) by copying 8-bytes of data from the byte array begenning at the specified offset.
`void`	`setKeyLength(int keyLength)` Sets the length (size) of the key.
`ASN1Object`	`toASN1Object()` Encodes this `CAST128ParameterSpec` object as an `ASN1Object`.
`java.lang.String`	`toString()` Creates a text representation of the ASN.1 structure of this `CAST128ParameterSpec` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CAST128ParameterSpec
```
public CAST128ParameterSpec()
```
    The default constructor. It creates a new CAST128ParameterSpec object with a default key length of 128.
    
    Since:
    
    Entrust 7.0
  - CAST128ParameterSpec
```
public CAST128ParameterSpec(int keyLength)
```
    Creates a new CAST128ParameterSpec object with the specified component.
    
    Parameters:
    
    keyLength - the key length in bits
  - CAST128ParameterSpec
```
public CAST128ParameterSpec(int keyLength,
                            byte[] iv)
```
    Creates a new CAST128ParameterSpec object with the specified components. The first 8 bytes of the supplied byte array are copied, and used as the initialization vector (IV). If the supplied byte array is null, then the default IV of all zeros is automatically set.
    
    Parameters:
    
    keyLength - the key length in bits
    
    iv - a byte array containing the initialization vector
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if an 8-byte initialization vector could not be extracted from the byte array
  - CAST128ParameterSpec
```
public CAST128ParameterSpec(int keyLength,
                            byte[] iv,
                            int offset)
```
    Creates a new CAST128ParameterSpec object with the specified components. The 8-byte initialization vector(IV) is copied from the supplied byte array starting at the indicated offset. If the supplied byte array is null, then the default IV of all zeros is automatically set.
    
    Parameters:
    
    keyLength - the key length in bits
    
    iv - a byte array containing the initialization vector
    
    offset - the offset in the byte array where the initialization vector begins
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if an 8-byte initialization vector could not be extracted from the byte array
  - CAST128ParameterSpec
```
public CAST128ParameterSpec(ASN1Object obj)
                     throws CodingException
```
    Creates a new CAST128ParameterSpec from an ASN1Object. The ASN1Object must be a CAST128Parameter structure.
    
    Parameters:
    
    obj - the ASN.1 representation of a CAST128Parameter structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
    
    Since:
    
    Entrust 7.0
- Method Detail
  - getIV
```
public byte[] getIV()
```
    Returns a copy of the initialization vector(IV). If no IV has been set, a default one consisting of all zeros is returned.
    
    Returns:
    
    byte [] a copy of the initialization vector
  - getKeyLength
```
public int getKeyLength()
```
    Returns the length (size) of the key.
    
    Returns:
    
    int the key length in bits
  - setIV
```
public void setIV(byte[] iv,
                  int offset)
```
    Sets the initialization vector(IV) by copying 8-bytes of data from the byte array begenning at the specified offset. If the supplied byte array is null, then the default IV of all zeros is automatically set.
    
    Parameters:
    
    iv - a byte array containing the initialization vector
    
    offset - the offset in the byte array where the initialization vector begins
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if an 8-byte initialization vector could not be extracted from the byte array
    
    Since:
    
    Entrust 7.0
  - setKeyLength
```
public void setKeyLength(int keyLength)
```
    Sets the length (size) of the key.
    
    Parameters:
    
    keyLength - the key length in bits
    
    Since:
    
    Entrust 7.0
  - decode
```
public void decode(ASN1Object obj)
            throws CodingException
```
    Decodes a CAST128ParameterSpec from an ASN1Object. The ASN1Object must be a CAST128Parameter structure.
    
    Specified by:
    
    decode in interface ASN1Type
    
    Parameters:
    
    obj - an ASN.1 representation of a CAST128Parameter structure
    
    Throws:
    
    CodingException - thrown if an errors occurs while decoding the ANS1Object
    
    Since:
    
    Entrust 7.0
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Encodes this CAST128ParameterSpec object as an ASN1Object.
    
    Specified by:
    
    toASN1Object in interface ASN1Type
    
    Returns:
    
    an ASN.1 representation of the CAST128Parameter structure
    
    Since:
    
    Entrust 7.0
  - toString
```
public java.lang.String toString()
```
    Creates a text representation of the ASN.1 structure of this CAST128ParameterSpec object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a text representation of the ASN.1 structure of this object
    
    Since:
    
    Entrust 7.0

Class CAST128ParameterSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CAST128ParameterSpec

CAST128ParameterSpec

CAST128ParameterSpec

CAST128ParameterSpec

CAST128ParameterSpec

Method Detail

getIV

getKeyLength

setIV

setKeyLength

decode

toASN1Object

toString