blob: 951536b1b1b4c44509f83cdbcee72ccbb6a22007 [file] [log] [blame]
Paul Crowley1ef25582016-01-21 20:26:12 +00001/*
2 * Copyright (C) 2016 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#include "KeyStorage.h"
18
Daniel Rosenbergd2906b82019-06-07 14:18:14 -070019#include "Checkpoint.h"
Paul Crowley1ef25582016-01-21 20:26:12 +000020#include "Keymaster.h"
Paul Crowley63c18d32016-02-10 14:02:47 +000021#include "ScryptParameters.h"
Paul Crowley1ef25582016-01-21 20:26:12 +000022#include "Utils.h"
23
Daniel Rosenberga48730a2019-06-06 20:38:38 -070024#include <thread>
Paul Crowley1ef25582016-01-21 20:26:12 +000025#include <vector>
26
27#include <errno.h>
Paul Crowleydff8c722016-05-16 08:14:56 -070028#include <stdio.h>
Paul Crowley1ef25582016-01-21 20:26:12 +000029#include <sys/stat.h>
30#include <sys/types.h>
31#include <sys/wait.h>
32#include <unistd.h>
33
Paul Crowley6ab2cab2017-01-04 22:32:40 -080034#include <openssl/err.h>
35#include <openssl/evp.h>
Paul Crowley1ef25582016-01-21 20:26:12 +000036#include <openssl/sha.h>
37
38#include <android-base/file.h>
39#include <android-base/logging.h>
Daniel Rosenberga48730a2019-06-06 20:38:38 -070040#include <android-base/properties.h>
Daniel Rosenbergd2906b82019-06-07 14:18:14 -070041#include <android-base/unique_fd.h>
Paul Crowley1ef25582016-01-21 20:26:12 +000042
Paul Crowley63c18d32016-02-10 14:02:47 +000043#include <cutils/properties.h>
44
Paul Crowley320e5e12016-03-04 14:07:05 -080045#include <hardware/hw_auth_token.h>
Shawn Willden35f0f222020-01-16 13:21:42 -070046#include <keymasterV4_1/authorization_set.h>
47#include <keymasterV4_1/keymaster_utils.h>
Paul Crowley320e5e12016-03-04 14:07:05 -080048
Paul Crowley63c18d32016-02-10 14:02:47 +000049extern "C" {
50
51#include "crypto_scrypt.h"
Paul Crowley63c18d32016-02-10 14:02:47 +000052}
53
Paul Crowley1ef25582016-01-21 20:26:12 +000054namespace android {
55namespace vold {
56
Paul Crowleydf528a72016-03-09 09:31:37 -080057const KeyAuthentication kEmptyAuthentication{"", ""};
Paul Crowley05720802016-02-08 15:55:41 +000058
Paul Crowley1ef25582016-01-21 20:26:12 +000059static constexpr size_t AES_KEY_BYTES = 32;
60static constexpr size_t GCM_NONCE_BYTES = 12;
61static constexpr size_t GCM_MAC_BYTES = 16;
Paul Crowleydf528a72016-03-09 09:31:37 -080062static constexpr size_t SALT_BYTES = 1 << 4;
63static constexpr size_t SECDISCARDABLE_BYTES = 1 << 14;
64static constexpr size_t STRETCHED_BYTES = 1 << 6;
Paul Crowley1ef25582016-01-21 20:26:12 +000065
Shawn Willden785365b2018-01-20 09:37:36 -070066static constexpr uint32_t AUTH_TIMEOUT = 30; // Seconds
Paul Crowleyb3de3372016-04-27 12:58:41 -070067
Paul Crowley05720802016-02-08 15:55:41 +000068static const char* kCurrentVersion = "1";
Paul Crowley1ef25582016-01-21 20:26:12 +000069static const char* kRmPath = "/system/bin/rm";
70static const char* kSecdiscardPath = "/system/bin/secdiscard";
Paul Crowley63c18d32016-02-10 14:02:47 +000071static const char* kStretch_none = "none";
72static const char* kStretch_nopassword = "nopassword";
73static const std::string kStretchPrefix_scrypt = "scrypt ";
Paul Crowley6ab2cab2017-01-04 22:32:40 -080074static const char* kHashPrefix_secdiscardable = "Android secdiscardable SHA512";
75static const char* kHashPrefix_keygen = "Android key wrapping key generation SHA512";
Paul Crowley1ef25582016-01-21 20:26:12 +000076static const char* kFn_encrypted_key = "encrypted_key";
Paul Crowley05720802016-02-08 15:55:41 +000077static const char* kFn_keymaster_key_blob = "keymaster_key_blob";
Paul Crowleydff8c722016-05-16 08:14:56 -070078static const char* kFn_keymaster_key_blob_upgraded = "keymaster_key_blob_upgraded";
Paul Crowley63c18d32016-02-10 14:02:47 +000079static const char* kFn_salt = "salt";
Paul Crowley1ef25582016-01-21 20:26:12 +000080static const char* kFn_secdiscardable = "secdiscardable";
Paul Crowley05720802016-02-08 15:55:41 +000081static const char* kFn_stretching = "stretching";
82static const char* kFn_version = "version";
Paul Crowley1ef25582016-01-21 20:26:12 +000083
Paul Crowley13ffd8e2016-01-27 14:30:22 +000084static bool checkSize(const std::string& kind, size_t actual, size_t expected) {
Paul Crowley1ef25582016-01-21 20:26:12 +000085 if (actual != expected) {
Paul Crowleydf528a72016-03-09 09:31:37 -080086 LOG(ERROR) << "Wrong number of bytes in " << kind << ", expected " << expected << " got "
87 << actual;
Paul Crowley1ef25582016-01-21 20:26:12 +000088 return false;
89 }
90 return true;
91}
92
Paul Crowley26a53882017-10-26 11:16:39 -070093static void hashWithPrefix(char const* prefix, const std::string& tohash, std::string* res) {
Paul Crowley1ef25582016-01-21 20:26:12 +000094 SHA512_CTX c;
95
96 SHA512_Init(&c);
97 // Personalise the hashing by introducing a fixed prefix.
98 // Hashing applications should use personalization except when there is a
99 // specific reason not to; see section 4.11 of https://www.schneier.com/skein1.3.pdf
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800100 std::string hashingPrefix = prefix;
101 hashingPrefix.resize(SHA512_CBLOCK);
102 SHA512_Update(&c, hashingPrefix.data(), hashingPrefix.size());
103 SHA512_Update(&c, tohash.data(), tohash.size());
Paul Crowley26a53882017-10-26 11:16:39 -0700104 res->assign(SHA512_DIGEST_LENGTH, '\0');
105 SHA512_Final(reinterpret_cast<uint8_t*>(&(*res)[0]), &c);
Paul Crowley1ef25582016-01-21 20:26:12 +0000106}
107
Paul Crowleydf528a72016-03-09 09:31:37 -0800108static bool generateKeymasterKey(Keymaster& keymaster, const KeyAuthentication& auth,
109 const std::string& appId, std::string* key) {
Shawn Willden35351812018-01-22 09:08:32 -0700110 auto paramBuilder = km::AuthorizationSetBuilder()
Paul Crowleydf528a72016-03-09 09:31:37 -0800111 .AesEncryptionKey(AES_KEY_BYTES * 8)
Shawn Willden35351812018-01-22 09:08:32 -0700112 .GcmModeMinMacLen(GCM_MAC_BYTES * 8)
113 .Authorization(km::TAG_APPLICATION_ID, km::support::blob2hidlVec(appId));
Paul Crowley320e5e12016-03-04 14:07:05 -0800114 if (auth.token.empty()) {
115 LOG(DEBUG) << "Creating key that doesn't need auth token";
Shawn Willden35351812018-01-22 09:08:32 -0700116 paramBuilder.Authorization(km::TAG_NO_AUTH_REQUIRED);
Paul Crowley320e5e12016-03-04 14:07:05 -0800117 } else {
118 LOG(DEBUG) << "Auth token required for key";
119 if (auth.token.size() != sizeof(hw_auth_token_t)) {
120 LOG(ERROR) << "Auth token should be " << sizeof(hw_auth_token_t) << " bytes, was "
Paul Crowleydf528a72016-03-09 09:31:37 -0800121 << auth.token.size() << " bytes";
Paul Crowley320e5e12016-03-04 14:07:05 -0800122 return false;
123 }
Paul Crowleydf528a72016-03-09 09:31:37 -0800124 const hw_auth_token_t* at = reinterpret_cast<const hw_auth_token_t*>(auth.token.data());
Paul Crowleyd281de72018-08-30 15:25:19 -0700125 auto user_id = at->user_id; // Make a copy because at->user_id is unaligned.
126 paramBuilder.Authorization(km::TAG_USER_SECURE_ID, user_id);
Shawn Willden35351812018-01-22 09:08:32 -0700127 paramBuilder.Authorization(km::TAG_USER_AUTH_TYPE, km::HardwareAuthenticatorType::PASSWORD);
128 paramBuilder.Authorization(km::TAG_AUTH_TIMEOUT, AUTH_TIMEOUT);
Paul Crowley320e5e12016-03-04 14:07:05 -0800129 }
Shawn Willden8431fe22018-12-06 07:45:02 -0700130
131 auto paramsWithRollback = paramBuilder;
132 paramsWithRollback.Authorization(km::TAG_ROLLBACK_RESISTANCE);
133
134 // Generate rollback-resistant key if possible.
135 return keymaster.generateKey(paramsWithRollback, key) ||
136 keymaster.generateKey(paramBuilder, key);
Paul Crowley320e5e12016-03-04 14:07:05 -0800137}
138
Barani Muthukumaran3dfb0942020-02-03 13:06:45 -0800139bool generateWrappedStorageKey(KeyBuffer* key) {
140 Keymaster keymaster;
141 if (!keymaster) return false;
142 std::string key_temp;
143 auto paramBuilder = km::AuthorizationSetBuilder().AesEncryptionKey(AES_KEY_BYTES * 8);
144 paramBuilder.Authorization(km::TAG_ROLLBACK_RESISTANCE);
145 paramBuilder.Authorization(km::TAG_STORAGE_KEY);
146 if (!keymaster.generateKey(paramBuilder, &key_temp)) return false;
147 *key = KeyBuffer(key_temp.size());
148 memcpy(reinterpret_cast<void*>(key->data()), key_temp.c_str(), key->size());
149 return true;
150}
151
152bool exportWrappedStorageKey(const KeyBuffer& kmKey, KeyBuffer* key) {
153 Keymaster keymaster;
154 if (!keymaster) return false;
155 std::string key_temp;
156
157 if (!keymaster.exportKey(kmKey, &key_temp)) return false;
158 *key = KeyBuffer(key_temp.size());
159 memcpy(reinterpret_cast<void*>(key->data()), key_temp.c_str(), key->size());
160 return true;
161}
162
Shawn Willden35351812018-01-22 09:08:32 -0700163static std::pair<km::AuthorizationSet, km::HardwareAuthToken> beginParams(
164 const KeyAuthentication& auth, const std::string& appId) {
165 auto paramBuilder = km::AuthorizationSetBuilder()
166 .GcmModeMacLen(GCM_MAC_BYTES * 8)
167 .Authorization(km::TAG_APPLICATION_ID, km::support::blob2hidlVec(appId));
168 km::HardwareAuthToken authToken;
Paul Crowley320e5e12016-03-04 14:07:05 -0800169 if (!auth.token.empty()) {
170 LOG(DEBUG) << "Supplying auth token to Keymaster";
Shawn Willden35351812018-01-22 09:08:32 -0700171 authToken = km::support::hidlVec2AuthToken(km::support::blob2hidlVec(auth.token));
Paul Crowley320e5e12016-03-04 14:07:05 -0800172 }
Shawn Willden35351812018-01-22 09:08:32 -0700173 return {paramBuilder, authToken};
Paul Crowley1ef25582016-01-21 20:26:12 +0000174}
175
Paul Crowleydf528a72016-03-09 09:31:37 -0800176static bool readFileToString(const std::string& filename, std::string* result) {
Paul Crowleya051eb72016-03-08 16:08:32 -0800177 if (!android::base::ReadFileToString(filename, result)) {
Paul Crowleydf528a72016-03-09 09:31:37 -0800178 PLOG(ERROR) << "Failed to read from " << filename;
179 return false;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000180 }
181 return true;
182}
183
Paul Crowley26a53882017-10-26 11:16:39 -0700184static bool readRandomBytesOrLog(size_t count, std::string* out) {
185 auto status = ReadRandomBytes(count, *out);
186 if (status != OK) {
187 LOG(ERROR) << "Random read failed with status: " << status;
188 return false;
189 }
190 return true;
191}
192
193bool createSecdiscardable(const std::string& filename, std::string* hash) {
194 std::string secdiscardable;
195 if (!readRandomBytesOrLog(SECDISCARDABLE_BYTES, &secdiscardable)) return false;
196 if (!writeStringToFile(secdiscardable, filename)) return false;
197 hashWithPrefix(kHashPrefix_secdiscardable, secdiscardable, hash);
198 return true;
199}
200
201bool readSecdiscardable(const std::string& filename, std::string* hash) {
202 std::string secdiscardable;
203 if (!readFileToString(filename, &secdiscardable)) return false;
204 hashWithPrefix(kHashPrefix_secdiscardable, secdiscardable, hash);
205 return true;
206}
207
Daniel Rosenberga48730a2019-06-06 20:38:38 -0700208static void deferedKmDeleteKey(const std::string& kmkey) {
209 while (!android::base::WaitForProperty("vold.checkpoint_committed", "1")) {
210 LOG(ERROR) << "Wait for boot timed out";
211 }
212 Keymaster keymaster;
213 if (!keymaster || !keymaster.deleteKey(kmkey)) {
214 LOG(ERROR) << "Defered Key deletion failed during upgrade";
215 }
216}
217
218bool kmDeleteKey(Keymaster& keymaster, const std::string& kmKey) {
219 bool needs_cp = cp_needsCheckpoint();
220
221 if (needs_cp) {
222 std::thread(deferedKmDeleteKey, kmKey).detach();
223 LOG(INFO) << "Deferring Key deletion during upgrade";
224 return true;
225 } else {
226 return keymaster.deleteKey(kmKey);
227 }
228}
229
Shawn Willden35351812018-01-22 09:08:32 -0700230static KeymasterOperation begin(Keymaster& keymaster, const std::string& dir,
231 km::KeyPurpose purpose, const km::AuthorizationSet& keyParams,
232 const km::AuthorizationSet& opParams,
233 const km::HardwareAuthToken& authToken,
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800234 km::AuthorizationSet* outParams, bool keepOld) {
Paul Crowleydff8c722016-05-16 08:14:56 -0700235 auto kmKeyPath = dir + "/" + kFn_keymaster_key_blob;
236 std::string kmKey;
237 if (!readFileToString(kmKeyPath, &kmKey)) return KeymasterOperation();
Shawn Willden35351812018-01-22 09:08:32 -0700238 km::AuthorizationSet inParams(keyParams);
Janis Danisevskis8e537b82016-10-26 14:27:10 +0100239 inParams.append(opParams.begin(), opParams.end());
Paul Crowleydff8c722016-05-16 08:14:56 -0700240 for (;;) {
Shawn Willden35351812018-01-22 09:08:32 -0700241 auto opHandle = keymaster.begin(purpose, kmKey, inParams, authToken, outParams);
Paul Crowleydff8c722016-05-16 08:14:56 -0700242 if (opHandle) {
243 return opHandle;
244 }
Shawn Willden35351812018-01-22 09:08:32 -0700245 if (opHandle.errorCode() != km::ErrorCode::KEY_REQUIRES_UPGRADE) return opHandle;
Paul Crowleydff8c722016-05-16 08:14:56 -0700246 LOG(DEBUG) << "Upgrading key: " << dir;
247 std::string newKey;
248 if (!keymaster.upgradeKey(kmKey, keyParams, &newKey)) return KeymasterOperation();
249 auto newKeyPath = dir + "/" + kFn_keymaster_key_blob_upgraded;
250 if (!writeStringToFile(newKey, newKeyPath)) return KeymasterOperation();
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800251 if (!keepOld) {
252 if (rename(newKeyPath.c_str(), kmKeyPath.c_str()) != 0) {
253 PLOG(ERROR) << "Unable to move upgraded key to location: " << kmKeyPath;
254 return KeymasterOperation();
255 }
Woody Lin37c82f52019-03-11 20:58:20 +0800256 if (!android::vold::FsyncDirectory(dir)) {
257 LOG(ERROR) << "Key dir sync failed: " << dir;
258 return KeymasterOperation();
259 }
Daniel Rosenberga48730a2019-06-06 20:38:38 -0700260 if (!kmDeleteKey(keymaster, kmKey)) {
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800261 LOG(ERROR) << "Key deletion failed during upgrade, continuing anyway: " << dir;
262 }
Paul Crowleydff8c722016-05-16 08:14:56 -0700263 }
264 kmKey = newKey;
265 LOG(INFO) << "Key upgraded: " << dir;
266 }
267}
268
269static bool encryptWithKeymasterKey(Keymaster& keymaster, const std::string& dir,
Shawn Willden35351812018-01-22 09:08:32 -0700270 const km::AuthorizationSet& keyParams,
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800271 const km::HardwareAuthToken& authToken, const KeyBuffer& message,
272 std::string* ciphertext, bool keepOld) {
Shawn Willden35351812018-01-22 09:08:32 -0700273 km::AuthorizationSet opParams;
274 km::AuthorizationSet outParams;
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800275 auto opHandle = begin(keymaster, dir, km::KeyPurpose::ENCRYPT, keyParams, opParams, authToken,
276 &outParams, keepOld);
Paul Crowleydff8c722016-05-16 08:14:56 -0700277 if (!opHandle) return false;
Shawn Willden35351812018-01-22 09:08:32 -0700278 auto nonceBlob = outParams.GetTagValue(km::TAG_NONCE);
Janis Danisevskis8e537b82016-10-26 14:27:10 +0100279 if (!nonceBlob.isOk()) {
Paul Crowleydff8c722016-05-16 08:14:56 -0700280 LOG(ERROR) << "GCM encryption but no nonce generated";
281 return false;
282 }
283 // nonceBlob here is just a pointer into existing data, must not be freed
Shawn Willden785365b2018-01-20 09:37:36 -0700284 std::string nonce(reinterpret_cast<const char*>(&nonceBlob.value()[0]),
285 nonceBlob.value().size());
Paul Crowleydff8c722016-05-16 08:14:56 -0700286 if (!checkSize("nonce", nonce.size(), GCM_NONCE_BYTES)) return false;
287 std::string body;
288 if (!opHandle.updateCompletely(message, &body)) return false;
289
290 std::string mac;
291 if (!opHandle.finish(&mac)) return false;
292 if (!checkSize("mac", mac.size(), GCM_MAC_BYTES)) return false;
293 *ciphertext = nonce + body + mac;
294 return true;
295}
296
297static bool decryptWithKeymasterKey(Keymaster& keymaster, const std::string& dir,
Shawn Willden35351812018-01-22 09:08:32 -0700298 const km::AuthorizationSet& keyParams,
299 const km::HardwareAuthToken& authToken,
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800300 const std::string& ciphertext, KeyBuffer* message,
301 bool keepOld) {
Paul Crowleydff8c722016-05-16 08:14:56 -0700302 auto nonce = ciphertext.substr(0, GCM_NONCE_BYTES);
303 auto bodyAndMac = ciphertext.substr(GCM_NONCE_BYTES);
Shawn Willden35351812018-01-22 09:08:32 -0700304 auto opParams = km::AuthorizationSetBuilder().Authorization(km::TAG_NONCE,
305 km::support::blob2hidlVec(nonce));
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800306 auto opHandle = begin(keymaster, dir, km::KeyPurpose::DECRYPT, keyParams, opParams, authToken,
307 nullptr, keepOld);
Paul Crowleydff8c722016-05-16 08:14:56 -0700308 if (!opHandle) return false;
309 if (!opHandle.updateCompletely(bodyAndMac, message)) return false;
310 if (!opHandle.finish(nullptr)) return false;
311 return true;
312}
313
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800314static std::string getStretching(const KeyAuthentication& auth) {
315 if (!auth.usesKeymaster()) {
316 return kStretch_none;
317 } else if (auth.secret.empty()) {
318 return kStretch_nopassword;
319 } else {
320 char paramstr[PROPERTY_VALUE_MAX];
Paul Crowley63c18d32016-02-10 14:02:47 +0000321
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800322 property_get(SCRYPT_PROP, paramstr, SCRYPT_DEFAULTS);
323 return std::string() + kStretchPrefix_scrypt + paramstr;
324 }
Paul Crowley63c18d32016-02-10 14:02:47 +0000325}
326
Paul Crowleydf528a72016-03-09 09:31:37 -0800327static bool stretchingNeedsSalt(const std::string& stretching) {
Paul Crowley63c18d32016-02-10 14:02:47 +0000328 return stretching != kStretch_nopassword && stretching != kStretch_none;
329}
330
Paul Crowleydf528a72016-03-09 09:31:37 -0800331static bool stretchSecret(const std::string& stretching, const std::string& secret,
332 const std::string& salt, std::string* stretched) {
Paul Crowley63c18d32016-02-10 14:02:47 +0000333 if (stretching == kStretch_nopassword) {
334 if (!secret.empty()) {
Paul Crowleyd9b92952016-03-04 13:45:00 -0800335 LOG(WARNING) << "Password present but stretching is nopassword";
Paul Crowley63c18d32016-02-10 14:02:47 +0000336 // Continue anyway
337 }
Paul Crowleya051eb72016-03-08 16:08:32 -0800338 stretched->clear();
Paul Crowley63c18d32016-02-10 14:02:47 +0000339 } else if (stretching == kStretch_none) {
Paul Crowleya051eb72016-03-08 16:08:32 -0800340 *stretched = secret;
Paul Crowleydf528a72016-03-09 09:31:37 -0800341 } else if (std::equal(kStretchPrefix_scrypt.begin(), kStretchPrefix_scrypt.end(),
342 stretching.begin())) {
Paul Crowley63c18d32016-02-10 14:02:47 +0000343 int Nf, rf, pf;
Paul Crowleydf528a72016-03-09 09:31:37 -0800344 if (!parse_scrypt_parameters(stretching.substr(kStretchPrefix_scrypt.size()).c_str(), &Nf,
345 &rf, &pf)) {
Paul Crowley63c18d32016-02-10 14:02:47 +0000346 LOG(ERROR) << "Unable to parse scrypt params in stretching: " << stretching;
347 return false;
348 }
Paul Crowleya051eb72016-03-08 16:08:32 -0800349 stretched->assign(STRETCHED_BYTES, '\0');
Paul Crowleydf528a72016-03-09 09:31:37 -0800350 if (crypto_scrypt(reinterpret_cast<const uint8_t*>(secret.data()), secret.size(),
Shawn Willden785365b2018-01-20 09:37:36 -0700351 reinterpret_cast<const uint8_t*>(salt.data()), salt.size(), 1 << Nf,
352 1 << rf, 1 << pf, reinterpret_cast<uint8_t*>(&(*stretched)[0]),
353 stretched->size()) != 0) {
Paul Crowley63c18d32016-02-10 14:02:47 +0000354 LOG(ERROR) << "scrypt failed with params: " << stretching;
355 return false;
356 }
357 } else {
358 LOG(ERROR) << "Unknown stretching type: " << stretching;
359 return false;
360 }
361 return true;
362}
363
Paul Crowleydf528a72016-03-09 09:31:37 -0800364static bool generateAppId(const KeyAuthentication& auth, const std::string& stretching,
Paul Crowley26a53882017-10-26 11:16:39 -0700365 const std::string& salt, const std::string& secdiscardable_hash,
Paul Crowleydf528a72016-03-09 09:31:37 -0800366 std::string* appId) {
Paul Crowley63c18d32016-02-10 14:02:47 +0000367 std::string stretched;
Paul Crowleya051eb72016-03-08 16:08:32 -0800368 if (!stretchSecret(stretching, auth.secret, salt, &stretched)) return false;
Paul Crowley26a53882017-10-26 11:16:39 -0700369 *appId = secdiscardable_hash + stretched;
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800370 return true;
371}
372
373static void logOpensslError() {
374 LOG(ERROR) << "Openssl error: " << ERR_get_error();
375}
376
Shawn Willden785365b2018-01-20 09:37:36 -0700377static bool encryptWithoutKeymaster(const std::string& preKey, const KeyBuffer& plaintext,
378 std::string* ciphertext) {
Paul Crowley26a53882017-10-26 11:16:39 -0700379 std::string key;
380 hashWithPrefix(kHashPrefix_keygen, preKey, &key);
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800381 key.resize(AES_KEY_BYTES);
382 if (!readRandomBytesOrLog(GCM_NONCE_BYTES, ciphertext)) return false;
383 auto ctx = std::unique_ptr<EVP_CIPHER_CTX, decltype(&::EVP_CIPHER_CTX_free)>(
384 EVP_CIPHER_CTX_new(), EVP_CIPHER_CTX_free);
385 if (!ctx) {
386 logOpensslError();
387 return false;
388 }
389 if (1 != EVP_EncryptInit_ex(ctx.get(), EVP_aes_256_gcm(), NULL,
Shawn Willden785365b2018-01-20 09:37:36 -0700390 reinterpret_cast<const uint8_t*>(key.data()),
391 reinterpret_cast<const uint8_t*>(ciphertext->data()))) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800392 logOpensslError();
393 return false;
394 }
395 ciphertext->resize(GCM_NONCE_BYTES + plaintext.size() + GCM_MAC_BYTES);
396 int outlen;
Shawn Willden785365b2018-01-20 09:37:36 -0700397 if (1 != EVP_EncryptUpdate(
398 ctx.get(), reinterpret_cast<uint8_t*>(&(*ciphertext)[0] + GCM_NONCE_BYTES),
399 &outlen, reinterpret_cast<const uint8_t*>(plaintext.data()), plaintext.size())) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800400 logOpensslError();
401 return false;
402 }
403 if (outlen != static_cast<int>(plaintext.size())) {
404 LOG(ERROR) << "GCM ciphertext length should be " << plaintext.size() << " was " << outlen;
405 return false;
406 }
Shawn Willden785365b2018-01-20 09:37:36 -0700407 if (1 != EVP_EncryptFinal_ex(
408 ctx.get(),
409 reinterpret_cast<uint8_t*>(&(*ciphertext)[0] + GCM_NONCE_BYTES + plaintext.size()),
410 &outlen)) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800411 logOpensslError();
412 return false;
413 }
414 if (outlen != 0) {
415 LOG(ERROR) << "GCM EncryptFinal should be 0, was " << outlen;
416 return false;
417 }
418 if (1 != EVP_CIPHER_CTX_ctrl(ctx.get(), EVP_CTRL_GCM_GET_TAG, GCM_MAC_BYTES,
Shawn Willden785365b2018-01-20 09:37:36 -0700419 reinterpret_cast<uint8_t*>(&(*ciphertext)[0] + GCM_NONCE_BYTES +
420 plaintext.size()))) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800421 logOpensslError();
422 return false;
423 }
424 return true;
425}
426
Shawn Willden785365b2018-01-20 09:37:36 -0700427static bool decryptWithoutKeymaster(const std::string& preKey, const std::string& ciphertext,
428 KeyBuffer* plaintext) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800429 if (ciphertext.size() < GCM_NONCE_BYTES + GCM_MAC_BYTES) {
430 LOG(ERROR) << "GCM ciphertext too small: " << ciphertext.size();
431 return false;
432 }
Paul Crowley26a53882017-10-26 11:16:39 -0700433 std::string key;
434 hashWithPrefix(kHashPrefix_keygen, preKey, &key);
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800435 key.resize(AES_KEY_BYTES);
436 auto ctx = std::unique_ptr<EVP_CIPHER_CTX, decltype(&::EVP_CIPHER_CTX_free)>(
437 EVP_CIPHER_CTX_new(), EVP_CIPHER_CTX_free);
438 if (!ctx) {
439 logOpensslError();
440 return false;
441 }
442 if (1 != EVP_DecryptInit_ex(ctx.get(), EVP_aes_256_gcm(), NULL,
Shawn Willden785365b2018-01-20 09:37:36 -0700443 reinterpret_cast<const uint8_t*>(key.data()),
444 reinterpret_cast<const uint8_t*>(ciphertext.data()))) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800445 logOpensslError();
446 return false;
447 }
Pavel Grafove2e2d302017-08-01 17:15:53 +0100448 *plaintext = KeyBuffer(ciphertext.size() - GCM_NONCE_BYTES - GCM_MAC_BYTES);
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800449 int outlen;
Shawn Willden785365b2018-01-20 09:37:36 -0700450 if (1 != EVP_DecryptUpdate(ctx.get(), reinterpret_cast<uint8_t*>(&(*plaintext)[0]), &outlen,
451 reinterpret_cast<const uint8_t*>(ciphertext.data() + GCM_NONCE_BYTES),
452 plaintext->size())) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800453 logOpensslError();
454 return false;
455 }
456 if (outlen != static_cast<int>(plaintext->size())) {
457 LOG(ERROR) << "GCM plaintext length should be " << plaintext->size() << " was " << outlen;
458 return false;
459 }
460 if (1 != EVP_CIPHER_CTX_ctrl(ctx.get(), EVP_CTRL_GCM_SET_TAG, GCM_MAC_BYTES,
Shawn Willden785365b2018-01-20 09:37:36 -0700461 const_cast<void*>(reinterpret_cast<const void*>(
462 ciphertext.data() + GCM_NONCE_BYTES + plaintext->size())))) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800463 logOpensslError();
464 return false;
465 }
466 if (1 != EVP_DecryptFinal_ex(ctx.get(),
Shawn Willden785365b2018-01-20 09:37:36 -0700467 reinterpret_cast<uint8_t*>(&(*plaintext)[0] + plaintext->size()),
468 &outlen)) {
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800469 logOpensslError();
470 return false;
471 }
472 if (outlen != 0) {
473 LOG(ERROR) << "GCM EncryptFinal should be 0, was " << outlen;
474 return false;
475 }
Paul Crowley63c18d32016-02-10 14:02:47 +0000476 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000477}
478
Paul Crowleyf71ace32016-06-02 11:01:19 -0700479bool pathExists(const std::string& path) {
480 return access(path.c_str(), F_OK) == 0;
481}
482
Pavel Grafove2e2d302017-08-01 17:15:53 +0100483bool storeKey(const std::string& dir, const KeyAuthentication& auth, const KeyBuffer& key) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000484 if (TEMP_FAILURE_RETRY(mkdir(dir.c_str(), 0700)) == -1) {
485 PLOG(ERROR) << "key mkdir " << dir;
486 return false;
487 }
Paul Crowleydf528a72016-03-09 09:31:37 -0800488 if (!writeStringToFile(kCurrentVersion, dir + "/" + kFn_version)) return false;
Paul Crowley26a53882017-10-26 11:16:39 -0700489 std::string secdiscardable_hash;
490 if (!createSecdiscardable(dir + "/" + kFn_secdiscardable, &secdiscardable_hash)) return false;
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800491 std::string stretching = getStretching(auth);
Paul Crowleydf528a72016-03-09 09:31:37 -0800492 if (!writeStringToFile(stretching, dir + "/" + kFn_stretching)) return false;
Paul Crowley63c18d32016-02-10 14:02:47 +0000493 std::string salt;
494 if (stretchingNeedsSalt(stretching)) {
495 if (ReadRandomBytes(SALT_BYTES, salt) != OK) {
496 LOG(ERROR) << "Random read failed";
497 return false;
498 }
Paul Crowleydf528a72016-03-09 09:31:37 -0800499 if (!writeStringToFile(salt, dir + "/" + kFn_salt)) return false;
Paul Crowley63c18d32016-02-10 14:02:47 +0000500 }
Paul Crowley320e5e12016-03-04 14:07:05 -0800501 std::string appId;
Paul Crowley26a53882017-10-26 11:16:39 -0700502 if (!generateAppId(auth, stretching, salt, secdiscardable_hash, &appId)) return false;
Paul Crowley320e5e12016-03-04 14:07:05 -0800503 std::string encryptedKey;
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800504 if (auth.usesKeymaster()) {
505 Keymaster keymaster;
506 if (!keymaster) return false;
507 std::string kmKey;
508 if (!generateKeymasterKey(keymaster, auth, appId, &kmKey)) return false;
509 if (!writeStringToFile(kmKey, dir + "/" + kFn_keymaster_key_blob)) return false;
Shawn Willden35351812018-01-22 09:08:32 -0700510 km::AuthorizationSet keyParams;
511 km::HardwareAuthToken authToken;
512 std::tie(keyParams, authToken) = beginParams(auth, appId);
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800513 if (!encryptWithKeymasterKey(keymaster, dir, keyParams, authToken, key, &encryptedKey,
514 false))
Shawn Willden35351812018-01-22 09:08:32 -0700515 return false;
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800516 } else {
517 if (!encryptWithoutKeymaster(appId, key, &encryptedKey)) return false;
518 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000519 if (!writeStringToFile(encryptedKey, dir + "/" + kFn_encrypted_key)) return false;
Paul Crowley621d9b92018-12-07 15:36:09 -0800520 if (!FsyncDirectory(dir)) return false;
Paul Crowley1ef25582016-01-21 20:26:12 +0000521 return true;
522}
523
Paul Crowleyf71ace32016-06-02 11:01:19 -0700524bool storeKeyAtomically(const std::string& key_path, const std::string& tmp_path,
Pavel Grafove2e2d302017-08-01 17:15:53 +0100525 const KeyAuthentication& auth, const KeyBuffer& key) {
Paul Crowleyf71ace32016-06-02 11:01:19 -0700526 if (pathExists(key_path)) {
527 LOG(ERROR) << "Already exists, cannot create key at: " << key_path;
528 return false;
529 }
530 if (pathExists(tmp_path)) {
531 LOG(DEBUG) << "Already exists, destroying: " << tmp_path;
532 destroyKey(tmp_path); // May be partially created so ignore errors
533 }
534 if (!storeKey(tmp_path, auth, key)) return false;
535 if (rename(tmp_path.c_str(), key_path.c_str()) != 0) {
536 PLOG(ERROR) << "Unable to move new key to location: " << key_path;
537 return false;
538 }
539 LOG(DEBUG) << "Created key: " << key_path;
540 return true;
541}
542
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800543bool retrieveKey(const std::string& dir, const KeyAuthentication& auth, KeyBuffer* key,
544 bool keepOld) {
Paul Crowley05720802016-02-08 15:55:41 +0000545 std::string version;
Paul Crowleya051eb72016-03-08 16:08:32 -0800546 if (!readFileToString(dir + "/" + kFn_version, &version)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000547 if (version != kCurrentVersion) {
548 LOG(ERROR) << "Version mismatch, expected " << kCurrentVersion << " got " << version;
549 return false;
550 }
Paul Crowley26a53882017-10-26 11:16:39 -0700551 std::string secdiscardable_hash;
552 if (!readSecdiscardable(dir + "/" + kFn_secdiscardable, &secdiscardable_hash)) return false;
Paul Crowley63c18d32016-02-10 14:02:47 +0000553 std::string stretching;
Paul Crowleya051eb72016-03-08 16:08:32 -0800554 if (!readFileToString(dir + "/" + kFn_stretching, &stretching)) return false;
Paul Crowley63c18d32016-02-10 14:02:47 +0000555 std::string salt;
556 if (stretchingNeedsSalt(stretching)) {
Paul Crowleydf528a72016-03-09 09:31:37 -0800557 if (!readFileToString(dir + "/" + kFn_salt, &salt)) return false;
Paul Crowley63c18d32016-02-10 14:02:47 +0000558 }
Paul Crowley320e5e12016-03-04 14:07:05 -0800559 std::string appId;
Paul Crowley26a53882017-10-26 11:16:39 -0700560 if (!generateAppId(auth, stretching, salt, secdiscardable_hash, &appId)) return false;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000561 std::string encryptedMessage;
Paul Crowleya051eb72016-03-08 16:08:32 -0800562 if (!readFileToString(dir + "/" + kFn_encrypted_key, &encryptedMessage)) return false;
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800563 if (auth.usesKeymaster()) {
564 Keymaster keymaster;
565 if (!keymaster) return false;
Shawn Willden35351812018-01-22 09:08:32 -0700566 km::AuthorizationSet keyParams;
567 km::HardwareAuthToken authToken;
568 std::tie(keyParams, authToken) = beginParams(auth, appId);
Daniel Rosenberg690d6de2018-12-14 01:08:10 -0800569 if (!decryptWithKeymasterKey(keymaster, dir, keyParams, authToken, encryptedMessage, key,
570 keepOld))
Shawn Willden785365b2018-01-20 09:37:36 -0700571 return false;
Paul Crowley6ab2cab2017-01-04 22:32:40 -0800572 } else {
573 if (!decryptWithoutKeymaster(appId, encryptedMessage, key)) return false;
574 }
575 return true;
Paul Crowley1ef25582016-01-21 20:26:12 +0000576}
577
Paul Crowleydf528a72016-03-09 09:31:37 -0800578static bool deleteKey(const std::string& dir) {
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000579 std::string kmKey;
Paul Crowleya051eb72016-03-08 16:08:32 -0800580 if (!readFileToString(dir + "/" + kFn_keymaster_key_blob, &kmKey)) return false;
Paul Crowley1ef25582016-01-21 20:26:12 +0000581 Keymaster keymaster;
582 if (!keymaster) return false;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000583 if (!keymaster.deleteKey(kmKey)) return false;
Paul Crowley1ef25582016-01-21 20:26:12 +0000584 return true;
585}
586
Rubin Xu2436e272017-04-27 20:43:10 +0100587bool runSecdiscardSingle(const std::string& file) {
Shawn Willden785365b2018-01-20 09:37:36 -0700588 if (ForkExecvp(std::vector<std::string>{kSecdiscardPath, "--", file}) != 0) {
Rubin Xu2436e272017-04-27 20:43:10 +0100589 LOG(ERROR) << "secdiscard failed";
590 return false;
591 }
592 return true;
593}
594
Paul Crowleydf528a72016-03-09 09:31:37 -0800595static bool recursiveDeleteKey(const std::string& dir) {
596 if (ForkExecvp(std::vector<std::string>{kRmPath, "-rf", dir}) != 0) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000597 LOG(ERROR) << "recursive delete failed";
598 return false;
599 }
600 return true;
601}
602
Paul Crowleydf528a72016-03-09 09:31:37 -0800603bool destroyKey(const std::string& dir) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000604 bool success = true;
605 // Try each thing, even if previous things failed.
Paul Crowleyff19b052017-10-26 11:28:55 -0700606 bool uses_km = pathExists(dir + "/" + kFn_keymaster_key_blob);
607 if (uses_km) {
608 success &= deleteKey(dir);
609 }
610 auto secdiscard_cmd = std::vector<std::string>{
Paul Crowley14c8c072018-09-18 13:30:21 -0700611 kSecdiscardPath,
612 "--",
613 dir + "/" + kFn_encrypted_key,
614 dir + "/" + kFn_secdiscardable,
Paul Crowleyff19b052017-10-26 11:28:55 -0700615 };
616 if (uses_km) {
617 secdiscard_cmd.emplace_back(dir + "/" + kFn_keymaster_key_blob);
618 }
619 if (ForkExecvp(secdiscard_cmd) != 0) {
620 LOG(ERROR) << "secdiscard failed";
621 success = false;
622 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000623 success &= recursiveDeleteKey(dir);
Paul Crowley1ef25582016-01-21 20:26:12 +0000624 return success;
625}
626
627} // namespace vold
628} // namespace android