iaik.security.cipher

Class CBCCMacParameters

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.security.cipher.CBCCMacParameters

public class CBCCMacParameters
extends java.security.AlgorithmParametersSpi

This class represents parameters for the AES-CBC-CMAC authenticated encryption algorithm as defined by the BSI Technical Guideline TR-03109-1.
The parameters specified for the AES-CBC-CMAC algorithm consist of the iv and the length of the MAC):

   CBC-CMAC-Param ::= SEQUENCE {
     aes-iV OCTET STRING 
     aes-MacLen INTEGER (12 | 13 | 14 | 15 | 16) DEFAULT 16 } 
 

Additionally, this class may hold the associated data and MAC block.

AES CBCCMacParameters 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 CBCCMacParameterSpec is recommended) or a DER encoded byte array, e.g.

 CBCCMacParameterSpec paramSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("AES-CBC-CMAC", "IAIK");
 params.init(gcmParamsSpec);
 

The AES CBCCMacParameters can also be initialized with an IvParameterSpec object representing the initialization vector.

Version:

File Revision 4

Constructor Summary

Constructors

Constructor and Description
CBCCMacParameters() The default constructor.

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 AES-CBC-CMAC Parameter Specification of this AES-CBC-CMAC 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 CBCCMacParameters 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 GCM Parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

CBCCMacParameters

public CBCCMacParameters()
                  throws java.security.InvalidAlgorithmParameterException

The default constructor. No values are set for the parameters. Use AlgorithmParameters.getInstance for obtaining a AES CBCCMacParameters object.

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 GCM 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 AES-CBC-CMAC 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 AES-CBC-CMAC Parameter Specification of this AES-CBC-CMAC Parameters object. paramSpec identifies the specification class in which the parameters should be returned. If paramSpec is not CBCCMacParameterSpec 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 CBCCMacParameterSpec

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

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 CBCCMacParameters 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 AES CBCCMacParameters 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 GCM Parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a formatted string describing the GCM Parameters.