WrappedKeyEntry Class

Reference

Definition

Namespace:: Android.Security.Keystore

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An Entry that holds a wrapped key.

[Android.Runtime.Register("android/security/keystore/WrappedKeyEntry", ApiSince=28, DoNotGenerateAcw=true)]
public class WrappedKeyEntry : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Security.KeyStore.IEntry

[<Android.Runtime.Register("android/security/keystore/WrappedKeyEntry", ApiSince=28, DoNotGenerateAcw=true)>]
type WrappedKeyEntry = class
    inherit Object
    interface KeyStore.IEntry
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

Object
WrappedKeyEntry

Attributes: RegisterAttribute

Implements: IJavaObject IJavaPeerable KeyStore.IEntry IDisposable

Remarks

An 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
                )

<ul> <li>keyFormat is an integer from the KeyFormat enum, defining the format of the plaintext key material. </li> <li>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 for the AuthorizationList format. </li> <li>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. </li> <li>keyDescription is a KeyDescription, above. </li> <li>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. </li> <li>tag is the tag produced by the AES-GCM encryption of encryptedKey. </li> </ul>

Imported wrapped keys will have KeymasterDefs.KM_ORIGIN_SECURELY_IMPORTED

Java documentation for android.security.keystore.WrappedKeyEntry.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

WrappedKeyEntry(Byte[], String, String, IAlgorithmParameterSpec)	Constructs a `WrappedKeyEntry` with a binary wrapped key.
WrappedKeyEntry(IntPtr, JniHandleOwnership)

Properties

AlgorithmParameterSpec
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass
ThresholdType
Transformation
WrappingKeyAlias

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetWrappedKeyBytes()
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to