com.entrust.toolkit.security.spec

Class IvParameterSpec

java.lang.Object

javax.crypto.spec.IvParameterSpec

com.entrust.toolkit.security.spec.IvParameterSpec

All Implemented Interfaces:

ASN1Type, java.security.spec.AlgorithmParameterSpec

public class IvParameterSpec
extends javax.crypto.spec.IvParameterSpec
implements java.security.spec.AlgorithmParameterSpec, ASN1Type

This class implements the initialization vector (IV) used by most symmetric ciphers.

It specifies the initialization vector (IV), and is designed for use with any symmetric block cipher implementation. The IV must be the same size as the symmetric cipher block size.

This class is a re-implementation of javax.crypto.spec.IvParameterSpec, that also provides support for ASN1 encoding and decoding of an IV. This class should be used instead of javax.crypto.spec.IvParameterSpec, when ASN1 support is required.

 IVParameter ::= OCTET STRING
 

Since:

7.0

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ASN1Object obj) Decodes an IvParameterSpec object from an ASN1Object.
byte[]	getIV() Returns a copy of the initialization vector (IV).
void	setIV(byte[] iv, int offset, int length) Sets the initialization vector (IV) by copying specified amount of data from the byte array beginning at the specified offset.
ASN1Object	toASN1Object() Encodes this IvParameterSpec object as an ASN1Object.
java.lang.String	toString() Creates a text representation of the ASN.1 structure of this IvParameterSpec object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IvParameterSpec

public IvParameterSpec()

The default constructor.

It creates a new IvParameterSpec object with a default initialization vector (IV), an empty or all-zero 8-byte IV.

IvParameterSpec

public IvParameterSpec(byte[] iv)

Creates a new IvParameterSpec object with the specified component.

The supplied byte array is copied, and used as the initialization vector (IV).

Parameters:

iv - a byte array containing the initialization vector

Throws:

java.lang.IllegalArgumentException - thrown if the byte array is null

IvParameterSpec

public IvParameterSpec(byte[] iv,
               int offset,
               int length)

Creates a new IvParameterSpec object with the specified component.

The initialization vector (IV) is copied from the supplied byte array starting at the indicated offset.

Parameters:

iv - a byte array containing the initialization vector

offset - the offset in the byte array where the initialization vector begins

length - the length of initialization vector

Throws:

java.lang.IllegalArgumentException - thrown if the byte array is null

java.lang.ArrayIndexOutOfBoundsException - thrown if an initialization vector of the specified size could not be extracted from the byte array

java.lang.NegativeArraySizeException - thrown if length is negative

IvParameterSpec

public IvParameterSpec(ASN1Object obj)
                throws CodingException

Creates a new IvParameterSpec object from an ASN1Object.

The ASN1Object must be a IVParameter structure.

Parameters:

obj - the ASN.1 representation of a IVParameter 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).

Overrides:

getIV in class javax.crypto.spec.IvParameterSpec

Returns:

a copy of the initialization vector

setIV

public void setIV(byte[] iv,
         int offset,
         int length)

Sets the initialization vector (IV) by copying specified amount of data from the byte array beginning at the specified offset.

Parameters:

iv - a byte array containing the initialization vector

offset - the offset in the byte array where the initialization vector begins

length - the length of initialization vector

Throws:

java.lang.IllegalArgumentException - thrown if the byte array is null

java.lang.ArrayIndexOutOfBoundsException - thrown if an initialization vector of the specified size could not be extracted from the byte array

java.lang.NegativeArraySizeException - thrown if length is negative

decode

public void decode(ASN1Object obj)
            throws CodingException

Decodes an IvParameterSpec object from an ASN1Object.

The ASN1Object must be a IVParameter structure.

Specified by:

decode in interface ASN1Type

Parameters:

obj - an ASN.1 representation of an IVParameter structure

Throws:

CodingException - thrown if an errors occurs while decoding the ANS1Object

toASN1Object

public ASN1Object toASN1Object()

Encodes this IvParameterSpec object as an ASN1Object.

Specified by:

toASN1Object in interface ASN1Type

Returns:

an ASN.1 representation of the IVParameter structure

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

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