KeyChainManager

Kotlin |Java

public final class KeyChainManager
extends Object

java.lang.Object
↳	android.security.KeyChainManager

Manages KeyChain certificates and grants.

Summary

Constants
`int`	`KEYPAIR_SCOPE_DEVICE` Scope indicating the key pair is installed device-wide and is visible to all affiliated users on the device.
`int`	`KEYPAIR_SCOPE_USER` Scope indicating the key pair is installed for the current user only.

Public methods
`List<X509Certificate>`	`getCertificateChain(String alias, int scope)` Returns the certificate chain of the given scoped certificate.
`List<GrantedKeyInfo>`	`getGrantedKeyPairs(int scope)` Returns a list of granted keys that the calling app has access to for the specified scope.
`PrivateKey`	`getPrivateKey(String alias, int scope)` Returns the private key for the given alias and scope.

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.

Constants

KEYPAIR_SCOPE_DEVICE

Added in API level 10000

public static final int KEYPAIR_SCOPE_DEVICE

Scope indicating the key pair is installed device-wide and is visible to all affiliated users on the device.

Constant Value: 1 (0x00000001)

KEYPAIR_SCOPE_USER

Added in API level 10000

public static final int KEYPAIR_SCOPE_USER

Scope indicating the key pair is installed for the current user only. This is the default scope for existing KeyChain credentials.

Constant Value: 2 (0x00000002)

Public methods

getCertificateChain

Added in API level 10000

public List<X509Certificate> getCertificateChain (String alias, 
                int scope)

Returns the certificate chain of the given scoped certificate. Callable by the application that installed the certificate, any app that has been granted access to the given alias, as well as DPCs and their delegates.

Parameters
`alias`	`String`: The alias of the desired certificate chain. This value cannot be `null`.
`scope`	`int`: The scope to search (`KEYPAIR_SCOPE_USER` or `KEYPAIR_SCOPE_DEVICE`). Value is one of the following: `KEYPAIR_SCOPE_USER` `KEYPAIR_SCOPE_DEVICE`

Returns
`List<X509Certificate>`	The list of `X509Certificate`s representing the chain, or an empty list if no certificate exists for the given alias/scope or if access to the key is not granted. This value cannot be `null`.

Throws
`IllegalArgumentException`	if `scope` is invalid.

getGrantedKeyPairs

Added in API level 10000

public List<GrantedKeyInfo> getGrantedKeyPairs (int scope)

Returns a list of granted keys that the calling app has access to for the specified scope.

Parameters
`scope`	`int`: The scope of the key pair: `KEYPAIR_SCOPE_USER` or `KEYPAIR_SCOPE_DEVICE`. Value is one of the following: `KEYPAIR_SCOPE_USER` `KEYPAIR_SCOPE_DEVICE`

Returns
`List<GrantedKeyInfo>`	A non-null list of `GrantedKeyInfo` objects.

Throws
`IllegalArgumentException`	if `scope` is invalid.

getPrivateKey

Added in API level 10000

public PrivateKey getPrivateKey (String alias, 
                int scope)

Returns the private key for the given alias and scope.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`alias`	`String`: The alias of the desired key pair. This value cannot be `null`.
`scope`	`int`: The scope to search (`KEYPAIR_SCOPE_USER` or `KEYPAIR_SCOPE_DEVICE`). Value is one of the following: `KEYPAIR_SCOPE_USER` `KEYPAIR_SCOPE_DEVICE`

Returns
`PrivateKey`	The `PrivateKey`, or `null` if no key exists for the given alias/scope or if access to the key is not granted.

Throws
`IllegalArgumentException`	if `scope` is invalid.