blob: a9c5ba54ad5dc477c93687817fa25061c4e14042 [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 "key_control.h"
42#include "cryptfs.h"
Jeff Sharkey47695b22016-02-01 17:02:29 -070043#include "ext4_crypt.h"
Paul Lawrence731a7a22015-04-28 22:14:15 +000044
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070045#define EMULATED_USES_SELINUX 0
46
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080047#include <cutils/fs.h>
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080048
Elliott Hughes7e128fb2015-12-04 15:50:53 -080049#include <android-base/file.h>
Elliott Hughes6bf05472015-12-04 17:55:33 -080050#include <android-base/logging.h>
Elliott Hughes7e128fb2015-12-04 15:50:53 -080051#include <android-base/stringprintf.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000052
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080053using android::base::StringPrintf;
Paul Crowley05720802016-02-08 15:55:41 +000054using android::vold::kEmptyAuthentication;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080055
Jeff Sharkey47695b22016-02-01 17:02:29 -070056// NOTE: keep in sync with StorageManager
57static constexpr int FLAG_STORAGE_DE = 1 << 0;
58static constexpr int FLAG_STORAGE_CE = 1 << 1;
59
Paul Lawrence731a7a22015-04-28 22:14:15 +000060namespace {
61 // Key length in bits
62 const int key_length = 128;
Paul Lawrencefd7db732015-04-10 07:48:51 -070063 static_assert(key_length % 8 == 0,
64 "Key length must be multiple of 8 bits");
Paul Lawrence731a7a22015-04-28 22:14:15 +000065
Paul Crowley38132a12016-02-09 09:50:32 +000066 const std::string device_key_dir = std::string() + DATA_MNT_POINT + "/unencrypted";
67 const std::string device_key_path = device_key_dir + "/key";
68 const std::string device_key_temp = device_key_dir + "/temp";
Paul Lawrence5a06a642016-02-03 13:39:13 -080069
Paul Crowley285956f2016-01-20 13:12:38 +000070 const std::string user_key_dir = std::string() + DATA_MNT_POINT + "/misc/vold/user_keys";
Paul Crowleyb1f3d242016-01-28 10:09:46 +000071 const std::string user_key_temp = user_key_dir + "/temp";
Paul Crowley285956f2016-01-20 13:12:38 +000072
Paul Crowley38132a12016-02-09 09:50:32 +000073 bool s_global_de_initialized = false;
Paul Lawrence7b6b5652016-02-02 11:14:59 -080074
Paul Crowleyb1f3d242016-01-28 10:09:46 +000075 // Some users are ephemeral, don't try to wipe their keys from disk
76 std::set<userid_t> s_ephemeral_users;
Paul Lawrenceaec34df2016-02-03 10:52:41 -080077
Paul Crowleyb1f3d242016-01-28 10:09:46 +000078 // Map user ids to key references
Paul Crowleyb92f83c2016-02-01 14:10:43 +000079 std::map<userid_t, std::string> s_de_key_raw_refs;
Paul Crowleyb1f3d242016-01-28 10:09:46 +000080 std::map<userid_t, std::string> s_ce_key_raw_refs;
Paul Crowley05720802016-02-08 15:55:41 +000081 // TODO abolish this map. Keys should not be long-lived in user memory, only kernel memory.
82 // See b/26948053
83 std::map<userid_t, std::string> s_ce_keys;
Paul Lawrence731a7a22015-04-28 22:14:15 +000084
Paul Crowley285956f2016-01-20 13:12:38 +000085 // ext4enc:TODO get this const from somewhere good
Paul Lawrencefd7db732015-04-10 07:48:51 -070086 const int EXT4_KEY_DESCRIPTOR_SIZE = 8;
87
Paul Lawrence731a7a22015-04-28 22:14:15 +000088 // ext4enc:TODO Include structure from somewhere sensible
89 // MUST be in sync with ext4_crypto.c in kernel
Paul Lawrencefd7db732015-04-10 07:48:51 -070090 const int EXT4_MAX_KEY_SIZE = 64;
91 const int EXT4_ENCRYPTION_MODE_AES_256_XTS = 1;
Paul Lawrence731a7a22015-04-28 22:14:15 +000092 struct ext4_encryption_key {
Paul Lawrencefd7db732015-04-10 07:48:51 -070093 uint32_t mode;
94 char raw[EXT4_MAX_KEY_SIZE];
95 uint32_t size;
Paul Lawrence731a7a22015-04-28 22:14:15 +000096 };
Paul Lawrence731a7a22015-04-28 22:14:15 +000097}
98
Paul Lawrencef10544d2016-02-04 08:18:52 -080099// TODO replace with proper function to test for file encryption
Paul Crowley38132a12016-02-09 09:50:32 +0000100bool e4crypt_is_native() {
101 char value[PROPERTY_VALUE_MAX];
102 property_get("ro.crypto.type", value, "none");
103 return !strcmp(value, "file");
104}
105
106static bool e4crypt_is_emulated() {
107 return property_get_bool("persist.sys.emulate_fbe", false);
108}
109
110static const char* escape_null(const char* value) {
111 return (value == nullptr) ? "null" : value;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000112}
113
Paul Crowley93363482015-07-07 15:17:22 +0100114// Get raw keyref - used to make keyname and to pass to ioctl
Paul Lawrencefd7db732015-04-10 07:48:51 -0700115static std::string generate_key_ref(const char* key, int length)
116{
117 SHA512_CTX c;
118
119 SHA512_Init(&c);
120 SHA512_Update(&c, key, length);
Paul Crowley285956f2016-01-20 13:12:38 +0000121 unsigned char key_ref1[SHA512_DIGEST_LENGTH];
Paul Lawrencefd7db732015-04-10 07:48:51 -0700122 SHA512_Final(key_ref1, &c);
123
124 SHA512_Init(&c);
Paul Crowley285956f2016-01-20 13:12:38 +0000125 SHA512_Update(&c, key_ref1, SHA512_DIGEST_LENGTH);
126 unsigned char key_ref2[SHA512_DIGEST_LENGTH];
Paul Lawrencefd7db732015-04-10 07:48:51 -0700127 SHA512_Final(key_ref2, &c);
128
129 return std::string((char*)key_ref2, EXT4_KEY_DESCRIPTOR_SIZE);
130}
131
Paul Crowley93363482015-07-07 15:17:22 +0100132static ext4_encryption_key fill_key(const std::string &key)
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100133{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700134 // ext4enc:TODO Currently raw key is required to be of length
135 // sizeof(ext4_key.raw) == EXT4_MAX_KEY_SIZE, so zero pad to
136 // this length. Change when kernel bug is fixed.
137 ext4_encryption_key ext4_key = {EXT4_ENCRYPTION_MODE_AES_256_XTS,
138 {0},
139 sizeof(ext4_key.raw)};
140 memset(ext4_key.raw, 0, sizeof(ext4_key.raw));
141 static_assert(key_length / 8 <= sizeof(ext4_key.raw),
142 "Key too long!");
Paul Crowley95376d62015-05-06 15:04:43 +0100143 memcpy(ext4_key.raw, &key[0], key.size());
Paul Crowley93363482015-07-07 15:17:22 +0100144 return ext4_key;
145}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000146
Paul Crowley93363482015-07-07 15:17:22 +0100147static std::string keyname(const std::string &raw_ref)
148{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700149 std::ostringstream o;
Paul Crowley93363482015-07-07 15:17:22 +0100150 o << "ext4:";
Paul Lawrencefd7db732015-04-10 07:48:51 -0700151 for (auto i = raw_ref.begin(); i != raw_ref.end(); ++i) {
152 o << std::hex << std::setw(2) << std::setfill('0') << (int)*i;
153 }
Paul Crowley93363482015-07-07 15:17:22 +0100154 return o.str();
155}
Paul Lawrencefd7db732015-04-10 07:48:51 -0700156
Paul Crowley93363482015-07-07 15:17:22 +0100157// Get the keyring we store all keys in
158static key_serial_t e4crypt_keyring()
159{
160 return keyctl_search(KEY_SPEC_SESSION_KEYRING, "keyring", "e4crypt", 0);
161}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000162
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000163// Install password into global keyring
164// Return raw key reference for use in policy
165static bool install_key(const std::string &key, std::string &raw_ref)
Paul Crowley93363482015-07-07 15:17:22 +0100166{
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000167 if (key.size() != key_length/8) {
168 LOG(ERROR) << "Wrong size key " << key.size();
169 return false;
170 }
171 auto ext4_key = fill_key(key);
172 raw_ref = generate_key_ref(ext4_key.raw, ext4_key.size);
173 auto ref = keyname(raw_ref);
Paul Crowley93363482015-07-07 15:17:22 +0100174 key_serial_t device_keyring = e4crypt_keyring();
Paul Lawrencefd7db732015-04-10 07:48:51 -0700175 key_serial_t key_id = add_key("logon", ref.c_str(),
Paul Lawrence731a7a22015-04-28 22:14:15 +0000176 (void*)&ext4_key, sizeof(ext4_key),
177 device_keyring);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000178 if (key_id == -1) {
Paul Crowley285956f2016-01-20 13:12:38 +0000179 PLOG(ERROR) << "Failed to insert key into keyring " << device_keyring;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000180 return false;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000181 }
Paul Crowley285956f2016-01-20 13:12:38 +0000182 LOG(INFO) << "Added key " << key_id << " (" << ref << ") to keyring "
183 << device_keyring << " in process " << getpid();
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000184 return true;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000185}
186
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000187static std::string get_de_key_path(userid_t user_id) {
188 return StringPrintf("%s/de/%d", user_key_dir.c_str(), user_id);
189}
190
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000191static std::string get_ce_key_path(userid_t user_id) {
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000192 return StringPrintf("%s/ce/%d/current", user_key_dir.c_str(), user_id);
Paul Crowleyb33e8872015-05-19 12:34:09 +0100193}
194
Paul Crowley05720802016-02-08 15:55:41 +0000195static bool read_and_install_user_ce_key(
196 userid_t user_id, const android::vold::KeyAuthentication &auth) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000197 if (s_ce_key_raw_refs.count(user_id) != 0) return true;
Paul Crowley05720802016-02-08 15:55:41 +0000198 const auto ce_key_path = get_ce_key_path(user_id);
199 std::string ce_key;
200 if (!android::vold::retrieveKey(ce_key_path, auth, ce_key)) return false;
201 std::string ce_raw_ref;
202 if (!install_key(ce_key, ce_raw_ref)) return false;
203 s_ce_keys[user_id] = ce_key;
204 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000205 LOG(DEBUG) << "Installed ce key for user " << user_id;
Paul Crowley1ef25582016-01-21 20:26:12 +0000206 return true;
Paul Crowley285956f2016-01-20 13:12:38 +0000207}
208
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000209static bool prepare_dir(const std::string &dir, mode_t mode, uid_t uid, gid_t gid) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000210 LOG(DEBUG) << "Preparing: " << dir;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000211 if (fs_prepare_dir(dir.c_str(), mode, uid, gid) != 0) {
212 PLOG(ERROR) << "Failed to prepare " << dir;
Paul Crowley285956f2016-01-20 13:12:38 +0000213 return false;
214 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000215 return true;
216}
217
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000218static bool random_key(std::string &key) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000219 if (android::vold::ReadRandomBytes(key_length / 8, key) != 0) {
220 // TODO status_t plays badly with PLOG, fix it.
221 LOG(ERROR) << "Random read failed";
Paul Crowley285956f2016-01-20 13:12:38 +0000222 return false;
223 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000224 return true;
225}
226
227static bool path_exists(const std::string &path) {
228 return access(path.c_str(), F_OK) == 0;
229}
230
231// NB this assumes that there is only one thread listening for crypt commands, because
232// it creates keys in a fixed location.
Paul Crowley38132a12016-02-09 09:50:32 +0000233static bool store_key(const std::string &key_path, const std::string &tmp_path,
Paul Crowley05720802016-02-08 15:55:41 +0000234 const android::vold::KeyAuthentication &auth, const std::string &key) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000235 if (path_exists(key_path)) {
236 LOG(ERROR) << "Already exists, cannot create key at: " << key_path;
237 return false;
238 }
Paul Crowley38132a12016-02-09 09:50:32 +0000239 if (path_exists(tmp_path)) {
240 android::vold::destroyKey(tmp_path);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000241 }
Paul Crowley38132a12016-02-09 09:50:32 +0000242 if (!android::vold::storeKey(tmp_path, auth, key)) return false;
243 if (rename(tmp_path.c_str(), key_path.c_str()) != 0) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000244 PLOG(ERROR) << "Unable to move new key to location: " << key_path;
245 return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100246 }
Paul Crowley285956f2016-01-20 13:12:38 +0000247 LOG(DEBUG) << "Created key " << key_path;
Paul Crowley95376d62015-05-06 15:04:43 +0100248 return true;
249}
250
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000251static bool create_and_install_user_keys(userid_t user_id, bool create_ephemeral) {
252 std::string de_key, ce_key;
253 if (!random_key(de_key)) return false;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000254 if (!random_key(ce_key)) return false;
255 if (create_ephemeral) {
256 // If the key should be created as ephemeral, don't store it.
257 s_ephemeral_users.insert(user_id);
258 } else {
Paul Crowley38132a12016-02-09 09:50:32 +0000259 if (!store_key(get_de_key_path(user_id), user_key_temp,
260 kEmptyAuthentication, de_key)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000261 if (!prepare_dir(user_key_dir + "/ce/" + std::to_string(user_id),
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000262 0700, AID_ROOT, AID_ROOT)) return false;
Paul Crowley38132a12016-02-09 09:50:32 +0000263 if (!store_key(get_ce_key_path(user_id), user_key_temp,
264 kEmptyAuthentication, ce_key)) return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100265 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000266 std::string de_raw_ref;
267 if (!install_key(de_key, de_raw_ref)) return false;
268 s_de_key_raw_refs[user_id] = de_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000269 std::string ce_raw_ref;
270 if (!install_key(ce_key, ce_raw_ref)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000271 s_ce_keys[user_id] = ce_key;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000272 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000273 LOG(DEBUG) << "Created keys for user " << user_id;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000274 return true;
275}
276
277static bool lookup_key_ref(const std::map<userid_t, std::string> &key_map,
278 userid_t user_id, std::string &raw_ref) {
279 auto refi = key_map.find(user_id);
280 if (refi == key_map.end()) {
281 LOG(ERROR) << "Cannot find key for " << user_id;
282 return false;
283 }
284 raw_ref = refi->second;
285 return true;
286}
287
Jeff Sharkey47695b22016-02-01 17:02:29 -0700288static bool ensure_policy(const std::string &raw_ref, const std::string& path) {
289 if (e4crypt_policy_ensure(path.c_str(), raw_ref.data(), raw_ref.size()) != 0) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000290 LOG(ERROR) << "Failed to set policy on: " << path;
291 return false;
292 }
293 return true;
Paul Crowley95376d62015-05-06 15:04:43 +0100294}
Paul Crowleyb33e8872015-05-19 12:34:09 +0100295
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000296static bool is_numeric(const char *name) {
297 for (const char *p = name; *p != '\0'; p++) {
298 if (!isdigit(*p))
299 return false;
300 }
301 return true;
302}
303
304static bool load_all_de_keys() {
305 auto de_dir = user_key_dir + "/de";
306 auto dirp = std::unique_ptr<DIR, int(*)(DIR*)>(opendir(de_dir.c_str()), closedir);
307 if (!dirp) {
308 PLOG(ERROR) << "Unable to read de key directory";
309 return false;
310 }
311 for (;;) {
312 errno = 0;
313 auto entry = readdir(dirp.get());
314 if (!entry) {
315 if (errno) {
316 PLOG(ERROR) << "Unable to read de key directory";
317 return false;
318 }
319 break;
320 }
321 if (entry->d_type != DT_DIR || !is_numeric(entry->d_name)) {
322 LOG(DEBUG) << "Skipping non-de-key " << entry->d_name;
323 continue;
324 }
325 userid_t user_id = atoi(entry->d_name);
326 if (s_de_key_raw_refs.count(user_id) == 0) {
Paul Crowley05720802016-02-08 15:55:41 +0000327 auto key_path = de_dir + "/" + entry->d_name;
328 std::string key;
329 if (!android::vold::retrieveKey(key_path, kEmptyAuthentication, key)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000330 std::string raw_ref;
Paul Crowley05720802016-02-08 15:55:41 +0000331 if (!install_key(key, raw_ref)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000332 s_de_key_raw_refs[user_id] = raw_ref;
333 LOG(DEBUG) << "Installed de key for user " << user_id;
334 }
335 }
336 // ext4enc:TODO: go through all DE directories, ensure that all user dirs have the
337 // correct policy set on them, and that no rogue ones exist.
338 return true;
339}
340
Paul Crowley76107cb2016-02-09 10:04:39 +0000341bool e4crypt_initialize_global_de()
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800342{
Paul Crowley38132a12016-02-09 09:50:32 +0000343 LOG(INFO) << "e4crypt_initialize_global_de";
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800344
Paul Crowley38132a12016-02-09 09:50:32 +0000345 if (s_global_de_initialized) {
346 LOG(INFO) << "Already initialized";
Paul Crowley76107cb2016-02-09 10:04:39 +0000347 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800348 }
349
350 std::string device_key;
Paul Crowley38132a12016-02-09 09:50:32 +0000351 if (path_exists(device_key_path)) {
352 if (!android::vold::retrieveKey(device_key_path,
Paul Crowley76107cb2016-02-09 10:04:39 +0000353 kEmptyAuthentication, device_key)) return false;
Paul Crowley38132a12016-02-09 09:50:32 +0000354 } else {
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800355 LOG(INFO) << "Creating new key";
Paul Crowley76107cb2016-02-09 10:04:39 +0000356 if (!random_key(device_key)) return false;
Paul Crowley38132a12016-02-09 09:50:32 +0000357 if (!store_key(device_key_path, device_key_temp,
Paul Crowley76107cb2016-02-09 10:04:39 +0000358 kEmptyAuthentication, device_key)) return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800359 }
360
361 std::string device_key_ref;
362 if (!install_key(device_key, device_key_ref)) {
363 LOG(ERROR) << "Failed to install device key";
Paul Crowley76107cb2016-02-09 10:04:39 +0000364 return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800365 }
366
Paul Lawrencef10544d2016-02-04 08:18:52 -0800367 std::string ref_filename = std::string("/data") + e4crypt_key_ref;
368 if (!android::base::WriteStringToFile(device_key_ref, ref_filename)) {
369 PLOG(ERROR) << "Cannot save key reference";
Paul Crowley76107cb2016-02-09 10:04:39 +0000370 return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800371 }
372
Paul Crowley38132a12016-02-09 09:50:32 +0000373 s_global_de_initialized = true;
Paul Crowley76107cb2016-02-09 10:04:39 +0000374 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800375}
376
Paul Crowley76107cb2016-02-09 10:04:39 +0000377bool e4crypt_init_user0() {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000378 LOG(DEBUG) << "e4crypt_init_user0";
379 if (e4crypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000380 if (!prepare_dir(user_key_dir, 0700, AID_ROOT, AID_ROOT)) return false;
381 if (!prepare_dir(user_key_dir + "/ce", 0700, AID_ROOT, AID_ROOT)) return false;
382 if (!prepare_dir(user_key_dir + "/de", 0700, AID_ROOT, AID_ROOT)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000383 auto de_path = get_de_key_path(0);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000384 auto ce_path = get_ce_key_path(0);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000385 if (!path_exists(de_path) || !path_exists(ce_path)) {
386 if (path_exists(de_path)) {
387 android::vold::destroyKey(de_path); // Ignore failure
388 }
389 if (path_exists(ce_path)) {
390 android::vold::destroyKey(ce_path); // Ignore failure
391 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000392 if (!create_and_install_user_keys(0, false)) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000393 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700394 // TODO: switch to loading only DE_0 here once framework makes
395 // explicit calls to install DE keys for secondary users
Paul Crowley76107cb2016-02-09 10:04:39 +0000396 if (!load_all_de_keys()) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000397 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700398 // We can only safely prepare DE storage here, since CE keys are probably
399 // entangled with user credentials. The framework will always prepare CE
400 // storage once CE keys are installed.
Paul Crowley76107cb2016-02-09 10:04:39 +0000401 if (!e4crypt_prepare_user_storage(nullptr, 0, 0, FLAG_STORAGE_DE)) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700402 LOG(ERROR) << "Failed to prepare user 0 storage";
Paul Crowley76107cb2016-02-09 10:04:39 +0000403 return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700404 }
Jeff Sharkey0754a452016-02-08 12:21:42 -0700405
406 // If this is a non-FBE device that recently left an emulated mode,
407 // restore user data directories to known-good state.
408 if (!e4crypt_is_native() && !e4crypt_is_emulated()) {
Jeff Sharkey695d9282016-02-08 18:10:34 -0700409 e4crypt_unlock_user_key(0, 0, "!", "!");
Jeff Sharkey0754a452016-02-08 12:21:42 -0700410 }
411
Paul Crowley76107cb2016-02-09 10:04:39 +0000412 return true;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000413}
414
Paul Crowley76107cb2016-02-09 10:04:39 +0000415bool e4crypt_vold_create_user_key(userid_t user_id, int serial, bool ephemeral) {
Paul Crowley285956f2016-01-20 13:12:38 +0000416 LOG(DEBUG) << "e4crypt_vold_create_user_key for " << user_id << " serial " << serial;
Paul Crowleyea62e262016-01-28 12:23:53 +0000417 if (!e4crypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000418 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000419 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000420 // FIXME test for existence of key that is not loaded yet
421 if (s_ce_key_raw_refs.count(user_id) != 0) {
Paul Crowley285956f2016-01-20 13:12:38 +0000422 LOG(ERROR) << "Already exists, can't e4crypt_vold_create_user_key for "
423 << user_id << " serial " << serial;
424 // FIXME should we fail the command?
Paul Crowley76107cb2016-02-09 10:04:39 +0000425 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800426 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000427 if (!create_and_install_user_keys(user_id, ephemeral)) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000428 return false;
Paul Crowley285956f2016-01-20 13:12:38 +0000429 }
430 // TODO: create second key for user_de data
Paul Crowley76107cb2016-02-09 10:04:39 +0000431 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800432}
433
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000434static bool evict_key(const std::string &raw_ref) {
435 auto ref = keyname(raw_ref);
Paul Crowley93363482015-07-07 15:17:22 +0100436 auto key_serial = keyctl_search(e4crypt_keyring(), "logon", ref.c_str(), 0);
Paul Crowley1ef25582016-01-21 20:26:12 +0000437 if (keyctl_revoke(key_serial) != 0) {
Paul Crowley285956f2016-01-20 13:12:38 +0000438 PLOG(ERROR) << "Failed to revoke key with serial " << key_serial << " ref " << ref;
Paul Crowley1ef25582016-01-21 20:26:12 +0000439 return false;
Paul Crowley93363482015-07-07 15:17:22 +0100440 }
Paul Crowley1ef25582016-01-21 20:26:12 +0000441 LOG(DEBUG) << "Revoked key with serial " << key_serial << " ref " << ref;
442 return true;
443}
444
Paul Crowley76107cb2016-02-09 10:04:39 +0000445bool e4crypt_destroy_user_key(userid_t user_id) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000446 LOG(DEBUG) << "e4crypt_destroy_user_key(" << user_id << ")";
Paul Crowleyea62e262016-01-28 12:23:53 +0000447 if (!e4crypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000448 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000449 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000450 bool success = true;
Paul Crowley05720802016-02-08 15:55:41 +0000451 s_ce_keys.erase(user_id);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000452 std::string raw_ref;
453 success &= lookup_key_ref(s_ce_key_raw_refs, user_id, raw_ref) && evict_key(raw_ref);
Paul Crowley05720802016-02-08 15:55:41 +0000454 s_ce_key_raw_refs.erase(user_id);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000455 success &= lookup_key_ref(s_de_key_raw_refs, user_id, raw_ref) && evict_key(raw_ref);
Paul Crowley05720802016-02-08 15:55:41 +0000456 s_de_key_raw_refs.erase(user_id);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000457 auto it = s_ephemeral_users.find(user_id);
458 if (it != s_ephemeral_users.end()) {
459 s_ephemeral_users.erase(it);
Paul Crowley1ef25582016-01-21 20:26:12 +0000460 } else {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000461 success &= android::vold::destroyKey(get_ce_key_path(user_id));
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000462 success &= android::vold::destroyKey(get_de_key_path(user_id));
Lenka Trochtova395039f2015-11-25 10:13:03 +0100463 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000464 return success;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100465}
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800466
Paul Crowley76107cb2016-02-09 10:04:39 +0000467static bool emulated_lock(const std::string& path) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700468 if (chmod(path.c_str(), 0000) != 0) {
469 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000470 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700471 }
472#if EMULATED_USES_SELINUX
473 if (setfilecon(path.c_str(), "u:object_r:storage_stub_file:s0") != 0) {
474 PLOG(WARNING) << "Failed to setfilecon " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000475 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700476 }
477#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000478 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700479}
480
Paul Crowley76107cb2016-02-09 10:04:39 +0000481static bool emulated_unlock(const std::string& path, mode_t mode) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700482 if (chmod(path.c_str(), mode) != 0) {
483 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000484 // FIXME temporary workaround for b/26713622
Paul Crowley76107cb2016-02-09 10:04:39 +0000485 if (e4crypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700486 }
487#if EMULATED_USES_SELINUX
488 if (selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_FORCE) != 0) {
489 PLOG(WARNING) << "Failed to restorecon " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000490 // FIXME temporary workaround for b/26713622
Paul Crowley76107cb2016-02-09 10:04:39 +0000491 if (e4crypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700492 }
493#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000494 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700495}
496
Paul Crowley05720802016-02-08 15:55:41 +0000497static bool parse_hex(const char *hex, std::string &result) {
498 if (strcmp("!", hex) == 0) {
499 result = "";
500 return true;
501 }
502 if (android::vold::HexToStr(hex, result) != 0) {
503 LOG(ERROR) << "Invalid FBE hex string"; // Don't log the string for security reasons
504 return false;
505 }
506 return true;
507}
508
Paul Crowley76107cb2016-02-09 10:04:39 +0000509bool e4crypt_change_user_key(userid_t user_id, int serial,
Paul Crowley05720802016-02-08 15:55:41 +0000510 const char* token_hex, const char* old_secret_hex, const char* new_secret_hex) {
511 LOG(DEBUG) << "e4crypt_change_user_key " << user_id << " serial=" << serial <<
512 " token_present=" << (strcmp(token_hex, "!") != 0);
Paul Crowley76107cb2016-02-09 10:04:39 +0000513 if (!e4crypt_is_native()) return true;
514 if (s_ephemeral_users.count(user_id) != 0) return true;
Paul Crowley05720802016-02-08 15:55:41 +0000515 std::string token, old_secret, new_secret;
Paul Crowley76107cb2016-02-09 10:04:39 +0000516 if (!parse_hex(token_hex, token)) return false;
517 if (!parse_hex(old_secret_hex, old_secret)) return false;
518 if (!parse_hex(new_secret_hex, new_secret)) return false;
Paul Crowleyad2eb642016-02-10 17:56:05 +0000519 auto old_auth = old_secret.empty()
520 ? kEmptyAuthentication
521 : android::vold::KeyAuthentication(token, old_secret);
522 auto new_auth = new_secret.empty()
Paul Crowley05720802016-02-08 15:55:41 +0000523 ? kEmptyAuthentication
524 : android::vold::KeyAuthentication(token, new_secret);
525 auto it = s_ce_keys.find(user_id);
526 if (it == s_ce_keys.end()) {
527 LOG(ERROR) << "Key not loaded into memory, can't change for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000528 return false;
Paul Crowley05720802016-02-08 15:55:41 +0000529 }
530 auto ce_key = it->second;
531 auto ce_key_path = get_ce_key_path(user_id);
Paul Crowleyad2eb642016-02-10 17:56:05 +0000532 std::string trial_key;
533 if (!android::vold::retrieveKey(ce_key_path, old_auth, trial_key)) {
534 LOG(WARNING) << "change_user_key wasn't given enough info to reconstruct the key";
535 } else if (ce_key != trial_key) {
536 LOG(WARNING) << "Reconstructed key != stored key";
537 }
Paul Crowley05720802016-02-08 15:55:41 +0000538 android::vold::destroyKey(ce_key_path);
Paul Crowleyad2eb642016-02-10 17:56:05 +0000539 if (!store_key(ce_key_path, user_key_temp, new_auth, ce_key)) return false;
Paul Crowley76107cb2016-02-09 10:04:39 +0000540 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000541}
542
Jeff Sharkey47695b22016-02-01 17:02:29 -0700543// TODO: rename to 'install' for consistency, and take flags to know which keys to install
Paul Crowley76107cb2016-02-09 10:04:39 +0000544bool e4crypt_unlock_user_key(userid_t user_id, int serial,
Paul Crowley05720802016-02-08 15:55:41 +0000545 const char* token_hex, const char* secret_hex) {
546 LOG(DEBUG) << "e4crypt_unlock_user_key " << user_id << " serial=" << serial <<
547 " token_present=" << (strcmp(token_hex, "!") != 0);
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700548 if (e4crypt_is_native()) {
Paul Crowley05720802016-02-08 15:55:41 +0000549 if (s_ce_key_raw_refs.count(user_id) != 0) {
550 LOG(WARNING) << "Tried to unlock already-unlocked key for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000551 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000552 }
553 std::string token, secret;
554 if (!parse_hex(token_hex, token)) return false;
555 if (!parse_hex(secret_hex, secret)) return false;
556 android::vold::KeyAuthentication auth(token, secret);
557 if (!read_and_install_user_ce_key(user_id, auth)) {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000558 LOG(ERROR) << "Couldn't read key for " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000559 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800560 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700561 } else {
562 // When in emulation mode, we just use chmod. However, we also
563 // unlock directories when not in emulation mode, to bring devices
564 // back into a known-good state.
Paul Crowley76107cb2016-02-09 10:04:39 +0000565 if (!emulated_unlock(android::vold::BuildDataSystemCePath(user_id), 0771) ||
566 !emulated_unlock(android::vold::BuildDataMiscCePath(user_id), 01771) ||
567 !emulated_unlock(android::vold::BuildDataMediaPath(nullptr, user_id), 0770) ||
568 !emulated_unlock(android::vold::BuildDataUserPath(nullptr, user_id), 0771)) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700569 LOG(ERROR) << "Failed to unlock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000570 return false;
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700571 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800572 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000573 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800574}
575
Jeff Sharkey47695b22016-02-01 17:02:29 -0700576// TODO: rename to 'evict' for consistency
Paul Crowley76107cb2016-02-09 10:04:39 +0000577bool e4crypt_lock_user_key(userid_t user_id) {
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700578 if (e4crypt_is_native()) {
579 // TODO: remove from kernel keyring
580 } else if (e4crypt_is_emulated()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800581 // When in emulation mode, we just use chmod
Paul Crowley76107cb2016-02-09 10:04:39 +0000582 if (!emulated_lock(android::vold::BuildDataSystemCePath(user_id)) ||
583 !emulated_lock(android::vold::BuildDataMiscCePath(user_id)) ||
584 !emulated_lock(android::vold::BuildDataMediaPath(nullptr, user_id)) ||
585 !emulated_lock(android::vold::BuildDataUserPath(nullptr, user_id))) {
Paul Crowley57eedbf2016-02-09 09:30:23 +0000586 LOG(ERROR) << "Failed to lock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000587 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800588 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800589 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700590
Paul Crowley76107cb2016-02-09 10:04:39 +0000591 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800592}
593
Paul Crowley76107cb2016-02-09 10:04:39 +0000594bool e4crypt_prepare_user_storage(const char* volume_uuid, userid_t user_id,
Jeff Sharkey47695b22016-02-01 17:02:29 -0700595 int serial, int flags) {
596 LOG(DEBUG) << "e4crypt_prepare_user_storage for volume " << escape_null(volume_uuid)
597 << ", user " << user_id << ", serial " << serial << ", flags " << flags;
598
599 if (flags & FLAG_STORAGE_DE) {
600 auto system_de_path = android::vold::BuildDataSystemDePath(user_id);
601 auto misc_de_path = android::vold::BuildDataMiscDePath(user_id);
602 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
603
Paul Crowley76107cb2016-02-09 10:04:39 +0000604 if (!prepare_dir(system_de_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
605 if (!prepare_dir(misc_de_path, 01771, AID_SYSTEM, AID_MISC)) return false;
606 if (!prepare_dir(user_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Calin Juravled1ee9442016-03-02 18:36:50 +0000607
608 if (volume_uuid == nullptr) {
609 // Prepare profile directories only for the internal storage.
610 // For now, we do not store profiles on the adopted storage.
611 auto profiles_de_path = android::vold::BuildDataProfilesDePath(user_id);
612 auto foreign_dex_profiles_de_path =
613 android::vold::BuildDataProfilesForeignDexDePath(user_id);
614 if (!prepare_dir(profiles_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
615 if (!prepare_dir(foreign_dex_profiles_de_path, 0773, AID_SYSTEM, AID_SYSTEM)) {
616 return false;
617 }
618 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700619
Paul Crowley38132a12016-02-09 09:50:32 +0000620 if (e4crypt_is_native()) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700621 std::string de_raw_ref;
Paul Crowley76107cb2016-02-09 10:04:39 +0000622 if (!lookup_key_ref(s_de_key_raw_refs, user_id, de_raw_ref)) return false;
623 if (!ensure_policy(de_raw_ref, system_de_path)) return false;
624 if (!ensure_policy(de_raw_ref, misc_de_path)) return false;
625 if (!ensure_policy(de_raw_ref, user_de_path)) return false;
Calin Juravle79f55a42016-02-17 20:14:46 +0000626 // No need to set the policy for profiles_de_path. The parent directory (/data/misc)
627 // already has a DE_sys policy set.
Jeff Sharkey47695b22016-02-01 17:02:29 -0700628 }
Paul Crowley285956f2016-01-20 13:12:38 +0000629 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800630
Jeff Sharkey47695b22016-02-01 17:02:29 -0700631 if (flags & FLAG_STORAGE_CE) {
632 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
633 auto misc_ce_path = android::vold::BuildDataMiscCePath(user_id);
634 auto media_ce_path = android::vold::BuildDataMediaPath(volume_uuid, user_id);
635 auto user_ce_path = android::vold::BuildDataUserPath(volume_uuid, user_id);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800636
Paul Crowley76107cb2016-02-09 10:04:39 +0000637 if (!prepare_dir(system_ce_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
638 if (!prepare_dir(misc_ce_path, 01771, AID_SYSTEM, AID_MISC)) return false;
639 if (!prepare_dir(media_ce_path, 0770, AID_MEDIA_RW, AID_MEDIA_RW)) return false;
640 if (!prepare_dir(user_ce_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700641
Paul Crowley38132a12016-02-09 09:50:32 +0000642 if (e4crypt_is_native()) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700643 std::string ce_raw_ref;
Paul Crowley76107cb2016-02-09 10:04:39 +0000644 if (!lookup_key_ref(s_ce_key_raw_refs, user_id, ce_raw_ref)) return false;
645 if (!ensure_policy(ce_raw_ref, system_ce_path)) return false;
646 if (!ensure_policy(ce_raw_ref, misc_ce_path)) return false;
647 if (!ensure_policy(ce_raw_ref, media_ce_path)) return false;
648 if (!ensure_policy(ce_raw_ref, user_ce_path)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700649 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800650 }
651
Paul Crowley76107cb2016-02-09 10:04:39 +0000652 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800653}