iaik.pkcs.pkcs11.objects

Class PublicKey

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PublicKey

Direct Known Subclasses:

DHPublicKey, DSAPublicKey, ECPublicKey, KEAPublicKey, RSAPublicKey

public class PublicKey
extends Key

This is the base class for public (asymmetric) keys. Objects of this class represent public 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	encrypt True, if this public key can be used for encryption.
protected ByteArrayAttribute	subject The subject attribute of this public key.
protected BooleanAttribute	trusted True, if this public key can be used for wrapping other keys.
protected BooleanAttribute	verify True, if this public key can be used for verification.
protected BooleanAttribute	verifyRecover True, if this public key can be used for encryption with recovery.
protected BooleanAttribute	wrap True, if this public key can be used for wrapping other keys.
protected AttributeArray	wrapTemplate Template of the key, that can be wrapped.

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

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

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
	PublicKey() Default Constructor.
protected	PublicKey(Session session, long objectHandle) Called by sub-classes to create an instance of a PKCS#11 public 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	getEncrypt() Gets the encrypt 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 public key.
ByteArrayAttribute	getSubject() Gets the subject attribute of this key.
BooleanAttribute	getTrusted() Gets the trusted attribute of this key.
protected static PKCS11Object	getUnknownPublicKey(Session session, long objectHandle) Try to create a key which has no or an unknown public key type attribute.
BooleanAttribute	getVerify() Gets the verify attribute of this key.
BooleanAttribute	getVerifyRecover() Gets the verify recover attribute of this key.
BooleanAttribute	getWrap() Gets the wrap attribute of this key.
AttributeArray	getWrapTemplate() Gets the wrap template attribute of this key.
protected static void	putAttributesInTable(PublicKey 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, getVendorDefinedKeyBuilder, hashCode, putAttributesInTable, setVendorDefinedKeyBuilder

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 attribute of this public key.

encrypt

protected BooleanAttribute encrypt

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

verify

protected BooleanAttribute verify

True, if this public key can be used for verification.

verifyRecover

protected BooleanAttribute verifyRecover

True, if this public key can be used for encryption with recovery.

wrap

protected BooleanAttribute wrap

True, if this public key can be used for wrapping other keys.

trusted

protected BooleanAttribute trusted

True, if this public key can be used for wrapping other keys.

wrapTemplate

protected AttributeArray wrapTemplate

Template of the key, that can be wrapped.

Constructor Detail

PublicKey

public PublicKey()

Default Constructor.

PublicKey

protected PublicKey(Session session,
                    long objectHandle)
             throws TokenException

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

getUnknownPublicKey

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

Try to create a key which has no or an unknown public key 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 PublicKey .

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(PublicKey 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.

getEncrypt

public BooleanAttribute getEncrypt()

Gets the encrypt attribute of this key.

Returns:

The encrypt attribute.

getVerify

public BooleanAttribute getVerify()

Gets the verify attribute of this key.

Returns:

The verify attribute.

getVerifyRecover

public BooleanAttribute getVerifyRecover()

Gets the verify recover attribute of this key.

Returns:

The verify recover attribute.

getWrap

public BooleanAttribute getWrap()

Gets the wrap attribute of this key.

Returns:

The wrap attribute.

getTrusted

public BooleanAttribute getTrusted()

Gets the trusted attribute of this key.

Returns:

The trusted attribute.

getWrapTemplate

public AttributeArray getWrapTemplate()

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

Returns:

The wrap template 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.