iaik.pkcs.pkcs11.params

Class SSL3KeyMaterialParams

java.lang.Object

iaik.pkcs.pkcs11.params.SSL3KeyMaterialParams

All Implemented Interfaces:

Params

public class SSL3KeyMaterialParams
extends Object
implements Params

This class encapsulates parameters for the Mechanism.SSL3_KEY_AND_MAC_DERIVE mechanism.

Version:

1.0

Author:

Karl Scheibelhofer

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	export Indicates whether the keys have to be derived for an export version of the protocol.
protected long	ivSizeInBits The length (in bits) of the IV agreed upon during the protocol handshake phase.
protected long	keySizeInBits The length (in bits) of the secret keys agreed upon during the protocol handshake phase.
protected long	macSizeInBits The length (in bits) of the MACing keys agreed upon during the protocol handshake phase.
protected SSL3RandomDataParams	randomInfo The client's and server's random data information.
protected SSL3KeyMaterialOutParams	returnedKeyMaterial Receives the handles for the keys generated and the IVs.

Constructor Summary

Constructors

Constructor and Description
SSL3KeyMaterialParams(long macSizeInBits, long keySizeInBits, long ivSizeInBits, boolean export, SSL3RandomDataParams randomInfo, SSL3KeyMaterialOutParams returnedKeyMaterial) Create a new SSL3KeyMaterialParameters object with the given parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherObject) Compares all member variables of this object with the other object.
long	getIVSizeInBits() Get the length (in bits) of the IV agreed upon during the protocol handshake phase.
long	getKeySizeInBits() Get the length (in bits) of the secret keys agreed upon during the protocol handshake phase.
long	getMacSizeInBits() Get the length (in bits) of the MACing keys agreed upon during the protocol handshake phase.
Object	getPKCS11ParamsObject() Get this parameters object as a CK_SSL3_KEY_MAT_PARAMS object.
SSL3RandomDataParams	getRandomInfo() Get the client's and server's random data information.
SSL3KeyMaterialOutParams	getReturnedKeyMaterial() Get the object that receives the handles for the keys generated and the IVs.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
boolean	isExport() Check whether the keys have to be derived for an export version of the protocol.
void	setExport(boolean export) Set whether the keys have to be derived for an export version of the protocol.
void	setIVSizeInBits(long ivSizeInBits) Set the length (in bits) of the IV agreed upon during the protocol handshake phase.
void	setKeySizeInBits(long keySizeInBits) Set the length (in bits) of the secret keys agreed upon during the protocol handshake phase.
void	setMacSizeInBits(long macSizeInBits) Set the length (in bits) of the MACing keys agreed upon during the protocol handshake phase.
void	setRandomInfo(SSL3RandomDataParams randomInfo) Set the client's and server's random data information.
void	setReturnedKeyMaterial(SSL3KeyMaterialOutParams returnedKeyMaterial) Set the object that receives the handles for the keys generated and the IVs.
String	toString() Returns the string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

macSizeInBits

protected long macSizeInBits

The length (in bits) of the MACing keys agreed upon during the protocol handshake phase.

keySizeInBits

protected long keySizeInBits

The length (in bits) of the secret keys agreed upon during the protocol handshake phase.

ivSizeInBits

protected long ivSizeInBits

The length (in bits) of the IV agreed upon during the protocol handshake phase. If no IV is required, the length should be set to 0.

export

protected boolean export

Indicates whether the keys have to be derived for an export version of the protocol.

randomInfo

protected SSL3RandomDataParams randomInfo

The client's and server's random data information.

returnedKeyMaterial

protected SSL3KeyMaterialOutParams returnedKeyMaterial

Receives the handles for the keys generated and the IVs.

Constructor Detail

SSL3KeyMaterialParams

public SSL3KeyMaterialParams(long macSizeInBits,
                             long keySizeInBits,
                             long ivSizeInBits,
                             boolean export,
                             SSL3RandomDataParams randomInfo,
                             SSL3KeyMaterialOutParams returnedKeyMaterial)

