com.entrust.toolkit.security.provider

Class IDEAParameters

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.security.cipher.IvParameters

com.entrust.toolkit.security.provider.IDEAParameters

public class IDEAParameters
extends IvParameters

This class represents IDEA parameters in opaque form and may be used for generating opaque IDEA parameters and converting them between various formats.

The parameters for the IDEA algorithm are specified in RFC3058 and consist of only an optional initialization vector (of eight octets):

  IDEA-CBCPar ::= SEQUENCE {
    iv  OCTET STRING OPTIONAL } -- exactly 8 octets
  

IDEAParameters can be generated provide-independently by calling one of the AlgorithmParameters.getInstance methods for the algorithm in mind. Subsequently, the new AlgorithmParameters object must be initialized with a proper IDEA parameter specification or a DER encoded byte array. If the first way is chosen, the parameter value (iv) for initializing the new AlgorithmParameters object taken from the given IDEA parameter specification. If the parameters are given as DER encoded byte array, the value are parsed from the derived ASN.1 object, e.g.:

  IDEAParameterspec ideaParmSpec = ...;
  AlgorithmParameters params = AlgorithmParameters.getInstance( "IDEA", "Entrust" );
  params.init(ideaParamsSpec);
  

For obtaining IDEA parameters in transparent representation from an opaque IDEAParameters object, the getParameterSpec method can be used. For obtaining the parameters as DER encoded ASN.1 object, use getEncoded.

Field Summary

Fields inherited from class iaik.security.cipher.IvParameters

iv

Constructor Summary

Constructors

Constructor and Description
IDEAParameters() The default constructor.

Method Summary

Modifier and Type	Method and Description
protected byte[]	engineGetEncoded() Returns the parameters as a DER byte array.
protected byte[]	engineGetEncoded(java.lang.String format) Returns the parameters as a DER byte array.
protected java.security.spec.AlgorithmParameterSpec	engineGetParameterSpec(java.lang.Class paramSpec) Returns the IDEA parameters as a transparent IDEA parameter specification of the given class type.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this IDEAParameters with the IDEA parameter values from a given IDEAParameterspec or a IvParameterSpec.
protected void	engineInit(byte[] params) Initializes this IDEAParameters object by parsing the given DER encoded byte array.
protected void	engineInit(byte[] params, java.lang.String format) Inits the parameters from an DER encoded byte array.
protected java.lang.String	engineToString() Returns a String representation of the IDEA parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

IDEAParameters

public IDEAParameters()

The default constructor. Only internally used for creating an IDEAParameters object. Applications shall use one of the AlgorithmParameters.getInstance factory methods for obtaining IDEAParameters.

Method Detail

engineGetEncoded

protected byte[] engineGetEncoded()

Returns the parameters as a DER byte array. Does the following encoding:

IDEA-CBCPar ::= SEQUENCE { iv OCTET STRING OPTIONAL } -- exactly 8 octets

Overrides:

engineGetEncoded in class IvParameters

Returns:

the IV parameters as DER byte array

engineGetEncoded

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

Returns the parameters as a DER byte array.

The format is ignored. Only DER-encoding is supported at this time. This method simply calls engineGetEncoded() for encoding the IV value as an ASN.1 OCTET STRING, regardless of what is specified in the format string.

Overrides:

engineGetEncoded in class IvParameters

Parameters:

format - the encoding format - ignored

Returns:

the IV parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

engineGetParameterSpec

protected java.security.spec.AlgorithmParameterSpec engineGetParameterSpec(java.lang.Class paramSpec)
                                                                    throws java.security.spec.InvalidParameterSpecException

Returns the IDEA parameters as a transparent IDEA parameter specification of the given class type.

Overrides:

engineGetParameterSpec in class IvParameters

Parameters:

paramSpec - the desired parameter specification class (IDEAParameterSpec)

Returns:

the IV parameters as IvParameterSpec

Throws:

java.security.spec.InvalidParameterSpecException - if the parameters cannot be converted to the desired parameter specification

engineInit

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

Initializes this IDEAParameters with the IDEA parameter values from a given IDEAParameterspec or a IvParameterSpec.

Overrides:

engineInit in class IvParameters

Parameters:

paramSpec - the parameter specification, which has to be a IDEAParameterSpec or a IvParameterSpec

Throws:

java.security.spec.InvalidParameterSpecException - if the given parameter specification is not a IDEAParameterSpec or a IvParameterSpec, or the included parameters are invalid

engineInit

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

Initializes this IDEAParameters object by parsing the given DER encoded byte array.

Overrides:

engineInit in class IvParameters

Parameters:

params - the DER encoded byte array

Throws:

java.io.IOException - if an error occurs when decoding the given byte array or the derived parameter values are invalid

engineInit

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

Inits the parameters from an DER encoded byte array. Format is ignored. This simply calls {engineInit(params) for initializing this IDEAParameters object from the given DER encoded byte array, regardless of what is specified in the format string.

Overrides:

engineInit in class IvParameters

Parameters:

params - the DER encoded byte array

format - the encoding format - ignored

Throws:

java.io.IOException - if an error occurs when decoding the given byte array

engineToString

protected java.lang.String engineToString()

Returns a String representation of the IDEA parameters.

Overrides:

engineToString in class IvParameters

Returns:

a String representation of this IvParameters object