KeyInfo

extends Object
implements KeySpec

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

Class Overview

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.
String[]	getSignaturePaddings() Gets the set of padding schemes (e.g., `PSS`, `PKCS#1`) with which the key can be used when signing/verifying.
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() Returns `true` if the key resides inside secure hardware (e.g., Trusted Execution Environment (TEE) or Secure Element (SE)).
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 if enforced by secure hardware (e.g., Trusted Execution Environment (TEE) or Secure Element (SE)).

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Results

Classes

Exceptions

KeyInfo

Class Overview

Example: Symmetric Key

Example: Private Key

Summary

Public Methods

public String[] getBlockModes ()

public String[] getDigests ()

public String[] getEncryptionPaddings ()

public int getKeySize ()

public Date getKeyValidityForConsumptionEnd ()

Returns

public Date getKeyValidityForOriginationEnd ()

Returns

public Date getKeyValidityStart ()

Returns

public String getKeystoreAlias ()

public int getOrigin ()

public int getPurposes ()

public String[] getSignaturePaddings ()

public int getUserAuthenticationValidityDurationSeconds ()

Returns

See Also

public boolean isInsideSecureHardware ()

public boolean isUserAuthenticationRequired ()

See Also

public boolean isUserAuthenticationRequirementEnforcedBySecureHardware ()

See Also