blob: fdc0197c6e0ede067995e9ea3378ccfd73df6ddd [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 {
Paul Crowley38132a12016-02-09 09:50:32 +000061 const std::string device_key_dir = std::string() + DATA_MNT_POINT + "/unencrypted";
62 const std::string device_key_path = device_key_dir + "/key";
63 const std::string device_key_temp = device_key_dir + "/temp";
Paul Lawrence5a06a642016-02-03 13:39:13 -080064
Paul Crowley285956f2016-01-20 13:12:38 +000065 const std::string user_key_dir = std::string() + DATA_MNT_POINT + "/misc/vold/user_keys";
Paul Crowleyb1f3d242016-01-28 10:09:46 +000066 const std::string user_key_temp = user_key_dir + "/temp";
Paul Crowley285956f2016-01-20 13:12:38 +000067
Paul Crowley38132a12016-02-09 09:50:32 +000068 bool s_global_de_initialized = false;
Paul Lawrence7b6b5652016-02-02 11:14:59 -080069
Paul Crowleyb1f3d242016-01-28 10:09:46 +000070 // Some users are ephemeral, don't try to wipe their keys from disk
71 std::set<userid_t> s_ephemeral_users;
Paul Lawrenceaec34df2016-02-03 10:52:41 -080072
Paul Crowleyb1f3d242016-01-28 10:09:46 +000073 // Map user ids to key references
Paul Crowleyb92f83c2016-02-01 14:10:43 +000074 std::map<userid_t, std::string> s_de_key_raw_refs;
Paul Crowleyb1f3d242016-01-28 10:09:46 +000075 std::map<userid_t, std::string> s_ce_key_raw_refs;
Paul Crowley05720802016-02-08 15:55:41 +000076 // TODO abolish this map. Keys should not be long-lived in user memory, only kernel memory.
77 // See b/26948053
78 std::map<userid_t, std::string> s_ce_keys;
Paul Lawrence731a7a22015-04-28 22:14:15 +000079
Paul Crowley285956f2016-01-20 13:12:38 +000080 // ext4enc:TODO get this const from somewhere good
Paul Lawrencefd7db732015-04-10 07:48:51 -070081 const int EXT4_KEY_DESCRIPTOR_SIZE = 8;
82
Paul Lawrence731a7a22015-04-28 22:14:15 +000083 // ext4enc:TODO Include structure from somewhere sensible
84 // MUST be in sync with ext4_crypto.c in kernel
Paul Crowley21990692016-03-02 09:15:07 -080085 constexpr int EXT4_ENCRYPTION_MODE_AES_256_XTS = 1;
86 constexpr int EXT4_AES_256_XTS_KEY_SIZE = 64;
87 constexpr int EXT4_MAX_KEY_SIZE = 64;
Paul Lawrence731a7a22015-04-28 22:14:15 +000088 struct ext4_encryption_key {
Paul Lawrencefd7db732015-04-10 07:48:51 -070089 uint32_t mode;
90 char raw[EXT4_MAX_KEY_SIZE];
91 uint32_t size;
Paul Lawrence731a7a22015-04-28 22:14:15 +000092 };
Paul Lawrence731a7a22015-04-28 22:14:15 +000093}
94
Paul Lawrencef10544d2016-02-04 08:18:52 -080095// TODO replace with proper function to test for file encryption
Paul Crowley38132a12016-02-09 09:50:32 +000096bool e4crypt_is_native() {
97 char value[PROPERTY_VALUE_MAX];
98 property_get("ro.crypto.type", value, "none");
99 return !strcmp(value, "file");
100}
101
102static bool e4crypt_is_emulated() {
103 return property_get_bool("persist.sys.emulate_fbe", false);
104}
105
106static const char* escape_null(const char* value) {
107 return (value == nullptr) ? "null" : value;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000108}
109
Paul Crowley93363482015-07-07 15:17:22 +0100110// Get raw keyref - used to make keyname and to pass to ioctl
Paul Lawrencefd7db732015-04-10 07:48:51 -0700111static std::string generate_key_ref(const char* key, int length)
112{
113 SHA512_CTX c;
114
115 SHA512_Init(&c);
116 SHA512_Update(&c, key, length);
Paul Crowley285956f2016-01-20 13:12:38 +0000117 unsigned char key_ref1[SHA512_DIGEST_LENGTH];
Paul Lawrencefd7db732015-04-10 07:48:51 -0700118 SHA512_Final(key_ref1, &c);
119
120 SHA512_Init(&c);
Paul Crowley285956f2016-01-20 13:12:38 +0000121 SHA512_Update(&c, key_ref1, SHA512_DIGEST_LENGTH);
122 unsigned char key_ref2[SHA512_DIGEST_LENGTH];
Paul Lawrencefd7db732015-04-10 07:48:51 -0700123 SHA512_Final(key_ref2, &c);
124
125 return std::string((char*)key_ref2, EXT4_KEY_DESCRIPTOR_SIZE);
126}
127
Paul Crowley21990692016-03-02 09:15:07 -0800128static bool fill_key(const std::string& key, ext4_encryption_key& ext4_key)
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100129{
Paul Crowley21990692016-03-02 09:15:07 -0800130 if (key.size() != EXT4_AES_256_XTS_KEY_SIZE) {
131 LOG(ERROR) << "Wrong size key " << key.size();
132 return false;
133 }
134 static_assert(EXT4_AES_256_XTS_KEY_SIZE <= sizeof(ext4_key.raw),
Paul Lawrencefd7db732015-04-10 07:48:51 -0700135 "Key too long!");
Paul Crowley21990692016-03-02 09:15:07 -0800136 ext4_key.mode = EXT4_ENCRYPTION_MODE_AES_256_XTS;
137 ext4_key.size = key.size();
138 memset(ext4_key.raw, 0, sizeof(ext4_key.raw));
139 memcpy(ext4_key.raw, key.data(), key.size());
140 return true;
Paul Crowley93363482015-07-07 15:17:22 +0100141}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000142
Paul Crowley93363482015-07-07 15:17:22 +0100143static std::string keyname(const std::string &raw_ref)
144{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700145 std::ostringstream o;
Paul Crowley93363482015-07-07 15:17:22 +0100146 o << "ext4:";
Paul Lawrencefd7db732015-04-10 07:48:51 -0700147 for (auto i = raw_ref.begin(); i != raw_ref.end(); ++i) {
148 o << std::hex << std::setw(2) << std::setfill('0') << (int)*i;
149 }
Paul Crowley93363482015-07-07 15:17:22 +0100150 return o.str();
151}
Paul Lawrencefd7db732015-04-10 07:48:51 -0700152
Paul Crowley93363482015-07-07 15:17:22 +0100153// Get the keyring we store all keys in
154static key_serial_t e4crypt_keyring()
155{
156 return keyctl_search(KEY_SPEC_SESSION_KEYRING, "keyring", "e4crypt", 0);
157}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000158
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000159// Install password into global keyring
160// Return raw key reference for use in policy
161static bool install_key(const std::string &key, std::string &raw_ref)
Paul Crowley93363482015-07-07 15:17:22 +0100162{
Paul Crowley21990692016-03-02 09:15:07 -0800163 ext4_encryption_key ext4_key;
164 if (!fill_key(key, ext4_key)) return false;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000165 raw_ref = generate_key_ref(ext4_key.raw, ext4_key.size);
166 auto ref = keyname(raw_ref);
Paul Crowley93363482015-07-07 15:17:22 +0100167 key_serial_t device_keyring = e4crypt_keyring();
Paul Lawrencefd7db732015-04-10 07:48:51 -0700168 key_serial_t key_id = add_key("logon", ref.c_str(),
Paul Lawrence731a7a22015-04-28 22:14:15 +0000169 (void*)&ext4_key, sizeof(ext4_key),
170 device_keyring);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000171 if (key_id == -1) {
Paul Crowley285956f2016-01-20 13:12:38 +0000172 PLOG(ERROR) << "Failed to insert key into keyring " << device_keyring;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000173 return false;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000174 }
Paul Crowley285956f2016-01-20 13:12:38 +0000175 LOG(INFO) << "Added key " << key_id << " (" << ref << ") to keyring "
176 << device_keyring << " in process " << getpid();
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000177 return true;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000178}
179
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000180static std::string get_de_key_path(userid_t user_id) {
181 return StringPrintf("%s/de/%d", user_key_dir.c_str(), user_id);
182}
183
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000184static std::string get_ce_key_path(userid_t user_id) {
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000185 return StringPrintf("%s/ce/%d/current", user_key_dir.c_str(), user_id);
Paul Crowleyb33e8872015-05-19 12:34:09 +0100186}
187
Paul Crowley05720802016-02-08 15:55:41 +0000188static bool read_and_install_user_ce_key(
189 userid_t user_id, const android::vold::KeyAuthentication &auth) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000190 if (s_ce_key_raw_refs.count(user_id) != 0) return true;
Paul Crowley05720802016-02-08 15:55:41 +0000191 const auto ce_key_path = get_ce_key_path(user_id);
192 std::string ce_key;
193 if (!android::vold::retrieveKey(ce_key_path, auth, ce_key)) return false;
194 std::string ce_raw_ref;
195 if (!install_key(ce_key, ce_raw_ref)) return false;
196 s_ce_keys[user_id] = ce_key;
197 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000198 LOG(DEBUG) << "Installed ce key for user " << user_id;
Paul Crowley1ef25582016-01-21 20:26:12 +0000199 return true;
Paul Crowley285956f2016-01-20 13:12:38 +0000200}
201
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000202static bool prepare_dir(const std::string &dir, mode_t mode, uid_t uid, gid_t gid) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000203 LOG(DEBUG) << "Preparing: " << dir;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000204 if (fs_prepare_dir(dir.c_str(), mode, uid, gid) != 0) {
205 PLOG(ERROR) << "Failed to prepare " << dir;
Paul Crowley285956f2016-01-20 13:12:38 +0000206 return false;
207 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000208 return true;
209}
210
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000211static bool random_key(std::string &key) {
Paul Crowley21990692016-03-02 09:15:07 -0800212 if (android::vold::ReadRandomBytes(EXT4_AES_256_XTS_KEY_SIZE, key) != 0) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000213 // TODO status_t plays badly with PLOG, fix it.
214 LOG(ERROR) << "Random read failed";
Paul Crowley285956f2016-01-20 13:12:38 +0000215 return false;
216 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000217 return true;
218}
219
220static bool path_exists(const std::string &path) {
221 return access(path.c_str(), F_OK) == 0;
222}
223
224// NB this assumes that there is only one thread listening for crypt commands, because
225// it creates keys in a fixed location.
Paul Crowley38132a12016-02-09 09:50:32 +0000226static bool store_key(const std::string &key_path, const std::string &tmp_path,
Paul Crowley05720802016-02-08 15:55:41 +0000227 const android::vold::KeyAuthentication &auth, const std::string &key) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000228 if (path_exists(key_path)) {
229 LOG(ERROR) << "Already exists, cannot create key at: " << key_path;
230 return false;
231 }
Paul Crowley38132a12016-02-09 09:50:32 +0000232 if (path_exists(tmp_path)) {
233 android::vold::destroyKey(tmp_path);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000234 }
Paul Crowley38132a12016-02-09 09:50:32 +0000235 if (!android::vold::storeKey(tmp_path, auth, key)) return false;
236 if (rename(tmp_path.c_str(), key_path.c_str()) != 0) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000237 PLOG(ERROR) << "Unable to move new key to location: " << key_path;
238 return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100239 }
Paul Crowley285956f2016-01-20 13:12:38 +0000240 LOG(DEBUG) << "Created key " << key_path;
Paul Crowley95376d62015-05-06 15:04:43 +0100241 return true;
242}
243
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000244static bool create_and_install_user_keys(userid_t user_id, bool create_ephemeral) {
245 std::string de_key, ce_key;
246 if (!random_key(de_key)) return false;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000247 if (!random_key(ce_key)) return false;
248 if (create_ephemeral) {
249 // If the key should be created as ephemeral, don't store it.
250 s_ephemeral_users.insert(user_id);
251 } else {
Paul Crowley38132a12016-02-09 09:50:32 +0000252 if (!store_key(get_de_key_path(user_id), user_key_temp,
253 kEmptyAuthentication, de_key)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000254 if (!prepare_dir(user_key_dir + "/ce/" + std::to_string(user_id),
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000255 0700, AID_ROOT, AID_ROOT)) return false;
Paul Crowley38132a12016-02-09 09:50:32 +0000256 if (!store_key(get_ce_key_path(user_id), user_key_temp,
257 kEmptyAuthentication, ce_key)) return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100258 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000259 std::string de_raw_ref;
260 if (!install_key(de_key, de_raw_ref)) return false;
261 s_de_key_raw_refs[user_id] = de_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000262 std::string ce_raw_ref;
263 if (!install_key(ce_key, ce_raw_ref)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000264 s_ce_keys[user_id] = ce_key;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000265 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000266 LOG(DEBUG) << "Created keys for user " << user_id;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000267 return true;
268}
269
270static bool lookup_key_ref(const std::map<userid_t, std::string> &key_map,
271 userid_t user_id, std::string &raw_ref) {
272 auto refi = key_map.find(user_id);
273 if (refi == key_map.end()) {
274 LOG(ERROR) << "Cannot find key for " << user_id;
275 return false;
276 }
277 raw_ref = refi->second;
278 return true;
279}
280
Jeff Sharkey47695b22016-02-01 17:02:29 -0700281static bool ensure_policy(const std::string &raw_ref, const std::string& path) {
282 if (e4crypt_policy_ensure(path.c_str(), raw_ref.data(), raw_ref.size()) != 0) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000283 LOG(ERROR) << "Failed to set policy on: " << path;
284 return false;
285 }
286 return true;
Paul Crowley95376d62015-05-06 15:04:43 +0100287}
Paul Crowleyb33e8872015-05-19 12:34:09 +0100288
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000289static bool is_numeric(const char *name) {
290 for (const char *p = name; *p != '\0'; p++) {
291 if (!isdigit(*p))
292 return false;
293 }
294 return true;
295}
296
297static bool load_all_de_keys() {
298 auto de_dir = user_key_dir + "/de";
299 auto dirp = std::unique_ptr<DIR, int(*)(DIR*)>(opendir(de_dir.c_str()), closedir);
300 if (!dirp) {
301 PLOG(ERROR) << "Unable to read de key directory";
302 return false;
303 }
304 for (;;) {
305 errno = 0;
306 auto entry = readdir(dirp.get());
307 if (!entry) {
308 if (errno) {
309 PLOG(ERROR) << "Unable to read de key directory";
310 return false;
311 }
312 break;
313 }
314 if (entry->d_type != DT_DIR || !is_numeric(entry->d_name)) {
315 LOG(DEBUG) << "Skipping non-de-key " << entry->d_name;
316 continue;
317 }
318 userid_t user_id = atoi(entry->d_name);
319 if (s_de_key_raw_refs.count(user_id) == 0) {
Paul Crowley05720802016-02-08 15:55:41 +0000320 auto key_path = de_dir + "/" + entry->d_name;
321 std::string key;
322 if (!android::vold::retrieveKey(key_path, kEmptyAuthentication, key)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000323 std::string raw_ref;
Paul Crowley05720802016-02-08 15:55:41 +0000324 if (!install_key(key, raw_ref)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000325 s_de_key_raw_refs[user_id] = raw_ref;
326 LOG(DEBUG) << "Installed de key for user " << user_id;
327 }
328 }
329 // ext4enc:TODO: go through all DE directories, ensure that all user dirs have the
330 // correct policy set on them, and that no rogue ones exist.
331 return true;
332}
333
Paul Crowley76107cb2016-02-09 10:04:39 +0000334bool e4crypt_initialize_global_de()
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800335{
Paul Crowley38132a12016-02-09 09:50:32 +0000336 LOG(INFO) << "e4crypt_initialize_global_de";
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800337
Paul Crowley38132a12016-02-09 09:50:32 +0000338 if (s_global_de_initialized) {
339 LOG(INFO) << "Already initialized";
Paul Crowley76107cb2016-02-09 10:04:39 +0000340 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800341 }
342
343 std::string device_key;
Paul Crowley38132a12016-02-09 09:50:32 +0000344 if (path_exists(device_key_path)) {
345 if (!android::vold::retrieveKey(device_key_path,
Paul Crowley76107cb2016-02-09 10:04:39 +0000346 kEmptyAuthentication, device_key)) return false;
Paul Crowley38132a12016-02-09 09:50:32 +0000347 } else {
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800348 LOG(INFO) << "Creating new key";
Paul Crowley76107cb2016-02-09 10:04:39 +0000349 if (!random_key(device_key)) return false;
Paul Crowley38132a12016-02-09 09:50:32 +0000350 if (!store_key(device_key_path, device_key_temp,
Paul Crowley76107cb2016-02-09 10:04:39 +0000351 kEmptyAuthentication, device_key)) return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800352 }
353
354 std::string device_key_ref;
355 if (!install_key(device_key, device_key_ref)) {
356 LOG(ERROR) << "Failed to install device key";
Paul Crowley76107cb2016-02-09 10:04:39 +0000357 return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800358 }
359
Paul Lawrencef10544d2016-02-04 08:18:52 -0800360 std::string ref_filename = std::string("/data") + e4crypt_key_ref;
361 if (!android::base::WriteStringToFile(device_key_ref, ref_filename)) {
362 PLOG(ERROR) << "Cannot save key reference";
Paul Crowley76107cb2016-02-09 10:04:39 +0000363 return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800364 }
365
Paul Crowley38132a12016-02-09 09:50:32 +0000366 s_global_de_initialized = true;
Paul Crowley76107cb2016-02-09 10:04:39 +0000367 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800368}
369
Paul Crowley76107cb2016-02-09 10:04:39 +0000370bool e4crypt_init_user0() {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000371 LOG(DEBUG) << "e4crypt_init_user0";
372 if (e4crypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000373 if (!prepare_dir(user_key_dir, 0700, AID_ROOT, AID_ROOT)) return false;
374 if (!prepare_dir(user_key_dir + "/ce", 0700, AID_ROOT, AID_ROOT)) return false;
375 if (!prepare_dir(user_key_dir + "/de", 0700, AID_ROOT, AID_ROOT)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000376 auto de_path = get_de_key_path(0);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000377 auto ce_path = get_ce_key_path(0);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000378 if (!path_exists(de_path) || !path_exists(ce_path)) {
379 if (path_exists(de_path)) {
380 android::vold::destroyKey(de_path); // Ignore failure
381 }
382 if (path_exists(ce_path)) {
383 android::vold::destroyKey(ce_path); // Ignore failure
384 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000385 if (!create_and_install_user_keys(0, false)) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000386 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700387 // TODO: switch to loading only DE_0 here once framework makes
388 // explicit calls to install DE keys for secondary users
Paul Crowley76107cb2016-02-09 10:04:39 +0000389 if (!load_all_de_keys()) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000390 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700391 // We can only safely prepare DE storage here, since CE keys are probably
392 // entangled with user credentials. The framework will always prepare CE
393 // storage once CE keys are installed.
Paul Crowley76107cb2016-02-09 10:04:39 +0000394 if (!e4crypt_prepare_user_storage(nullptr, 0, 0, FLAG_STORAGE_DE)) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700395 LOG(ERROR) << "Failed to prepare user 0 storage";
Paul Crowley76107cb2016-02-09 10:04:39 +0000396 return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700397 }
Jeff Sharkey0754a452016-02-08 12:21:42 -0700398
399 // If this is a non-FBE device that recently left an emulated mode,
400 // restore user data directories to known-good state.
401 if (!e4crypt_is_native() && !e4crypt_is_emulated()) {
Jeff Sharkey695d9282016-02-08 18:10:34 -0700402 e4crypt_unlock_user_key(0, 0, "!", "!");
Jeff Sharkey0754a452016-02-08 12:21:42 -0700403 }
404
Paul Crowley76107cb2016-02-09 10:04:39 +0000405 return true;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000406}
407
Paul Crowley76107cb2016-02-09 10:04:39 +0000408bool e4crypt_vold_create_user_key(userid_t user_id, int serial, bool ephemeral) {
Paul Crowley285956f2016-01-20 13:12:38 +0000409 LOG(DEBUG) << "e4crypt_vold_create_user_key for " << user_id << " serial " << serial;
Paul Crowleyea62e262016-01-28 12:23:53 +0000410 if (!e4crypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000411 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000412 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000413 // FIXME test for existence of key that is not loaded yet
414 if (s_ce_key_raw_refs.count(user_id) != 0) {
Paul Crowley285956f2016-01-20 13:12:38 +0000415 LOG(ERROR) << "Already exists, can't e4crypt_vold_create_user_key for "
416 << user_id << " serial " << serial;
417 // FIXME should we fail the command?
Paul Crowley76107cb2016-02-09 10:04:39 +0000418 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800419 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000420 if (!create_and_install_user_keys(user_id, ephemeral)) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000421 return false;
Paul Crowley285956f2016-01-20 13:12:38 +0000422 }
423 // TODO: create second key for user_de data
Paul Crowley76107cb2016-02-09 10:04:39 +0000424 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800425}
426
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000427static bool evict_key(const std::string &raw_ref) {
428 auto ref = keyname(raw_ref);
Paul Crowley93363482015-07-07 15:17:22 +0100429 auto key_serial = keyctl_search(e4crypt_keyring(), "logon", ref.c_str(), 0);
Paul Crowley1ef25582016-01-21 20:26:12 +0000430 if (keyctl_revoke(key_serial) != 0) {
Paul Crowley285956f2016-01-20 13:12:38 +0000431 PLOG(ERROR) << "Failed to revoke key with serial " << key_serial << " ref " << ref;
Paul Crowley1ef25582016-01-21 20:26:12 +0000432 return false;
Paul Crowley93363482015-07-07 15:17:22 +0100433 }
Paul Crowley1ef25582016-01-21 20:26:12 +0000434 LOG(DEBUG) << "Revoked key with serial " << key_serial << " ref " << ref;
435 return true;
436}
437
Paul Crowley76107cb2016-02-09 10:04:39 +0000438bool e4crypt_destroy_user_key(userid_t user_id) {
Paul Crowley1ef25582016-01-21 20:26:12 +0000439 LOG(DEBUG) << "e4crypt_destroy_user_key(" << user_id << ")";
Paul Crowleyea62e262016-01-28 12:23:53 +0000440 if (!e4crypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000441 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000442 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000443 bool success = true;
Paul Crowley05720802016-02-08 15:55:41 +0000444 s_ce_keys.erase(user_id);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000445 std::string raw_ref;
446 success &= lookup_key_ref(s_ce_key_raw_refs, user_id, raw_ref) && evict_key(raw_ref);
Paul Crowley05720802016-02-08 15:55:41 +0000447 s_ce_key_raw_refs.erase(user_id);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000448 success &= lookup_key_ref(s_de_key_raw_refs, user_id, raw_ref) && evict_key(raw_ref);
Paul Crowley05720802016-02-08 15:55:41 +0000449 s_de_key_raw_refs.erase(user_id);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000450 auto it = s_ephemeral_users.find(user_id);
451 if (it != s_ephemeral_users.end()) {
452 s_ephemeral_users.erase(it);
Paul Crowley1ef25582016-01-21 20:26:12 +0000453 } else {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000454 success &= android::vold::destroyKey(get_ce_key_path(user_id));
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000455 success &= android::vold::destroyKey(get_de_key_path(user_id));
Lenka Trochtova395039f2015-11-25 10:13:03 +0100456 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000457 return success;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100458}
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800459
Paul Crowley76107cb2016-02-09 10:04:39 +0000460static bool emulated_lock(const std::string& path) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700461 if (chmod(path.c_str(), 0000) != 0) {
462 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000463 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700464 }
465#if EMULATED_USES_SELINUX
466 if (setfilecon(path.c_str(), "u:object_r:storage_stub_file:s0") != 0) {
467 PLOG(WARNING) << "Failed to setfilecon " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000468 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700469 }
470#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000471 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700472}
473
Paul Crowley76107cb2016-02-09 10:04:39 +0000474static bool emulated_unlock(const std::string& path, mode_t mode) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700475 if (chmod(path.c_str(), mode) != 0) {
476 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000477 // FIXME temporary workaround for b/26713622
Paul Crowley76107cb2016-02-09 10:04:39 +0000478 if (e4crypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700479 }
480#if EMULATED_USES_SELINUX
481 if (selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_FORCE) != 0) {
482 PLOG(WARNING) << "Failed to restorecon " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000483 // FIXME temporary workaround for b/26713622
Paul Crowley76107cb2016-02-09 10:04:39 +0000484 if (e4crypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700485 }
486#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000487 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700488}
489
Paul Crowley05720802016-02-08 15:55:41 +0000490static bool parse_hex(const char *hex, std::string &result) {
491 if (strcmp("!", hex) == 0) {
492 result = "";
493 return true;
494 }
495 if (android::vold::HexToStr(hex, result) != 0) {
496 LOG(ERROR) << "Invalid FBE hex string"; // Don't log the string for security reasons
497 return false;
498 }
499 return true;
500}
501
Paul Crowley76107cb2016-02-09 10:04:39 +0000502bool e4crypt_change_user_key(userid_t user_id, int serial,
Paul Crowley05720802016-02-08 15:55:41 +0000503 const char* token_hex, const char* old_secret_hex, const char* new_secret_hex) {
504 LOG(DEBUG) << "e4crypt_change_user_key " << user_id << " serial=" << serial <<
505 " token_present=" << (strcmp(token_hex, "!") != 0);
Paul Crowley76107cb2016-02-09 10:04:39 +0000506 if (!e4crypt_is_native()) return true;
507 if (s_ephemeral_users.count(user_id) != 0) return true;
Paul Crowley05720802016-02-08 15:55:41 +0000508 std::string token, old_secret, new_secret;
Paul Crowley76107cb2016-02-09 10:04:39 +0000509 if (!parse_hex(token_hex, token)) return false;
510 if (!parse_hex(old_secret_hex, old_secret)) return false;
511 if (!parse_hex(new_secret_hex, new_secret)) return false;
Paul Crowleyad2eb642016-02-10 17:56:05 +0000512 auto old_auth = old_secret.empty()
513 ? kEmptyAuthentication
514 : android::vold::KeyAuthentication(token, old_secret);
515 auto new_auth = new_secret.empty()
Paul Crowley05720802016-02-08 15:55:41 +0000516 ? kEmptyAuthentication
517 : android::vold::KeyAuthentication(token, new_secret);
518 auto it = s_ce_keys.find(user_id);
519 if (it == s_ce_keys.end()) {
520 LOG(ERROR) << "Key not loaded into memory, can't change for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000521 return false;
Paul Crowley05720802016-02-08 15:55:41 +0000522 }
523 auto ce_key = it->second;
524 auto ce_key_path = get_ce_key_path(user_id);
Paul Crowleyad2eb642016-02-10 17:56:05 +0000525 std::string trial_key;
526 if (!android::vold::retrieveKey(ce_key_path, old_auth, trial_key)) {
527 LOG(WARNING) << "change_user_key wasn't given enough info to reconstruct the key";
528 } else if (ce_key != trial_key) {
529 LOG(WARNING) << "Reconstructed key != stored key";
530 }
Paul Crowley05720802016-02-08 15:55:41 +0000531 android::vold::destroyKey(ce_key_path);
Paul Crowleyad2eb642016-02-10 17:56:05 +0000532 if (!store_key(ce_key_path, user_key_temp, new_auth, ce_key)) return false;
Paul Crowley76107cb2016-02-09 10:04:39 +0000533 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000534}
535
Jeff Sharkey47695b22016-02-01 17:02:29 -0700536// TODO: rename to 'install' for consistency, and take flags to know which keys to install
Paul Crowley76107cb2016-02-09 10:04:39 +0000537bool e4crypt_unlock_user_key(userid_t user_id, int serial,
Paul Crowley05720802016-02-08 15:55:41 +0000538 const char* token_hex, const char* secret_hex) {
539 LOG(DEBUG) << "e4crypt_unlock_user_key " << user_id << " serial=" << serial <<
540 " token_present=" << (strcmp(token_hex, "!") != 0);
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700541 if (e4crypt_is_native()) {
Paul Crowley05720802016-02-08 15:55:41 +0000542 if (s_ce_key_raw_refs.count(user_id) != 0) {
543 LOG(WARNING) << "Tried to unlock already-unlocked key for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000544 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000545 }
546 std::string token, secret;
547 if (!parse_hex(token_hex, token)) return false;
548 if (!parse_hex(secret_hex, secret)) return false;
549 android::vold::KeyAuthentication auth(token, secret);
550 if (!read_and_install_user_ce_key(user_id, auth)) {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000551 LOG(ERROR) << "Couldn't read key for " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000552 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800553 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700554 } else {
555 // When in emulation mode, we just use chmod. However, we also
556 // unlock directories when not in emulation mode, to bring devices
557 // back into a known-good state.
Paul Crowley76107cb2016-02-09 10:04:39 +0000558 if (!emulated_unlock(android::vold::BuildDataSystemCePath(user_id), 0771) ||
559 !emulated_unlock(android::vold::BuildDataMiscCePath(user_id), 01771) ||
560 !emulated_unlock(android::vold::BuildDataMediaPath(nullptr, user_id), 0770) ||
561 !emulated_unlock(android::vold::BuildDataUserPath(nullptr, user_id), 0771)) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700562 LOG(ERROR) << "Failed to unlock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000563 return false;
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700564 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800565 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000566 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800567}
568
Jeff Sharkey47695b22016-02-01 17:02:29 -0700569// TODO: rename to 'evict' for consistency
Paul Crowley76107cb2016-02-09 10:04:39 +0000570bool e4crypt_lock_user_key(userid_t user_id) {
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700571 if (e4crypt_is_native()) {
572 // TODO: remove from kernel keyring
573 } else if (e4crypt_is_emulated()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800574 // When in emulation mode, we just use chmod
Paul Crowley76107cb2016-02-09 10:04:39 +0000575 if (!emulated_lock(android::vold::BuildDataSystemCePath(user_id)) ||
576 !emulated_lock(android::vold::BuildDataMiscCePath(user_id)) ||
577 !emulated_lock(android::vold::BuildDataMediaPath(nullptr, user_id)) ||
578 !emulated_lock(android::vold::BuildDataUserPath(nullptr, user_id))) {
Paul Crowley57eedbf2016-02-09 09:30:23 +0000579 LOG(ERROR) << "Failed to lock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000580 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800581 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800582 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700583
Paul Crowley76107cb2016-02-09 10:04:39 +0000584 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800585}
586
Paul Crowley76107cb2016-02-09 10:04:39 +0000587bool e4crypt_prepare_user_storage(const char* volume_uuid, userid_t user_id,
Jeff Sharkey47695b22016-02-01 17:02:29 -0700588 int serial, int flags) {
589 LOG(DEBUG) << "e4crypt_prepare_user_storage for volume " << escape_null(volume_uuid)
590 << ", user " << user_id << ", serial " << serial << ", flags " << flags;
591
592 if (flags & FLAG_STORAGE_DE) {
593 auto system_de_path = android::vold::BuildDataSystemDePath(user_id);
594 auto misc_de_path = android::vold::BuildDataMiscDePath(user_id);
595 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
596
Paul Crowley76107cb2016-02-09 10:04:39 +0000597 if (!prepare_dir(system_de_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
598 if (!prepare_dir(misc_de_path, 01771, AID_SYSTEM, AID_MISC)) return false;
599 if (!prepare_dir(user_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Calin Juravled1ee9442016-03-02 18:36:50 +0000600
601 if (volume_uuid == nullptr) {
602 // Prepare profile directories only for the internal storage.
603 // For now, we do not store profiles on the adopted storage.
604 auto profiles_de_path = android::vold::BuildDataProfilesDePath(user_id);
605 auto foreign_dex_profiles_de_path =
606 android::vold::BuildDataProfilesForeignDexDePath(user_id);
607 if (!prepare_dir(profiles_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
608 if (!prepare_dir(foreign_dex_profiles_de_path, 0773, AID_SYSTEM, AID_SYSTEM)) {
609 return false;
610 }
611 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700612
Paul Crowley38132a12016-02-09 09:50:32 +0000613 if (e4crypt_is_native()) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700614 std::string de_raw_ref;
Paul Crowley76107cb2016-02-09 10:04:39 +0000615 if (!lookup_key_ref(s_de_key_raw_refs, user_id, de_raw_ref)) return false;
616 if (!ensure_policy(de_raw_ref, system_de_path)) return false;
617 if (!ensure_policy(de_raw_ref, misc_de_path)) return false;
618 if (!ensure_policy(de_raw_ref, user_de_path)) return false;
Calin Juravle79f55a42016-02-17 20:14:46 +0000619 // No need to set the policy for profiles_de_path. The parent directory (/data/misc)
620 // already has a DE_sys policy set.
Jeff Sharkey47695b22016-02-01 17:02:29 -0700621 }
Paul Crowley285956f2016-01-20 13:12:38 +0000622 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800623
Jeff Sharkey47695b22016-02-01 17:02:29 -0700624 if (flags & FLAG_STORAGE_CE) {
625 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
626 auto misc_ce_path = android::vold::BuildDataMiscCePath(user_id);
627 auto media_ce_path = android::vold::BuildDataMediaPath(volume_uuid, user_id);
628 auto user_ce_path = android::vold::BuildDataUserPath(volume_uuid, user_id);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800629
Paul Crowley76107cb2016-02-09 10:04:39 +0000630 if (!prepare_dir(system_ce_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
631 if (!prepare_dir(misc_ce_path, 01771, AID_SYSTEM, AID_MISC)) return false;
632 if (!prepare_dir(media_ce_path, 0770, AID_MEDIA_RW, AID_MEDIA_RW)) return false;
633 if (!prepare_dir(user_ce_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700634
Paul Crowley38132a12016-02-09 09:50:32 +0000635 if (e4crypt_is_native()) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700636 std::string ce_raw_ref;
Paul Crowley76107cb2016-02-09 10:04:39 +0000637 if (!lookup_key_ref(s_ce_key_raw_refs, user_id, ce_raw_ref)) return false;
638 if (!ensure_policy(ce_raw_ref, system_ce_path)) return false;
639 if (!ensure_policy(ce_raw_ref, misc_ce_path)) return false;
640 if (!ensure_policy(ce_raw_ref, media_ce_path)) return false;
641 if (!ensure_policy(ce_raw_ref, user_ce_path)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700642 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800643 }
644
Paul Crowley76107cb2016-02-09 10:04:39 +0000645 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800646}