IdentityCredentialStoreCapabilities
class IdentityCredentialStoreCapabilities
A class that supports querying the capabilities of a IdentityCredentialStore as implemented in secure hardware or in software (backed by Android Keystore).
Capabilities depend on the Android system features and can be queried using getSystemAvailableFeatures and hasSystemFeature. The feature names in question are android.hardware.identity_credential andandroid.hardware.identity_credential_direct_access for the direct access store.
Known feature versions include FEATURE_VERSION_202009 and FEATURE_VERSION_202101.
Summary
Constants |
|
|---|---|
const Int |
FEATURE_VERSION_202009 = 202009The feature version corresponding to features included in the Identity Credential API shipped in Android 11. |
const Int |
FEATURE_VERSION_202101 = 202101The feature version corresponding to features included in the Identity Credential API shipped in Android 12. |
Public functions |
|
|---|---|
Int |
Returns the feature version of the |
(Mutable)Set<String!> |
Gets a set of supported document types. |
Boolean |
Returns whether |
Boolean |
Returns whether the credential store is for direct access. |
Boolean |
Returns whether the credential is backed by Secure Hardware. |
Boolean |
Returns true if |
Boolean |
Returns true if |
Boolean |
Returns true if |
Constants
FEATURE_VERSION_202009
const val FEATURE_VERSION_202009 = 202009: Int
The feature version corresponding to features included in the Identity Credential API shipped in Android 11.
FEATURE_VERSION_202101
const val FEATURE_VERSION_202101 = 202101: Int
The feature version corresponding to features included in the Identity Credential API shipped in Android 12. This feature version adds support for delete, update, proveOwnership, and storeStaticAuthenticationData.
Public functions
getFeatureVersion
fun getFeatureVersion(): Int
Returns the feature version of the IdentityCredentialStore.
| Returns | |
|---|---|
Int |
the feature version. |
getSupportedDocTypes
fun getSupportedDocTypes(): (Mutable)Set<String!>
Gets a set of supported document types.
Only the direct-access store may restrict the kind of document types that can be used for credentials. The default store always supports any document type.
This always return the empty set for the software-based store.
isDeleteSupported
fun isDeleteSupported(): Boolean
Returns whether delete is supported by the underlying hardware.
This is supported in feature version FEATURE_VERSION_202101 and later.
This is always supported by the software-based store.
| Returns | |
|---|---|
Boolean |
|
isDirectAccess
fun isDirectAccess(): Boolean
Returns whether the credential store is for direct access.
This always return false for the software-based store.
| Returns | |
|---|---|
Boolean |
|
isHardwareBacked
fun isHardwareBacked(): Boolean
Returns whether the credential is backed by Secure Hardware.
This always return false for the software-based store.
Note that the software-based store is still using Android Keystore which itself is backed by secure hardware.
| Returns | |
|---|---|
Boolean |
|
isProveOwnershipSupported
fun isProveOwnershipSupported(): Boolean
Returns true if proveOwnership is supported by the underlying hardware.
This is supported in feature version FEATURE_VERSION_202101 and later.
This is always supported by the software-based store.
| Returns | |
|---|---|
Boolean |
|
isStaticAuthenticationDataExpirationSupported
fun isStaticAuthenticationDataExpirationSupported(): Boolean
Returns true if storeStaticAuthenticationData is supported by the underlying hardware.
This is supported in feature version FEATURE_VERSION_202101 and later.
This is always supported by the software-based store.
| Returns | |
|---|---|
Boolean |
|
isUpdateSupported
fun isUpdateSupported(): Boolean
Returns true if update is supported by the underlying hardware.
This is supported in feature version FEATURE_VERSION_202101 and later.
This is always supported by the software-based store.
| Returns | |
|---|---|
Boolean |
|