# WrappedKeyEntry

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

# WrappedKeyEntry

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/security/keystore/WrappedKeyEntry "View this page in Kotlin")\|Java

`
public


class
WrappedKeyEntry
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[KeyStore.Entry](https://developer.android.com/reference/java/security/KeyStore.Entry)`


`

|---|-------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.security.keystore.WrappedKeyEntry |

<br />

*** ** * ** ***

An[Entry](https://developer.android.com/reference/java/security/KeyStore.Entry)that holds a wrapped key. Wrapped keys contain encrypted key data and description information that can be used to securely import key material into a hardware-backed Keystore.

The wrapped key is in DER-encoded ASN.1 format, specified by the following schema:  

```
     KeyDescription ::= SEQUENCE(
         keyFormat INTEGER,                   # Values from KeyFormat enum.
         keyParams AuthorizationList,
     )

     SecureKeyWrapper ::= SEQUENCE(
         version INTEGER,                     # Contains value 0
         encryptedTransportKey OCTET_STRING,
         initializationVector OCTET_STRING,
         keyDescription KeyDescription,
         encryptedKey OCTET_STRING,
         tag OCTET_STRING
     )
 
```

- keyFormat is an integer from the KeyFormat enum, defining the format of the plaintext key material.
- keyParams is the characteristics of the key to be imported (as with generateKey or importKey). If the secure import is successful, these characteristics must be associated with the key exactly as if the key material had been insecurely imported with importKey. See[Key Attestation](https://developer.android.com/training/articles/security-key-attestation.html#certificate_schema)for the AuthorizationList format.
- encryptedTransportKey is a 256-bit AES key, XORed with a masking key and then encrypted in RSA-OAEP mode (SHA-256 digest, SHA-1 MGF1 digest) with the wrapping key specified by wrappingKeyBlob.
- keyDescription is a KeyDescription, above.
- encryptedKey is the key material of the key to be imported, in format keyFormat, and encrypted with encryptedEphemeralKey in AES-GCM mode, with the DER-encoded representation of keyDescription provided as additional authenticated data.
- tag is the tag produced by the AES-GCM encryption of encryptedKey.

Imported wrapped keys will have KeymasterDefs.KM_ORIGIN_SECURELY_IMPORTED

<br />

## Summary

|                                                                                                                                                                                                                                                                                                                                             ### Public constructors                                                                                                                                                                                                                                                                                                                                             ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[WrappedKeyEntry](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry#WrappedKeyEntry(byte[],%20java.lang.String,%20java.lang.String,%20java.security.spec.AlgorithmParameterSpec))`(byte[] wrappedKeyBytes, `[String](https://developer.android.com/reference/java/lang/String)` wrappingKeyAlias, `[String](https://developer.android.com/reference/java/lang/String)` transformation, `[AlgorithmParameterSpec](https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec)` algorithmParameterSpec) ` Constructs a[WrappedKeyEntry](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry)with a binary wrapped key. |

|                                                                                                                         ### Public methods                                                                                                                         ||
|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[AlgorithmParameterSpec](https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec) | ` `[getAlgorithmParameterSpec](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry#getAlgorithmParameterSpec())`() ` |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                          | ` `[getTransformation](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry#getTransformation())`() `                 |
| ` byte[]`                                                                                                      | ` `[getWrappedKeyBytes](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry#getWrappedKeyBytes())`() `               |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                          | ` `[getWrappingKeyAlias](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry#getWrappingKeyAlias())`() `             |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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*.                                                                                             | ||
| From interface` `[java.security.KeyStore.Entry](https://developer.android.com/reference/java/security/KeyStore.Entry)` ` |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` default `[Set](https://developer.android.com/reference/java/util/Set)`<`[KeyStore.Entry.Attribute](https://developer.android.com/reference/java/security/KeyStore.Entry.Attribute)`>` | ` `[getAttributes](https://developer.android.com/reference/java/security/KeyStore.Entry#getAttributes())`() ` Retrieves the attributes associated with an entry. | ||

## Public constructors

### WrappedKeyEntry

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

```
public WrappedKeyEntry (byte[] wrappedKeyBytes, 
                String wrappingKeyAlias, 
                String transformation, 
                AlgorithmParameterSpec algorithmParameterSpec)
```

Constructs a[WrappedKeyEntry](https://developer.android.com/reference/android/security/keystore/WrappedKeyEntry)with a binary wrapped key.

<br />

|                                                     Parameters                                                     ||
|--------------------------|------------------------------------------------------------------------------------------|
| `wrappedKeyBytes`        | `byte`: ASN.1 DER encoded wrapped key <br />                                             |
| `wrappingKeyAlias`       | `String`: identifies the private key that can unwrap the wrapped key <br />              |
| `transformation`         | `String`: used to unwrap the key. ex: "RSA/ECB/OAEPPadding" <br />                       |
| `algorithmParameterSpec` | `AlgorithmParameterSpec`: spec for the private key used to unwrap the wrapped key <br /> |

## Public methods

### getAlgorithmParameterSpec

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

```
public AlgorithmParameterSpec getAlgorithmParameterSpec ()
```

<br />

<br />

|                                                       Returns                                                       ||
|-------------------------------------------------------------------------------------------------------------|--------|
| [AlgorithmParameterSpec](https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec) | <br /> |

### getTransformation

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

```
public String getTransformation ()
```

<br />

<br />

|                                  Returns                                   ||
|--------------------------------------------------------------------|--------|
| [String](https://developer.android.com/reference/java/lang/String) | <br /> |

### getWrappedKeyBytes

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

```
public byte[] getWrappedKeyBytes ()
```

<br />

<br />

|     Returns      ||
|----------|--------|
| `byte[]` | <br /> |

### getWrappingKeyAlias

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

```
public String getWrappingKeyAlias ()
```

<br />

<br />

|                                  Returns                                   ||
|--------------------------------------------------------------------|--------|
| [String](https://developer.android.com/reference/java/lang/String) | <br /> |