iaik.pkcs.pkcs11.objects

Class Key

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

PrivateKey, PublicKey, SecretKey

public class Key
extends Storage

An object of this class represents a key as defined by PKCS#11 2.11. A key is of a specific type: RSA, DSA, DH, ECDSA, EC, X9_42_DH, KEA, GENERIC_SECRET, RC2, RC4, DES, DES2, DES3, CAST, CAST3, CAST5, CAST128, RC5, IDEA, SKIPJACK, BATON, JUNIPER, CDMF, AES or VENDOR_DEFINED. If an application needs to use vendor-defined keys, it must set a VendorDefinedKeyeBuilder using the setVendorDefinedKeyBuilder method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Key.KeyType This interface defines the available key types as defined by PKCS#11 2.11: RSA, DSA, DH, ECDSA, KEA, GENERIC_SECRET, RC2, RC4, DES, DES2, DES3, CAST, CAST3, CAST5, CAST128, RC5, IDEA, SKIPJACK, BATON, JUNIPER, CDMF, AES, EC, X9_42_DH or VENDOR_DEFINED.
static interface	Key.VendorDefinedKeyBuilder If an application uses vendor defined keys, it must implement this interface and install such an object handler using setVendorDefinedKeyBuilder.

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

Object.ObjectClass, Object.VendorDefinedObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected MechanismArrayAttribute	allowedMechanisms_ The list of mechanism that can be used with this key.
protected BooleanAttribute	derive_ True, if other keys can be derived from this key.
protected DateAttribute	endDate_ The end date of this key's validity.
protected ByteArrayAttribute	id_ The identifier (ID) of this key.
protected MechanismAttribute	keyGenMechanism_ The mechanism used to generate the key material.
protected KeyTypeAttribute	keyType_ The type of this key.
protected static java.util.Hashtable	keyTypeNames_ A table holding string representations for all known key types.
protected BooleanAttribute	local_ True, if this key was created (generated or copied from a different key) on the token.
protected DateAttribute	startDate_ The start date of this key's validity.
protected static Key.VendorDefinedKeyBuilder	vendorKeyBuilder_ The currently set vendor defined key builder, or null.

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

label_, modifiable_, private_, token_

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

attributeTable_, objectClass_, objectClassNames_, objectHandle_, vendorObjectBuilder_

Constructor Summary

Constructors

Modifier	Constructor and Description
	Key() The default constructor.
protected	Key(Session session, long objectHandle) Called by sub-classes to create an instance of a PKCS#11 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.
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.
MechanismArrayAttribute	getAllowedMechanisms() Get the list of mechanisms that are allowed to use with this key.
BooleanAttribute	getDerive() Check, if other keys can be derived from this key.
DateAttribute	getEndDate() Gets the end date attribute of the validity of this key.
ByteArrayAttribute	getId() Gets the ID attribute of this key.
MechanismAttribute	getKeyGenMechanism() Get the mechanism used to generate the key material for this key.
LongAttribute	getKeyType() Gets the key type attribute of the PKCS#11 key.
static java.lang.String	getKeyTypeName(java.lang.Long keyType) Get the given key type as string.
BooleanAttribute	getLocal() Check, if this key is a local key; i.e. was generated on the token or created via copy from a different key on the token.
DateAttribute	getStartDate() Gets the start date attribute of the validity of this key.
static Key.VendorDefinedKeyBuilder	getVendorDefinedKeyBuilder() Get the currently set vendor-defined key builder.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
boolean	isDerivable() Check whether this key's derive attribute is set to true.
boolean	isDerive() Check whether this key's derive attribute is set to true.
boolean	isLocal() Check whether this key's local attribute is set to true.
protected static void	putAttributesInTable(Key object) Put all attributes of the given object into the attributes table of this object.
Mechanism[]	readAllowedMechanisms() Read the value of the allowed mechanisms attribute.
boolean	readDerive() Read the value of the derive attribute.
java.util.Date	readEndDate() Read the value of the end date attribute.
byte[]	readId() Read the value of the ID attribute.
java.lang.Long	readKeyGenMechanism() Read the value of the key generation mechanism attribute.
java.lang.Long	readKeyType() Read the value of the key type attribute.
boolean	readLocal() Read the value of the local attribute.
java.util.Date	readStartDate() Read the value of the start date attribute.
Key	setAllowedMechanisms(Mechanism[] allowedMechanisms) Set the value of the allowed mechanisms attribute.
Key	setDerive(boolean derive) Set the value of the derive attribute.
Key	setEndDate(java.util.Date endDate) Set the value of the end date attribute.
Key	setId(byte[] id) Set the value of the ID attribute.
Key	setKeyGenMechanism(java.lang.Long keyGenMechanism) Set the value of the key generation mechanism attribute.
Key	setKeyType(java.lang.Long keyType) Set the value of the key type attribute.
Key	setLocal(boolean local) Set the value of the local attribute.
Key	setStartDate(java.util.Date startDate) Set the value of the start date attribute.
static void	setVendorDefinedKeyBuilder(Key.VendorDefinedKeyBuilder builder) Set a vendor-defined key builder that should be called to create an instance of an vendor-defined PKCS#11 key; i.e. an instance of a vendor defined sub-class of this class.
java.lang.String	toString() This method returns a string representation of the current object.

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

