| /* |
| * Copyright (C) 2017 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.security.keystore.recovery; |
| |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.RequiresPermission; |
| import android.annotation.SystemApi; |
| import android.app.PendingIntent; |
| import android.content.Context; |
| import android.content.pm.PackageManager.NameNotFoundException; |
| import android.os.RemoteException; |
| import android.os.ServiceManager; |
| import android.os.ServiceSpecificException; |
| import android.security.KeyStore; |
| import android.security.keystore.AndroidKeyStoreProvider; |
| |
| import com.android.internal.widget.ILockSettings; |
| |
| import java.security.Key; |
| import java.security.UnrecoverableKeyException; |
| import java.security.cert.CertPath; |
| import java.security.cert.CertificateException; |
| import java.util.ArrayList; |
| import java.util.List; |
| import java.util.Map; |
| |
| /** |
| * An assistant for generating {@link javax.crypto.SecretKey} instances that can be recovered by |
| * other Android devices belonging to the user. The exported keychain is protected by the user's |
| * lock screen. |
| * |
| * <p>The RecoveryController must be paired with a recovery agent. The recovery agent is responsible |
| * for transporting the keychain to remote trusted hardware. This hardware must prevent brute force |
| * attempts against the user's lock screen by limiting the number of allowed guesses (to, e.g., 10). |
| * After that number of incorrect guesses, the trusted hardware no longer allows access to the |
| * key chain. |
| * |
| * <p>Only the recovery agent itself is able to create keys, so it is expected that the recovery |
| * agent is itself the system app. |
| * |
| * <p>A recovery agent requires the privileged permission |
| * {@code android.Manifest.permission#RECOVER_KEYSTORE}. |
| * |
| * @hide |
| */ |
| @SystemApi |
| public class RecoveryController { |
| private static final String TAG = "RecoveryController"; |
| |
| /** Key has been successfully synced. */ |
| public static final int RECOVERY_STATUS_SYNCED = 0; |
| /** Waiting for recovery agent to sync the key. */ |
| public static final int RECOVERY_STATUS_SYNC_IN_PROGRESS = 1; |
| /** Key cannot be synced. */ |
| public static final int RECOVERY_STATUS_PERMANENT_FAILURE = 3; |
| |
| /** |
| * Failed because no snapshot is yet pending to be synced for the user. |
| * |
| * @hide |
| */ |
| public static final int ERROR_NO_SNAPSHOT_PENDING = 21; |
| |
| /** |
| * Failed due to an error internal to the recovery service. This is unexpected and indicates |
| * either a problem with the logic in the service, or a problem with a dependency of the |
| * service (such as AndroidKeyStore). |
| * |
| * @hide |
| */ |
| public static final int ERROR_SERVICE_INTERNAL_ERROR = 22; |
| |
| /** |
| * Failed because the user does not have a lock screen set. |
| * |
| * @hide |
| */ |
| public static final int ERROR_INSECURE_USER = 23; |
| |
| /** |
| * Error thrown when attempting to use a recovery session that has since been closed. |
| * |
| * @hide |
| */ |
| public static final int ERROR_SESSION_EXPIRED = 24; |
| |
| /** |
| * Failed because the format of the provided certificate is incorrect, e.g., cannot be decoded |
| * properly or misses necessary fields. |
| * |
| * <p>Note that this is different from {@link #ERROR_INVALID_CERTIFICATE}, which implies the |
| * certificate has a correct format but cannot be validated. |
| * |
| * @hide |
| */ |
| public static final int ERROR_BAD_CERTIFICATE_FORMAT = 25; |
| |
| /** |
| * Error thrown if decryption failed. This might be because the tag is wrong, the key is wrong, |
| * the data has become corrupted, the data has been tampered with, etc. |
| * |
| * @hide |
| */ |
| public static final int ERROR_DECRYPTION_FAILED = 26; |
| |
| /** |
| * Error thrown if the format of a given key is invalid. This might be because the key has a |
| * wrong length, invalid content, etc. |
| * |
| * @hide |
| */ |
| public static final int ERROR_INVALID_KEY_FORMAT = 27; |
| |
| /** |
| * Failed because the provided certificate cannot be validated, e.g., is expired or has invalid |
| * signatures. |
| * |
| * <p>Note that this is different from {@link #ERROR_BAD_CERTIFICATE_FORMAT}, which denotes |
| * incorrect certificate formats, e.g., due to wrong encoding or structure. |
| * |
| * @hide |
| */ |
| public static final int ERROR_INVALID_CERTIFICATE = 28; |
| |
| private final ILockSettings mBinder; |
| private final KeyStore mKeyStore; |
| |
| private RecoveryController(ILockSettings binder, KeyStore keystore) { |
| mBinder = binder; |
| mKeyStore = keystore; |
| } |
| |
| /** |
| * Internal method used by {@code RecoverySession}. |
| * |
| * @hide |
| */ |
| ILockSettings getBinder() { |
| return mBinder; |
| } |
| |
| /** |
| * Gets a new instance of the class. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public static RecoveryController getInstance(Context context) { |
| ILockSettings lockSettings = |
| ILockSettings.Stub.asInterface(ServiceManager.getService("lock_settings")); |
| return new RecoveryController(lockSettings, KeyStore.getInstance()); |
| } |
| |
| /** |
| * @deprecated Use {@link #initRecoveryService(String, byte[], byte[])} instead. |
| */ |
| @Deprecated |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void initRecoveryService( |
| @NonNull String rootCertificateAlias, @NonNull byte[] signedPublicKeyList) |
| throws CertificateException, InternalRecoveryServiceException { |
| try { |
| mBinder.initRecoveryService(rootCertificateAlias, signedPublicKeyList); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| if (e.errorCode == ERROR_BAD_CERTIFICATE_FORMAT |
| || e.errorCode == ERROR_INVALID_CERTIFICATE) { |
| throw new CertificateException(e.getMessage()); |
| } |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Initializes the recovery service for the calling application. The detailed steps should be: |
| * <ol> |
| * <li>Parse {@code signatureFile} to get relevant information. |
| * <li>Validate the signer's X509 certificate, contained in {@code signatureFile}, against |
| * the root certificate pre-installed in the OS and chosen by {@code |
| * rootCertificateAlias}. |
| * <li>Verify the public-key signature, contained in {@code signatureFile}, and verify it |
| * against the entire {@code certificateFile}. |
| * <li>Parse {@code certificateFile} to get relevant information. |
| * <li>Check the serial number, contained in {@code certificateFile}, and skip the following |
| * steps if the serial number is not larger than the one previously stored. |
| * <li>Randomly choose a X509 certificate from the endpoint X509 certificates, contained in |
| * {@code certificateFile}, and validate it against the root certificate pre-installed |
| * in the OS and chosen by {@code rootCertificateAlias}. |
| * <li>Store the chosen X509 certificate and the serial in local database for later use. |
| * </ol> |
| * |
| * @param rootCertificateAlias the alias of a root certificate pre-installed in the OS |
| * @param certificateFile the binary content of the XML file containing a list of recovery |
| * service X509 certificates, and other metadata including the serial number |
| * @param signatureFile the binary content of the XML file containing the public-key signature |
| * of the entire certificate file, and a signer's X509 certificate |
| * @throws CertificateException if the given certificate files cannot be parsed or validated |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void initRecoveryService( |
| @NonNull String rootCertificateAlias, @NonNull byte[] certificateFile, |
| @NonNull byte[] signatureFile) |
| throws CertificateException, InternalRecoveryServiceException { |
| try { |
| mBinder.initRecoveryServiceWithSigFile( |
| rootCertificateAlias, certificateFile, signatureFile); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| if (e.errorCode == ERROR_BAD_CERTIFICATE_FORMAT |
| || e.errorCode == ERROR_INVALID_CERTIFICATE) { |
| throw new CertificateException(e.getMessage()); |
| } |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * @deprecated Use {@link #getKeyChainSnapshot()} |
| */ |
| @Deprecated |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public @Nullable KeyChainSnapshot getRecoveryData() throws InternalRecoveryServiceException { |
| return getKeyChainSnapshot(); |
| } |
| |
| /** |
| * Returns data necessary to store all recoverable keys. Key material is |
| * encrypted with user secret and recovery public key. |
| * |
| * @return Data necessary to recover keystore or {@code null} if snapshot is not available. |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public @Nullable KeyChainSnapshot getKeyChainSnapshot() |
| throws InternalRecoveryServiceException { |
| try { |
| return mBinder.getKeyChainSnapshot(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| if (e.errorCode == ERROR_NO_SNAPSHOT_PENDING) { |
| return null; |
| } |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Sets a listener which notifies recovery agent that new recovery snapshot is available. {@link |
| * #getRecoveryData} can be used to get the snapshot. Note that every recovery agent can have at |
| * most one registered listener at any time. |
| * |
| * @param intent triggered when new snapshot is available. Unregisters listener if the value is |
| * {@code null}. |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void setSnapshotCreatedPendingIntent(@Nullable PendingIntent intent) |
| throws InternalRecoveryServiceException { |
| try { |
| mBinder.setSnapshotCreatedPendingIntent(intent); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Server parameters used to generate new recovery key blobs. This value will be included in |
| * {@code KeyChainSnapshot.getEncryptedRecoveryKeyBlob()}. The same value must be included |
| * in vaultParams {@link RecoverySession#start(CertPath, byte[], byte[], List)}. |
| * |
| * @param serverParams included in recovery key blob. |
| * @see #getRecoveryData |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void setServerParams(byte[] serverParams) throws InternalRecoveryServiceException { |
| try { |
| mBinder.setServerParams(serverParams); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * @deprecated Use {@link #getAliases()}. |
| */ |
| @Deprecated |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public List<String> getAliases(@Nullable String packageName) |
| throws InternalRecoveryServiceException { |
| return getAliases(); |
| } |
| |
| /** |
| * Returns a list of aliases of keys belonging to the application. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public List<String> getAliases() throws InternalRecoveryServiceException { |
| try { |
| Map<String, Integer> allStatuses = mBinder.getRecoveryStatus(); |
| return new ArrayList<>(allStatuses.keySet()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * @deprecated Use {@link #setRecoveryStatus(String, int)} |
| */ |
| @Deprecated |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void setRecoveryStatus( |
| @NonNull String packageName, String alias, int status) |
| throws NameNotFoundException, InternalRecoveryServiceException { |
| setRecoveryStatus(alias, status); |
| } |
| |
| /** |
| * Sets the recovery status for given key. It is used to notify the keystore that the key was |
| * successfully stored on the server or that there was an error. An application can check this |
| * value using {@link #getRecoveryStatus(String, String)}. |
| * |
| * @param alias The alias of the key whose status to set. |
| * @param status The status of the key. One of {@link #RECOVERY_STATUS_SYNCED}, |
| * {@link #RECOVERY_STATUS_SYNC_IN_PROGRESS} or {@link #RECOVERY_STATUS_PERMANENT_FAILURE}. |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void setRecoveryStatus(String alias, int status) |
| throws InternalRecoveryServiceException { |
| try { |
| mBinder.setRecoveryStatus(alias, status); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * @deprecated Use {@link #getRecoveryStatus(String)}. |
| */ |
| @Deprecated |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public int getRecoveryStatus(String packageName, String alias) |
| throws InternalRecoveryServiceException { |
| return getRecoveryStatus(alias); |
| } |
| |
| /** |
| * Returns the recovery status for the key with the given {@code alias}. |
| * |
| * <ul> |
| * <li>{@link #RECOVERY_STATUS_SYNCED} |
| * <li>{@link #RECOVERY_STATUS_SYNC_IN_PROGRESS} |
| * <li>{@link #RECOVERY_STATUS_PERMANENT_FAILURE} |
| * </ul> |
| * |
| * @see #setRecoveryStatus(String, int) |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public int getRecoveryStatus(String alias) throws InternalRecoveryServiceException { |
| try { |
| Map<String, Integer> allStatuses = mBinder.getRecoveryStatus(); |
| Integer status = allStatuses.get(alias); |
| if (status == null) { |
| return RecoveryController.RECOVERY_STATUS_PERMANENT_FAILURE; |
| } else { |
| return status; |
| } |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Specifies a set of secret types used for end-to-end keystore encryption. Knowing all of them |
| * is necessary to recover data. |
| * |
| * @param secretTypes {@link KeyChainProtectionParams#TYPE_LOCKSCREEN} or {@link |
| * KeyChainProtectionParams#TYPE_CUSTOM_PASSWORD} |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void setRecoverySecretTypes( |
| @NonNull @KeyChainProtectionParams.UserSecretType int[] secretTypes) |
| throws InternalRecoveryServiceException { |
| try { |
| mBinder.setRecoverySecretTypes(secretTypes); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Defines a set of secret types used for end-to-end keystore encryption. Knowing all of them is |
| * necessary to generate KeyChainSnapshot. |
| * |
| * @return list of recovery secret types |
| * @see KeyChainSnapshot |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public @NonNull @KeyChainProtectionParams.UserSecretType int[] getRecoverySecretTypes() |
| throws InternalRecoveryServiceException { |
| try { |
| return mBinder.getRecoverySecretTypes(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Returns a list of recovery secret types, necessary to create a pending recovery snapshot. |
| * When user enters a secret of a pending type {@link #recoverySecretAvailable} should be |
| * called. |
| * |
| * @return list of recovery secret types |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @NonNull |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public @KeyChainProtectionParams.UserSecretType int[] getPendingRecoverySecretTypes() |
| throws InternalRecoveryServiceException { |
| try { |
| return mBinder.getPendingRecoverySecretTypes(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Method notifies KeyStore that a user-generated secret is available. This method generates a |
| * symmetric session key which a trusted remote device can use to return a recovery key. Caller |
| * should use {@link KeyChainProtectionParams#clearSecret} to override the secret value in |
| * memory. |
| * |
| * @param recoverySecret user generated secret together with parameters necessary to regenerate |
| * it on a new device. |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void recoverySecretAvailable(@NonNull KeyChainProtectionParams recoverySecret) |
| throws InternalRecoveryServiceException { |
| try { |
| mBinder.recoverySecretAvailable(recoverySecret); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Deprecated. |
| * Generates a AES256/GCM/NoPADDING key called {@code alias} and loads it into the recoverable |
| * key store. Returns the raw material of the key. |
| * |
| * @param alias The key alias. |
| * @param account The account associated with the key |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| * @throws LockScreenRequiredException if the user has not set a lock screen. This is required |
| * to generate recoverable keys, as the snapshots are encrypted using a key derived from the |
| * lock screen. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public byte[] generateAndStoreKey(@NonNull String alias, byte[] account) |
| throws InternalRecoveryServiceException, LockScreenRequiredException { |
| try { |
| return mBinder.generateAndStoreKey(alias); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| if (e.errorCode == ERROR_INSECURE_USER) { |
| throw new LockScreenRequiredException(e.getMessage()); |
| } |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * @deprecated Use {@link #generateKey(String)}. |
| */ |
| @Deprecated |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public Key generateKey(@NonNull String alias, byte[] account) |
| throws InternalRecoveryServiceException, LockScreenRequiredException { |
| return generateKey(alias); |
| } |
| |
| /** |
| * Generates a recoverable key with the given {@code alias}. |
| * |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| * @throws LockScreenRequiredException if the user does not have a lock screen set. A lock |
| * screen is required to generate recoverable keys. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public Key generateKey(@NonNull String alias) throws InternalRecoveryServiceException, |
| LockScreenRequiredException { |
| try { |
| String grantAlias = mBinder.generateKey(alias); |
| if (grantAlias == null) { |
| throw new InternalRecoveryServiceException("null grant alias"); |
| } |
| return AndroidKeyStoreProvider.loadAndroidKeyStoreKeyFromKeystore( |
| mKeyStore, |
| grantAlias, |
| KeyStore.UID_SELF); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (UnrecoverableKeyException e) { |
| throw new InternalRecoveryServiceException("Failed to get key from keystore", e); |
| } catch (ServiceSpecificException e) { |
| if (e.errorCode == ERROR_INSECURE_USER) { |
| throw new LockScreenRequiredException(e.getMessage()); |
| } |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Imports a 256-bit recoverable AES key with the given {@code alias} and the raw bytes {@code |
| * keyBytes}. |
| * |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| * @throws LockScreenRequiredException if the user does not have a lock screen set. A lock |
| * screen is required to generate recoverable keys. |
| * |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public Key importKey(@NonNull String alias, byte[] keyBytes) |
| throws InternalRecoveryServiceException, LockScreenRequiredException { |
| try { |
| String grantAlias = mBinder.importKey(alias, keyBytes); |
| if (grantAlias == null) { |
| throw new InternalRecoveryServiceException("Null grant alias"); |
| } |
| return AndroidKeyStoreProvider.loadAndroidKeyStoreKeyFromKeystore( |
| mKeyStore, |
| grantAlias, |
| KeyStore.UID_SELF); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (UnrecoverableKeyException e) { |
| throw new InternalRecoveryServiceException("Failed to get key from keystore", e); |
| } catch (ServiceSpecificException e) { |
| if (e.errorCode == ERROR_INSECURE_USER) { |
| throw new LockScreenRequiredException(e.getMessage()); |
| } |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Gets a key called {@code alias} from the recoverable key store. |
| * |
| * @param alias The key alias. |
| * @return The key. |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| * @throws UnrecoverableKeyException if key is permanently invalidated or not found. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public @Nullable Key getKey(@NonNull String alias) |
| throws InternalRecoveryServiceException, UnrecoverableKeyException { |
| try { |
| String grantAlias = mBinder.getKey(alias); |
| if (grantAlias == null) { |
| return null; |
| } |
| return AndroidKeyStoreProvider.loadAndroidKeyStoreKeyFromKeystore( |
| mKeyStore, |
| grantAlias, |
| KeyStore.UID_SELF); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Removes a key called {@code alias} from the recoverable key store. |
| * |
| * @param alias The key alias. |
| * @throws InternalRecoveryServiceException if an unexpected error occurred in the recovery |
| * service. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public void removeKey(@NonNull String alias) throws InternalRecoveryServiceException { |
| try { |
| mBinder.removeKey(alias); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } catch (ServiceSpecificException e) { |
| throw wrapUnexpectedServiceSpecificException(e); |
| } |
| } |
| |
| /** |
| * Returns a new {@link RecoverySession}. |
| * |
| * <p>A recovery session is required to restore keys from a remote store. |
| */ |
| @RequiresPermission(android.Manifest.permission.RECOVER_KEYSTORE) |
| public RecoverySession createRecoverySession() { |
| return RecoverySession.newInstance(this); |
| } |
| |
| InternalRecoveryServiceException wrapUnexpectedServiceSpecificException( |
| ServiceSpecificException e) { |
| if (e.errorCode == ERROR_SERVICE_INTERNAL_ERROR) { |
| return new InternalRecoveryServiceException(e.getMessage()); |
| } |
| |
| // Should never happen. If it does, it's a bug, and we need to update how the method that |
| // called this throws its exceptions. |
| return new InternalRecoveryServiceException("Unexpected error code for method: " |
| + e.errorCode, e); |
| } |
| } |