iaik.pkcs.pkcs11.objects

Class PrivateKey

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PrivateKey

Direct Known Subclasses:

DHPrivateKey, DSAPrivateKey, ECPrivateKey, KEAPrivateKey, RSAPrivateKey

public class PrivateKey
extends Key

This is the base class for private (asymmetric) keys. Objects of this class represent 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 BooleanAttribute	alwaysAuthenticate True, if the user has to supply the PIN for each use (sign or decrypt) with the key.
protected BooleanAttribute	alwaysSensitive True, if this private key was always sensitive.
protected LongAttribute	authPinFlags The authentication flags for secondary authentication.
protected BooleanAttribute	decrypt True, if this private key can be used for encryption.
protected BooleanAttribute	extractable True, if this private key can not be extracted from the token.
protected BooleanAttribute	neverExtractable True, if this private key was never extractable.
protected BooleanAttribute	secondaryAuth True, if this private key supports secondary authentication.
protected BooleanAttribute	sensitive True, if this private key is sensitive.
protected BooleanAttribute	sign True, if this private key can be used for signing.
protected BooleanAttribute	signRecover True, if this private key can be used for signing with recover.
protected ByteArrayAttribute	subject The subject of this private key.
protected BooleanAttribute	unwrap True, if this private key can be used for unwrapping wrapped keys.
protected AttributeArray	unwrapTemplate Template of the key, that can be unwrapped.
protected BooleanAttribute	wrapWithTrusted True, if this private key can only be wrapped with a wrapping key having set the attribute trusted to true.

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
	PrivateKey() Default Constructor.
