iaik.pkcs.pkcs11.objects

Class DHPrivateKey

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PrivateKey

iaik.pkcs.pkcs11.objects.DHPrivateKey

Direct Known Subclasses:

X942DHPrivateKey

public class DHPrivateKey
extends PrivateKey

Objects of this class represent DH private keys as specified by PKCS#11 v2.11.

Version:

1.0

Author:

Karl Scheibelhofer

Nested Class Summary

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.Key

Key.KeyType, Key.VendorDefinedKeyBuilder

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.PKCS11Object

PKCS11Object.ObjectClass, PKCS11Object.VendorDefinedObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteArrayAttribute	base The base (g) of this DH key.
protected ByteArrayAttribute	prime The prime (p) of this DH key.
protected ByteArrayAttribute	value The private value (x) of this DH key.
protected LongAttribute	valueBits The length of the value (x) of this DH key in bits.

Fields inherited from class iaik.pkcs.pkcs11.objects.PrivateKey

alwaysAuthenticate, alwaysSensitive, authPinFlags, decrypt, extractable, neverExtractable, secondaryAuth, sensitive, sign, signRecover, subject, unwrap, unwrapTemplate, wrapWithTrusted

Fields inherited from class iaik.pkcs.pkcs11.objects.Key

allowedMechanisms, derive, endDate, id, keyGenMechanism, keyType, keyTypeNames, local, startDate

Fields inherited from class iaik.pkcs.pkcs11.objects.Storage

label, modifiable, private_, token

Fields inherited from class iaik.pkcs.pkcs11.objects.PKCS11Object

attributeTable, objectClass, objectClassNames, objectHandle, vendorObjectBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
	DHPrivateKey() Default Constructor.
protected	DHPrivateKey(Session session, long objectHandle) Called by getInstance to create an instance of a PKCS#11 DH private key.

Method Summary

Modifier and Type	Method and Description
protected void	allocateAttributes() Allocates the attribute objects for this class and adds them to the attribute table.
boolean	equals(Object otherObject) Compares all member variables of this object with the other object.
ByteArrayAttribute	getBase() Gets the base attribute of this DH key.
static PKCS11Object	getInstance(Session session, long objectHandle) The getInstance method of the PrivateKey class uses this method to create an instance of a PKCS#11 DH private key.
ByteArrayAttribute	getPrime() Gets the prime attribute of this DH key.
ByteArrayAttribute	getValue() Gets the value attribute of this DH key.
LongAttribute	getValueBits() Gets the value length attribute of this DH key (in bits).
protected static void	putAttributesInTable(DHPrivateKey object) Put all attributes of the given object into the attributes table of this object.
void	readAttributes(Session session) Read the values of the attributes of this object from the token.
String	toString() Returns a string representation of the current object.

Methods inherited from class iaik.pkcs.pkcs11.objects.PrivateKey

getAlwaysAuthenticate, getAlwaysSensitive, getAuthPinFlags, getDecrypt, getExtractable, getNeverExtractable, getSecondaryAuth, getSensitive, getSign, getSignRecover, getSubject, getUnknownPrivateKey, getUnwrap, getUnwrapTemplate, getWrapWithTrusted, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.Key

getAllowedMechanisms, getDerive, getEndDate, getId, getKeyGenMechanism, getKeyType, getKeyTypeName, getLocal, getStartDate, hashCode, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.Storage

getLabel, getModifiable, getPrivate, getToken, putAttributesInTable

Methods inherited from class iaik.pkcs.pkcs11.objects.PKCS11Object

getAttribute, getAttributeTable, getAttributeValue, getAttributeValues, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, putAttribute, putAttributesInTable, removeAttribute, setObjectHandle, setVendorDefinedObjectBuilder, toString

Methods inherited from class java.lang.Object

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

Field Detail

prime

protected ByteArrayAttribute prime

The prime (p) of this DH key.

base

protected ByteArrayAttribute base

The base (g) of this DH key.

value

protected ByteArrayAttribute value

The private value (x) of this DH key.

valueBits

protected LongAttribute valueBits

The length of the value (x) of this DH key in bits.

Constructor Detail

DHPrivateKey

public DHPrivateKey()

Default Constructor.

DHPrivateKey

protected DHPrivateKey(Session session,
                       long objectHandle)
                throws TokenException

Called by getInstance to create an instance of a PKCS#11 DH private key.

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

objectHandle - The object handle as given from the PKCS#111 module.

Throws:

TokenException - If getting the attributes failed.

Method Detail

getInstance

public static PKCS11Object getInstance(Session session,
                                       long objectHandle)
                                throws TokenException

The getInstance method of the PrivateKey class uses this method to create an instance of a PKCS#11 DH private key.

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

objectHandle - The object handle as given from the PKCS#111 module.

Returns:

The object representing the PKCS#11 object. The returned object can be casted to the according sub-class.

Throws:

TokenException - If getting the attributes failed.

putAttributesInTable

protected static void putAttributesInTable(DHPrivateKey object)

Put all attributes of the given object into the attributes table of this object. This method is only static to be able to access invoke the implementation of this method for each class separately.

Parameters:

object - The object to handle.

allocateAttributes

protected void allocateAttributes()

Allocates the attribute objects for this class and adds them to the attribute table.

Overrides:

allocateAttributes in class PrivateKey

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 PrivateKey

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.

getPrime

public ByteArrayAttribute getPrime()

Gets the prime attribute of this DH key.

Returns:

The prime attribute.

getBase

public ByteArrayAttribute getBase()

Gets the base attribute of this DH key.

Returns:

The base attribute.

getValue

public ByteArrayAttribute getValue()

Gets the value attribute of this DH key.

Returns:

The value attribute.

getValueBits

public LongAttribute getValueBits()

Gets the value length attribute of this DH key (in bits).

Returns:

The value length attribute.

readAttributes

public void readAttributes(Session session)
                    throws TokenException

Read the values of the attributes of this object from the token.

Overrides:

readAttributes in class PrivateKey

Parameters:

session - The session to use for reading attributes. This session must have the appropriate rights; i.e. it must be a user-session, if it is a private object.

Throws:

TokenException - If getting the attributes failed.

toString

public String toString()

Returns a string representation of the current object. The output is only for debugging purposes and should not be used for other purposes.

Overrides:

toString in class PrivateKey

Returns:

A string presentation of this object for debugging output.