blob: 087b916e6e5673bd685a84e97b75ffa86ade1b94 [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
Eric Biggersa701c452018-10-23 13:06:55 -070017#include "FsCrypt.h"
Paul Lawrence731a7a22015-04-28 22:14:15 +000018
Paul Crowley1ef25582016-01-21 20:26:12 +000019#include "KeyStorage.h"
Paul Crowleyf71ace32016-06-02 11:01:19 -070020#include "KeyUtil.h"
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080021#include "Utils.h"
Paul Crowleya7ca40b2017-10-06 14:29:33 -070022#include "VoldUtil.h"
23
Paul Crowleya3630362016-05-17 14:17:56 -070024#include <algorithm>
Paul Lawrence731a7a22015-04-28 22:14:15 +000025#include <map>
Paul Crowleyb1f3d242016-01-28 10:09:46 +000026#include <set>
Paul Lawrencefd7db732015-04-10 07:48:51 -070027#include <sstream>
Paul Crowleydf528a72016-03-09 09:31:37 -080028#include <string>
Paul Crowleyf71ace32016-06-02 11:01:19 -070029#include <vector>
Paul Lawrence731a7a22015-04-28 22:14:15 +000030
Paul Crowleydf528a72016-03-09 09:31:37 -080031#include <dirent.h>
32#include <errno.h>
33#include <fcntl.h>
Paul Crowleya3630362016-05-17 14:17:56 -070034#include <limits.h>
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070035#include <selinux/android.h>
Paul Crowleydf528a72016-03-09 09:31:37 -080036#include <sys/mount.h>
37#include <sys/stat.h>
38#include <sys/types.h>
Paul Crowley14c8c072018-09-18 13:30:21 -070039#include <unistd.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000040
Paul Crowley480fcd22015-08-24 14:53:28 +010041#include <private/android_filesystem_config.h>
42
Paul Crowley82b41ff2017-10-20 08:17:54 -070043#include "android/os/IVold.h"
44
Paul Lawrence731a7a22015-04-28 22:14:15 +000045#include "cryptfs.h"
46
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070047#define EMULATED_USES_SELINUX 0
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -060048#define MANAGE_MISC_DIRS 0
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070049
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080050#include <cutils/fs.h>
Paul Crowleyf71ace32016-06-02 11:01:19 -070051#include <cutils/properties.h>
52
Eric Biggersa701c452018-10-23 13:06:55 -070053#include <fscrypt/fscrypt.h>
Elliott Hughesc3bda182017-05-09 17:01:04 -070054#include <keyutils.h>
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080055
Elliott Hughes7e128fb2015-12-04 15:50:53 -080056#include <android-base/file.h>
Elliott Hughes6bf05472015-12-04 17:55:33 -080057#include <android-base/logging.h>
Paul Crowley3aa914d2017-10-09 16:35:51 -070058#include <android-base/properties.h>
Elliott Hughes7e128fb2015-12-04 15:50:53 -080059#include <android-base/stringprintf.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000060
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080061using android::base::StringPrintf;
Pavel Grafovb350ed02017-07-27 17:34:57 +010062using android::base::WriteStringToFile;
Paul Crowley05720802016-02-08 15:55:41 +000063using android::vold::kEmptyAuthentication;
Pavel Grafove2e2d302017-08-01 17:15:53 +010064using android::vold::KeyBuffer;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080065
Paul Lawrence731a7a22015-04-28 22:14:15 +000066namespace {
Andrew Scull7ec25c72016-10-31 10:28:25 +000067
Paul Crowley3aa914d2017-10-09 16:35:51 -070068struct PolicyKeyRef {
69 std::string contents_mode;
70 std::string filenames_mode;
71 std::string key_raw_ref;
72};
73
Eric Biggersa701c452018-10-23 13:06:55 -070074const std::string device_key_dir = std::string() + DATA_MNT_POINT + fscrypt_unencrypted_folder;
Paul Crowleydf528a72016-03-09 09:31:37 -080075const std::string device_key_path = device_key_dir + "/key";
76const std::string device_key_temp = device_key_dir + "/temp";
Paul Lawrence5a06a642016-02-03 13:39:13 -080077
Paul Crowleydf528a72016-03-09 09:31:37 -080078const std::string user_key_dir = std::string() + DATA_MNT_POINT + "/misc/vold/user_keys";
79const std::string user_key_temp = user_key_dir + "/temp";
Paul Crowley82b41ff2017-10-20 08:17:54 -070080const std::string prepare_subdirs_path = "/system/bin/vold_prepare_subdirs";
Paul Crowley285956f2016-01-20 13:12:38 +000081
Paul Crowley26a53882017-10-26 11:16:39 -070082const std::string systemwide_volume_key_dir =
83 std::string() + DATA_MNT_POINT + "/misc/vold/volume_keys";
84
Paul Crowleydf528a72016-03-09 09:31:37 -080085bool s_global_de_initialized = false;
Paul Lawrence7b6b5652016-02-02 11:14:59 -080086
Paul Crowleydf528a72016-03-09 09:31:37 -080087// Some users are ephemeral, don't try to wipe their keys from disk
88std::set<userid_t> s_ephemeral_users;
Paul Lawrenceaec34df2016-02-03 10:52:41 -080089
Paul Crowleydf528a72016-03-09 09:31:37 -080090// Map user ids to key references
91std::map<userid_t, std::string> s_de_key_raw_refs;
92std::map<userid_t, std::string> s_ce_key_raw_refs;
Paul Crowley99360d72016-10-19 14:00:24 -070093// TODO abolish this map, per b/26948053
Pavel Grafove2e2d302017-08-01 17:15:53 +010094std::map<userid_t, KeyBuffer> s_ce_keys;
Paul Lawrence731a7a22015-04-28 22:14:15 +000095
Paul Crowley14c8c072018-09-18 13:30:21 -070096} // namespace
Paul Lawrence731a7a22015-04-28 22:14:15 +000097
Eric Biggersa701c452018-10-23 13:06:55 -070098static bool fscrypt_is_emulated() {
Paul Crowley38132a12016-02-09 09:50:32 +000099 return property_get_bool("persist.sys.emulate_fbe", false);
100}
101
Paul Crowley3b71fc52017-10-09 10:55:21 -0700102static const char* escape_empty(const std::string& value) {
103 return value.empty() ? "null" : value.c_str();
Paul Lawrence731a7a22015-04-28 22:14:15 +0000104}
105
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000106static std::string get_de_key_path(userid_t user_id) {
107 return StringPrintf("%s/de/%d", user_key_dir.c_str(), user_id);
108}
109
Paul Crowleya3630362016-05-17 14:17:56 -0700110static std::string get_ce_key_directory_path(userid_t user_id) {
111 return StringPrintf("%s/ce/%d", user_key_dir.c_str(), user_id);
112}
113
114// Returns the keys newest first
115static std::vector<std::string> get_ce_key_paths(const std::string& directory_path) {
116 auto dirp = std::unique_ptr<DIR, int (*)(DIR*)>(opendir(directory_path.c_str()), closedir);
117 if (!dirp) {
118 PLOG(ERROR) << "Unable to open ce key directory: " + directory_path;
119 return std::vector<std::string>();
120 }
121 std::vector<std::string> result;
122 for (;;) {
123 errno = 0;
124 auto const entry = readdir(dirp.get());
125 if (!entry) {
126 if (errno) {
127 PLOG(ERROR) << "Unable to read ce key directory: " + directory_path;
128 return std::vector<std::string>();
129 }
130 break;
131 }
132 if (entry->d_type != DT_DIR || entry->d_name[0] != 'c') {
133 LOG(DEBUG) << "Skipping non-key " << entry->d_name;
134 continue;
135 }
136 result.emplace_back(directory_path + "/" + entry->d_name);
137 }
138 std::sort(result.begin(), result.end());
139 std::reverse(result.begin(), result.end());
140 return result;
141}
142
143static std::string get_ce_key_current_path(const std::string& directory_path) {
144 return directory_path + "/current";
145}
146
147static bool get_ce_key_new_path(const std::string& directory_path,
Paul Crowley14c8c072018-09-18 13:30:21 -0700148 const std::vector<std::string>& paths, std::string* ce_key_path) {
Paul Crowleya3630362016-05-17 14:17:56 -0700149 if (paths.empty()) {
150 *ce_key_path = get_ce_key_current_path(directory_path);
151 return true;
152 }
153 for (unsigned int i = 0; i < UINT_MAX; i++) {
154 auto const candidate = StringPrintf("%s/cx%010u", directory_path.c_str(), i);
155 if (paths[0] < candidate) {
156 *ce_key_path = candidate;
157 return true;
158 }
159 }
160 return false;
161}
162
163// Discard all keys but the named one; rename it to canonical name.
164// No point in acting on errors in this; ignore them.
Paul Crowley14c8c072018-09-18 13:30:21 -0700165static void fixate_user_ce_key(const std::string& directory_path, const std::string& to_fix,
Paul Crowleya3630362016-05-17 14:17:56 -0700166 const std::vector<std::string>& paths) {
Paul Crowley14c8c072018-09-18 13:30:21 -0700167 for (auto const other_path : paths) {
Paul Crowleya3630362016-05-17 14:17:56 -0700168 if (other_path != to_fix) {
169 android::vold::destroyKey(other_path);
170 }
171 }
172 auto const current_path = get_ce_key_current_path(directory_path);
173 if (to_fix != current_path) {
174 LOG(DEBUG) << "Renaming " << to_fix << " to " << current_path;
175 if (rename(to_fix.c_str(), current_path.c_str()) != 0) {
176 PLOG(WARNING) << "Unable to rename " << to_fix << " to " << current_path;
177 }
178 }
179}
180
181static bool read_and_fixate_user_ce_key(userid_t user_id,
182 const android::vold::KeyAuthentication& auth,
Paul Crowley14c8c072018-09-18 13:30:21 -0700183 KeyBuffer* ce_key) {
Paul Crowleya3630362016-05-17 14:17:56 -0700184 auto const directory_path = get_ce_key_directory_path(user_id);
185 auto const paths = get_ce_key_paths(directory_path);
Paul Crowley14c8c072018-09-18 13:30:21 -0700186 for (auto const ce_key_path : paths) {
Paul Crowleya3630362016-05-17 14:17:56 -0700187 LOG(DEBUG) << "Trying user CE key " << ce_key_path;
188 if (android::vold::retrieveKey(ce_key_path, auth, ce_key)) {
189 LOG(DEBUG) << "Successfully retrieved key";
190 fixate_user_ce_key(directory_path, ce_key_path, paths);
191 return true;
192 }
193 }
194 LOG(ERROR) << "Failed to find working ce key for user " << user_id;
195 return false;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100196}
197
Paul Crowleydf528a72016-03-09 09:31:37 -0800198static bool read_and_install_user_ce_key(userid_t user_id,
199 const android::vold::KeyAuthentication& auth) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000200 if (s_ce_key_raw_refs.count(user_id) != 0) return true;
Pavel Grafove2e2d302017-08-01 17:15:53 +0100201 KeyBuffer ce_key;
Paul Crowleya3630362016-05-17 14:17:56 -0700202 if (!read_and_fixate_user_ce_key(user_id, auth, &ce_key)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000203 std::string ce_raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700204 if (!android::vold::installKey(ce_key, &ce_raw_ref)) return false;
Pavel Grafove2e2d302017-08-01 17:15:53 +0100205 s_ce_keys[user_id] = std::move(ce_key);
Paul Crowley05720802016-02-08 15:55:41 +0000206 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000207 LOG(DEBUG) << "Installed ce key for user " << user_id;
Paul Crowley1ef25582016-01-21 20:26:12 +0000208 return true;
Paul Crowley285956f2016-01-20 13:12:38 +0000209}
210
Paul Crowleydf528a72016-03-09 09:31:37 -0800211static bool prepare_dir(const std::string& dir, mode_t mode, uid_t uid, gid_t gid) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000212 LOG(DEBUG) << "Preparing: " << dir;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000213 if (fs_prepare_dir(dir.c_str(), mode, uid, gid) != 0) {
214 PLOG(ERROR) << "Failed to prepare " << dir;
Paul Crowley285956f2016-01-20 13:12:38 +0000215 return false;
216 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000217 return true;
218}
219
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600220static bool destroy_dir(const std::string& dir) {
221 LOG(DEBUG) << "Destroying: " << dir;
222 if (rmdir(dir.c_str()) != 0 && errno != ENOENT) {
223 PLOG(ERROR) << "Failed to destroy " << dir;
224 return false;
225 }
226 return true;
227}
228
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000229// NB this assumes that there is only one thread listening for crypt commands, because
230// it creates keys in a fixed location.
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000231static bool create_and_install_user_keys(userid_t user_id, bool create_ephemeral) {
Pavel Grafove2e2d302017-08-01 17:15:53 +0100232 KeyBuffer de_key, ce_key;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700233 if (!android::vold::randomKey(&de_key)) return false;
234 if (!android::vold::randomKey(&ce_key)) return false;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000235 if (create_ephemeral) {
236 // If the key should be created as ephemeral, don't store it.
237 s_ephemeral_users.insert(user_id);
238 } else {
Paul Crowleya3630362016-05-17 14:17:56 -0700239 auto const directory_path = get_ce_key_directory_path(user_id);
240 if (!prepare_dir(directory_path, 0700, AID_ROOT, AID_ROOT)) return false;
241 auto const paths = get_ce_key_paths(directory_path);
242 std::string ce_key_path;
243 if (!get_ce_key_new_path(directory_path, paths, &ce_key_path)) return false;
Paul Crowley14c8c072018-09-18 13:30:21 -0700244 if (!android::vold::storeKeyAtomically(ce_key_path, user_key_temp, kEmptyAuthentication,
245 ce_key))
246 return false;
Paul Crowleya3630362016-05-17 14:17:56 -0700247 fixate_user_ce_key(directory_path, ce_key_path, paths);
248 // Write DE key second; once this is written, all is good.
Paul Crowleyf71ace32016-06-02 11:01:19 -0700249 if (!android::vold::storeKeyAtomically(get_de_key_path(user_id), user_key_temp,
Paul Crowley14c8c072018-09-18 13:30:21 -0700250 kEmptyAuthentication, de_key))
251 return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100252 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000253 std::string de_raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700254 if (!android::vold::installKey(de_key, &de_raw_ref)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000255 s_de_key_raw_refs[user_id] = de_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000256 std::string ce_raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700257 if (!android::vold::installKey(ce_key, &ce_raw_ref)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000258 s_ce_keys[user_id] = ce_key;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000259 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000260 LOG(DEBUG) << "Created keys for user " << user_id;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000261 return true;
262}
263
Paul Crowleydf528a72016-03-09 09:31:37 -0800264static bool lookup_key_ref(const std::map<userid_t, std::string>& key_map, userid_t user_id,
265 std::string* raw_ref) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000266 auto refi = key_map.find(user_id);
267 if (refi == key_map.end()) {
268 LOG(ERROR) << "Cannot find key for " << user_id;
269 return false;
270 }
Paul Crowleya051eb72016-03-08 16:08:32 -0800271 *raw_ref = refi->second;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000272 return true;
273}
274
Paul Crowley3aa914d2017-10-09 16:35:51 -0700275static void get_data_file_encryption_modes(PolicyKeyRef* key_ref) {
Paul Crowleya7ca40b2017-10-06 14:29:33 -0700276 struct fstab_rec* rec = fs_mgr_get_entry_for_mount_point(fstab_default, DATA_MNT_POINT);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700277 char const* contents_mode;
278 char const* filenames_mode;
279 fs_mgr_get_file_encryption_modes(rec, &contents_mode, &filenames_mode);
280 key_ref->contents_mode = contents_mode;
281 key_ref->filenames_mode = filenames_mode;
Paul Crowleya7ca40b2017-10-06 14:29:33 -0700282}
283
Paul Crowley3aa914d2017-10-09 16:35:51 -0700284static bool ensure_policy(const PolicyKeyRef& key_ref, const std::string& path) {
Eric Biggersa701c452018-10-23 13:06:55 -0700285 return fscrypt_policy_ensure(path.c_str(), key_ref.key_raw_ref.data(),
Paul Crowley3aa914d2017-10-09 16:35:51 -0700286 key_ref.key_raw_ref.size(), key_ref.contents_mode.c_str(),
287 key_ref.filenames_mode.c_str()) == 0;
Paul Crowley95376d62015-05-06 15:04:43 +0100288}
Paul Crowleyb33e8872015-05-19 12:34:09 +0100289
Paul Crowleydf528a72016-03-09 09:31:37 -0800290static bool is_numeric(const char* name) {
291 for (const char* p = name; *p != '\0'; p++) {
292 if (!isdigit(*p)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000293 }
294 return true;
295}
296
297static bool load_all_de_keys() {
298 auto de_dir = user_key_dir + "/de";
Paul Crowleydf528a72016-03-09 09:31:37 -0800299 auto dirp = std::unique_ptr<DIR, int (*)(DIR*)>(opendir(de_dir.c_str()), closedir);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000300 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 }
Jeff Sharkey95440eb2017-09-18 18:19:28 -0600318 userid_t user_id = std::stoi(entry->d_name);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000319 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;
Pavel Grafove2e2d302017-08-01 17:15:53 +0100321 KeyBuffer key;
Paul Crowleya051eb72016-03-08 16:08:32 -0800322 if (!android::vold::retrieveKey(key_path, kEmptyAuthentication, &key)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000323 std::string raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700324 if (!android::vold::installKey(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 }
Eric Biggersa701c452018-10-23 13:06:55 -0700329 // fscrypt:TODO: go through all DE directories, ensure that all user dirs have the
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000330 // correct policy set on them, and that no rogue ones exist.
331 return true;
332}
333
Eric Biggersa701c452018-10-23 13:06:55 -0700334bool fscrypt_initialize_global_de() {
335 LOG(INFO) << "fscrypt_initialize_global_de";
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800336
Paul Crowley38132a12016-02-09 09:50:32 +0000337 if (s_global_de_initialized) {
338 LOG(INFO) << "Already initialized";
Paul Crowley76107cb2016-02-09 10:04:39 +0000339 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800340 }
341
Paul Crowley3aa914d2017-10-09 16:35:51 -0700342 PolicyKeyRef device_ref;
Paul Crowley26a53882017-10-26 11:16:39 -0700343 if (!android::vold::retrieveAndInstallKey(true, kEmptyAuthentication, device_key_path,
344 device_key_temp, &device_ref.key_raw_ref))
Paul Crowley3aa914d2017-10-09 16:35:51 -0700345 return false;
346 get_data_file_encryption_modes(&device_ref);
Eric Biggersb45caaf2017-02-02 14:52:12 -0800347
Paul Crowley3aa914d2017-10-09 16:35:51 -0700348 std::string modestring = device_ref.contents_mode + ":" + device_ref.filenames_mode;
Eric Biggersa701c452018-10-23 13:06:55 -0700349 std::string mode_filename = std::string("/data") + fscrypt_key_mode;
Eric Biggersb45caaf2017-02-02 14:52:12 -0800350 if (!android::base::WriteStringToFile(modestring, mode_filename)) {
Paul Lawrence6e410592016-05-24 14:20:38 -0700351 PLOG(ERROR) << "Cannot save type";
352 return false;
353 }
354
Eric Biggersa701c452018-10-23 13:06:55 -0700355 std::string ref_filename = std::string("/data") + fscrypt_key_ref;
Paul Crowley3aa914d2017-10-09 16:35:51 -0700356 if (!android::base::WriteStringToFile(device_ref.key_raw_ref, ref_filename)) {
Paul Crowleyf71ace32016-06-02 11:01:19 -0700357 PLOG(ERROR) << "Cannot save key reference to:" << ref_filename;
Paul Crowley76107cb2016-02-09 10:04:39 +0000358 return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800359 }
Paul Crowleyf71ace32016-06-02 11:01:19 -0700360 LOG(INFO) << "Wrote system DE key reference to:" << ref_filename;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800361
Paul Crowley38132a12016-02-09 09:50:32 +0000362 s_global_de_initialized = true;
Paul Crowley76107cb2016-02-09 10:04:39 +0000363 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800364}
365
Eric Biggersa701c452018-10-23 13:06:55 -0700366bool fscrypt_init_user0() {
367 LOG(DEBUG) << "fscrypt_init_user0";
368 if (fscrypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000369 if (!prepare_dir(user_key_dir, 0700, AID_ROOT, AID_ROOT)) return false;
370 if (!prepare_dir(user_key_dir + "/ce", 0700, AID_ROOT, AID_ROOT)) return false;
371 if (!prepare_dir(user_key_dir + "/de", 0700, AID_ROOT, AID_ROOT)) return false;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700372 if (!android::vold::pathExists(get_de_key_path(0))) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000373 if (!create_and_install_user_keys(0, false)) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000374 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700375 // TODO: switch to loading only DE_0 here once framework makes
376 // explicit calls to install DE keys for secondary users
Paul Crowley76107cb2016-02-09 10:04:39 +0000377 if (!load_all_de_keys()) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000378 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700379 // We can only safely prepare DE storage here, since CE keys are probably
380 // entangled with user credentials. The framework will always prepare CE
381 // storage once CE keys are installed.
Eric Biggersa701c452018-10-23 13:06:55 -0700382 if (!fscrypt_prepare_user_storage("", 0, 0, android::os::IVold::STORAGE_FLAG_DE)) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700383 LOG(ERROR) << "Failed to prepare user 0 storage";
Paul Crowley76107cb2016-02-09 10:04:39 +0000384 return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700385 }
Jeff Sharkey0754a452016-02-08 12:21:42 -0700386
387 // If this is a non-FBE device that recently left an emulated mode,
388 // restore user data directories to known-good state.
Eric Biggersa701c452018-10-23 13:06:55 -0700389 if (!fscrypt_is_native() && !fscrypt_is_emulated()) {
390 fscrypt_unlock_user_key(0, 0, "!", "!");
Jeff Sharkey0754a452016-02-08 12:21:42 -0700391 }
392
Paul Crowley76107cb2016-02-09 10:04:39 +0000393 return true;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000394}
395
Eric Biggersa701c452018-10-23 13:06:55 -0700396bool fscrypt_vold_create_user_key(userid_t user_id, int serial, bool ephemeral) {
397 LOG(DEBUG) << "fscrypt_vold_create_user_key for " << user_id << " serial " << serial;
398 if (!fscrypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000399 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000400 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000401 // FIXME test for existence of key that is not loaded yet
402 if (s_ce_key_raw_refs.count(user_id) != 0) {
Eric Biggersa701c452018-10-23 13:06:55 -0700403 LOG(ERROR) << "Already exists, can't fscrypt_vold_create_user_key for " << user_id
Paul Crowleydf528a72016-03-09 09:31:37 -0800404 << " serial " << serial;
Paul Crowley285956f2016-01-20 13:12:38 +0000405 // FIXME should we fail the command?
Paul Crowley76107cb2016-02-09 10:04:39 +0000406 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800407 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000408 if (!create_and_install_user_keys(user_id, ephemeral)) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000409 return false;
Paul Crowley285956f2016-01-20 13:12:38 +0000410 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000411 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800412}
413
Pavel Grafovb350ed02017-07-27 17:34:57 +0100414static void drop_caches() {
415 // Clean any dirty pages (otherwise they won't be dropped).
416 sync();
417 // Drop inode and page caches.
418 if (!WriteStringToFile("3", "/proc/sys/vm/drop_caches")) {
419 PLOG(ERROR) << "Failed to drop caches during key eviction";
420 }
421}
422
Andrew Scull7ec25c72016-10-31 10:28:25 +0000423static bool evict_ce_key(userid_t user_id) {
Pavel Grafove2e2d302017-08-01 17:15:53 +0100424 s_ce_keys.erase(user_id);
Andrew Scull7ec25c72016-10-31 10:28:25 +0000425 bool success = true;
426 std::string raw_ref;
427 // If we haven't loaded the CE key, no need to evict it.
428 if (lookup_key_ref(s_ce_key_raw_refs, user_id, &raw_ref)) {
Paul Crowleyf71ace32016-06-02 11:01:19 -0700429 success &= android::vold::evictKey(raw_ref);
Pavel Grafovb350ed02017-07-27 17:34:57 +0100430 drop_caches();
Andrew Scull7ec25c72016-10-31 10:28:25 +0000431 }
432 s_ce_key_raw_refs.erase(user_id);
433 return success;
434}
435
Eric Biggersa701c452018-10-23 13:06:55 -0700436bool fscrypt_destroy_user_key(userid_t user_id) {
437 LOG(DEBUG) << "fscrypt_destroy_user_key(" << user_id << ")";
438 if (!fscrypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000439 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000440 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000441 bool success = true;
442 std::string raw_ref;
Andrew Scull7ec25c72016-10-31 10:28:25 +0000443 success &= evict_ce_key(user_id);
Paul Crowley14c8c072018-09-18 13:30:21 -0700444 success &=
445 lookup_key_ref(s_de_key_raw_refs, user_id, &raw_ref) && android::vold::evictKey(raw_ref);
Paul Crowley05720802016-02-08 15:55:41 +0000446 s_de_key_raw_refs.erase(user_id);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000447 auto it = s_ephemeral_users.find(user_id);
448 if (it != s_ephemeral_users.end()) {
449 s_ephemeral_users.erase(it);
Paul Crowley1ef25582016-01-21 20:26:12 +0000450 } else {
Paul Crowley14c8c072018-09-18 13:30:21 -0700451 for (auto const path : get_ce_key_paths(get_ce_key_directory_path(user_id))) {
Paul Crowleya3630362016-05-17 14:17:56 -0700452 success &= android::vold::destroyKey(path);
453 }
Paul Crowleyab0b56a2016-07-19 15:29:53 -0700454 auto de_key_path = get_de_key_path(user_id);
Paul Crowleyf71ace32016-06-02 11:01:19 -0700455 if (android::vold::pathExists(de_key_path)) {
Paul Crowleyab0b56a2016-07-19 15:29:53 -0700456 success &= android::vold::destroyKey(de_key_path);
457 } else {
458 LOG(INFO) << "Not present so not erasing: " << de_key_path;
459 }
Lenka Trochtova395039f2015-11-25 10:13:03 +0100460 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000461 return success;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100462}
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800463
Paul Crowley76107cb2016-02-09 10:04:39 +0000464static bool emulated_lock(const std::string& path) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700465 if (chmod(path.c_str(), 0000) != 0) {
466 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000467 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700468 }
469#if EMULATED_USES_SELINUX
470 if (setfilecon(path.c_str(), "u:object_r:storage_stub_file:s0") != 0) {
471 PLOG(WARNING) << "Failed to setfilecon " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000472 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700473 }
474#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000475 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700476}
477
Paul Crowley76107cb2016-02-09 10:04:39 +0000478static bool emulated_unlock(const std::string& path, mode_t mode) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700479 if (chmod(path.c_str(), mode) != 0) {
480 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000481 // FIXME temporary workaround for b/26713622
Eric Biggersa701c452018-10-23 13:06:55 -0700482 if (fscrypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700483 }
484#if EMULATED_USES_SELINUX
485 if (selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_FORCE) != 0) {
486 PLOG(WARNING) << "Failed to restorecon " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000487 // FIXME temporary workaround for b/26713622
Eric Biggersa701c452018-10-23 13:06:55 -0700488 if (fscrypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700489 }
490#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000491 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700492}
493
Paul Crowley3b71fc52017-10-09 10:55:21 -0700494static bool parse_hex(const std::string& hex, std::string* result) {
495 if (hex == "!") {
Paul Crowleya051eb72016-03-08 16:08:32 -0800496 *result = "";
Paul Crowley05720802016-02-08 15:55:41 +0000497 return true;
498 }
Paul Crowleya051eb72016-03-08 16:08:32 -0800499 if (android::vold::HexToStr(hex, *result) != 0) {
Paul Crowleydf528a72016-03-09 09:31:37 -0800500 LOG(ERROR) << "Invalid FBE hex string"; // Don't log the string for security reasons
Paul Crowley05720802016-02-08 15:55:41 +0000501 return false;
502 }
503 return true;
504}
505
Paul Crowley3aa914d2017-10-09 16:35:51 -0700506static std::string volkey_path(const std::string& misc_path, const std::string& volume_uuid) {
507 return misc_path + "/vold/volume_keys/" + volume_uuid + "/default";
508}
509
Paul Crowley26a53882017-10-26 11:16:39 -0700510static std::string volume_secdiscardable_path(const std::string& volume_uuid) {
511 return systemwide_volume_key_dir + "/" + volume_uuid + "/secdiscardable";
512}
513
Paul Crowley3aa914d2017-10-09 16:35:51 -0700514static bool read_or_create_volkey(const std::string& misc_path, const std::string& volume_uuid,
515 PolicyKeyRef* key_ref) {
Paul Crowley26a53882017-10-26 11:16:39 -0700516 auto secdiscardable_path = volume_secdiscardable_path(volume_uuid);
517 std::string secdiscardable_hash;
518 if (android::vold::pathExists(secdiscardable_path)) {
519 if (!android::vold::readSecdiscardable(secdiscardable_path, &secdiscardable_hash))
520 return false;
521 } else {
522 if (fs_mkdirs(secdiscardable_path.c_str(), 0700) != 0) {
523 PLOG(ERROR) << "Creating directories for: " << secdiscardable_path;
524 return false;
525 }
526 if (!android::vold::createSecdiscardable(secdiscardable_path, &secdiscardable_hash))
527 return false;
528 }
Paul Crowley3aa914d2017-10-09 16:35:51 -0700529 auto key_path = volkey_path(misc_path, volume_uuid);
530 if (fs_mkdirs(key_path.c_str(), 0700) != 0) {
531 PLOG(ERROR) << "Creating directories for: " << key_path;
532 return false;
533 }
Paul Crowley26a53882017-10-26 11:16:39 -0700534 android::vold::KeyAuthentication auth("", secdiscardable_hash);
535 if (!android::vold::retrieveAndInstallKey(true, auth, key_path, key_path + "_tmp",
Paul Crowley3aa914d2017-10-09 16:35:51 -0700536 &key_ref->key_raw_ref))
537 return false;
538 key_ref->contents_mode =
539 android::base::GetProperty("ro.crypto.volume.contents_mode", "aes-256-xts");
540 key_ref->filenames_mode =
541 android::base::GetProperty("ro.crypto.volume.filenames_mode", "aes-256-heh");
542 return true;
543}
544
545static bool destroy_volkey(const std::string& misc_path, const std::string& volume_uuid) {
Paul Crowleyc6433a22017-10-24 14:54:43 -0700546 auto path = volkey_path(misc_path, volume_uuid);
547 if (!android::vold::pathExists(path)) return true;
548 return android::vold::destroyKey(path);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700549}
550
Eric Biggersa701c452018-10-23 13:06:55 -0700551bool fscrypt_add_user_key_auth(userid_t user_id, int serial, const std::string& token_hex,
Paul Crowley3b71fc52017-10-09 10:55:21 -0700552 const std::string& secret_hex) {
Eric Biggersa701c452018-10-23 13:06:55 -0700553 LOG(DEBUG) << "fscrypt_add_user_key_auth " << user_id << " serial=" << serial
Paul Crowley3b71fc52017-10-09 10:55:21 -0700554 << " token_present=" << (token_hex != "!");
Eric Biggersa701c452018-10-23 13:06:55 -0700555 if (!fscrypt_is_native()) return true;
Paul Crowley76107cb2016-02-09 10:04:39 +0000556 if (s_ephemeral_users.count(user_id) != 0) return true;
Paul Crowleya3630362016-05-17 14:17:56 -0700557 std::string token, secret;
Paul Crowleya051eb72016-03-08 16:08:32 -0800558 if (!parse_hex(token_hex, &token)) return false;
Paul Crowleya3630362016-05-17 14:17:56 -0700559 if (!parse_hex(secret_hex, &secret)) return false;
Paul Crowley14c8c072018-09-18 13:30:21 -0700560 auto auth =
561 secret.empty() ? kEmptyAuthentication : android::vold::KeyAuthentication(token, secret);
Paul Crowley05720802016-02-08 15:55:41 +0000562 auto it = s_ce_keys.find(user_id);
563 if (it == s_ce_keys.end()) {
564 LOG(ERROR) << "Key not loaded into memory, can't change for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000565 return false;
Paul Crowley05720802016-02-08 15:55:41 +0000566 }
Paul Crowley14c8c072018-09-18 13:30:21 -0700567 const auto& ce_key = it->second;
Paul Crowleya3630362016-05-17 14:17:56 -0700568 auto const directory_path = get_ce_key_directory_path(user_id);
569 auto const paths = get_ce_key_paths(directory_path);
570 std::string ce_key_path;
571 if (!get_ce_key_new_path(directory_path, paths, &ce_key_path)) return false;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700572 if (!android::vold::storeKeyAtomically(ce_key_path, user_key_temp, auth, ce_key)) return false;
Paul Crowleya3630362016-05-17 14:17:56 -0700573 return true;
574}
575
Eric Biggersa701c452018-10-23 13:06:55 -0700576bool fscrypt_fixate_newest_user_key_auth(userid_t user_id) {
577 LOG(DEBUG) << "fscrypt_fixate_newest_user_key_auth " << user_id;
578 if (!fscrypt_is_native()) return true;
Paul Crowley25a71382016-07-25 15:55:36 -0700579 if (s_ephemeral_users.count(user_id) != 0) return true;
Paul Crowleya3630362016-05-17 14:17:56 -0700580 auto const directory_path = get_ce_key_directory_path(user_id);
581 auto const paths = get_ce_key_paths(directory_path);
582 if (paths.empty()) {
583 LOG(ERROR) << "No ce keys present, cannot fixate for user " << user_id;
584 return false;
Paul Crowleyad2eb642016-02-10 17:56:05 +0000585 }
Paul Crowleya3630362016-05-17 14:17:56 -0700586 fixate_user_ce_key(directory_path, paths[0], paths);
Paul Crowley76107cb2016-02-09 10:04:39 +0000587 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000588}
589
Jeff Sharkey47695b22016-02-01 17:02:29 -0700590// TODO: rename to 'install' for consistency, and take flags to know which keys to install
Eric Biggersa701c452018-10-23 13:06:55 -0700591bool fscrypt_unlock_user_key(userid_t user_id, int serial, const std::string& token_hex,
Paul Crowley3b71fc52017-10-09 10:55:21 -0700592 const std::string& secret_hex) {
Eric Biggersa701c452018-10-23 13:06:55 -0700593 LOG(DEBUG) << "fscrypt_unlock_user_key " << user_id << " serial=" << serial
Paul Crowley3b71fc52017-10-09 10:55:21 -0700594 << " token_present=" << (token_hex != "!");
Eric Biggersa701c452018-10-23 13:06:55 -0700595 if (fscrypt_is_native()) {
Paul Crowley05720802016-02-08 15:55:41 +0000596 if (s_ce_key_raw_refs.count(user_id) != 0) {
597 LOG(WARNING) << "Tried to unlock already-unlocked key for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000598 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000599 }
600 std::string token, secret;
Paul Crowleya051eb72016-03-08 16:08:32 -0800601 if (!parse_hex(token_hex, &token)) return false;
602 if (!parse_hex(secret_hex, &secret)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000603 android::vold::KeyAuthentication auth(token, secret);
604 if (!read_and_install_user_ce_key(user_id, auth)) {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000605 LOG(ERROR) << "Couldn't read key for " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000606 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800607 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700608 } else {
609 // When in emulation mode, we just use chmod. However, we also
610 // unlock directories when not in emulation mode, to bring devices
611 // back into a known-good state.
Paul Crowley76107cb2016-02-09 10:04:39 +0000612 if (!emulated_unlock(android::vold::BuildDataSystemCePath(user_id), 0771) ||
Paul Crowleydf528a72016-03-09 09:31:37 -0800613 !emulated_unlock(android::vold::BuildDataMiscCePath(user_id), 01771) ||
Paul Crowley3b71fc52017-10-09 10:55:21 -0700614 !emulated_unlock(android::vold::BuildDataMediaCePath("", user_id), 0770) ||
615 !emulated_unlock(android::vold::BuildDataUserCePath("", user_id), 0771)) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700616 LOG(ERROR) << "Failed to unlock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000617 return false;
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700618 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800619 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000620 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800621}
622
Jeff Sharkey47695b22016-02-01 17:02:29 -0700623// TODO: rename to 'evict' for consistency
Eric Biggersa701c452018-10-23 13:06:55 -0700624bool fscrypt_lock_user_key(userid_t user_id) {
625 LOG(DEBUG) << "fscrypt_lock_user_key " << user_id;
626 if (fscrypt_is_native()) {
Andrew Scull7ec25c72016-10-31 10:28:25 +0000627 return evict_ce_key(user_id);
Eric Biggersa701c452018-10-23 13:06:55 -0700628 } else if (fscrypt_is_emulated()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800629 // When in emulation mode, we just use chmod
Paul Crowley76107cb2016-02-09 10:04:39 +0000630 if (!emulated_lock(android::vold::BuildDataSystemCePath(user_id)) ||
Paul Crowleydf528a72016-03-09 09:31:37 -0800631 !emulated_lock(android::vold::BuildDataMiscCePath(user_id)) ||
Paul Crowley3b71fc52017-10-09 10:55:21 -0700632 !emulated_lock(android::vold::BuildDataMediaCePath("", user_id)) ||
633 !emulated_lock(android::vold::BuildDataUserCePath("", user_id))) {
Paul Crowley57eedbf2016-02-09 09:30:23 +0000634 LOG(ERROR) << "Failed to lock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000635 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800636 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800637 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700638
Paul Crowley76107cb2016-02-09 10:04:39 +0000639 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800640}
641
Paul Crowley82b41ff2017-10-20 08:17:54 -0700642static bool prepare_subdirs(const std::string& action, const std::string& volume_uuid,
643 userid_t user_id, int flags) {
644 if (0 != android::vold::ForkExecvp(
645 std::vector<std::string>{prepare_subdirs_path, action, volume_uuid,
646 std::to_string(user_id), std::to_string(flags)})) {
647 LOG(ERROR) << "vold_prepare_subdirs failed";
Paul Crowley8e550662017-10-16 17:01:44 -0700648 return false;
649 }
650 return true;
651}
652
Eric Biggersa701c452018-10-23 13:06:55 -0700653bool fscrypt_prepare_user_storage(const std::string& volume_uuid, userid_t user_id, int serial,
Paul Crowley3b71fc52017-10-09 10:55:21 -0700654 int flags) {
Eric Biggersa701c452018-10-23 13:06:55 -0700655 LOG(DEBUG) << "fscrypt_prepare_user_storage for volume " << escape_empty(volume_uuid)
Paul Crowleydf528a72016-03-09 09:31:37 -0800656 << ", user " << user_id << ", serial " << serial << ", flags " << flags;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700657
Paul Crowley82b41ff2017-10-20 08:17:54 -0700658 if (flags & android::os::IVold::STORAGE_FLAG_DE) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600659 // DE_sys key
660 auto system_legacy_path = android::vold::BuildDataSystemLegacyPath(user_id);
661 auto misc_legacy_path = android::vold::BuildDataMiscLegacyPath(user_id);
662 auto profiles_de_path = android::vold::BuildDataProfilesDePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600663
664 // DE_n key
Jeff Sharkey47695b22016-02-01 17:02:29 -0700665 auto system_de_path = android::vold::BuildDataSystemDePath(user_id);
666 auto misc_de_path = android::vold::BuildDataMiscDePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800667 auto vendor_de_path = android::vold::BuildDataVendorDePath(user_id);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700668 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
669
Paul Crowley3b71fc52017-10-09 10:55:21 -0700670 if (volume_uuid.empty()) {
Paul Crowley6b756ce2017-10-05 14:07:09 -0700671 if (!prepare_dir(system_legacy_path, 0700, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600672#if MANAGE_MISC_DIRS
Paul Crowley6b756ce2017-10-05 14:07:09 -0700673 if (!prepare_dir(misc_legacy_path, 0750, multiuser_get_uid(user_id, AID_SYSTEM),
Paul Crowley14c8c072018-09-18 13:30:21 -0700674 multiuser_get_uid(user_id, AID_EVERYBODY)))
675 return false;
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600676#endif
Paul Crowley6b756ce2017-10-05 14:07:09 -0700677 if (!prepare_dir(profiles_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600678
Paul Crowley6b756ce2017-10-05 14:07:09 -0700679 if (!prepare_dir(system_de_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
680 if (!prepare_dir(misc_de_path, 01771, AID_SYSTEM, AID_MISC)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800681 if (!prepare_dir(vendor_de_path, 0771, AID_ROOT, AID_ROOT)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700682 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000683 if (!prepare_dir(user_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Calin Juravled1ee9442016-03-02 18:36:50 +0000684
Eric Biggersa701c452018-10-23 13:06:55 -0700685 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700686 PolicyKeyRef de_ref;
Paul Crowley3b71fc52017-10-09 10:55:21 -0700687 if (volume_uuid.empty()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700688 if (!lookup_key_ref(s_de_key_raw_refs, user_id, &de_ref.key_raw_ref)) return false;
689 get_data_file_encryption_modes(&de_ref);
690 if (!ensure_policy(de_ref, system_de_path)) return false;
691 if (!ensure_policy(de_ref, misc_de_path)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800692 if (!ensure_policy(de_ref, vendor_de_path)) return false;
Paul Crowley3aa914d2017-10-09 16:35:51 -0700693 } else {
694 if (!read_or_create_volkey(misc_de_path, volume_uuid, &de_ref)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700695 }
Paul Crowley3aa914d2017-10-09 16:35:51 -0700696 if (!ensure_policy(de_ref, user_de_path)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700697 }
Paul Crowley285956f2016-01-20 13:12:38 +0000698 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800699
Paul Crowley82b41ff2017-10-20 08:17:54 -0700700 if (flags & android::os::IVold::STORAGE_FLAG_CE) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600701 // CE_n key
Jeff Sharkey47695b22016-02-01 17:02:29 -0700702 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
703 auto misc_ce_path = android::vold::BuildDataMiscCePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800704 auto vendor_ce_path = android::vold::BuildDataVendorCePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600705 auto media_ce_path = android::vold::BuildDataMediaCePath(volume_uuid, user_id);
706 auto user_ce_path = android::vold::BuildDataUserCePath(volume_uuid, user_id);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800707
Paul Crowley3b71fc52017-10-09 10:55:21 -0700708 if (volume_uuid.empty()) {
Paul Crowley6b756ce2017-10-05 14:07:09 -0700709 if (!prepare_dir(system_ce_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
710 if (!prepare_dir(misc_ce_path, 01771, AID_SYSTEM, AID_MISC)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800711 if (!prepare_dir(vendor_ce_path, 0771, AID_ROOT, AID_ROOT)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700712 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000713 if (!prepare_dir(media_ce_path, 0770, AID_MEDIA_RW, AID_MEDIA_RW)) return false;
714 if (!prepare_dir(user_ce_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700715
Eric Biggersa701c452018-10-23 13:06:55 -0700716 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700717 PolicyKeyRef ce_ref;
Paul Crowley3b71fc52017-10-09 10:55:21 -0700718 if (volume_uuid.empty()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700719 if (!lookup_key_ref(s_ce_key_raw_refs, user_id, &ce_ref.key_raw_ref)) return false;
720 get_data_file_encryption_modes(&ce_ref);
721 if (!ensure_policy(ce_ref, system_ce_path)) return false;
722 if (!ensure_policy(ce_ref, misc_ce_path)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800723 if (!ensure_policy(ce_ref, vendor_ce_path)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700724
Paul Crowley3aa914d2017-10-09 16:35:51 -0700725 } else {
726 if (!read_or_create_volkey(misc_ce_path, volume_uuid, &ce_ref)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700727 }
Paul Crowley3aa914d2017-10-09 16:35:51 -0700728 if (!ensure_policy(ce_ref, media_ce_path)) return false;
729 if (!ensure_policy(ce_ref, user_ce_path)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700730 }
Paul Crowley1a965262017-10-13 13:49:50 -0700731
732 if (volume_uuid.empty()) {
Paul Crowley8e550662017-10-16 17:01:44 -0700733 // Now that credentials have been installed, we can run restorecon
734 // over these paths
735 // NOTE: these paths need to be kept in sync with libselinux
736 android::vold::RestoreconRecursive(system_ce_path);
737 android::vold::RestoreconRecursive(misc_ce_path);
Paul Crowley1a965262017-10-13 13:49:50 -0700738 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800739 }
Paul Crowley82b41ff2017-10-20 08:17:54 -0700740 if (!prepare_subdirs("prepare", volume_uuid, user_id, flags)) return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800741
Paul Crowley76107cb2016-02-09 10:04:39 +0000742 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800743}
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600744
Eric Biggersa701c452018-10-23 13:06:55 -0700745bool fscrypt_destroy_user_storage(const std::string& volume_uuid, userid_t user_id, int flags) {
746 LOG(DEBUG) << "fscrypt_destroy_user_storage for volume " << escape_empty(volume_uuid)
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600747 << ", user " << user_id << ", flags " << flags;
748 bool res = true;
749
Paul Crowley82b41ff2017-10-20 08:17:54 -0700750 res &= prepare_subdirs("destroy", volume_uuid, user_id, flags);
751
752 if (flags & android::os::IVold::STORAGE_FLAG_CE) {
Paul Crowley8e550662017-10-16 17:01:44 -0700753 // CE_n key
754 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
755 auto misc_ce_path = android::vold::BuildDataMiscCePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800756 auto vendor_ce_path = android::vold::BuildDataVendorCePath(user_id);
Paul Crowley8e550662017-10-16 17:01:44 -0700757 auto media_ce_path = android::vold::BuildDataMediaCePath(volume_uuid, user_id);
758 auto user_ce_path = android::vold::BuildDataUserCePath(volume_uuid, user_id);
759
760 res &= destroy_dir(media_ce_path);
761 res &= destroy_dir(user_ce_path);
762 if (volume_uuid.empty()) {
Paul Crowley8e550662017-10-16 17:01:44 -0700763 res &= destroy_dir(system_ce_path);
764 res &= destroy_dir(misc_ce_path);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800765 res &= destroy_dir(vendor_ce_path);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700766 } else {
Eric Biggersa701c452018-10-23 13:06:55 -0700767 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700768 res &= destroy_volkey(misc_ce_path, volume_uuid);
769 }
Paul Crowley8e550662017-10-16 17:01:44 -0700770 }
771 }
772
Paul Crowley82b41ff2017-10-20 08:17:54 -0700773 if (flags & android::os::IVold::STORAGE_FLAG_DE) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600774 // DE_sys key
775 auto system_legacy_path = android::vold::BuildDataSystemLegacyPath(user_id);
776 auto misc_legacy_path = android::vold::BuildDataMiscLegacyPath(user_id);
777 auto profiles_de_path = android::vold::BuildDataProfilesDePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600778
779 // DE_n key
780 auto system_de_path = android::vold::BuildDataSystemDePath(user_id);
781 auto misc_de_path = android::vold::BuildDataMiscDePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800782 auto vendor_de_path = android::vold::BuildDataVendorDePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600783 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
784
Paul Crowley8e550662017-10-16 17:01:44 -0700785 res &= destroy_dir(user_de_path);
Paul Crowley3b71fc52017-10-09 10:55:21 -0700786 if (volume_uuid.empty()) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600787 res &= destroy_dir(system_legacy_path);
788#if MANAGE_MISC_DIRS
789 res &= destroy_dir(misc_legacy_path);
790#endif
791 res &= destroy_dir(profiles_de_path);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600792 res &= destroy_dir(system_de_path);
793 res &= destroy_dir(misc_de_path);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800794 res &= destroy_dir(vendor_de_path);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700795 } else {
Eric Biggersa701c452018-10-23 13:06:55 -0700796 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700797 res &= destroy_volkey(misc_de_path, volume_uuid);
798 }
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600799 }
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600800 }
801
802 return res;
803}
Rubin Xu2436e272017-04-27 20:43:10 +0100804
Paul Crowleyc6433a22017-10-24 14:54:43 -0700805static bool destroy_volume_keys(const std::string& directory_path, const std::string& volume_uuid) {
806 auto dirp = std::unique_ptr<DIR, int (*)(DIR*)>(opendir(directory_path.c_str()), closedir);
807 if (!dirp) {
808 PLOG(ERROR) << "Unable to open directory: " + directory_path;
809 return false;
810 }
811 bool res = true;
812 for (;;) {
813 errno = 0;
814 auto const entry = readdir(dirp.get());
815 if (!entry) {
816 if (errno) {
817 PLOG(ERROR) << "Unable to read directory: " + directory_path;
818 return false;
819 }
820 break;
821 }
822 if (entry->d_type != DT_DIR || entry->d_name[0] == '.') {
823 LOG(DEBUG) << "Skipping non-user " << entry->d_name;
824 continue;
825 }
826 res &= destroy_volkey(directory_path + "/" + entry->d_name, volume_uuid);
827 }
828 return res;
829}
830
Eric Biggersa701c452018-10-23 13:06:55 -0700831bool fscrypt_destroy_volume_keys(const std::string& volume_uuid) {
Paul Crowleyc6433a22017-10-24 14:54:43 -0700832 bool res = true;
Eric Biggersa701c452018-10-23 13:06:55 -0700833 LOG(DEBUG) << "fscrypt_destroy_volume_keys for volume " << escape_empty(volume_uuid);
Paul Crowley26a53882017-10-26 11:16:39 -0700834 auto secdiscardable_path = volume_secdiscardable_path(volume_uuid);
835 res &= android::vold::runSecdiscardSingle(secdiscardable_path);
Paul Crowleyc6433a22017-10-24 14:54:43 -0700836 res &= destroy_volume_keys("/data/misc_ce", volume_uuid);
837 res &= destroy_volume_keys("/data/misc_de", volume_uuid);
838 return res;
839}