com.entrust.toolkit.security.crypto.cipher

Class IvParameters

java.lang.Object

java.security.AlgorithmParametersSpi

com.entrust.toolkit.security.crypto.cipher.IvParameters

public final class IvParameters
extends java.security.AlgorithmParametersSpi

An implementation of IV symmetric cipher algorithm parameters, as defined in RFC 3370.

IV algorithm parameters contain a 8-byte initialization vector. These parameters are designed to be used with the an 8-byte block symmetric cipher (i.e. DESede) in a block mode that requires an initialization vector (i.e. CBC).

This class provides the capability to convert IV algorithm parameters to/from transparent representation. Currently, the following transparent algorithm parameter representations are supported:

• javax.crypto.spec.IvParameterSpec
• com.entrust.toolkit.security.spec.IvParameterSpec

This class also provides the capability to convert IV algorithm parameters to/from encoded representation. Currently, the following encoding/decoding formats are supported:

• ASN.1

The following ASN.1 structure is supported by the ASN.1 encoding/decoding format:

 IV ::= OCTET STRING  -- exactly 8 octets
 

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
IvParameters() The constructor; creates a new instance of IV algorithm parameters.

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	engineGetEncoded() Returns the algorithm parameters in encoded representation by encoding them using the primary encoding format.
protected byte[]	engineGetEncoded(java.lang.String format) Returns the algorithm parameters in encoded representation by encoding them using the specified encoding format.
protected <T extends java.security.spec.AlgorithmParameterSpec> T	engineGetParameterSpec(java.lang.Class<T> paramSpec) Returns the algorithm parameters in transparent representation.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this algorithm parameters object using the algorithm parameters provided in transparent representation.
protected void	engineInit(byte[] params) Initializes this algorithm parameters object using the algorithm parameters provided in encoded representation by decoding them using the primary decoding format.
protected void	engineInit(byte[] params, java.lang.String format) Initializes this algorithm parameters object using the algorithm parameters provided in encoded representation by decoding them using the specified decoding format.
protected java.lang.String	engineToString() Returns a formatted string describing the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

IvParameters

public IvParameters()

The constructor; creates a new instance of IV algorithm parameters.

Applications should never use this constructor, instead the algorithm parameters should be requested from the appropriate JCA/JCE cryptographic service provider as follows: AlgorithmParameters.getInstance("IV", "Entrust").

Method Detail

engineInit

protected void engineInit(java.security.spec.AlgorithmParameterSpec paramSpec)
                   throws java.security.spec.InvalidParameterSpecException

Initializes this algorithm parameters object using the algorithm parameters provided in transparent representation.

For details on the algorithm parameter specifications supported refer to the class documentation of the instance.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the algorithm parameters in transparent representation

Throws:

java.security.spec.InvalidParameterSpecException - if the given algorithm parameter specification is inappropriate for the initialization of this parameters object

engineInit

protected void engineInit(byte[] params)
                   throws java.io.IOException

Initializes this algorithm parameters object using the algorithm parameters provided in encoded representation by decoding them using the primary decoding format.

The primary decoding format is 'ASN.1'; for details on this format refer to the class documentation of the instance.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the algorithm parameters in encoded representation

Throws:

java.io.IOException - on decoding errors

engineInit

protected void engineInit(byte[] params,
              java.lang.String format)
                   throws java.io.IOException

Initializes this algorithm parameters object using the algorithm parameters provided in encoded representation by decoding them using the specified decoding format.

If format is null, the primary decoding format is used. The primary decoding format is 'ASN.1'; for details on the supported decoding formats refer to the class documentation of the instance.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the algorithm parameters in encoded representation

format - the name of the decoding format

Throws:

java.io.IOException - if the decoding format is unsupported or a decoding error occurs

engineGetEncoded

protected byte[] engineGetEncoded()

Returns the algorithm parameters in encoded representation by encoding them using the primary encoding format.

The primary encoding format is 'ASN.1'; for details on this format refer to the class documentation of the instance.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Returns:

the algorithm parameters in encoded representation

engineGetEncoded

protected byte[] engineGetEncoded(java.lang.String format)
                           throws java.io.IOException

Returns the algorithm parameters in encoded representation by encoding them using the specified encoding format.

If format is null, the primary encoding format is used. The primary encoding format is 'ASN.1'; for details on the supported encoding formats refer to the class documentation of the instance.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Parameters:

format - the name of the encoding format

Returns:

the algorithm parameters in encoded representation

Throws:

java.io.IOException - if the encoding format is unsupported

engineGetParameterSpec

protected <T extends java.security.spec.AlgorithmParameterSpec> T engineGetParameterSpec(java.lang.Class<T> paramSpec)
                                                                              throws java.security.spec.InvalidParameterSpecException

Returns the algorithm parameters in transparent representation.

For details on the parameter specifications supported refer to the class documentation of the instance.

Specified by:

engineGetParameterSpec in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the parameter specification class in which the algorithm parameters should be returned

Returns:

the algorithm parameters in transparent representation

Throws:

java.security.spec.InvalidParameterSpecException - if the requested parameter specification is inappropriate for this parameters object

engineToString

protected java.lang.String engineToString()

Returns a formatted string describing the parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a formatted string describing the parameters