Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2009 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.security; |
| 18 | |
Svetoslav | 2dac95d | 2015-04-30 11:30:33 -0700 | [diff] [blame] | 19 | import android.app.ActivityThread; |
| 20 | import android.app.Application; |
Alex Klyubin | 5418393 | 2015-05-08 15:25:48 -0700 | [diff] [blame] | 21 | import android.app.KeyguardManager; |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 22 | import android.content.Context; |
Kevin Chyn | 5596642 | 2017-10-23 16:08:47 -0700 | [diff] [blame] | 23 | import android.content.pm.PackageManager; |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 24 | import android.hardware.fingerprint.FingerprintManager; |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 25 | import android.os.Binder; |
| 26 | import android.os.IBinder; |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 27 | import android.os.Process; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 28 | import android.os.RemoteException; |
| 29 | import android.os.ServiceManager; |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 30 | import android.os.UserHandle; |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 31 | import android.security.keymaster.ExportResult; |
| 32 | import android.security.keymaster.KeyCharacteristics; |
| 33 | import android.security.keymaster.KeymasterArguments; |
Chad Brubaker | 5e73c0e | 2015-03-21 22:46:43 -0700 | [diff] [blame] | 34 | import android.security.keymaster.KeymasterBlob; |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 35 | import android.security.keymaster.KeymasterCertificateChain; |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 36 | import android.security.keymaster.KeymasterDefs; |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 37 | import android.security.keymaster.OperationResult; |
Alex Klyubin | 3f8d4d8 | 2015-05-13 09:15:00 -0700 | [diff] [blame] | 38 | import android.security.keystore.KeyExpiredException; |
| 39 | import android.security.keystore.KeyNotYetValidException; |
| 40 | import android.security.keystore.KeyPermanentlyInvalidatedException; |
Alex Klyubin | 3f8d4d8 | 2015-05-13 09:15:00 -0700 | [diff] [blame] | 41 | import android.security.keystore.UserNotAuthenticatedException; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 42 | import android.util.Log; |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 43 | |
Alex Klyubin | ae6cb7a | 2015-06-22 18:09:35 -0700 | [diff] [blame] | 44 | import java.math.BigInteger; |
Alex Klyubin | ad9ba10 | 2015-04-21 15:17:24 -0700 | [diff] [blame] | 45 | import java.security.InvalidKeyException; |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 46 | import java.util.List; |
Kenny Root | b91773b | 2013-09-05 13:03:16 -0700 | [diff] [blame] | 47 | import java.util.Locale; |
| 48 | |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 49 | /** |
Brian Carlstrom | 46703b0 | 2011-04-06 15:41:29 -0700 | [diff] [blame] | 50 | * @hide This should not be made public in its present form because it |
| 51 | * assumes that private and secret key bytes are available and would |
| 52 | * preclude the use of hardware crypto. |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 53 | */ |
| 54 | public class KeyStore { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 55 | private static final String TAG = "KeyStore"; |
Brian Carlstrom | 5cfee3f | 2011-05-31 01:00:15 -0700 | [diff] [blame] | 56 | |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 57 | // ResponseCodes - see system/security/keystore/include/keystore/keystore.h |
Brian Carlstrom | 7e4b1a4 | 2011-06-01 15:29:29 -0700 | [diff] [blame] | 58 | public static final int NO_ERROR = 1; |
| 59 | public static final int LOCKED = 2; |
| 60 | public static final int UNINITIALIZED = 3; |
| 61 | public static final int SYSTEM_ERROR = 4; |
| 62 | public static final int PROTOCOL_ERROR = 5; |
| 63 | public static final int PERMISSION_DENIED = 6; |
| 64 | public static final int KEY_NOT_FOUND = 7; |
| 65 | public static final int VALUE_CORRUPTED = 8; |
| 66 | public static final int UNDEFINED_ACTION = 9; |
| 67 | public static final int WRONG_PASSWORD = 10; |
Brian Carlstrom | 5cfee3f | 2011-05-31 01:00:15 -0700 | [diff] [blame] | 68 | |
Chad Brubaker | 560d653 | 2015-04-24 10:32:18 -0700 | [diff] [blame] | 69 | /** |
| 70 | * Per operation authentication is needed before this operation is valid. |
| 71 | * This is returned from {@link #begin} when begin succeeds but the operation uses |
| 72 | * per-operation authentication and must authenticate before calling {@link #update} or |
| 73 | * {@link #finish}. |
| 74 | */ |
| 75 | public static final int OP_AUTH_NEEDED = 15; |
| 76 | |
Kenny Root | 2eeda72 | 2013-04-10 11:30:58 -0700 | [diff] [blame] | 77 | // Used for UID field to indicate the calling UID. |
| 78 | public static final int UID_SELF = -1; |
| 79 | |
| 80 | // Flags for "put" "import" and "generate" |
| 81 | public static final int FLAG_NONE = 0; |
Alex Klyubin | 5418393 | 2015-05-08 15:25:48 -0700 | [diff] [blame] | 82 | |
| 83 | /** |
| 84 | * Indicates that this key (or key pair) must be encrypted at rest. This will protect the key |
| 85 | * (or key pair) with the secure lock screen credential (e.g., password, PIN, or pattern). |
| 86 | * |
| 87 | * <p>Note that this requires that the secure lock screen (e.g., password, PIN, pattern) is set |
| 88 | * up, otherwise key (or key pair) generation or import will fail. Moreover, this key (or key |
| 89 | * pair) will be deleted when the secure lock screen is disabled or reset (e.g., by the user or |
| 90 | * a Device Administrator). Finally, this key (or key pair) cannot be used until the user |
| 91 | * unlocks the secure lock screen after boot. |
| 92 | * |
| 93 | * @see KeyguardManager#isDeviceSecure() |
| 94 | */ |
Kenny Root | a3788b0 | 2013-04-10 10:37:55 -0700 | [diff] [blame] | 95 | public static final int FLAG_ENCRYPTED = 1; |
| 96 | |
Rubin Xu | 12b644d | 2017-04-21 19:21:42 +0100 | [diff] [blame] | 97 | /** |
Janis Danisevskis | 0aadf93 | 2017-12-18 17:28:52 -0800 | [diff] [blame] | 98 | * Select Software keymaster device, which as of this writing is the lowest security |
| 99 | * level available on an android device. If neither FLAG_STRONGBOX nor FLAG_SOFTWARE is provided |
| 100 | * A TEE based keymaster implementation is implied. |
| 101 | * |
| 102 | * Need to be in sync with KeyStoreFlag in system/security/keystore/include/keystore/keystore.h |
| 103 | * For historical reasons this corresponds to the KEYSTORE_FLAG_FALLBACK flag. |
| 104 | */ |
| 105 | public static final int FLAG_SOFTWARE = 1 << 1; |
| 106 | |
| 107 | /** |
Rubin Xu | 12b644d | 2017-04-21 19:21:42 +0100 | [diff] [blame] | 108 | * A private flag that's only available to system server to indicate that this key is part of |
| 109 | * device encryption flow so it receives special treatment from keystore. For example this key |
| 110 | * will not be super encrypted, and it will be stored separately under an unique UID instead |
| 111 | * of the caller UID i.e. SYSTEM. |
| 112 | * |
| 113 | * Need to be in sync with KeyStoreFlag in system/security/keystore/include/keystore/keystore.h |
| 114 | */ |
| 115 | public static final int FLAG_CRITICAL_TO_DEVICE_ENCRYPTION = 1 << 3; |
| 116 | |
Janis Danisevskis | 0aadf93 | 2017-12-18 17:28:52 -0800 | [diff] [blame] | 117 | /** |
| 118 | * Select Strongbox keymaster device, which as of this writing the the highest security level |
| 119 | * available an android devices. If neither FLAG_STRONGBOX nor FLAG_SOFTWARE is provided |
| 120 | * A TEE based keymaster implementation is implied. |
| 121 | * |
| 122 | * Need to be in sync with KeyStoreFlag in system/security/keystore/include/keystore/keystore.h |
| 123 | */ |
| 124 | public static final int FLAG_STRONGBOX = 1 << 4; |
| 125 | |
| 126 | |
Brian Carlstrom | 5cfee3f | 2011-05-31 01:00:15 -0700 | [diff] [blame] | 127 | // States |
| 128 | public enum State { UNLOCKED, LOCKED, UNINITIALIZED }; |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 129 | |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 130 | private int mError = NO_ERROR; |
| 131 | |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 132 | private final IKeystoreService mBinder; |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 133 | private final Context mContext; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 134 | |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 135 | private IBinder mToken; |
| 136 | |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 137 | private KeyStore(IKeystoreService binder) { |
| 138 | mBinder = binder; |
Alex Klyubin | 3f8d4d8 | 2015-05-13 09:15:00 -0700 | [diff] [blame] | 139 | mContext = getApplicationContext(); |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 140 | } |
| 141 | |
Alex Klyubin | dcdaf87 | 2015-05-13 15:57:09 -0700 | [diff] [blame] | 142 | public static Context getApplicationContext() { |
Alex Klyubin | a99b8b5 | 2015-06-11 13:27:34 -0700 | [diff] [blame] | 143 | Application application = ActivityThread.currentApplication(); |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 144 | if (application == null) { |
| 145 | throw new IllegalStateException( |
Alex Klyubin | a99b8b5 | 2015-06-11 13:27:34 -0700 | [diff] [blame] | 146 | "Failed to obtain application Context from ActivityThread"); |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 147 | } |
| 148 | return application; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 149 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 150 | |
| 151 | public static KeyStore getInstance() { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 152 | IKeystoreService keystore = IKeystoreService.Stub.asInterface(ServiceManager |
| 153 | .getService("android.security.keystore")); |
| 154 | return new KeyStore(keystore); |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 155 | } |
| 156 | |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 157 | private synchronized IBinder getToken() { |
| 158 | if (mToken == null) { |
| 159 | mToken = new Binder(); |
| 160 | } |
| 161 | return mToken; |
| 162 | } |
| 163 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 164 | public State state(int userId) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 165 | final int ret; |
| 166 | try { |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 167 | ret = mBinder.getState(userId); |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 168 | } catch (RemoteException e) { |
| 169 | Log.w(TAG, "Cannot connect to keystore", e); |
| 170 | throw new AssertionError(e); |
| 171 | } |
| 172 | |
| 173 | switch (ret) { |
Brian Carlstrom | 5cfee3f | 2011-05-31 01:00:15 -0700 | [diff] [blame] | 174 | case NO_ERROR: return State.UNLOCKED; |
| 175 | case LOCKED: return State.LOCKED; |
| 176 | case UNINITIALIZED: return State.UNINITIALIZED; |
| 177 | default: throw new AssertionError(mError); |
| 178 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 179 | } |
| 180 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 181 | public State state() { |
| 182 | return state(UserHandle.myUserId()); |
| 183 | } |
| 184 | |
Kenny Root | b9594ce | 2013-02-14 10:18:38 -0800 | [diff] [blame] | 185 | public boolean isUnlocked() { |
| 186 | return state() == State.UNLOCKED; |
| 187 | } |
| 188 | |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 189 | public byte[] get(String key, int uid) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 190 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 191 | key = key != null ? key : ""; |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 192 | return mBinder.get(key, uid); |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 193 | } catch (RemoteException e) { |
| 194 | Log.w(TAG, "Cannot connect to keystore", e); |
| 195 | return null; |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 196 | } catch (android.os.ServiceSpecificException e) { |
| 197 | Log.w(TAG, "KeyStore exception", e); |
| 198 | return null; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 199 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 200 | } |
| 201 | |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 202 | public byte[] get(String key) { |
| 203 | return get(key, UID_SELF); |
| 204 | } |
| 205 | |
Kenny Root | a3788b0 | 2013-04-10 10:37:55 -0700 | [diff] [blame] | 206 | public boolean put(String key, byte[] value, int uid, int flags) { |
Alex Klyubin | 3ceb1a0 | 2015-06-05 15:51:06 -0700 | [diff] [blame] | 207 | return insert(key, value, uid, flags) == NO_ERROR; |
| 208 | } |
| 209 | |
| 210 | public int insert(String key, byte[] value, int uid, int flags) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 211 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 212 | if (value == null) { |
| 213 | value = new byte[0]; |
| 214 | } |
Alex Klyubin | 3ceb1a0 | 2015-06-05 15:51:06 -0700 | [diff] [blame] | 215 | return mBinder.insert(key, value, uid, flags); |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 216 | } catch (RemoteException e) { |
| 217 | Log.w(TAG, "Cannot connect to keystore", e); |
Alex Klyubin | 3ceb1a0 | 2015-06-05 15:51:06 -0700 | [diff] [blame] | 218 | return SYSTEM_ERROR; |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 219 | } |
| 220 | } |
| 221 | |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 222 | public boolean delete(String key, int uid) { |
| 223 | try { |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 224 | int ret = mBinder.del(key, uid); |
| 225 | return (ret == NO_ERROR || ret == KEY_NOT_FOUND); |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 226 | } catch (RemoteException e) { |
| 227 | Log.w(TAG, "Cannot connect to keystore", e); |
| 228 | return false; |
| 229 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | public boolean delete(String key) { |
Kenny Root | 2eeda72 | 2013-04-10 11:30:58 -0700 | [diff] [blame] | 233 | return delete(key, UID_SELF); |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 234 | } |
| 235 | |
| 236 | public boolean contains(String key, int uid) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 237 | try { |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 238 | return mBinder.exist(key, uid) == NO_ERROR; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 239 | } catch (RemoteException e) { |
| 240 | Log.w(TAG, "Cannot connect to keystore", e); |
| 241 | return false; |
| 242 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 243 | } |
| 244 | |
| 245 | public boolean contains(String key) { |
Kenny Root | 2eeda72 | 2013-04-10 11:30:58 -0700 | [diff] [blame] | 246 | return contains(key, UID_SELF); |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 247 | } |
| 248 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 249 | /** |
| 250 | * List all entries in the keystore for {@code uid} starting with {@code prefix}. |
| 251 | */ |
| 252 | public String[] list(String prefix, int uid) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 253 | try { |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 254 | return mBinder.list(prefix, uid); |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 255 | } catch (RemoteException e) { |
| 256 | Log.w(TAG, "Cannot connect to keystore", e); |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 257 | return null; |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 258 | } catch (android.os.ServiceSpecificException e) { |
| 259 | Log.w(TAG, "KeyStore exception", e); |
| 260 | return null; |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 261 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 262 | } |
| 263 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 264 | public String[] list(String prefix) { |
| 265 | return list(prefix, UID_SELF); |
| 266 | } |
| 267 | |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 268 | public boolean reset() { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 269 | try { |
| 270 | return mBinder.reset() == NO_ERROR; |
| 271 | } catch (RemoteException e) { |
| 272 | Log.w(TAG, "Cannot connect to keystore", e); |
| 273 | return false; |
| 274 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 275 | } |
| 276 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 277 | /** |
| 278 | * Attempt to lock the keystore for {@code user}. |
| 279 | * |
| 280 | * @param user Android user to lock. |
| 281 | * @return whether {@code user}'s keystore was locked. |
| 282 | */ |
| 283 | public boolean lock(int userId) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 284 | try { |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 285 | return mBinder.lock(userId) == NO_ERROR; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 286 | } catch (RemoteException e) { |
| 287 | Log.w(TAG, "Cannot connect to keystore", e); |
| 288 | return false; |
| 289 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 290 | } |
| 291 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 292 | public boolean lock() { |
| 293 | return lock(UserHandle.myUserId()); |
| 294 | } |
| 295 | |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 296 | /** |
| 297 | * Attempt to unlock the keystore for {@code user} with the password {@code password}. |
| 298 | * This is required before keystore entries created with FLAG_ENCRYPTED can be accessed or |
| 299 | * created. |
| 300 | * |
| 301 | * @param user Android user ID to operate on |
| 302 | * @param password user's keystore password. Should be the most recent value passed to |
| 303 | * {@link #onUserPasswordChanged} for the user. |
| 304 | * |
| 305 | * @return whether the keystore was unlocked. |
| 306 | */ |
| 307 | public boolean unlock(int userId, String password) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 308 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 309 | password = password != null ? password : ""; |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 310 | mError = mBinder.unlock(userId, password); |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 311 | return mError == NO_ERROR; |
| 312 | } catch (RemoteException e) { |
| 313 | Log.w(TAG, "Cannot connect to keystore", e); |
| 314 | return false; |
| 315 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 316 | } |
| 317 | |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 318 | public boolean unlock(String password) { |
| 319 | return unlock(UserHandle.getUserId(Process.myUid()), password); |
| 320 | } |
| 321 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 322 | /** |
| 323 | * Check if the keystore for {@code userId} is empty. |
| 324 | */ |
| 325 | public boolean isEmpty(int userId) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 326 | try { |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 327 | return mBinder.isEmpty(userId) != 0; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 328 | } catch (RemoteException e) { |
| 329 | Log.w(TAG, "Cannot connect to keystore", e); |
| 330 | return false; |
| 331 | } |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 332 | } |
| 333 | |
Chad Brubaker | e35d49f | 2015-05-12 15:19:52 -0700 | [diff] [blame] | 334 | public boolean isEmpty() { |
| 335 | return isEmpty(UserHandle.myUserId()); |
| 336 | } |
| 337 | |
Kenny Root | a398598 | 2013-08-16 14:03:29 -0700 | [diff] [blame] | 338 | public boolean generate(String key, int uid, int keyType, int keySize, int flags, |
| 339 | byte[][] args) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 340 | try { |
Chad Brubaker | 7a2c973 | 2015-01-13 17:41:22 -0800 | [diff] [blame] | 341 | return mBinder.generate(key, uid, keyType, keySize, flags, |
| 342 | new KeystoreArguments(args)) == NO_ERROR; |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 343 | } catch (RemoteException e) { |
| 344 | Log.w(TAG, "Cannot connect to keystore", e); |
| 345 | return false; |
| 346 | } |
| 347 | } |
| 348 | |
Kenny Root | a3788b0 | 2013-04-10 10:37:55 -0700 | [diff] [blame] | 349 | public boolean importKey(String keyName, byte[] key, int uid, int flags) { |
Kenny Root | 78ad849 | 2013-02-13 17:02:57 -0800 | [diff] [blame] | 350 | try { |
Kenny Root | a3788b0 | 2013-04-10 10:37:55 -0700 | [diff] [blame] | 351 | return mBinder.import_key(keyName, key, uid, flags) == NO_ERROR; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 352 | } catch (RemoteException e) { |
| 353 | Log.w(TAG, "Cannot connect to keystore", e); |
| 354 | return false; |
| 355 | } |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 356 | } |
| 357 | |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 358 | public byte[] sign(String key, byte[] data) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 359 | try { |
| 360 | return mBinder.sign(key, data); |
| 361 | } catch (RemoteException e) { |
| 362 | Log.w(TAG, "Cannot connect to keystore", e); |
| 363 | return null; |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 364 | } catch (android.os.ServiceSpecificException e) { |
| 365 | Log.w(TAG, "KeyStore exception", e); |
| 366 | return null; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 367 | } |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 368 | |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 369 | } |
| 370 | |
| 371 | public boolean verify(String key, byte[] data, byte[] signature) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 372 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 373 | signature = signature != null ? signature : new byte[0]; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 374 | return mBinder.verify(key, data, signature) == NO_ERROR; |
| 375 | } catch (RemoteException e) { |
| 376 | Log.w(TAG, "Cannot connect to keystore", e); |
| 377 | return false; |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 378 | } catch (android.os.ServiceSpecificException e) { |
| 379 | Log.w(TAG, "KeyStore exception", e); |
| 380 | return false; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 381 | } |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 382 | |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 383 | } |
| 384 | |
Janis Danisevskis | b50e9f6 | 2017-06-08 17:53:34 -0700 | [diff] [blame] | 385 | public String grant(String key, int uid) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 386 | try { |
Janis Danisevskis | b50e9f6 | 2017-06-08 17:53:34 -0700 | [diff] [blame] | 387 | String grantAlias = mBinder.grant(key, uid); |
| 388 | if (grantAlias == "") return null; |
| 389 | return grantAlias; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 390 | } catch (RemoteException e) { |
| 391 | Log.w(TAG, "Cannot connect to keystore", e); |
Janis Danisevskis | b50e9f6 | 2017-06-08 17:53:34 -0700 | [diff] [blame] | 392 | return null; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 393 | } |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 394 | } |
| 395 | |
| 396 | public boolean ungrant(String key, int uid) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 397 | try { |
| 398 | return mBinder.ungrant(key, uid) == NO_ERROR; |
| 399 | } catch (RemoteException e) { |
| 400 | Log.w(TAG, "Cannot connect to keystore", e); |
| 401 | return false; |
Kenny Root | 473c712 | 2012-08-17 21:13:48 -0700 | [diff] [blame] | 402 | } |
Kenny Root | 473c712 | 2012-08-17 21:13:48 -0700 | [diff] [blame] | 403 | } |
| 404 | |
| 405 | /** |
| 406 | * Returns the last modification time of the key in milliseconds since the |
| 407 | * epoch. Will return -1L if the key could not be found or other error. |
| 408 | */ |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 409 | public long getmtime(String key, int uid) { |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 410 | try { |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 411 | final long millis = mBinder.getmtime(key, uid); |
Kenny Root | e66769a | 2013-02-04 15:49:11 -0800 | [diff] [blame] | 412 | if (millis == -1L) { |
| 413 | return -1L; |
| 414 | } |
| 415 | |
| 416 | return millis * 1000L; |
Kenny Root | 6b77645 | 2012-11-02 15:40:32 -0700 | [diff] [blame] | 417 | } catch (RemoteException e) { |
| 418 | Log.w(TAG, "Cannot connect to keystore", e); |
| 419 | return -1L; |
| 420 | } |
Kenny Root | 473c712 | 2012-08-17 21:13:48 -0700 | [diff] [blame] | 421 | } |
| 422 | |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 423 | public long getmtime(String key) { |
| 424 | return getmtime(key, UID_SELF); |
| 425 | } |
| 426 | |
Alex Klyubin | 469cbf5 | 2015-06-04 12:36:27 -0700 | [diff] [blame] | 427 | // TODO: remove this when it's removed from Settings |
Kenny Root | 5cb5cec | 2013-03-29 11:14:17 -0700 | [diff] [blame] | 428 | public boolean isHardwareBacked() { |
Kenny Root | b91773b | 2013-09-05 13:03:16 -0700 | [diff] [blame] | 429 | return isHardwareBacked("RSA"); |
| 430 | } |
| 431 | |
| 432 | public boolean isHardwareBacked(String keyType) { |
Kenny Root | 5cb5cec | 2013-03-29 11:14:17 -0700 | [diff] [blame] | 433 | try { |
Kenny Root | b91773b | 2013-09-05 13:03:16 -0700 | [diff] [blame] | 434 | return mBinder.is_hardware_backed(keyType.toUpperCase(Locale.US)) == NO_ERROR; |
Kenny Root | 5cb5cec | 2013-03-29 11:14:17 -0700 | [diff] [blame] | 435 | } catch (RemoteException e) { |
| 436 | Log.w(TAG, "Cannot connect to keystore", e); |
| 437 | return false; |
| 438 | } |
| 439 | } |
| 440 | |
Kenny Root | d72317a | 2013-04-01 15:59:59 -0700 | [diff] [blame] | 441 | public boolean clearUid(int uid) { |
| 442 | try { |
| 443 | return mBinder.clear_uid(uid) == NO_ERROR; |
| 444 | } catch (RemoteException e) { |
| 445 | Log.w(TAG, "Cannot connect to keystore", e); |
| 446 | return false; |
| 447 | } |
| 448 | } |
| 449 | |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 450 | public int getLastError() { |
| 451 | return mError; |
| 452 | } |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 453 | |
Janis Danisevskis | 0aadf93 | 2017-12-18 17:28:52 -0800 | [diff] [blame] | 454 | public boolean addRngEntropy(byte[] data, int flags) { |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 455 | try { |
Janis Danisevskis | 0aadf93 | 2017-12-18 17:28:52 -0800 | [diff] [blame] | 456 | return mBinder.addRngEntropy(data, flags) == NO_ERROR; |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 457 | } catch (RemoteException e) { |
| 458 | Log.w(TAG, "Cannot connect to keystore", e); |
| 459 | return false; |
| 460 | } |
| 461 | } |
| 462 | |
Chad Brubaker | dae79e5 | 2015-03-27 14:28:35 -0700 | [diff] [blame] | 463 | public int generateKey(String alias, KeymasterArguments args, byte[] entropy, int uid, |
| 464 | int flags, KeyCharacteristics outCharacteristics) { |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 465 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 466 | entropy = entropy != null ? entropy : new byte[0]; |
| 467 | args = args != null ? args : new KeymasterArguments(); |
Chad Brubaker | dae79e5 | 2015-03-27 14:28:35 -0700 | [diff] [blame] | 468 | return mBinder.generateKey(alias, args, entropy, uid, flags, outCharacteristics); |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 469 | } catch (RemoteException e) { |
| 470 | Log.w(TAG, "Cannot connect to keystore", e); |
| 471 | return SYSTEM_ERROR; |
| 472 | } |
| 473 | } |
| 474 | |
Chad Brubaker | dae79e5 | 2015-03-27 14:28:35 -0700 | [diff] [blame] | 475 | public int generateKey(String alias, KeymasterArguments args, byte[] entropy, int flags, |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 476 | KeyCharacteristics outCharacteristics) { |
Chad Brubaker | dae79e5 | 2015-03-27 14:28:35 -0700 | [diff] [blame] | 477 | return generateKey(alias, args, entropy, UID_SELF, flags, outCharacteristics); |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 478 | } |
| 479 | |
Chad Brubaker | 5e73c0e | 2015-03-21 22:46:43 -0700 | [diff] [blame] | 480 | public int getKeyCharacteristics(String alias, KeymasterBlob clientId, KeymasterBlob appId, |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 481 | int uid, KeyCharacteristics outCharacteristics) { |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 482 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 483 | clientId = clientId != null ? clientId : new KeymasterBlob(new byte[0]); |
| 484 | appId = appId != null ? appId : new KeymasterBlob(new byte[0]); |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 485 | return mBinder.getKeyCharacteristics(alias, clientId, appId, uid, outCharacteristics); |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 486 | } catch (RemoteException e) { |
| 487 | Log.w(TAG, "Cannot connect to keystore", e); |
| 488 | return SYSTEM_ERROR; |
| 489 | } |
| 490 | } |
| 491 | |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 492 | public int getKeyCharacteristics(String alias, KeymasterBlob clientId, KeymasterBlob appId, |
| 493 | KeyCharacteristics outCharacteristics) { |
| 494 | return getKeyCharacteristics(alias, clientId, appId, UID_SELF, outCharacteristics); |
| 495 | } |
| 496 | |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 497 | public int importKey(String alias, KeymasterArguments args, int format, byte[] keyData, |
| 498 | int uid, int flags, KeyCharacteristics outCharacteristics) { |
| 499 | try { |
| 500 | return mBinder.importKey(alias, args, format, keyData, uid, flags, |
| 501 | outCharacteristics); |
| 502 | } catch (RemoteException e) { |
| 503 | Log.w(TAG, "Cannot connect to keystore", e); |
| 504 | return SYSTEM_ERROR; |
| 505 | } |
| 506 | } |
| 507 | |
| 508 | public int importKey(String alias, KeymasterArguments args, int format, byte[] keyData, |
| 509 | int flags, KeyCharacteristics outCharacteristics) { |
| 510 | return importKey(alias, args, format, keyData, UID_SELF, flags, outCharacteristics); |
| 511 | } |
| 512 | |
Frank Salim | 21d9c1d | 2017-12-19 22:38:09 -0800 | [diff] [blame] | 513 | public int importWrappedKey(String wrappedKeyAlias, byte[] wrappedKey, |
| 514 | String wrappingKeyAlias, |
| 515 | byte[] maskingKey, KeymasterArguments args, long rootSid, long fingerprintSid, int uid, |
| 516 | KeyCharacteristics outCharacteristics) { |
| 517 | try { |
| 518 | return mBinder.importWrappedKey(wrappedKeyAlias, wrappedKey, wrappingKeyAlias, |
| 519 | maskingKey, args, rootSid, fingerprintSid, outCharacteristics); |
| 520 | } catch (RemoteException e) { |
| 521 | Log.w(TAG, "Cannot connect to keystore", e); |
| 522 | return SYSTEM_ERROR; |
| 523 | } |
| 524 | } |
| 525 | |
Chad Brubaker | 5e73c0e | 2015-03-21 22:46:43 -0700 | [diff] [blame] | 526 | public ExportResult exportKey(String alias, int format, KeymasterBlob clientId, |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 527 | KeymasterBlob appId, int uid) { |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 528 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 529 | clientId = clientId != null ? clientId : new KeymasterBlob(new byte[0]); |
| 530 | appId = appId != null ? appId : new KeymasterBlob(new byte[0]); |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 531 | return mBinder.exportKey(alias, format, clientId, appId, uid); |
| 532 | } catch (RemoteException e) { |
| 533 | Log.w(TAG, "Cannot connect to keystore", e); |
| 534 | return null; |
| 535 | } |
| 536 | } |
| 537 | public ExportResult exportKey(String alias, int format, KeymasterBlob clientId, |
| 538 | KeymasterBlob appId) { |
| 539 | return exportKey(alias, format, clientId, appId, UID_SELF); |
| 540 | } |
| 541 | |
| 542 | public OperationResult begin(String alias, int purpose, boolean pruneable, |
| 543 | KeymasterArguments args, byte[] entropy, int uid) { |
| 544 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 545 | args = args != null ? args : new KeymasterArguments(); |
| 546 | entropy = entropy != null ? entropy : new byte[0]; |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 547 | return mBinder.begin(getToken(), alias, purpose, pruneable, args, entropy, uid); |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 548 | } catch (RemoteException e) { |
| 549 | Log.w(TAG, "Cannot connect to keystore", e); |
| 550 | return null; |
| 551 | } |
| 552 | } |
| 553 | |
| 554 | public OperationResult begin(String alias, int purpose, boolean pruneable, |
Chad Brubaker | 966486e | 2015-06-01 12:57:06 -0700 | [diff] [blame] | 555 | KeymasterArguments args, byte[] entropy) { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 556 | entropy = entropy != null ? entropy : new byte[0]; |
| 557 | args = args != null ? args : new KeymasterArguments(); |
Chad Brubaker | 5bbf048 | 2015-09-09 14:53:52 -0700 | [diff] [blame] | 558 | return begin(alias, purpose, pruneable, args, entropy, UID_SELF); |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 559 | } |
| 560 | |
| 561 | public OperationResult update(IBinder token, KeymasterArguments arguments, byte[] input) { |
| 562 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 563 | arguments = arguments != null ? arguments : new KeymasterArguments(); |
| 564 | input = input != null ? input : new byte[0]; |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 565 | return mBinder.update(token, arguments, input); |
| 566 | } catch (RemoteException e) { |
| 567 | Log.w(TAG, "Cannot connect to keystore", e); |
| 568 | return null; |
| 569 | } |
| 570 | } |
| 571 | |
Chad Brubaker | 8a07701 | 2015-05-29 12:32:51 -0700 | [diff] [blame] | 572 | public OperationResult finish(IBinder token, KeymasterArguments arguments, byte[] signature, |
| 573 | byte[] entropy) { |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 574 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 575 | arguments = arguments != null ? arguments : new KeymasterArguments(); |
| 576 | entropy = entropy != null ? entropy : new byte[0]; |
| 577 | signature = signature != null ? signature : new byte[0]; |
Chad Brubaker | 8a07701 | 2015-05-29 12:32:51 -0700 | [diff] [blame] | 578 | return mBinder.finish(token, arguments, signature, entropy); |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 579 | } catch (RemoteException e) { |
| 580 | Log.w(TAG, "Cannot connect to keystore", e); |
| 581 | return null; |
| 582 | } |
| 583 | } |
| 584 | |
Chad Brubaker | 8a07701 | 2015-05-29 12:32:51 -0700 | [diff] [blame] | 585 | public OperationResult finish(IBinder token, KeymasterArguments arguments, byte[] signature) { |
| 586 | return finish(token, arguments, signature, null); |
| 587 | } |
| 588 | |
Chad Brubaker | e6a46134 | 2015-02-10 21:33:23 -0800 | [diff] [blame] | 589 | public int abort(IBinder token) { |
| 590 | try { |
| 591 | return mBinder.abort(token); |
| 592 | } catch (RemoteException e) { |
| 593 | Log.w(TAG, "Cannot connect to keystore", e); |
| 594 | return SYSTEM_ERROR; |
| 595 | } |
| 596 | } |
Chad Brubaker | 5654b36 | 2015-03-17 16:59:52 -0700 | [diff] [blame] | 597 | |
| 598 | /** |
| 599 | * Check if the operation referenced by {@code token} is currently authorized. |
| 600 | * |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 601 | * @param token An operation token returned by a call to |
| 602 | * {@link #begin(String, int, boolean, KeymasterArguments, byte[], KeymasterArguments) begin}. |
Chad Brubaker | 5654b36 | 2015-03-17 16:59:52 -0700 | [diff] [blame] | 603 | */ |
| 604 | public boolean isOperationAuthorized(IBinder token) { |
| 605 | try { |
| 606 | return mBinder.isOperationAuthorized(token); |
| 607 | } catch (RemoteException e) { |
| 608 | Log.w(TAG, "Cannot connect to keystore", e); |
| 609 | return false; |
| 610 | } |
| 611 | } |
| 612 | |
| 613 | /** |
| 614 | * Add an authentication record to the keystore authorization table. |
| 615 | * |
| 616 | * @param authToken The packed bytes of a hw_auth_token_t to be provided to keymaster. |
| 617 | * @return {@code KeyStore.NO_ERROR} on success, otherwise an error value corresponding to |
| 618 | * a {@code KeymasterDefs.KM_ERROR_} value or {@code KeyStore} ResponseCode. |
| 619 | */ |
| 620 | public int addAuthToken(byte[] authToken) { |
| 621 | try { |
| 622 | return mBinder.addAuthToken(authToken); |
| 623 | } catch (RemoteException e) { |
| 624 | Log.w(TAG, "Cannot connect to keystore", e); |
| 625 | return SYSTEM_ERROR; |
| 626 | } |
| 627 | } |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 628 | |
Alex Klyubin | ad9ba10 | 2015-04-21 15:17:24 -0700 | [diff] [blame] | 629 | /** |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 630 | * Notify keystore that a user's password has changed. |
| 631 | * |
| 632 | * @param userId the user whose password changed. |
| 633 | * @param newPassword the new password or "" if the password was removed. |
| 634 | */ |
| 635 | public boolean onUserPasswordChanged(int userId, String newPassword) { |
| 636 | // Parcel.cpp doesn't support deserializing null strings and treats them as "". Make that |
| 637 | // explicit here. |
| 638 | if (newPassword == null) { |
| 639 | newPassword = ""; |
| 640 | } |
| 641 | try { |
| 642 | return mBinder.onUserPasswordChanged(userId, newPassword) == NO_ERROR; |
| 643 | } catch (RemoteException e) { |
| 644 | Log.w(TAG, "Cannot connect to keystore", e); |
| 645 | return false; |
| 646 | } |
| 647 | } |
| 648 | |
Chad Brubaker | 83ce095 | 2015-05-12 13:00:02 -0700 | [diff] [blame] | 649 | /** |
| 650 | * Notify keystore that a user was added. |
| 651 | * |
| 652 | * @param userId the new user. |
| 653 | * @param parentId the parent of the new user, or -1 if the user has no parent. If parentId is |
| 654 | * specified then the new user's keystore will be intialized with the same secure lockscreen |
| 655 | * password as the parent. |
| 656 | */ |
| 657 | public void onUserAdded(int userId, int parentId) { |
| 658 | try { |
| 659 | mBinder.onUserAdded(userId, parentId); |
| 660 | } catch (RemoteException e) { |
| 661 | Log.w(TAG, "Cannot connect to keystore", e); |
| 662 | } |
| 663 | } |
| 664 | |
| 665 | /** |
| 666 | * Notify keystore that a user was added. |
| 667 | * |
| 668 | * @param userId the new user. |
| 669 | */ |
| 670 | public void onUserAdded(int userId) { |
| 671 | onUserAdded(userId, -1); |
| 672 | } |
| 673 | |
| 674 | /** |
| 675 | * Notify keystore that a user was removed. |
| 676 | * |
| 677 | * @param userId the removed user. |
| 678 | */ |
| 679 | public void onUserRemoved(int userId) { |
| 680 | try { |
| 681 | mBinder.onUserRemoved(userId); |
| 682 | } catch (RemoteException e) { |
| 683 | Log.w(TAG, "Cannot connect to keystore", e); |
| 684 | } |
| 685 | } |
| 686 | |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 687 | public boolean onUserPasswordChanged(String newPassword) { |
| 688 | return onUserPasswordChanged(UserHandle.getUserId(Process.myUid()), newPassword); |
| 689 | } |
| 690 | |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 691 | public int attestKey( |
| 692 | String alias, KeymasterArguments params, KeymasterCertificateChain outChain) { |
| 693 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 694 | if (params == null) { |
| 695 | params = new KeymasterArguments(); |
| 696 | } |
| 697 | if (outChain == null) { |
| 698 | outChain = new KeymasterCertificateChain(); |
| 699 | } |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 700 | return mBinder.attestKey(alias, params, outChain); |
| 701 | } catch (RemoteException e) { |
| 702 | Log.w(TAG, "Cannot connect to keystore", e); |
| 703 | return SYSTEM_ERROR; |
| 704 | } |
| 705 | } |
| 706 | |
Bartosz Fabianowski | 237f4b36 | 2017-04-24 13:57:46 +0200 | [diff] [blame] | 707 | public int attestDeviceIds(KeymasterArguments params, KeymasterCertificateChain outChain) { |
| 708 | try { |
Dmitry Dementyev | efc4311 | 2017-10-27 23:10:28 -0700 | [diff] [blame] | 709 | if (params == null) { |
| 710 | params = new KeymasterArguments(); |
| 711 | } |
| 712 | if (outChain == null) { |
| 713 | outChain = new KeymasterCertificateChain(); |
| 714 | } |
Bartosz Fabianowski | 237f4b36 | 2017-04-24 13:57:46 +0200 | [diff] [blame] | 715 | return mBinder.attestDeviceIds(params, outChain); |
| 716 | } catch (RemoteException e) { |
| 717 | Log.w(TAG, "Cannot connect to keystore", e); |
| 718 | return SYSTEM_ERROR; |
| 719 | } |
| 720 | } |
| 721 | |
Tucker Sylvestro | b32aae2 | 2016-06-23 17:23:33 -0400 | [diff] [blame] | 722 | /** |
| 723 | * Notify keystore that the device went off-body. |
| 724 | */ |
| 725 | public void onDeviceOffBody() { |
| 726 | try { |
| 727 | mBinder.onDeviceOffBody(); |
| 728 | } catch (RemoteException e) { |
| 729 | Log.w(TAG, "Cannot connect to keystore", e); |
| 730 | } |
| 731 | } |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 732 | |
Janis Danisevskis | 7dacad8 | 2018-01-24 15:12:11 -0800 | [diff] [blame^] | 733 | // Keep in sync with confirmationui/1.0/types.hal. |
| 734 | public static final int CONFIRMATIONUI_OK = 0; |
| 735 | public static final int CONFIRMATIONUI_CANCELED = 1; |
| 736 | public static final int CONFIRMATIONUI_ABORTED = 2; |
| 737 | public static final int CONFIRMATIONUI_OPERATION_PENDING = 3; |
| 738 | public static final int CONFIRMATIONUI_IGNORED = 4; |
| 739 | public static final int CONFIRMATIONUI_SYSTEM_ERROR = 5; |
| 740 | public static final int CONFIRMATIONUI_UNIMPLEMENTED = 6; |
| 741 | public static final int CONFIRMATIONUI_UNEXPECTED = 7; |
| 742 | public static final int CONFIRMATIONUI_UIERROR = 0x10000; |
| 743 | public static final int CONFIRMATIONUI_UIERROR_MISSING_GLYPH = 0x10001; |
| 744 | public static final int CONFIRMATIONUI_UIERROR_MESSAGE_TOO_LONG = 0x10002; |
| 745 | public static final int CONFIRMATIONUI_UIERROR_MALFORMED_UTF8_ENCODING = 0x10003; |
| 746 | |
| 747 | /** |
| 748 | * Requests keystore call into the confirmationui HAL to display a prompt. |
| 749 | * |
| 750 | * @param listener the binder to use for callbacks. |
| 751 | * @param promptText the prompt to display. |
| 752 | * @param extraData extra data / nonce from application. |
| 753 | * @param locale the locale as a BCP 47 langauge tag. |
| 754 | * @param uiOptionsAsFlags the UI options to use, as flags. |
| 755 | * @return one of the {@code CONFIRMATIONUI_*} constants, for |
| 756 | * example {@code KeyStore.CONFIRMATIONUI_OK}. |
| 757 | */ |
| 758 | public int presentConfirmationPrompt(IBinder listener, String promptText, byte[] extraData, |
| 759 | String locale, int uiOptionsAsFlags) { |
| 760 | try { |
| 761 | return mBinder.presentConfirmationPrompt(listener, promptText, extraData, locale, |
| 762 | uiOptionsAsFlags); |
| 763 | } catch (RemoteException e) { |
| 764 | Log.w(TAG, "Cannot connect to keystore", e); |
| 765 | return CONFIRMATIONUI_SYSTEM_ERROR; |
| 766 | } |
| 767 | } |
| 768 | |
| 769 | /** |
| 770 | * Requests keystore call into the confirmationui HAL to cancel displaying a prompt. |
| 771 | * |
| 772 | * @param listener the binder passed to the {@link #presentConfirmationPrompt} method. |
| 773 | * @return one of the {@code CONFIRMATIONUI_*} constants, for |
| 774 | * example {@code KeyStore.CONFIRMATIONUI_OK}. |
| 775 | */ |
| 776 | public int cancelConfirmationPrompt(IBinder listener) { |
| 777 | try { |
| 778 | return mBinder.cancelConfirmationPrompt(listener); |
| 779 | } catch (RemoteException e) { |
| 780 | Log.w(TAG, "Cannot connect to keystore", e); |
| 781 | return CONFIRMATIONUI_SYSTEM_ERROR; |
| 782 | } |
| 783 | } |
| 784 | |
Chad Brubaker | a91a850 | 2015-05-07 10:02:22 -0700 | [diff] [blame] | 785 | /** |
Alex Klyubin | ad9ba10 | 2015-04-21 15:17:24 -0700 | [diff] [blame] | 786 | * Returns a {@link KeyStoreException} corresponding to the provided keystore/keymaster error |
| 787 | * code. |
| 788 | */ |
Alex Klyubin | dcdaf87 | 2015-05-13 15:57:09 -0700 | [diff] [blame] | 789 | public static KeyStoreException getKeyStoreException(int errorCode) { |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 790 | if (errorCode > 0) { |
| 791 | // KeyStore layer error |
| 792 | switch (errorCode) { |
| 793 | case NO_ERROR: |
| 794 | return new KeyStoreException(errorCode, "OK"); |
| 795 | case LOCKED: |
Alex Klyubin | 5418393 | 2015-05-08 15:25:48 -0700 | [diff] [blame] | 796 | return new KeyStoreException(errorCode, "User authentication required"); |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 797 | case UNINITIALIZED: |
| 798 | return new KeyStoreException(errorCode, "Keystore not initialized"); |
| 799 | case SYSTEM_ERROR: |
| 800 | return new KeyStoreException(errorCode, "System error"); |
| 801 | case PERMISSION_DENIED: |
| 802 | return new KeyStoreException(errorCode, "Permission denied"); |
| 803 | case KEY_NOT_FOUND: |
| 804 | return new KeyStoreException(errorCode, "Key not found"); |
| 805 | case VALUE_CORRUPTED: |
| 806 | return new KeyStoreException(errorCode, "Key blob corrupted"); |
Alex Klyubin | 058de02 | 2015-04-29 17:32:00 -0700 | [diff] [blame] | 807 | case OP_AUTH_NEEDED: |
| 808 | return new KeyStoreException(errorCode, "Operation requires authorization"); |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 809 | default: |
| 810 | return new KeyStoreException(errorCode, String.valueOf(errorCode)); |
| 811 | } |
| 812 | } else { |
| 813 | // Keymaster layer error |
| 814 | switch (errorCode) { |
| 815 | case KeymasterDefs.KM_ERROR_INVALID_AUTHORIZATION_TIMEOUT: |
| 816 | // The name of this parameter significantly differs between Keymaster and |
| 817 | // framework APIs. Use the framework wording to make life easier for developers. |
| 818 | return new KeyStoreException(errorCode, |
| 819 | "Invalid user authentication validity duration"); |
| 820 | default: |
| 821 | return new KeyStoreException(errorCode, |
| 822 | KeymasterDefs.getErrorMessage(errorCode)); |
| 823 | } |
| 824 | } |
| 825 | } |
| 826 | |
Alex Klyubin | ad9ba10 | 2015-04-21 15:17:24 -0700 | [diff] [blame] | 827 | /** |
| 828 | * Returns an {@link InvalidKeyException} corresponding to the provided |
| 829 | * {@link KeyStoreException}. |
| 830 | */ |
Alex Klyubin | dcdaf87 | 2015-05-13 15:57:09 -0700 | [diff] [blame] | 831 | public InvalidKeyException getInvalidKeyException( |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 832 | String keystoreKeyAlias, int uid, KeyStoreException e) { |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 833 | switch (e.getErrorCode()) { |
Alex Klyubin | 5418393 | 2015-05-08 15:25:48 -0700 | [diff] [blame] | 834 | case LOCKED: |
| 835 | return new UserNotAuthenticatedException(); |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 836 | case KeymasterDefs.KM_ERROR_KEY_EXPIRED: |
| 837 | return new KeyExpiredException(); |
| 838 | case KeymasterDefs.KM_ERROR_KEY_NOT_YET_VALID: |
| 839 | return new KeyNotYetValidException(); |
| 840 | case KeymasterDefs.KM_ERROR_KEY_USER_NOT_AUTHENTICATED: |
Alex Klyubin | 058de02 | 2015-04-29 17:32:00 -0700 | [diff] [blame] | 841 | case OP_AUTH_NEEDED: |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 842 | { |
| 843 | // We now need to determine whether the key/operation can become usable if user |
| 844 | // authentication is performed, or whether it can never become usable again. |
| 845 | // User authentication requirements are contained in the key's characteristics. We |
| 846 | // need to check whether these requirements can be be satisfied by asking the user |
| 847 | // to authenticate. |
| 848 | KeyCharacteristics keyCharacteristics = new KeyCharacteristics(); |
| 849 | int getKeyCharacteristicsErrorCode = |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 850 | getKeyCharacteristics(keystoreKeyAlias, null, null, uid, |
| 851 | keyCharacteristics); |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 852 | if (getKeyCharacteristicsErrorCode != NO_ERROR) { |
| 853 | return new InvalidKeyException( |
| 854 | "Failed to obtained key characteristics", |
| 855 | getKeyStoreException(getKeyCharacteristicsErrorCode)); |
| 856 | } |
Alex Klyubin | ae6cb7a | 2015-06-22 18:09:35 -0700 | [diff] [blame] | 857 | List<BigInteger> keySids = |
| 858 | keyCharacteristics.getUnsignedLongs(KeymasterDefs.KM_TAG_USER_SECURE_ID); |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 859 | if (keySids.isEmpty()) { |
| 860 | // Key is not bound to any SIDs -- no amount of authentication will help here. |
| 861 | return new KeyPermanentlyInvalidatedException(); |
| 862 | } |
| 863 | long rootSid = GateKeeper.getSecureUserId(); |
Alex Klyubin | ae6cb7a | 2015-06-22 18:09:35 -0700 | [diff] [blame] | 864 | if ((rootSid != 0) && (keySids.contains(KeymasterArguments.toUint64(rootSid)))) { |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 865 | // One of the key's SIDs is the current root SID -- user can be authenticated |
| 866 | // against that SID. |
| 867 | return new UserNotAuthenticatedException(); |
| 868 | } |
| 869 | |
| 870 | long fingerprintOnlySid = getFingerprintOnlySid(); |
| 871 | if ((fingerprintOnlySid != 0) |
Alex Klyubin | ae6cb7a | 2015-06-22 18:09:35 -0700 | [diff] [blame] | 872 | && (keySids.contains(KeymasterArguments.toUint64(fingerprintOnlySid)))) { |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 873 | // One of the key's SIDs is the current fingerprint SID -- user can be |
| 874 | // authenticated against that SID. |
| 875 | return new UserNotAuthenticatedException(); |
| 876 | } |
| 877 | |
| 878 | // None of the key's SIDs can ever be authenticated |
| 879 | return new KeyPermanentlyInvalidatedException(); |
| 880 | } |
Janis Danisevskis | d07d338 | 2017-09-01 14:45:16 -0700 | [diff] [blame] | 881 | case UNINITIALIZED: |
| 882 | return new KeyPermanentlyInvalidatedException(); |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 883 | default: |
Alex Klyubin | ad9ba10 | 2015-04-21 15:17:24 -0700 | [diff] [blame] | 884 | return new InvalidKeyException("Keystore operation failed", e); |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 885 | } |
| 886 | } |
| 887 | |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 888 | private long getFingerprintOnlySid() { |
Kevin Chyn | 5596642 | 2017-10-23 16:08:47 -0700 | [diff] [blame] | 889 | final PackageManager packageManager = mContext.getPackageManager(); |
| 890 | if (!packageManager.hasSystemFeature(PackageManager.FEATURE_FINGERPRINT)) { |
| 891 | return 0; |
| 892 | } |
Alex Klyubin | a99b8b5 | 2015-06-11 13:27:34 -0700 | [diff] [blame] | 893 | FingerprintManager fingerprintManager = mContext.getSystemService(FingerprintManager.class); |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 894 | if (fingerprintManager == null) { |
Alex Klyubin | 708fc940 | 2015-04-28 18:58:47 -0700 | [diff] [blame] | 895 | return 0; |
| 896 | } |
| 897 | |
Alex Klyubin | a99b8b5 | 2015-06-11 13:27:34 -0700 | [diff] [blame] | 898 | // TODO: Restore USE_FINGERPRINT permission check in |
| 899 | // FingerprintManager.getAuthenticatorId once the ID is no longer needed here. |
Alex Klyubin | 2d7a85c | 2015-04-30 11:43:53 -0700 | [diff] [blame] | 900 | return fingerprintManager.getAuthenticatorId(); |
Svetoslav | 2dac95d | 2015-04-30 11:30:33 -0700 | [diff] [blame] | 901 | } |
| 902 | |
Alex Klyubin | ad9ba10 | 2015-04-21 15:17:24 -0700 | [diff] [blame] | 903 | /** |
| 904 | * Returns an {@link InvalidKeyException} corresponding to the provided keystore/keymaster error |
| 905 | * code. |
| 906 | */ |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 907 | public InvalidKeyException getInvalidKeyException(String keystoreKeyAlias, int uid, |
| 908 | int errorCode) { |
| 909 | return getInvalidKeyException(keystoreKeyAlias, uid, getKeyStoreException(errorCode)); |
Alex Klyubin | b4834ae | 2015-04-02 15:53:46 -0700 | [diff] [blame] | 910 | } |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 911 | } |