2 * libdevmapper - device-mapper backend for cryptsetup
4 * Copyright (C) 2004, Christophe Saout <christophe@saout.de>
5 * Copyright (C) 2004-2007, Clemens Fruhwirth <clemens@endorphin.org>
6 * Copyright (C) 2009-2012, Red Hat, Inc. All rights reserved.
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <libdevmapper.h>
28 #include <uuid/uuid.h>
32 #define DM_UUID_LEN 129
33 #define DM_UUID_PREFIX "CRYPT-"
34 #define DM_UUID_PREFIX_LEN 6
35 #define DM_CRYPT_TARGET "crypt"
36 #define DM_VERITY_TARGET "verity"
39 /* Set if dm-crypt version was probed */
40 static int _dm_crypt_checked = 0;
41 static uint32_t _dm_crypt_flags = 0;
43 static int _dm_use_count = 0;
44 static struct crypt_device *_context = NULL;
46 /* Check if we have DM flag to instruct kernel to force wipe buffers */
47 #if !HAVE_DECL_DM_TASK_SECURE_DATA
48 static int dm_task_secure_data(struct dm_task *dmt) { return 1; }
51 /* Compatibility for old device-mapper without udev support */
52 #if HAVE_DECL_DM_UDEV_DISABLE_DISK_RULES_FLAG
53 #define CRYPT_TEMP_UDEV_FLAGS DM_UDEV_DISABLE_SUBSYSTEM_RULES_FLAG | \
54 DM_UDEV_DISABLE_DISK_RULES_FLAG | \
55 DM_UDEV_DISABLE_OTHER_RULES_FLAG
56 #define _dm_task_set_cookie dm_task_set_cookie
57 #define _dm_udev_wait dm_udev_wait
59 #define CRYPT_TEMP_UDEV_FLAGS 0
60 static int _dm_task_set_cookie(struct dm_task *dmt, uint32_t *cookie, uint16_t flags) { return 0; }
61 static int _dm_udev_wait(uint32_t cookie) { return 0; };
64 static int _dm_use_udev(void)
66 #ifdef USE_UDEV /* cannot be enabled if devmapper is too old */
67 return dm_udev_get_sync_support();
73 __attribute__((format(printf, 4, 5)))
74 static void set_dm_error(int level,
75 const char *file __attribute__((unused)),
76 int line __attribute__((unused)),
83 if (vasprintf(&msg, f, va) > 0) {
85 log_err(_context, msg);
86 log_err(_context, "\n");
94 static int _dm_simple(int task, const char *name, int udev_wait);
96 static void _dm_set_crypt_compat(const char *dm_version, unsigned crypt_maj,
97 unsigned crypt_min, unsigned crypt_patch)
99 unsigned dm_maj, dm_min, dm_patch;
101 if (sscanf(dm_version, "%u.%u.%u", &dm_maj, &dm_min, &dm_patch) != 3)
102 dm_maj = dm_min = dm_patch = 0;
104 log_dbg("Detected dm-crypt version %i.%i.%i, dm-ioctl version %u.%u.%u.",
105 crypt_maj, crypt_min, crypt_patch, dm_maj, dm_min, dm_patch);
107 if (crypt_maj >= 1 && crypt_min >= 2)
108 _dm_crypt_flags |= DM_KEY_WIPE_SUPPORTED;
110 log_dbg("Suspend and resume disabled, no wipe key support.");
112 if (crypt_maj >= 1 && crypt_min >= 10)
113 _dm_crypt_flags |= DM_LMK_SUPPORTED;
115 if (dm_maj >= 4 && dm_min >= 20)
116 _dm_crypt_flags |= DM_SECURE_SUPPORTED;
118 /* not perfect, 2.6.33 supports with 1.7.0 */
119 if (crypt_maj >= 1 && crypt_min >= 8)
120 _dm_crypt_flags |= DM_PLAIN64_SUPPORTED;
122 if (crypt_maj >= 1 && crypt_min >= 11)
123 _dm_crypt_flags |= DM_DISCARDS_SUPPORTED;
125 /* Repeat test if dm-crypt is not present */
127 _dm_crypt_checked = 1;
130 static void _dm_set_verity_compat(const char *dm_version, unsigned verity_maj,
131 unsigned verity_min, unsigned verity_patch)
134 _dm_crypt_flags |= DM_VERITY_SUPPORTED;
136 log_dbg("Detected dm-verity version %i.%i.%i.",
137 verity_maj, verity_min, verity_patch);
140 static int _dm_check_versions(void)
143 struct dm_versions *target, *last_target;
146 if (_dm_crypt_checked)
149 /* FIXME: add support to DM so it forces crypt target module load here */
150 if (!(dmt = dm_task_create(DM_DEVICE_LIST_VERSIONS)))
153 if (!dm_task_run(dmt)) {
154 dm_task_destroy(dmt);
158 if (!dm_task_get_driver_version(dmt, dm_version, sizeof(dm_version))) {
159 dm_task_destroy(dmt);
163 target = dm_task_get_versions(dmt);
165 last_target = target;
166 if (!strcmp(DM_CRYPT_TARGET, target->name)) {
167 _dm_set_crypt_compat(dm_version,
168 (unsigned)target->version[0],
169 (unsigned)target->version[1],
170 (unsigned)target->version[2]);
171 } else if (!strcmp(DM_VERITY_TARGET, target->name)) {
172 _dm_set_verity_compat(dm_version,
173 (unsigned)target->version[0],
174 (unsigned)target->version[1],
175 (unsigned)target->version[2]);
177 target = (struct dm_versions *)((char *) target + target->next);
178 } while (last_target != target);
180 dm_task_destroy(dmt);
184 uint32_t dm_flags(void)
186 if (!_dm_crypt_checked)
187 _dm_check_versions();
189 return _dm_crypt_flags;
192 int dm_init(struct crypt_device *context, int check_kernel)
194 if (!_dm_use_count++) {
195 log_dbg("Initialising device-mapper backend%s, UDEV is %sabled.",
196 check_kernel ? "" : " (NO kernel check requested)",
197 _dm_use_udev() ? "en" : "dis");
198 if (check_kernel && !_dm_check_versions()) {
199 log_err(context, _("Cannot initialize device-mapper. Is dm_mod kernel module loaded?\n"));
202 if (getuid() || geteuid())
203 log_dbg(("WARNING: Running as a non-root user. Functionality may be unavailable."));
204 dm_log_init(set_dm_error);
205 dm_log_init_verbose(10);
208 // FIXME: global context is not safe
212 return 1; /* unsafe memory */
217 if (_dm_use_count && (!--_dm_use_count)) {
218 log_dbg("Releasing device-mapper backend.");
219 dm_log_init_verbose(0);
226 /* Return path to DM device */
227 char *dm_device_path(const char *prefix, int major, int minor)
233 if (!(dmt = dm_task_create(DM_DEVICE_STATUS)))
235 if (!dm_task_set_minor(dmt, minor) ||
236 !dm_task_set_major(dmt, major) ||
238 !(name = dm_task_get_name(dmt))) {
239 dm_task_destroy(dmt);
243 if (snprintf(path, sizeof(path), "%s%s", prefix ?: "", name) < 0)
246 dm_task_destroy(dmt);
251 static void hex_key(char *hexkey, size_t key_size, const char *key)
255 for(i = 0; i < key_size; i++)
256 sprintf(&hexkey[i * 2], "%02x", (unsigned char)key[i]);
259 static char *get_dm_crypt_params(struct crypt_dm_active_device *dmd)
261 int r, max_size, null_cipher = 0;
262 char *params, *hexkey;
263 const char *features = "";
265 if (dmd->flags & CRYPT_ACTIVATE_ALLOW_DISCARDS) {
266 if (dm_flags() & DM_DISCARDS_SUPPORTED) {
267 features = " 1 allow_discards";
268 log_dbg("Discard/TRIM is allowed.");
270 log_dbg("Discard/TRIM is not supported by the kernel.");
273 if (!strncmp(dmd->u.crypt.cipher, "cipher_null-", 12))
276 hexkey = crypt_safe_alloc(null_cipher ? 2 : (dmd->u.crypt.vk->keylength * 2 + 1));
281 strncpy(hexkey, "-", 2);
283 hex_key(hexkey, dmd->u.crypt.vk->keylength, dmd->u.crypt.vk->key);
285 max_size = strlen(hexkey) + strlen(dmd->u.crypt.cipher) +
286 strlen(dmd->u.crypt.device) + strlen(features) + 64;
287 params = crypt_safe_alloc(max_size);
291 r = snprintf(params, max_size, "%s %s %" PRIu64 " %s %" PRIu64 "%s",
292 dmd->u.crypt.cipher, hexkey, dmd->u.crypt.iv_offset,
293 dmd->u.crypt.device, dmd->u.crypt.offset, features);
294 if (r < 0 || r >= max_size) {
295 crypt_safe_free(params);
299 crypt_safe_free(hexkey);
302 static char *get_dm_verity_params(struct crypt_params_verity *vp,
303 struct crypt_dm_active_device *dmd)
306 char *params = NULL, *hexroot = NULL, *hexsalt = NULL;
308 hexroot = crypt_safe_alloc(dmd->u.verity.root_hash_size * 2 + 1);
311 hex_key(hexroot, dmd->u.verity.root_hash_size, dmd->u.verity.root_hash);
313 hexsalt = crypt_safe_alloc(vp->salt_size * 2 + 1);
316 hex_key(hexsalt, vp->salt_size, vp->salt);
318 max_size = strlen(hexroot) + strlen(hexsalt) +
319 strlen(dmd->u.verity.data_device) +
320 strlen(dmd->u.verity.hash_device) +
321 strlen(vp->hash_name) + 128;
323 params = crypt_safe_alloc(max_size);
327 r = snprintf(params, max_size,
328 "%u %s %s %u %u %" PRIu64 " %" PRIu64 " %s %s %s",
329 vp->version, dmd->u.verity.data_device,
330 dmd->u.verity.hash_device,
331 vp->data_block_size, vp->hash_block_size,
332 vp->data_size, dmd->u.verity.hash_offset,
333 vp->hash_name, hexroot, hexsalt);
334 if (r < 0 || r >= max_size) {
335 crypt_safe_free(params);
338 log_dbg("TABLE: %s", params);
340 crypt_safe_free(hexroot);
341 crypt_safe_free(hexsalt);
347 static int _dm_simple(int task, const char *name, int udev_wait)
356 if (!(dmt = dm_task_create(task)))
359 if (name && !dm_task_set_name(dmt, name))
362 #if HAVE_DECL_DM_TASK_RETRY_REMOVE
363 /* Used only in DM_DEVICE_REMOVE */
364 if (name && !dm_task_retry_remove(dmt))
367 if (udev_wait && !_dm_task_set_cookie(dmt, &cookie, 0))
370 r = dm_task_run(dmt);
373 (void)_dm_udev_wait(cookie);
376 dm_task_destroy(dmt);
380 static int _error_device(const char *name, size_t size)
385 if (!(dmt = dm_task_create(DM_DEVICE_RELOAD)))
388 if (!dm_task_set_name(dmt, name))
391 if (!dm_task_add_target(dmt, UINT64_C(0), size, "error", ""))
394 if (!dm_task_set_ro(dmt))
397 if (!dm_task_no_open_count(dmt))
400 if (!dm_task_run(dmt))
403 if (!_dm_simple(DM_DEVICE_RESUME, name, 1)) {
404 _dm_simple(DM_DEVICE_CLEAR, name, 0);
411 dm_task_destroy(dmt);
415 int dm_remove_device(const char *name, int force, uint64_t size)
418 int retries = force ? RETRY_COUNT : 1;
419 int error_target = 0;
421 if (!name || (force && !size))
425 r = _dm_simple(DM_DEVICE_REMOVE, name, 1) ? 0 : -EINVAL;
426 if (--retries && r) {
427 log_dbg("WARNING: other process locked internal device %s, %s.",
428 name, retries ? "retrying remove" : "giving up");
429 if (force && (crypt_get_debug_level() == CRYPT_LOG_DEBUG))
430 debug_processes_using_device(name);
432 if (force && !error_target) {
433 /* If force flag is set, replace device with error, read-only target.
434 * it should stop processes from reading it and also removed underlying
435 * device from mapping, so it is usable again.
436 * Force flag should be used only for temporary devices, which are
437 * intended to work inside cryptsetup only!
438 * Anyway, if some process try to read temporary cryptsetup device,
439 * it is bug - no other process should try touch it (e.g. udev).
441 _error_device(name, size);
445 } while (r == -EINVAL && retries);
447 dm_task_update_nodes();
452 #define UUID_LEN 37 /* 36 + \0, libuuid ... */
454 * UUID has format: CRYPT-<devicetype>-[<uuid>-]<device name>
456 * CRYPT-LUKS1-00000000000000000000000000000000-name
459 static void dm_prepare_uuid(const char *name, const char *type, const char *uuid, char *buf, size_t buflen)
461 char *ptr, uuid2[UUID_LEN] = {0};
465 /* Remove '-' chars */
466 if (uuid && !uuid_parse(uuid, uu)) {
467 for (ptr = uuid2, i = 0; i < UUID_LEN; i++)
468 if (uuid[i] != '-') {
474 i = snprintf(buf, buflen, DM_UUID_PREFIX "%s%s%s%s%s",
475 type ?: "", type ? "-" : "",
476 uuid2[0] ? uuid2 : "", uuid2[0] ? "-" : "",
479 log_dbg("DM-UUID is %s", buf);
481 log_err(NULL, _("DM-UUID for device %s was truncated.\n"), name);
484 static int _dm_create_device(const char *name, const char *type,
485 const char *device, uint32_t flags,
486 const char *uuid, uint64_t size,
487 char *params, int reload)
489 struct dm_task *dmt = NULL;
491 char dev_uuid[DM_UUID_LEN] = {0};
493 uint32_t read_ahead = 0;
495 uint16_t udev_flags = 0;
497 if (flags & CRYPT_ACTIVATE_PRIVATE)
498 udev_flags = CRYPT_TEMP_UDEV_FLAGS;
500 /* All devices must have DM_UUID, only resize on old device is exception */
502 if (!(dmt = dm_task_create(DM_DEVICE_RELOAD)))
505 if (!dm_task_set_name(dmt, name))
508 dm_prepare_uuid(name, type, uuid, dev_uuid, sizeof(dev_uuid));
510 if (!(dmt = dm_task_create(DM_DEVICE_CREATE)))
513 if (!dm_task_set_name(dmt, name))
516 if (!dm_task_set_uuid(dmt, dev_uuid))
519 if (_dm_use_udev() && !_dm_task_set_cookie(dmt, &cookie, udev_flags))
523 if ((dm_flags() & DM_SECURE_SUPPORTED) && !dm_task_secure_data(dmt))
525 if ((flags & CRYPT_ACTIVATE_READONLY) && !dm_task_set_ro(dmt))
528 if (!dm_task_add_target(dmt, 0, size,
529 !strcmp("VERITY", type) ? DM_VERITY_TARGET : DM_CRYPT_TARGET, params))
532 #ifdef DM_READ_AHEAD_MINIMUM_FLAG
533 if (device_read_ahead(device, &read_ahead) &&
534 !dm_task_set_read_ahead(dmt, read_ahead, DM_READ_AHEAD_MINIMUM_FLAG))
538 if (!dm_task_run(dmt))
542 dm_task_destroy(dmt);
543 if (!(dmt = dm_task_create(DM_DEVICE_RESUME)))
545 if (!dm_task_set_name(dmt, name))
547 if (uuid && !dm_task_set_uuid(dmt, dev_uuid))
549 if (_dm_use_udev() && !_dm_task_set_cookie(dmt, &cookie, udev_flags))
551 if (!dm_task_run(dmt))
555 if (!dm_task_get_info(dmt, &dmi))
560 if (_dm_use_udev()) {
561 (void)_dm_udev_wait(cookie);
565 if (r < 0 && !reload)
566 dm_remove_device(name, 0, 0);
569 if (cookie && _dm_use_udev())
570 (void)_dm_udev_wait(cookie);
573 crypt_safe_free(params);
575 dm_task_destroy(dmt);
577 dm_task_update_nodes();
581 int dm_create_device(const char *name,
583 struct crypt_dm_active_device *dmd,
587 char *table_params = NULL;
589 if (dmd->target == DM_CRYPT)
590 table_params = get_dm_crypt_params(dmd);
591 else if (dmd->target == DM_VERITY)
592 table_params = get_dm_verity_params(params, dmd);
597 return _dm_create_device(name, type, dmd->u.crypt.device, dmd->flags,
598 dmd->uuid, dmd->size, table_params, reload);
601 static int dm_status_dmi(const char *name, struct dm_info *dmi,
602 const char *target, char **status_line)
605 uint64_t start, length;
606 char *target_type, *params = NULL;
610 if (!(dmt = dm_task_create(DM_DEVICE_STATUS)))
613 if (!dm_task_set_name(dmt, name))
616 if (!dm_task_run(dmt))
619 if (!dm_task_get_info(dmt, dmi))
627 next = dm_get_next_target(dmt, next, &start, &length,
628 &target_type, ¶ms);
629 if (!target_type || strcmp(target_type, target) != 0 ||
635 if (!r && status_line && !(*status_line = strdup(params)))
639 dm_task_destroy(dmt);
644 int dm_status_device(const char *name)
649 r = dm_status_dmi(name, &dmi, DM_CRYPT_TARGET, NULL);
653 return (dmi.open_count > 0);
656 int dm_status_suspended(const char *name)
661 r = dm_status_dmi(name, &dmi, DM_CRYPT_TARGET, NULL);
665 return dmi.suspended ? 1 : 0;
668 int dm_status_verity_ok(const char *name)
672 char *status_line = NULL;
674 r = dm_status_dmi(name, &dmi, DM_VERITY_TARGET, &status_line);
675 if (r < 0 || !status_line) {
680 log_dbg("Verity volume %s status is %s.", name, status_line ?: "");
681 r = status_line[0] == 'V' ? 1 : 0;
687 static int _dm_query_crypt(uint32_t get_flags,
690 struct crypt_dm_active_device *dmd)
693 char *rcipher, *key_, *rdevice, *endp, buffer[3], *arg;
696 dmd->target = DM_CRYPT;
698 rcipher = strsep(¶ms, " ");
700 if (get_flags & DM_ACTIVE_CIPHER)
701 dmd->u.crypt.cipher = strdup(rcipher);
704 key_ = strsep(¶ms, " ");
707 val64 = strtoull(params, ¶ms, 10);
712 dmd->u.crypt.iv_offset = val64;
715 rdevice = strsep(¶ms, " ");
716 if (get_flags & DM_ACTIVE_DEVICE)
717 dmd->u.crypt.device = crypt_lookup_dev(rdevice);
722 val64 = strtoull(params, ¶ms, 10);
723 dmd->u.crypt.offset = val64;
725 /* Features section, available since crypt target version 1.11 */
731 /* Number of arguments */
732 val64 = strtoull(params, ¶ms, 10);
737 for (i = 0; i < val64; i++) {
740 arg = strsep(¶ms, " ");
741 if (!strcasecmp(arg, "allow_discards"))
742 dmd->flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS;
743 else /* unknown option */
747 /* All parameters shold be processed */
752 /* Never allow to return empty key */
753 if ((get_flags & DM_ACTIVE_KEY) && dmi->suspended) {
754 log_dbg("Cannot read volume key while suspended.");
758 if (get_flags & DM_ACTIVE_KEYSIZE) {
759 dmd->u.crypt.vk = crypt_alloc_volume_key(strlen(key_) / 2, NULL);
760 if (!dmd->u.crypt.vk)
763 if (get_flags & DM_ACTIVE_KEY) {
765 for(i = 0; i < dmd->u.crypt.vk->keylength; i++) {
766 memcpy(buffer, &key_[i * 2], 2);
767 dmd->u.crypt.vk->key[i] = strtoul(buffer, &endp, 16);
768 if (endp != &buffer[2]) {
769 crypt_free_volume_key(dmd->u.crypt.vk);
770 dmd->u.crypt.vk = NULL;
776 memset(key_, 0, strlen(key_));
781 static int _dm_query_verity(uint32_t get_flags,
784 struct crypt_dm_active_device *dmd)
786 dmd->target = DM_VERITY;
790 int dm_query_device(const char *name, uint32_t get_flags,
791 struct crypt_dm_active_device *dmd)
795 uint64_t start, length;
796 char *target_type, *params;
797 const char *tmp_uuid;
801 memset(dmd, 0, sizeof(*dmd));
803 if (!(dmt = dm_task_create(DM_DEVICE_TABLE)))
805 if ((dm_flags() & DM_SECURE_SUPPORTED) && !dm_task_secure_data(dmt))
807 if (!dm_task_set_name(dmt, name))
810 if (!dm_task_run(dmt))
814 if (!dm_task_get_info(dmt, &dmi))
822 next = dm_get_next_target(dmt, next, &start, &length,
823 &target_type, ¶ms);
825 if (!target_type || start != 0 || next)
828 if (!strcmp(target_type, DM_CRYPT_TARGET))
829 r = _dm_query_crypt(get_flags, &dmi, params, dmd);
830 else if (!strcmp(target_type, DM_VERITY_TARGET))
831 r = _dm_query_verity(get_flags, &dmi, params, dmd);
841 dmd->flags |= CRYPT_ACTIVATE_READONLY;
843 tmp_uuid = dm_task_get_uuid(dmt);
845 dmd->flags |= CRYPT_ACTIVATE_NO_UUID;
846 else if (get_flags & DM_ACTIVE_UUID) {
847 if (!strncmp(tmp_uuid, DM_UUID_PREFIX, DM_UUID_PREFIX_LEN))
848 dmd->uuid = strdup(tmp_uuid + DM_UUID_PREFIX_LEN);
851 r = (dmi.open_count > 0);
854 dm_task_destroy(dmt);
859 static int _dm_message(const char *name, const char *msg)
864 if (!(dmt = dm_task_create(DM_DEVICE_TARGET_MSG)))
867 if ((dm_flags() & DM_SECURE_SUPPORTED) && !dm_task_secure_data(dmt))
870 if (name && !dm_task_set_name(dmt, name))
873 if (!dm_task_set_sector(dmt, (uint64_t) 0))
876 if (!dm_task_set_message(dmt, msg))
879 r = dm_task_run(dmt);
882 dm_task_destroy(dmt);
886 int dm_suspend_and_wipe_key(const char *name)
888 if (!_dm_check_versions())
891 if (!(_dm_crypt_flags & DM_KEY_WIPE_SUPPORTED))
894 if (!_dm_simple(DM_DEVICE_SUSPEND, name, 0))
897 if (!_dm_message(name, "key wipe")) {
898 _dm_simple(DM_DEVICE_RESUME, name, 1);
905 int dm_resume_and_reinstate_key(const char *name,
909 int msg_size = key_size * 2 + 10; // key set <key>
913 if (!_dm_check_versions())
916 if (!(_dm_crypt_flags & DM_KEY_WIPE_SUPPORTED))
919 msg = crypt_safe_alloc(msg_size);
923 memset(msg, 0, msg_size);
924 strcpy(msg, "key set ");
925 hex_key(&msg[8], key_size, key);
927 if (!_dm_message(name, msg) ||
928 !_dm_simple(DM_DEVICE_RESUME, name, 1))
931 crypt_safe_free(msg);
935 const char *dm_get_dir(void)
940 int dm_is_dm_device(int major, int minor)
942 return dm_is_dm_major((uint32_t)major);
945 int dm_is_dm_kernel_name(const char *name)
947 return strncmp(name, "dm-", 3) ? 0 : 1;
950 int dm_check_segment(const char *name, uint64_t offset, uint64_t size)
952 struct crypt_dm_active_device dmd;
955 log_dbg("Checking segments for device %s.", name);
957 r = dm_query_device(name, 0, &dmd);
961 if (offset >= (dmd.u.crypt.offset + dmd.size) ||
962 (offset + size) <= dmd.u.crypt.offset)
967 log_dbg("seg: %" PRIu64 " - %" PRIu64 ", new %" PRIu64 " - %" PRIu64 "%s",
968 dmd.u.crypt.offset, dmd.u.crypt.offset + dmd.size, offset, offset + size,
969 r ? " (overlapping)" : " (ok)");