blob: 5c1b9214a60d19993111f2f82d5d6fdca998b09d [file] [log] [blame]
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -08001/*
2 * Copyright (C) 2015 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
Paul Lawrence731a7a22015-04-28 22:14:15 +000017#include "Ext4Crypt.h"
18
Paul Crowley1ef25582016-01-21 20:26:12 +000019#include "KeyStorage.h"
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080020#include "Utils.h"
21
Paul Lawrencefd7db732015-04-10 07:48:51 -070022#include <iomanip>
Paul Lawrence731a7a22015-04-28 22:14:15 +000023#include <map>
Paul Crowleyb1f3d242016-01-28 10:09:46 +000024#include <set>
Paul Lawrencefd7db732015-04-10 07:48:51 -070025#include <string>
26#include <sstream>
Paul Lawrence731a7a22015-04-28 22:14:15 +000027
Paul Crowleyb1f3d242016-01-28 10:09:46 +000028#include <stdio.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000029#include <errno.h>
Paul Crowley95376d62015-05-06 15:04:43 +010030#include <dirent.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000031#include <sys/mount.h>
Paul Crowley95376d62015-05-06 15:04:43 +010032#include <sys/types.h>
33#include <sys/stat.h>
34#include <fcntl.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000035#include <cutils/properties.h>
Paul Lawrencefd7db732015-04-10 07:48:51 -070036#include <openssl/sha.h>
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070037#include <selinux/android.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000038
Paul Crowley480fcd22015-08-24 14:53:28 +010039#include <private/android_filesystem_config.h>
40
Paul Lawrence731a7a22015-04-28 22:14:15 +000041#include "unencrypted_properties.h"
42#include "key_control.h"
43#include "cryptfs.h"
Paul Crowley95376d62015-05-06 15:04:43 +010044#include "ext4_crypt_init_extensions.h"
Paul Lawrence731a7a22015-04-28 22:14:15 +000045
46#define LOG_TAG "Ext4Crypt"
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080047
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070048#define EMULATED_USES_SELINUX 0
49
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080050#include <cutils/fs.h>
51#include <cutils/log.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000052#include <cutils/klog.h>
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080053
Elliott Hughes7e128fb2015-12-04 15:50:53 -080054#include <android-base/file.h>
Elliott Hughes6bf05472015-12-04 17:55:33 -080055#include <android-base/logging.h>
Elliott Hughes7e128fb2015-12-04 15:50:53 -080056#include <android-base/stringprintf.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000057
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080058using android::base::StringPrintf;
59
Jeff Sharkeyfc505c32015-12-07 17:27:01 -070060static bool e4crypt_is_native() {
61 char value[PROPERTY_VALUE_MAX];
62 property_get("ro.crypto.type", value, "none");
63 return !strcmp(value, "file");
64}
65
66static bool e4crypt_is_emulated() {
67 return property_get_bool("persist.sys.emulate_fbe", false);
68}
Jeff Sharkeyc79fb892015-11-12 20:18:02 -080069
Paul Lawrence731a7a22015-04-28 22:14:15 +000070namespace {
71 // Key length in bits
72 const int key_length = 128;
Paul Lawrencefd7db732015-04-10 07:48:51 -070073 static_assert(key_length % 8 == 0,
74 "Key length must be multiple of 8 bits");
Paul Lawrence731a7a22015-04-28 22:14:15 +000075
Paul Lawrence86c942a2015-05-06 13:53:43 -070076 // How long do we store passwords for?
77 const int password_max_age_seconds = 60;
78
Paul Crowley285956f2016-01-20 13:12:38 +000079 const std::string user_key_dir = std::string() + DATA_MNT_POINT + "/misc/vold/user_keys";
Paul Crowleyb1f3d242016-01-28 10:09:46 +000080 const std::string user_key_temp = user_key_dir + "/temp";
Paul Crowley285956f2016-01-20 13:12:38 +000081
Paul Lawrence731a7a22015-04-28 22:14:15 +000082 // How is device encrypted
83 struct keys {
84 std::string master_key;
85 std::string password;
Paul Lawrence86c942a2015-05-06 13:53:43 -070086 time_t expiry_time;
Paul Lawrence731a7a22015-04-28 22:14:15 +000087 };
88 std::map<std::string, keys> s_key_store;
Paul Crowleyb1f3d242016-01-28 10:09:46 +000089 // Some users are ephemeral, don't try to wipe their keys from disk
90 std::set<userid_t> s_ephemeral_users;
91 // Map user ids to key references
92 std::map<userid_t, std::string> s_ce_key_raw_refs;
Paul Lawrence731a7a22015-04-28 22:14:15 +000093
Paul Crowley285956f2016-01-20 13:12:38 +000094 // ext4enc:TODO get this const from somewhere good
Paul Lawrencefd7db732015-04-10 07:48:51 -070095 const int EXT4_KEY_DESCRIPTOR_SIZE = 8;
96
Paul Lawrence731a7a22015-04-28 22:14:15 +000097 // ext4enc:TODO Include structure from somewhere sensible
98 // MUST be in sync with ext4_crypto.c in kernel
Paul Lawrencefd7db732015-04-10 07:48:51 -070099 const int EXT4_MAX_KEY_SIZE = 64;
100 const int EXT4_ENCRYPTION_MODE_AES_256_XTS = 1;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000101 struct ext4_encryption_key {
Paul Lawrencefd7db732015-04-10 07:48:51 -0700102 uint32_t mode;
103 char raw[EXT4_MAX_KEY_SIZE];
104 uint32_t size;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000105 };
106
107 namespace tag {
108 const char* magic = "magic";
109 const char* major_version = "major_version";
110 const char* minor_version = "minor_version";
111 const char* flags = "flags";
112 const char* crypt_type = "crypt_type";
113 const char* failed_decrypt_count = "failed_decrypt_count";
114 const char* crypto_type_name = "crypto_type_name";
115 const char* master_key = "master_key";
116 const char* salt = "salt";
117 const char* kdf_type = "kdf_type";
118 const char* N_factor = "N_factor";
119 const char* r_factor = "r_factor";
120 const char* p_factor = "p_factor";
121 const char* keymaster_blob = "keymaster_blob";
122 const char* scrypted_intermediate_key = "scrypted_intermediate_key";
123 }
124}
125
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000126static bool install_key(const std::string &key, std::string &raw_ref);
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100127
Paul Lawrence731a7a22015-04-28 22:14:15 +0000128static int put_crypt_ftr_and_key(const crypt_mnt_ftr& crypt_ftr,
129 UnencryptedProperties& props)
130{
131 SLOGI("Putting crypt footer");
132
133 bool success = props.Set<int>(tag::magic, crypt_ftr.magic)
134 && props.Set<int>(tag::major_version, crypt_ftr.major_version)
135 && props.Set<int>(tag::minor_version, crypt_ftr.minor_version)
136 && props.Set<int>(tag::flags, crypt_ftr.flags)
137 && props.Set<int>(tag::crypt_type, crypt_ftr.crypt_type)
138 && props.Set<int>(tag::failed_decrypt_count,
139 crypt_ftr.failed_decrypt_count)
140 && props.Set<std::string>(tag::crypto_type_name,
141 std::string(reinterpret_cast<const char*>(crypt_ftr.crypto_type_name)))
142 && props.Set<std::string>(tag::master_key,
143 std::string((const char*) crypt_ftr.master_key,
144 crypt_ftr.keysize))
145 && props.Set<std::string>(tag::salt,
146 std::string((const char*) crypt_ftr.salt,
147 SALT_LEN))
148 && props.Set<int>(tag::kdf_type, crypt_ftr.kdf_type)
149 && props.Set<int>(tag::N_factor, crypt_ftr.N_factor)
150 && props.Set<int>(tag::r_factor, crypt_ftr.r_factor)
151 && props.Set<int>(tag::p_factor, crypt_ftr.p_factor)
152 && props.Set<std::string>(tag::keymaster_blob,
153 std::string((const char*) crypt_ftr.keymaster_blob,
154 crypt_ftr.keymaster_blob_size))
155 && props.Set<std::string>(tag::scrypted_intermediate_key,
156 std::string((const char*) crypt_ftr.scrypted_intermediate_key,
157 SCRYPT_LEN));
158 return success ? 0 : -1;
159}
160
161static int get_crypt_ftr_and_key(crypt_mnt_ftr& crypt_ftr,
162 const UnencryptedProperties& props)
163{
164 memset(&crypt_ftr, 0, sizeof(crypt_ftr));
165 crypt_ftr.magic = props.Get<int>(tag::magic);
166 crypt_ftr.major_version = props.Get<int>(tag::major_version);
167 crypt_ftr.minor_version = props.Get<int>(tag::minor_version);
Paul Lawrence0d9cd9e2015-05-05 15:58:27 -0700168 crypt_ftr.ftr_size = sizeof(crypt_ftr);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000169 crypt_ftr.flags = props.Get<int>(tag::flags);
170 crypt_ftr.crypt_type = props.Get<int>(tag::crypt_type);
171 crypt_ftr.failed_decrypt_count = props.Get<int>(tag::failed_decrypt_count);
172 std::string crypto_type_name = props.Get<std::string>(tag::crypto_type_name);
173 strlcpy(reinterpret_cast<char*>(crypt_ftr.crypto_type_name),
174 crypto_type_name.c_str(),
175 sizeof(crypt_ftr.crypto_type_name));
176 std::string master_key = props.Get<std::string>(tag::master_key);
177 crypt_ftr.keysize = master_key.size();
178 if (crypt_ftr.keysize > sizeof(crypt_ftr.master_key)) {
179 SLOGE("Master key size too long");
180 return -1;
181 }
182 memcpy(crypt_ftr.master_key, &master_key[0], crypt_ftr.keysize);
183 std::string salt = props.Get<std::string>(tag::salt);
184 if (salt.size() != SALT_LEN) {
185 SLOGE("Salt wrong length");
186 return -1;
187 }
188 memcpy(crypt_ftr.salt, &salt[0], SALT_LEN);
189 crypt_ftr.kdf_type = props.Get<int>(tag::kdf_type);
190 crypt_ftr.N_factor = props.Get<int>(tag::N_factor);
191 crypt_ftr.r_factor = props.Get<int>(tag::r_factor);
192 crypt_ftr.p_factor = props.Get<int>(tag::p_factor);
193 std::string keymaster_blob = props.Get<std::string>(tag::keymaster_blob);
194 crypt_ftr.keymaster_blob_size = keymaster_blob.size();
195 if (crypt_ftr.keymaster_blob_size > sizeof(crypt_ftr.keymaster_blob)) {
196 SLOGE("Keymaster blob too long");
197 return -1;
198 }
199 memcpy(crypt_ftr.keymaster_blob, &keymaster_blob[0],
200 crypt_ftr.keymaster_blob_size);
201 std::string scrypted_intermediate_key = props.Get<std::string>(tag::scrypted_intermediate_key);
202 if (scrypted_intermediate_key.size() != SCRYPT_LEN) {
203 SLOGE("scrypted intermediate key wrong length");
204 return -1;
205 }
206 memcpy(crypt_ftr.scrypted_intermediate_key, &scrypted_intermediate_key[0],
207 SCRYPT_LEN);
208
209 return 0;
210}
211
212static UnencryptedProperties GetProps(const char* path)
213{
214 return UnencryptedProperties(path);
215}
216
217static UnencryptedProperties GetAltProps(const char* path)
218{
219 return UnencryptedProperties((std::string() + path + "/tmp_mnt").c_str());
220}
221
222static UnencryptedProperties GetPropsOrAltProps(const char* path)
223{
224 UnencryptedProperties props = GetProps(path);
225 if (props.OK()) {
226 return props;
227 }
228 return GetAltProps(path);
229}
230
231int e4crypt_enable(const char* path)
232{
233 // Already enabled?
234 if (s_key_store.find(path) != s_key_store.end()) {
235 return 0;
236 }
237
238 // Not an encryptable device?
239 UnencryptedProperties key_props = GetProps(path).GetChild(properties::key);
240 if (!key_props.OK()) {
241 return 0;
242 }
243
244 if (key_props.Get<std::string>(tag::master_key).empty()) {
245 crypt_mnt_ftr ftr;
246 if (cryptfs_create_default_ftr(&ftr, key_length)) {
247 SLOGE("Failed to create crypto footer");
248 return -1;
249 }
250
Paul Lawrence0d9cd9e2015-05-05 15:58:27 -0700251 // Scrub fields not used by ext4enc
252 ftr.persist_data_offset[0] = 0;
253 ftr.persist_data_offset[1] = 0;
254 ftr.persist_data_size = 0;
255
Paul Lawrence731a7a22015-04-28 22:14:15 +0000256 if (put_crypt_ftr_and_key(ftr, key_props)) {
257 SLOGE("Failed to write crypto footer");
258 return -1;
259 }
260
261 crypt_mnt_ftr ftr2;
262 if (get_crypt_ftr_and_key(ftr2, key_props)) {
263 SLOGE("Failed to read crypto footer back");
264 return -1;
265 }
266
267 if (memcmp(&ftr, &ftr2, sizeof(ftr)) != 0) {
268 SLOGE("Crypto footer not correctly written");
Paul Lawrence0d9cd9e2015-05-05 15:58:27 -0700269 return -1;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000270 }
271 }
272
273 if (!UnencryptedProperties(path).Remove(properties::ref)) {
274 SLOGE("Failed to remove key ref");
275 return -1;
276 }
277
278 return e4crypt_check_passwd(path, "");
279}
280
281int e4crypt_change_password(const char* path, int crypt_type,
282 const char* password)
283{
284 SLOGI("e4crypt_change_password");
Paul Lawrencea56d3132015-05-04 15:48:24 -0700285 auto key_props = GetProps(path).GetChild(properties::key);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000286
287 crypt_mnt_ftr ftr;
288 if (get_crypt_ftr_and_key(ftr, key_props)) {
289 SLOGE("Failed to read crypto footer back");
290 return -1;
291 }
292
293 auto mki = s_key_store.find(path);
294 if (mki == s_key_store.end()) {
295 SLOGE("No stored master key - can't change password");
296 return -1;
297 }
298
Paul Crowley95376d62015-05-06 15:04:43 +0100299 const unsigned char* master_key_bytes
Paul Lawrence731a7a22015-04-28 22:14:15 +0000300 = reinterpret_cast<const unsigned char*>(&mki->second.master_key[0]);
301
Paul Crowley95376d62015-05-06 15:04:43 +0100302 if (cryptfs_set_password(&ftr, password, master_key_bytes)) {
Paul Lawrence731a7a22015-04-28 22:14:15 +0000303 SLOGE("Failed to set password");
304 return -1;
305 }
306
307 ftr.crypt_type = crypt_type;
308
309 if (put_crypt_ftr_and_key(ftr, key_props)) {
310 SLOGE("Failed to write crypto footer");
311 return -1;
312 }
313
314 if (!UnencryptedProperties(path).Set(properties::is_default,
315 crypt_type == CRYPT_TYPE_DEFAULT)) {
316 SLOGE("Failed to update default flag");
317 return -1;
318 }
319
320 return 0;
321}
322
323int e4crypt_crypto_complete(const char* path)
324{
325 SLOGI("ext4 crypto complete called on %s", path);
Paul Lawrencea56d3132015-05-04 15:48:24 -0700326 auto key_props = GetPropsOrAltProps(path).GetChild(properties::key);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000327 if (key_props.Get<std::string>(tag::master_key).empty()) {
328 SLOGI("No master key, so not ext4enc");
329 return -1;
330 }
331
332 return 0;
333}
334
Paul Crowley93363482015-07-07 15:17:22 +0100335// Get raw keyref - used to make keyname and to pass to ioctl
Paul Lawrencefd7db732015-04-10 07:48:51 -0700336static std::string generate_key_ref(const char* key, int length)
337{
338 SHA512_CTX c;
339
340 SHA512_Init(&c);
341 SHA512_Update(&c, key, length);
Paul Crowley285956f2016-01-20 13:12:38 +0000342 unsigned char key_ref1[SHA512_DIGEST_LENGTH];
Paul Lawrencefd7db732015-04-10 07:48:51 -0700343 SHA512_Final(key_ref1, &c);
344
345 SHA512_Init(&c);
Paul Crowley285956f2016-01-20 13:12:38 +0000346 SHA512_Update(&c, key_ref1, SHA512_DIGEST_LENGTH);
347 unsigned char key_ref2[SHA512_DIGEST_LENGTH];
Paul Lawrencefd7db732015-04-10 07:48:51 -0700348 SHA512_Final(key_ref2, &c);
349
350 return std::string((char*)key_ref2, EXT4_KEY_DESCRIPTOR_SIZE);
351}
352
Paul Lawrence731a7a22015-04-28 22:14:15 +0000353int e4crypt_check_passwd(const char* path, const char* password)
354{
355 SLOGI("e4crypt_check_password");
Paul Lawrencea56d3132015-05-04 15:48:24 -0700356 auto props = GetPropsOrAltProps(path);
357 auto key_props = props.GetChild(properties::key);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000358
359 crypt_mnt_ftr ftr;
360 if (get_crypt_ftr_and_key(ftr, key_props)) {
361 SLOGE("Failed to read crypto footer back");
362 return -1;
363 }
364
Paul Crowley95376d62015-05-06 15:04:43 +0100365 unsigned char master_key_bytes[key_length / 8];
366 if (cryptfs_get_master_key (&ftr, password, master_key_bytes)){
Paul Lawrence731a7a22015-04-28 22:14:15 +0000367 SLOGI("Incorrect password");
Paul Lawrencec78c71b2015-04-14 15:26:29 -0700368 ftr.failed_decrypt_count++;
369 if (put_crypt_ftr_and_key(ftr, key_props)) {
370 SLOGW("Failed to update failed_decrypt_count");
371 }
372 return ftr.failed_decrypt_count;
373 }
374
375 if (ftr.failed_decrypt_count) {
376 ftr.failed_decrypt_count = 0;
377 if (put_crypt_ftr_and_key(ftr, key_props)) {
378 SLOGW("Failed to reset failed_decrypt_count");
379 }
Paul Lawrence731a7a22015-04-28 22:14:15 +0000380 }
Paul Crowley95376d62015-05-06 15:04:43 +0100381 std::string master_key(reinterpret_cast<char*>(master_key_bytes),
382 sizeof(master_key_bytes));
Paul Lawrence731a7a22015-04-28 22:14:15 +0000383
Paul Lawrence86c942a2015-05-06 13:53:43 -0700384 struct timespec now;
385 clock_gettime(CLOCK_BOOTTIME, &now);
Paul Crowley95376d62015-05-06 15:04:43 +0100386 s_key_store[path] = keys{master_key, password,
Paul Lawrence86c942a2015-05-06 13:53:43 -0700387 now.tv_sec + password_max_age_seconds};
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000388 std::string raw_ref;
389 if (!install_key(master_key, raw_ref)) {
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100390 return -1;
391 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000392 SLOGD("Installed master key");
Paul Lawrence731a7a22015-04-28 22:14:15 +0000393
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100394 // Save reference to key so we can set policy later
395 if (!props.Set(properties::ref, raw_ref)) {
396 SLOGE("Cannot save key reference");
397 return -1;
398 }
399
400 return 0;
401}
402
Paul Crowley93363482015-07-07 15:17:22 +0100403static ext4_encryption_key fill_key(const std::string &key)
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100404{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700405 // ext4enc:TODO Currently raw key is required to be of length
406 // sizeof(ext4_key.raw) == EXT4_MAX_KEY_SIZE, so zero pad to
407 // this length. Change when kernel bug is fixed.
408 ext4_encryption_key ext4_key = {EXT4_ENCRYPTION_MODE_AES_256_XTS,
409 {0},
410 sizeof(ext4_key.raw)};
411 memset(ext4_key.raw, 0, sizeof(ext4_key.raw));
412 static_assert(key_length / 8 <= sizeof(ext4_key.raw),
413 "Key too long!");
Paul Crowley95376d62015-05-06 15:04:43 +0100414 memcpy(ext4_key.raw, &key[0], key.size());
Paul Crowley93363482015-07-07 15:17:22 +0100415 return ext4_key;
416}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000417
Paul Crowley93363482015-07-07 15:17:22 +0100418static std::string keyname(const std::string &raw_ref)
419{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700420 std::ostringstream o;
Paul Crowley93363482015-07-07 15:17:22 +0100421 o << "ext4:";
Paul Lawrencefd7db732015-04-10 07:48:51 -0700422 for (auto i = raw_ref.begin(); i != raw_ref.end(); ++i) {
423 o << std::hex << std::setw(2) << std::setfill('0') << (int)*i;
424 }
Paul Crowley93363482015-07-07 15:17:22 +0100425 return o.str();
426}
Paul Lawrencefd7db732015-04-10 07:48:51 -0700427
Paul Crowley93363482015-07-07 15:17:22 +0100428// Get the keyring we store all keys in
429static key_serial_t e4crypt_keyring()
430{
431 return keyctl_search(KEY_SPEC_SESSION_KEYRING, "keyring", "e4crypt", 0);
432}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000433
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000434// Install password into global keyring
435// Return raw key reference for use in policy
436static bool install_key(const std::string &key, std::string &raw_ref)
Paul Crowley93363482015-07-07 15:17:22 +0100437{
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000438 if (key.size() != key_length/8) {
439 LOG(ERROR) << "Wrong size key " << key.size();
440 return false;
441 }
442 auto ext4_key = fill_key(key);
443 raw_ref = generate_key_ref(ext4_key.raw, ext4_key.size);
444 auto ref = keyname(raw_ref);
Paul Crowley93363482015-07-07 15:17:22 +0100445 key_serial_t device_keyring = e4crypt_keyring();
Paul Lawrencefd7db732015-04-10 07:48:51 -0700446 key_serial_t key_id = add_key("logon", ref.c_str(),
Paul Lawrence731a7a22015-04-28 22:14:15 +0000447 (void*)&ext4_key, sizeof(ext4_key),
448 device_keyring);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000449 if (key_id == -1) {
Paul Crowley285956f2016-01-20 13:12:38 +0000450 PLOG(ERROR) << "Failed to insert key into keyring " << device_keyring;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000451 return false;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000452 }
Paul Crowley285956f2016-01-20 13:12:38 +0000453 LOG(INFO) << "Added key " << key_id << " (" << ref << ") to keyring "
454 << device_keyring << " in process " << getpid();
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000455 return true;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000456}
457
458int e4crypt_restart(const char* path)
459{
460 SLOGI("e4crypt_restart");
461
462 int rc = 0;
463
464 SLOGI("ext4 restart called on %s", path);
465 property_set("vold.decrypt", "trigger_reset_main");
466 SLOGI("Just asked init to shut down class main");
467 sleep(2);
468
469 std::string tmp_path = std::string() + path + "/tmp_mnt";
470
Paul Lawrence2f32cda2015-05-05 14:28:25 -0700471 rc = wait_and_unmount(tmp_path.c_str(), true);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000472 if (rc) {
473 SLOGE("umount %s failed with rc %d, msg %s",
474 tmp_path.c_str(), rc, strerror(errno));
475 return rc;
476 }
477
Paul Lawrence2f32cda2015-05-05 14:28:25 -0700478 rc = wait_and_unmount(path, true);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000479 if (rc) {
480 SLOGE("umount %s failed with rc %d, msg %s",
481 path, rc, strerror(errno));
482 return rc;
483 }
484
485 return 0;
486}
487
Paul Lawrence731a7a22015-04-28 22:14:15 +0000488int e4crypt_get_password_type(const char* path)
489{
490 SLOGI("e4crypt_get_password_type");
491 return GetPropsOrAltProps(path).GetChild(properties::key)
492 .Get<int>(tag::crypt_type, CRYPT_TYPE_DEFAULT);
493}
Paul Lawrence368d7942015-04-15 14:12:00 -0700494
Paul Lawrence86c942a2015-05-06 13:53:43 -0700495const char* e4crypt_get_password(const char* path)
496{
497 SLOGI("e4crypt_get_password");
498
499 auto i = s_key_store.find(path);
500 if (i == s_key_store.end()) {
501 return 0;
502 }
503
504 struct timespec now;
505 clock_gettime(CLOCK_BOOTTIME, &now);
506 if (i->second.expiry_time < now.tv_sec) {
507 e4crypt_clear_password(path);
508 return 0;
509 }
510
511 return i->second.password.c_str();
512}
513
514void e4crypt_clear_password(const char* path)
515{
516 SLOGI("e4crypt_clear_password");
517
518 auto i = s_key_store.find(path);
519 if (i == s_key_store.end()) {
520 return;
521 }
522
523 memset(&i->second.password[0], 0, i->second.password.size());
524 i->second.password = std::string();
525}
526
Paul Lawrence368d7942015-04-15 14:12:00 -0700527int e4crypt_get_field(const char* path, const char* fieldname,
528 char* value, size_t len)
529{
530 auto v = GetPropsOrAltProps(path).GetChild(properties::props)
531 .Get<std::string>(fieldname);
532
533 if (v == "") {
534 return CRYPTO_GETFIELD_ERROR_NO_FIELD;
535 }
536
537 if (v.length() >= len) {
538 return CRYPTO_GETFIELD_ERROR_BUF_TOO_SMALL;
539 }
540
541 strlcpy(value, v.c_str(), len);
542 return 0;
543}
544
545int e4crypt_set_field(const char* path, const char* fieldname,
546 const char* value)
547{
548 return GetPropsOrAltProps(path).GetChild(properties::props)
549 .Set(fieldname, std::string(value)) ? 0 : -1;
550}
Paul Crowley95376d62015-05-06 15:04:43 +0100551
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000552static std::string get_ce_key_path(userid_t user_id) {
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000553 return StringPrintf("%s/user_%d/current", user_key_dir.c_str(), user_id);
Paul Crowleyb33e8872015-05-19 12:34:09 +0100554}
555
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000556static bool read_and_install_key(const std::string &key_path, std::string &raw_ref)
557{
558 std::string key;
559 if (!android::vold::retrieveKey(key_path, key)) return false;
560 if (!install_key(key, raw_ref)) return false;
561 return true;
Lenka Trochtova395039f2015-11-25 10:13:03 +0100562}
563
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000564static bool read_and_install_user_ce_key(userid_t user_id)
Paul Crowleyb33e8872015-05-19 12:34:09 +0100565{
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000566 if (s_ce_key_raw_refs.count(user_id) != 0) return true;
567 const auto key_path = get_ce_key_path(user_id);
568 std::string raw_ref;
569 if (!read_and_install_key(key_path, raw_ref)) return false;
570 s_ce_key_raw_refs[user_id] = raw_ref;
571 LOG(DEBUG) << "Installed ce key for user " << user_id;
Paul Crowley1ef25582016-01-21 20:26:12 +0000572 return true;
Paul Crowley285956f2016-01-20 13:12:38 +0000573}
574
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000575static bool prepare_dir(const std::string &dir, mode_t mode, uid_t uid, gid_t gid) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000576 LOG(DEBUG) << "Preparing: " << dir;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000577 if (fs_prepare_dir(dir.c_str(), mode, uid, gid) != 0) {
578 PLOG(ERROR) << "Failed to prepare " << dir;
Paul Crowley285956f2016-01-20 13:12:38 +0000579 return false;
580 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000581 return true;
582}
583
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000584static bool random_key(std::string &key) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000585 if (android::vold::ReadRandomBytes(key_length / 8, key) != 0) {
586 // TODO status_t plays badly with PLOG, fix it.
587 LOG(ERROR) << "Random read failed";
Paul Crowley285956f2016-01-20 13:12:38 +0000588 return false;
589 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000590 return true;
591}
592
593static bool path_exists(const std::string &path) {
594 return access(path.c_str(), F_OK) == 0;
595}
596
597// NB this assumes that there is only one thread listening for crypt commands, because
598// it creates keys in a fixed location.
599static bool store_key(const std::string &key_path, const std::string &key) {
600 if (path_exists(key_path)) {
601 LOG(ERROR) << "Already exists, cannot create key at: " << key_path;
602 return false;
603 }
604 if (path_exists(user_key_temp)) {
605 android::vold::destroyKey(user_key_temp);
606 }
607 if (!android::vold::storeKey(user_key_temp, key)) return false;
608 if (rename(user_key_temp.c_str(), key_path.c_str()) != 0) {
609 PLOG(ERROR) << "Unable to move new key to location: " << key_path;
610 return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100611 }
Paul Crowley285956f2016-01-20 13:12:38 +0000612 LOG(DEBUG) << "Created key " << key_path;
Paul Crowley95376d62015-05-06 15:04:43 +0100613 return true;
614}
615
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000616static bool create_and_install_user_key(userid_t user_id, bool create_ephemeral) {
617 std::string ce_key;
618 if (!random_key(ce_key)) return false;
619 if (create_ephemeral) {
620 // If the key should be created as ephemeral, don't store it.
621 s_ephemeral_users.insert(user_id);
622 } else {
623 if (!prepare_dir(user_key_dir + "/user_" + std::to_string(user_id),
624 0700, AID_ROOT, AID_ROOT)) return false;
625 if (!store_key(get_ce_key_path(user_id), ce_key)) return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100626 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000627 std::string ce_raw_ref;
628 if (!install_key(ce_key, ce_raw_ref)) return false;
629 s_ce_key_raw_refs[user_id] = ce_raw_ref;
630 LOG(DEBUG) << "Created key for user " << user_id;
631 return true;
632}
633
634static bool lookup_key_ref(const std::map<userid_t, std::string> &key_map,
635 userid_t user_id, std::string &raw_ref) {
636 auto refi = key_map.find(user_id);
637 if (refi == key_map.end()) {
638 LOG(ERROR) << "Cannot find key for " << user_id;
639 return false;
640 }
641 raw_ref = refi->second;
642 return true;
643}
644
645static bool set_policy(const std::string &raw_ref, const std::string& path) {
646 if (do_policy_set(path.c_str(), raw_ref.data(), raw_ref.size()) != 0) {
647 LOG(ERROR) << "Failed to set policy on: " << path;
648 return false;
649 }
650 return true;
Paul Crowley95376d62015-05-06 15:04:43 +0100651}
Paul Crowleyb33e8872015-05-19 12:34:09 +0100652
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000653int e4crypt_init_user0() {
654 LOG(DEBUG) << "e4crypt_init_user0";
655 if (e4crypt_is_native()) {
656 if (!prepare_dir(user_key_dir, 0700, AID_ROOT, AID_ROOT)) return -1;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000657 auto ce_path = get_ce_key_path(0);
658 if (!path_exists(ce_path)) {
659 if (!create_and_install_user_key(0, false)) return -1;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000660 }
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000661 }
662 // Ignore failures. FIXME this is horrid
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000663 // FIXME: we need an idempotent policy-setting call, which simply verifies the
664 // policy is already set on a second run, even if the directory is nonempty.
665 // Then we need to call it all the time.
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000666 e4crypt_prepare_user_storage(nullptr, 0, 0, false);
667 return 0;
668}
669
Paul Crowley27cbce92015-12-10 14:51:30 +0000670int e4crypt_vold_create_user_key(userid_t user_id, int serial, bool ephemeral) {
Paul Crowley285956f2016-01-20 13:12:38 +0000671 LOG(DEBUG) << "e4crypt_vold_create_user_key for " << user_id << " serial " << serial;
Paul Crowleyea62e262016-01-28 12:23:53 +0000672 if (!e4crypt_is_native()) {
673 return 0;
674 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000675 // FIXME test for existence of key that is not loaded yet
676 if (s_ce_key_raw_refs.count(user_id) != 0) {
Paul Crowley285956f2016-01-20 13:12:38 +0000677 LOG(ERROR) << "Already exists, can't e4crypt_vold_create_user_key for "
678 << user_id << " serial " << serial;
679 // FIXME should we fail the command?
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800680 return 0;
681 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000682 if (!create_and_install_user_key(user_id, ephemeral)) {
Paul Crowley285956f2016-01-20 13:12:38 +0000683 return -1;
684 }
685 // TODO: create second key for user_de data
686 return 0;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800687}
688
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000689static bool evict_key(const std::string &raw_ref) {
690 auto ref = keyname(raw_ref);
Paul Crowley93363482015-07-07 15:17:22 +0100691 auto key_serial = keyctl_search(e4crypt_keyring(), "logon", ref.c_str(), 0);
Paul Crowley1ef25582016-01-21 20:26:12 +0000692 if (keyctl_revoke(key_serial) != 0) {
Paul Crowley285956f2016-01-20 13:12:38 +0000693 PLOG(ERROR) << "Failed to revoke key with serial " << key_serial << " ref " << ref;
Paul Crowley1ef25582016-01-21 20:26:12 +0000694 return false;
Paul Crowley93363482015-07-07 15:17:22 +0100695 }
Paul Crowley1ef25582016-01-21 20:26:12 +0000696 LOG(DEBUG) << "Revoked key with serial " << key_serial << " ref " << ref;
697 return true;
698}
699
700int e4crypt_destroy_user_key(userid_t user_id) {
701 LOG(DEBUG) << "e4crypt_destroy_user_key(" << user_id << ")";
Paul Crowleyea62e262016-01-28 12:23:53 +0000702 if (!e4crypt_is_native()) {
703 return 0;
704 }
Paul Crowley1ef25582016-01-21 20:26:12 +0000705 // TODO: destroy second key for user_de data
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000706 bool success = true;
707 std::string raw_ref;
708 success &= lookup_key_ref(s_ce_key_raw_refs, user_id, raw_ref) && evict_key(raw_ref);
709 auto it = s_ephemeral_users.find(user_id);
710 if (it != s_ephemeral_users.end()) {
711 s_ephemeral_users.erase(it);
Paul Crowley1ef25582016-01-21 20:26:12 +0000712 } else {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000713 success &= android::vold::destroyKey(get_ce_key_path(user_id));
Lenka Trochtova395039f2015-11-25 10:13:03 +0100714 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000715 return success ? 0 : -1;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100716}
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800717
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700718static int emulated_lock(const std::string& path) {
719 if (chmod(path.c_str(), 0000) != 0) {
720 PLOG(ERROR) << "Failed to chmod " << path;
721 return -1;
722 }
723#if EMULATED_USES_SELINUX
724 if (setfilecon(path.c_str(), "u:object_r:storage_stub_file:s0") != 0) {
725 PLOG(WARNING) << "Failed to setfilecon " << path;
726 return -1;
727 }
728#endif
729 return 0;
730}
731
732static int emulated_unlock(const std::string& path, mode_t mode) {
733 if (chmod(path.c_str(), mode) != 0) {
734 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000735 // FIXME temporary workaround for b/26713622
736 if (e4crypt_is_emulated()) return -1;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700737 }
738#if EMULATED_USES_SELINUX
739 if (selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_FORCE) != 0) {
740 PLOG(WARNING) << "Failed to restorecon " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000741 // FIXME temporary workaround for b/26713622
742 if (e4crypt_is_emulated()) return -1;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700743 }
744#endif
745 return 0;
746}
747
Paul Crowley285956f2016-01-20 13:12:38 +0000748int e4crypt_unlock_user_key(userid_t user_id, int serial, const char* token) {
749 LOG(DEBUG) << "e4crypt_unlock_user_key " << user_id << " " << (token != nullptr);
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700750 if (e4crypt_is_native()) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000751 if (!read_and_install_user_ce_key(user_id)) {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000752 LOG(ERROR) << "Couldn't read key for " << user_id;
753 return -1;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800754 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700755 } else {
756 // When in emulation mode, we just use chmod. However, we also
757 // unlock directories when not in emulation mode, to bring devices
758 // back into a known-good state.
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700759 if (emulated_unlock(android::vold::BuildDataSystemCePath(user_id), 0771) ||
760 emulated_unlock(android::vold::BuildDataMediaPath(nullptr, user_id), 0770) ||
761 emulated_unlock(android::vold::BuildDataUserPath(nullptr, user_id), 0771)) {
762 LOG(ERROR) << "Failed to unlock user " << user_id;
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700763 return -1;
764 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800765 }
766 return 0;
767}
768
769int e4crypt_lock_user_key(userid_t user_id) {
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700770 if (e4crypt_is_native()) {
771 // TODO: remove from kernel keyring
772 } else if (e4crypt_is_emulated()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800773 // When in emulation mode, we just use chmod
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700774 if (emulated_lock(android::vold::BuildDataSystemCePath(user_id)) ||
775 emulated_lock(android::vold::BuildDataMediaPath(nullptr, user_id)) ||
776 emulated_lock(android::vold::BuildDataUserPath(nullptr, user_id))) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800777 PLOG(ERROR) << "Failed to lock user " << user_id;
778 return -1;
779 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800780 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700781
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800782 return 0;
783}
784
Lenka Trochtova9ad43692015-12-11 13:27:26 +0100785int e4crypt_prepare_user_storage(const char* volume_uuid,
786 userid_t user_id,
787 int serial,
788 bool ephemeral) {
Paul Crowley285956f2016-01-20 13:12:38 +0000789 if (volume_uuid) {
790 LOG(DEBUG) << "e4crypt_prepare_user_storage " << volume_uuid << " " << user_id;
791 } else {
792 LOG(DEBUG) << "e4crypt_prepare_user_storage, null volume " << user_id;
793 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000794 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
795 auto media_ce_path = android::vold::BuildDataMediaPath(volume_uuid, user_id);
796 auto user_ce_path = android::vold::BuildDataUserPath(volume_uuid, user_id);
797 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800798
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000799 // FIXME: should this be 0770 or 0700?
800 if (!prepare_dir(system_ce_path, 0770, AID_SYSTEM, AID_SYSTEM)) return -1;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000801 if (!prepare_dir(media_ce_path, 0770, AID_MEDIA_RW, AID_MEDIA_RW)) return -1;
802 if (!prepare_dir(user_ce_path, 0771, AID_SYSTEM, AID_SYSTEM)) return -1;
803 if (!prepare_dir(user_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return -1;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800804
805 if (e4crypt_crypto_complete(DATA_MNT_POINT) == 0) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000806 std::string ce_raw_ref;
807 if (!lookup_key_ref(s_ce_key_raw_refs, user_id, ce_raw_ref)) return -1;
808 if (!set_policy(ce_raw_ref, system_ce_path)) return -1;
809 if (!set_policy(ce_raw_ref, media_ce_path)) return -1;
810 if (!set_policy(ce_raw_ref, user_ce_path)) return -1;
811 // ext4enc:TODO set DE policy too
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800812 }
813
814 return 0;
815}