Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 1 | /* |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 2 | * Copyright (C) 2016 The Android Open Source Project |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 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 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 17 | #define LOG_TAG "keystore" |
| 18 | |
Shawn Willden | fa5702f | 2017-12-03 15:14:58 -0700 | [diff] [blame] | 19 | #include "KeyStore.h" |
Kenny Root | 07438c8 | 2012-11-02 15:41:02 -0700 | [diff] [blame] | 20 | |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 21 | #include <dirent.h> |
| 22 | #include <fcntl.h> |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 23 | |
Kenny Root | 822c3a9 | 2012-03-23 16:34:39 -0700 | [diff] [blame] | 24 | #include <openssl/bio.h> |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 25 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 26 | #include <utils/String16.h> |
Janis Danisevskis | 6905c33 | 2017-09-01 13:24:23 -0700 | [diff] [blame] | 27 | #include <utils/String8.h> |
Kenny Root | 70e3a86 | 2012-02-15 17:20:23 -0800 | [diff] [blame] | 28 | |
Pavel Grafov | cef3947 | 2018-02-12 18:45:02 +0000 | [diff] [blame] | 29 | #include <android-base/scopeguard.h> |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 30 | #include <android/hardware/keymaster/3.0/IKeymasterDevice.h> |
Rob Barnes | bb6cabd | 2018-10-04 17:10:37 -0600 | [diff] [blame] | 31 | #include <android/security/keystore/IKeystoreService.h> |
Pavel Grafov | ff311b4 | 2018-01-24 20:34:37 +0000 | [diff] [blame] | 32 | #include <log/log_event_list.h> |
| 33 | |
| 34 | #include <private/android_logger.h> |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 35 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 36 | #include "keystore_utils.h" |
| 37 | #include "permissions.h" |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 38 | #include <keystore/keystore_hidl_support.h> |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 39 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 40 | #include "keymaster_worker.h" |
| 41 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 42 | namespace keystore { |
| 43 | |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 44 | const char* KeyStore::kOldMasterKey = ".masterkey"; |
| 45 | const char* KeyStore::kMetaDataFile = ".metadata"; |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 46 | |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 47 | const android::String16 KeyStore::kRsaKeyType("RSA"); |
| 48 | const android::String16 KeyStore::kEcKeyType("EC"); |
Riley Spahn | eaabae9 | 2014-06-30 12:39:52 -0700 | [diff] [blame] | 49 | |
Janis Danisevskis | 6905c33 | 2017-09-01 13:24:23 -0700 | [diff] [blame] | 50 | using android::String8; |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 51 | |
Branden Archer | 44d1afa | 2018-12-28 09:10:49 -0800 | [diff] [blame] | 52 | KeyStore::KeyStore(const KeymasterDevices& kmDevices, |
Janis Danisevskis | c146014 | 2017-12-18 16:48:46 -0800 | [diff] [blame] | 53 | SecurityLevel minimalAllowedSecurityLevelForNewKeys) |
Branden Archer | 44d1afa | 2018-12-28 09:10:49 -0800 | [diff] [blame] | 54 | : mAllowNewFallback(minimalAllowedSecurityLevelForNewKeys == SecurityLevel::SOFTWARE), |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 55 | mConfirmationManager(new ConfirmationManager(this)) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 56 | memset(&mMetaData, '\0', sizeof(mMetaData)); |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 57 | |
| 58 | static_assert(std::tuple_size<std::decay_t<decltype(kmDevices)>>::value == |
| 59 | std::tuple_size<decltype(mKmDevices)>::value, |
| 60 | "KmasterDevices and KeymasterWorkers must have the same size"); |
| 61 | for (size_t i = 0; i < kmDevices.size(); ++i) { |
| 62 | if (kmDevices[SecurityLevel(i)]) { |
| 63 | mKmDevices[SecurityLevel(i)] = |
| 64 | std::make_shared<KeymasterWorker>(kmDevices[SecurityLevel(i)], this); |
| 65 | } |
| 66 | } |
Kenny Root | 70e3a86 | 2012-02-15 17:20:23 -0800 | [diff] [blame] | 67 | } |
| 68 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 69 | KeyStore::~KeyStore() { |
Shawn Willden | 55268b5 | 2015-07-28 11:06:00 -0600 | [diff] [blame] | 70 | } |
| 71 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 72 | ResponseCode KeyStore::initialize() { |
| 73 | readMetaData(); |
| 74 | if (upgradeKeystore()) { |
| 75 | writeMetaData(); |
Shawn Willden | 55268b5 | 2015-07-28 11:06:00 -0600 | [diff] [blame] | 76 | } |
| 77 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 78 | return ResponseCode::NO_ERROR; |
Shawn Willden | 55268b5 | 2015-07-28 11:06:00 -0600 | [diff] [blame] | 79 | } |
| 80 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 81 | ResponseCode KeyStore::initializeUser(const android::String8& pw, uid_t userId) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 82 | auto userState = mUserStateDB.getUserState(userId); |
Branden Archer | 44d1afa | 2018-12-28 09:10:49 -0800 | [diff] [blame] | 83 | return userState->initialize(pw); |
Chad Brubaker | fc18edc | 2015-01-12 15:17:18 -0800 | [diff] [blame] | 84 | } |
| 85 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 86 | ResponseCode KeyStore::copyMasterKey(uid_t srcUser, uid_t dstUser) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 87 | auto userState = mUserStateDB.getUserState(dstUser); |
| 88 | auto initState = mUserStateDB.getUserState(srcUser); |
| 89 | return userState->copyMasterKey(&initState); |
Kenny Root | 70e3a86 | 2012-02-15 17:20:23 -0800 | [diff] [blame] | 90 | } |
| 91 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 92 | ResponseCode KeyStore::writeMasterKey(const android::String8& pw, uid_t userId) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 93 | auto userState = mUserStateDB.getUserState(userId); |
Branden Archer | 44d1afa | 2018-12-28 09:10:49 -0800 | [diff] [blame] | 94 | return userState->writeMasterKey(pw); |
Shawn Willden | 55268b5 | 2015-07-28 11:06:00 -0600 | [diff] [blame] | 95 | } |
| 96 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 97 | ResponseCode KeyStore::readMasterKey(const android::String8& pw, uid_t userId) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 98 | auto userState = mUserStateDB.getUserState(userId); |
Branden Archer | 44d1afa | 2018-12-28 09:10:49 -0800 | [diff] [blame] | 99 | return userState->readMasterKey(pw); |
Kenny Root | 4946890 | 2013-03-19 13:41:33 -0700 | [diff] [blame] | 100 | } |
| 101 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 102 | LockedKeyBlobEntry KeyStore::getLockedBlobEntryIfNotExists(const std::string& alias, uid_t uid) { |
| 103 | KeyBlobEntry kbe(alias, mUserStateDB.getUserStateByUid(uid)->getUserDirName(), uid); |
| 104 | auto result = LockedKeyBlobEntry::get(std::move(kbe)); |
| 105 | if (result->hasKeyBlob()) return {}; |
| 106 | return result; |
Kenny Root | 655b958 | 2013-04-04 08:37:42 -0700 | [diff] [blame] | 107 | } |
| 108 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 109 | std::optional<KeyBlobEntry> KeyStore::getBlobEntryIfExists(const std::string& alias, uid_t uid) { |
| 110 | KeyBlobEntry kbe(alias, mUserStateDB.getUserStateByUid(uid)->getUserDirName(), uid); |
| 111 | if (kbe.hasKeyBlob()) return kbe; |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 112 | |
| 113 | // If this is one of the legacy UID->UID mappings, use it. |
| 114 | uid_t euid = get_keystore_euid(uid); |
| 115 | if (euid != uid) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 116 | kbe = KeyBlobEntry(alias, mUserStateDB.getUserStateByUid(euid)->getUserDirName(), euid); |
| 117 | if (kbe.hasKeyBlob()) return kbe; |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | // They might be using a granted key. |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 121 | auto grant = mGrants.get(uid, alias); |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 122 | if (grant) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 123 | kbe = grant->entry_; |
| 124 | if (kbe.hasKeyBlob()) return kbe; |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 125 | } |
| 126 | return {}; |
| 127 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 128 | LockedKeyBlobEntry KeyStore::getLockedBlobEntryIfExists(const std::string& alias, uid_t uid) { |
| 129 | auto blobentry = getBlobEntryIfExists(alias, uid); |
| 130 | if (!blobentry) return {}; |
| 131 | LockedKeyBlobEntry lockedentry = LockedKeyBlobEntry::get(std::move(*blobentry)); |
| 132 | if (!lockedentry || !lockedentry->hasKeyBlob()) return {}; |
| 133 | return lockedentry; |
| 134 | } |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 135 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 136 | void KeyStore::resetUser(uid_t userId, bool keepUnenryptedEntries) { |
| 137 | android::String8 prefix(""); |
| 138 | android::Vector<android::String16> aliases; |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 139 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 140 | auto userState = mUserStateDB.getUserState(userId); |
| 141 | std::string userDirName = userState->getUserDirName(); |
| 142 | auto encryptionKey = userState->getEncryptionKey(); |
| 143 | auto state = userState->getState(); |
Janis Danisevskis | 265435f | 2018-11-16 14:10:46 -0800 | [diff] [blame] | 144 | // userState is a proxy that holds a lock which may be required by a worker. |
| 145 | // LockedKeyBlobEntry::list has a fence that waits until all workers have finished which may |
| 146 | // not happen if a user state lock is held. The following line relinquishes the lock. |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 147 | userState = {}; |
| 148 | |
| 149 | ResponseCode rc; |
| 150 | std::list<LockedKeyBlobEntry> matches; |
| 151 | |
| 152 | // must not be called by a keymaster worker. List waits for workers to relinquish all access |
| 153 | // to blob entries |
| 154 | std::tie(rc, matches) = LockedKeyBlobEntry::list(userDirName); |
| 155 | if (rc != ResponseCode::NO_ERROR) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 156 | return; |
| 157 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 158 | |
| 159 | for (LockedKeyBlobEntry& lockedEntry : matches) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 160 | bool shouldDelete = true; |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 161 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 162 | if (keepUnenryptedEntries) { |
| 163 | Blob blob; |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 164 | Blob charBlob; |
| 165 | ResponseCode rc; |
| 166 | |
| 167 | std::tie(rc, blob, charBlob) = lockedEntry.readBlobs(encryptionKey, state); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 168 | |
Shawn Willden | 07aebe7 | 2017-02-28 13:53:24 -0700 | [diff] [blame] | 169 | switch (rc) { |
| 170 | case ResponseCode::SYSTEM_ERROR: |
| 171 | case ResponseCode::VALUE_CORRUPTED: |
| 172 | // If we can't read blobs, delete them. |
| 173 | shouldDelete = true; |
| 174 | break; |
| 175 | |
| 176 | case ResponseCode::NO_ERROR: |
| 177 | case ResponseCode::LOCKED: |
| 178 | // Delete encrypted blobs but keep unencrypted blobs and super-encrypted blobs. We |
| 179 | // need to keep super-encrypted blobs so we can report that the user is |
| 180 | // unauthenticated if a caller tries to use them, rather than reporting that they |
| 181 | // don't exist. |
| 182 | shouldDelete = blob.isEncrypted(); |
| 183 | break; |
| 184 | |
| 185 | default: |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 186 | ALOGE("Got unexpected return code %d from readBlobs", rc); |
Shawn Willden | 07aebe7 | 2017-02-28 13:53:24 -0700 | [diff] [blame] | 187 | // This shouldn't happen. To be on the safe side, delete it. |
| 188 | shouldDelete = true; |
| 189 | break; |
| 190 | } |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 191 | } |
| 192 | if (shouldDelete) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 193 | del(lockedEntry); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 194 | } |
| 195 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 196 | |
| 197 | userState = mUserStateDB.getUserState(userId); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 198 | if (!userState->deleteMasterKey()) { |
| 199 | ALOGE("Failed to delete user %d's master key", userId); |
| 200 | } |
| 201 | if (!keepUnenryptedEntries) { |
| 202 | if (!userState->reset()) { |
| 203 | ALOGE("Failed to remove user %d's directory", userId); |
| 204 | } |
| 205 | } |
| 206 | } |
| 207 | |
| 208 | bool KeyStore::isEmpty(uid_t userId) const { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 209 | std::string userDirName; |
| 210 | { |
Janis Danisevskis | 265435f | 2018-11-16 14:10:46 -0800 | [diff] [blame] | 211 | // userState holds a lock which must be relinquished before list is called. This scope |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 212 | // prevents deadlocks. |
| 213 | auto userState = mUserStateDB.getUserState(userId); |
| 214 | if (!userState) { |
| 215 | return true; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 216 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 217 | userDirName = userState->getUserDirName(); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 218 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 219 | |
| 220 | ResponseCode rc; |
| 221 | std::list<LockedKeyBlobEntry> matches; |
| 222 | |
| 223 | // must not be called by a keymaster worker. List waits for workers to relinquish all access |
| 224 | // to blob entries |
| 225 | std::tie(rc, matches) = LockedKeyBlobEntry::list(userDirName); |
| 226 | |
| 227 | return rc == ResponseCode::SYSTEM_ERROR || matches.size() == 0; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 228 | } |
| 229 | |
| 230 | void KeyStore::lock(uid_t userId) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 231 | auto userState = mUserStateDB.getUserState(userId); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 232 | userState->zeroizeMasterKeysInMemory(); |
| 233 | userState->setState(STATE_LOCKED); |
| 234 | } |
| 235 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 236 | static void maybeLogKeyIntegrityViolation(const LockedKeyBlobEntry& lockedEntry, |
| 237 | const BlobType type) { |
| 238 | if (!__android_log_security() || (type != TYPE_KEY_PAIR && type != TYPE_KEYMASTER_10)) return; |
| 239 | log_key_integrity_violation(lockedEntry->alias().c_str(), lockedEntry->uid()); |
| 240 | } |
Pavel Grafov | cef3947 | 2018-02-12 18:45:02 +0000 | [diff] [blame] | 241 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 242 | std::tuple<ResponseCode, Blob, Blob> KeyStore::get(const LockedKeyBlobEntry& blobfile) { |
| 243 | std::tuple<ResponseCode, Blob, Blob> result; |
Pavel Grafov | cef3947 | 2018-02-12 18:45:02 +0000 | [diff] [blame] | 244 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 245 | uid_t userId = get_user_id(blobfile->uid()); |
| 246 | Blob& keyBlob = std::get<1>(result); |
| 247 | ResponseCode& rc = std::get<0>(result); |
| 248 | |
| 249 | auto userState = mUserStateDB.getUserState(userId); |
| 250 | BlobType type = BlobType::TYPE_ANY; |
Pavel Grafov | cef3947 | 2018-02-12 18:45:02 +0000 | [diff] [blame] | 251 | auto logOnScopeExit = android::base::make_scope_guard([&] { |
| 252 | if (rc == ResponseCode::VALUE_CORRUPTED) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 253 | maybeLogKeyIntegrityViolation(blobfile, type); |
Pavel Grafov | cef3947 | 2018-02-12 18:45:02 +0000 | [diff] [blame] | 254 | } |
| 255 | }); |
| 256 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 257 | result = blobfile.readBlobs(userState->getEncryptionKey(), userState->getState()); |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 258 | if (rc != ResponseCode::NO_ERROR) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 259 | return result; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 260 | } |
| 261 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 262 | // update the type for logging (see scope_guard above) |
| 263 | type = keyBlob.getType(); |
| 264 | |
| 265 | const uint8_t version = keyBlob.getVersion(); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 266 | if (version < CURRENT_BLOB_VERSION) { |
| 267 | /* If we upgrade the key, we need to write it to disk again. Then |
| 268 | * it must be read it again since the blob is encrypted each time |
| 269 | * it's written. |
| 270 | */ |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 271 | if (upgradeBlob(&keyBlob, version)) { |
| 272 | if ((rc = this->put(blobfile, keyBlob, {})) != ResponseCode::NO_ERROR || |
| 273 | (result = blobfile.readBlobs(userState->getEncryptionKey(), userState->getState()), |
| 274 | rc) != ResponseCode::NO_ERROR) { |
| 275 | return result; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 276 | } |
| 277 | } |
| 278 | } |
| 279 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 280 | return result; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 281 | } |
| 282 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 283 | ResponseCode KeyStore::put(const LockedKeyBlobEntry& blobfile, Blob keyBlob, |
| 284 | Blob characteristicsBlob) { |
| 285 | auto userState = mUserStateDB.getUserStateByUid(blobfile->uid()); |
| 286 | return blobfile.writeBlobs(std::move(keyBlob), std::move(characteristicsBlob), |
Branden Archer | 44d1afa | 2018-12-28 09:10:49 -0800 | [diff] [blame] | 287 | userState->getEncryptionKey(), userState->getState()); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 288 | } |
| 289 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 290 | ResponseCode KeyStore::del(const LockedKeyBlobEntry& blobfile) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 291 | Blob keyBlob; |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 292 | Blob charactaristicsBlob; |
| 293 | ResponseCode rc; |
| 294 | uid_t uid = blobfile->uid(); |
| 295 | std::string alias = blobfile->alias(); |
| 296 | |
| 297 | std::tie(rc, keyBlob, charactaristicsBlob) = get(blobfile); |
| 298 | |
| 299 | // after getting the blob from the file system we scrub the filesystem. |
| 300 | mGrants.removeAllGrantsToKey(uid, alias); |
| 301 | auto result = blobfile.deleteBlobs(); |
| 302 | |
Janis Danisevskis | c7a9fa2 | 2016-10-13 18:43:45 +0100 | [diff] [blame] | 303 | if (rc != ResponseCode::NO_ERROR) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 304 | LOG(ERROR) << "get keyblob failed " << int(rc); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 305 | return rc; |
| 306 | } |
| 307 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 308 | // if we got the blob successfully, we try and delete it from the keymaster device |
Janis Danisevskis | c146014 | 2017-12-18 16:48:46 -0800 | [diff] [blame] | 309 | auto dev = getDevice(keyBlob); |
Janis Danisevskis | 69c434a | 2017-01-30 10:27:10 +0000 | [diff] [blame] | 310 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 311 | if (keyBlob.getType() == ::TYPE_KEYMASTER_10) { |
Janis Danisevskis | a359c67 | 2019-03-14 17:15:06 -0700 | [diff] [blame] | 312 | dev->deleteKey(blob2hidlVec(keyBlob), [dev, alias, uid](Return<ErrorCode> rc) { |
| 313 | auto ret = KS_HANDLE_HIDL_ERROR(dev, rc); |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 314 | // A device doesn't have to implement delete_key. |
| 315 | bool success = ret == ErrorCode::OK || ret == ErrorCode::UNIMPLEMENTED; |
| 316 | if (__android_log_security()) { |
| 317 | android_log_event_list(SEC_TAG_KEY_DESTROYED) |
| 318 | << int32_t(success) << alias << int32_t(uid) << LOG_ID_SECURITY; |
Kenny Root | 07438c8 | 2012-11-02 15:41:02 -0700 | [diff] [blame] | 319 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 320 | if (!success) { |
| 321 | LOG(ERROR) << "Keymaster delete for key " << alias << " of uid " << uid |
| 322 | << " failed"; |
Chad Brubaker | df70517 | 2015-06-17 20:17:51 -0700 | [diff] [blame] | 323 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 324 | }); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 325 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 326 | |
| 327 | return result; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 328 | } |
Chad Brubaker | 3a7d9e6 | 2015-06-04 15:01:46 -0700 | [diff] [blame] | 329 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 330 | std::string KeyStore::addGrant(const LockedKeyBlobEntry& blobfile, uid_t granteeUid) { |
| 331 | return mGrants.put(granteeUid, blobfile); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 332 | } |
Chad Brubaker | 3a7d9e6 | 2015-06-04 15:01:46 -0700 | [diff] [blame] | 333 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 334 | bool KeyStore::removeGrant(const LockedKeyBlobEntry& blobfile, const uid_t granteeUid) { |
| 335 | return mGrants.removeByFileAlias(granteeUid, blobfile); |
Janis Danisevskis | 31b44f2 | 2017-09-21 11:29:47 -0700 | [diff] [blame] | 336 | } |
| 337 | void KeyStore::removeAllGrantsToUid(const uid_t granteeUid) { |
| 338 | mGrants.removeAllGrantsToUid(granteeUid); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 339 | } |
Chad Brubaker | 3a7d9e6 | 2015-06-04 15:01:46 -0700 | [diff] [blame] | 340 | |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 341 | bool KeyStore::isHardwareBacked(const android::String16& keyType) const { |
Janis Danisevskis | c146014 | 2017-12-18 16:48:46 -0800 | [diff] [blame] | 342 | // if strongbox device is present TEE must also be present and of sufficiently high version |
| 343 | // to support all keys in hardware |
| 344 | if (getDevice(SecurityLevel::STRONGBOX)) return true; |
| 345 | if (!getDevice(SecurityLevel::TRUSTED_ENVIRONMENT)) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 346 | ALOGW("can't get keymaster device"); |
| 347 | return false; |
| 348 | } |
Janis Danisevskis | e2b6caf | 2017-03-02 16:37:10 -0800 | [diff] [blame] | 349 | |
Janis Danisevskis | c146014 | 2017-12-18 16:48:46 -0800 | [diff] [blame] | 350 | auto version = getDevice(SecurityLevel::TRUSTED_ENVIRONMENT)->halVersion(); |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 351 | if (keyType == kRsaKeyType) return true; // All versions support RSA |
| 352 | return keyType == kEcKeyType && version.supportsEc; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 353 | } |
| 354 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 355 | std::tuple<ResponseCode, Blob, Blob, LockedKeyBlobEntry> |
| 356 | KeyStore::getKeyForName(const android::String8& keyName, const uid_t uid, const BlobType type) { |
| 357 | std::tuple<ResponseCode, Blob, Blob, LockedKeyBlobEntry> result; |
| 358 | auto& [rc, keyBlob, charBlob, lockedEntry] = result; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 359 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 360 | lockedEntry = getLockedBlobEntryIfExists(keyName.string(), uid); |
Riley Spahn | eaabae9 | 2014-06-30 12:39:52 -0700 | [diff] [blame] | 361 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 362 | if (!lockedEntry) return rc = ResponseCode::KEY_NOT_FOUND, std::move(result); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 363 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 364 | std::tie(rc, keyBlob, charBlob) = get(lockedEntry); |
| 365 | |
| 366 | if (rc == ResponseCode::NO_ERROR) { |
| 367 | if (keyBlob.getType() != type) return rc = ResponseCode::KEY_NOT_FOUND, std::move(result); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 368 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 369 | return result; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 370 | } |
| 371 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 372 | bool KeyStore::upgradeBlob(Blob* blob, const uint8_t oldVersion) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 373 | bool updated = false; |
| 374 | uint8_t version = oldVersion; |
| 375 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 376 | if (!blob || !(*blob)) return false; |
| 377 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 378 | /* From V0 -> V1: All old types were unknown */ |
| 379 | if (version == 0) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 380 | ALOGE("Failed to upgrade key blob. Ancient blob version 0 is no longer supported"); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 381 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 382 | return false; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 383 | } |
| 384 | |
| 385 | /* From V1 -> V2: All old keys were encrypted */ |
| 386 | if (version == 1) { |
| 387 | ALOGV("upgrading to version 2"); |
| 388 | |
| 389 | blob->setEncrypted(true); |
| 390 | version = 2; |
| 391 | updated = true; |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 392 | } |
Kenny Root | 07438c8 | 2012-11-02 15:41:02 -0700 | [diff] [blame] | 393 | |
| 394 | /* |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 395 | * If we've updated, set the key blob to the right version |
| 396 | * and write it. |
Kenny Root | 07438c8 | 2012-11-02 15:41:02 -0700 | [diff] [blame] | 397 | */ |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 398 | if (updated) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 399 | blob->setVersion(version); |
| 400 | } |
Kenny Root | 70e3a86 | 2012-02-15 17:20:23 -0800 | [diff] [blame] | 401 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 402 | return updated; |
| 403 | } |
| 404 | |
| 405 | struct BIO_Delete { |
| 406 | void operator()(BIO* p) const { BIO_free(p); } |
| 407 | }; |
Janis Danisevskis | ccfff10 | 2017-05-01 11:02:51 -0700 | [diff] [blame] | 408 | typedef std::unique_ptr<BIO, BIO_Delete> Unique_BIO; |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 409 | |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 410 | void KeyStore::readMetaData() { |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 411 | int in = TEMP_FAILURE_RETRY(open(kMetaDataFile, O_RDONLY)); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 412 | if (in < 0) { |
| 413 | return; |
| 414 | } |
| 415 | size_t fileLength = readFully(in, (uint8_t*)&mMetaData, sizeof(mMetaData)); |
| 416 | if (fileLength != sizeof(mMetaData)) { |
| 417 | ALOGI("Metadata file is %zd bytes (%zd experted); upgrade?", fileLength, sizeof(mMetaData)); |
| 418 | } |
| 419 | close(in); |
| 420 | } |
| 421 | |
| 422 | void KeyStore::writeMetaData() { |
| 423 | const char* tmpFileName = ".metadata.tmp"; |
| 424 | int out = |
| 425 | TEMP_FAILURE_RETRY(open(tmpFileName, O_WRONLY | O_TRUNC | O_CREAT, S_IRUSR | S_IWUSR)); |
| 426 | if (out < 0) { |
| 427 | ALOGE("couldn't write metadata file: %s", strerror(errno)); |
| 428 | return; |
| 429 | } |
| 430 | size_t fileLength = writeFully(out, (uint8_t*)&mMetaData, sizeof(mMetaData)); |
| 431 | if (fileLength != sizeof(mMetaData)) { |
| 432 | ALOGI("Could only write %zd bytes to metadata file (%zd expected)", fileLength, |
| 433 | sizeof(mMetaData)); |
| 434 | } |
| 435 | close(out); |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 436 | rename(tmpFileName, kMetaDataFile); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 437 | } |
| 438 | |
| 439 | bool KeyStore::upgradeKeystore() { |
| 440 | bool upgraded = false; |
| 441 | |
| 442 | if (mMetaData.version == 0) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 443 | auto userState = getUserStateDB().getUserStateByUid(0); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 444 | |
| 445 | // Initialize first so the directory is made. |
| 446 | userState->initialize(); |
| 447 | |
| 448 | // Migrate the old .masterkey file to user 0. |
Shawn Willden | 0329a82 | 2017-12-04 13:55:14 -0700 | [diff] [blame] | 449 | if (access(kOldMasterKey, R_OK) == 0) { |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 450 | if (rename(kOldMasterKey, userState->getMasterKeyFileName().c_str()) < 0) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 451 | ALOGE("couldn't migrate old masterkey: %s", strerror(errno)); |
| 452 | return false; |
| 453 | } |
| 454 | } |
| 455 | |
| 456 | // Initialize again in case we had a key. |
| 457 | userState->initialize(); |
| 458 | |
| 459 | // Try to migrate existing keys. |
| 460 | DIR* dir = opendir("."); |
| 461 | if (!dir) { |
| 462 | // Give up now; maybe we can upgrade later. |
| 463 | ALOGE("couldn't open keystore's directory; something is wrong"); |
| 464 | return false; |
| 465 | } |
| 466 | |
| 467 | struct dirent* file; |
Yi Kong | e353f25 | 2018-07-30 01:38:39 -0700 | [diff] [blame] | 468 | while ((file = readdir(dir)) != nullptr) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 469 | // We only care about files. |
| 470 | if (file->d_type != DT_REG) { |
| 471 | continue; |
| 472 | } |
| 473 | |
| 474 | // Skip anything that starts with a "." |
| 475 | if (file->d_name[0] == '.') { |
| 476 | continue; |
| 477 | } |
| 478 | |
| 479 | // Find the current file's user. |
| 480 | char* end; |
| 481 | unsigned long thisUid = strtoul(file->d_name, &end, 10); |
| 482 | if (end[0] != '_' || end[1] == 0) { |
| 483 | continue; |
| 484 | } |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 485 | auto otherUser = getUserStateDB().getUserStateByUid(thisUid); |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 486 | if (otherUser->getUserId() != 0) { |
| 487 | unlinkat(dirfd(dir), file->d_name, 0); |
| 488 | } |
| 489 | |
| 490 | // Rename the file into user directory. |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 491 | DIR* otherdir = opendir(otherUser->getUserDirName().c_str()); |
Yi Kong | e353f25 | 2018-07-30 01:38:39 -0700 | [diff] [blame] | 492 | if (otherdir == nullptr) { |
Shawn Willden | c1d1fee | 2016-01-26 22:44:56 -0700 | [diff] [blame] | 493 | ALOGW("couldn't open user directory for rename"); |
| 494 | continue; |
| 495 | } |
| 496 | if (renameat(dirfd(dir), file->d_name, dirfd(otherdir), file->d_name) < 0) { |
| 497 | ALOGW("couldn't rename blob: %s: %s", file->d_name, strerror(errno)); |
| 498 | } |
| 499 | closedir(otherdir); |
| 500 | } |
| 501 | closedir(dir); |
| 502 | |
| 503 | mMetaData.version = 1; |
| 504 | upgraded = true; |
| 505 | } |
| 506 | |
| 507 | return upgraded; |
Kenny Root | a91203b | 2012-02-15 15:00:46 -0800 | [diff] [blame] | 508 | } |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 509 | |
Janis Danisevskis | ff3d7f4 | 2018-10-08 07:15:09 -0700 | [diff] [blame] | 510 | void KeyStore::binderDied(const ::android::wp<IBinder>& who) { |
| 511 | for (unsigned i = 0; i < mKmDevices.size(); ++i) { |
| 512 | if (mKmDevices[SecurityLevel(i)]) mKmDevices[SecurityLevel(i)]->binderDied(who); |
| 513 | } |
| 514 | getConfirmationManager().binderDied(who); |
Pavel Grafov | cef3947 | 2018-02-12 18:45:02 +0000 | [diff] [blame] | 515 | } |
| 516 | |
Shawn Willden | c67a8aa | 2017-12-03 17:51:29 -0700 | [diff] [blame] | 517 | } // namespace keystore |