blob: e810d58349fe8b37eb9c7614853ba1e169c46c47 [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>
Jieb6698d52018-11-12 15:26:02 +080060#include <android-base/unique_fd.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000061
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080062using android::base::StringPrintf;
Pavel Grafovb350ed02017-07-27 17:34:57 +010063using android::base::WriteStringToFile;
Tom Cherry4c5bde22019-01-29 14:34:01 -080064using android::fs_mgr::GetEntryForMountPoint;
Paul Crowley05720802016-02-08 15:55:41 +000065using android::vold::kEmptyAuthentication;
Pavel Grafove2e2d302017-08-01 17:15:53 +010066using android::vold::KeyBuffer;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080067
Paul Lawrence731a7a22015-04-28 22:14:15 +000068namespace {
Andrew Scull7ec25c72016-10-31 10:28:25 +000069
Paul Crowley3aa914d2017-10-09 16:35:51 -070070struct PolicyKeyRef {
71 std::string contents_mode;
72 std::string filenames_mode;
73 std::string key_raw_ref;
74};
75
Eric Biggersa701c452018-10-23 13:06:55 -070076const std::string device_key_dir = std::string() + DATA_MNT_POINT + fscrypt_unencrypted_folder;
Paul Crowleydf528a72016-03-09 09:31:37 -080077const std::string device_key_path = device_key_dir + "/key";
78const std::string device_key_temp = device_key_dir + "/temp";
Paul Lawrence5a06a642016-02-03 13:39:13 -080079
Paul Crowleydf528a72016-03-09 09:31:37 -080080const std::string user_key_dir = std::string() + DATA_MNT_POINT + "/misc/vold/user_keys";
81const std::string user_key_temp = user_key_dir + "/temp";
Paul Crowley82b41ff2017-10-20 08:17:54 -070082const std::string prepare_subdirs_path = "/system/bin/vold_prepare_subdirs";
Paul Crowley285956f2016-01-20 13:12:38 +000083
Paul Crowley26a53882017-10-26 11:16:39 -070084const std::string systemwide_volume_key_dir =
85 std::string() + DATA_MNT_POINT + "/misc/vold/volume_keys";
86
Paul Crowleydf528a72016-03-09 09:31:37 -080087bool s_global_de_initialized = false;
Paul Lawrence7b6b5652016-02-02 11:14:59 -080088
Paul Crowleydf528a72016-03-09 09:31:37 -080089// Some users are ephemeral, don't try to wipe their keys from disk
90std::set<userid_t> s_ephemeral_users;
Paul Lawrenceaec34df2016-02-03 10:52:41 -080091
Paul Crowleydf528a72016-03-09 09:31:37 -080092// Map user ids to key references
93std::map<userid_t, std::string> s_de_key_raw_refs;
94std::map<userid_t, std::string> s_ce_key_raw_refs;
Paul Crowley99360d72016-10-19 14:00:24 -070095// TODO abolish this map, per b/26948053
Pavel Grafove2e2d302017-08-01 17:15:53 +010096std::map<userid_t, KeyBuffer> s_ce_keys;
Paul Lawrence731a7a22015-04-28 22:14:15 +000097
Paul Crowley14c8c072018-09-18 13:30:21 -070098} // namespace
Paul Lawrence731a7a22015-04-28 22:14:15 +000099
Eric Biggersa701c452018-10-23 13:06:55 -0700100static bool fscrypt_is_emulated() {
Paul Crowley38132a12016-02-09 09:50:32 +0000101 return property_get_bool("persist.sys.emulate_fbe", false);
102}
103
Paul Crowley3b71fc52017-10-09 10:55:21 -0700104static const char* escape_empty(const std::string& value) {
105 return value.empty() ? "null" : value.c_str();
Paul Lawrence731a7a22015-04-28 22:14:15 +0000106}
107
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000108static std::string get_de_key_path(userid_t user_id) {
109 return StringPrintf("%s/de/%d", user_key_dir.c_str(), user_id);
110}
111
Paul Crowleya3630362016-05-17 14:17:56 -0700112static std::string get_ce_key_directory_path(userid_t user_id) {
113 return StringPrintf("%s/ce/%d", user_key_dir.c_str(), user_id);
114}
115
116// Returns the keys newest first
117static std::vector<std::string> get_ce_key_paths(const std::string& directory_path) {
118 auto dirp = std::unique_ptr<DIR, int (*)(DIR*)>(opendir(directory_path.c_str()), closedir);
119 if (!dirp) {
120 PLOG(ERROR) << "Unable to open ce key directory: " + directory_path;
121 return std::vector<std::string>();
122 }
123 std::vector<std::string> result;
124 for (;;) {
125 errno = 0;
126 auto const entry = readdir(dirp.get());
127 if (!entry) {
128 if (errno) {
129 PLOG(ERROR) << "Unable to read ce key directory: " + directory_path;
130 return std::vector<std::string>();
131 }
132 break;
133 }
134 if (entry->d_type != DT_DIR || entry->d_name[0] != 'c') {
135 LOG(DEBUG) << "Skipping non-key " << entry->d_name;
136 continue;
137 }
138 result.emplace_back(directory_path + "/" + entry->d_name);
139 }
140 std::sort(result.begin(), result.end());
141 std::reverse(result.begin(), result.end());
142 return result;
143}
144
145static std::string get_ce_key_current_path(const std::string& directory_path) {
146 return directory_path + "/current";
147}
148
149static bool get_ce_key_new_path(const std::string& directory_path,
Paul Crowley14c8c072018-09-18 13:30:21 -0700150 const std::vector<std::string>& paths, std::string* ce_key_path) {
Paul Crowleya3630362016-05-17 14:17:56 -0700151 if (paths.empty()) {
152 *ce_key_path = get_ce_key_current_path(directory_path);
153 return true;
154 }
155 for (unsigned int i = 0; i < UINT_MAX; i++) {
156 auto const candidate = StringPrintf("%s/cx%010u", directory_path.c_str(), i);
157 if (paths[0] < candidate) {
158 *ce_key_path = candidate;
159 return true;
160 }
161 }
162 return false;
163}
164
165// Discard all keys but the named one; rename it to canonical name.
166// No point in acting on errors in this; ignore them.
Paul Crowley14c8c072018-09-18 13:30:21 -0700167static void fixate_user_ce_key(const std::string& directory_path, const std::string& to_fix,
Paul Crowleya3630362016-05-17 14:17:56 -0700168 const std::vector<std::string>& paths) {
Paul Crowley14c8c072018-09-18 13:30:21 -0700169 for (auto const other_path : paths) {
Paul Crowleya3630362016-05-17 14:17:56 -0700170 if (other_path != to_fix) {
171 android::vold::destroyKey(other_path);
172 }
173 }
174 auto const current_path = get_ce_key_current_path(directory_path);
175 if (to_fix != current_path) {
176 LOG(DEBUG) << "Renaming " << to_fix << " to " << current_path;
177 if (rename(to_fix.c_str(), current_path.c_str()) != 0) {
178 PLOG(WARNING) << "Unable to rename " << to_fix << " to " << current_path;
Jieb6698d52018-11-12 15:26:02 +0800179 return;
Paul Crowleya3630362016-05-17 14:17:56 -0700180 }
181 }
Paul Crowley621d9b92018-12-07 15:36:09 -0800182 android::vold::FsyncDirectory(directory_path);
Paul Crowleya3630362016-05-17 14:17:56 -0700183}
184
185static bool read_and_fixate_user_ce_key(userid_t user_id,
186 const android::vold::KeyAuthentication& auth,
Paul Crowley14c8c072018-09-18 13:30:21 -0700187 KeyBuffer* ce_key) {
Paul Crowleya3630362016-05-17 14:17:56 -0700188 auto const directory_path = get_ce_key_directory_path(user_id);
189 auto const paths = get_ce_key_paths(directory_path);
Paul Crowley14c8c072018-09-18 13:30:21 -0700190 for (auto const ce_key_path : paths) {
Paul Crowleya3630362016-05-17 14:17:56 -0700191 LOG(DEBUG) << "Trying user CE key " << ce_key_path;
192 if (android::vold::retrieveKey(ce_key_path, auth, ce_key)) {
193 LOG(DEBUG) << "Successfully retrieved key";
194 fixate_user_ce_key(directory_path, ce_key_path, paths);
195 return true;
196 }
197 }
198 LOG(ERROR) << "Failed to find working ce key for user " << user_id;
199 return false;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100200}
201
Paul Crowleydf528a72016-03-09 09:31:37 -0800202static bool read_and_install_user_ce_key(userid_t user_id,
203 const android::vold::KeyAuthentication& auth) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000204 if (s_ce_key_raw_refs.count(user_id) != 0) return true;
Pavel Grafove2e2d302017-08-01 17:15:53 +0100205 KeyBuffer ce_key;
Paul Crowleya3630362016-05-17 14:17:56 -0700206 if (!read_and_fixate_user_ce_key(user_id, auth, &ce_key)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000207 std::string ce_raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700208 if (!android::vold::installKey(ce_key, &ce_raw_ref)) return false;
Pavel Grafove2e2d302017-08-01 17:15:53 +0100209 s_ce_keys[user_id] = std::move(ce_key);
Paul Crowley05720802016-02-08 15:55:41 +0000210 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000211 LOG(DEBUG) << "Installed ce key for user " << user_id;
Paul Crowley1ef25582016-01-21 20:26:12 +0000212 return true;
Paul Crowley285956f2016-01-20 13:12:38 +0000213}
214
Paul Crowleydf528a72016-03-09 09:31:37 -0800215static bool prepare_dir(const std::string& dir, mode_t mode, uid_t uid, gid_t gid) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000216 LOG(DEBUG) << "Preparing: " << dir;
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000217 if (fs_prepare_dir(dir.c_str(), mode, uid, gid) != 0) {
218 PLOG(ERROR) << "Failed to prepare " << dir;
Paul Crowley285956f2016-01-20 13:12:38 +0000219 return false;
220 }
Paul Crowley13ffd8e2016-01-27 14:30:22 +0000221 return true;
222}
223
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600224static bool destroy_dir(const std::string& dir) {
225 LOG(DEBUG) << "Destroying: " << dir;
226 if (rmdir(dir.c_str()) != 0 && errno != ENOENT) {
227 PLOG(ERROR) << "Failed to destroy " << dir;
228 return false;
229 }
230 return true;
231}
232
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000233// NB this assumes that there is only one thread listening for crypt commands, because
234// it creates keys in a fixed location.
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000235static bool create_and_install_user_keys(userid_t user_id, bool create_ephemeral) {
Pavel Grafove2e2d302017-08-01 17:15:53 +0100236 KeyBuffer de_key, ce_key;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700237 if (!android::vold::randomKey(&de_key)) return false;
238 if (!android::vold::randomKey(&ce_key)) return false;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000239 if (create_ephemeral) {
240 // If the key should be created as ephemeral, don't store it.
241 s_ephemeral_users.insert(user_id);
242 } else {
Paul Crowleya3630362016-05-17 14:17:56 -0700243 auto const directory_path = get_ce_key_directory_path(user_id);
244 if (!prepare_dir(directory_path, 0700, AID_ROOT, AID_ROOT)) return false;
245 auto const paths = get_ce_key_paths(directory_path);
246 std::string ce_key_path;
247 if (!get_ce_key_new_path(directory_path, paths, &ce_key_path)) return false;
Paul Crowley14c8c072018-09-18 13:30:21 -0700248 if (!android::vold::storeKeyAtomically(ce_key_path, user_key_temp, kEmptyAuthentication,
249 ce_key))
250 return false;
Paul Crowleya3630362016-05-17 14:17:56 -0700251 fixate_user_ce_key(directory_path, ce_key_path, paths);
252 // Write DE key second; once this is written, all is good.
Paul Crowleyf71ace32016-06-02 11:01:19 -0700253 if (!android::vold::storeKeyAtomically(get_de_key_path(user_id), user_key_temp,
Paul Crowley14c8c072018-09-18 13:30:21 -0700254 kEmptyAuthentication, de_key))
255 return false;
Paul Crowley95376d62015-05-06 15:04:43 +0100256 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000257 std::string de_raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700258 if (!android::vold::installKey(de_key, &de_raw_ref)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000259 s_de_key_raw_refs[user_id] = de_raw_ref;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000260 std::string ce_raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700261 if (!android::vold::installKey(ce_key, &ce_raw_ref)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000262 s_ce_keys[user_id] = ce_key;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000263 s_ce_key_raw_refs[user_id] = ce_raw_ref;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000264 LOG(DEBUG) << "Created keys for user " << user_id;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000265 return true;
266}
267
Paul Crowleydf528a72016-03-09 09:31:37 -0800268static bool lookup_key_ref(const std::map<userid_t, std::string>& key_map, userid_t user_id,
269 std::string* raw_ref) {
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000270 auto refi = key_map.find(user_id);
271 if (refi == key_map.end()) {
272 LOG(ERROR) << "Cannot find key for " << user_id;
273 return false;
274 }
Paul Crowleya051eb72016-03-08 16:08:32 -0800275 *raw_ref = refi->second;
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000276 return true;
277}
278
Paul Crowley3aa914d2017-10-09 16:35:51 -0700279static void get_data_file_encryption_modes(PolicyKeyRef* key_ref) {
Tom Cherry4c5bde22019-01-29 14:34:01 -0800280 auto entry = GetEntryForMountPoint(&fstab_default, DATA_MNT_POINT);
281 if (entry == nullptr) {
282 return;
283 }
284 key_ref->contents_mode = entry->file_contents_mode;
285 key_ref->filenames_mode = entry->file_names_mode;
Paul Crowleya7ca40b2017-10-06 14:29:33 -0700286}
287
Paul Crowley3aa914d2017-10-09 16:35:51 -0700288static bool ensure_policy(const PolicyKeyRef& key_ref, const std::string& path) {
Eric Biggersa701c452018-10-23 13:06:55 -0700289 return fscrypt_policy_ensure(path.c_str(), key_ref.key_raw_ref.data(),
Paul Crowley3aa914d2017-10-09 16:35:51 -0700290 key_ref.key_raw_ref.size(), key_ref.contents_mode.c_str(),
291 key_ref.filenames_mode.c_str()) == 0;
Paul Crowley95376d62015-05-06 15:04:43 +0100292}
Paul Crowleyb33e8872015-05-19 12:34:09 +0100293
Paul Crowleydf528a72016-03-09 09:31:37 -0800294static bool is_numeric(const char* name) {
295 for (const char* p = name; *p != '\0'; p++) {
296 if (!isdigit(*p)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000297 }
298 return true;
299}
300
301static bool load_all_de_keys() {
302 auto de_dir = user_key_dir + "/de";
Paul Crowleydf528a72016-03-09 09:31:37 -0800303 auto dirp = std::unique_ptr<DIR, int (*)(DIR*)>(opendir(de_dir.c_str()), closedir);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000304 if (!dirp) {
305 PLOG(ERROR) << "Unable to read de key directory";
306 return false;
307 }
308 for (;;) {
309 errno = 0;
310 auto entry = readdir(dirp.get());
311 if (!entry) {
312 if (errno) {
313 PLOG(ERROR) << "Unable to read de key directory";
314 return false;
315 }
316 break;
317 }
318 if (entry->d_type != DT_DIR || !is_numeric(entry->d_name)) {
319 LOG(DEBUG) << "Skipping non-de-key " << entry->d_name;
320 continue;
321 }
Jeff Sharkey95440eb2017-09-18 18:19:28 -0600322 userid_t user_id = std::stoi(entry->d_name);
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000323 if (s_de_key_raw_refs.count(user_id) == 0) {
Paul Crowley05720802016-02-08 15:55:41 +0000324 auto key_path = de_dir + "/" + entry->d_name;
Pavel Grafove2e2d302017-08-01 17:15:53 +0100325 KeyBuffer key;
Paul Crowleya051eb72016-03-08 16:08:32 -0800326 if (!android::vold::retrieveKey(key_path, kEmptyAuthentication, &key)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000327 std::string raw_ref;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700328 if (!android::vold::installKey(key, &raw_ref)) return false;
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000329 s_de_key_raw_refs[user_id] = raw_ref;
330 LOG(DEBUG) << "Installed de key for user " << user_id;
331 }
332 }
Eric Biggersa701c452018-10-23 13:06:55 -0700333 // fscrypt:TODO: go through all DE directories, ensure that all user dirs have the
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000334 // correct policy set on them, and that no rogue ones exist.
335 return true;
336}
337
Eric Biggersa701c452018-10-23 13:06:55 -0700338bool fscrypt_initialize_global_de() {
339 LOG(INFO) << "fscrypt_initialize_global_de";
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800340
Paul Crowley38132a12016-02-09 09:50:32 +0000341 if (s_global_de_initialized) {
342 LOG(INFO) << "Already initialized";
Paul Crowley76107cb2016-02-09 10:04:39 +0000343 return true;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800344 }
345
Paul Crowley3aa914d2017-10-09 16:35:51 -0700346 PolicyKeyRef device_ref;
Paul Crowley26a53882017-10-26 11:16:39 -0700347 if (!android::vold::retrieveAndInstallKey(true, kEmptyAuthentication, device_key_path,
348 device_key_temp, &device_ref.key_raw_ref))
Paul Crowley3aa914d2017-10-09 16:35:51 -0700349 return false;
350 get_data_file_encryption_modes(&device_ref);
Eric Biggersb45caaf2017-02-02 14:52:12 -0800351
Paul Crowley3aa914d2017-10-09 16:35:51 -0700352 std::string modestring = device_ref.contents_mode + ":" + device_ref.filenames_mode;
Eric Biggersa701c452018-10-23 13:06:55 -0700353 std::string mode_filename = std::string("/data") + fscrypt_key_mode;
Eric Biggersb45caaf2017-02-02 14:52:12 -0800354 if (!android::base::WriteStringToFile(modestring, mode_filename)) {
Paul Lawrence6e410592016-05-24 14:20:38 -0700355 PLOG(ERROR) << "Cannot save type";
356 return false;
357 }
358
Eric Biggersa701c452018-10-23 13:06:55 -0700359 std::string ref_filename = std::string("/data") + fscrypt_key_ref;
Paul Crowley3aa914d2017-10-09 16:35:51 -0700360 if (!android::base::WriteStringToFile(device_ref.key_raw_ref, ref_filename)) {
Paul Crowleyf71ace32016-06-02 11:01:19 -0700361 PLOG(ERROR) << "Cannot save key reference to:" << ref_filename;
Paul Crowley76107cb2016-02-09 10:04:39 +0000362 return false;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800363 }
Paul Crowleyf71ace32016-06-02 11:01:19 -0700364 LOG(INFO) << "Wrote system DE key reference to:" << ref_filename;
Paul Lawrenceaec34df2016-02-03 10:52:41 -0800365
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
Eric Biggersa701c452018-10-23 13:06:55 -0700370bool fscrypt_init_user0() {
371 LOG(DEBUG) << "fscrypt_init_user0";
372 if (fscrypt_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 Crowleyf71ace32016-06-02 11:01:19 -0700376 if (!android::vold::pathExists(get_de_key_path(0))) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000377 if (!create_and_install_user_keys(0, false)) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000378 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700379 // TODO: switch to loading only DE_0 here once framework makes
380 // explicit calls to install DE keys for secondary users
Paul Crowley76107cb2016-02-09 10:04:39 +0000381 if (!load_all_de_keys()) return false;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000382 }
Jeff Sharkey47695b22016-02-01 17:02:29 -0700383 // We can only safely prepare DE storage here, since CE keys are probably
384 // entangled with user credentials. The framework will always prepare CE
385 // storage once CE keys are installed.
Eric Biggersa701c452018-10-23 13:06:55 -0700386 if (!fscrypt_prepare_user_storage("", 0, 0, android::os::IVold::STORAGE_FLAG_DE)) {
Jeff Sharkey47695b22016-02-01 17:02:29 -0700387 LOG(ERROR) << "Failed to prepare user 0 storage";
Paul Crowley76107cb2016-02-09 10:04:39 +0000388 return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700389 }
Jeff Sharkey0754a452016-02-08 12:21:42 -0700390
391 // If this is a non-FBE device that recently left an emulated mode,
392 // restore user data directories to known-good state.
Eric Biggersa701c452018-10-23 13:06:55 -0700393 if (!fscrypt_is_native() && !fscrypt_is_emulated()) {
394 fscrypt_unlock_user_key(0, 0, "!", "!");
Jeff Sharkey0754a452016-02-08 12:21:42 -0700395 }
396
Paul Crowley76107cb2016-02-09 10:04:39 +0000397 return true;
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000398}
399
Eric Biggersa701c452018-10-23 13:06:55 -0700400bool fscrypt_vold_create_user_key(userid_t user_id, int serial, bool ephemeral) {
401 LOG(DEBUG) << "fscrypt_vold_create_user_key for " << user_id << " serial " << serial;
402 if (!fscrypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000403 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000404 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000405 // FIXME test for existence of key that is not loaded yet
406 if (s_ce_key_raw_refs.count(user_id) != 0) {
Eric Biggersa701c452018-10-23 13:06:55 -0700407 LOG(ERROR) << "Already exists, can't fscrypt_vold_create_user_key for " << user_id
Paul Crowleydf528a72016-03-09 09:31:37 -0800408 << " serial " << serial;
Paul Crowley285956f2016-01-20 13:12:38 +0000409 // FIXME should we fail the command?
Paul Crowley76107cb2016-02-09 10:04:39 +0000410 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800411 }
Paul Crowleyb92f83c2016-02-01 14:10:43 +0000412 if (!create_and_install_user_keys(user_id, ephemeral)) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000413 return false;
Paul Crowley285956f2016-01-20 13:12:38 +0000414 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000415 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800416}
417
Pavel Grafovb350ed02017-07-27 17:34:57 +0100418static void drop_caches() {
419 // Clean any dirty pages (otherwise they won't be dropped).
420 sync();
421 // Drop inode and page caches.
422 if (!WriteStringToFile("3", "/proc/sys/vm/drop_caches")) {
423 PLOG(ERROR) << "Failed to drop caches during key eviction";
424 }
425}
426
Andrew Scull7ec25c72016-10-31 10:28:25 +0000427static bool evict_ce_key(userid_t user_id) {
Pavel Grafove2e2d302017-08-01 17:15:53 +0100428 s_ce_keys.erase(user_id);
Andrew Scull7ec25c72016-10-31 10:28:25 +0000429 bool success = true;
430 std::string raw_ref;
431 // If we haven't loaded the CE key, no need to evict it.
432 if (lookup_key_ref(s_ce_key_raw_refs, user_id, &raw_ref)) {
Paul Crowleyf71ace32016-06-02 11:01:19 -0700433 success &= android::vold::evictKey(raw_ref);
Pavel Grafovb350ed02017-07-27 17:34:57 +0100434 drop_caches();
Andrew Scull7ec25c72016-10-31 10:28:25 +0000435 }
436 s_ce_key_raw_refs.erase(user_id);
437 return success;
438}
439
Eric Biggersa701c452018-10-23 13:06:55 -0700440bool fscrypt_destroy_user_key(userid_t user_id) {
441 LOG(DEBUG) << "fscrypt_destroy_user_key(" << user_id << ")";
442 if (!fscrypt_is_native()) {
Paul Crowley76107cb2016-02-09 10:04:39 +0000443 return true;
Paul Crowleyea62e262016-01-28 12:23:53 +0000444 }
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000445 bool success = true;
446 std::string raw_ref;
Andrew Scull7ec25c72016-10-31 10:28:25 +0000447 success &= evict_ce_key(user_id);
Paul Crowley14c8c072018-09-18 13:30:21 -0700448 success &=
449 lookup_key_ref(s_de_key_raw_refs, user_id, &raw_ref) && android::vold::evictKey(raw_ref);
Paul Crowley05720802016-02-08 15:55:41 +0000450 s_de_key_raw_refs.erase(user_id);
Paul Crowleyb1f3d242016-01-28 10:09:46 +0000451 auto it = s_ephemeral_users.find(user_id);
452 if (it != s_ephemeral_users.end()) {
453 s_ephemeral_users.erase(it);
Paul Crowley1ef25582016-01-21 20:26:12 +0000454 } else {
Paul Crowley14c8c072018-09-18 13:30:21 -0700455 for (auto const path : get_ce_key_paths(get_ce_key_directory_path(user_id))) {
Paul Crowleya3630362016-05-17 14:17:56 -0700456 success &= android::vold::destroyKey(path);
457 }
Paul Crowleyab0b56a2016-07-19 15:29:53 -0700458 auto de_key_path = get_de_key_path(user_id);
Paul Crowleyf71ace32016-06-02 11:01:19 -0700459 if (android::vold::pathExists(de_key_path)) {
Paul Crowleyab0b56a2016-07-19 15:29:53 -0700460 success &= android::vold::destroyKey(de_key_path);
461 } else {
462 LOG(INFO) << "Not present so not erasing: " << de_key_path;
463 }
Lenka Trochtova395039f2015-11-25 10:13:03 +0100464 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000465 return success;
Paul Crowleyb33e8872015-05-19 12:34:09 +0100466}
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800467
Paul Crowley76107cb2016-02-09 10:04:39 +0000468static bool emulated_lock(const std::string& path) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700469 if (chmod(path.c_str(), 0000) != 0) {
470 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000471 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700472 }
473#if EMULATED_USES_SELINUX
474 if (setfilecon(path.c_str(), "u:object_r:storage_stub_file:s0") != 0) {
475 PLOG(WARNING) << "Failed to setfilecon " << path;
Paul Crowley76107cb2016-02-09 10:04:39 +0000476 return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700477 }
478#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000479 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700480}
481
Paul Crowley76107cb2016-02-09 10:04:39 +0000482static bool emulated_unlock(const std::string& path, mode_t mode) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700483 if (chmod(path.c_str(), mode) != 0) {
484 PLOG(ERROR) << "Failed to chmod " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000485 // FIXME temporary workaround for b/26713622
Eric Biggersa701c452018-10-23 13:06:55 -0700486 if (fscrypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700487 }
488#if EMULATED_USES_SELINUX
489 if (selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_FORCE) != 0) {
490 PLOG(WARNING) << "Failed to restorecon " << path;
Paul Crowleya042cb52016-01-21 17:24:49 +0000491 // FIXME temporary workaround for b/26713622
Eric Biggersa701c452018-10-23 13:06:55 -0700492 if (fscrypt_is_emulated()) return false;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700493 }
494#endif
Paul Crowley76107cb2016-02-09 10:04:39 +0000495 return true;
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700496}
497
Paul Crowley3b71fc52017-10-09 10:55:21 -0700498static bool parse_hex(const std::string& hex, std::string* result) {
499 if (hex == "!") {
Paul Crowleya051eb72016-03-08 16:08:32 -0800500 *result = "";
Paul Crowley05720802016-02-08 15:55:41 +0000501 return true;
502 }
Paul Crowleya051eb72016-03-08 16:08:32 -0800503 if (android::vold::HexToStr(hex, *result) != 0) {
Paul Crowleydf528a72016-03-09 09:31:37 -0800504 LOG(ERROR) << "Invalid FBE hex string"; // Don't log the string for security reasons
Paul Crowley05720802016-02-08 15:55:41 +0000505 return false;
506 }
507 return true;
508}
509
Paul Crowley3aa914d2017-10-09 16:35:51 -0700510static std::string volkey_path(const std::string& misc_path, const std::string& volume_uuid) {
511 return misc_path + "/vold/volume_keys/" + volume_uuid + "/default";
512}
513
Paul Crowley26a53882017-10-26 11:16:39 -0700514static std::string volume_secdiscardable_path(const std::string& volume_uuid) {
515 return systemwide_volume_key_dir + "/" + volume_uuid + "/secdiscardable";
516}
517
Paul Crowley3aa914d2017-10-09 16:35:51 -0700518static bool read_or_create_volkey(const std::string& misc_path, const std::string& volume_uuid,
519 PolicyKeyRef* key_ref) {
Paul Crowley26a53882017-10-26 11:16:39 -0700520 auto secdiscardable_path = volume_secdiscardable_path(volume_uuid);
521 std::string secdiscardable_hash;
522 if (android::vold::pathExists(secdiscardable_path)) {
523 if (!android::vold::readSecdiscardable(secdiscardable_path, &secdiscardable_hash))
524 return false;
525 } else {
526 if (fs_mkdirs(secdiscardable_path.c_str(), 0700) != 0) {
527 PLOG(ERROR) << "Creating directories for: " << secdiscardable_path;
528 return false;
529 }
530 if (!android::vold::createSecdiscardable(secdiscardable_path, &secdiscardable_hash))
531 return false;
532 }
Paul Crowley3aa914d2017-10-09 16:35:51 -0700533 auto key_path = volkey_path(misc_path, volume_uuid);
534 if (fs_mkdirs(key_path.c_str(), 0700) != 0) {
535 PLOG(ERROR) << "Creating directories for: " << key_path;
536 return false;
537 }
Paul Crowley26a53882017-10-26 11:16:39 -0700538 android::vold::KeyAuthentication auth("", secdiscardable_hash);
539 if (!android::vold::retrieveAndInstallKey(true, auth, key_path, key_path + "_tmp",
Paul Crowley3aa914d2017-10-09 16:35:51 -0700540 &key_ref->key_raw_ref))
541 return false;
542 key_ref->contents_mode =
543 android::base::GetProperty("ro.crypto.volume.contents_mode", "aes-256-xts");
544 key_ref->filenames_mode =
545 android::base::GetProperty("ro.crypto.volume.filenames_mode", "aes-256-heh");
546 return true;
547}
548
549static bool destroy_volkey(const std::string& misc_path, const std::string& volume_uuid) {
Paul Crowleyc6433a22017-10-24 14:54:43 -0700550 auto path = volkey_path(misc_path, volume_uuid);
551 if (!android::vold::pathExists(path)) return true;
552 return android::vold::destroyKey(path);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700553}
554
Eric Biggersa701c452018-10-23 13:06:55 -0700555bool fscrypt_add_user_key_auth(userid_t user_id, int serial, const std::string& token_hex,
Paul Crowley3b71fc52017-10-09 10:55:21 -0700556 const std::string& secret_hex) {
Eric Biggersa701c452018-10-23 13:06:55 -0700557 LOG(DEBUG) << "fscrypt_add_user_key_auth " << user_id << " serial=" << serial
Paul Crowley3b71fc52017-10-09 10:55:21 -0700558 << " token_present=" << (token_hex != "!");
Eric Biggersa701c452018-10-23 13:06:55 -0700559 if (!fscrypt_is_native()) return true;
Paul Crowley76107cb2016-02-09 10:04:39 +0000560 if (s_ephemeral_users.count(user_id) != 0) return true;
Paul Crowleya3630362016-05-17 14:17:56 -0700561 std::string token, secret;
Paul Crowleya051eb72016-03-08 16:08:32 -0800562 if (!parse_hex(token_hex, &token)) return false;
Paul Crowleya3630362016-05-17 14:17:56 -0700563 if (!parse_hex(secret_hex, &secret)) return false;
Paul Crowley14c8c072018-09-18 13:30:21 -0700564 auto auth =
565 secret.empty() ? kEmptyAuthentication : android::vold::KeyAuthentication(token, secret);
Paul Crowley05720802016-02-08 15:55:41 +0000566 auto it = s_ce_keys.find(user_id);
567 if (it == s_ce_keys.end()) {
568 LOG(ERROR) << "Key not loaded into memory, can't change for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000569 return false;
Paul Crowley05720802016-02-08 15:55:41 +0000570 }
Paul Crowley14c8c072018-09-18 13:30:21 -0700571 const auto& ce_key = it->second;
Paul Crowleya3630362016-05-17 14:17:56 -0700572 auto const directory_path = get_ce_key_directory_path(user_id);
573 auto const paths = get_ce_key_paths(directory_path);
574 std::string ce_key_path;
575 if (!get_ce_key_new_path(directory_path, paths, &ce_key_path)) return false;
Paul Crowleyf71ace32016-06-02 11:01:19 -0700576 if (!android::vold::storeKeyAtomically(ce_key_path, user_key_temp, auth, ce_key)) return false;
Paul Crowley621d9b92018-12-07 15:36:09 -0800577 if (!android::vold::FsyncDirectory(directory_path)) return false;
Paul Crowleya3630362016-05-17 14:17:56 -0700578 return true;
579}
580
Eric Biggersa701c452018-10-23 13:06:55 -0700581bool fscrypt_fixate_newest_user_key_auth(userid_t user_id) {
582 LOG(DEBUG) << "fscrypt_fixate_newest_user_key_auth " << user_id;
583 if (!fscrypt_is_native()) return true;
Paul Crowley25a71382016-07-25 15:55:36 -0700584 if (s_ephemeral_users.count(user_id) != 0) return true;
Paul Crowleya3630362016-05-17 14:17:56 -0700585 auto const directory_path = get_ce_key_directory_path(user_id);
586 auto const paths = get_ce_key_paths(directory_path);
587 if (paths.empty()) {
588 LOG(ERROR) << "No ce keys present, cannot fixate for user " << user_id;
589 return false;
Paul Crowleyad2eb642016-02-10 17:56:05 +0000590 }
Paul Crowleya3630362016-05-17 14:17:56 -0700591 fixate_user_ce_key(directory_path, paths[0], paths);
Paul Crowley76107cb2016-02-09 10:04:39 +0000592 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000593}
594
Jeff Sharkey47695b22016-02-01 17:02:29 -0700595// TODO: rename to 'install' for consistency, and take flags to know which keys to install
Eric Biggersa701c452018-10-23 13:06:55 -0700596bool fscrypt_unlock_user_key(userid_t user_id, int serial, const std::string& token_hex,
Paul Crowley3b71fc52017-10-09 10:55:21 -0700597 const std::string& secret_hex) {
Eric Biggersa701c452018-10-23 13:06:55 -0700598 LOG(DEBUG) << "fscrypt_unlock_user_key " << user_id << " serial=" << serial
Paul Crowley3b71fc52017-10-09 10:55:21 -0700599 << " token_present=" << (token_hex != "!");
Eric Biggersa701c452018-10-23 13:06:55 -0700600 if (fscrypt_is_native()) {
Paul Crowley05720802016-02-08 15:55:41 +0000601 if (s_ce_key_raw_refs.count(user_id) != 0) {
602 LOG(WARNING) << "Tried to unlock already-unlocked key for user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000603 return true;
Paul Crowley05720802016-02-08 15:55:41 +0000604 }
605 std::string token, secret;
Paul Crowleya051eb72016-03-08 16:08:32 -0800606 if (!parse_hex(token_hex, &token)) return false;
607 if (!parse_hex(secret_hex, &secret)) return false;
Paul Crowley05720802016-02-08 15:55:41 +0000608 android::vold::KeyAuthentication auth(token, secret);
609 if (!read_and_install_user_ce_key(user_id, auth)) {
Paul Crowley8fb12fd2016-02-01 14:28:12 +0000610 LOG(ERROR) << "Couldn't read key for " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000611 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800612 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700613 } else {
614 // When in emulation mode, we just use chmod. However, we also
615 // unlock directories when not in emulation mode, to bring devices
616 // back into a known-good state.
Paul Crowley76107cb2016-02-09 10:04:39 +0000617 if (!emulated_unlock(android::vold::BuildDataSystemCePath(user_id), 0771) ||
Paul Crowleydf528a72016-03-09 09:31:37 -0800618 !emulated_unlock(android::vold::BuildDataMiscCePath(user_id), 01771) ||
Paul Crowley3b71fc52017-10-09 10:55:21 -0700619 !emulated_unlock(android::vold::BuildDataMediaCePath("", user_id), 0770) ||
620 !emulated_unlock(android::vold::BuildDataUserCePath("", user_id), 0771)) {
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700621 LOG(ERROR) << "Failed to unlock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000622 return false;
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700623 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800624 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000625 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800626}
627
Jeff Sharkey47695b22016-02-01 17:02:29 -0700628// TODO: rename to 'evict' for consistency
Eric Biggersa701c452018-10-23 13:06:55 -0700629bool fscrypt_lock_user_key(userid_t user_id) {
630 LOG(DEBUG) << "fscrypt_lock_user_key " << user_id;
631 if (fscrypt_is_native()) {
Andrew Scull7ec25c72016-10-31 10:28:25 +0000632 return evict_ce_key(user_id);
Eric Biggersa701c452018-10-23 13:06:55 -0700633 } else if (fscrypt_is_emulated()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800634 // When in emulation mode, we just use chmod
Paul Crowley76107cb2016-02-09 10:04:39 +0000635 if (!emulated_lock(android::vold::BuildDataSystemCePath(user_id)) ||
Paul Crowleydf528a72016-03-09 09:31:37 -0800636 !emulated_lock(android::vold::BuildDataMiscCePath(user_id)) ||
Paul Crowley3b71fc52017-10-09 10:55:21 -0700637 !emulated_lock(android::vold::BuildDataMediaCePath("", user_id)) ||
638 !emulated_lock(android::vold::BuildDataUserCePath("", user_id))) {
Paul Crowley57eedbf2016-02-09 09:30:23 +0000639 LOG(ERROR) << "Failed to lock user " << user_id;
Paul Crowley76107cb2016-02-09 10:04:39 +0000640 return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800641 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800642 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700643
Paul Crowley76107cb2016-02-09 10:04:39 +0000644 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800645}
646
Paul Crowley82b41ff2017-10-20 08:17:54 -0700647static bool prepare_subdirs(const std::string& action, const std::string& volume_uuid,
648 userid_t user_id, int flags) {
649 if (0 != android::vold::ForkExecvp(
650 std::vector<std::string>{prepare_subdirs_path, action, volume_uuid,
651 std::to_string(user_id), std::to_string(flags)})) {
652 LOG(ERROR) << "vold_prepare_subdirs failed";
Paul Crowley8e550662017-10-16 17:01:44 -0700653 return false;
654 }
655 return true;
656}
657
Eric Biggersa701c452018-10-23 13:06:55 -0700658bool fscrypt_prepare_user_storage(const std::string& volume_uuid, userid_t user_id, int serial,
Paul Crowley3b71fc52017-10-09 10:55:21 -0700659 int flags) {
Eric Biggersa701c452018-10-23 13:06:55 -0700660 LOG(DEBUG) << "fscrypt_prepare_user_storage for volume " << escape_empty(volume_uuid)
Paul Crowleydf528a72016-03-09 09:31:37 -0800661 << ", user " << user_id << ", serial " << serial << ", flags " << flags;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700662
Paul Crowley82b41ff2017-10-20 08:17:54 -0700663 if (flags & android::os::IVold::STORAGE_FLAG_DE) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600664 // DE_sys key
665 auto system_legacy_path = android::vold::BuildDataSystemLegacyPath(user_id);
666 auto misc_legacy_path = android::vold::BuildDataMiscLegacyPath(user_id);
667 auto profiles_de_path = android::vold::BuildDataProfilesDePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600668
669 // DE_n key
Jeff Sharkey47695b22016-02-01 17:02:29 -0700670 auto system_de_path = android::vold::BuildDataSystemDePath(user_id);
671 auto misc_de_path = android::vold::BuildDataMiscDePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800672 auto vendor_de_path = android::vold::BuildDataVendorDePath(user_id);
Jeff Sharkey47695b22016-02-01 17:02:29 -0700673 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
674
Paul Crowley3b71fc52017-10-09 10:55:21 -0700675 if (volume_uuid.empty()) {
Paul Crowley6b756ce2017-10-05 14:07:09 -0700676 if (!prepare_dir(system_legacy_path, 0700, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600677#if MANAGE_MISC_DIRS
Paul Crowley6b756ce2017-10-05 14:07:09 -0700678 if (!prepare_dir(misc_legacy_path, 0750, multiuser_get_uid(user_id, AID_SYSTEM),
Paul Crowley14c8c072018-09-18 13:30:21 -0700679 multiuser_get_uid(user_id, AID_EVERYBODY)))
680 return false;
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600681#endif
Paul Crowley6b756ce2017-10-05 14:07:09 -0700682 if (!prepare_dir(profiles_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600683
Paul Crowley6b756ce2017-10-05 14:07:09 -0700684 if (!prepare_dir(system_de_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
685 if (!prepare_dir(misc_de_path, 01771, AID_SYSTEM, AID_MISC)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800686 if (!prepare_dir(vendor_de_path, 0771, AID_ROOT, AID_ROOT)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700687 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000688 if (!prepare_dir(user_de_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Calin Juravled1ee9442016-03-02 18:36:50 +0000689
Eric Biggersa701c452018-10-23 13:06:55 -0700690 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700691 PolicyKeyRef de_ref;
Paul Crowley3b71fc52017-10-09 10:55:21 -0700692 if (volume_uuid.empty()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700693 if (!lookup_key_ref(s_de_key_raw_refs, user_id, &de_ref.key_raw_ref)) return false;
694 get_data_file_encryption_modes(&de_ref);
695 if (!ensure_policy(de_ref, system_de_path)) return false;
696 if (!ensure_policy(de_ref, misc_de_path)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800697 if (!ensure_policy(de_ref, vendor_de_path)) return false;
Paul Crowley3aa914d2017-10-09 16:35:51 -0700698 } else {
699 if (!read_or_create_volkey(misc_de_path, volume_uuid, &de_ref)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700700 }
Paul Crowley3aa914d2017-10-09 16:35:51 -0700701 if (!ensure_policy(de_ref, user_de_path)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700702 }
Paul Crowley285956f2016-01-20 13:12:38 +0000703 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800704
Paul Crowley82b41ff2017-10-20 08:17:54 -0700705 if (flags & android::os::IVold::STORAGE_FLAG_CE) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600706 // CE_n key
Jeff Sharkey47695b22016-02-01 17:02:29 -0700707 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
708 auto misc_ce_path = android::vold::BuildDataMiscCePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800709 auto vendor_ce_path = android::vold::BuildDataVendorCePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600710 auto media_ce_path = android::vold::BuildDataMediaCePath(volume_uuid, user_id);
711 auto user_ce_path = android::vold::BuildDataUserCePath(volume_uuid, user_id);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800712
Paul Crowley3b71fc52017-10-09 10:55:21 -0700713 if (volume_uuid.empty()) {
Paul Crowley6b756ce2017-10-05 14:07:09 -0700714 if (!prepare_dir(system_ce_path, 0770, AID_SYSTEM, AID_SYSTEM)) return false;
715 if (!prepare_dir(misc_ce_path, 01771, AID_SYSTEM, AID_MISC)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800716 if (!prepare_dir(vendor_ce_path, 0771, AID_ROOT, AID_ROOT)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700717 }
Paul Crowley76107cb2016-02-09 10:04:39 +0000718 if (!prepare_dir(media_ce_path, 0770, AID_MEDIA_RW, AID_MEDIA_RW)) return false;
719 if (!prepare_dir(user_ce_path, 0771, AID_SYSTEM, AID_SYSTEM)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700720
Eric Biggersa701c452018-10-23 13:06:55 -0700721 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700722 PolicyKeyRef ce_ref;
Paul Crowley3b71fc52017-10-09 10:55:21 -0700723 if (volume_uuid.empty()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700724 if (!lookup_key_ref(s_ce_key_raw_refs, user_id, &ce_ref.key_raw_ref)) return false;
725 get_data_file_encryption_modes(&ce_ref);
726 if (!ensure_policy(ce_ref, system_ce_path)) return false;
727 if (!ensure_policy(ce_ref, misc_ce_path)) return false;
Andreas Huber71cd43f2018-01-22 11:25:29 -0800728 if (!ensure_policy(ce_ref, vendor_ce_path)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700729
Paul Crowley3aa914d2017-10-09 16:35:51 -0700730 } else {
731 if (!read_or_create_volkey(misc_ce_path, volume_uuid, &ce_ref)) return false;
Paul Crowley6b756ce2017-10-05 14:07:09 -0700732 }
Paul Crowley3aa914d2017-10-09 16:35:51 -0700733 if (!ensure_policy(ce_ref, media_ce_path)) return false;
734 if (!ensure_policy(ce_ref, user_ce_path)) return false;
Jeff Sharkey47695b22016-02-01 17:02:29 -0700735 }
Paul Crowley1a965262017-10-13 13:49:50 -0700736
737 if (volume_uuid.empty()) {
Paul Crowley8e550662017-10-16 17:01:44 -0700738 // Now that credentials have been installed, we can run restorecon
739 // over these paths
740 // NOTE: these paths need to be kept in sync with libselinux
741 android::vold::RestoreconRecursive(system_ce_path);
742 android::vold::RestoreconRecursive(misc_ce_path);
Paul Crowley1a965262017-10-13 13:49:50 -0700743 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800744 }
Paul Crowley82b41ff2017-10-20 08:17:54 -0700745 if (!prepare_subdirs("prepare", volume_uuid, user_id, flags)) return false;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800746
Paul Crowley76107cb2016-02-09 10:04:39 +0000747 return true;
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800748}
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600749
Eric Biggersa701c452018-10-23 13:06:55 -0700750bool fscrypt_destroy_user_storage(const std::string& volume_uuid, userid_t user_id, int flags) {
751 LOG(DEBUG) << "fscrypt_destroy_user_storage for volume " << escape_empty(volume_uuid)
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600752 << ", user " << user_id << ", flags " << flags;
753 bool res = true;
754
Paul Crowley82b41ff2017-10-20 08:17:54 -0700755 res &= prepare_subdirs("destroy", volume_uuid, user_id, flags);
756
757 if (flags & android::os::IVold::STORAGE_FLAG_CE) {
Paul Crowley8e550662017-10-16 17:01:44 -0700758 // CE_n key
759 auto system_ce_path = android::vold::BuildDataSystemCePath(user_id);
760 auto misc_ce_path = android::vold::BuildDataMiscCePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800761 auto vendor_ce_path = android::vold::BuildDataVendorCePath(user_id);
Paul Crowley8e550662017-10-16 17:01:44 -0700762 auto media_ce_path = android::vold::BuildDataMediaCePath(volume_uuid, user_id);
763 auto user_ce_path = android::vold::BuildDataUserCePath(volume_uuid, user_id);
764
765 res &= destroy_dir(media_ce_path);
766 res &= destroy_dir(user_ce_path);
767 if (volume_uuid.empty()) {
Paul Crowley8e550662017-10-16 17:01:44 -0700768 res &= destroy_dir(system_ce_path);
769 res &= destroy_dir(misc_ce_path);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800770 res &= destroy_dir(vendor_ce_path);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700771 } else {
Eric Biggersa701c452018-10-23 13:06:55 -0700772 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700773 res &= destroy_volkey(misc_ce_path, volume_uuid);
774 }
Paul Crowley8e550662017-10-16 17:01:44 -0700775 }
776 }
777
Paul Crowley82b41ff2017-10-20 08:17:54 -0700778 if (flags & android::os::IVold::STORAGE_FLAG_DE) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600779 // DE_sys key
780 auto system_legacy_path = android::vold::BuildDataSystemLegacyPath(user_id);
781 auto misc_legacy_path = android::vold::BuildDataMiscLegacyPath(user_id);
782 auto profiles_de_path = android::vold::BuildDataProfilesDePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600783
784 // DE_n key
785 auto system_de_path = android::vold::BuildDataSystemDePath(user_id);
786 auto misc_de_path = android::vold::BuildDataMiscDePath(user_id);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800787 auto vendor_de_path = android::vold::BuildDataVendorDePath(user_id);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600788 auto user_de_path = android::vold::BuildDataUserDePath(volume_uuid, user_id);
789
Paul Crowley8e550662017-10-16 17:01:44 -0700790 res &= destroy_dir(user_de_path);
Paul Crowley3b71fc52017-10-09 10:55:21 -0700791 if (volume_uuid.empty()) {
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600792 res &= destroy_dir(system_legacy_path);
793#if MANAGE_MISC_DIRS
794 res &= destroy_dir(misc_legacy_path);
795#endif
796 res &= destroy_dir(profiles_de_path);
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600797 res &= destroy_dir(system_de_path);
798 res &= destroy_dir(misc_de_path);
Andreas Huber71cd43f2018-01-22 11:25:29 -0800799 res &= destroy_dir(vendor_de_path);
Paul Crowley3aa914d2017-10-09 16:35:51 -0700800 } else {
Eric Biggersa701c452018-10-23 13:06:55 -0700801 if (fscrypt_is_native()) {
Paul Crowley3aa914d2017-10-09 16:35:51 -0700802 res &= destroy_volkey(misc_de_path, volume_uuid);
803 }
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600804 }
Jeff Sharkeybe70c9a2016-04-14 20:45:16 -0600805 }
806
807 return res;
808}
Rubin Xu2436e272017-04-27 20:43:10 +0100809
Paul Crowleyc6433a22017-10-24 14:54:43 -0700810static bool destroy_volume_keys(const std::string& directory_path, const std::string& volume_uuid) {
811 auto dirp = std::unique_ptr<DIR, int (*)(DIR*)>(opendir(directory_path.c_str()), closedir);
812 if (!dirp) {
813 PLOG(ERROR) << "Unable to open directory: " + directory_path;
814 return false;
815 }
816 bool res = true;
817 for (;;) {
818 errno = 0;
819 auto const entry = readdir(dirp.get());
820 if (!entry) {
821 if (errno) {
822 PLOG(ERROR) << "Unable to read directory: " + directory_path;
823 return false;
824 }
825 break;
826 }
827 if (entry->d_type != DT_DIR || entry->d_name[0] == '.') {
828 LOG(DEBUG) << "Skipping non-user " << entry->d_name;
829 continue;
830 }
831 res &= destroy_volkey(directory_path + "/" + entry->d_name, volume_uuid);
832 }
833 return res;
834}
835
Eric Biggersa701c452018-10-23 13:06:55 -0700836bool fscrypt_destroy_volume_keys(const std::string& volume_uuid) {
Paul Crowleyc6433a22017-10-24 14:54:43 -0700837 bool res = true;
Eric Biggersa701c452018-10-23 13:06:55 -0700838 LOG(DEBUG) << "fscrypt_destroy_volume_keys for volume " << escape_empty(volume_uuid);
Paul Crowley26a53882017-10-26 11:16:39 -0700839 auto secdiscardable_path = volume_secdiscardable_path(volume_uuid);
840 res &= android::vold::runSecdiscardSingle(secdiscardable_path);
Paul Crowleyc6433a22017-10-24 14:54:43 -0700841 res &= destroy_volume_keys("/data/misc_ce", volume_uuid);
842 res &= destroy_volume_keys("/data/misc_de", volume_uuid);
843 return res;
844}