protected	PrivateKey(Session session, long objectHandle) Called by sub-classes to create an instance of a PKCS#11 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.
BooleanAttribute	getAlwaysAuthenticate() Gets the always authenticate attribute of this key.
BooleanAttribute	getAlwaysSensitive() Gets the always sensitive attribute of this key.
LongAttribute	getAuthPinFlags() Gets the authentication flags for secondary authentication of this key.
BooleanAttribute	getDecrypt() Gets the decrypt attribute of this key.
BooleanAttribute	getExtractable() Gets the extractable attribute of this key.
static PKCS11Object	getInstance(Session session, long objectHandle) The getInstance method of the PKCS11Object class uses this method to create an instance of a PKCS#11 private key.
BooleanAttribute	getNeverExtractable() Gets the never extractable attribute of this key.
BooleanAttribute	getSecondaryAuth() Gets the secondary authentication attribute of this key.
BooleanAttribute	getSensitive() Gets the sensitive attribute of this key.
BooleanAttribute	getSign() Gets the sign attribute of this key.
BooleanAttribute	getSignRecover() Gets the sign recover attribute of this key.
ByteArrayAttribute	getSubject() Gets the subject attribute of this key.
protected static PKCS11Object	getUnknownPrivateKey(Session session, long objectHandle) Try to create a key which has no or an unknown private key type type attribute.
BooleanAttribute	getUnwrap() Gets the unwrap attribute of this key.
AttributeArray	getUnwrapTemplate() Gets the unwrap template attribute of this key.
BooleanAttribute	getWrapWithTrusted() Gets the wrap with trusted attribute of this key.
protected static void	putAttributesInTable(PrivateKey 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.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

subject

protected ByteArrayAttribute subject

The subject of this private key.

sensitive

protected BooleanAttribute sensitive

True, if this private key is sensitive.

secondaryAuth

protected BooleanAttribute secondaryAuth

True, if this private key supports secondary authentication.

authPinFlags

protected LongAttribute authPinFlags

The authentication flags for secondary authentication. Only defined, if the secondaryAuth is set.

decrypt

protected BooleanAttribute decrypt

True, if this private key can be used for encryption.

sign

protected BooleanAttribute sign

True, if this private key can be used for signing.

signRecover

protected BooleanAttribute signRecover

True, if this private key can be used for signing with recover.

unwrap

protected BooleanAttribute unwrap

True, if this private key can be used for unwrapping wrapped keys.

extractable

protected BooleanAttribute extractable

True, if this private key can not be extracted from the token.

alwaysSensitive

protected BooleanAttribute alwaysSensitive

True, if this private key was always sensitive.

neverExtractable

protected BooleanAttribute neverExtractable

True, if this private key was never extractable.

wrapWithTrusted

protected BooleanAttribute wrapWithTrusted

True, if this private key can only be wrapped with a wrapping key having set the attribute trusted to true.

unwrapTemplate

protected AttributeArray unwrapTemplate

Template of the key, that can be unwrapped.

alwaysAuthenticate

protected BooleanAttribute alwaysAuthenticate

True, if the user has to supply the PIN for each use (sign or decrypt) with the key.

Constructor Detail

PrivateKey

public PrivateKey()

Default Constructor.

PrivateKey

protected PrivateKey(Session session,
                     long objectHandle)
              throws TokenException

Called by sub-classes to create an instance of a PKCS#11 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 PKCS11Object class uses this method to create an instance of a PKCS#11 private key. This method reads the key type attribute and calls the getInstance method of the according sub-class. If the key type is a vendor defined it uses the VendorDefinedKeyBuilder set by the application. If no private key could be constructed, Returns null.

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.

getUnknownPrivateKey

protected static PKCS11Object getUnknownPrivateKey(Session session,
                                                   long objectHandle)
                                            throws TokenException

Try to create a key which has no or an unknown private key type type attribute. This implementation will try to use a vendor defined key builder, if such has been set. If this is impossible or fails, it will create just a simple PrivateKey .

Parameters:

session - The session to use.

objectHandle - The handle of the object

Returns:

A new PKCS11Object.

Throws:

TokenException - If no object could be created.

putAttributesInTable

protected static void putAttributesInTable(PrivateKey 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 Key

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 Key

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.

getSubject

public ByteArrayAttribute getSubject()

Gets the subject attribute of this key.

Returns:

The subject attribute.

getSensitive

public BooleanAttribute getSensitive()

Gets the sensitive attribute of this key.

Returns:

The sensitive attribute.

getSecondaryAuth

public BooleanAttribute getSecondaryAuth()

Gets the secondary authentication attribute of this key.

Returns:

The secondary authentication attribute.

getAuthPinFlags

public LongAttribute getAuthPinFlags()

Gets the authentication flags for secondary authentication of this key.

Returns:

The authentication flags for secondary authentication attribute.

getDecrypt

public BooleanAttribute getDecrypt()

Gets the decrypt attribute of this key.

Returns:

The decrypt attribute.

getSign

public BooleanAttribute getSign()

Gets the sign attribute of this key.

Returns:

The sign attribute.

getSignRecover

public BooleanAttribute getSignRecover()

Gets the sign recover attribute of this key.

Returns:

The sign recover attribute.

getUnwrap

public BooleanAttribute getUnwrap()

Gets the unwrap attribute of this key.

Returns:

The unwrap attribute.

getExtractable

public BooleanAttribute getExtractable()

Gets the extractable attribute of this key.

Returns:

The extractable attribute.

getAlwaysSensitive

public BooleanAttribute getAlwaysSensitive()

Gets the always sensitive attribute of this key.

Returns:

The always sensitive attribute.

getNeverExtractable

public BooleanAttribute getNeverExtractable()

Gets the never extractable attribute of this key.

Returns:

The never extractable attribute.

getWrapWithTrusted

public BooleanAttribute getWrapWithTrusted()

Gets the wrap with trusted attribute of this key.

Returns:

The wrap with trusted attribute.

getUnwrapTemplate

public AttributeArray getUnwrapTemplate()

Gets the unwrap template attribute of this key. This attribute can only be used with PKCS#11 modules supporting cryptoki version 2.20 or higher.

Returns:

The unwrap template attribute.

getAlwaysAuthenticate

public BooleanAttribute getAlwaysAuthenticate()

Gets the always authenticate attribute of this key.

Returns:

The always authenticate 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 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.

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 Key

Returns:

A string presentation of this object for debugging output.