com.entrust.toolkit.credentials

Class P11StorageObject

java.lang.Object

com.entrust.toolkit.credentials.P11StorageObject

Direct Known Subclasses:

P11DataObject, P11PrivateKeyObject, P11X509CertificateObject

public abstract class P11StorageObject
extends java.lang.Object

This class represents a PKCS #11 storage object.

Using this class a software representation of an Entrust digital identity in PKCS #11 format can be defined, as required by a Card Management System (CMS). This representation is simply a collection of these storage objects.

This object specifies values for all the following object attributes:

CKA_CLASS (mandatory)

Object class (type)

CKA_TOKEN

TRUE if object is a token object; FALSE if object is a session object

CKA_PRIVATE

TRUE if object is a private object; FALSE if object is a public object

CKA_LABEL

Description of the object

For storage attributes that have not yet been specified (CKA_MODIFIABLE), or have been specified but have not been set in the storage object implementation, default values are to be used when the object is written to the smart card by the CMS.

This class is abstract; the following storage object implementations are used to create a software representation of an Entrust digital identity in PKCS #11 format:

• P11DataObject
• P11X509CertificateObject
• P11PrivateKeyObject

Each of these storage object implementations specifies additional attributes that must also be written to the smart card. To properly create the Entrust digital identity on a smart card, each object must be written with all the attribute values specified by the implementation.

Since:

7.0sp1

See Also:

PKCS #11: Cryptographic Token Interface Standard, CMPForCardMS

Method Summary

Modifier and Type	Method and Description
long	getCkaClass() Returns the object class (type).
java.lang.String	getCkaLabel() Returns a description of the object.
java.lang.Boolean	getCkaPrivate() Returns an indicator for whether the object is a public object or a private object.
java.lang.Boolean	getCkaToken() Returns an indicator for whether the object is a token object or a session object.
boolean	isDataObject() Indicate whether this PKCS #11 storage object is a data object.
boolean	isPrivateKeyObject() Indicate whether this PKCS #11 storage object is a private key object.
boolean	isX509CertificateObject() Indicate whether this PKCS #11 storage object is an X.509 certificate object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCkaClass

public long getCkaClass()

Returns the object class (type).

Returns:

the value of the CKA_CLASS attribute

getCkaToken

public java.lang.Boolean getCkaToken()

Returns an indicator for whether the object is a token object or a session object.

Returns:

the value of the CKA_TOKEN attributeif it has been set; null otherwise

getCkaPrivate

public java.lang.Boolean getCkaPrivate()

Returns an indicator for whether the object is a public object or a private object.

Returns:

the value of the CKA_PRIVATE attribute if it has been set; null otherwise

getCkaLabel

public java.lang.String getCkaLabel()

Returns a description of the object.

Returns:

the value of the CKA_LABEL attribute if it has been set; null otherwise

isDataObject

public boolean isDataObject()

Indicate whether this PKCS #11 storage object is a data object.

Returns:

true if this object is a data object; false otherwise

isX509CertificateObject

public boolean isX509CertificateObject()

Indicate whether this PKCS #11 storage object is an X.509 certificate object.

Returns:

true if this object is a X.509 certificate object; false otherwise

isPrivateKeyObject

public boolean isPrivateKeyObject()

Indicate whether this PKCS #11 storage object is a private key object.

Returns:

true if this object is a private key object; false otherwise