Added in API level 23

Summary: Methods | Inherited Methods

KeyInfo

Kotlin |Java

public class KeyInfo
extends Object implements KeySpec

java.lang.Object
↳	android.security.keystore.KeyInfo

Information about a key from the Android Keystore system. This class describes whether the key material is available in plaintext outside of secure hardware, whether user authentication is required for using the key and whether this requirement is enforced by secure hardware, the key's origin, what uses the key is authorized for (e.g., only in GCM mode, or signing only), whether the key should be encrypted at rest, the key's and validity start and end dates.

Instances of this class are immutable.

Example: Symmetric Key

The following example illustrates how to obtain a KeyInfo describing the provided Android Keystore SecretKey.

SecretKey key = ...; // Android Keystore key

 SecretKeyFactory factory = SecretKeyFactory.getInstance(key.getAlgorithm(), "AndroidKeyStore");
 KeyInfo keyInfo;
 try {
     keyInfo = (KeyInfo) factory.getKeySpec(key, KeyInfo.class);
 } catch (InvalidKeySpecException e) {
     // Not an Android KeyStore key.
 }

Example: Private Key

The following example illustrates how to obtain a KeyInfo describing the provided Android KeyStore PrivateKey.

PrivateKey key = ...; // Android KeyStore key

 KeyFactory factory = KeyFactory.getInstance(key.getAlgorithm(), "AndroidKeyStore");
 KeyInfo keyInfo;
 try {
     keyInfo = factory.getKeySpec(key, KeyInfo.class);
 } catch (InvalidKeySpecException e) {
     // Not an Android KeyStore key.
 }

Summary

