IdentityCredentialStore Class
Definition
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 interface to a secure store for user identity documents.
[Android.Runtime.Register("android/security/identity/IdentityCredentialStore", ApiSince=30, DoNotGenerateAcw=true)]
public abstract class IdentityCredentialStore : Java.Lang.Object[<Android.Runtime.Register("android/security/identity/IdentityCredentialStore", ApiSince=30, DoNotGenerateAcw=true)>]
type IdentityCredentialStore = class
inherit Object- Inheritance
- Attributes
Remarks
An interface to a secure store for user identity documents.
This interface is deliberately fairly general and abstract. To the extent possible, specification of the message formats and semantics of communication with credential verification devices and issuing authorities (IAs) is out of scope. It provides the interface with secure storage but a credential-specific Android application will be required to implement the presentation and verification protocols and processes appropriate for the specific credential type.
Multiple credentials can be created. Each credential comprises:
<ul> <li>A document type, which is a string.</li>
<li>A set of namespaces, which serve to disambiguate value names. It is recommended that namespaces be structured as reverse domain names so that IANA effectively serves as the namespace registrar.</li>
<li>For each namespace, a set of name/value pairs, each with an associated set of access control profile IDs. Names are strings and values are typed and can be any value supported by CBOR.</li>
<li>A set of access control profiles (up to 32), each with a profile ID and a specification of the conditions which satisfy the profile's requirements.</li>
<li>An asymmetric key pair which is used to authenticate the credential to the Issuing Authority, called the <em>CredentialKey</em>.</li>
<li>A set of zero or more named reader authentication public keys, which are used to authenticate an authorized reader to the credential.</li>
<li>A set of named signing keys, which are used to sign collections of values and session transcripts.</li> </ul>
Implementing support for user identity documents in secure storage requires dedicated hardware-backed support and may not always be available.
Two different credential stores exist - the <em>default</em> store and the <em>direct access</em> store. Most often credentials will be accessed through the default store but that requires that the Android device be powered up and fully functional. It is desirable to allow identity credential usage when the Android device's battery is too low to boot the Android operating system, so direct access to the secure hardware via NFC may allow data retrieval, if the secure hardware chooses to implement it.
Credentials provisioned to the direct access store should <strong>always</strong> use reader authentication to protect data elements. The reason for this is user authentication or user approval of data release is not possible when the device is off.
The Identity Credential API is designed to be able to evolve and change over time but still provide 100% backwards compatibility. This is complicated by the fact that there may be a version skew between the API used by the application and the version implemented in secure hardware. To solve this problem, the API provides for a way for the application to query which feature version the hardware implements (if any at all) using android.content.pm#FEATURE_IDENTITY_CREDENTIAL_HARDWARE and android.content.pm#FEATURE_IDENTITY_CREDENTIAL_HARDWARE_DIRECT_ACCESS. Methods which only work on certain feature versions are clearly documented as such.
Java documentation for android.security.identity.IdentityCredentialStore.
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
| IdentityCredentialStore(IntPtr, JniHandleOwnership) |
Fields
| CiphersuiteEcdheHkdfEcdsaWithAes256GcmSha256 |
Obsolete.
Specifies that the cipher suite that will be used to secure communications between the reader and the prover is using the following primitives |
Properties
| Class |
Returns the runtime class of this |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| PeerReference | (Inherited from Object) |
| ThresholdClass | |
| ThresholdType | |
Methods
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| CreateCredential(String, String) |
Creates a new credential. |
| CreatePresentationSession(Int32) |
Creates a new presentation session. |
| DeleteCredentialByName(String) |
Delete a named credential. |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetCredentialByName(String, Int32) |
Retrieve a named credential. |
| GetDirectAccessInstance(Context) |
Gets the |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetInstance(Context) |
Gets the default |
| GetSupportedDocTypes() |
Gets a list of supported document types. |
| 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, 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) |
| 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) |
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) | |