Create a new SSL3KeyMaterialParameters object with the given parameters.

Parameters:

macSizeInBits - The length (in bits) of the MACing keys agreed upon during the protocol handshake phase.

keySizeInBits - The length (in bits) of the secret keys agreed upon during the protocol handshake phase.

initializationVectorSizeInBits - The length (in bits) of the IV agreed upon during the protocol handshake phase. If no IV is required, the length should be set to 0.

export - Indicates whether the keys have to be derived for an export version of the protocol.

randomInfo - The client's and server's random data information.

returnedKeyMaterial - Receives the handles for the keys generated and the IVs.

Method Detail

getPKCS11ParamsObject

public Object getPKCS11ParamsObject()

Get this parameters object as a CK_SSL3_KEY_MAT_PARAMS object.

Specified by:

getPKCS11ParamsObject in interface Params

Returns:

This object as a CK_SSL3_KEY_MAT_PARAMS object.

getMacSizeInBits

public long getMacSizeInBits()

Get the length (in bits) of the MACing keys agreed upon during the protocol handshake phase.

Returns:

The length (in bits) of the MACing keys agreed upon during the protocol handshake phase.

getKeySizeInBits

public long getKeySizeInBits()

Get the length (in bits) of the secret keys agreed upon during the protocol handshake phase.

Returns:

The length (in bits) of the secret keys agreed upon during the protocol handshake phase.

getIVSizeInBits

public long getIVSizeInBits()

Get the length (in bits) of the IV agreed upon during the protocol handshake phase. If no IV is required, the length should be set to 0

Returns:

The length (in bits) of the IV agreed upon during the protocol handshake phase. If no IV is required, the length should be set to 0.

isExport

public boolean isExport()

Check whether the keys have to be derived for an export version of the protocol.

Returns:

True, if the keys have to be derived for an export version of the protocol; false, otherwise.

getRandomInfo

public SSL3RandomDataParams getRandomInfo()

Get the client's and server's random data information.

Returns:

The client's and server's random data information.

getReturnedKeyMaterial

public SSL3KeyMaterialOutParams getReturnedKeyMaterial()

Get the object that receives the handles for the keys generated and the IVs.

Returns:

The object that receives the handles for the keys generated and the IVs.

setMacSizeInBits

public void setMacSizeInBits(long macSizeInBits)

Set the length (in bits) of the MACing keys agreed upon during the protocol handshake phase.

Parameters:

macSizeInBits - The length (in bits) of the MACing keys agreed upon during the protocol handshake phase.

setKeySizeInBits

public void setKeySizeInBits(long keySizeInBits)

Set the length (in bits) of the secret keys agreed upon during the protocol handshake phase.

Parameters:

keySizeInBits - The length (in bits) of the secret keys agreed upon during the protocol handshake phase.

setIVSizeInBits

public void setIVSizeInBits(long ivSizeInBits)

Set the length (in bits) of the IV agreed upon during the protocol handshake phase. If no IV is required, the length should be set to 0.

Parameters:

initializationVectorSizeInBits - The length (in bits) of the IV agreed upon during the protocol handshake phase. If no IV is required, the length should be set to 0.

setExport

public void setExport(boolean export)

Set whether the keys have to be derived for an export version of the protocol.

Parameters:

export - True, if the keys have to be derived for an export version of the protocol; false, otherwise.

setRandomInfo

public void setRandomInfo(SSL3RandomDataParams randomInfo)

Set the client's and server's random data information.

Parameters:

randomInfo - The client's and server's random data information.

setReturnedKeyMaterial

public void setReturnedKeyMaterial(SSL3KeyMaterialOutParams returnedKeyMaterial)

Set the object that receives the handles for the keys generated and the IVs.

Parameters:

returnedKeyMaterial - The object that receives the handles for the keys generated and the IVs.

toString

public 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 Object

Returns:

A string representation of this object.

equals

public boolean equals(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 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 Object

Returns:

The hash code of this object.