Public methods
`String[]`	`getBlockModes()` Gets the set of block modes (e.g., `GCM`, `CBC`) with which the key can be used when encrypting/decrypting.
`String[]`	`getDigests()` Gets the set of digest algorithms (e.g., `SHA-256`, `SHA-384`) with which the key can be used.
`String[]`	`getEncryptionPaddings()` Gets the set of padding schemes (e.g., `PKCS7Padding`, `PKCS1Padding`, `NoPadding`) with which the key can be used when encrypting/decrypting.
`int`	`getKeySize()` Gets the size of the key in bits.
`Date`	`getKeyValidityForConsumptionEnd()` Gets the time instant after which the key is no long valid for decryption and verification.
`Date`	`getKeyValidityForOriginationEnd()` Gets the time instant after which the key is no long valid for encryption and signing.
`Date`	`getKeyValidityStart()` Gets the time instant before which the key is not yet valid.
`String`	`getKeystoreAlias()` Gets the entry alias under which the key is stored in the `AndroidKeyStore`.
`int`	`getOrigin()` Gets the origin of the key.
`int`	`getPurposes()` Gets the set of purposes (e.g., encrypt, decrypt, sign) for which the key can be used.
`int`	`getRemainingUsageCount()` Returns the remaining number of times the key is allowed to be used or `KeyProperties.UNRESTRICTED_USAGE_COUNT` if there's no restriction on the number of times the key can be used.
`int`	`getSecurityLevel()` Returns the security level that the key is protected by.
`String[]`	`getSignaturePaddings()` Gets the set of padding schemes (e.g., `PSS`, `PKCS#1`) with which the key can be used when signing/verifying.
`int`	`getUserAuthenticationType()` Gets the acceptable user authentication types for which this key can be authorized to be used.
`int`	`getUserAuthenticationValidityDurationSeconds()` Gets the duration of time (seconds) for which this key is authorized to be used after the user is successfully authenticated.
`boolean`	`isInsideSecureHardware()` This method was deprecated in API level 31. This method is superseded by @see getSecurityLevel.
`boolean`	`isInvalidatedByBiometricEnrollment()` Returns `true` if the key will be invalidated by enrollment of a new fingerprint or removal of all fingerprints.
`boolean`	`isTrustedUserPresenceRequired()` Returns `true` if the key can only be only be used if a test for user presence has succeeded since Signature.initSign() has been called.
`boolean`	`isUnlockedDeviceRequired()` Returns `true` if the key is authorized to be used only while the device is unlocked.
`boolean`	`isUserAuthenticationRequired()` Returns `true` if the key is authorized to be used only if the user has been authenticated.
`boolean`	`isUserAuthenticationRequirementEnforcedBySecureHardware()` Returns `true` if the requirement that this key can only be used if the user has been authenticated is enforced by secure hardware (e.g., Trusted Execution Environment (TEE) or Secure Element (SE)).
`boolean`	`isUserAuthenticationValidWhileOnBody()` Returns `true` if this key will become unusable when the device is removed from the user's body.
`boolean`	`isUserConfirmationRequired()` Returns `true` if the key is authorized to be used only for messages confirmed by the user.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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(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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getBlockModes

Added in API level 23

public String[] getBlockModes ()

Gets the set of block modes (e.g., GCM, CBC) with which the key can be used when encrypting/decrypting. Attempts to use the key with any other block modes will be rejected.

See KeyProperties.BLOCK_MODE constants.

Returns
`String[]`	This value cannot be `null`. Value is `KeyProperties.BLOCK_MODE_ECB`, `KeyProperties.BLOCK_MODE_CBC`, `KeyProperties.BLOCK_MODE_CTR`, or `KeyProperties.BLOCK_MODE_GCM`

getDigests

Added in API level 23

public String[] getDigests ()

Gets the set of digest algorithms (e.g., SHA-256, SHA-384) with which the key can be used.

See KeyProperties.DIGEST constants.

Returns
`String[]`	This value cannot be `null`. Value is `KeyProperties.DIGEST_NONE`, `KeyProperties.DIGEST_MD5`, `KeyProperties.DIGEST_SHA1`, `KeyProperties.DIGEST_SHA224`, `KeyProperties.DIGEST_SHA256`, `KeyProperties.DIGEST_SHA384`, or `KeyProperties.DIGEST_SHA512`

getEncryptionPaddings

Added in API level 23

public String[] getEncryptionPaddings ()

Gets the set of padding schemes (e.g., PKCS7Padding, PKCS1Padding, NoPadding) with which the key can be used when encrypting/decrypting. Attempts to use the key with any other padding scheme will be rejected.

See KeyProperties.ENCRYPTION_PADDING constants.

Returns
`String[]`	This value cannot be `null`. Value is `KeyProperties.ENCRYPTION_PADDING_NONE`, `KeyProperties.ENCRYPTION_PADDING_PKCS7`, `KeyProperties.ENCRYPTION_PADDING_RSA_PKCS1`, or `KeyProperties.ENCRYPTION_PADDING_RSA_OAEP`

getKeySize

Added in API level 23

public int getKeySize ()

Gets the size of the key in bits.

Returns
`int`

getKeyValidityForConsumptionEnd

Added in API level 23

public Date getKeyValidityForConsumptionEnd ()

Gets the time instant after which the key is no long valid for decryption and verification.

Returns
`Date`	instant or `null` if not restricted.

getKeyValidityForOriginationEnd

Added in API level 23

public Date getKeyValidityForOriginationEnd ()

Gets the time instant after which the key is no long valid for encryption and signing.

Returns
`Date`	instant or `null` if not restricted.

getKeyValidityStart

Added in API level 23

public Date getKeyValidityStart ()

Gets the time instant before which the key is not yet valid.

Returns
`Date`	instant or `null` if not restricted.

getKeystoreAlias

Added in API level 23

public String getKeystoreAlias ()

Gets the entry alias under which the key is stored in the AndroidKeyStore.

Returns
`String`

getOrigin

Added in API level 23

public int getOrigin ()

Gets the origin of the key. See KeyProperties.ORIGIN constants.

Returns
`int`	Value is `KeyProperties.ORIGIN_GENERATED`, `KeyProperties.ORIGIN_IMPORTED`, or `KeyProperties.ORIGIN_UNKNOWN`

getPurposes

Added in API level 23

public int getPurposes ()

Gets the set of purposes (e.g., encrypt, decrypt, sign) for which the key can be used. Attempts to use the key for any other purpose will be rejected.

See KeyProperties.PURPOSE flags.

Returns
`int`	Value is either `0` or a combination of `KeyProperties.PURPOSE_ENCRYPT`, `KeyProperties.PURPOSE_DECRYPT`, `KeyProperties.PURPOSE_SIGN`, `KeyProperties.PURPOSE_VERIFY`, `KeyProperties.PURPOSE_WRAP_KEY`, `KeyProperties.PURPOSE_AGREE_KEY`, and `KeyProperties.PURPOSE_ATTEST_KEY`

getRemainingUsageCount

Added in API level 31

public int getRemainingUsageCount ()

Returns the remaining number of times the key is allowed to be used or KeyProperties.UNRESTRICTED_USAGE_COUNT if there's no restriction on the number of times the key can be used. Note that this gives a best effort count and need not be accurate (as there might be usages happening in parallel and the count maintained here need not be in sync with the usage).

Returns
`int`

getSecurityLevel

Added in API level 31

public int getSecurityLevel ()

Returns the security level that the key is protected by. KeyProperties.SecurityLevelEnum.TRUSTED_ENVIRONMENT and KeyProperties.SecurityLevelEnum.STRONGBOX indicate that the key material resides in secure hardware. Key material of such keys is available in plaintext only inside the secure hardware and is not exposed outside of it.

See KeyProperties.SecurityLevelEnum constants.

Returns
`int`	Value is `KeyProperties.SECURITY_LEVEL_UNKNOWN`, `KeyProperties.SECURITY_LEVEL_UNKNOWN_SECURE`, `KeyProperties.SECURITY_LEVEL_SOFTWARE`, `KeyProperties.SECURITY_LEVEL_TRUSTED_ENVIRONMENT`, or `KeyProperties.SECURITY_LEVEL_STRONGBOX`

getSignaturePaddings

Added in API level 23

public String[] getSignaturePaddings ()

Gets the set of padding schemes (e.g., PSS, PKCS#1) with which the key can be used when signing/verifying. Attempts to use the key with any other padding scheme will be rejected.

See KeyProperties.SIGNATURE_PADDING constants.

Returns
`String[]`	This value cannot be `null`. Value is `KeyProperties.SIGNATURE_PADDING_RSA_PKCS1`, or `KeyProperties.SIGNATURE_PADDING_RSA_PSS`

getUserAuthenticationType

Added in API level 30

public int getUserAuthenticationType ()

Gets the acceptable user authentication types for which this key can be authorized to be used. This has effect only if user authentication is required (see isUserAuthenticationRequired()).

This authorization applies only to secret key and private key operations. Public key operations are not restricted.

Returns
`int`	integer representing the accepted forms of user authentication for this key Value is either `0` or a combination of `KeyProperties.AUTH_BIOMETRIC_STRONG`, and `KeyProperties.AUTH_DEVICE_CREDENTIAL`

See also:

isUserAuthenticationRequired()

getUserAuthenticationValidityDurationSeconds

Added in API level 23

public int getUserAuthenticationValidityDurationSeconds ()

Gets the duration of time (seconds) for which this key is authorized to be used after the user is successfully authenticated. This has effect only if user authentication is required (see isUserAuthenticationRequired()).

This authorization applies only to secret key and private key operations. Public key operations are not restricted.

Returns
`int`	duration in seconds or `-1` if authentication is required for every use of the key.

See also:

isUserAuthenticationRequired()

isInsideSecureHardware

Added in API level 23
Deprecated in API level 31

public boolean isInsideSecureHardware ()

This method was deprecated in API level 31.
This method is superseded by @see getSecurityLevel.

Returns true if the key resides inside secure hardware (e.g., Trusted Execution Environment (TEE) or Secure Element (SE)). Key material of such keys is available in plaintext only inside the secure hardware and is not exposed outside of it.

Returns
`boolean`

isInvalidatedByBiometricEnrollment

Added in API level 24

public boolean isInvalidatedByBiometricEnrollment ()

Returns true if the key will be invalidated by enrollment of a new fingerprint or removal of all fingerprints.

Returns
`boolean`

isTrustedUserPresenceRequired

Added in API level 28

public boolean isTrustedUserPresenceRequired ()

Returns true if the key can only be only be used if a test for user presence has succeeded since Signature.initSign() has been called.

Returns
`boolean`

isUnlockedDeviceRequired

Added in Android Baklava

public boolean isUnlockedDeviceRequired ()

Returns true if the key is authorized to be used only while the device is unlocked.

This authorization applies only to secret key and private key operations. Public key operations are not restricted.

Returns
`boolean`

See also:

isUserAuthenticationRequired

Added in API level 23

public boolean isUserAuthenticationRequired ()

Returns true if the key is authorized to be used only if the user has been authenticated.

This authorization applies only to secret key and private key operations. Public key operations are not restricted.

Returns
`boolean`

See also:

isUserAuthenticationRequirementEnforcedBySecureHardware

Added in API level 23

public boolean isUserAuthenticationRequirementEnforcedBySecureHardware ()

Returns true if the requirement that this key can only be used if the user has been authenticated is enforced by secure hardware (e.g., Trusted Execution Environment (TEE) or Secure Element (SE)).

Returns
`boolean`

See also:

isUserAuthenticationRequired()

isUserAuthenticationValidWhileOnBody

Added in API level 24

public boolean isUserAuthenticationValidWhileOnBody ()

Returns true if this key will become unusable when the device is removed from the user's body. This is possible only for keys with a specified validity duration, and only on devices with an on-body sensor. Always returns false on devices that lack an on-body sensor.

Returns
`boolean`

isUserConfirmationRequired

Added in API level 28

public boolean isUserConfirmationRequired ()

Returns true if the key is authorized to be used only for messages confirmed by the user. Confirmation is separate from user authentication (see isUserAuthenticationRequired()). Keys can be created that require confirmation but not user authentication, or user authentication but not confirmation, or both. Confirmation verifies that some user with physical possession of the device has approved a displayed message. User authentication verifies that the correct user is present and has authenticated.

This authorization applies only to secret key and private key operations. Public key operations are not restricted.

Returns
`boolean`

See also: