com.entrust.toolkit.security.crypto.cipher

Class Cast3Parameters

java.lang.Object

java.security.AlgorithmParametersSpi

com.entrust.toolkit.security.crypto.cipher.Cast3Parameters

public class Cast3Parameters
extends java.security.AlgorithmParametersSpi

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

The parameters specified for the CAST algorithm in RFC 2144 consist of an initialization vector (of eight octets) and the m_keyLength:

 Parameters ::= SEQUENCE {
      iv         OCTET STRING DEFAULT 0,  -- Initialization vector
      keyLength  INTEGER                  -- Key length, in bits
 }
 

If no initialization vector is included it defaults to an iv of all zeros.

Cast3Parameters can be generated provider 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 CAST3 parameter specification or a DER encoded byte array, e.g.:

 Cast3ParameterSpec castParamSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("CAST3", "Entrust");
 params.init(castParamsSpec);
 

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

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
Cast3Parameters() The default constructor.

Method Summary

Modifier and Type	Method and Description
protected byte[]	engineGetEncoded() Returns the parameters as DER byte array.
protected byte[]	engineGetEncoded(java.lang.String format) Returns the parameters as a DER byte array.
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 Cast3Parameters with the parameter values from a given Cast3ParameterSpec.
protected void	engineInit(byte[] params) Initializes this Cast3Parameters object from the given DER encoded byte array.
protected void	engineInit(byte[] params, java.lang.String format) Initializes the parameters from a DER encoded byte array.
protected java.lang.String	engineToString() Returns a String representation of the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cast3Parameters

public Cast3Parameters()

The default constructor. Only internally used for creating a Cast3Parameters object. Applications must use one of the AlgorithmParameters.getInstance factory methods for obtaining a Cast3Parameters instance

Method Detail

engineGetEncoded

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

Returns the parameters as DER byte array.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Returns:

the Cast3 parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

engineGetEncoded

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

Returns the parameters as a DER byte array.

Format is ignored. Only DER encoding is supported at this time. This method only calls engineGetEncoded(), regardless of what is specified in the format string.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Parameters:

format - the encoding format; ignored

Returns:

the CAST3 parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

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

engineInit

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

Initializes this Cast3Parameters with the parameter values from a given Cast3ParameterSpec.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the parameter specification, which has to be a Cast3ParameterSpec

Throws:

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

engineInit

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

Initializes this Cast3Parameters object from the given DER encoded byte array.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

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

Initializes the parameters from a DER encoded byte array. Format is ignored. Only calls engineInit(params) for initializing this Cast3Parameters object from the given DER encoded byte array, regardless of what is specified in the format string.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

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 parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a String representation of this Cast3Parameters object