sun.security.x509

Class ExtendedKeyUsageExtension

java.lang.Object

sun.security.x509.Extension

sun.security.x509.ExtendedKeyUsageExtension

All Implemented Interfaces:

CertAttrSet<java.lang.String>

public class ExtendedKeyUsageExtension
extends Extension
implements CertAttrSet<java.lang.String>

This class defines the Extended Key Usage Extension, which indicates one or more purposes for which the certified public key may be used, in addition to or in place of the basic purposes indicated in the key usage extension field. This field is defined as follows:

id-ce-extKeyUsage OBJECT IDENTIFIER ::= {id-ce 37}

ExtKeyUsageSyntax ::= SEQUENCE SIZE (1..MAX) OF KeyPurposeId

KeyPurposeId ::= OBJECT IDENTIFIER

Key purposes may be defined by any organization with a need. Object identifiers used to identify key purposes shall be assigned in accordance with IANA or ITU-T Rec. X.660 | ISO/IEC/ITU 9834-1.

This extension may, at the option of the certificate issuer, be either critical or non-critical.

If the extension is flagged critical, then the certificate MUST be used only for one of the purposes indicated.

If the extension is flagged non-critical, then it indicates the intended purpose or purposes of the key, and may be used in finding the correct key/certificate of an entity that has multiple keys/certificates. It is an advisory field and does not imply that usage of the key is restricted by the certification authority to the purpose indicated. Certificate using applications may nevertheless require that a particular purpose be indicated in order for the certificate to be acceptable to that application.

If a certificate contains both a critical key usage field and a critical extended key usage field, then both fields MUST be processed independently and the certificate MUST only be used for a purpose consistent with both fields. If there is no purpose consistent with both fields, then the certificate MUST NOT be used for any purpose.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDENT Identifier for this attribute, to be used with the get, set, delete methods of Certificate, x509 type.
static java.lang.String	NAME Attribute names.
static java.lang.String	USAGES

Fields inherited from class sun.security.x509.Extension

critical, extensionId, extensionValue

Constructor Summary

Constructors

Constructor and Description
ExtendedKeyUsageExtension(java.lang.Boolean critical, java.lang.Object value) Create the extension from its DER encoded value and criticality.
ExtendedKeyUsageExtension(java.lang.Boolean critical, java.util.Vector<ObjectIdentifier> keyUsages) Create a ExtendedKeyUsageExtension object from a Vector of KeyUsages with specified criticality.
ExtendedKeyUsageExtension(java.util.Vector<ObjectIdentifier> keyUsages) Create a ExtendedKeyUsageExtension object from a Vector of Key Usages; the criticality is set to false.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(java.lang.String name) Delete the attribute value.
void	encode(java.io.OutputStream out) Write the extension to the DerOutputStream.
java.lang.Object	get(java.lang.String name) Get the attribute value.
java.util.Enumeration<java.lang.String>	getElements() Return an enumeration of names of attributes existing within this attribute.
java.util.List<java.lang.String>	getExtendedKeyUsage()
java.lang.String	getName() Return the name of this attribute.
void	set(java.lang.String name, java.lang.Object obj) Set the attribute value.
java.lang.String	toString() Return the extension as user readable string.

Methods inherited from class sun.security.x509.Extension

encode, equals, getExtensionId, getExtensionValue, hashCode, isCritical

Methods inherited from class java.lang.Object

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

Field Detail

IDENT

public static final java.lang.String IDENT

Identifier for this attribute, to be used with the get, set, delete methods of Certificate, x509 type.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Attribute names.

See Also:

Constant Field Values

USAGES

public static final java.lang.String USAGES

See Also:

Constant Field Values

Constructor Detail

ExtendedKeyUsageExtension

public ExtendedKeyUsageExtension(java.util.Vector<ObjectIdentifier> keyUsages)
                          throws java.io.IOException

Create a ExtendedKeyUsageExtension object from a Vector of Key Usages; the criticality is set to false.

Parameters:

keyUsages - the Vector of KeyUsages (ObjectIdentifiers)

Throws:

java.io.IOException

ExtendedKeyUsageExtension

public ExtendedKeyUsageExtension(java.lang.Boolean critical,
                         java.util.Vector<ObjectIdentifier> keyUsages)
                          throws java.io.IOException

Create a ExtendedKeyUsageExtension object from a Vector of KeyUsages with specified criticality.

Parameters:

critical - true if the extension is to be treated as critical.

keyUsages - the Vector of KeyUsages (ObjectIdentifiers)

Throws:

java.io.IOException

ExtendedKeyUsageExtension

public ExtendedKeyUsageExtension(java.lang.Boolean critical,
                         java.lang.Object value)
                          throws java.io.IOException

Create the extension from its DER encoded value and criticality.

Parameters:

critical - true if the extension is to be treated as critical.

value - an array of DER encoded bytes of the actual value.

Throws:

java.lang.ClassCastException - if value is not an array of bytes

java.io.IOException - on error.

Method Detail

toString

public java.lang.String toString()

Return the extension as user readable string.

Specified by:

toString in interface CertAttrSet<java.lang.String>

Overrides:

toString in class Extension

Returns:

value of this certificate attribute in printable form.

encode

public void encode(java.io.OutputStream out)
            throws java.io.IOException

Write the extension to the DerOutputStream.

Specified by:

encode in interface CertAttrSet<java.lang.String>

Parameters:

out - the DerOutputStream to write the extension to.

Throws:

java.io.IOException - on encoding errors.

set

public void set(java.lang.String name,
       java.lang.Object obj)
         throws java.io.IOException

Set the attribute value.

Specified by:

set in interface CertAttrSet<java.lang.String>

Parameters:

name - the name of the attribute (e.g. "x509.info.key")

obj - the attribute object.

Throws:

java.io.IOException - on other errors.

get

public java.lang.Object get(java.lang.String name)
                     throws java.io.IOException

Get the attribute value.

Specified by:

get in interface CertAttrSet<java.lang.String>

Parameters:

name - the name of the attribute to return.

Throws:

java.io.IOException - on other errors.

delete

public void delete(java.lang.String name)
            throws java.io.IOException

Delete the attribute value.

Specified by:

delete in interface CertAttrSet<java.lang.String>

Parameters:

name - the name of the attribute to delete.

Throws:

java.io.IOException - on other errors.

getElements

public java.util.Enumeration<java.lang.String> getElements()

Return an enumeration of names of attributes existing within this attribute.

Specified by:

getElements in interface CertAttrSet<java.lang.String>

Returns:

an enumeration of the attribute names.

getName

public java.lang.String getName()

Return the name of this attribute.

Specified by:

getName in interface CertAttrSet<java.lang.String>

Returns:

the name of this CertAttrSet.

getExtendedKeyUsage

public java.util.List<java.lang.String> getExtendedKeyUsage()