getLabel, getModifiable, getPrivate, getToken, isModifiable, isPrivate, isToken, putAttributesInTable, readLabel, readModifiable, readPrivate, readToken, setLabel, setModifiable, setPrivate, setToken

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

checkAttributesState, checkAttributeState, filterExcludedAttributes, filterExcludedAttributes, getAttribute, getAttributeTable, getAttributeValue, getAttributeValues, getExcludedAttributes, getInstance, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, hasExcluded, putAttribute, putAttributesInTable, readAttributes, removeAttribute, setObjectHandle, setVendorDefinedObjectBuilder, toString

Methods inherited from class java.lang.Object

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

Field Detail

vendorKeyBuilder_

protected static Key.VendorDefinedKeyBuilder vendorKeyBuilder_

The currently set vendor defined key builder, or null.

keyTypeNames_

protected static java.util.Hashtable keyTypeNames_

A table holding string representations for all known key types. Table key is the key type as Long object.

keyType_

protected KeyTypeAttribute keyType_

The type of this key. Its value is one of KeyType, or one that has a bigger value than VENDOR_DEFINED.

id_

protected ByteArrayAttribute id_

The identifier (ID) of this key.

startDate_

protected DateAttribute startDate_

The start date of this key's validity.

endDate_

protected DateAttribute endDate_

The end date of this key's validity.

derive_

protected BooleanAttribute derive_

True, if other keys can be derived from this key.

local_

protected BooleanAttribute local_

True, if this key was created (generated or copied from a different key) on the token.

keyGenMechanism_

protected MechanismAttribute keyGenMechanism_

The mechanism used to generate the key material.

allowedMechanisms_

protected MechanismArrayAttribute allowedMechanisms_

The list of mechanism that can be used with this key.

Constructor Detail

Key

public Key()

The default constructor. An application use this constructor to instantiate a key that serves as a template. It may also be useful for working with vendor-defined keys.

Key

protected Key(Session session,
              long objectHandle)
       throws TokenException

Called by sub-classes to create an instance of a PKCS#11 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

setVendorDefinedKeyBuilder

public static void setVendorDefinedKeyBuilder(Key.VendorDefinedKeyBuilder builder)

Set a vendor-defined key builder that should be called to create an instance of an vendor-defined PKCS#11 key; i.e. an instance of a vendor defined sub-class of this class.

Parameters:

builder - The vendor-defined key builder. Null to clear any previously installed vendor-defined builder.

getVendorDefinedKeyBuilder

public static Key.VendorDefinedKeyBuilder getVendorDefinedKeyBuilder()

Get the currently set vendor-defined key builder.

Returns:

The currently set vendor-defined key builder or null if none is set.

getKeyTypeName

public static java.lang.String getKeyTypeName(java.lang.Long keyType)

Get the given key type as string.

Parameters:

keyType - The key type to get as string.

Returns:

A string denoting the key type; e.g. "RSA".

putAttributesInTable

