iaik.pkcs.pkcs11.parameters

Class GcmMessageParameters

java.lang.Object

iaik.pkcs.pkcs11.parameters.GcmMessageParameters

All Implemented Interfaces:

MessageParameters, Parameters, java.lang.Cloneable

public class GcmMessageParameters
extends java.lang.Object
implements Parameters, MessageParameters

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

Version:

1.0

Author:

Otto Touzil

Field Summary

Fields

Modifier and Type	Field and Description
protected long	ivGenerator
protected byte[]	pIv
protected byte[]	pTag
protected long	ulIvFixedBits

Constructor Summary

Constructors

Constructor and Description
GcmMessageParameters(byte[] pIv, long ulIvFixedBits, long ivGenerator, byte[] pTag) 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_ECDH1_DERIVE_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 obj) Read the parameters from the PKCS11Object and overwrite the values into this object.
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

pIv

protected byte[] pIv

ulIvFixedBits

protected long ulIvFixedBits

ivGenerator

protected long ivGenerator

pTag

protected byte[] pTag

Constructor Detail

GcmMessageParameters

public GcmMessageParameters(byte[] pIv,
                            long ulIvFixedBits,
                            long ivGenerator,
                            byte[] pTag)

Create a new GCMParameters object with the given attributes.

Parameters:

pIv - Initialization vector

ulIvFixedBits - number of bits of the original IV to preserve when generating an
new IV. These bits are counted from the Most significant bits (to the right).

ivGenerator - Function used to generate a new IV. Each IV must be unique for a given session.

pTag - ocation of the authentication tag which is returned on MessageEncrypt, and provided on MessageDecrypt.

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 EcDH1KeyDerivationParameters) and (result.equals(this))

getPKCS11ParamsObject

public java.lang.Object getPKCS11ParamsObject()

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

Specified by:

getPKCS11ParamsObject in interface Parameters

Returns:

This object as a CK_ECDH1_DERIVE_PARAMS object.

Postconditions:

(result != null)

setValuesFromPKCS11Object

public void setValuesFromPKCS11Object(java.lang.Object obj)

Read the parameters from the PKCS11Object and overwrite the values into this object.

Specified by:

setValuesFromPKCS11Object in interface MessageParameters

Parameters:

obj - Object to read the parameters from

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.