/**@class android.security.KeyChain @extends java.lang.Object The {@code KeyChain} class provides access to private keys and their corresponding certificate chains in credential storage. <p>Applications accessing the {@code KeyChain} normally go through these steps: <ol> <li>Receive a callback from an {@link javax.net.ssl.X509KeyManager X509KeyManager} that a private key is requested. <li>Call {@link #choosePrivateKeyAlias choosePrivateKeyAlias} to allow the user to select from a list of currently available private keys and corresponding certificate chains. The chosen alias will be returned by the callback {@link android.security.KeyChainAliasCallback#alias}, or null if no private key is available or the user cancels the request. <li>Call {@link #getPrivateKey} and {@link #getCertificateChain} to retrieve the credentials to return to the corresponding {@link javax.net.ssl.X509KeyManager} callbacks. </ol> <p>An application may remember the value of a selected alias to avoid prompting the user with {@link #choosePrivateKeyAlias choosePrivateKeyAlias} on subsequent connections. If the alias is no longer valid, null will be returned on lookups using that value <p>An application can request the installation of private keys and certificates via the {@code Intent} provided by {@link #createInstallIntent}. Private keys installed via this {@code Intent} will be accessible via {@link #choosePrivateKeyAlias} while Certificate Authority (CA) certificates will be trusted by all applications through the default {@code X509TrustManager}. */ var KeyChain = { /** @hide Also used by KeyChainService implementation */ ACCOUNT_TYPE : "com.android.keychain", /** Extra for use with {@link #ACTION_CHOOSER} @hide Also used by KeyChainActivity implementation */ EXTRA_RESPONSE : "response", /** Extra for use with {@link #ACTION_CHOOSER} @hide Also used by KeyChainActivity implementation */ EXTRA_URI : "uri", /** Extra for use with {@link #ACTION_CHOOSER} @hide Also used by KeyChainActivity implementation */ EXTRA_ALIAS : "alias", /** Extra for use with {@link #ACTION_CHOOSER} @hide Also used by KeyChainActivity implementation */ EXTRA_SENDER : "sender", /** Extra for use with {@link #ACTION_CHOOSER} @hide Also used by KeyChainActivity implementation */ EXTRA_KEY_TYPES : "key_types", /** Extra for use with {@link #ACTION_CHOOSER} @hide Also used by KeyChainActivity implementation */ EXTRA_ISSUERS : "issuers", /** Optional extra to specify a {@code String} credential name on the {@code Intent} returned by {@link #createInstallIntent}. */ EXTRA_NAME : "name", /** Optional extra to specify an X.509 certificate to install on the {@code Intent} returned by {@link #createInstallIntent}. The extra value should be a PEM or ASN.1 DER encoded {@code byte[]}. An {@link X509Certificate} can be converted to DER encoded bytes with {@link X509Certificate#getEncoded}. <p>{@link #EXTRA_NAME} may be used to provide a default alias name for the installed certificate. */ EXTRA_CERTIFICATE : "CERT", /** Optional extra for use with the {@code Intent} returned by {@link #createInstallIntent} to specify a PKCS#12 key store to install. The extra value should be a {@code byte[]}. The bytes may come from an external source or be generated with {@link java.security.KeyStore#store} on a "PKCS12" instance. <p>The user will be prompted for the password to load the key store. <p>The key store will be scanned for {@link java.security.KeyStore.PrivateKeyEntry} entries and both the private key and associated certificate chain will be installed. <p>{@link #EXTRA_NAME} may be used to provide a default alias name for the installed credentials. */ EXTRA_PKCS12 : "PKCS12", /** Broadcast Action: Indicates the trusted storage has changed. Sent when one of this happens: <ul> <li>a new CA is added, <li>an existing CA is removed or disabled, <li>a disabled CA is enabled, <li>trusted storage is reset (all user certs are cleared), <li>when permission to access a private key is changed. </ul> @deprecated Use {@link #ACTION_KEYCHAIN_CHANGED}, {@link #ACTION_TRUST_STORE_CHANGED} or {@link #ACTION_KEY_ACCESS_CHANGED}. Apps that target a version higher than {@link android.os.Build.VERSION_CODES#N_MR1} will only receive this broadcast if they register for it at runtime. */ ACTION_STORAGE_CHANGED : "android.security.STORAGE_CHANGED", /** Broadcast Action: Indicates the contents of the keychain has changed. Sent when a KeyChain entry is added, modified or removed. */ ACTION_KEYCHAIN_CHANGED : "android.security.action.KEYCHAIN_CHANGED", /** Broadcast Action: Indicates the contents of the trusted certificate store has changed. Sent when one the following occurs: <ul> <li>A pre-installed CA is disabled or re-enabled</li> <li>A CA is added or removed from the trust store</li> </ul> */ ACTION_TRUST_STORE_CHANGED : "android.security.action.TRUST_STORE_CHANGED", /** Broadcast Action: Indicates that the access permissions for a private key have changed. */ ACTION_KEY_ACCESS_CHANGED : "android.security.action.KEY_ACCESS_CHANGED", /** Used as a String extra field in {@link #ACTION_KEY_ACCESS_CHANGED} to supply the alias of the key. */ EXTRA_KEY_ALIAS : "android.security.extra.KEY_ALIAS", /** Used as a boolean extra field in {@link #ACTION_KEY_ACCESS_CHANGED} to supply if the key is accessible to the application. */ EXTRA_KEY_ACCESSIBLE : "android.security.extra.KEY_ACCESSIBLE", /** Indicates that a call to {@link #generateKeyPair} was successful. @hide */ KEY_GEN_SUCCESS : "0", /** An alias was missing from the key specifications when calling {@link #generateKeyPair}. @hide */ KEY_GEN_MISSING_ALIAS : "1", /** A key attestation challenge was provided to {@link #generateKeyPair}, but it shouldn't have been provided. @hide */ KEY_GEN_SUPERFLUOUS_ATTESTATION_CHALLENGE : "2", /** Algorithm not supported by {@link #generateKeyPair} @hide */ KEY_GEN_NO_SUCH_ALGORITHM : "3", /** Invalid algorithm parameters when calling {@link #generateKeyPair} @hide */ KEY_GEN_INVALID_ALGORITHM_PARAMETERS : "4", /** Keystore is not available when calling {@link #generateKeyPair} @hide */ KEY_GEN_NO_KEYSTORE_PROVIDER : "5", /** StrongBox unavailable when calling {@link #generateKeyPair} @hide */ KEY_GEN_STRONGBOX_UNAVAILABLE : "6", /** General failure while calling {@link #generateKeyPair} @hide */ KEY_GEN_FAILURE : "7", /** Successful call to {@link #attestKey} @hide */ KEY_ATTESTATION_SUCCESS : "0", /** Attestation challenge missing when calling {@link #attestKey} @hide */ KEY_ATTESTATION_MISSING_CHALLENGE : "1", /** The caller requested Device ID attestation when calling {@link #attestKey}, but has no permissions to get device identifiers. @hide */ KEY_ATTESTATION_CANNOT_COLLECT_DATA : "2", /** The underlying hardware does not support Device ID attestation or cannot attest to the identifiers that are stored on the device. This indicates permanent inability to get attestation records on the device. @hide */ KEY_ATTESTATION_CANNOT_ATTEST_IDS : "3", /** General failure when calling {@link #attestKey} @hide */ KEY_ATTESTATION_FAILURE : "4", /**Returns an {@code Intent} that can be used for credential installation. The intent may be used without any extras, in which case the user will be able to install credentials from their own source. <p>Alternatively, {@link #EXTRA_CERTIFICATE} or {@link #EXTRA_PKCS12} maybe used to specify the bytes of an X.509 certificate or a PKCS#12 key store for installation. These extras may be combined with {@link #EXTRA_NAME} to provide a default alias name for credentials being installed. <p>When used with {@link Activity#startActivityForResult}, {@link Activity#RESULT_OK} will be returned if a credential was successfully installed, otherwise {@link Activity#RESULT_CANCELED} will be returned. */ createInstallIntent : function( ) {}, /**Launches an {@code Activity} for the user to select the alias for a private key and certificate pair for authentication. The selected alias or null will be returned via the KeyChainAliasCallback callback. <p>A device policy controller (as a device or profile owner) can intercept the request before the activity is shown, to pick a specific private key alias by implementing {@link android.app.admin.DeviceAdminReceiver#onChoosePrivateKeyAlias onChoosePrivateKeyAlias}. <p>{@code keyTypes} and {@code issuers} may be used to narrow down suggested choices to the user. If either {@code keyTypes} or {@code issuers} is specified and non-empty, and there are no matching certificates in the KeyChain, then the certificate selection prompt would be suppressed entirely. <p>{@code host} and {@code port} may be used to give the user more context about the server requesting the credentials. <p>{@code alias} allows the caller to preselect an existing alias which will still be subject to user confirmation. @param {Object {Activity}} activity The {@link Activity} context to use for launching the new sub-Activity to prompt the user to select a private key; used only to call startActivity(); must not be null. @param {Object {KeyChainAliasCallback}} response Callback to invoke when the request completes; must not be null. @param {Object {java.lang.String[]}} keyTypes The acceptable types of asymmetric keys such as "RSA", "EC" or null. @param {Object {java.security.Principal[]}} issuers The acceptable certificate issuers for the certificate matching the private key, or null. @param {String} host The host name of the server requesting the certificate, or null if unavailable. @param {Number} port The port number of the server requesting the certificate, or -1 if unavailable. @param {String} alias The alias to preselect if available, or null if unavailable. */ choosePrivateKeyAlias : function( ) {}, /**Launches an {@code Activity} for the user to select the alias for a private key and certificate pair for authentication. The selected alias or null will be returned via the KeyChainAliasCallback callback. <p>A device policy controller (as a device or profile owner) can intercept the request before the activity is shown, to pick a specific private key alias by implementing {@link android.app.admin.DeviceAdminReceiver#onChoosePrivateKeyAlias onChoosePrivateKeyAlias}. <p>{@code keyTypes} and {@code issuers} may be used to narrow down suggested choices to the user. If either {@code keyTypes} or {@code issuers} is specified and non-empty, and there are no matching certificates in the KeyChain, then the certificate selection prompt would be suppressed entirely. <p>{@code uri} may be used to give the user more context about the server requesting the credentials. <p>{@code alias} allows the caller to preselect an existing alias which will still be subject to user confirmation. @param {Object {Activity}} activity The {@link Activity} context to use for launching the new sub-Activity to prompt the user to select a private key; used only to call startActivity(); must not be null. @param {Object {KeyChainAliasCallback}} response Callback to invoke when the request completes; must not be null. @param {Object {java.lang.String[]}} keyTypes The acceptable types of asymmetric keys such as "RSA", "EC" or null. @param {Object {java.security.Principal[]}} issuers The acceptable certificate issuers for the certificate matching the private key, or null. @param {Object {Uri}} uri The full URI the server is requesting the certificate for, or null if unavailable. @param {String} alias The alias to preselect if available, or null if unavailable. @throws IllegalArgumentException if the specified issuers are not of type {@code X500Principal}. */ choosePrivateKeyAlias : function( ) {}, /**Returns the {@code PrivateKey} for the requested alias, or null if the alias does not exist or the caller has no permission to access it (see note on exceptions below). <p> This method may block while waiting for a connection to another process, and must never be called from the main thread. <p> As {@link Activity} and {@link Service} contexts are short-lived and can be destroyed at any time from the main thread, it is safer to rely on a long-lived context such as one returned from {@link Context#getApplicationContext()}. <p> If the caller provides a valid alias to which it was not granted access, then the caller must invoke {@link #choosePrivateKeyAlias} again to get another valid alias or a grant to access the same alias. <p>On Android versions prior to Q, when a key associated with the specified alias is unavailable, the method will throw a {@code KeyChainException} rather than return null. If the exception's cause (as obtained by calling {@code KeyChainException.getCause()}) is a throwable of type {@code IllegalStateException} then the caller lacks a grant to access the key and certificates associated with this alias. @param {Object {Context}} alias The alias of the desired private key, typically returned via {@link KeyChainAliasCallback#alias}. @throws KeyChainException if the alias was valid but there was some problem accessing it. @throws IllegalStateException if called from the main thread. */ getPrivateKey : function( ) {}, /** @hide */ getKeyPair : function( ) {}, /**Returns the {@code X509Certificate} chain for the requested alias, or null if the alias does not exist or the caller has no permission to access it (see note on exceptions in {@link #getPrivateKey}). <p> <strong>Note:</strong> If a certificate chain was explicitly specified when the alias was installed, this method will return that chain. If only the client certificate was specified at the installation time, this method will try to build a certificate chain using all available trust anchors (preinstalled and user-added). <p> This method may block while waiting for a connection to another process, and must never be called from the main thread. <p> As {@link Activity} and {@link Service} contexts are short-lived and can be destroyed at any time from the main thread, it is safer to rely on a long-lived context such as one returned from {@link Context#getApplicationContext()}. <p> In case the caller specifies an alias for which it lacks a grant, it must call {@link #choosePrivateKeyAlias} again. See {@link #getPrivateKey} for more details on coping with this scenario. @param {Object {Context}} alias The alias of the desired certificate chain, typically returned via {@link KeyChainAliasCallback#alias}. @throws KeyChainException if the alias was valid but there was some problem accessing it. @throws IllegalStateException if called from the main thread. */ getCertificateChain : function( ) {}, /**Returns {@code true} if the current device's {@code KeyChain} supports a specific {@code PrivateKey} type indicated by {@code algorithm} (e.g., "RSA"). */ isKeyAlgorithmSupported : function( ) {}, /**Returns {@code true} if the current device's {@code KeyChain} binds any {@code PrivateKey} of the given {@code algorithm} to the device once imported or generated. This can be used to tell if there is special hardware support that can be used to bind keys to the device in a way that makes it non-exportable. @deprecated Whether the key is bound to the secure hardware is known only once the key has been imported. To find out, use: <pre>{@code PrivateKey key = ...; // private key from KeyChain KeyFactory keyFactory = KeyFactory.getInstance(key.getAlgorithm(), "AndroidKeyStore"); KeyInfo keyInfo = keyFactory.getKeySpec(key, KeyInfo.class); if (keyInfo.isInsideSecureHardware()) { // The key is bound to the secure hardware of this Android }}</pre> */ isBoundKeyAlgorithm : function( ) {}, /** @hide */ toCertificate : function( ) {}, /** @hide */ toCertificates : function( ) {}, /** @hide for reuse by CertInstaller and Settings. Caller should call unbindService on the result when finished. */ bind : function( ) {}, /** @hide */ bindAsUser : function( ) {}, };