iaik.pkcs.pkcs11.objects

Class RSAPublicKey

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PublicKey

iaik.pkcs.pkcs11.objects.RSAPublicKey

All Implemented Interfaces:

java.lang.Cloneable

public class RSAPublicKey
extends PublicKey

Objects of this class represent RSA public keys as specified by PKCS#11 v2.11.

Version:

1.0

Author:

Karl Scheibelhofer

Invariants:

(modulus_ != null) and (publicExponent_ != null) and (modulusBits_ != null)

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 ByteArrayAttribute	modulus_ The modulus (n) of this RSA key.
protected LongAttribute	modulusBits_ The bit-length of the modulus of this RSA key.
protected ByteArrayAttribute	publicExponent_ The public exponent (e) of this RSA key.

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

encrypt_, subject_, trusted_, verify_, verifyRecover_, wrap_, wrapTemplate_

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
	RSAPublicKey() Default Constructor.
protected	RSAPublicKey(Session session, long objectHandle) Called by getInstance to create an instance of a PKCS#11 RSA 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.
static Object	getInstance(Session session, long objectHandle) The getInstance method of the PublicKey class uses this method to create an instance of a PKCS#11 RSA public key.
ByteArrayAttribute	getModulus() Gets the modulus attribute of this RSA key.
LongAttribute	getModulusBits() Gets the modulus bits (bit-length of the modulus) attribute of this RSA key.
ByteArrayAttribute	getPublicExponent() Gets the public exponent attribute of this RSA key.
protected static void	putAttributesInTable(RSAPublicKey object) Put all attributes of the given object into the attributes table of this object.
java.lang.String	toString() This method returns a string representation of the current object.

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

getEncrypt, getSubject, getTrusted, getUnknownPublicKey, getVerify, getVerifyRecover, getWrap, getWrapTemplate, putAttributesInTable

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

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

Methods inherited from class java.lang.Object

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

Field Detail

modulus_

protected ByteArrayAttribute modulus_

The modulus (n) of this RSA key.

publicExponent_

protected ByteArrayAttribute publicExponent_

The public exponent (e) of this RSA key.

modulusBits_

protected LongAttribute modulusBits_

The bit-length of the modulus of this RSA key.

Constructor Detail

RSAPublicKey

public RSAPublicKey()

Default Constructor.

RSAPublicKey

protected RSAPublicKey(Session session,
                       long objectHandle)
                throws TokenException

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

Preconditions:

(session != null)

Method Detail

getInstance

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

The getInstance method of the PublicKey class uses this method to create an instance of a PKCS#11 RSA 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.

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.

Postconditions:

(result != null)

Preconditions:

(session != null)

putAttributesInTable

protected static void putAttributesInTable(RSAPublicKey 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.

Preconditions:

(object != null)

allocateAttributes

protected void allocateAttributes()

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

Overrides:

allocateAttributes in class PublicKey

clone

public java.lang.Object clone()

Create a (deep) clone of this object.

Overrides:

clone in class PublicKey

Returns:

A clone of this object.

Postconditions:

(result != null) and (result instanceof RSAPublicKey) and (result.equals(this))

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 PublicKey

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.

getModulus

public ByteArrayAttribute getModulus()

Gets the modulus attribute of this RSA key.

Returns:

The modulus attribute.

Postconditions:

(result != null)

getPublicExponent

public ByteArrayAttribute getPublicExponent()

Gets the public exponent attribute of this RSA key.

Returns:

The public exponent attribute.

Postconditions:

(result != null)

getModulusBits

public LongAttribute getModulusBits()

Gets the modulus bits (bit-length of the modulus) attribute of this RSA key.

Returns:

The public exponent attribute.

Postconditions:

(result != null)

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 PublicKey

Returns:

A string presentation of this object for debugging output.

Postconditions:

(result != null)