iaik.security.cipher

Class CCMCMSParameters

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.security.cipher.CCMCMSParameters

public class CCMCMSParameters
extends java.security.AlgorithmParametersSpi

This class represents CCM parameters for use with CMS. The difference to the class CCMParameters is, that the calculated MAC is not concatenated to the ciphertext but can be received as parameter. CCMCMSParameters can be generated by calling one of the AlgorithmParameters.getInstance methods. Subsequently the new AlgorithmParameters object must be initialized with a proper parameter specification (class CCMCMSParameterSpec is recommended) or a DER encoded byte array, e.g.

 CCMCMSParameterSpec ccmcmsParamSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("CCMCMS", "IAIK");
 params.init(ccmcmsParamsSpec);
 

The CCMCMSParameters can also be initialized with an IvParameterSpec object. In this case, the specified IV will be used as nonce.

Version:

File Revision 1

Constructor Summary

Constructors

Constructor and Description
CCMCMSParameters() The default constructor.
CCMCMSParameters(byte[] associatedData, byte[] nonce, byte[] macBlock, int macLength) Creates CCM Parameters with the given associated data, nonce and MAC length.

Method Summary

Methods

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 a CCM Parameter Specification of this CCM Parameters object.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this parameters object using the parameters specified in paramSpec.
protected void	engineInit(byte[] params) Initializes this CCMCMSParameters object from 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 formatted string describing the CCM Parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

CCMCMSParameters

public CCMCMSParameters()
                 throws java.security.InvalidAlgorithmParameterException

The default constructor. No values are set for the parameters. Use AlgorithmParameters.getInstance for obtaining CCMCMSParameters.

Throws:

java.security.InvalidAlgorithmParameterException - if the parameter values are incorrect

CCMCMSParameters

public CCMCMSParameters(byte[] associatedData,
                byte[] nonce,
                byte[] macBlock,
                int macLength)
                 throws java.security.InvalidAlgorithmParameterException

Creates CCM Parameters with the given associated data, nonce and MAC length.

Parameters:

nonce - the unique nonce

macLength - number of bytes used for Authentication

Throws:

java.security.InvalidAlgorithmParameterException - if the parameter values are incorrect

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 CCM 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 CCM 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 a CCM Parameter Specification of this CCM Parameters object. paramSpec identifies the specification class in which the parameters should be returned. If paramSpec is not CCMCMSParameterSpec than a InvalidParameterSpecException is thrown.

Specified by:

engineGetParameterSpec in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the specification class in which the parameters should be returned - has to be the class CCMCMSParameterSpec

Returns:

the parameter specification.

Throws:

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

engineInit

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

Initializes this parameters object using the parameters specified in paramSpec.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the parameter specification - must be CCMCMSParameterSpec.

Throws:

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

engineInit

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

Initializes this CCMCMSParameters 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

Inits the parameters from an DER encoded byte array. Format is ignored. Only calls {engineInit(params) for initializing this CCMCMSParameters 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 formatted string describing the CCM Parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a formatted string describing the CCM Parameters.