PKCS8EncodedKeySpec

AI-generated Key Takeaways

• PKCS8EncodedKeySpec represents the ASN.1 encoding of a private key, based on the PKCS#8 standard's PrivateKeyInfo structure.

• It provides access to the encoded key bytes and the encoding format, which is "PKCS#8".

• This class is used in conjunction with KeyFactory to convert the encoded key into a usable private key object.

• A new PKCS8EncodedKeySpec is created using the encoded private key bytes, which are copied to ensure immutability.

public class PKCS8EncodedKeySpec extends EncodedKeySpec

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
 

See Also

• Key
• KeyFactory
• KeySpec
• EncodedKeySpec
• X509EncodedKeySpec

Public Constructor Summary

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

Public Method Summary

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

Inherited Method Summary

From class java.security.spec.EncodedKeySpec

byte[]	getEncoded() Returns the encoded key.
abstract String	getFormat() Returns the name of the encoding format associated with this key specification.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

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.

Throws

NullPointerException	if encodedKey is null.

Public Methods

public byte[] getEncoded ()

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

Returns

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

public final String getFormat ()

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

Returns

• the string "PKCS#8".