iaik.pkcs.pkcs11.objects

Class ECPublicKey

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PublicKey

iaik.pkcs.pkcs11.objects.ECPublicKey

public class ECPublicKey
extends PublicKey

Objects of this class represent ECDSA 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 ByteArrayAttribute	ecdsaParams The DER-encoding of an X9.62 ECParameters value of this ECDSA key.
protected ByteArrayAttribute	ecPoint The DER-encoding of X9.62 ECPoint value P of this ECDSA 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

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
	ECPublicKey() Default Constructor.
	ECPublicKey(long keyType) Default Constructor with the specification of keyType
protected	ECPublicKey(Session session, long objectHandle) Called by getInstance to create an instance of a PKCS#11 ECDSA 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.
ByteArrayAttribute	getEcdsaParams() Gets the ECDSA parameters attribute of this ECDSA key.
ByteArrayAttribute	getEcPoint() Gets the EC point attribute of this ECDSA key.
static PKCS11Object	getInstance(Session session, long objectHandle) The getInstance method of the PublicKey class uses this method to create an instance of a PKCS#11 ECDSA public key.
static ECPublicKey	newSM2PublicKey(Module module)
protected static void	putAttributesInTable(ECPublicKey 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.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, 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

ecdsaParams

protected ByteArrayAttribute ecdsaParams

The DER-encoding of an X9.62 ECParameters value of this ECDSA key.

ecPoint

protected ByteArrayAttribute ecPoint

The DER-encoding of X9.62 ECPoint value P of this ECDSA key.

Constructor Detail

ECPublicKey

public ECPublicKey()

Default Constructor.

ECPublicKey

public ECPublicKey(long keyType)

Default Constructor with the specification of keyType

Parameters:

keyType - key type. Valid Values are EC, VENDOR_SM2, EC_EDWARDS and EC_MONTGOMERY defined in KeyType.

See Also:

KeyType

ECPublicKey

protected ECPublicKey(Session session,
                      long objectHandle)
               throws TokenException

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

newSM2PublicKey

public static ECPublicKey newSM2PublicKey(Module module)

getInstance

public static PKCS11Object 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 ECDSA 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.

putAttributesInTable

protected static void putAttributesInTable(ECPublicKey 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 PublicKey

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

getEcdsaParams

public ByteArrayAttribute getEcdsaParams()

Gets the ECDSA parameters attribute of this ECDSA key.

Returns:

The ECDSA parameters attribute.

getEcPoint

public ByteArrayAttribute getEcPoint()

Gets the EC point attribute of this ECDSA key.

Returns:

The EC point 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 PublicKey

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 PublicKey

Returns:

A string presentation of this object for debugging output.