Top Description Constructors Methods
java.security.spec

public Class PKCS8EncodedKeySpec

extends EncodedKeySpec
Class Inheritance
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
Author
Jan Luehe
Since
1.2
See Also
java.security.Key, java.security.KeyFactory, KeySpec, EncodedKeySpec, X509EncodedKeySpec

Constructor Summary

AccessConstructor and Description
public
PKCS8EncodedKeySpec(byte[]
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.
encodedKey)

Creates a new PKCS8EncodedKeySpec with the given encoded key.

public
PKCS8EncodedKeySpec(byte[]
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.
encodedKey, String
the algorithm name of the encoded private key See the KeyFactory section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.
algorithm)

Creates a new PKCS8EncodedKeySpec with the given encoded key and algorithm.

Method Summary

Modifier and TypeMethod and Description
public byte[]

Returns:

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

Overrides java.security.spec.EncodedKeySpec.getEncoded.

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

public final String

Returns:

the string "PKCS#8".
getFormat()

Implements abstract java.security.spec.EncodedKeySpec.getFormat.

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

Inherited from java.security.spec.EncodedKeySpec:
cleargetAlgorithm

Constructor Detail

PKCS8EncodedKeySpecback to summary
public PKCS8EncodedKeySpec(byte[] encodedKey)

Creates a new PKCS8EncodedKeySpec with the given encoded key.

Parameters
encodedKey:byte[]

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.

Exceptions
NullPointerException:
if encodedKey is null.
PKCS8EncodedKeySpecback to summary
public PKCS8EncodedKeySpec(byte[] encodedKey, String algorithm)

Creates a new PKCS8EncodedKeySpec with the given encoded key and algorithm. This constructor is useful when subsequent callers of the PKCS8EncodedKeySpec object might not know the algorithm of the private key.

Parameters
encodedKey:byte[]

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.

algorithm:String

the algorithm name of the encoded private key See the KeyFactory section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.

Exceptions
NullPointerException:
if encodedKey or algorithm is null.
IllegalArgumentException:
if algorithm is the empty string ""
Since
9

Method Detail

getEncodedback to summary
public byte[] getEncoded()

Overrides java.security.spec.EncodedKeySpec.getEncoded.

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

Returns:byte[]

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

getFormatback to summary
public final String getFormat()

Implements abstract java.security.spec.EncodedKeySpec.getFormat.

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

Returns:String

the string "PKCS#8".