com.entrust.toolkit.security.spec

Class Cast3ParameterSpec

java.lang.Object

com.entrust.toolkit.security.spec.Cast3ParameterSpec

All Implemented Interfaces:

ASN1Type, java.security.spec.AlgorithmParameterSpec

public class Cast3ParameterSpec
extends java.lang.Object
implements java.security.spec.AlgorithmParameterSpec, ASN1Type

This class implements the Cast3CBCParameter structure. It specifies the initialization vector (IV) and the length of the key (in bits), and is designed for use with Entrust's CAST3 symmetric block cipher implementation.

 Cast3CBCParameter ::= SEQUENCE {
     iv           OCTET STRING OPTIONAL          -- 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.

Since:

7.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes a Cast3ParameterSpec 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 beginning at the specified offset.
void	setKeyLength(int keyLength) Sets the length (size) of the key.
ASN1Object	toASN1Object() Encodes this Cast3ParameterSpec object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this Cast3ParameterSpec object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cast3ParameterSpec

public Cast3ParameterSpec()

The default constructor. It creates a new Cast3ParameterSpec object with a default key length of 64.

Cast3ParameterSpec

public Cast3ParameterSpec(int keyLength)

Creates a new Cast3ParameterSpec object with the specified key length.

Parameters:

keyLength - the key length in bits

Cast3ParameterSpec

public Cast3ParameterSpec(int keyLength,
                          byte[] iv)

Creates a new Cast3ParameterSpec 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

Cast3ParameterSpec

public Cast3ParameterSpec(int keyLength,
                          byte[] iv,
                          int offset)

Creates a new Cast3ParameterSpec 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

Cast3ParameterSpec

public Cast3ParameterSpec(ASN1Object obj)
                   throws CodingException

Creates a new Cast3ParameterSpec from an ASN1Object. The ASN1Object must be a Cast3ParameterSpec structure.

Parameters:

obj - the ASN.1 representation of a Cast3ParameterSpec structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

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

setKeyLength

public void setKeyLength(int keyLength)

Sets the length (size) of the key.

Parameters:

keyLength - the key length in bits

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes a Cast3ParameterSpec from an ASN1Object. The ASN1Object must be a Cast3ParameterSpec structure.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of a Cast3ParameterSpec structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this Cast3ParameterSpec object as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of the CAST128Parameter structure

toString

public java.lang.String toString()

Creates a text representation of the ASN.1 structure of this Cast3ParameterSpec object.

Overrides:

toString in class java.lang.Object

Returns:

a text representation of the ASN.1 structure of this object