iaik.security.cipher
Class RC2WrapParameters

java.lang.Object
  |
  +--java.security.AlgorithmParametersSpi
        |
        +--iaik.security.cipher.IvParameters
              |
              +--iaik.security.cipher.RC2Parameters
                    |
                    +--iaik.security.cipher.RC2WrapParameters

public class RC2WrapParameters

extends RC2Parameters

This class represents RC2 wrap paramters in opaque form and may be used for generating opaque RC2 parameters and converting them between various formats. The CMS RC2 key wrap algorithm wraps a RC2 (content-enctyption) key with a RC2 (key-encryption) key.

Wrap parameters specified for the RC2 key wrap algorithm given in RFC2630 (Cryptographic Message Syntax) represent the RC2ParameterVersion for indicating the number of effective key bits:

 RC2wrapParameter :: RC2ParameterVersion

 RC2ParameterVersion ::= INTEGER
 

The RC2 effective-key-bits (key size) greater than 32 and less than 256 is encoded in the RC2ParameterVersion. For the effective-key- bits of 40, 64, and 128, the rc2ParameterVersion values are 160, 120, and 58 respectively. These values are not simply the RC2 key length.

RC2WrapParamters can be generated provider independently by calling one of the AlgorithmParameters.getInstance methods for the algorithm in mind. Subsequently the new AlgorithmParamters object must be initialized with a proper RC2 wrap parameter specification or a DER encoded byte array. If the first way is chosen, the parameter version for initializing the new AlgorithmParameters object immediately must be derived from the given RC2 wrap parameter specification; if the parameters are given as DER encoded byte array, the values are parsed from the derived ASN.1 object, e.g.:

 RC2WrapParameterSpec rc2WrapParamSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("RC2WrapRC2", "IAIK");
 params.init(rc2WrapParamsSpec);
 

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

Version:

File Revision 10

Constructor Summary

RC2WrapParameters()
The default constructor.

Method Summary

protected byte[]	engineGetEncoded() Returns the parameters as DER byte array.
protected byte[]	engineGetEncoded(String format) Returns the parameters as a DER byte array.
protected AlgorithmParameterSpec	engineGetParameterSpec(Class paramSpec) Returns the RC2 wrap parameters as transparent RC2 parameter specification of the given class type.
protected void	engineInit(AlgorithmParameterSpec paramSpec) Initializes this RC2WrapParameters with the effective key bits from the given RC2WrapParameterSpec.
protected void	engineInit(byte[] params) Initializes this RC2WrapParameters object from the given DER encoded byte array.
protected void	engineInit(byte[] params, String format) Inits the parameters from an DER encoded byte array.
protected 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

RC2WrapParameters

public RC2WrapParameters()

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

Method Detail

engineGetEncoded

protected byte[] engineGetEncoded()
                           throws IOException

Returns the parameters as DER byte array.

Overrides:

engineGetEncoded in class RC2Parameters

Returns:

the RC2 wrap parameters as DER byte array

Throws:

IOException - if an encoding error occurs

engineGetEncoded

protected byte[] engineGetEncoded(String format)
                           throws 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.

Overrides:

engineGetEncoded in class RC2Parameters

Parameters:

format - the encoding format; ignored

Returns:

the RC2 wrap parameters as DER byte array

Throws:

IOException - if an encoding error occurs

engineGetParameterSpec

protected AlgorithmParameterSpec engineGetParameterSpec(Class paramSpec)
                                                 throws InvalidParameterSpecException

Returns the RC2 wrap parameters as transparent RC2 parameter specification of the given class type.

Overrides:

engineGetParameterSpec in class RC2Parameters

Parameters:

paramSpec - the desired parameter specification class (RC2WrapParameterSpec)

Returns:

the parameters as RC2WrapParameterSpec

Throws:

InvalidParameterSpecException - if the paramters cannot be converted to the desired parameter specification

engineInit

protected void engineInit(AlgorithmParameterSpec paramSpec)
                   throws InvalidParameterSpecException

Initializes this RC2WrapParameters with the effective key bits from the given RC2WrapParameterSpec.

Overrides:

engineInit in class RC2Parameters

Parameters:

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

Throws:

InvalidParameterSpecException - if the given parameter specification is not a RC2WrapParameterSpec or the included parameters are invalid

engineInit

protected void engineInit(byte[] params)
                   throws IOException

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

Overrides:

engineInit in class RC2Parameters

Parameters:

params - the DER encoded byte array

Throws:

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

engineInit

protected void engineInit(byte[] params,
                          String format)
                   throws IOException

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

Overrides:

engineInit in class RC2Parameters

Parameters:

params - the DER encoded byte array

format - the encoding format; ignored

Throws:

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

engineToString

protected String engineToString()

Returns a String representation of the parameters.

Overrides:

engineToString in class RC2Parameters

Returns:

a String representation of this RC2WrapParameters object