Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#pubctors) \| [Methods](https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#inhmethods)

# PKCS8EncodedKeySpec

` public class PKCS8EncodedKeySpec `   
` ` ` extends https://developer.android.com/reference/java/security/spec/EncodedKeySpec ` ` `

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [java.security.spec.EncodedKeySpec](https://developer.android.com/reference/java/security/spec/EncodedKeySpec) ||
|   | ↳ | java.security.spec.PKCS8EncodedKeySpec |

<br />

*** ** * ** ***

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
```

<br />

**See also:**

- `https://developer.android.com/reference/java/security/Key`
- `https://developer.android.com/reference/java/security/KeyFactory`
- `https://developer.android.com/reference/java/security/spec/KeySpec`
- `https://developer.android.com/reference/java/security/spec/EncodedKeySpec`
- `https://developer.android.com/reference/java/security/spec/X509EncodedKeySpec`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#PKCS8EncodedKeySpec(byte[])(byte[] encodedKey) ` Creates a new `PKCS8EncodedKeySpec` with the given encoded key. |
| ` https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#PKCS8EncodedKeySpec(byte[],%20java.lang.String)(byte[] encodedKey, https://developer.android.com/reference/java/lang/String algorithm) ` Creates a new `PKCS8EncodedKeySpec` with the given encoded key and algorithm. |

| ### Public methods ||
|---|---|
| ` byte[]` | ` https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#getEncoded()() ` Returns the key bytes, encoded according to the PKCS #8 standard. |
| ` final https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/security/spec/PKCS8EncodedKeySpec#getFormat()() ` Returns the name of the encoding format associated with this key specification. |

### Inherited methods

From class ` https://developer.android.com/reference/java/security/spec/EncodedKeySpec ` ` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/security/spec/EncodedKeySpec#getAlgorithm()() `

Returns the name of the algorithm of the encoded key.
` byte[]` ` https://developer.android.com/reference/java/security/spec/EncodedKeySpec#getEncoded()() `

Returns the encoded key.
` abstract https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/security/spec/EncodedKeySpec#getFormat()() `

Returns the name of the encoding format associated with this key specification.
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public constructors

### PKCS8EncodedKeySpec

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PKCS8EncodedKeySpec (byte[] encodedKey)
```

Creates a new `PKCS8EncodedKeySpec` with the given encoded key.

<br />

| 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. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `encodedKey` is null. |

### PKCS8EncodedKeySpec

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| 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. <br /> |
| `algorithm` | `String`: the algorithm name of the encoded private key See the KeyFactory section in the [Java Security Standard Algorithm Names Specification](https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#keyfactory-algorithms) for information about standard algorithm names. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `algorithm` is the empty string `""` |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `encodedKey` or `algorithm` is null. |

## Public methods

### getEncoded

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getEncoded ()
```

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

<br />

| Returns ||
|---|---|
| `byte[]` | the PKCS #8 encoding of the key. Returns a new array each time this method is called. <br /> |

### getFormat

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final String getFormat ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the string `"PKCS#8"`. <br /> |