blob: 4eb7c3ecc3346cec3797a9d8a7725a7c81b0c57f [file] [log] [blame]
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -08001/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Paul Lawrence731a7a22015-04-28 22:14:15 +000017#include "Ext4Crypt.h"
18
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080019#include "Utils.h"
20
Paul Lawrencefd7db732015-04-10 07:48:51 -070021#include <iomanip>
Paul Lawrence731a7a22015-04-28 22:14:15 +000022#include <map>
Paul Lawrencefd7db732015-04-10 07:48:51 -070023#include <fstream>
24#include <string>
25#include <sstream>
Paul Lawrence731a7a22015-04-28 22:14:15 +000026
27#include <errno.h>
Paul Crowley95376d62015-05-06 15:04:43 +010028#include <dirent.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000029#include <sys/mount.h>
Paul Crowley95376d62015-05-06 15:04:43 +010030#include <sys/types.h>
31#include <sys/stat.h>
32#include <fcntl.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000033#include <cutils/properties.h>
Paul Lawrencefd7db732015-04-10 07:48:51 -070034#include <openssl/sha.h>
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070035#include <selinux/android.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000036
Paul Crowley480fcd22015-08-24 14:53:28 +010037#include <private/android_filesystem_config.h>
38
Paul Lawrence731a7a22015-04-28 22:14:15 +000039#include "unencrypted_properties.h"
40#include "key_control.h"
41#include "cryptfs.h"
Paul Crowley95376d62015-05-06 15:04:43 +010042#include "ext4_crypt_init_extensions.h"
Paul Lawrence731a7a22015-04-28 22:14:15 +000043
44#define LOG_TAG "Ext4Crypt"
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080045
Jeff Sharkey7a9dd952016-01-12 16:52:16 -070046#define EMULATED_USES_SELINUX 0
47
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080048#include <cutils/fs.h>
49#include <cutils/log.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000050#include <cutils/klog.h>
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080051
Elliott Hughes7e128fb2015-12-04 15:50:53 -080052#include <android-base/file.h>
Elliott Hughes6bf05472015-12-04 17:55:33 -080053#include <android-base/logging.h>
Elliott Hughes7e128fb2015-12-04 15:50:53 -080054#include <android-base/stringprintf.h>
Paul Lawrence731a7a22015-04-28 22:14:15 +000055
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -080056using android::base::StringPrintf;
57
Jeff Sharkeyfc505c32015-12-07 17:27:01 -070058static bool e4crypt_is_native() {
59 char value[PROPERTY_VALUE_MAX];
60 property_get("ro.crypto.type", value, "none");
61 return !strcmp(value, "file");
62}
63
64static bool e4crypt_is_emulated() {
65 return property_get_bool("persist.sys.emulate_fbe", false);
66}
Jeff Sharkeyc79fb892015-11-12 20:18:02 -080067
Paul Lawrence731a7a22015-04-28 22:14:15 +000068namespace {
69 // Key length in bits
70 const int key_length = 128;
Paul Lawrencefd7db732015-04-10 07:48:51 -070071 static_assert(key_length % 8 == 0,
72 "Key length must be multiple of 8 bits");
Paul Lawrence731a7a22015-04-28 22:14:15 +000073
Paul Lawrence86c942a2015-05-06 13:53:43 -070074 // How long do we store passwords for?
75 const int password_max_age_seconds = 60;
76
Paul Lawrence731a7a22015-04-28 22:14:15 +000077 // How is device encrypted
78 struct keys {
79 std::string master_key;
80 std::string password;
Paul Lawrence86c942a2015-05-06 13:53:43 -070081 time_t expiry_time;
Paul Lawrence731a7a22015-04-28 22:14:15 +000082 };
83 std::map<std::string, keys> s_key_store;
Lenka Trochtova395039f2015-11-25 10:13:03 +010084 // Maps the key paths of ephemeral keys to the keys
85 std::map<std::string, std::string> s_ephemeral_user_keys;
Paul Lawrence731a7a22015-04-28 22:14:15 +000086
Paul Lawrencefd7db732015-04-10 07:48:51 -070087 // ext4enc:TODO get these consts from somewhere good
88 const int SHA512_LENGTH = 64;
89 const int EXT4_KEY_DESCRIPTOR_SIZE = 8;
90
Paul Lawrence731a7a22015-04-28 22:14:15 +000091 // ext4enc:TODO Include structure from somewhere sensible
92 // MUST be in sync with ext4_crypto.c in kernel
Paul Lawrencefd7db732015-04-10 07:48:51 -070093 const int EXT4_MAX_KEY_SIZE = 64;
94 const int EXT4_ENCRYPTION_MODE_AES_256_XTS = 1;
Paul Lawrence731a7a22015-04-28 22:14:15 +000095 struct ext4_encryption_key {
Paul Lawrencefd7db732015-04-10 07:48:51 -070096 uint32_t mode;
97 char raw[EXT4_MAX_KEY_SIZE];
98 uint32_t size;
Paul Lawrence731a7a22015-04-28 22:14:15 +000099 };
100
101 namespace tag {
102 const char* magic = "magic";
103 const char* major_version = "major_version";
104 const char* minor_version = "minor_version";
105 const char* flags = "flags";
106 const char* crypt_type = "crypt_type";
107 const char* failed_decrypt_count = "failed_decrypt_count";
108 const char* crypto_type_name = "crypto_type_name";
109 const char* master_key = "master_key";
110 const char* salt = "salt";
111 const char* kdf_type = "kdf_type";
112 const char* N_factor = "N_factor";
113 const char* r_factor = "r_factor";
114 const char* p_factor = "p_factor";
115 const char* keymaster_blob = "keymaster_blob";
116 const char* scrypted_intermediate_key = "scrypted_intermediate_key";
117 }
118}
119
Paul Crowley95376d62015-05-06 15:04:43 +0100120static std::string e4crypt_install_key(const std::string &key);
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100121
Paul Lawrence731a7a22015-04-28 22:14:15 +0000122static int put_crypt_ftr_and_key(const crypt_mnt_ftr& crypt_ftr,
123 UnencryptedProperties& props)
124{
125 SLOGI("Putting crypt footer");
126
127 bool success = props.Set<int>(tag::magic, crypt_ftr.magic)
128 && props.Set<int>(tag::major_version, crypt_ftr.major_version)
129 && props.Set<int>(tag::minor_version, crypt_ftr.minor_version)
130 && props.Set<int>(tag::flags, crypt_ftr.flags)
131 && props.Set<int>(tag::crypt_type, crypt_ftr.crypt_type)
132 && props.Set<int>(tag::failed_decrypt_count,
133 crypt_ftr.failed_decrypt_count)
134 && props.Set<std::string>(tag::crypto_type_name,
135 std::string(reinterpret_cast<const char*>(crypt_ftr.crypto_type_name)))
136 && props.Set<std::string>(tag::master_key,
137 std::string((const char*) crypt_ftr.master_key,
138 crypt_ftr.keysize))
139 && props.Set<std::string>(tag::salt,
140 std::string((const char*) crypt_ftr.salt,
141 SALT_LEN))
142 && props.Set<int>(tag::kdf_type, crypt_ftr.kdf_type)
143 && props.Set<int>(tag::N_factor, crypt_ftr.N_factor)
144 && props.Set<int>(tag::r_factor, crypt_ftr.r_factor)
145 && props.Set<int>(tag::p_factor, crypt_ftr.p_factor)
146 && props.Set<std::string>(tag::keymaster_blob,
147 std::string((const char*) crypt_ftr.keymaster_blob,
148 crypt_ftr.keymaster_blob_size))
149 && props.Set<std::string>(tag::scrypted_intermediate_key,
150 std::string((const char*) crypt_ftr.scrypted_intermediate_key,
151 SCRYPT_LEN));
152 return success ? 0 : -1;
153}
154
155static int get_crypt_ftr_and_key(crypt_mnt_ftr& crypt_ftr,
156 const UnencryptedProperties& props)
157{
158 memset(&crypt_ftr, 0, sizeof(crypt_ftr));
159 crypt_ftr.magic = props.Get<int>(tag::magic);
160 crypt_ftr.major_version = props.Get<int>(tag::major_version);
161 crypt_ftr.minor_version = props.Get<int>(tag::minor_version);
Paul Lawrence0d9cd9e2015-05-05 15:58:27 -0700162 crypt_ftr.ftr_size = sizeof(crypt_ftr);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000163 crypt_ftr.flags = props.Get<int>(tag::flags);
164 crypt_ftr.crypt_type = props.Get<int>(tag::crypt_type);
165 crypt_ftr.failed_decrypt_count = props.Get<int>(tag::failed_decrypt_count);
166 std::string crypto_type_name = props.Get<std::string>(tag::crypto_type_name);
167 strlcpy(reinterpret_cast<char*>(crypt_ftr.crypto_type_name),
168 crypto_type_name.c_str(),
169 sizeof(crypt_ftr.crypto_type_name));
170 std::string master_key = props.Get<std::string>(tag::master_key);
171 crypt_ftr.keysize = master_key.size();
172 if (crypt_ftr.keysize > sizeof(crypt_ftr.master_key)) {
173 SLOGE("Master key size too long");
174 return -1;
175 }
176 memcpy(crypt_ftr.master_key, &master_key[0], crypt_ftr.keysize);
177 std::string salt = props.Get<std::string>(tag::salt);
178 if (salt.size() != SALT_LEN) {
179 SLOGE("Salt wrong length");
180 return -1;
181 }
182 memcpy(crypt_ftr.salt, &salt[0], SALT_LEN);
183 crypt_ftr.kdf_type = props.Get<int>(tag::kdf_type);
184 crypt_ftr.N_factor = props.Get<int>(tag::N_factor);
185 crypt_ftr.r_factor = props.Get<int>(tag::r_factor);
186 crypt_ftr.p_factor = props.Get<int>(tag::p_factor);
187 std::string keymaster_blob = props.Get<std::string>(tag::keymaster_blob);
188 crypt_ftr.keymaster_blob_size = keymaster_blob.size();
189 if (crypt_ftr.keymaster_blob_size > sizeof(crypt_ftr.keymaster_blob)) {
190 SLOGE("Keymaster blob too long");
191 return -1;
192 }
193 memcpy(crypt_ftr.keymaster_blob, &keymaster_blob[0],
194 crypt_ftr.keymaster_blob_size);
195 std::string scrypted_intermediate_key = props.Get<std::string>(tag::scrypted_intermediate_key);
196 if (scrypted_intermediate_key.size() != SCRYPT_LEN) {
197 SLOGE("scrypted intermediate key wrong length");
198 return -1;
199 }
200 memcpy(crypt_ftr.scrypted_intermediate_key, &scrypted_intermediate_key[0],
201 SCRYPT_LEN);
202
203 return 0;
204}
205
206static UnencryptedProperties GetProps(const char* path)
207{
208 return UnencryptedProperties(path);
209}
210
211static UnencryptedProperties GetAltProps(const char* path)
212{
213 return UnencryptedProperties((std::string() + path + "/tmp_mnt").c_str());
214}
215
216static UnencryptedProperties GetPropsOrAltProps(const char* path)
217{
218 UnencryptedProperties props = GetProps(path);
219 if (props.OK()) {
220 return props;
221 }
222 return GetAltProps(path);
223}
224
225int e4crypt_enable(const char* path)
226{
227 // Already enabled?
228 if (s_key_store.find(path) != s_key_store.end()) {
229 return 0;
230 }
231
232 // Not an encryptable device?
233 UnencryptedProperties key_props = GetProps(path).GetChild(properties::key);
234 if (!key_props.OK()) {
235 return 0;
236 }
237
238 if (key_props.Get<std::string>(tag::master_key).empty()) {
239 crypt_mnt_ftr ftr;
240 if (cryptfs_create_default_ftr(&ftr, key_length)) {
241 SLOGE("Failed to create crypto footer");
242 return -1;
243 }
244
Paul Lawrence0d9cd9e2015-05-05 15:58:27 -0700245 // Scrub fields not used by ext4enc
246 ftr.persist_data_offset[0] = 0;
247 ftr.persist_data_offset[1] = 0;
248 ftr.persist_data_size = 0;
249
Paul Lawrence731a7a22015-04-28 22:14:15 +0000250 if (put_crypt_ftr_and_key(ftr, key_props)) {
251 SLOGE("Failed to write crypto footer");
252 return -1;
253 }
254
255 crypt_mnt_ftr ftr2;
256 if (get_crypt_ftr_and_key(ftr2, key_props)) {
257 SLOGE("Failed to read crypto footer back");
258 return -1;
259 }
260
261 if (memcmp(&ftr, &ftr2, sizeof(ftr)) != 0) {
262 SLOGE("Crypto footer not correctly written");
Paul Lawrence0d9cd9e2015-05-05 15:58:27 -0700263 return -1;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000264 }
265 }
266
267 if (!UnencryptedProperties(path).Remove(properties::ref)) {
268 SLOGE("Failed to remove key ref");
269 return -1;
270 }
271
272 return e4crypt_check_passwd(path, "");
273}
274
275int e4crypt_change_password(const char* path, int crypt_type,
276 const char* password)
277{
278 SLOGI("e4crypt_change_password");
Paul Lawrencea56d3132015-05-04 15:48:24 -0700279 auto key_props = GetProps(path).GetChild(properties::key);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000280
281 crypt_mnt_ftr ftr;
282 if (get_crypt_ftr_and_key(ftr, key_props)) {
283 SLOGE("Failed to read crypto footer back");
284 return -1;
285 }
286
287 auto mki = s_key_store.find(path);
288 if (mki == s_key_store.end()) {
289 SLOGE("No stored master key - can't change password");
290 return -1;
291 }
292
Paul Crowley95376d62015-05-06 15:04:43 +0100293 const unsigned char* master_key_bytes
Paul Lawrence731a7a22015-04-28 22:14:15 +0000294 = reinterpret_cast<const unsigned char*>(&mki->second.master_key[0]);
295
Paul Crowley95376d62015-05-06 15:04:43 +0100296 if (cryptfs_set_password(&ftr, password, master_key_bytes)) {
Paul Lawrence731a7a22015-04-28 22:14:15 +0000297 SLOGE("Failed to set password");
298 return -1;
299 }
300
301 ftr.crypt_type = crypt_type;
302
303 if (put_crypt_ftr_and_key(ftr, key_props)) {
304 SLOGE("Failed to write crypto footer");
305 return -1;
306 }
307
308 if (!UnencryptedProperties(path).Set(properties::is_default,
309 crypt_type == CRYPT_TYPE_DEFAULT)) {
310 SLOGE("Failed to update default flag");
311 return -1;
312 }
313
314 return 0;
315}
316
317int e4crypt_crypto_complete(const char* path)
318{
319 SLOGI("ext4 crypto complete called on %s", path);
Paul Lawrencea56d3132015-05-04 15:48:24 -0700320 auto key_props = GetPropsOrAltProps(path).GetChild(properties::key);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000321 if (key_props.Get<std::string>(tag::master_key).empty()) {
322 SLOGI("No master key, so not ext4enc");
323 return -1;
324 }
325
326 return 0;
327}
328
Paul Crowley93363482015-07-07 15:17:22 +0100329// Get raw keyref - used to make keyname and to pass to ioctl
Paul Lawrencefd7db732015-04-10 07:48:51 -0700330static std::string generate_key_ref(const char* key, int length)
331{
332 SHA512_CTX c;
333
334 SHA512_Init(&c);
335 SHA512_Update(&c, key, length);
336 unsigned char key_ref1[SHA512_LENGTH];
337 SHA512_Final(key_ref1, &c);
338
339 SHA512_Init(&c);
340 SHA512_Update(&c, key_ref1, SHA512_LENGTH);
341 unsigned char key_ref2[SHA512_LENGTH];
342 SHA512_Final(key_ref2, &c);
343
344 return std::string((char*)key_ref2, EXT4_KEY_DESCRIPTOR_SIZE);
345}
346
Paul Lawrence731a7a22015-04-28 22:14:15 +0000347int e4crypt_check_passwd(const char* path, const char* password)
348{
349 SLOGI("e4crypt_check_password");
Paul Lawrencea56d3132015-05-04 15:48:24 -0700350 auto props = GetPropsOrAltProps(path);
351 auto key_props = props.GetChild(properties::key);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000352
353 crypt_mnt_ftr ftr;
354 if (get_crypt_ftr_and_key(ftr, key_props)) {
355 SLOGE("Failed to read crypto footer back");
356 return -1;
357 }
358
Paul Crowley95376d62015-05-06 15:04:43 +0100359 unsigned char master_key_bytes[key_length / 8];
360 if (cryptfs_get_master_key (&ftr, password, master_key_bytes)){
Paul Lawrence731a7a22015-04-28 22:14:15 +0000361 SLOGI("Incorrect password");
Paul Lawrencec78c71b2015-04-14 15:26:29 -0700362 ftr.failed_decrypt_count++;
363 if (put_crypt_ftr_and_key(ftr, key_props)) {
364 SLOGW("Failed to update failed_decrypt_count");
365 }
366 return ftr.failed_decrypt_count;
367 }
368
369 if (ftr.failed_decrypt_count) {
370 ftr.failed_decrypt_count = 0;
371 if (put_crypt_ftr_and_key(ftr, key_props)) {
372 SLOGW("Failed to reset failed_decrypt_count");
373 }
Paul Lawrence731a7a22015-04-28 22:14:15 +0000374 }
Paul Crowley95376d62015-05-06 15:04:43 +0100375 std::string master_key(reinterpret_cast<char*>(master_key_bytes),
376 sizeof(master_key_bytes));
Paul Lawrence731a7a22015-04-28 22:14:15 +0000377
Paul Lawrence86c942a2015-05-06 13:53:43 -0700378 struct timespec now;
379 clock_gettime(CLOCK_BOOTTIME, &now);
Paul Crowley95376d62015-05-06 15:04:43 +0100380 s_key_store[path] = keys{master_key, password,
Paul Lawrence86c942a2015-05-06 13:53:43 -0700381 now.tv_sec + password_max_age_seconds};
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100382 auto raw_ref = e4crypt_install_key(master_key);
383 if (raw_ref.empty()) {
384 return -1;
385 }
Paul Lawrence731a7a22015-04-28 22:14:15 +0000386
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100387 // Save reference to key so we can set policy later
388 if (!props.Set(properties::ref, raw_ref)) {
389 SLOGE("Cannot save key reference");
390 return -1;
391 }
392
393 return 0;
394}
395
Paul Crowley93363482015-07-07 15:17:22 +0100396static ext4_encryption_key fill_key(const std::string &key)
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100397{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700398 // ext4enc:TODO Currently raw key is required to be of length
399 // sizeof(ext4_key.raw) == EXT4_MAX_KEY_SIZE, so zero pad to
400 // this length. Change when kernel bug is fixed.
401 ext4_encryption_key ext4_key = {EXT4_ENCRYPTION_MODE_AES_256_XTS,
402 {0},
403 sizeof(ext4_key.raw)};
404 memset(ext4_key.raw, 0, sizeof(ext4_key.raw));
405 static_assert(key_length / 8 <= sizeof(ext4_key.raw),
406 "Key too long!");
Paul Crowley95376d62015-05-06 15:04:43 +0100407 memcpy(ext4_key.raw, &key[0], key.size());
Paul Crowley93363482015-07-07 15:17:22 +0100408 return ext4_key;
409}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000410
Paul Crowley93363482015-07-07 15:17:22 +0100411static std::string keyname(const std::string &raw_ref)
412{
Paul Lawrencefd7db732015-04-10 07:48:51 -0700413 std::ostringstream o;
Paul Crowley93363482015-07-07 15:17:22 +0100414 o << "ext4:";
Paul Lawrencefd7db732015-04-10 07:48:51 -0700415 for (auto i = raw_ref.begin(); i != raw_ref.end(); ++i) {
416 o << std::hex << std::setw(2) << std::setfill('0') << (int)*i;
417 }
Paul Crowley93363482015-07-07 15:17:22 +0100418 return o.str();
419}
Paul Lawrencefd7db732015-04-10 07:48:51 -0700420
Paul Crowley93363482015-07-07 15:17:22 +0100421// Get the keyring we store all keys in
422static key_serial_t e4crypt_keyring()
423{
424 return keyctl_search(KEY_SPEC_SESSION_KEYRING, "keyring", "e4crypt", 0);
425}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000426
Paul Crowley93363482015-07-07 15:17:22 +0100427static int e4crypt_install_key(const ext4_encryption_key &ext4_key, const std::string &ref)
428{
429 key_serial_t device_keyring = e4crypt_keyring();
Paul Lawrence731a7a22015-04-28 22:14:15 +0000430 SLOGI("Found device_keyring - id is %d", device_keyring);
Paul Lawrencefd7db732015-04-10 07:48:51 -0700431 key_serial_t key_id = add_key("logon", ref.c_str(),
Paul Lawrence731a7a22015-04-28 22:14:15 +0000432 (void*)&ext4_key, sizeof(ext4_key),
433 device_keyring);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000434 if (key_id == -1) {
435 SLOGE("Failed to insert key into keyring with error %s",
436 strerror(errno));
Paul Crowley93363482015-07-07 15:17:22 +0100437 return -1;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000438 }
Paul Lawrencefd7db732015-04-10 07:48:51 -0700439 SLOGI("Added key %d (%s) to keyring %d in process %d",
440 key_id, ref.c_str(), device_keyring, getpid());
Paul Crowley93363482015-07-07 15:17:22 +0100441 return 0;
442}
Paul Lawrence731a7a22015-04-28 22:14:15 +0000443
Paul Crowley93363482015-07-07 15:17:22 +0100444// Install password into global keyring
445// Return raw key reference for use in policy
446static std::string e4crypt_install_key(const std::string &key)
447{
448 auto ext4_key = fill_key(key);
449 auto raw_ref = generate_key_ref(ext4_key.raw, ext4_key.size);
450 auto ref = keyname(raw_ref);
451 if (e4crypt_install_key(ext4_key, ref) == -1) {
452 return "";
453 }
Paul Crowleyf25a35a2015-05-06 13:38:53 +0100454 return raw_ref;
Paul Lawrence731a7a22015-04-28 22:14:15 +0000455}
456
457int e4crypt_restart(const char* path)
458{
459 SLOGI("e4crypt_restart");
460
461 int rc = 0;
462
463 SLOGI("ext4 restart called on %s", path);
464 property_set("vold.decrypt", "trigger_reset_main");
465 SLOGI("Just asked init to shut down class main");
466 sleep(2);
467
468 std::string tmp_path = std::string() + path + "/tmp_mnt";
469
Paul Lawrence2f32cda2015-05-05 14:28:25 -0700470 rc = wait_and_unmount(tmp_path.c_str(), true);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000471 if (rc) {
472 SLOGE("umount %s failed with rc %d, msg %s",
473 tmp_path.c_str(), rc, strerror(errno));
474 return rc;
475 }
476
Paul Lawrence2f32cda2015-05-05 14:28:25 -0700477 rc = wait_and_unmount(path, true);
Paul Lawrence731a7a22015-04-28 22:14:15 +0000478 if (rc) {
479 SLOGE("umount %s failed with rc %d, msg %s",
480 path, rc, strerror(errno));
481 return rc;
482 }
483
484 return 0;
485}
486
Paul Lawrence731a7a22015-04-28 22:14:15 +0000487int e4crypt_get_password_type(const char* path)
488{
489 SLOGI("e4crypt_get_password_type");
490 return GetPropsOrAltProps(path).GetChild(properties::key)
491 .Get<int>(tag::crypt_type, CRYPT_TYPE_DEFAULT);
492}
Paul Lawrence368d7942015-04-15 14:12:00 -0700493
Paul Lawrence86c942a2015-05-06 13:53:43 -0700494const char* e4crypt_get_password(const char* path)
495{
496 SLOGI("e4crypt_get_password");
497
498 auto i = s_key_store.find(path);
499 if (i == s_key_store.end()) {
500 return 0;
501 }
502
503 struct timespec now;
504 clock_gettime(CLOCK_BOOTTIME, &now);
505 if (i->second.expiry_time < now.tv_sec) {
506 e4crypt_clear_password(path);
507 return 0;
508 }
509
510 return i->second.password.c_str();
511}
512
513void e4crypt_clear_password(const char* path)
514{
515 SLOGI("e4crypt_clear_password");
516
517 auto i = s_key_store.find(path);
518 if (i == s_key_store.end()) {
519 return;
520 }
521
522 memset(&i->second.password[0], 0, i->second.password.size());
523 i->second.password = std::string();
524}
525
Paul Lawrence368d7942015-04-15 14:12:00 -0700526int e4crypt_get_field(const char* path, const char* fieldname,
527 char* value, size_t len)
528{
529 auto v = GetPropsOrAltProps(path).GetChild(properties::props)
530 .Get<std::string>(fieldname);
531
532 if (v == "") {
533 return CRYPTO_GETFIELD_ERROR_NO_FIELD;
534 }
535
536 if (v.length() >= len) {
537 return CRYPTO_GETFIELD_ERROR_BUF_TOO_SMALL;
538 }
539
540 strlcpy(value, v.c_str(), len);
541 return 0;
542}
543
544int e4crypt_set_field(const char* path, const char* fieldname,
545 const char* value)
546{
547 return GetPropsOrAltProps(path).GetChild(properties::props)
548 .Set(fieldname, std::string(value)) ? 0 : -1;
549}
Paul Crowley95376d62015-05-06 15:04:43 +0100550
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800551static std::string get_key_path(const char *mount_path, userid_t user_id) {
Paul Crowley95376d62015-05-06 15:04:43 +0100552 // ext4enc:TODO get the path properly
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800553 auto key_dir = StringPrintf("%s/misc/vold/user_keys", mount_path);
554 if (fs_prepare_dir(key_dir.c_str(), 0700, AID_ROOT, AID_ROOT)) {
555 PLOG(ERROR) << "Failed to prepare " << key_dir;
Paul Crowley95376d62015-05-06 15:04:43 +0100556 return "";
557 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800558 return StringPrintf("%s/%d", key_dir.c_str(), user_id);
Paul Crowleyb33e8872015-05-19 12:34:09 +0100559}
560
Lenka Trochtova395039f2015-11-25 10:13:03 +0100561static bool e4crypt_is_key_ephemeral(const std::string &key_path) {
562 return s_ephemeral_user_keys.find(key_path) != s_ephemeral_user_keys.end();
563}
564
Paul Crowleyb33e8872015-05-19 12:34:09 +0100565// ext4enc:TODO this can't be the only place keys are read from /dev/urandom
566// we should unite those places.
Paul Crowley93363482015-07-07 15:17:22 +0100567static std::string e4crypt_get_key(
568 const std::string &key_path,
Lenka Trochtova395039f2015-11-25 10:13:03 +0100569 bool create_if_absent,
570 bool create_ephemeral)
Paul Crowleyb33e8872015-05-19 12:34:09 +0100571{
Lenka Trochtova395039f2015-11-25 10:13:03 +0100572 const auto ephemeral_key_it = s_ephemeral_user_keys.find(key_path);
573 if (ephemeral_key_it != s_ephemeral_user_keys.end()) {
574 return ephemeral_key_it->second;
575 }
576
Paul Crowley95376d62015-05-06 15:04:43 +0100577 std::string content;
578 if (android::base::ReadFileToString(key_path, &content)) {
579 if (content.size() != key_length/8) {
580 SLOGE("Wrong size key %zu in %s", content.size(), key_path.c_str());
581 return "";
582 }
583 return content;
584 }
585 if (!create_if_absent) {
586 SLOGE("No key found in %s", key_path.c_str());
587 return "";
588 }
589 std::ifstream urandom("/dev/urandom");
590 if (!urandom) {
591 SLOGE("Unable to open /dev/urandom (%s)", strerror(errno));
592 return "";
593 }
594 char key_bytes[key_length / 8];
595 errno = 0;
596 urandom.read(key_bytes, sizeof(key_bytes));
597 if (!urandom) {
598 SLOGE("Unable to read key from /dev/urandom (%s)", strerror(errno));
599 return "";
600 }
Paul Crowley93363482015-07-07 15:17:22 +0100601 std::string key(key_bytes, sizeof(key_bytes));
Lenka Trochtova395039f2015-11-25 10:13:03 +0100602 if (create_ephemeral) {
603 // If the key should be created as ephemeral, store it in memory only.
604 s_ephemeral_user_keys[key_path] = key;
605 } else if (!android::base::WriteStringToFile(key, key_path)) {
Paul Crowley95376d62015-05-06 15:04:43 +0100606 SLOGE("Unable to write key to %s (%s)",
607 key_path.c_str(), strerror(errno));
608 return "";
609 }
Paul Crowley93363482015-07-07 15:17:22 +0100610 return key;
Paul Crowley95376d62015-05-06 15:04:43 +0100611}
612
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800613static int e4crypt_set_user_policy(const char *mount_path, userid_t user_id,
Jeff Sharkeyd2d7bff2015-12-18 17:18:22 -0700614 std::string& path, bool create_if_absent, bool create_ephemeral) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800615 SLOGD("e4crypt_set_user_policy for %d", user_id);
616 auto user_key = e4crypt_get_key(get_key_path(mount_path, user_id),
Lenka Trochtova395039f2015-11-25 10:13:03 +0100617 create_if_absent, create_ephemeral);
Paul Crowley95376d62015-05-06 15:04:43 +0100618 if (user_key.empty()) {
619 return -1;
620 }
621 auto raw_ref = e4crypt_install_key(user_key);
622 if (raw_ref.empty()) {
623 return -1;
624 }
Jeff Sharkeyd2d7bff2015-12-18 17:18:22 -0700625 return do_policy_set(path.c_str(), raw_ref.c_str(), raw_ref.size());
Paul Crowley95376d62015-05-06 15:04:43 +0100626}
627
Paul Crowley95376d62015-05-06 15:04:43 +0100628static bool is_numeric(const char *name) {
629 for (const char *p = name; *p != '\0'; p++) {
630 if (!isdigit(*p))
631 return false;
632 }
633 return true;
634}
635
Paul Crowley27cbce92015-12-10 14:51:30 +0000636int e4crypt_vold_set_user_crypto_policies(const char *dir)
Paul Crowley95376d62015-05-06 15:04:43 +0100637{
638 if (e4crypt_crypto_complete(DATA_MNT_POINT) != 0) {
639 return 0;
640 }
Paul Crowley27cbce92015-12-10 14:51:30 +0000641 SLOGD("e4crypt_vold_set_user_crypto_policies");
Paul Crowley95376d62015-05-06 15:04:43 +0100642 std::unique_ptr<DIR, int(*)(DIR*)> dirp(opendir(dir), closedir);
643 if (!dirp) {
644 SLOGE("Unable to read directory %s, error %s\n",
645 dir, strerror(errno));
646 return -1;
647 }
648 for (;;) {
649 struct dirent *result = readdir(dirp.get());
650 if (!result) {
651 // ext4enc:TODO check errno
652 break;
653 }
654 if (result->d_type != DT_DIR || !is_numeric(result->d_name)) {
655 continue; // skips user 0, which is a symlink
656 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800657 auto user_id = atoi(result->d_name);
Paul Crowley95376d62015-05-06 15:04:43 +0100658 auto user_dir = std::string() + dir + "/" + result->d_name;
659 // ext4enc:TODO don't hardcode /data
Jeff Sharkeyd2d7bff2015-12-18 17:18:22 -0700660 if (e4crypt_set_user_policy("/data", user_id, user_dir, false, false)) {
Paul Crowley95376d62015-05-06 15:04:43 +0100661 // ext4enc:TODO If this function fails, stop the boot: we must
662 // deliver on promised encryption.
663 SLOGE("Unable to set policy on %s\n", user_dir.c_str());
664 }
665 }
666 return 0;
667}
Paul Crowleyb33e8872015-05-19 12:34:09 +0100668
Paul Crowley27cbce92015-12-10 14:51:30 +0000669int e4crypt_vold_create_user_key(userid_t user_id, int serial, bool ephemeral) {
670 SLOGD("e4crypt_vold_create_user_key(%d)", user_id);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800671 // TODO: create second key for user_de data
Lenka Trochtova395039f2015-11-25 10:13:03 +0100672 if (e4crypt_get_key(
673 get_key_path(DATA_MNT_POINT, user_id), true, ephemeral).empty()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800674 return -1;
675 } else {
676 return 0;
677 }
678}
679
680int e4crypt_destroy_user_key(userid_t user_id) {
681 SLOGD("e4crypt_destroy_user_key(%d)", user_id);
682 // TODO: destroy second key for user_de data
683 auto key_path = get_key_path(DATA_MNT_POINT, user_id);
Lenka Trochtova395039f2015-11-25 10:13:03 +0100684 auto key = e4crypt_get_key(key_path, false, false);
Paul Crowley93363482015-07-07 15:17:22 +0100685 auto ext4_key = fill_key(key);
686 auto ref = keyname(generate_key_ref(ext4_key.raw, ext4_key.size));
687 auto key_serial = keyctl_search(e4crypt_keyring(), "logon", ref.c_str(), 0);
688 if (keyctl_revoke(key_serial) == 0) {
689 SLOGD("Revoked key with serial %ld ref %s\n", key_serial, ref.c_str());
690 } else {
691 SLOGE("Failed to revoke key with serial %ld ref %s: %s\n",
692 key_serial, ref.c_str(), strerror(errno));
693 }
Lenka Trochtova395039f2015-11-25 10:13:03 +0100694 if (e4crypt_is_key_ephemeral(key_path)) {
695 s_ephemeral_user_keys.erase(key_path);
696 return 0;
697 }
Paul Crowleycd307b72015-05-19 17:31:39 +0100698 int pid = fork();
699 if (pid < 0) {
700 SLOGE("Unable to fork: %s", strerror(errno));
Paul Crowleyb33e8872015-05-19 12:34:09 +0100701 return -1;
702 }
Paul Crowleycd307b72015-05-19 17:31:39 +0100703 if (pid == 0) {
704 SLOGD("Forked for secdiscard");
705 execl("/system/bin/secdiscard",
706 "/system/bin/secdiscard",
Paul Crowley5ab73e92015-07-03 16:17:23 +0100707 "--",
Paul Crowleycd307b72015-05-19 17:31:39 +0100708 key_path.c_str(),
709 NULL);
710 SLOGE("Unable to launch secdiscard on %s: %s\n", key_path.c_str(),
711 strerror(errno));
712 exit(-1);
713 }
714 // ext4enc:TODO reap the zombie
Paul Crowleyb33e8872015-05-19 12:34:09 +0100715 return 0;
716}
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800717
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700718static int emulated_lock(const std::string& path) {
719 if (chmod(path.c_str(), 0000) != 0) {
720 PLOG(ERROR) << "Failed to chmod " << path;
721 return -1;
722 }
723#if EMULATED_USES_SELINUX
724 if (setfilecon(path.c_str(), "u:object_r:storage_stub_file:s0") != 0) {
725 PLOG(WARNING) << "Failed to setfilecon " << path;
726 return -1;
727 }
728#endif
729 return 0;
730}
731
732static int emulated_unlock(const std::string& path, mode_t mode) {
733 if (chmod(path.c_str(), mode) != 0) {
734 PLOG(ERROR) << "Failed to chmod " << path;
735 return -1;
736 }
737#if EMULATED_USES_SELINUX
738 if (selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_FORCE) != 0) {
739 PLOG(WARNING) << "Failed to restorecon " << path;
740 return -1;
741 }
742#endif
743 return 0;
744}
745
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800746int e4crypt_unlock_user_key(userid_t user_id, const char* token) {
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700747 if (e4crypt_is_native()) {
Lenka Trochtova395039f2015-11-25 10:13:03 +0100748 auto user_key = e4crypt_get_key(get_key_path(DATA_MNT_POINT, user_id), false, false);
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800749 if (user_key.empty()) {
750 return -1;
751 }
752 auto raw_ref = e4crypt_install_key(user_key);
753 if (raw_ref.empty()) {
754 return -1;
755 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700756 } else {
757 // When in emulation mode, we just use chmod. However, we also
758 // unlock directories when not in emulation mode, to bring devices
759 // back into a known-good state.
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700760 if (emulated_unlock(android::vold::BuildDataSystemCePath(user_id), 0771) ||
761 emulated_unlock(android::vold::BuildDataMediaPath(nullptr, user_id), 0770) ||
762 emulated_unlock(android::vold::BuildDataUserPath(nullptr, user_id), 0771)) {
763 LOG(ERROR) << "Failed to unlock user " << user_id;
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700764 return -1;
765 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800766 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700767
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800768 return 0;
769}
770
771int e4crypt_lock_user_key(userid_t user_id) {
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700772 if (e4crypt_is_native()) {
773 // TODO: remove from kernel keyring
774 } else if (e4crypt_is_emulated()) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800775 // When in emulation mode, we just use chmod
Jeff Sharkey7a9dd952016-01-12 16:52:16 -0700776 if (emulated_lock(android::vold::BuildDataSystemCePath(user_id)) ||
777 emulated_lock(android::vold::BuildDataMediaPath(nullptr, user_id)) ||
778 emulated_lock(android::vold::BuildDataUserPath(nullptr, user_id))) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800779 PLOG(ERROR) << "Failed to lock user " << user_id;
780 return -1;
781 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800782 }
Jeff Sharkeyfc505c32015-12-07 17:27:01 -0700783
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800784 return 0;
785}
786
Lenka Trochtova9ad43692015-12-11 13:27:26 +0100787int e4crypt_prepare_user_storage(const char* volume_uuid,
788 userid_t user_id,
789 int serial,
790 bool ephemeral) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800791 std::string system_ce_path(android::vold::BuildDataSystemCePath(user_id));
Jeff Sharkeyd2d7bff2015-12-18 17:18:22 -0700792 std::string media_ce_path(android::vold::BuildDataMediaPath(volume_uuid, user_id));
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800793 std::string user_ce_path(android::vold::BuildDataUserPath(volume_uuid, user_id));
794 std::string user_de_path(android::vold::BuildDataUserDePath(volume_uuid, user_id));
795
796 if (fs_prepare_dir(system_ce_path.c_str(), 0700, AID_SYSTEM, AID_SYSTEM)) {
797 PLOG(ERROR) << "Failed to prepare " << system_ce_path;
798 return -1;
799 }
Jeff Sharkeyd2d7bff2015-12-18 17:18:22 -0700800 if (fs_prepare_dir(media_ce_path.c_str(), 0770, AID_MEDIA_RW, AID_MEDIA_RW)) {
801 PLOG(ERROR) << "Failed to prepare " << media_ce_path;
802 return -1;
803 }
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800804 if (fs_prepare_dir(user_ce_path.c_str(), 0771, AID_SYSTEM, AID_SYSTEM)) {
805 PLOG(ERROR) << "Failed to prepare " << user_ce_path;
806 return -1;
807 }
808 if (fs_prepare_dir(user_de_path.c_str(), 0771, AID_SYSTEM, AID_SYSTEM)) {
809 PLOG(ERROR) << "Failed to prepare " << user_de_path;
810 return -1;
811 }
812
813 if (e4crypt_crypto_complete(DATA_MNT_POINT) == 0) {
Jeff Sharkeyd2d7bff2015-12-18 17:18:22 -0700814 if (e4crypt_set_user_policy(DATA_MNT_POINT, user_id, system_ce_path, true, ephemeral)
815 || e4crypt_set_user_policy(DATA_MNT_POINT, user_id, media_ce_path, true, ephemeral)
816 || e4crypt_set_user_policy(DATA_MNT_POINT, user_id, user_ce_path, true,
817 ephemeral)) {
Jeff Sharkeyd2c96e72015-11-08 17:56:23 -0800818 return -1;
819 }
820 }
821
822 return 0;
823}