open class PKCS8EncodedKeySpec : 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
  

Summary

Public constructors

Creates a new PKCS8EncodedKeySpec with the given encoded key.

PKCS8EncodedKeySpec(encodedKey: ByteArray!, algorithm: String!)

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

Public methods
open ByteArray!

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.

Inherited functions

From class EncodedKeySpec

String! getAlgorithm()

Returns the name of the algorithm of the encoded key.

Public constructors

PKCS8EncodedKeySpec

PKCS8EncodedKeySpec(encodedKey: ByteArray!)

Creates a new PKCS8EncodedKeySpec with the given encoded key.

Parameters
encodedKey ByteArray!: 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
java.lang.NullPointerException if encodedKey is null.

PKCS8EncodedKeySpec

PKCS8EncodedKeySpec(
    encodedKey: ByteArray!,
    algorithm: String!)

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 ByteArray!: 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
java.lang.IllegalArgumentException if algorithm is the empty string ""
java.lang.NullPointerException if encodedKey or algorithm is null.

Public methods

getEncoded

open fun getEncoded(): ByteArray!

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

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

getFormat

fun getFormat(): String!

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

Return
String! the string "PKCS#8".

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-02-13 UTC.