iaik.pkcs.pkcs11.parameters

Class CcmParameters

java.lang.Object

iaik.pkcs.pkcs11.parameters.CcmParameters

All Implemented Interfaces:

Parameters, java.lang.Cloneable

public class CcmParameters
extends java.lang.Object
implements Parameters

This class encapsulates parameters for the AES-CCM en/decryption

Version:

1.0

Author:

Otto Touzil

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	pAad
protected byte[]	pNonce
protected long	ulDataLen
protected long	ulMacLen

Constructor Summary

Constructors

Constructor and Description
CcmParameters(long ulDataLen, byte[] pNonce, byte[] pAad, long ulMacLen) Create a new CCMParameters object with the given attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Create a (deep) clone of this object.
boolean	equals(java.lang.Object otherObject) Compares all member variables of this object with the other object.
java.lang.Object	getPKCS11ParamsObject() Get this parameters object as an object of the CK_CCM_PARAMS class.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
java.lang.String	toString() Returns the string representation of this object.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ulDataLen

protected long ulDataLen

pNonce

protected byte[] pNonce

pAad

protected byte[] pAad

ulMacLen

protected long ulMacLen

Constructor Detail

CcmParameters

public CcmParameters(long ulDataLen,
                     byte[] pNonce,
                     byte[] pAad,
                     long ulMacLen)

Create a new CCMParameters object with the given attributes.

Parameters:

ulDataLen - length of the data where 0 ≤ ulDataLen < 2^8L. This length should not include the length of the MAC that is appended to the cipher text. (where L is the size in bytes of the data length's length(2 < L < 8)

pNonce - the nonce

pAad - additional authentication data. This data is authenticated but not encrypted.

ulMacLen - length of the MAC (output following cipher text) in bytes. Valid values are (4, 6, 8, 10, 12, 14 and 16)

Method Detail

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class java.lang.Object

Returns:

A clone of this object.

Postconditions:

(result != null) and (result instanceof CK_CCM_PARAMS) and (result.equals(this))

getPKCS11ParamsObject

public java.lang.Object getPKCS11ParamsObject()

Get this parameters object as an object of the CK_CCM_PARAMS class.

Specified by:

getPKCS11ParamsObject in interface Parameters

Returns:

This object as a CK_CCM_PARAMS object.

Postconditions:

(result != null)

toString

public java.lang.String toString()

Returns the string representation of this object. Do not parse data from this string, it is for debugging only.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

equals

public boolean equals(java.lang.Object otherObject)

Compares all member variables of this object with the other object. Returns only true, if all are equal in both objects.

Overrides:

equals in class java.lang.Object

Parameters:

otherObject - The other object to compare to.

Returns:

True, if other is an instance of this class and all member variables of both objects are equal. False, otherwise.

hashCode

public int hashCode()

The overriding of this method should ensure that the objects of this class work correctly in a hashtable.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code of this object.