iaik.security.cipher

Class PWRIKekWrapParameters

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.security.cipher.PWRIKekWrapParameters

public class PWRIKekWrapParameters
extends java.security.AlgorithmParametersSpi

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

The parameters specified for the CMS PWRI-KEK key wrap algorithm in RFC 3211 consist of an OID specifying the algorithm to use to wrap the content encryption key:

 KeyEncryptionAlgorithmIdentifier ::=  AlgorithmIdentifier {{ KeyEncryptionAlgorithms }}

 KeyEncryptionAlgorithms ALGORITHM ::= {
 { OID id-alg-PWRI-KEK PARMS
   AlgorithmIdentifier {{ PWRIAlgorithms }} },
 ...
 }
 

PWRIKekWrapParamters 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 PWRI-KEK Wrap parameter specification or a DER encoded byte array, e.g.:

 PWRIKekWrapParameterSpec paramSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("CMS-PWRI-KEK");
 params.init(paramsSpec);
 

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

Constructor Summary

Constructors

Constructor and Description
PWRIKekWrapParameters() 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 java.security.spec.AlgorithmParameterSpec	engineGetParameterSpec(java.lang.Class paramSpec) Returns the PWRI-KEK parameters as transparent PWRI-KEK parameter specification of the given class type.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this PWRIKekWrapParameters with the parameter values from a given PWRIKekWrapParametersSpec.
protected void	engineInit(byte[] params) Initializes this PWRIKekWrapParameters object from the given DER encoded byte array.
protected void	engineInit(byte[] params, java.lang.String format) Initializes the parameters from an DER encoded byte array.
protected java.lang.String	engineToString() Returns a String representation of the parameters.
AlgorithmID	getEncryptionAlgorithm()

Methods inherited from class java.lang.Object

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

Constructor Detail

PWRIKekWrapParameters

public PWRIKekWrapParameters()

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

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 CMS-PWRI-KEK 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 CMS-PWRI-KEK 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 PWRI-KEK parameters as transparent PWRI-KEK parameter specification of the given class type.

Specified by:

engineGetParameterSpec in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the desired parameter specification class (PWRIKekWrapParameterSpec)

Returns:

the parameters as PWRIKekWrapParameterSpec

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 PWRIKekWrapParameters with the parameter values from a given PWRIKekWrapParametersSpec.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

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

Throws:

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

getEncryptionAlgorithm

public AlgorithmID getEncryptionAlgorithm()

engineInit

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

Initializes this PWRIKekWrapParameters 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 an DER encoded byte array. Format is ignored. Only calls {engineInit(params) for initializing this PWRIKekParameters 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 PWRIKekWrapParameters object