iaik.security.cipher

Class CCMParameterSpec

java.lang.Object

iaik.security.cipher.CCMParameterSpec

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec

public class CCMParameterSpec
extends java.lang.Object
implements java.security.spec.AlgorithmParameterSpec

CCM (counter with CBC-MAC) parameter specification.

This class holds the necessary inputs (associated data, nonce, MAC length and input length) for the encryption and decryption with the CCM mode.

If no parameters are passed to the constructor the nonce is generated and the macLength is set to 12. If only macLength and/or inputLength shall be specified, set nonce and associatedData to null.

Note that associated data may be supplied to the CCM Cipher only either by means of a CCMParameterSpec or by calling ccmCipher.updateAAD(). Supplying associated data by both CCMParameterSpec and calling ccmCipher.updateAAD() is not allowed.
If associated data is specified by a CCMParameterSpec the associated data is also included in the parameters got from a CCM Cipher when calling ccmCipher.getParameters(). However, associated data that has been supplied by calling ccmCipher.updateAAD() is not included in the parameters got from a CCM Cipher when calling ccmCipher.getParameters().

Version:

File Revision 6

See Also:

AlgorithmParameterSpec

Constructor Summary

Constructors

Constructor and Description
CCMParameterSpec() Creates a CCM Parameter specification with default values.
CCMParameterSpec(byte[] associatedData, byte[] nonce) Creates a CCM Parameter specification with the given associated data and nonce.
CCMParameterSpec(byte[] associatedData, byte[] nonce, int macLength) Creates a CCM Parameter specification with the given associated data, nonce and MAC length.
CCMParameterSpec(long inputLength, byte[] associatedData, byte[] nonce) Creates a CCM Parameter specification with the given input length, associated data and nonce.
CCMParameterSpec(long inputLen, byte[] assocData, byte[] non, int macLen) Creates a CCM Parameter specification with the given input length, associated data, nonce and MAC length.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getAssociatedData() Returns the associated data used for authentication.
long	getInputLength() Returns the length of the input data that shall be encrypted and authenticated.
int	getMacLength() Returns the number of bytes used from the calculated CBC-MAC-block.
byte[]	getNonce() Returns the nonce used with the IV and the CBC-MAC-calculation.
void	setInputLength(long inputLength) Set byte length of input data, needed at the beginning of the MAC-calculation.
void	setMacLength(int macLength) Set number of bytes that should be used as MAC.

Methods inherited from class java.lang.Object

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

Constructor Detail

CCMParameterSpec

public CCMParameterSpec(long inputLen,
                byte[] assocData,
                byte[] non,
                int macLen)
                 throws java.security.InvalidAlgorithmParameterException

Creates a CCM Parameter specification with the given input length, associated data, nonce and MAC length.

Parameters:

inputLen - length of the input data that is authenticated and encrypted

assocData - the associated data that is authenticated

non - the unique nonce

macLen - number of bytes used as MAC

Throws:

java.security.InvalidAlgorithmParameterException

CCMParameterSpec

public CCMParameterSpec(long inputLength,
                byte[] associatedData,
                byte[] nonce)
                 throws java.lang.Exception

Creates a CCM Parameter specification with the given input length, associated data and nonce. MAC length will be set to 12 bytes.

Parameters:

inputLength - length of the input data that is authenticated and encrypted

associatedData - the associated data that is authenticated

nonce - the unique nonce

Throws:

java.lang.Exception

CCMParameterSpec

public CCMParameterSpec(byte[] associatedData,
                byte[] nonce,
                int macLength)
                 throws java.lang.Exception

Creates a CCM Parameter specification with the given associated data, nonce and MAC length. Input data will have to be buffered.

Parameters:

associatedData - the associated data that is authenticated

nonce - the unique nonce

macLength - number of bytes used as authentication block

Throws:

java.lang.Exception

CCMParameterSpec

public CCMParameterSpec(byte[] associatedData,
                byte[] nonce)
                 throws java.lang.Exception

Creates a CCM Parameter specification with the given associated data and nonce. Input data will have to be buffered and MAC length will be set to 12 bytes.

Parameters:

associatedData - the associated data that is authenticated

nonce - the unique nonce

Throws:

java.lang.Exception

CCMParameterSpec

public CCMParameterSpec()
                 throws java.lang.Exception

Creates a CCM Parameter specification with default values. The nonce will be generated and the MAC length will be set to 12 bytes. Input data will have to be buffered.

Throws:

java.lang.Exception

Method Detail

setInputLength

public void setInputLength(long inputLength)
                    throws java.security.InvalidAlgorithmParameterException

Set byte length of input data, needed at the beginning of the MAC-calculation.

Throws:

java.security.InvalidAlgorithmParameterException - if the specified input length is not valid

setMacLength

public void setMacLength(int macLength)
                  throws java.security.InvalidAlgorithmParameterException

Set number of bytes that should be used as MAC.

Throws:

java.security.InvalidAlgorithmParameterException - if the specified MAC length is not valid

getAssociatedData

public byte[] getAssociatedData()

Returns the associated data used for authentication.

Returns:

associated data

getMacLength

public int getMacLength()

Returns the number of bytes used from the calculated CBC-MAC-block.

Returns:

number of bytes of the authentication block

getNonce

public byte[] getNonce()

Returns the nonce used with the IV and the CBC-MAC-calculation.

Returns:

nonce

getInputLength

public long getInputLength()

Returns the length of the input data that shall be encrypted and authenticated.

Returns:

length of the input data