PKCS8EncodedKeySpec (Java 2 Platform SE 5.0) (original) (raw)

java.security.spec

Class PKCS8EncodedKeySpec

java.lang.Object extended by java.security.spec.EncodedKeySpec java.security.spec.PKCS8EncodedKeySpec

All Implemented Interfaces:

public class PKCS8EncodedKeySpec

This class represents the ASN.1 encoding of a private key, encoded according to the ASN.1 type PrivateKeyInfo. The PrivateKeyInfo syntax is defined in the PKCS#8 standard as follows:

PrivateKeyInfo ::= SEQUENCE { version Version, privateKeyAlgorithm PrivateKeyAlgorithmIdentifier, privateKey PrivateKey, attributes [0] IMPLICIT Attributes OPTIONAL }

Version ::= INTEGER

PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier

PrivateKey ::= OCTET STRING

Attributes ::= SET OF Attribute

Since:

1.2

Constructor Summary
PKCS8EncodedKeySpec(byte[] encodedKey) Creates a new PKCS8EncodedKeySpec with the given encoded key.

Method Summary
byte[]	getEncoded() Returns the key bytes, encoded according to the PKCS #8 standard.
String	getFormat() Returns the name of the encoding format associated with this key specification.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

PKCS8EncodedKeySpec

public PKCS8EncodedKeySpec(byte[] encodedKey)

Creates a new PKCS8EncodedKeySpec with the given encoded key.

Parameters:

encodedKey - the key, which is assumed to be encoded according to the PKCS #8 standard. The contents of the array are copied to protect against subsequent modification.

Method Detail

getEncoded

public byte[] getEncoded()

Returns the key bytes, encoded according to the PKCS #8 standard.

Overrides:

[getEncoded](../../../java/security/spec/EncodedKeySpec.html#getEncoded%28%29) in class [EncodedKeySpec](../../../java/security/spec/EncodedKeySpec.html "class in java.security.spec")

Returns:

the PKCS #8 encoding of the key. Returns a new array each time this method is called.

getFormat

public final String getFormat()

Returns the name of the encoding format associated with this key specification.

Specified by:

[getFormat](../../../java/security/spec/EncodedKeySpec.html#getFormat%28%29) in class [EncodedKeySpec](../../../java/security/spec/EncodedKeySpec.html "class in java.security.spec")

Returns:

the string "PKCS#8".

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.