sun.security.x509

Class KeyUsageExtension

java.lang.Object

sun.security.x509.Extension

sun.security.x509.KeyUsageExtension

All Implemented Interfaces:

CertAttrSet<java.lang.String>

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

Represent the Key Usage Extension.

This extension, if present, defines the purpose (e.g., encipherment, signature, certificate signing) of the key contained in the certificate. The usage restriction might be employed when a multipurpose key is to be restricted (e.g., when an RSA key should be used only for signing or only for key encipherment).

Author:

Amit Kapoor, Hemma Prafullchandra

See Also:

Extension, CertAttrSet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CRL_SIGN
static java.lang.String	DATA_ENCIPHERMENT
static java.lang.String	DECIPHER_ONLY
static java.lang.String	DIGITAL_SIGNATURE
static java.lang.String	ENCIPHER_ONLY
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	KEY_AGREEMENT
static java.lang.String	KEY_CERTSIGN
static java.lang.String	KEY_ENCIPHERMENT
static java.lang.String	NAME Attribute names.
static java.lang.String	NON_REPUDIATION

Fields inherited from class sun.security.x509.Extension

critical, extensionId, extensionValue

Constructor Summary

Constructors

Constructor and Description
KeyUsageExtension() Create a default key usage.
KeyUsageExtension(BitArray bitString) Create a KeyUsageExtension with the passed bit settings.
KeyUsageExtension(boolean[] bitString) Create a KeyUsageExtension with the passed bit settings.
KeyUsageExtension(java.lang.Boolean critical, java.lang.Object value) Create the extension from the passed DER encoded value of the same.
KeyUsageExtension(byte[] bitString) Create a KeyUsageExtension with the passed bit settings.

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.
boolean[]	getBits()
java.util.Enumeration<java.lang.String>	getElements() Return an enumeration of names of attributes existing within this attribute.
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() Returns a printable representation of the KeyUsage.

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

DIGITAL_SIGNATURE

public static final java.lang.String DIGITAL_SIGNATURE

See Also:

Constant Field Values

NON_REPUDIATION

public static final java.lang.String NON_REPUDIATION

See Also:

Constant Field Values

KEY_ENCIPHERMENT

public static final java.lang.String KEY_ENCIPHERMENT

See Also:

Constant Field Values

DATA_ENCIPHERMENT

public static final java.lang.String DATA_ENCIPHERMENT

See Also:

Constant Field Values

KEY_AGREEMENT

public static final java.lang.String KEY_AGREEMENT

See Also:

Constant Field Values

KEY_CERTSIGN

public static final java.lang.String KEY_CERTSIGN

See Also:

Constant Field Values

CRL_SIGN

public static final java.lang.String CRL_SIGN

See Also:

Constant Field Values

ENCIPHER_ONLY

public static final java.lang.String ENCIPHER_ONLY

See Also:

Constant Field Values

DECIPHER_ONLY

public static final java.lang.String DECIPHER_ONLY

See Also:

Constant Field Values

Constructor Detail

KeyUsageExtension

public KeyUsageExtension(byte[] bitString)
                  throws java.io.IOException

Create a KeyUsageExtension with the passed bit settings. The criticality is set to true.

Parameters:

bitString - the bits to be set for the extension.

Throws:

java.io.IOException

KeyUsageExtension

public KeyUsageExtension(boolean[] bitString)
                  throws java.io.IOException

Create a KeyUsageExtension with the passed bit settings. The criticality is set to true.

Parameters:

bitString - the bits to be set for the extension.

Throws:

java.io.IOException

KeyUsageExtension

public KeyUsageExtension(BitArray bitString)
                  throws java.io.IOException

Create a KeyUsageExtension with the passed bit settings. The criticality is set to true.

Parameters:

bitString - the bits to be set for the extension.

Throws:

java.io.IOException

KeyUsageExtension

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

Create the extension from the passed DER encoded value of the same. The DER encoded value may be wrapped in an OCTET STRING.

Parameters:

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

value - an array of DER encoded bytes of the actual value (possibly wrapped in an OCTET STRING).

Throws:

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

java.io.IOException - on error.

KeyUsageExtension

public KeyUsageExtension()

Create a default key usage.

Method Detail

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.

toString

public java.lang.String toString()

Returns a printable representation of the KeyUsage.

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.

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.

getBits

public boolean[] getBits()

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.