KeyChain Class

Reference

Definition

Namespace:: Android.Security

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.

The KeyChain class provides access to private keys and their corresponding certificate chains in credential storage.

[Android.Runtime.Register("android/security/KeyChain", DoNotGenerateAcw=true)]
public sealed class KeyChain : Java.Lang.Object

[<Android.Runtime.Register("android/security/KeyChain", DoNotGenerateAcw=true)>]
type KeyChain = class
    inherit Object

Inheritance: Object

Object
KeyChain

Attributes: RegisterAttribute

Remarks

Java documentation for android.security.KeyChain.

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

KeyChain()

Fields

ActionKeyAccessChanged	Broadcast Action: Indicates that the access permissions for a private key have changed.
ActionKeychainChanged	Broadcast Action: Indicates the contents of the keychain has changed.
ActionStorageChanged	Obsolete. Broadcast Action: Indicates the trusted storage has changed.
ActionTrustStoreChanged	Broadcast Action: Indicates the contents of the trusted certificate store has changed.
ExtraCertificate	Optional extra to specify an X.
ExtraKeyAccessible	Used as a boolean extra field in `#ACTION_KEY_ACCESS_CHANGED` to supply if the key is accessible to the application.
ExtraKeyAlias	Used as a String extra field in `#ACTION_KEY_ACCESS_CHANGED` to supply the alias of the key.
ExtraName	Optional extra to specify a `String` credential name on the `Intent` returned by `#createInstallIntent`.
ExtraPkcs12	Optional extra for use with the `Intent` returned by `#createInstallIntent` to specify a PKCS#12 key store to install.
KeyAliasSelectionDenied	Used by DPC or delegated app in `android.app.admin.DeviceAdminReceiver#onChoosePrivateKeyAlias` or `android.app.admin.DelegatedAdminReceiver#onChoosePrivateKeyAlias` to identify that the requesting app is not granted access to any key, and nor will the user be able to grant access manually.

Properties

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	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)

Methods

ChoosePrivateKeyAlias(Activity, IKeyChainAliasCallback, String[], IPrincipal[], String, Int32, String)	Launches an `Activity` for the user to select the alias for a private key and certificate pair for authentication.
ChoosePrivateKeyAlias(Activity, IKeyChainAliasCallback, String[], IPrincipal[], Uri, String)	Launches an `Activity` for the user to select the alias for a private key and certificate pair for authentication.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CreateInstallIntent()	Returns an `Intent` that can be used for credential installation.
CreateManageCredentialsIntent(AppUriAuthenticationPolicy)	Returns an `Intent` that should be used by an app to request to manage the user's credentials.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetCertificateChain(Context, String)	Returns the `X509Certificate` chain for the requested alias, or null if the alias does not exist or the caller has no permission to access it (see note on exceptions in `#getPrivateKey`).
GetCredentialManagementAppPolicy(Context)	Called by the credential management app to get the authentication policy `AppUriAuthenticationPolicy`.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetPrivateKey(Context, String)	Returns the `PrivateKey` for the requested alias, or null if the alias does not exist or the caller has no permission to access it (see note on exceptions below).
IsBoundKeyAlgorithm(String)	Obsolete. Returns `true` if the current device's `KeyChain` binds any `PrivateKey` of the given `algorithm` to the device once imported or generated.
IsCredentialManagementApp(Context)	Check whether the caller is the credential management app `CredentialManagementApp`.
IsKeyAlgorithmSupported(String)	Returns `true` if the current device's `KeyChain` supports a specific `PrivateKey` type indicated by `algorithm` (e.
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)
RemoveCredentialManagementApp(Context)	Called by the credential management app `CredentialManagementApp` to unregister as the credential management app and stop managing the user's credentials.
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 another thread invokes the `java.lang.Object#notify()` method or the `java.lang.Object#notifyAll()` method for this object. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until either another thread invokes the `java.lang.Object#notify()` method or the `java.lang.Object#notifyAll()` method for this object, or a specified amount of time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until another thread invokes the `java.lang.Object#notify()` method or the `java.lang.Object#notifyAll()` method for this object, or some other thread interrupts the current thread, or 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