com.entrust.toolkit.x509.extensions

Class KeyAttributes

java.lang.Object

iaik.x509.V3Extension

com.entrust.toolkit.x509.extensions.KeyAttributes

public class KeyAttributes
extends V3Extension

This class implements the KeyAttributes Extension.

The KeyAttributes extension is obsolete, and has been replaced by the SubjectKeyIdentifier, KeyUsage, and PrivateKeyUsagePeriod extensions. It is provided here for backward compatibility with older certificates only.

The KeyAttributes OID is "2.5.29.2".

The ASN.1 definition of the KeyAttributes extension is specified as follows:

 KeyAttributes ::= SEQUENCE {
     subjectKeyIdentifier    SubjectKeyIdentifier          OPTIONAL,
     keyUsage                KeyUsage                              OPTIONAL,
     privateKeyUsagePeriod   PrivateKeyUsagePeriod   OPTIONAL }
 

If the keyIdentifier field is present it identifies the key in this certificate. See the SubjectKeyIdentifier documentation for details.

If the keyUsage field is present it identifies the key usage for the key in this certificate. See the KeyUsage documentation for details.

If the privateKeyUsagePeriod field is present it identifies the validity period for the corresponding private key. See the PrivateKeyUsagePeriod documentation for details.

This class provides several methods for getting (but not setting) the component values of an KeyAttributes extension object.

See Also:

V3Extension, X509Certificate, SubjectKeyIdentifier, KeyUsage, PrivateKeyUsagePeriod

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectID	oid

Fields inherited from class iaik.x509.V3Extension

critical

Constructor Summary

Constructors

Constructor and Description
KeyAttributes() Default constructor.

Method Summary

Modifier and Type	Method and Description
KeyUsage	getKeyUsage() Returns the keyUsage value of this KeyAttributes extension identifying the possible uses for the key contained in this certificate.
ObjectID	getObjectID() Returns the object ID of this KeyAttributes extension
PrivateKeyUsagePeriod	getPrivateKeyUsagePeriod() Returns the privateKeyUsagePeriod value of this KeyAttributes extension identifying validity date range of the corresponding private key.
SubjectKeyIdentifier	getSubjectKeyIdentifier() Returns the subjectKeyIdentifier value of this KeyAttributes extension identifying the public key contained in this certificate.
int	hashCode() Returns a hashcode for this identity.
void	init(ASN1Object attr) Inits this KeyAttributes implementation with an ASN1Object representing the value of this extension.
ASN1Object	toASN1Object() Stub function to meet V3Extension criteria.
java.lang.String	toString() Returns a string that represents the contents of this KeyAttributes extension.

Methods inherited from class iaik.x509.V3Extension

getName, isCritical, setCritical

Methods inherited from class java.lang.Object

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

Field Detail

oid

public static final ObjectID oid

Constructor Detail

KeyAttributes

public KeyAttributes()

Default constructor.

The KeyAttributes extension is obsolete and has been replaced by the SubjectKeyIdentifier, KeyUsage, and PrivateKeyUsagePeriod extensions.

Generating a new KeyAttributes extension is not supported. This class is provided for backward compatibility with existing certificates only.

Method Detail

getObjectID

public ObjectID getObjectID()

Returns the object ID of this KeyAttributes extension

Specified by:

getObjectID in class V3Extension

Returns:

the object ID

init

public void init(ASN1Object attr)
          throws X509ExtensionException

Inits this KeyAttributes implementation with an ASN1Object representing the value of this extension.

The ASN1Object is the extensionValue from ASN.1 type "Extension" representing the (optional) keyIdentifier, (optional) keyUsage, and the (optional) privateKeyUsagePeriod values of this extension.

Specified by:

init in class V3Extension

Parameters:

attr - the extensionValue as an ASN1Object

Throws:

X509ExtensionException - if the extension could not be parsed

toASN1Object

public ASN1Object toASN1Object()

Stub function to meet V3Extension criteria. Returns null.

Specified by:

toASN1Object in class V3Extension

Returns:

the value of the extension as ASN1Object

getSubjectKeyIdentifier

public SubjectKeyIdentifier getSubjectKeyIdentifier()

Returns the subjectKeyIdentifier value of this KeyAttributes extension identifying the public key contained in this certificate.

The subjectKeyIdentifier is returned as a SubjectKeyIdentifier object. Please refer to the SubjectKeyIdentifier description for structure details.

Returns:

the subjectKeyIdentifier value.

getKeyUsage

public KeyUsage getKeyUsage()

Returns the keyUsage value of this KeyAttributes extension identifying the possible uses for the key contained in this certificate.

The keyUsage is returned as a KeyUsage object. Please refer to the KeyUsage description for structure details.

Returns:

the keyUsage value.

getPrivateKeyUsagePeriod

public PrivateKeyUsagePeriod getPrivateKeyUsagePeriod()

Returns the privateKeyUsagePeriod value of this KeyAttributes extension identifying validity date range of the corresponding private key.

The privateKeyUsagePeriod is returned as a PrivateKeyUsagePeriod object. Please refer to the PrivateKeyUsagePeriod description for structure details.

Returns:

the privateKeyUsagePeriod value.

hashCode

public int hashCode()

Returns a hashcode for this identity.

Specified by:

hashCode in class V3Extension

Returns:

a hash code for this identity

toString

public java.lang.String toString()

Returns a string that represents the contents of this KeyAttributes extension.

Overrides:

toString in class java.lang.Object

Returns:

the string representation