2 * libcryptsetup - cryptsetup library
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.
7 * Copyright (C) 2009-2012, Milan Broz
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 #include "libcryptsetup.h"
41 struct device *device;
42 struct device *metadata_device;
44 struct volume_key *volume_key;
46 uint64_t iteration_time;
51 // FIXME: private binary headers and access it properly
52 // through sub-library (LUKS1, TCRYPT)
55 struct { /* used in CRYPT_LUKS1 */
57 uint64_t PBKDF2_per_sec;
59 struct { /* used in CRYPT_PLAIN */
60 struct crypt_params_plain hdr;
63 unsigned int key_size;
65 struct { /* used in CRYPT_LOOPAES */
66 struct crypt_params_loopaes hdr;
69 unsigned int key_size;
71 struct { /* used in CRYPT_VERITY */
72 struct crypt_params_verity hdr;
74 unsigned int root_hash_size;
77 struct { /* used in CRYPT_TCRYPT */
78 struct crypt_params_tcrypt params;
79 struct tcrypt_phdr hdr;
83 /* callbacks definitions */
84 void (*log)(int level, const char *msg, void *usrptr);
86 int (*confirm)(const char *msg, void *usrptr);
88 int (*password)(const char *msg, char *buf, size_t length, void *usrptr);
89 void *password_usrptr;
91 /* last error message */
92 char error[MAX_ERROR_LENGTH];
96 /* FIXME: not thread safe, remove this later */
97 static char global_error[MAX_ERROR_LENGTH] = {0};
100 static void (*_default_log)(int level, const char *msg, void *usrptr) = NULL;
101 static int _debug_level = 0;
103 void crypt_set_debug_level(int level)
105 _debug_level = level;
108 int crypt_get_debug_level(void)
113 static void crypt_set_error(struct crypt_device *cd, const char *error)
115 size_t size = strlen(error);
117 /* Set global error, ugly hack... */
118 strncpy(global_error, error, MAX_ERROR_LENGTH - 2);
119 if (size < MAX_ERROR_LENGTH && global_error[size - 1] == '\n')
120 global_error[size - 1] = '\0';
122 /* Set error string per context */
124 strncpy(cd->error, error, MAX_ERROR_LENGTH - 2);
125 if (size < MAX_ERROR_LENGTH && cd->error[size - 1] == '\n')
126 cd->error[size - 1] = '\0';
130 void crypt_log(struct crypt_device *cd, int level, const char *msg)
133 cd->log(level, msg, cd->log_usrptr);
134 else if (_default_log)
135 _default_log(level, msg, NULL);
137 if (level == CRYPT_LOG_ERROR)
138 crypt_set_error(cd, msg);
141 __attribute__((format(printf, 5, 6)))
142 void logger(struct crypt_device *cd, int level, const char *file,
143 int line, const char *format, ...)
148 va_start(argp, format);
150 if (vasprintf(&target, format, argp) > 0 ) {
152 crypt_log(cd, level, target);
154 } else if (_debug_level)
155 printf("# %s:%d %s\n", file ?: "?", line, target);
157 } else if (_debug_level)
158 printf("# %s\n", target);
166 static const char *mdata_device_path(struct crypt_device *cd)
168 return device_path(cd->metadata_device ?: cd->device);
172 struct device *crypt_metadata_device(struct crypt_device *cd)
174 return cd->metadata_device ?: cd->device;
177 struct device *crypt_data_device(struct crypt_device *cd)
182 int init_crypto(struct crypt_device *ctx)
186 crypt_fips_libcryptsetup_check(ctx);
188 r = crypt_random_init(ctx);
190 log_err(ctx, _("Cannot initialize crypto RNG backend.\n"));
194 r = crypt_backend_init(ctx);
196 log_err(ctx, _("Cannot initialize crypto backend.\n"));
198 log_dbg("Crypto backend (%s) initialized.", crypt_backend_version());
202 static int process_key(struct crypt_device *cd, const char *hash_name,
203 size_t key_size, const char *pass, size_t passLen,
204 struct volume_key **vk)
211 *vk = crypt_alloc_volume_key(key_size, NULL);
216 r = crypt_plain_hash(cd, hash_name, (*vk)->key, key_size, pass, passLen);
219 log_err(cd, _("Hash algorithm %s not supported.\n"),
222 log_err(cd, _("Key processing error (using hash %s).\n"),
224 crypt_free_volume_key(*vk);
228 } else if (passLen > key_size) {
229 memcpy((*vk)->key, pass, key_size);
231 memcpy((*vk)->key, pass, passLen);
237 static int isPLAIN(const char *type)
239 return (type && !strcmp(CRYPT_PLAIN, type));
242 static int isLUKS(const char *type)
244 return (type && !strcmp(CRYPT_LUKS1, type));
247 static int isLOOPAES(const char *type)
249 return (type && !strcmp(CRYPT_LOOPAES, type));
252 static int isVERITY(const char *type)
254 return (type && !strcmp(CRYPT_VERITY, type));
257 static int isTCRYPT(const char *type)
259 return (type && !strcmp(CRYPT_TCRYPT, type));
262 /* keyslot helpers */
263 static int keyslot_verify_or_find_empty(struct crypt_device *cd, int *keyslot)
265 if (*keyslot == CRYPT_ANY_SLOT) {
266 *keyslot = LUKS_keyslot_find_empty(&cd->u.luks1.hdr);
268 log_err(cd, _("All key slots full.\n"));
273 switch (LUKS_keyslot_info(&cd->u.luks1.hdr, *keyslot)) {
274 case CRYPT_SLOT_INVALID:
275 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
276 *keyslot, LUKS_NUMKEYS - 1);
278 case CRYPT_SLOT_INACTIVE:
281 log_err(cd, _("Key slot %d is full, please select another one.\n"),
290 * compares UUIDs returned by device-mapper (striped by cryptsetup) and uuid in header
292 static int crypt_uuid_cmp(const char *dm_uuid, const char *hdr_uuid)
297 if (!dm_uuid || !hdr_uuid)
300 str = strchr(dm_uuid, '-');
304 for (i = 0, j = 1; hdr_uuid[i]; i++) {
305 if (hdr_uuid[i] == '-')
308 if (!str[j] || str[j] == '-')
311 if (str[j] != hdr_uuid[i])
319 int PLAIN_activate(struct crypt_device *cd,
321 struct volume_key *vk,
326 char *dm_cipher = NULL;
327 enum devcheck device_check;
328 struct crypt_dm_active_device dmd = {
332 .data_device = crypt_data_device(cd),
336 .offset = crypt_get_data_offset(cd),
337 .iv_offset = crypt_get_iv_offset(cd),
341 if (dmd.flags & CRYPT_ACTIVATE_SHARED)
342 device_check = DEV_SHARED;
344 device_check = DEV_EXCL;
346 r = device_block_adjust(cd, dmd.data_device, device_check,
347 dmd.u.crypt.offset, &dmd.size, &dmd.flags);
351 if (crypt_get_cipher_mode(cd))
352 r = asprintf(&dm_cipher, "%s-%s", crypt_get_cipher(cd), crypt_get_cipher_mode(cd));
354 r = asprintf(&dm_cipher, "%s", crypt_get_cipher(cd));
358 dmd.u.crypt.cipher = dm_cipher;
359 log_dbg("Trying to activate PLAIN device %s using cipher %s.",
360 name, dmd.u.crypt.cipher);
362 r = dm_create_device(cd, name, CRYPT_PLAIN, &dmd, 0);
368 int crypt_confirm(struct crypt_device *cd, const char *msg)
370 if (!cd || !cd->confirm)
373 return cd->confirm(msg, cd->confirm_usrptr);
376 static int key_from_terminal(struct crypt_device *cd, char *msg, char **key,
377 size_t *key_len, int force_verify)
379 char *prompt = NULL, *device_name;
384 if (crypt_loop_device(crypt_get_device_name(cd)))
385 device_name = crypt_loop_backing_file(crypt_get_device_name(cd));
387 device_name = strdup(crypt_get_device_name(cd));
390 r = asprintf(&prompt, _("Enter passphrase for %s: "), device_name);
398 *key = crypt_safe_alloc(DEFAULT_PASSPHRASE_SIZE_MAX);
403 r = cd->password(msg, *key, DEFAULT_PASSPHRASE_SIZE_MAX,
404 cd->password_usrptr);
406 crypt_safe_free(*key);
411 r = crypt_get_key(msg, key, key_len, 0, 0, NULL, cd->timeout,
412 (force_verify || cd->password_verify), cd);
415 return (r < 0) ? r: 0;
418 static int volume_key_by_terminal_passphrase(struct crypt_device *cd, int keyslot,
419 struct volume_key **vk)
421 char *passphrase_read = NULL;
422 size_t passphrase_size_read;
423 int r = -EINVAL, eperm = 0, tries = cd->tries;
427 crypt_free_volume_key(*vk);
430 r = key_from_terminal(cd, NULL, &passphrase_read,
431 &passphrase_size_read, 0);
432 /* Continue if it is just passphrase verify mismatch */
438 r = LUKS_open_key_with_hdr(keyslot, passphrase_read,
439 passphrase_size_read, &cd->u.luks1.hdr, vk, cd);
442 crypt_safe_free(passphrase_read);
443 passphrase_read = NULL;
444 } while (r == -EPERM && (--tries > 0));
447 crypt_free_volume_key(*vk);
450 /* Report wrong passphrase if at least one try failed */
451 if (eperm && r == -EPIPE)
455 crypt_safe_free(passphrase_read);
459 static int key_from_file(struct crypt_device *cd, char *msg,
460 char **key, size_t *key_len,
461 const char *key_file, size_t key_offset,
464 return crypt_get_key(msg, key, key_len, key_offset, key_size, key_file,
468 void crypt_set_log_callback(struct crypt_device *cd,
469 void (*log)(int level, const char *msg, void *usrptr),
476 cd->log_usrptr = usrptr;
480 void crypt_set_confirm_callback(struct crypt_device *cd,
481 int (*confirm)(const char *msg, void *usrptr),
484 cd->confirm = confirm;
485 cd->confirm_usrptr = usrptr;
488 void crypt_set_password_callback(struct crypt_device *cd,
489 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
492 cd->password = password;
493 cd->password_usrptr = usrptr;
496 static void _get_error(char *error, char *buf, size_t size)
498 if (!buf || size < 1)
501 strncpy(buf, error, size - 1);
502 buf[size - 1] = '\0';
508 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size)
511 return _get_error(cd->error, buf, size);
514 /* Deprecated global error interface */
515 void crypt_get_error(char *buf, size_t size)
517 return _get_error(global_error, buf, size);
520 const char *crypt_get_dir(void)
525 int crypt_init(struct crypt_device **cd, const char *device)
527 struct crypt_device *h = NULL;
533 log_dbg("Allocating crypt device %s context.", device);
535 if (!(h = malloc(sizeof(struct crypt_device))))
538 memset(h, 0, sizeof(*h));
540 r = device_alloc(&h->device, device);
546 h->iteration_time = 1000;
547 h->password_verify = 0;
549 h->rng_type = crypt_random_default_key_rng();
553 device_free(h->device);
558 static int crypt_check_data_device_size(struct crypt_device *cd)
561 uint64_t size, size_min;
563 /* Check data device size, require at least one sector */
564 size_min = crypt_get_data_offset(cd) << SECTOR_SHIFT ?: SECTOR_SIZE;
566 r = device_size(cd->device, &size);
570 if (size < size_min) {
571 log_err(cd, _("Header detected but device %s is too small.\n"),
572 device_path(cd->device));
579 int crypt_set_data_device(struct crypt_device *cd, const char *device)
581 struct device *dev = NULL;
584 log_dbg("Setting ciphertext data device to %s.", device ?: "(none)");
586 if (!isLUKS(cd->type) && !isVERITY(cd->type)) {
587 log_err(cd, _("This operation is not supported for this device type.\n"));
591 /* metadata device must be set */
592 if (!cd->device || !device)
595 r = device_alloc(&dev, device);
599 if (!cd->metadata_device) {
600 cd->metadata_device = cd->device;
602 device_free(cd->device);
606 return crypt_check_data_device_size(cd);
609 static int _crypt_load_luks1(struct crypt_device *cd, int require_header, int repair)
611 struct luks_phdr hdr;
618 r = LUKS_read_phdr(&hdr, require_header, repair, cd);
622 if (!cd->type && !(cd->type = strdup(CRYPT_LUKS1)))
625 memcpy(&cd->u.luks1.hdr, &hdr, sizeof(hdr));
630 static int _crypt_load_tcrypt(struct crypt_device *cd, struct crypt_params_tcrypt *params)
641 memcpy(&cd->u.tcrypt.params, params, sizeof(*params));
643 r = TCRYPT_read_phdr(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params);
645 cd->u.tcrypt.params.passphrase = NULL;
646 cd->u.tcrypt.params.passphrase_size = 0;
647 cd->u.tcrypt.params.keyfiles = NULL;
648 cd->u.tcrypt.params.keyfiles_count = 0;
653 if (!cd->type && !(cd->type = strdup(CRYPT_TCRYPT)))
659 static int _crypt_load_verity(struct crypt_device *cd, struct crypt_params_verity *params)
662 size_t sb_offset = 0;
668 if (params && params->flags & CRYPT_VERITY_NO_HEADER)
672 sb_offset = params->hash_area_offset;
674 r = VERITY_read_sb(cd, sb_offset, &cd->u.verity.uuid, &cd->u.verity.hdr);
679 cd->u.verity.hdr.flags = params->flags;
681 /* Hash availability checked in sb load */
682 cd->u.verity.root_hash_size = crypt_hash_size(cd->u.verity.hdr.hash_name);
683 if (cd->u.verity.root_hash_size > 4096)
686 if (!cd->type && !(cd->type = strdup(CRYPT_VERITY)))
689 if (params && params->data_device &&
690 (r = crypt_set_data_device(cd, params->data_device)) < 0)
696 static int _init_by_name_crypt(struct crypt_device *cd, const char *name)
698 struct crypt_dm_active_device dmd = {};
699 char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
702 r = dm_query_device(cd, name,
705 DM_ACTIVE_CRYPT_CIPHER |
706 DM_ACTIVE_CRYPT_KEYSIZE, &dmd);
710 if (isPLAIN(cd->type)) {
711 cd->u.plain.hdr.hash = NULL; /* no way to get this */
712 cd->u.plain.hdr.offset = dmd.u.crypt.offset;
713 cd->u.plain.hdr.skip = dmd.u.crypt.iv_offset;
714 cd->u.plain.key_size = dmd.u.crypt.vk->keylength;
716 r = crypt_parse_name_and_mode(dmd.u.crypt.cipher, cipher, NULL, cipher_mode);
718 cd->u.plain.cipher = strdup(cipher);
719 cd->u.plain.cipher_mode = strdup(cipher_mode);
721 } else if (isLOOPAES(cd->type)) {
722 cd->u.loopaes.hdr.offset = dmd.u.crypt.offset;
724 r = crypt_parse_name_and_mode(dmd.u.crypt.cipher, cipher,
725 &key_nums, cipher_mode);
727 cd->u.loopaes.cipher = strdup(cipher);
728 cd->u.loopaes.cipher_mode = strdup(cipher_mode);
729 /* version 3 uses last key for IV */
730 if (dmd.u.crypt.vk->keylength % key_nums)
732 cd->u.loopaes.key_size = dmd.u.crypt.vk->keylength / key_nums;
734 } else if (isLUKS(cd->type)) {
735 if (crypt_metadata_device(cd)) {
736 r = _crypt_load_luks1(cd, 0, 0);
738 log_dbg("LUKS device header does not match active device.");
744 /* check whether UUIDs match each other */
745 r = crypt_uuid_cmp(dmd.uuid, cd->u.luks1.hdr.uuid);
747 log_dbg("LUKS device header uuid: %s mismatches DM returned uuid %s",
748 cd->u.luks1.hdr.uuid, dmd.uuid);
754 log_dbg("LUKS device header not available.");
759 } else if (isTCRYPT(cd->type)) {
760 r = TCRYPT_init_by_name(cd, name, &dmd, &cd->device,
761 &cd->u.tcrypt.params, &cd->u.tcrypt.hdr);
764 crypt_free_volume_key(dmd.u.crypt.vk);
765 device_free(dmd.data_device);
766 free(CONST_CAST(void*)dmd.u.crypt.cipher);
767 free(CONST_CAST(void*)dmd.uuid);
771 static int _init_by_name_verity(struct crypt_device *cd, const char *name)
773 struct crypt_params_verity params = {};
774 struct crypt_dm_active_device dmd = {
776 .u.verity.vp = ¶ms,
780 r = dm_query_device(cd, name,
782 DM_ACTIVE_VERITY_HASH_DEVICE |
783 DM_ACTIVE_VERITY_PARAMS, &dmd);
787 if (isVERITY(cd->type)) {
788 cd->u.verity.uuid = NULL; // FIXME
789 cd->u.verity.hdr.flags = CRYPT_VERITY_NO_HEADER; //FIXME
790 cd->u.verity.hdr.data_size = params.data_size;
791 cd->u.verity.root_hash_size = dmd.u.verity.root_hash_size;
792 cd->u.verity.root_hash = NULL;
793 cd->u.verity.hdr.hash_name = params.hash_name;
794 cd->u.verity.hdr.data_device = NULL;
795 cd->u.verity.hdr.hash_device = NULL;
796 cd->u.verity.hdr.data_block_size = params.data_block_size;
797 cd->u.verity.hdr.hash_block_size = params.hash_block_size;
798 cd->u.verity.hdr.hash_area_offset = dmd.u.verity.hash_offset;
799 cd->u.verity.hdr.hash_type = params.hash_type;
800 cd->u.verity.hdr.flags = params.flags;
801 cd->u.verity.hdr.salt_size = params.salt_size;
802 cd->u.verity.hdr.salt = params.salt;
803 cd->metadata_device = dmd.u.verity.hash_device;
806 device_free(dmd.data_device);
810 int crypt_init_by_name_and_header(struct crypt_device **cd,
812 const char *header_device)
814 crypt_status_info ci;
815 struct crypt_dm_active_device dmd;
818 log_dbg("Allocating crypt device context by device %s.", name);
820 ci = crypt_status(NULL, name);
821 if (ci == CRYPT_INVALID)
824 if (ci < CRYPT_ACTIVE) {
825 log_err(NULL, _("Device %s is not active.\n"), name);
829 r = dm_query_device(NULL, name, DM_ACTIVE_DEVICE | DM_ACTIVE_UUID, &dmd);
836 r = crypt_init(cd, header_device);
838 r = crypt_init(cd, device_path(dmd.data_device));
840 /* Underlying device disappeared but mapping still active */
841 if (!dmd.data_device || r == -ENOTBLK)
842 log_verbose(NULL, _("Underlying device for crypt device %s disappeared.\n"),
845 /* Underlying device is not readable but crypt mapping exists */
847 device_free(dmd.data_device);
848 dmd.data_device = NULL;
849 r = crypt_init(cd, NULL);
857 if (!strncmp(CRYPT_PLAIN, dmd.uuid, sizeof(CRYPT_PLAIN)-1))
858 (*cd)->type = strdup(CRYPT_PLAIN);
859 else if (!strncmp(CRYPT_LOOPAES, dmd.uuid, sizeof(CRYPT_LOOPAES)-1))
860 (*cd)->type = strdup(CRYPT_LOOPAES);
861 else if (!strncmp(CRYPT_LUKS1, dmd.uuid, sizeof(CRYPT_LUKS1)-1))
862 (*cd)->type = strdup(CRYPT_LUKS1);
863 else if (!strncmp(CRYPT_VERITY, dmd.uuid, sizeof(CRYPT_VERITY)-1))
864 (*cd)->type = strdup(CRYPT_VERITY);
865 else if (!strncmp(CRYPT_TCRYPT, dmd.uuid, sizeof(CRYPT_TCRYPT)-1))
866 (*cd)->type = strdup(CRYPT_TCRYPT);
868 log_dbg("Unknown UUID set, some parameters are not set.");
870 log_dbg("Active device has no UUID set, some parameters are not set.");
873 r = crypt_set_data_device(*cd, device_path(dmd.data_device));
878 /* Try to initialise basic parameters from active device */
880 if (dmd.target == DM_CRYPT)
881 r = _init_by_name_crypt(*cd, name);
882 else if (dmd.target == DM_VERITY)
883 r = _init_by_name_verity(*cd, name);
889 device_free(dmd.data_device);
890 free(CONST_CAST(void*)dmd.uuid);
894 int crypt_init_by_name(struct crypt_device **cd, const char *name)
896 return crypt_init_by_name_and_header(cd, name, NULL);
899 static int _crypt_format_plain(struct crypt_device *cd,
901 const char *cipher_mode,
903 size_t volume_key_size,
904 struct crypt_params_plain *params)
906 if (!cipher || !cipher_mode) {
907 log_err(cd, _("Invalid plain crypt parameters.\n"));
911 if (volume_key_size > 1024) {
912 log_err(cd, _("Invalid key size.\n"));
917 log_err(cd, _("UUID is not supported for this crypt type.\n"));
921 if (!(cd->type = strdup(CRYPT_PLAIN)))
924 cd->u.plain.key_size = volume_key_size;
925 cd->volume_key = crypt_alloc_volume_key(volume_key_size, NULL);
929 cd->u.plain.cipher = strdup(cipher);
930 cd->u.plain.cipher_mode = strdup(cipher_mode);
933 if (params && params->hash)
934 cd->u.plain.hdr.hash = strdup(params->hash);
936 cd->u.plain.hdr.offset = params ? params->offset : 0;
937 cd->u.plain.hdr.skip = params ? params->skip : 0;
938 cd->u.plain.hdr.size = params ? params->size : 0;
940 if (!cd->u.plain.cipher || !cd->u.plain.cipher_mode)
946 static int _crypt_format_luks1(struct crypt_device *cd,
948 const char *cipher_mode,
950 const char *volume_key,
951 size_t volume_key_size,
952 struct crypt_params_luks1 *params)
955 unsigned long required_alignment = DEFAULT_DISK_ALIGNMENT;
956 unsigned long alignment_offset = 0;
958 if (!crypt_metadata_device(cd)) {
959 log_err(cd, _("Can't format LUKS without device.\n"));
963 if (!(cd->type = strdup(CRYPT_LUKS1)))
967 cd->volume_key = crypt_alloc_volume_key(volume_key_size,
970 cd->volume_key = crypt_generate_volume_key(cd, volume_key_size);
975 if (params && params->data_device) {
976 cd->metadata_device = cd->device;
978 if (device_alloc(&cd->device, params->data_device) < 0)
980 required_alignment = params->data_alignment * SECTOR_SIZE;
981 } else if (params && params->data_alignment) {
982 required_alignment = params->data_alignment * SECTOR_SIZE;
984 device_topology_alignment(cd->device,
986 &alignment_offset, DEFAULT_DISK_ALIGNMENT);
988 /* Check early if we cannot allocate block device for key slot access */
989 r = device_block_adjust(cd, cd->device, DEV_OK, 0, NULL, NULL);
993 r = LUKS_generate_phdr(&cd->u.luks1.hdr, cd->volume_key, cipher, cipher_mode,
994 (params && params->hash) ? params->hash : "sha1",
996 required_alignment / SECTOR_SIZE,
997 alignment_offset / SECTOR_SIZE,
998 cd->iteration_time, &cd->u.luks1.PBKDF2_per_sec,
999 cd->metadata_device ? 1 : 0, cd);
1003 /* Wipe first 8 sectors - fs magic numbers etc. */
1004 r = crypt_wipe(crypt_metadata_device(cd), 0, 8 * SECTOR_SIZE, CRYPT_WIPE_ZERO, 1);
1007 log_err(cd, _("Cannot format device %s which is still in use.\n"),
1008 mdata_device_path(cd));
1009 else if (r == -EACCES) {
1010 log_err(cd, _("Cannot format device %s, permission denied.\n"),
1011 mdata_device_path(cd));
1014 log_err(cd, _("Cannot wipe header on device %s.\n"),
1015 mdata_device_path(cd));
1020 r = LUKS_write_phdr(&cd->u.luks1.hdr, cd);
1025 static int _crypt_format_loopaes(struct crypt_device *cd,
1028 size_t volume_key_size,
1029 struct crypt_params_loopaes *params)
1031 if (!crypt_metadata_device(cd)) {
1032 log_err(cd, _("Can't format LOOPAES without device.\n"));
1036 if (volume_key_size > 1024) {
1037 log_err(cd, _("Invalid key size.\n"));
1042 log_err(cd, _("UUID is not supported for this crypt type.\n"));
1046 if (!(cd->type = strdup(CRYPT_LOOPAES)))
1049 cd->u.loopaes.key_size = volume_key_size;
1051 cd->u.loopaes.cipher = strdup(cipher ?: DEFAULT_LOOPAES_CIPHER);
1053 if (params && params->hash)
1054 cd->u.loopaes.hdr.hash = strdup(params->hash);
1056 cd->u.loopaes.hdr.offset = params ? params->offset : 0;
1057 cd->u.loopaes.hdr.skip = params ? params->skip : 0;
1062 static int _crypt_format_verity(struct crypt_device *cd,
1064 struct crypt_params_verity *params)
1066 int r = 0, hash_size;
1067 uint64_t data_device_size;
1069 if (!crypt_metadata_device(cd)) {
1070 log_err(cd, _("Can't format VERITY without device.\n"));
1074 if (!params || !params->data_device)
1077 if (params->hash_type > VERITY_MAX_HASH_TYPE) {
1078 log_err(cd, _("Unsupported VERITY hash type %d.\n"), params->hash_type);
1082 if (VERITY_BLOCK_SIZE_OK(params->data_block_size) ||
1083 VERITY_BLOCK_SIZE_OK(params->hash_block_size)) {
1084 log_err(cd, _("Unsupported VERITY block size.\n"));
1088 if (params->hash_area_offset % 512) {
1089 log_err(cd, _("Unsupported VERITY hash offset.\n"));
1093 if (!(cd->type = strdup(CRYPT_VERITY)))
1096 r = crypt_set_data_device(cd, params->data_device);
1099 if (!params->data_size) {
1100 r = device_size(cd->device, &data_device_size);
1104 cd->u.verity.hdr.data_size = data_device_size / params->data_block_size;
1106 cd->u.verity.hdr.data_size = params->data_size;
1108 hash_size = crypt_hash_size(params->hash_name);
1109 if (hash_size <= 0) {
1110 log_err(cd, _("Hash algorithm %s not supported.\n"),
1114 cd->u.verity.root_hash_size = hash_size;
1116 cd->u.verity.root_hash = malloc(cd->u.verity.root_hash_size);
1117 if (!cd->u.verity.root_hash)
1120 cd->u.verity.hdr.flags = params->flags;
1121 if (!(cd->u.verity.hdr.hash_name = strdup(params->hash_name)))
1123 cd->u.verity.hdr.data_device = NULL;
1124 cd->u.verity.hdr.data_block_size = params->data_block_size;
1125 cd->u.verity.hdr.hash_block_size = params->hash_block_size;
1126 cd->u.verity.hdr.hash_area_offset = params->hash_area_offset;
1127 cd->u.verity.hdr.hash_type = params->hash_type;
1128 cd->u.verity.hdr.flags = params->flags;
1129 cd->u.verity.hdr.salt_size = params->salt_size;
1130 if (!(cd->u.verity.hdr.salt = malloc(params->salt_size)))
1134 memcpy(CONST_CAST(char*)cd->u.verity.hdr.salt, params->salt,
1137 r = crypt_random_get(cd, CONST_CAST(char*)cd->u.verity.hdr.salt,
1138 params->salt_size, CRYPT_RND_SALT);
1142 if (params->flags & CRYPT_VERITY_CREATE_HASH) {
1143 r = VERITY_create(cd, &cd->u.verity.hdr,
1144 cd->u.verity.root_hash, cd->u.verity.root_hash_size);
1149 if (!(params->flags & CRYPT_VERITY_NO_HEADER)) {
1151 cd->u.verity.uuid = strdup(uuid);
1153 r = VERITY_UUID_generate(cd, &cd->u.verity.uuid);
1158 r = VERITY_write_sb(cd, cd->u.verity.hdr.hash_area_offset,
1165 int crypt_format(struct crypt_device *cd,
1168 const char *cipher_mode,
1170 const char *volume_key,
1171 size_t volume_key_size,
1180 log_dbg("Context already formatted as %s.", cd->type);
1184 log_dbg("Formatting device %s as type %s.", mdata_device_path(cd) ?: "(none)", type);
1186 r = init_crypto(cd);
1191 r = _crypt_format_plain(cd, cipher, cipher_mode,
1192 uuid, volume_key_size, params);
1193 else if (isLUKS(type))
1194 r = _crypt_format_luks1(cd, cipher, cipher_mode,
1195 uuid, volume_key, volume_key_size, params);
1196 else if (isLOOPAES(type))
1197 r = _crypt_format_loopaes(cd, cipher, uuid, volume_key_size, params);
1198 else if (isVERITY(type))
1199 r = _crypt_format_verity(cd, uuid, params);
1201 log_err(cd, _("Unknown crypt device type %s requested.\n"), type);
1208 crypt_free_volume_key(cd->volume_key);
1209 cd->volume_key = NULL;
1215 int crypt_load(struct crypt_device *cd,
1216 const char *requested_type,
1221 log_dbg("Trying to load %s crypt type from device %s.",
1222 requested_type ?: "any", mdata_device_path(cd) ?: "(none)");
1224 if (!crypt_metadata_device(cd))
1227 if (!requested_type || isLUKS(requested_type)) {
1228 if (cd->type && !isLUKS(cd->type)) {
1229 log_dbg("Context is already initialised to type %s", cd->type);
1233 r = _crypt_load_luks1(cd, 1, 0);
1234 } else if (isVERITY(requested_type)) {
1235 if (cd->type && !isVERITY(cd->type)) {
1236 log_dbg("Context is already initialised to type %s", cd->type);
1239 r = _crypt_load_verity(cd, params);
1240 } else if (isTCRYPT(requested_type)) {
1241 if (cd->type && !isTCRYPT(cd->type)) {
1242 log_dbg("Context is already initialised to type %s", cd->type);
1245 r = _crypt_load_tcrypt(cd, params);
1252 int crypt_repair(struct crypt_device *cd,
1253 const char *requested_type,
1254 void *params __attribute__((unused)))
1258 log_dbg("Trying to repair %s crypt type from device %s.",
1259 requested_type ?: "any", mdata_device_path(cd) ?: "(none)");
1261 if (!crypt_metadata_device(cd))
1264 if (requested_type && !isLUKS(requested_type))
1268 /* Load with repair */
1269 r = _crypt_load_luks1(cd, 1, 1);
1273 /* cd->type and header must be set in context */
1274 r = crypt_check_data_device_size(cd);
1283 int crypt_resize(struct crypt_device *cd, const char *name, uint64_t new_size)
1285 struct crypt_dm_active_device dmd;
1288 /* Device context type must be initialised */
1292 log_dbg("Resizing device %s to %" PRIu64 " sectors.", name, new_size);
1294 r = dm_query_device(cd, name, DM_ACTIVE_DEVICE | DM_ACTIVE_CRYPT_CIPHER |
1295 DM_ACTIVE_UUID | DM_ACTIVE_CRYPT_KEYSIZE |
1296 DM_ACTIVE_CRYPT_KEY, &dmd);
1298 log_err(NULL, _("Device %s is not active.\n"), name);
1302 if (!dmd.uuid || dmd.target != DM_CRYPT) {
1307 r = device_block_adjust(cd, dmd.data_device, DEV_OK,
1308 dmd.u.crypt.offset, &new_size, &dmd.flags);
1312 if (new_size == dmd.size) {
1313 log_dbg("Device has already requested size %" PRIu64
1314 " sectors.", dmd.size);
1317 dmd.size = new_size;
1318 if (isTCRYPT(cd->type))
1321 r = dm_create_device(cd, name, cd->type, &dmd, 1);
1324 if (dmd.target == DM_CRYPT) {
1325 crypt_free_volume_key(dmd.u.crypt.vk);
1326 free(CONST_CAST(void*)dmd.u.crypt.cipher);
1328 free(CONST_CAST(void*)dmd.data_device);
1329 free(CONST_CAST(void*)dmd.uuid);
1334 int crypt_set_uuid(struct crypt_device *cd, const char *uuid)
1336 if (!isLUKS(cd->type)) {
1337 log_err(cd, _("This operation is not supported for this device type.\n"));
1341 if (uuid && !strncmp(uuid, cd->u.luks1.hdr.uuid, sizeof(cd->u.luks1.hdr.uuid))) {
1342 log_dbg("UUID is the same as requested (%s) for device %s.",
1343 uuid, mdata_device_path(cd));
1348 log_dbg("Requested new UUID change to %s for %s.", uuid, mdata_device_path(cd));
1350 log_dbg("Requested new UUID refresh for %s.", mdata_device_path(cd));
1352 if (!crypt_confirm(cd, _("Do you really want to change UUID of device?")))
1355 return LUKS_hdr_uuid_set(&cd->u.luks1.hdr, uuid, cd);
1358 int crypt_header_backup(struct crypt_device *cd,
1359 const char *requested_type,
1360 const char *backup_file)
1364 if ((requested_type && !isLUKS(requested_type)) || !backup_file)
1367 r = init_crypto(cd);
1371 log_dbg("Requested header backup of device %s (%s) to "
1372 "file %s.", mdata_device_path(cd), requested_type, backup_file);
1374 return LUKS_hdr_backup(backup_file, &cd->u.luks1.hdr, cd);
1377 int crypt_header_restore(struct crypt_device *cd,
1378 const char *requested_type,
1379 const char *backup_file)
1383 if (requested_type && !isLUKS(requested_type))
1386 if (cd->type && !isLUKS(cd->type))
1389 r = init_crypto(cd);
1393 log_dbg("Requested header restore to device %s (%s) from "
1394 "file %s.", mdata_device_path(cd), requested_type, backup_file);
1396 return LUKS_hdr_restore(backup_file, &cd->u.luks1.hdr, cd);
1399 void crypt_free(struct crypt_device *cd)
1402 log_dbg("Releasing crypt device %s context.", mdata_device_path(cd));
1405 crypt_free_volume_key(cd->volume_key);
1407 device_free(cd->device);
1408 device_free(cd->metadata_device);
1410 if (isPLAIN(cd->type)) {
1411 free(CONST_CAST(void*)cd->u.plain.hdr.hash);
1412 free(cd->u.plain.cipher);
1413 free(cd->u.plain.cipher_mode);
1414 } else if (isLOOPAES(cd->type)) {
1415 free(CONST_CAST(void*)cd->u.loopaes.hdr.hash);
1416 free(cd->u.loopaes.cipher);
1417 } else if (isVERITY(cd->type)) {
1418 free(CONST_CAST(void*)cd->u.verity.hdr.hash_name);
1419 free(CONST_CAST(void*)cd->u.verity.hdr.salt);
1420 free(cd->u.verity.root_hash);
1421 free(cd->u.verity.uuid);
1425 /* Some structures can contain keys (TCRYPT), wipe it */
1426 memset(cd, 0, sizeof(*cd));
1431 int crypt_suspend(struct crypt_device *cd,
1434 crypt_status_info ci;
1437 log_dbg("Suspending volume %s.", name);
1439 if (!cd || !isLUKS(cd->type)) {
1440 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1445 ci = crypt_status(NULL, name);
1446 if (ci < CRYPT_ACTIVE) {
1447 log_err(cd, _("Volume %s is not active.\n"), name);
1453 r = dm_status_suspended(cd, name);
1458 log_err(cd, _("Volume %s is already suspended.\n"), name);
1463 r = dm_suspend_and_wipe_key(cd, name);
1465 log_err(cd, _("Suspend is not supported for device %s.\n"), name);
1467 log_err(cd, _("Error during suspending device %s.\n"), name);
1473 int crypt_resume_by_passphrase(struct crypt_device *cd,
1476 const char *passphrase,
1477 size_t passphrase_size)
1479 struct volume_key *vk = NULL;
1482 log_dbg("Resuming volume %s.", name);
1484 if (!isLUKS(cd->type)) {
1485 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1490 r = dm_status_suspended(cd, name);
1495 log_err(cd, _("Volume %s is not suspended.\n"), name);
1500 r = LUKS_open_key_with_hdr(keyslot, passphrase, passphrase_size,
1501 &cd->u.luks1.hdr, &vk, cd);
1503 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1507 r = dm_resume_and_reinstate_key(cd, name, vk->keylength, vk->key);
1509 log_err(cd, _("Resume is not supported for device %s.\n"), name);
1511 log_err(cd, _("Error during resuming device %s.\n"), name);
1515 crypt_free_volume_key(vk);
1516 return r < 0 ? r : keyslot;
1519 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
1522 const char *keyfile,
1523 size_t keyfile_size,
1524 size_t keyfile_offset)
1526 struct volume_key *vk = NULL;
1527 char *passphrase_read = NULL;
1528 size_t passphrase_size_read;
1531 log_dbg("Resuming volume %s.", name);
1533 if (!isLUKS(cd->type)) {
1534 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1539 r = dm_status_suspended(cd, name);
1544 log_err(cd, _("Volume %s is not suspended.\n"), name);
1551 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1552 &passphrase_size_read, keyfile, keyfile_offset,
1557 r = LUKS_open_key_with_hdr(keyslot, passphrase_read,
1558 passphrase_size_read, &cd->u.luks1.hdr, &vk, cd);
1563 r = dm_resume_and_reinstate_key(cd, name, vk->keylength, vk->key);
1565 log_err(cd, _("Error during resuming device %s.\n"), name);
1567 crypt_safe_free(passphrase_read);
1568 crypt_free_volume_key(vk);
1569 return r < 0 ? r : keyslot;
1572 int crypt_resume_by_keyfile(struct crypt_device *cd,
1575 const char *keyfile,
1576 size_t keyfile_size)
1578 return crypt_resume_by_keyfile_offset(cd, name, keyslot,
1579 keyfile, keyfile_size, 0);
1582 // slot manipulation
1583 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
1584 int keyslot, // -1 any
1585 const char *passphrase, // NULL -> terminal
1586 size_t passphrase_size,
1587 const char *new_passphrase, // NULL -> terminal
1588 size_t new_passphrase_size)
1590 struct volume_key *vk = NULL;
1591 char *password = NULL, *new_password = NULL;
1592 size_t passwordLen, new_passwordLen;
1595 log_dbg("Adding new keyslot, existing passphrase %sprovided,"
1596 "new passphrase %sprovided.",
1597 passphrase ? "" : "not ", new_passphrase ? "" : "not ");
1599 if (!isLUKS(cd->type)) {
1600 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1604 r = keyslot_verify_or_find_empty(cd, &keyslot);
1608 if (!LUKS_keyslot_active_count(&cd->u.luks1.hdr)) {
1609 /* No slots used, try to use pre-generated key in header */
1610 if (cd->volume_key) {
1611 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1612 r = vk ? 0 : -ENOMEM;
1614 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1617 } else if (passphrase) {
1618 /* Passphrase provided, use it to unlock existing keyslot */
1619 r = LUKS_open_key_with_hdr(CRYPT_ANY_SLOT, passphrase,
1620 passphrase_size, &cd->u.luks1.hdr, &vk, cd);
1622 /* Passphrase not provided, ask first and use it to unlock existing keyslot */
1623 r = key_from_terminal(cd, _("Enter any passphrase: "),
1624 &password, &passwordLen, 0);
1628 r = LUKS_open_key_with_hdr(CRYPT_ANY_SLOT, password,
1629 passwordLen, &cd->u.luks1.hdr, &vk, cd);
1630 crypt_safe_free(password);
1636 if (new_passphrase) {
1637 new_password = CONST_CAST(char*)new_passphrase;
1638 new_passwordLen = new_passphrase_size;
1640 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1641 &new_password, &new_passwordLen, 1);
1646 r = LUKS_set_key(keyslot, new_password, new_passwordLen,
1647 &cd->u.luks1.hdr, vk, cd->iteration_time, &cd->u.luks1.PBKDF2_per_sec, cd);
1652 if (!new_passphrase)
1653 crypt_safe_free(new_password);
1654 crypt_free_volume_key(vk);
1655 return r ?: keyslot;
1658 int crypt_keyslot_change_by_passphrase(struct crypt_device *cd,
1661 const char *passphrase,
1662 size_t passphrase_size,
1663 const char *new_passphrase,
1664 size_t new_passphrase_size)
1666 struct volume_key *vk = NULL;
1669 log_dbg("Changing passphrase from old keyslot %d to new %d.",
1670 keyslot_old, keyslot_new);
1672 if (!isLUKS(cd->type)) {
1673 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1677 r = LUKS_open_key_with_hdr(keyslot_old, passphrase, passphrase_size,
1678 &cd->u.luks1.hdr, &vk, cd);
1682 if (keyslot_old != CRYPT_ANY_SLOT && keyslot_old != r) {
1683 log_dbg("Keyslot mismatch.");
1688 if (keyslot_new == CRYPT_ANY_SLOT) {
1689 keyslot_new = LUKS_keyslot_find_empty(&cd->u.luks1.hdr);
1690 if (keyslot_new < 0)
1691 keyslot_new = keyslot_old;
1694 if (keyslot_old == keyslot_new) {
1695 log_dbg("Key slot %d is going to be overwritten.", keyslot_old);
1696 (void)crypt_keyslot_destroy(cd, keyslot_old);
1699 r = LUKS_set_key(keyslot_new, new_passphrase, new_passphrase_size,
1700 &cd->u.luks1.hdr, vk, cd->iteration_time,
1701 &cd->u.luks1.PBKDF2_per_sec, cd);
1703 if (keyslot_old == keyslot_new) {
1705 log_verbose(cd, _("Key slot %d changed.\n"), r);
1708 log_verbose(cd, _("Replaced with key slot %d.\n"), r);
1709 r = crypt_keyslot_destroy(cd, keyslot_old);
1713 log_err(cd, _("Failed to swap new key slot.\n"));
1715 crypt_free_volume_key(vk);
1716 return r ?: keyslot_new;
1719 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
1721 const char *keyfile,
1722 size_t keyfile_size,
1723 size_t keyfile_offset,
1724 const char *new_keyfile,
1725 size_t new_keyfile_size,
1726 size_t new_keyfile_offset)
1728 struct volume_key *vk = NULL;
1729 char *password = NULL; size_t passwordLen;
1730 char *new_password = NULL; size_t new_passwordLen;
1733 log_dbg("Adding new keyslot, existing keyfile %s, new keyfile %s.",
1734 keyfile ?: "[none]", new_keyfile ?: "[none]");
1736 if (!isLUKS(cd->type)) {
1737 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1741 r = keyslot_verify_or_find_empty(cd, &keyslot);
1745 if (!LUKS_keyslot_active_count(&cd->u.luks1.hdr)) {
1746 /* No slots used, try to use pre-generated key in header */
1747 if (cd->volume_key) {
1748 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1749 r = vk ? 0 : -ENOMEM;
1751 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1755 /* Read password from file of (if NULL) from terminal */
1757 r = key_from_file(cd, _("Enter any passphrase: "),
1758 &password, &passwordLen,
1759 keyfile, keyfile_offset, keyfile_size);
1761 r = key_from_terminal(cd, _("Enter any passphrase: "),
1762 &password, &passwordLen, 0);
1766 r = LUKS_open_key_with_hdr(CRYPT_ANY_SLOT, password, passwordLen,
1767 &cd->u.luks1.hdr, &vk, cd);
1774 r = key_from_file(cd, _("Enter new passphrase for key slot: "),
1775 &new_password, &new_passwordLen, new_keyfile,
1776 new_keyfile_offset, new_keyfile_size);
1778 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1779 &new_password, &new_passwordLen, 1);
1783 r = LUKS_set_key(keyslot, new_password, new_passwordLen,
1784 &cd->u.luks1.hdr, vk, cd->iteration_time, &cd->u.luks1.PBKDF2_per_sec, cd);
1786 crypt_safe_free(password);
1787 crypt_safe_free(new_password);
1788 crypt_free_volume_key(vk);
1789 return r < 0 ? r : keyslot;
1792 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
1794 const char *keyfile,
1795 size_t keyfile_size,
1796 const char *new_keyfile,
1797 size_t new_keyfile_size)
1799 return crypt_keyslot_add_by_keyfile_offset(cd, keyslot,
1800 keyfile, keyfile_size, 0,
1801 new_keyfile, new_keyfile_size, 0);
1804 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
1806 const char *volume_key,
1807 size_t volume_key_size,
1808 const char *passphrase,
1809 size_t passphrase_size)
1811 struct volume_key *vk = NULL;
1813 char *new_password = NULL; size_t new_passwordLen;
1815 log_dbg("Adding new keyslot %d using volume key.", keyslot);
1817 if (!isLUKS(cd->type)) {
1818 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1823 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1824 else if (cd->volume_key)
1825 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1830 r = LUKS_verify_volume_key(&cd->u.luks1.hdr, vk);
1832 log_err(cd, _("Volume key does not match the volume.\n"));
1836 r = keyslot_verify_or_find_empty(cd, &keyslot);
1841 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1842 &new_password, &new_passwordLen, 1);
1845 passphrase = new_password;
1846 passphrase_size = new_passwordLen;
1849 r = LUKS_set_key(keyslot, passphrase, passphrase_size,
1850 &cd->u.luks1.hdr, vk, cd->iteration_time, &cd->u.luks1.PBKDF2_per_sec, cd);
1852 crypt_safe_free(new_password);
1853 crypt_free_volume_key(vk);
1854 return (r < 0) ? r : keyslot;
1857 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot)
1859 crypt_keyslot_info ki;
1861 log_dbg("Destroying keyslot %d.", keyslot);
1863 if (!isLUKS(cd->type)) {
1864 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1868 ki = crypt_keyslot_status(cd, keyslot);
1869 if (ki == CRYPT_SLOT_INVALID) {
1870 log_err(cd, _("Key slot %d is invalid.\n"), keyslot);
1874 if (ki == CRYPT_SLOT_INACTIVE) {
1875 log_err(cd, _("Key slot %d is not used.\n"), keyslot);
1879 return LUKS_del_key(keyslot, &cd->u.luks1.hdr, cd);
1882 // activation/deactivation of device mapping
1883 int crypt_activate_by_passphrase(struct crypt_device *cd,
1886 const char *passphrase,
1887 size_t passphrase_size,
1890 crypt_status_info ci;
1891 struct volume_key *vk = NULL;
1892 char *read_passphrase = NULL;
1893 size_t passphraseLen = 0;
1896 log_dbg("%s volume %s [keyslot %d] using %spassphrase.",
1897 name ? "Activating" : "Checking", name ?: "",
1898 keyslot, passphrase ? "" : "[none] ");
1901 ci = crypt_status(NULL, name);
1902 if (ci == CRYPT_INVALID)
1904 else if (ci >= CRYPT_ACTIVE) {
1905 log_err(cd, _("Device %s already exists.\n"), name);
1910 /* plain, use hashed passphrase */
1911 if (isPLAIN(cd->type)) {
1916 r = key_from_terminal(cd, NULL, &read_passphrase,
1920 passphrase = read_passphrase;
1921 passphrase_size = passphraseLen;
1924 r = process_key(cd, cd->u.plain.hdr.hash,
1925 cd->u.plain.key_size,
1926 passphrase, passphrase_size, &vk);
1930 r = PLAIN_activate(cd, name, vk, cd->u.plain.hdr.size, flags);
1932 } else if (isLUKS(cd->type)) {
1933 /* provided passphrase, do not retry */
1935 r = LUKS_open_key_with_hdr(keyslot, passphrase,
1936 passphrase_size, &cd->u.luks1.hdr, &vk, cd);
1938 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1943 r = LUKS1_activate(cd, name, vk, flags);
1948 crypt_safe_free(read_passphrase);
1949 crypt_free_volume_key(vk);
1951 return r < 0 ? r : keyslot;
1954 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
1957 const char *keyfile,
1958 size_t keyfile_size,
1959 size_t keyfile_offset,
1962 crypt_status_info ci;
1963 struct volume_key *vk = NULL;
1964 char *passphrase_read = NULL;
1965 size_t passphrase_size_read;
1966 unsigned int key_count = 0;
1969 log_dbg("Activating volume %s [keyslot %d] using keyfile %s.",
1970 name ?: "", keyslot, keyfile ?: "[none]");
1973 ci = crypt_status(NULL, name);
1974 if (ci == CRYPT_INVALID)
1976 else if (ci >= CRYPT_ACTIVE) {
1977 log_err(cd, _("Device %s already exists.\n"), name);
1985 if (isPLAIN(cd->type)) {
1989 r = key_from_file(cd, _("Enter passphrase: "),
1990 &passphrase_read, &passphrase_size_read,
1991 keyfile, keyfile_offset, keyfile_size);
1995 r = process_key(cd, cd->u.plain.hdr.hash,
1996 cd->u.plain.key_size,
1997 passphrase_read, passphrase_size_read, &vk);
2001 r = PLAIN_activate(cd, name, vk, cd->u.plain.hdr.size, flags);
2002 } else if (isLUKS(cd->type)) {
2003 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
2004 &passphrase_size_read, keyfile, keyfile_offset, keyfile_size);
2007 r = LUKS_open_key_with_hdr(keyslot, passphrase_read,
2008 passphrase_size_read, &cd->u.luks1.hdr, &vk, cd);
2014 r = LUKS1_activate(cd, name, vk, flags);
2019 } else if (isLOOPAES(cd->type)) {
2020 r = key_from_file(cd, NULL, &passphrase_read, &passphrase_size_read,
2021 keyfile, keyfile_offset, keyfile_size);
2024 r = LOOPAES_parse_keyfile(cd, &vk, cd->u.loopaes.hdr.hash, &key_count,
2025 passphrase_read, passphrase_size_read);
2029 r = LOOPAES_activate(cd, name, cd->u.loopaes.cipher,
2030 key_count, vk, flags);
2035 crypt_safe_free(passphrase_read);
2036 crypt_free_volume_key(vk);
2041 int crypt_activate_by_keyfile(struct crypt_device *cd,
2044 const char *keyfile,
2045 size_t keyfile_size,
2048 return crypt_activate_by_keyfile_offset(cd, name, keyslot, keyfile,
2049 keyfile_size, 0, flags);
2052 int crypt_activate_by_volume_key(struct crypt_device *cd,
2054 const char *volume_key,
2055 size_t volume_key_size,
2058 crypt_status_info ci;
2059 struct volume_key *vk = NULL;
2062 log_dbg("Activating volume %s by volume key.", name ?: "[none]");
2065 ci = crypt_status(NULL, name);
2066 if (ci == CRYPT_INVALID)
2068 else if (ci >= CRYPT_ACTIVE) {
2069 log_err(cd, _("Device %s already exists.\n"), name);
2074 /* use key directly, no hash */
2075 if (isPLAIN(cd->type)) {
2079 if (!volume_key || !volume_key_size || volume_key_size != cd->u.plain.key_size) {
2080 log_err(cd, _("Incorrect volume key specified for plain device.\n"));
2084 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
2088 r = PLAIN_activate(cd, name, vk, cd->u.plain.hdr.size, flags);
2089 } else if (isLUKS(cd->type)) {
2090 /* If key is not provided, try to use internal key */
2092 if (!cd->volume_key) {
2093 log_err(cd, _("Volume key does not match the volume.\n"));
2096 volume_key_size = cd->volume_key->keylength;
2097 volume_key = cd->volume_key->key;
2100 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
2103 r = LUKS_verify_volume_key(&cd->u.luks1.hdr, vk);
2106 log_err(cd, _("Volume key does not match the volume.\n"));
2109 r = LUKS1_activate(cd, name, vk, flags);
2110 } else if (isVERITY(cd->type)) {
2111 /* volume_key == root hash */
2112 if (!volume_key || !volume_key_size) {
2113 log_err(cd, _("Incorrect root hash specified for verity device.\n"));
2117 r = VERITY_activate(cd, name, volume_key, volume_key_size,
2118 &cd->u.verity.hdr, CRYPT_ACTIVATE_READONLY);
2121 free(cd->u.verity.root_hash);
2122 cd->u.verity.root_hash = NULL;
2124 cd->u.verity.root_hash_size = volume_key_size;
2125 if (!cd->u.verity.root_hash)
2126 cd->u.verity.root_hash = malloc(volume_key_size);
2127 if (cd->u.verity.root_hash)
2128 memcpy(cd->u.verity.root_hash, volume_key, volume_key_size);
2130 } else if (isTCRYPT(cd->type)) {
2133 r = TCRYPT_activate(cd, name, &cd->u.tcrypt.hdr,
2134 &cd->u.tcrypt.params, flags);
2136 log_err(cd, _("Device type is not properly initialised.\n"));
2138 crypt_free_volume_key(vk);
2143 int crypt_deactivate(struct crypt_device *cd, const char *name)
2145 struct crypt_device *fake_cd = NULL;
2151 log_dbg("Deactivating volume %s.", name);
2154 r = crypt_init_by_name(&fake_cd, name);
2160 switch (crypt_status(cd, name)) {
2163 if (isTCRYPT(cd->type))
2164 r = TCRYPT_deactivate(cd, name);
2166 r = dm_remove_device(cd, name, 0, 0);
2167 if (r < 0 && crypt_status(cd, name) == CRYPT_BUSY) {
2168 log_err(cd, _("Device %s is still in use.\n"), name);
2172 case CRYPT_INACTIVE:
2173 log_err(cd, _("Device %s is not active.\n"), name);
2177 log_err(cd, _("Invalid device %s.\n"), name);
2181 crypt_free(fake_cd);
2186 int crypt_volume_key_get(struct crypt_device *cd,
2189 size_t *volume_key_size,
2190 const char *passphrase,
2191 size_t passphrase_size)
2193 struct volume_key *vk = NULL;
2197 if (crypt_fips_mode()) {
2198 log_err(cd, _("Function not available in FIPS mode.\n"));
2202 key_len = crypt_get_volume_key_size(cd);
2203 if (key_len > *volume_key_size) {
2204 log_err(cd, _("Volume key buffer too small.\n"));
2208 if (isPLAIN(cd->type) && cd->u.plain.hdr.hash) {
2209 r = process_key(cd, cd->u.plain.hdr.hash, key_len,
2210 passphrase, passphrase_size, &vk);
2212 log_err(cd, _("Cannot retrieve volume key for plain device.\n"));
2213 } else if (isLUKS(cd->type)) {
2214 r = LUKS_open_key_with_hdr(keyslot, passphrase,
2215 passphrase_size, &cd->u.luks1.hdr, &vk, cd);
2216 } else if (isTCRYPT(cd->type)) {
2217 r = TCRYPT_get_volume_key(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params, &vk);
2219 log_err(cd, _("This operation is not supported for %s crypt device.\n"), cd->type ?: "(none)");
2222 memcpy(volume_key, vk->key, vk->keylength);
2223 *volume_key_size = vk->keylength;
2226 crypt_free_volume_key(vk);
2230 int crypt_volume_key_verify(struct crypt_device *cd,
2231 const char *volume_key,
2232 size_t volume_key_size)
2234 struct volume_key *vk;
2237 if (!isLUKS(cd->type)) {
2238 log_err(cd, _("This operation is supported only for LUKS device.\n"));
2242 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
2246 r = LUKS_verify_volume_key(&cd->u.luks1.hdr, vk);
2249 log_err(cd, _("Volume key does not match the volume.\n"));
2251 crypt_free_volume_key(vk);
2256 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec)
2258 log_dbg("Timeout set to %" PRIu64 " miliseconds.", timeout_sec);
2259 cd->timeout = timeout_sec;
2262 void crypt_set_password_retry(struct crypt_device *cd, int tries)
2264 log_dbg("Password retry count set to %d.", tries);
2268 void crypt_set_iteration_time(struct crypt_device *cd, uint64_t iteration_time_ms)
2270 log_dbg("Iteration time set to %" PRIu64 " miliseconds.", iteration_time_ms);
2271 cd->iteration_time = iteration_time_ms;
2273 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms)
2275 crypt_set_iteration_time(cd, iteration_time_ms);
2278 void crypt_set_password_verify(struct crypt_device *cd, int password_verify)
2280 log_dbg("Password verification %s.", password_verify ? "enabled" : "disabled");
2281 cd->password_verify = password_verify ? 1 : 0;
2284 void crypt_set_rng_type(struct crypt_device *cd, int rng_type)
2287 case CRYPT_RNG_URANDOM:
2288 case CRYPT_RNG_RANDOM:
2289 log_dbg("RNG set to %d (%s).", rng_type, rng_type ? "random" : "urandom");
2290 cd->rng_type = rng_type;
2294 int crypt_get_rng_type(struct crypt_device *cd)
2299 return cd->rng_type;
2302 int crypt_memory_lock(struct crypt_device *cd, int lock)
2304 return lock ? crypt_memlock_inc(cd) : crypt_memlock_dec(cd);
2308 crypt_status_info crypt_status(struct crypt_device *cd, const char *name)
2315 r = dm_status_device(cd, name);
2320 if (r < 0 && r != -ENODEV)
2321 return CRYPT_INVALID;
2324 return CRYPT_ACTIVE;
2329 return CRYPT_INACTIVE;
2332 static void hexprint(struct crypt_device *cd, const char *d, int n, const char *sep)
2335 for(i = 0; i < n; i++)
2336 log_std(cd, "%02hhx%s", (const char)d[i], sep);
2339 static int _luks_dump(struct crypt_device *cd)
2343 log_std(cd, "LUKS header information for %s\n\n", mdata_device_path(cd));
2344 log_std(cd, "Version: \t%d\n", cd->u.luks1.hdr.version);
2345 log_std(cd, "Cipher name: \t%s\n", cd->u.luks1.hdr.cipherName);
2346 log_std(cd, "Cipher mode: \t%s\n", cd->u.luks1.hdr.cipherMode);
2347 log_std(cd, "Hash spec: \t%s\n", cd->u.luks1.hdr.hashSpec);
2348 log_std(cd, "Payload offset:\t%d\n", cd->u.luks1.hdr.payloadOffset);
2349 log_std(cd, "MK bits: \t%d\n", cd->u.luks1.hdr.keyBytes * 8);
2350 log_std(cd, "MK digest: \t");
2351 hexprint(cd, cd->u.luks1.hdr.mkDigest, LUKS_DIGESTSIZE, " ");
2353 log_std(cd, "MK salt: \t");
2354 hexprint(cd, cd->u.luks1.hdr.mkDigestSalt, LUKS_SALTSIZE/2, " ");
2355 log_std(cd, "\n \t");
2356 hexprint(cd, cd->u.luks1.hdr.mkDigestSalt+LUKS_SALTSIZE/2, LUKS_SALTSIZE/2, " ");
2358 log_std(cd, "MK iterations: \t%d\n", cd->u.luks1.hdr.mkDigestIterations);
2359 log_std(cd, "UUID: \t%s\n\n", cd->u.luks1.hdr.uuid);
2360 for(i = 0; i < LUKS_NUMKEYS; i++) {
2361 if(cd->u.luks1.hdr.keyblock[i].active == LUKS_KEY_ENABLED) {
2362 log_std(cd, "Key Slot %d: ENABLED\n",i);
2363 log_std(cd, "\tIterations: \t%d\n",
2364 cd->u.luks1.hdr.keyblock[i].passwordIterations);
2365 log_std(cd, "\tSalt: \t");
2366 hexprint(cd, cd->u.luks1.hdr.keyblock[i].passwordSalt,
2367 LUKS_SALTSIZE/2, " ");
2368 log_std(cd, "\n\t \t");
2369 hexprint(cd, cd->u.luks1.hdr.keyblock[i].passwordSalt +
2370 LUKS_SALTSIZE/2, LUKS_SALTSIZE/2, " ");
2373 log_std(cd, "\tKey material offset:\t%d\n",
2374 cd->u.luks1.hdr.keyblock[i].keyMaterialOffset);
2375 log_std(cd, "\tAF stripes: \t%d\n",
2376 cd->u.luks1.hdr.keyblock[i].stripes);
2379 log_std(cd, "Key Slot %d: DISABLED\n", i);
2384 static int _verity_dump(struct crypt_device *cd)
2386 log_std(cd, "VERITY header information for %s\n", mdata_device_path(cd));
2387 log_std(cd, "UUID: \t%s\n", cd->u.verity.uuid ?: "");
2388 log_std(cd, "Hash type: \t%u\n", cd->u.verity.hdr.hash_type);
2389 log_std(cd, "Data blocks: \t%" PRIu64 "\n", cd->u.verity.hdr.data_size);
2390 log_std(cd, "Data block size: \t%u\n", cd->u.verity.hdr.data_block_size);
2391 log_std(cd, "Hash block size: \t%u\n", cd->u.verity.hdr.hash_block_size);
2392 log_std(cd, "Hash algorithm: \t%s\n", cd->u.verity.hdr.hash_name);
2393 log_std(cd, "Salt: \t");
2394 if (cd->u.verity.hdr.salt_size)
2395 hexprint(cd, cd->u.verity.hdr.salt, cd->u.verity.hdr.salt_size, "");
2399 if (cd->u.verity.root_hash) {
2400 log_std(cd, "Root hash: \t");
2401 hexprint(cd, cd->u.verity.root_hash, cd->u.verity.root_hash_size, "");
2407 int crypt_dump(struct crypt_device *cd)
2409 if (isLUKS(cd->type))
2410 return _luks_dump(cd);
2411 else if (isVERITY(cd->type))
2412 return _verity_dump(cd);
2413 else if (isTCRYPT(cd->type))
2414 return TCRYPT_dump(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params);
2416 log_err(cd, _("Dump operation is not supported for this device type.\n"));
2420 const char *crypt_get_cipher(struct crypt_device *cd)
2422 if (isPLAIN(cd->type))
2423 return cd->u.plain.cipher;
2425 if (isLUKS(cd->type))
2426 return cd->u.luks1.hdr.cipherName;
2428 if (isLOOPAES(cd->type))
2429 return cd->u.loopaes.cipher;
2431 if (isTCRYPT(cd->type))
2432 return cd->u.tcrypt.params.cipher;
2437 const char *crypt_get_cipher_mode(struct crypt_device *cd)
2439 if (isPLAIN(cd->type))
2440 return cd->u.plain.cipher_mode;
2442 if (isLUKS(cd->type))
2443 return cd->u.luks1.hdr.cipherMode;
2445 if (isLOOPAES(cd->type))
2446 return cd->u.loopaes.cipher_mode;
2448 if (isTCRYPT(cd->type))
2449 return cd->u.tcrypt.params.mode;
2454 const char *crypt_get_uuid(struct crypt_device *cd)
2456 if (isLUKS(cd->type))
2457 return cd->u.luks1.hdr.uuid;
2459 if (isVERITY(cd->type))
2460 return cd->u.verity.uuid;
2465 const char *crypt_get_device_name(struct crypt_device *cd)
2467 const char *path = device_block_path(cd->device);
2470 path = device_path(cd->device);
2475 int crypt_get_volume_key_size(struct crypt_device *cd)
2477 if (isPLAIN(cd->type))
2478 return cd->u.plain.key_size;
2480 if (isLUKS(cd->type))
2481 return cd->u.luks1.hdr.keyBytes;
2483 if (isLOOPAES(cd->type))
2484 return cd->u.loopaes.key_size;
2486 if (isVERITY(cd->type))
2487 return cd->u.verity.root_hash_size;
2489 if (isTCRYPT(cd->type))
2490 return cd->u.tcrypt.params.key_size;
2495 uint64_t crypt_get_data_offset(struct crypt_device *cd)
2497 if (isPLAIN(cd->type))
2498 return cd->u.plain.hdr.offset;
2500 if (isLUKS(cd->type))
2501 return cd->u.luks1.hdr.payloadOffset;
2503 if (isLOOPAES(cd->type))
2504 return cd->u.loopaes.hdr.offset;
2506 if (isTCRYPT(cd->type))
2507 return TCRYPT_get_data_offset(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params);
2512 uint64_t crypt_get_iv_offset(struct crypt_device *cd)
2514 if (isPLAIN(cd->type))
2515 return cd->u.plain.hdr.skip;
2517 if (isLUKS(cd->type))
2520 if (isLOOPAES(cd->type))
2521 return cd->u.loopaes.hdr.skip;
2523 if (isTCRYPT(cd->type))
2524 return TCRYPT_get_iv_offset(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params);
2529 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot)
2531 if (!isLUKS(cd->type)) {
2532 log_err(cd, _("This operation is supported only for LUKS device.\n"));
2533 return CRYPT_SLOT_INVALID;
2536 return LUKS_keyslot_info(&cd->u.luks1.hdr, keyslot);
2539 int crypt_keyslot_max(const char *type)
2541 if (type && isLUKS(type))
2542 return LUKS_NUMKEYS;
2547 int crypt_keyslot_area(struct crypt_device *cd,
2552 if (!isLUKS(cd->type))
2555 return LUKS_keyslot_area(&cd->u.luks1.hdr, keyslot, offset, length);
2558 const char *crypt_get_type(struct crypt_device *cd)
2563 int crypt_get_verity_info(struct crypt_device *cd,
2564 struct crypt_params_verity *vp)
2566 if (!isVERITY(cd->type) || !vp)
2569 vp->data_device = device_path(cd->device);
2570 vp->hash_device = mdata_device_path(cd);
2571 vp->hash_name = cd->u.verity.hdr.hash_name;
2572 vp->salt = cd->u.verity.hdr.salt;
2573 vp->salt_size = cd->u.verity.hdr.salt_size;
2574 vp->data_block_size = cd->u.verity.hdr.data_block_size;
2575 vp->hash_block_size = cd->u.verity.hdr.hash_block_size;
2576 vp->data_size = cd->u.verity.hdr.data_size;
2577 vp->hash_area_offset = cd->u.verity.hdr.hash_area_offset;
2578 vp->hash_type = cd->u.verity.hdr.hash_type;
2579 vp->flags = cd->u.verity.hdr.flags & CRYPT_VERITY_NO_HEADER;
2583 int crypt_get_active_device(struct crypt_device *cd, const char *name,
2584 struct crypt_active_device *cad)
2586 struct crypt_dm_active_device dmd;
2589 r = dm_query_device(cd, name, 0, &dmd);
2593 if (dmd.target != DM_CRYPT && dmd.target != DM_VERITY)
2596 if (cd && isTCRYPT(cd->type)) {
2597 cad->offset = TCRYPT_get_data_offset(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params);
2598 cad->iv_offset = TCRYPT_get_iv_offset(cd, &cd->u.tcrypt.hdr, &cd->u.tcrypt.params);
2600 cad->offset = dmd.u.crypt.offset;
2601 cad->iv_offset = dmd.u.crypt.iv_offset;
2603 cad->size = dmd.size;
2604 cad->flags = dmd.flags;