protected static void putAttributesInTable(Key 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 (see use in clone()).

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 Storage

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class Storage

Returns:

A clone 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 Storage

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.

setKeyType

public Key setKeyType(java.lang.Long keyType)

Set the value of the key type attribute.

Parameters:

keyType - the key type attrubute value

Returns:

this object

getKeyType

public LongAttribute getKeyType()

Gets the key type attribute of the PKCS#11 key. Its value must be one of those defined in the KeyType interface or one with an value bigger than KeyType.VENDOR_DEFINED.

Returns:

The key type identifier.

readKeyType

public java.lang.Long readKeyType()

Read the value of the key type attribute.

Returns:

the value of the key type attribute

setId

public Key setId(byte[] id)

Set the value of the ID attribute.

Parameters:

id - the ID attribute value

Returns:

this object

getId

public ByteArrayAttribute getId()

Gets the ID attribute of this key.

Returns:

The key identifier attribute.

readId

public byte[] readId()

Read the value of the ID attribute.

Returns:

the value of the ID attribute

setStartDate

public Key setStartDate(java.util.Date startDate)

Set the value of the start date attribute.

Parameters:

startDate - the start date attribute value

Returns:

this object

getStartDate

public DateAttribute getStartDate()

Gets the start date attribute of the validity of this key.

Returns:

The start date of validity.

readStartDate

public java.util.Date readStartDate()

Read the value of the start date attribute.

Returns:

the value of the start date attribute

setEndDate

public Key setEndDate(java.util.Date endDate)

Set the value of the end date attribute.

Parameters:

endDate - the end date attribute value

Returns:

this object

getEndDate

public DateAttribute getEndDate()

Gets the end date attribute of the validity of this key.

Returns:

The end date of validity.

readEndDate

public java.util.Date readEndDate()

Read the value of the end date attribute.

Returns:

the value of the end date attribute

setDerive

public Key setDerive(boolean derive)

Set the value of the derive attribute.

Parameters:

derive - the derive attribute value

getDerive

public BooleanAttribute getDerive()

Check, if other keys can be derived from this key.

Returns:

Its value is true, if other keys can be derived from this key.

readDerive

public boolean readDerive()

Read the value of the derive attribute.

Returns:

the value of the derive attribute

isDerive

public boolean isDerive()

Check whether this key's derive attribute is set to true.

Returns:

true if this key's derive attribute is set to true, false otherwise

isDerivable

public boolean isDerivable()

Check whether this key's derive attribute is set to true.

Returns:

true if this key's derive attribute is set to true, false otherwise

setLocal

public Key setLocal(boolean local)

Set the value of the local attribute.

Parameters:

local - the local attribute value

getLocal

public BooleanAttribute getLocal()

Check, if this key is a local key; i.e. was generated on the token or created via copy from a different key on the token.

Returns:

Its value is true, if the key was created on the token.

readLocal

public boolean readLocal()

Read the value of the local attribute.

Returns:

the value of the local attribute

isLocal

public boolean isLocal()

Check whether this key's local attribute is set to true.

Returns:

true if this key's local attribute is set to true, false otherwise

setKeyGenMechanism

public Key setKeyGenMechanism(java.lang.Long keyGenMechanism)

Set the value of the key generation mechanism attribute.

Parameters:

keyGenMechanism - the key generation mechanism attribute value

getKeyGenMechanism

public MechanismAttribute getKeyGenMechanism()

Get the mechanism used to generate the key material for this key.

Returns:

The mechanism attribute used to generate the key material for this key.

readKeyGenMechanism

public java.lang.Long readKeyGenMechanism()

Read the value of the key generation mechanism attribute.

Returns:

the value of the key generation mechanism attribute

setAllowedMechanisms

public Key setAllowedMechanisms(Mechanism[] allowedMechanisms)

Set the value of the allowed mechanisms attribute.

Parameters:

allowedMechanisms - the allowed mechanisms attribute value

getAllowedMechanisms

public MechanismArrayAttribute getAllowedMechanisms()

Get the list of mechanisms that are allowed to use with this key. This attribute can only be used with PKCS#11 modules supporting cryptoki version 2.20 or higher.

Returns:

The list of mechanisms that are allowed to use with this key.

readAllowedMechanisms

public Mechanism[] readAllowedMechanisms()

Read the value of the allowed mechanisms attribute.

Returns:

the value of the allowed mechanisms attribute

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 Storage

Returns:

The hash code of this object.

toString

public java.lang.String toString()

This method 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 Storage

Returns:

A string presentation of this object for debugging output.