OpenJDK 27 · sun.security.x509.KeyUsageExtension · APIdia, the JavaDoc alternative

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

Field Summary

Modifier and Type	Field and Description
private boolean[]	bitString
public static final String	CRL_SIGN
public static final String	DATA_ENCIPHERMENT
public static final String	DECIPHER_ONLY
public static final String	DIGITAL_SIGNATURE
public static final String	ENCIPHER_ONLY
public static final String	KEY_AGREEMENT
public static final String	KEY_CERTSIGN
public static final String	KEY_ENCIPHERMENT
public static final String	NAME
public static final String	NON_REPUDIATION

Inherited from sun.security.x509.Extension:: critical extensionId extensionValue

Constructor Summary

Access	Constructor and Description
public	KeyUsageExtension(byte[] the bits to be set for the extension. bitString) Create a KeyUsageExtension with the passed bit settings.
public	KeyUsageExtension(boolean[] the bits to be set for the extension. bitString) Create a KeyUsageExtension with the passed bit settings.
public	KeyUsageExtension(BitArray the bits to be set for the extension. bitString) Create a KeyUsageExtension with the passed bit settings.
public	KeyUsageExtension(Boolean true if the extension is to be treated as critical. critical, Object an array of DER encoded bytes of the actual value (possibly wrapped in an OCTET STRING). value) Create the extension from the passed DER encoded value of the same.
public	KeyUsageExtension() Create a default key usage.

Method Summary

Modifier and Type	Method and Description
public void	encode(DerOutputStream the DerOutputStream to write the extension to. out) Overrides sun.security.x509.Extension.encode. Implements sun.security.util.DerEncoder.encode. Write the extension to the DerOutputStream.
private void	encodeThis()
public boolean	get(String name) Get the attribute value.
public boolean[]	getBits()
public String	getName() Overrides sun.security.x509.Extension.getName. Return the name of this extension.
private boolean	isSet(int the position in the bit string to check. position) Check if bit is set.
private void	set(int position, boolean val) Set the bit at the specified position.
public void	set(String name, boolean val) Set the attribute value.
public String	toString() Overrides sun.security.x509.Extension.toString. Returns a printable representation of the KeyUsage.

Inherited from sun.security.x509.Extension:: encode equals getExtensionId getExtensionValue getId getValue hashCode isCritical newExtension

Field Detail

bitString	back to summary
private boolean[] bitString

CRL_SIGN	back to summary
public static final String CRL_SIGN

DATA_ENCIPHERMENT	back to summary
public static final String DATA_ENCIPHERMENT

DECIPHER_ONLY	back to summary
public static final String DECIPHER_ONLY

DIGITAL_SIGNATURE	back to summary
public static final String DIGITAL_SIGNATURE

ENCIPHER_ONLY	back to summary
public static final String ENCIPHER_ONLY

KEY_AGREEMENT	back to summary
public static final String KEY_AGREEMENT

KEY_CERTSIGN	back to summary
public static final String KEY_CERTSIGN

KEY_ENCIPHERMENT	back to summary
public static final String KEY_ENCIPHERMENT

NAME	back to summary
public static final String NAME

NON_REPUDIATION	back to summary
public static final String NON_REPUDIATION

Constructor Detail

KeyUsageExtension	back to summary
public KeyUsageExtension(byte[] bitString) Create a KeyUsageExtension with the passed bit settings. The criticality is set to true. Parameters bitString:byte[] the bits to be set for the extension.

KeyUsageExtension

back to summary

public KeyUsageExtension(byte[] bitString)

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

Parameters

bitString:byte[]: the bits to be set for the extension.

KeyUsageExtension	back to summary
public KeyUsageExtension(boolean[] bitString) Create a KeyUsageExtension with the passed bit settings. The criticality is set to true. Parameters bitString:boolean[] the bits to be set for the extension.

KeyUsageExtension

back to summary

public KeyUsageExtension(boolean[] bitString)

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

Parameters

bitString:boolean[]: the bits to be set for the extension.

KeyUsageExtension	back to summary
public KeyUsageExtension(BitArray bitString) Create a KeyUsageExtension with the passed bit settings. The criticality is set to true. Parameters bitString:BitArray the bits to be set for the extension.

KeyUsageExtension

back to summary

public KeyUsageExtension(BitArray bitString)

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

Parameters

bitString:BitArray: the bits to be set for the extension.

KeyUsageExtension	back to summary
public KeyUsageExtension(Boolean critical, Object value) throws 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:Boolean true if the extension is to be treated as critical. value:Object an array of DER encoded bytes of the actual value (possibly wrapped in an OCTET STRING). Exceptions IOException: on error. ClassCastException: if value is not an array of bytes

KeyUsageExtension

back to summary

public KeyUsageExtension(Boolean critical, Object value) throws 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:Boolean: true if the extension is to be treated as critical.
value:Object: an array of DER encoded bytes of the actual value (possibly wrapped in an OCTET STRING).

Exceptions

IOException:: on error.
ClassCastException:: if value is not an array of bytes

KeyUsageExtension	back to summary
public KeyUsageExtension() Create a default key usage.

Method Detail

encode	back to summary
public void encode(DerOutputStream out) Overrides sun.security.x509.Extension.encode. Implements sun.security.util.DerEncoder.encode. Write the extension to the DerOutputStream. Parameters out:DerOutputStream the DerOutputStream to write the extension to. Annotations @Override

encode

back to summary

public void encode(DerOutputStream out)

Overrides sun.security.x509.Extension.encode.

Implements sun.security.util.DerEncoder.encode.

Write the extension to the DerOutputStream.

Parameters

out:DerOutputStream: the DerOutputStream to write the extension to.

Annotations

@Override

encodeThis	back to summary
private void encodeThis()

get	back to summary
public boolean get(String name) throws IOException Get the attribute value.

getBits	back to summary
public boolean[] getBits()

getName	back to summary
public String getName() Overrides sun.security.x509.Extension.getName. Return the name of this extension. Annotations @Override

getName

back to summary

public String getName()

Overrides sun.security.x509.Extension.getName.

Return the name of this extension.

Annotations

@Override

isSet	back to summary
private boolean isSet(int position) Check if bit is set. Parameters position:int the position in the bit string to check.

isSet

back to summary

private boolean isSet(int position)

Check if bit is set.

Parameters

position:int: the position in the bit string to check.

set	back to summary
private void set(int position, boolean val) Set the bit at the specified position.

set	back to summary
public void set(String name, boolean val) throws IOException Set the attribute value.

toString	back to summary
public String toString() Overrides sun.security.x509.Extension.toString. Returns a printable representation of the KeyUsage.

toString

back to summary

public String toString()

Overrides sun.security.x509.Extension.toString.

Returns a printable representation of the KeyUsage.

public Class KeyUsageExtension

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail