iaik.pkcs.pkcs11.objects

Class PublicKey

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PublicKey

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

DHPublicKey, DSAPublicKey, ECDSAPublicKey, KEAPublicKey, MLDSAPublicKey, 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.

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

Object.ObjectClass, Object.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.Object

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.
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.
BooleanAttribute	getEncrypt() Gets the encrypt attribute of this key.
static Object	getInstance(Session session, long objectHandle) The getInstance method of the Object 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 Object	getUnknownPublicKey(Session session, long objectHandle) Try to create a key which has no or an unknown public key type 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.
boolean	isEncrypt() Check whether this key's encrypt attribute is set to true.
boolean	isTrusted() Check whether this key's trusted attribute is set to true.
boolean	isVerify() Check whether this key's verify attribute is set to true.
boolean	isVerifyRecover() Check whether this key's verify recover attribute is set to true.
boolean	isWrap() Check whether this key's wrap attribute is set to true.
protected static void	putAttributesInTable(PublicKey object) Put all attributes of the given object into the attributes table of this object.
boolean	readEncrypt() Read the value of the encrypt attribute.
byte[]	readSubject() Read the value of the subject attribute.
boolean	readTrusted() Read the value of the trusted attribute.
boolean	readVerify() Read the value of the verify attribute.
boolean	readVerifyRecover() Read the value of the verify recover attribute.
boolean	readWrap() Read the value of the wrap attribute.
Object	readWrapTemplate() Read the value of the wrap template attribute.
PublicKey	setEncrypt(boolean encrypt) Set the value of the encrypt attribute.
PublicKey	setSubject(byte[] subject) Set the value of the subject attribute.
PublicKey	setTrusted(boolean trusted) Set the value of the trusted attribute.
PublicKey	setVerify(boolean verify) Set the value of the verify attribute.
PublicKey	setVerifyRecover(boolean verifyRecover) Set the value of the verify recover attribute.
PublicKey	setWrap(boolean wrap) Set the value of the wrap attribute.
PublicKey	setWrapTemplate(Object wrapTemplate) Set the value of the wrap template attribute.
java.lang.String	toString() This method 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, isDerivable, isDerive, isLocal, putAttributesInTable, readAllowedMechanisms, readDerive, readEndDate, readId, readKeyGenMechanism, readKeyType, readLocal, readStartDate, setAllowedMechanisms, setDerive, setEndDate, setId, setKeyGenMechanism, setKeyType, setLocal, setStartDate, setVendorDefinedKeyBuilder

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, 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

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 Object getInstance(Session session,
                                 long objectHandle)
                          throws TokenException

The getInstance method of the Object 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, this method 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 Object getUnknownPublicKey(Session session,
                                            long objectHandle)
                                     throws TokenException

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

Parameters:

session - The session to use.

objectHandle - The handle of the object

Returns:

A new Object.

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 (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 Key

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class Key

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

setSubject

public PublicKey setSubject(byte[] subject)

Set the value of the subject attribute.

Parameters:

subject - the subject attribute value

Returns:

this object

getSubject

public ByteArrayAttribute getSubject()

Gets the subject attribute of this key.

Returns:

The subject attribute.

readSubject

public byte[] readSubject()

Read the value of the subject attribute.

Returns:

the value of the subject attribute

setEncrypt

public PublicKey setEncrypt(boolean encrypt)

Set the value of the encrypt attribute.

Parameters:

encrypt - the encrypt attribute value

Returns:

this object

getEncrypt

public BooleanAttribute getEncrypt()

Gets the encrypt attribute of this key.

Returns:

The encrypt attribute.

readEncrypt

public boolean readEncrypt()

Read the value of the encrypt attribute.

Returns:

the value of the encrypt attribute

isEncrypt

public boolean isEncrypt()

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

Returns:

true if the encrypt attribute is set to true, false otherwise

setVerify

public PublicKey setVerify(boolean verify)

Set the value of the verify attribute.

Parameters:

verify - the verify attribute value

Returns:

this object

getVerify

public BooleanAttribute getVerify()

Gets the verify attribute of this key.

Returns:

The verify attribute.

readVerify

public boolean readVerify()

Read the value of the verify attribute.

Returns:

the value of the verify attribute

isVerify

public boolean isVerify()

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

Returns:

true if the verify attribute is set to true, false otherwise

setVerifyRecover

public PublicKey setVerifyRecover(boolean verifyRecover)

Set the value of the verify recover attribute.

Parameters:

verifyRecover - the verify recover attribute value

Returns:

this object

getVerifyRecover

public BooleanAttribute getVerifyRecover()

Gets the verify recover attribute of this key.

Returns:

The verify recover attribute.

readVerifyRecover

public boolean readVerifyRecover()

Read the value of the verify recover attribute.

Returns:

the value of the verify recover attribute

isVerifyRecover

public boolean isVerifyRecover()

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

Returns:

true if the verify recover attribute is set to true, false otherwise

setWrap

public PublicKey setWrap(boolean wrap)

Set the value of the wrap attribute.

Parameters:

wrap - the wrap attribute value

Returns:

this object

getWrap

public BooleanAttribute getWrap()

Gets the wrap attribute of this key.

Returns:

The wrap attribute.

readWrap

public boolean readWrap()

Read the value of the wrap attribute.

Returns:

the value of the wrap attribute

isWrap

public boolean isWrap()

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

Returns:

true if the wrap attribute is set to true, false otherwise

setTrusted

public PublicKey setTrusted(boolean trusted)

Set the value of the trusted attribute.

Parameters:

trusted - the trusted attribute value

Returns:

this object

getTrusted

public BooleanAttribute getTrusted()

Gets the trusted attribute of this key.

Returns:

The trusted attribute.

readTrusted

public boolean readTrusted()

Read the value of the trusted attribute.

Returns:

the value of the trusted attribute

isTrusted

public boolean isTrusted()

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

Returns:

true if the trusted attribute is set to true, false otherwise

setWrapTemplate

public PublicKey setWrapTemplate(Object wrapTemplate)

Set the value of the wrap template attribute.

Parameters:

wrapTemplate - the wrap template attribute value

Returns:

this object

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.

readWrapTemplate

public Object readWrapTemplate()

Read the value of the wrap template attribute.

Returns:

the value of the wrap template attribute

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 Key

Returns:

A string presentation of this object for debugging output.