iaik.pkcs.pkcs11.objects

Class X509PublicKeyCertificate

java.lang.Object

iaik.pkcs.pkcs11.objects.PKCS11Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Certificate

iaik.pkcs.pkcs11.objects.X509PublicKeyCertificate

public class X509PublicKeyCertificate
extends Certificate

Objects of this class represent X.509 public key certificate 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.Certificate

Certificate.CertificateType, Certificate.VendorDefinedCertificateBuilder

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	hashOfIssuerPublicKey SHA-1 hash of the issuer public key.
protected ByteArrayAttribute	hashOfSubjectPublicKey SHA-1 hash of the subject public key.
protected ByteArrayAttribute	id The ID attribute of this certificate.
protected ByteArrayAttribute	issuer The issuer attribute of this certificate.
protected LongAttribute	javaMidpSecurityDomain Java MIDP security domain: 0 = unspecified (default value), 1 = manufacturer, 2 = operator, 3 = third party.
protected ByteArrayAttribute	serialNumber The serial number attribute of this certificate.
protected ByteArrayAttribute	subject The subject attribute of this certificate.
protected CharArrayAttribute	url This attribute gives the URL where the complete certificate can be obtained.
protected ByteArrayAttribute	value The value attribute of this certificate; i.e.

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

certificateCategory, certificateType, checkValue, endDate, startDate, trusted, vendorCertificateBuilder

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
	X509PublicKeyCertificate() Default Constructor.
protected	X509PublicKeyCertificate(Session session, long objectHandle) Called by getInstance to create an instance of a PKCS#11 X.509 public key certificate.

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	getHashOfIssuerPublicKey() Gets the hash of issuer public key attribute of this X.509 public key certificate.
ByteArrayAttribute	getHashOfSubjectPublicKey() Gets the hash of subject public key attribute of this X.509 public key certificate.
ByteArrayAttribute	getId() Gets the ID attribute of this X.509 public key certificate.
static PKCS11Object	getInstance(Session session, long objectHandle) The getInstance method of the Certificate class uses this method to create an instance of a PKCS#11 X.509 public key certificate.
ByteArrayAttribute	getIssuer() Gets the issuer attribute of this X.509 public key certificate.
LongAttribute	getJavaMidpSecurityDomain() Gets the java midp security domain attribute of the PKCS#11 certificate.
ByteArrayAttribute	getSerialNumber() Gets the serial number attribute of this X.509 public key certificate.
ByteArrayAttribute	getSubject() Gets the subject attribute of this X.509 public key certificate.
CharArrayAttribute	getUrl() Get the URL attribute of this object.
ByteArrayAttribute	getValue() Gets the value attribute of this X.509 public key certificate.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
protected static void	putAttributesInTable(X509PublicKeyCertificate 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.Certificate

getCertificateCategory, getCertificateType, getCertificateTypeName, getCheckValue, getEndDate, getStartDate, getTrusted, getUnknownCertificate, getVendorDefinedCertificateBuilder, putAttributesInTable, setVendorDefinedCertificateBuilder

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

id

protected ByteArrayAttribute id

The ID attribute of this certificate.

issuer

protected ByteArrayAttribute issuer

The issuer attribute of this certificate.

serialNumber

protected ByteArrayAttribute serialNumber

The serial number attribute of this certificate. Notice that netscape needs the raw serial number, but PKCS#11 defines this attribute as DER encoded integer.

value

protected ByteArrayAttribute value

The value attribute of this certificate; i.e. BER-encoded certificate.

url

protected CharArrayAttribute url

This attribute gives the URL where the complete certificate can be obtained.

hashOfSubjectPublicKey

protected ByteArrayAttribute hashOfSubjectPublicKey

SHA-1 hash of the subject public key.

hashOfIssuerPublicKey

protected ByteArrayAttribute hashOfIssuerPublicKey

SHA-1 hash of the issuer public key.

javaMidpSecurityDomain

protected LongAttribute javaMidpSecurityDomain

Java MIDP security domain: 0 = unspecified (default value), 1 = manufacturer, 2 = operator, 3 = third party.

Constructor Detail

X509PublicKeyCertificate

public X509PublicKeyCertificate()

Default Constructor.

X509PublicKeyCertificate

protected X509PublicKeyCertificate(Session session,
                                   long objectHandle)
                            throws TokenException

Called by getInstance to create an instance of a PKCS#11 X.509 public key certificate.

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 Certificate class uses this method to create an instance of a PKCS#11 X.509 public key certificate.

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(X509PublicKeyCertificate 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 Certificate

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 Certificate

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 X.509 public key certificate.

Returns:

The subject attribute of this X.509 public key certificate.

getId

public ByteArrayAttribute getId()

Gets the ID attribute of this X.509 public key certificate.

Returns:

The ID attribute of this X.509 public key certificate.

getIssuer

public ByteArrayAttribute getIssuer()

Gets the issuer attribute of this X.509 public key certificate.

Returns:

The issuer attribute of this X.509 public key certificate.

getSerialNumber

public ByteArrayAttribute getSerialNumber()

Gets the serial number attribute of this X.509 public key certificate.

Returns:

The serial number attribute of this X.509 public key certificate.

getValue

public ByteArrayAttribute getValue()

Gets the value attribute of this X.509 public key certificate.

Returns:

The value attribute of this X.509 public key certificate.

getUrl

public CharArrayAttribute getUrl()

Get the URL attribute of this object.

Returns:

Contains the URL as a char array.

getHashOfSubjectPublicKey

public ByteArrayAttribute getHashOfSubjectPublicKey()

Gets the hash of subject public key attribute of this X.509 public key certificate.

Returns:

The hash of subject public key attribute of this X.509 public key certificate.

getHashOfIssuerPublicKey

public ByteArrayAttribute getHashOfIssuerPublicKey()

Gets the hash of issuer public key attribute of this X.509 public key certificate.

Returns:

The hash of issuer public key attribute of this X.509 public key certificate.

getJavaMidpSecurityDomain

public LongAttribute getJavaMidpSecurityDomain()

Gets the java midp security domain attribute of the PKCS#11 certificate.

Returns:

The java midp security domain category attribute.

hashCode

public int hashCode()

The overriding of this method should ensure that the objects of this class work correctly in a hashtable.

Overrides:

hashCode in class Certificate

Returns:

The hash code of this object.

readAttributes

public void readAttributes(Session session)
                    throws TokenException

Read the values of the attributes of this object from the token.

Overrides:

readAttributes in class Certificate

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 Certificate

Returns:

A string presentation of this object for debugging output.