iaik.pkcs.pkcs11.parameters

Class GcmParameters

java.lang.Object

iaik.pkcs.pkcs11.SelfDestructor

iaik.pkcs.pkcs11.parameters.UniqueIvParameters

iaik.pkcs.pkcs11.parameters.GcmParameters

All Implemented Interfaces:

Parameters, java.lang.Cloneable

public class GcmParameters
extends UniqueIvParameters
implements Parameters

This class encapsulates parameters for the AES-GCM en/decryption.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	pAad
protected byte[]	pIv
protected long	ulTagBits

Fields inherited from class iaik.pkcs.pkcs11.parameters.UniqueIvParameters

length, pointer

Constructor Summary

Constructors

Constructor and Description
GcmParameters(byte[] pIv, byte[] pAad, long ulTagBits) Create a new GCMParameters 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_GCM_PARAMS class.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
void	setValuesFromPKCS11Object(java.lang.Object object)
java.lang.String	toString() Returns the string representation of this object.

Methods inherited from class iaik.pkcs.pkcs11.parameters.UniqueIvParameters

clean, isConfiguredForIvWriteBack

Methods inherited from class iaik.pkcs.pkcs11.SelfDestructor

close, finalize

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

pIv

protected byte[] pIv

pAad

protected byte[] pAad

ulTagBits

protected long ulTagBits

Constructor Detail

GcmParameters

public GcmParameters(byte[] pIv,
                     byte[] pAad,
                     long ulTagBits)

Create a new GCMParameters object with the given attributes.

Parameters:

pIv - Initialization vector

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

ulTagBits - length of authentication tag (output following ciphertext) in bits. (0 - 128) depending on the algorithm implementation within the hsm, ulTagBits may be any one of the following five values: 128, 120, 112, 104, or 96, may be 64 or 32;

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.

getPKCS11ParamsObject

public java.lang.Object getPKCS11ParamsObject()

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

Specified by:

getPKCS11ParamsObject in interface Parameters

Returns:

This object as a CK_GCM_PARAMS object.

setValuesFromPKCS11Object

public void setValuesFromPKCS11Object(java.lang.Object object)

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.