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-2011, 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include "libcryptsetup.h"
33 #include "crypto_backend.h"
41 struct volume_key *volume_key;
43 uint64_t iteration_time;
48 /* used in CRYPT_LUKS1 */
50 uint64_t PBKDF2_per_sec;
52 /* used in CRYPT_PLAIN */
53 struct crypt_params_plain plain_hdr;
55 char *plain_cipher_mode;
58 /* used in CRYPT_LOOPAES */
59 struct crypt_params_loopaes loopaes_hdr;
61 char *loopaes_cipher_mode;
63 unsigned int loopaes_key_size;
65 /* callbacks definitions */
66 void (*log)(int level, const char *msg, void *usrptr);
68 int (*confirm)(const char *msg, void *usrptr);
70 int (*password)(const char *msg, char *buf, size_t length, void *usrptr);
71 void *password_usrptr;
75 static void (*_default_log)(int level, const char *msg, void *usrptr) = NULL;
76 static int _debug_level = 0;
78 void crypt_set_debug_level(int level)
83 int crypt_get_debug_level(void)
88 void crypt_log(struct crypt_device *cd, int level, const char *msg)
91 cd->log(level, msg, cd->log_usrptr);
92 else if (_default_log)
93 _default_log(level, msg, NULL);
96 __attribute__((format(printf, 5, 6)))
97 void logger(struct crypt_device *cd, int level, const char *file,
98 int line, const char *format, ...)
103 va_start(argp, format);
105 if (vasprintf(&target, format, argp) > 0) {
107 crypt_log(cd, level, target);
109 } else if (_debug_level)
110 printf("# %s:%d %s\n", file ?: "?", line, target);
112 } else if (_debug_level)
113 printf("# %s\n", target);
121 static int init_crypto(struct crypt_device *ctx)
125 r = crypt_random_init(ctx);
127 log_err(ctx, _("Cannot initialize crypto RNG backend.\n"));
131 r = crypt_backend_init(ctx);
133 log_err(ctx, _("Cannot initialize crypto backend.\n"));
139 * Password processing behaviour matrix of process_key
141 * from binary file: check if there is sufficently large key material
142 * interactive & from fd: hash if requested, otherwise crop or pad with '0'
144 static char *process_key(struct crypt_device *cd, const char *hash_name,
145 const char *key_file, size_t key_size,
146 const char *pass, size_t passLen)
154 key = crypt_safe_alloc(key_size);
157 memset(key, 0, key_size);
159 /* key is coming from binary file */
160 if (key_file && strcmp(key_file, "-")) {
161 if(passLen < key_size) {
162 log_err(cd, _("Cannot not read %d bytes from key file %s.\n"),
163 (int)key_size, key_file);
164 crypt_safe_free(key);
167 memcpy(key, pass, key_size);
171 /* key is coming from tty, fd or binary stdin */
173 r = crypt_plain_hash(cd, hash_name, key, key_size, pass, passLen);
176 log_err(cd, _("Hash algorithm %s not supported.\n"),
179 log_err(cd, _("Key processing error (using hash %s).\n"),
181 crypt_safe_free(key);
184 } else if (passLen > key_size) {
185 memcpy(key, pass, key_size);
187 memcpy(key, pass, passLen);
193 static int isPLAIN(const char *type)
195 return (type && !strcmp(CRYPT_PLAIN, type));
198 static int isLUKS(const char *type)
200 return (type && !strcmp(CRYPT_LUKS1, type));
203 static int isLOOPAES(const char *type)
205 return (type && !strcmp(CRYPT_LOOPAES, type));
208 /* keyslot helpers */
209 static int keyslot_verify_or_find_empty(struct crypt_device *cd, int *keyslot)
211 if (*keyslot == CRYPT_ANY_SLOT) {
212 *keyslot = LUKS_keyslot_find_empty(&cd->hdr);
214 log_err(cd, _("All key slots full.\n"));
219 switch (LUKS_keyslot_info(&cd->hdr, *keyslot)) {
220 case CRYPT_SLOT_INVALID:
221 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
222 *keyslot, LUKS_NUMKEYS - 1);
224 case CRYPT_SLOT_INACTIVE:
227 log_err(cd, _("Key slot %d is full, please select another one.\n"),
235 static int verify_other_keyslot(struct crypt_device *cd,
236 const char *key_file,
239 struct volume_key *vk = NULL;
240 crypt_keyslot_info ki;
242 char *password = NULL;
245 r = crypt_get_key(_("Enter any remaining LUKS passphrase: "),
246 &password, &passwordLen, 0, key_file, cd->timeout,
247 cd->password_verify, cd);
251 ki = crypt_keyslot_status(cd, keyIndex);
252 if (ki == CRYPT_SLOT_ACTIVE) /* Not last slot */
253 LUKS_keyslot_set(&cd->hdr, keyIndex, 0);
255 openedIndex = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT,
256 password, passwordLen,
259 if (ki == CRYPT_SLOT_ACTIVE)
260 LUKS_keyslot_set(&cd->hdr, keyIndex, 1);
265 log_verbose(cd, _("Key slot %d verified.\n"), openedIndex);
267 crypt_free_volume_key(vk);
268 crypt_safe_free(password);
272 static int find_keyslot_by_passphrase(struct crypt_device *cd,
273 const char *key_file,
276 struct volume_key *vk = NULL;
277 char *password = NULL;
281 r = crypt_get_key(message,&password,&passwordLen, 0, key_file,
282 cd->timeout, cd->password_verify, cd);
286 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password,
287 passwordLen, &cd->hdr, &vk, cd);
289 crypt_free_volume_key(vk);
290 crypt_safe_free(password);
294 static int luks_remove_helper(struct crypt_device *cd,
296 const char *other_key_file,
297 const char *key_file,
300 crypt_keyslot_info ki;
303 if (key_slot == CRYPT_ANY_SLOT) {
304 key_slot = find_keyslot_by_passphrase(cd, key_file,
305 _("Enter LUKS passphrase to be deleted: "));
311 log_std(cd, _("Key slot %d selected for deletion.\n"), key_slot);
314 ki = crypt_keyslot_status(cd, key_slot);
315 if (ki == CRYPT_SLOT_INVALID) {
316 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
317 key_slot, LUKS_NUMKEYS - 1);
321 if (ki <= CRYPT_SLOT_INACTIVE) {
322 log_err(cd, _("Key %d not active. Can't wipe.\n"), key_slot);
327 if (ki == CRYPT_SLOT_ACTIVE_LAST && cd->confirm &&
328 !(cd->confirm(_("This is the last keyslot."
329 " Device will become unusable after purging this key."),
330 cd->confirm_usrptr))) {
336 r = verify_other_keyslot(cd, other_key_file, key_slot);
341 r = crypt_keyslot_destroy(cd, key_slot);
343 return (r < 0) ? r : 0;
346 static int create_device_helper(struct crypt_device *cd,
350 const char *cipher_mode,
351 const char *key_file,
352 const char *passphrase,
353 size_t passphrase_size,
362 crypt_status_info ci;
363 char *dm_cipher = NULL;
364 char *processed_key = NULL;
370 ci = crypt_status(cd, name);
371 if (ci == CRYPT_INVALID)
374 if (reload && ci < CRYPT_ACTIVE)
377 if (!reload && ci >= CRYPT_ACTIVE) {
378 log_err(cd, _("Device %s already exists.\n"), name);
382 if (key_size > 1024) {
383 log_err(cd, _("Invalid key size %d.\n"), (int)key_size);
387 r = device_check_and_adjust(cd, cd->device, !reload, &size, &offset, &read_only);
391 if (cipher_mode && asprintf(&dm_cipher, "%s-%s", cipher, cipher_mode) < 0)
394 processed_key = process_key(cd, hash, key_file, key_size, passphrase, passphrase_size);
395 if (!processed_key) {
400 r = dm_create_device(name, cd->device, dm_cipher ?: cipher, cd->type, uuid, size, skip, offset,
401 key_size, processed_key, read_only, reload);
404 crypt_safe_free(processed_key);
408 static int open_from_hdr_and_vk(struct crypt_device *cd,
409 struct volume_key *vk,
413 uint64_t size, offset;
415 int read_only, no_uuid, r;
418 offset = crypt_get_data_offset(cd);
419 read_only = flags & CRYPT_ACTIVATE_READONLY;
420 no_uuid = flags & CRYPT_ACTIVATE_NO_UUID;
422 r = device_check_and_adjust(cd, cd->device, 1, &size, &offset, &read_only);
426 if (asprintf(&cipher, "%s-%s", crypt_get_cipher(cd),
427 crypt_get_cipher_mode(cd)) < 0)
430 r = dm_create_device(name, cd->device, cipher, cd->type,
431 no_uuid ? NULL : crypt_get_uuid(cd),
432 size, 0, offset, vk->keylength, vk->key,
438 static void log_wrapper(int level, const char *msg, void *usrptr)
440 void (*xlog)(int level, char *msg) = usrptr;
441 xlog(level, (char *)msg);
444 static int yesDialog_wrapper(const char *msg, void *usrptr)
446 int (*xyesDialog)(char *msg) = usrptr;
447 return xyesDialog((char*)msg);
450 int crypt_confirm(struct crypt_device *cd, const char *msg)
452 if (!cd || !cd->confirm)
455 return cd->confirm(msg, cd->confirm_usrptr);
458 static int key_from_terminal(struct crypt_device *cd, char *msg, char **key,
459 size_t *key_len, int force_verify)
465 if(!msg && asprintf(&prompt, _("Enter passphrase for %s: "),
466 cd->backing_file ?: cd->device) < 0)
473 *key = crypt_safe_alloc(DEFAULT_PASSPHRASE_SIZE_MAX);
478 r = cd->password(msg, *key, DEFAULT_PASSPHRASE_SIZE_MAX,
479 cd->password_usrptr);
481 crypt_safe_free(*key);
486 r = crypt_get_key(msg, key, key_len, 0, NULL, cd->timeout,
487 (force_verify || cd->password_verify), cd);
490 return (r < 0) ? r: 0;
493 static int volume_key_by_terminal_passphrase(struct crypt_device *cd, int keyslot,
494 struct volume_key **vk)
496 char *passphrase_read = NULL;
497 size_t passphrase_size_read;
498 int r = -EINVAL, eperm = 0, tries = cd->tries;
502 crypt_free_volume_key(*vk);
505 r = key_from_terminal(cd, NULL, &passphrase_read,
506 &passphrase_size_read, 0);
510 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
511 passphrase_size_read, &cd->hdr, vk, cd);
514 crypt_safe_free(passphrase_read);
515 passphrase_read = NULL;
516 } while (r == -EPERM && (--tries > 0));
519 crypt_free_volume_key(*vk);
522 /* Report wrong passphrase if at least one try failed */
523 if (eperm && r == -EPIPE)
527 crypt_safe_free(passphrase_read);
531 static int key_from_file(struct crypt_device *cd, char *msg,
532 char **key, size_t *key_len,
533 const char *key_file, size_t key_size)
535 return crypt_get_key(msg, key, key_len, key_size, key_file,
539 static int _crypt_init(struct crypt_device **cd,
541 struct crypt_options *options,
542 int load, int need_dm)
546 /* if it is plain device and mapping table is being reloaded
547 initialize it by name*/
548 init_by_name = (type && !strcmp(type, CRYPT_PLAIN) && load);
550 /* Some of old API calls do not require DM in kernel,
551 fake initialisation by initialise it with kernel_check disabled */
553 (void)dm_init(NULL, 0);
555 r = crypt_init_by_name(cd, options->name);
557 r = crypt_init(cd, options->device);
564 crypt_set_log_callback(*cd, log_wrapper, options->icb->log);
565 crypt_set_confirm_callback(*cd, yesDialog_wrapper, options->icb->yesDialog);
567 crypt_set_timeout(*cd, options->timeout);
568 crypt_set_password_retry(*cd, options->tries);
569 crypt_set_iterarion_time(*cd, options->iteration_time ?: 1000);
570 crypt_set_password_verify(*cd, options->flags & CRYPT_FLAG_VERIFY);
572 if (load && !init_by_name)
573 r = crypt_load(*cd, type, NULL);
575 if (!r && type && !(*cd)->type) {
576 (*cd)->type = strdup(type);
587 void crypt_set_log_callback(struct crypt_device *cd,
588 void (*log)(int level, const char *msg, void *usrptr),
595 cd->log_usrptr = usrptr;
599 void crypt_set_confirm_callback(struct crypt_device *cd,
600 int (*confirm)(const char *msg, void *usrptr),
603 cd->confirm = confirm;
604 cd->confirm_usrptr = usrptr;
607 void crypt_set_password_callback(struct crypt_device *cd,
608 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
611 cd->password = password;
612 cd->password_usrptr = usrptr;
615 /* OPTIONS: name, cipher, device, hash, key_file, key_size, key_slot,
616 * offset, size, skip, timeout, tries, passphrase_fd (ignored),
618 static int crypt_create_and_update_device(struct crypt_options *options, int update)
620 struct crypt_device *cd = NULL;
621 char *passphrase = NULL;
622 size_t passphrase_size = 0;
625 r = _crypt_init(&cd, CRYPT_PLAIN, options, 0, 1);
629 r = crypt_get_key(_("Enter passphrase: "), &passphrase, &passphrase_size,
630 options->key_size, options->key_file,
631 cd->timeout, cd->password_verify, cd);
633 r = create_device_helper(cd, options->name, options->hash,
634 options->cipher, NULL, options->key_file,
635 passphrase, passphrase_size,
636 options->key_size, options->size, options->skip,
637 options->offset, NULL, options->flags & CRYPT_FLAG_READONLY,
640 crypt_safe_free(passphrase);
645 int crypt_create_device(struct crypt_options *options)
647 return crypt_create_and_update_device(options, 0);
650 int crypt_update_device(struct crypt_options *options)
652 return crypt_create_and_update_device(options, 1);
655 /* OPTIONS: name, size, icb */
656 int crypt_resize_device(struct crypt_options *options)
658 struct crypt_device *cd = NULL;
659 char *device = NULL, *cipher = NULL, *uuid = NULL, *key = NULL;
660 const char *type = NULL;
661 uint64_t size, skip, offset;
662 int key_size, read_only, r;
664 log_dbg("Resizing device %s to %" PRIu64 " sectors.", options->name, options->size);
666 if (dm_init(NULL, 1) < 0)
669 r = dm_query_device(options->name, &device, &size, &skip, &offset,
670 &cipher, &key_size, &key, &read_only, NULL, &uuid);
672 log_err(NULL, _("Device %s is not active.\n"), options->name);
676 /* Try to determine type of device from UUID */
679 if (!strncmp(uuid, CRYPT_PLAIN, strlen(CRYPT_PLAIN))) {
683 } else if (!strncmp(uuid, CRYPT_LUKS1, strlen(CRYPT_LUKS1)))
687 if (!options->device)
688 options->device = device;
690 r = _crypt_init(&cd, type, options, 1, 1);
694 size = options->size;
695 r = device_check_and_adjust(cd, device, 0, &size, &offset, &read_only);
699 r = dm_create_device(options->name, device, cipher, type,
700 crypt_get_uuid(cd), size, skip, offset,
701 key_size, key, read_only, 1);
703 crypt_safe_free(key);
705 if (options->device == device)
706 options->device = NULL;
714 /* OPTIONS: name, icb */
715 int crypt_query_device(struct crypt_options *options)
719 log_dbg("Query device %s.", options->name);
721 if (dm_init(NULL, 1) < 0)
724 r = dm_status_device(options->name);
728 r = dm_query_device(options->name, (char **)&options->device, &options->size,
729 &options->skip, &options->offset, (char **)&options->cipher,
730 &options->key_size, NULL, &read_only, NULL, NULL);
733 options->flags |= CRYPT_FLAG_READONLY;
735 options->flags |= CRYPT_FLAG_FREE_DEVICE;
736 options->flags |= CRYPT_FLAG_FREE_CIPHER;
748 /* OPTIONS: name, icb */
749 int crypt_remove_device(struct crypt_options *options)
751 struct crypt_device *cd = NULL;
754 r = crypt_init_by_name(&cd, options->name);
756 r = crypt_deactivate(cd, options->name);
763 /* OPTIONS: device, cipher, hash, align_payload, key_size (master key), key_slot
764 * new_key_file, iteration_time, timeout, flags, icb */
765 int crypt_luksFormat(struct crypt_options *options)
767 char cipherName[LUKS_CIPHERNAME_L];
768 char cipherMode[LUKS_CIPHERMODE_L];
771 struct crypt_device *cd = NULL;
772 struct crypt_params_luks1 cp = {
773 .hash = options->hash,
774 .data_alignment = options->align_payload
778 r = crypt_parse_name_and_mode(options->cipher, cipherName, NULL, cipherMode);
780 log_err(cd, _("No known cipher specification pattern detected.\n"));
784 if ((r = _crypt_init(&cd, CRYPT_LUKS1, options, 0, 1)))
787 if (options->key_slot >= LUKS_NUMKEYS && options->key_slot != CRYPT_ANY_SLOT) {
788 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
789 options->key_slot, LUKS_NUMKEYS - 1);
794 r = crypt_get_key(_("Enter LUKS passphrase: "), &password, &passwordLen, 0,
795 options->new_key_file, cd->timeout, cd->password_verify, cd);
800 r = crypt_format(cd, CRYPT_LUKS1, cipherName, cipherMode,
801 NULL, NULL, options->key_size, &cp);
805 /* Add keyslot using internally stored volume key generated during format */
806 r = crypt_keyslot_add_by_volume_key(cd, options->key_slot, NULL, 0,
807 password, passwordLen);
810 crypt_safe_free(password);
811 return (r < 0) ? r : 0;
814 /* OPTIONS: name, device, key_size, key_file, timeout, tries, flags, icb */
815 int crypt_luksOpen(struct crypt_options *options)
817 struct crypt_device *cd = NULL;
824 r = _crypt_init(&cd, CRYPT_LUKS1, options, 1, 1);
828 if (options->flags & CRYPT_FLAG_READONLY)
829 flags |= CRYPT_ACTIVATE_READONLY;
831 if (options->flags & CRYPT_FLAG_NON_EXCLUSIVE_ACCESS)
832 flags |= CRYPT_ACTIVATE_NO_UUID;
834 if (options->key_file)
835 r = crypt_activate_by_keyfile(cd, options->name,
836 CRYPT_ANY_SLOT, options->key_file, 0,
839 r = crypt_activate_by_passphrase(cd, options->name,
840 CRYPT_ANY_SLOT, options->passphrase,
841 options->passphrase ? strlen(options->passphrase) : 0,
845 return (r < 0) ? r : 0;
848 /* OPTIONS: device, keys_slot, key_file, timeout, flags, icb */
849 int crypt_luksKillSlot(struct crypt_options *options)
851 struct crypt_device *cd = NULL;
854 r = _crypt_init(&cd, CRYPT_LUKS1, options, 1, 1);
858 r = luks_remove_helper(cd, options->key_slot, options->key_file, NULL,
859 options->flags & CRYPT_FLAG_VERIFY_ON_DELKEY);
862 return (r < 0) ? r : 0;
865 /* OPTIONS: device, new_key_file, key_file, timeout, flags, icb */
866 int crypt_luksRemoveKey(struct crypt_options *options)
868 struct crypt_device *cd = NULL;
871 r = _crypt_init(&cd, CRYPT_LUKS1, options, 1, 1);
875 r = luks_remove_helper(cd, CRYPT_ANY_SLOT, options->key_file, options->new_key_file,
876 options->flags & CRYPT_FLAG_VERIFY_ON_DELKEY);
879 return (r < 0) ? r : 0;
883 /* OPTIONS: device, new_key_file, key_file, key_slot, flags,
884 iteration_time, timeout, icb */
885 int crypt_luksAddKey(struct crypt_options *options)
887 struct crypt_device *cd = NULL;
890 r = _crypt_init(&cd, CRYPT_LUKS1, options, 1, 1);
894 if (options->key_file || options->new_key_file)
895 r = crypt_keyslot_add_by_keyfile(cd, options->key_slot,
896 options->key_file, 0,
897 options->new_key_file, 0);
899 r = crypt_keyslot_add_by_passphrase(cd, options->key_slot,
903 return (r < 0) ? r : 0;
906 /* OPTIONS: device, icb */
907 int crypt_luksUUID(struct crypt_options *options)
909 struct crypt_device *cd = NULL;
913 r = _crypt_init(&cd, CRYPT_LUKS1, options, 1, 0);
917 uuid = (char *)crypt_get_uuid(cd);
918 log_std(cd, "%s\n", uuid ?: "");
923 /* OPTIONS: device, icb */
924 int crypt_isLuks(struct crypt_options *options)
926 struct crypt_device *cd = NULL;
929 log_dbg("Check device %s for LUKS header.", options->device);
935 r = crypt_init(&cd, options->device);
939 /* Do print fail here, no need to crypt_load() */
940 r = LUKS_read_phdr(cd->device, &cd->hdr, 0, cd) ? -EINVAL : 0;
946 /* OPTIONS: device, icb */
947 int crypt_luksDump(struct crypt_options *options)
949 struct crypt_device *cd = NULL;
952 r = _crypt_init(&cd, CRYPT_LUKS1, options, 1, 0);
962 void crypt_get_error(char *buf, size_t size)
964 const char *error = get_error();
966 if (!buf || size < 1)
969 strncpy(buf, error, size - 1);
970 buf[size - 1] = '\0';
976 void crypt_put_options(struct crypt_options *options)
978 if (options->flags & CRYPT_FLAG_FREE_DEVICE) {
979 free((char *)options->device);
980 options->device = NULL;
981 options->flags &= ~CRYPT_FLAG_FREE_DEVICE;
983 if (options->flags & CRYPT_FLAG_FREE_CIPHER) {
984 free((char *)options->cipher);
985 options->cipher = NULL;
986 options->flags &= ~CRYPT_FLAG_FREE_CIPHER;
990 const char *crypt_get_dir(void)
995 /////////////////////////////////
1000 int crypt_init(struct crypt_device **cd, const char *device)
1002 struct crypt_device *h = NULL;
1003 int r, readonly = 0;
1008 log_dbg("Allocating crypt device %s context.", device);
1010 if (!(h = malloc(sizeof(struct crypt_device))))
1013 memset(h, 0, sizeof(*h));
1017 r = device_ready(NULL, device, O_RDONLY);
1018 if (r == -ENOTBLK) {
1019 h->device = crypt_loop_get_device();
1020 log_dbg("Not a block device, %s%s.",
1021 h->device ? "using free loop device " :
1022 "no free loop device found",
1025 log_err(NULL, _("Cannot find a free loopback device.\n"));
1030 /* Keep the loop open, dettached on last close. */
1031 h->loop_fd = crypt_loop_attach(h->device, device, 0, 1, &readonly);
1032 if (h->loop_fd == -1) {
1033 log_err(NULL, _("Attaching loopback device failed "
1034 "(loop device with autoclear flag is required).\n"));
1039 h->backing_file = crypt_loop_backing_file(h->device);
1040 r = device_ready(NULL, h->device, O_RDONLY);
1048 if (!h->device && device && !(h->device = strdup(device))) {
1053 if (dm_init(h, 1) < 0) {
1058 h->iteration_time = 1000;
1059 h->password_verify = 0;
1061 h->rng_type = crypt_random_default_key_rng();
1067 if (h->loop_fd != -1)
1070 free(h->backing_file);
1076 int crypt_init_by_name(struct crypt_device **cd, const char *name)
1078 crypt_status_info ci;
1079 struct crypt_active_device cad;
1080 char *device = NULL, *cipher_full = NULL, *device_uuid = NULL;
1081 char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
1083 int key_size = 0, key_nums, r;
1086 log_dbg("Allocating crypt device context by device %s.", name);
1088 ci = crypt_status(NULL, name);
1089 if (ci == CRYPT_INVALID)
1092 if (ci < CRYPT_ACTIVE) {
1093 log_err(NULL, _("Device %s is not active.\n"), name);
1097 r = dm_query_device(name, &device, &cad.size, &cad.iv_offset, &cad.offset,
1098 &cipher_full, &key_size, &key, NULL, NULL,
1104 r = crypt_init(cd, device);
1106 /* Underlying device disappeared but mapping still active */
1107 if (!device || r == -ENOTBLK)
1108 log_verbose(NULL, _("Underlying device for crypt device %s disappeared.\n"),
1111 /* Underlying device is not readable but crypt mapping exists */
1112 if (r == -ENOTBLK) {
1115 r = crypt_init(cd, NULL);
1121 /* Try to initialise basic parameters from active device */
1123 if (!(*cd)->backing_file && device && crypt_loop_device(device) &&
1124 !((*cd)->backing_file = crypt_loop_backing_file(device))) {
1130 if (!strncmp(CRYPT_PLAIN, device_uuid, sizeof(CRYPT_PLAIN)-1)) {
1131 (*cd)->type = strdup(CRYPT_PLAIN);
1132 (*cd)->plain_uuid = strdup(device_uuid);
1133 (*cd)->plain_hdr.hash = NULL; /* no way to get this */
1134 (*cd)->plain_hdr.offset = cad.offset;
1135 (*cd)->plain_hdr.skip = cad.iv_offset;
1136 (*cd)->volume_key = crypt_alloc_volume_key(key_size, key);
1137 if (!(*cd)->volume_key) {
1142 r = crypt_parse_name_and_mode(cipher_full, cipher, NULL, cipher_mode);
1144 (*cd)->plain_cipher = strdup(cipher);
1145 (*cd)->plain_cipher_mode = strdup(cipher_mode);
1147 } else if (!strncmp(CRYPT_LOOPAES, device_uuid, sizeof(CRYPT_LOOPAES)-1)) {
1148 (*cd)->type = strdup(CRYPT_LOOPAES);
1149 (*cd)->loopaes_uuid = strdup(device_uuid);
1150 (*cd)->loopaes_hdr.offset = cad.offset;
1152 r = crypt_parse_name_and_mode(cipher_full, cipher,
1153 &key_nums, cipher_mode);
1155 (*cd)->loopaes_cipher = strdup(cipher);
1156 (*cd)->loopaes_cipher_mode = strdup(cipher_mode);
1157 /* version 3 uses last key for IV */
1158 if (key_size % key_nums)
1160 (*cd)->loopaes_key_size = key_size / key_nums;
1162 } else if (!strncmp(CRYPT_LUKS1, device_uuid, sizeof(CRYPT_LUKS1)-1)) {
1164 if (crypt_load(*cd, CRYPT_LUKS1, NULL) < 0 ||
1165 crypt_volume_key_verify(*cd, key, key_size) < 0) {
1166 log_dbg("LUKS device header does not match active device.");
1170 (*cd)->volume_key = crypt_alloc_volume_key(key_size, key);
1171 if (!(*cd)->volume_key) {
1178 log_dbg("Active device has no UUID set, some parameters are not set.");
1185 crypt_safe_free(key);
1192 static int _crypt_format_plain(struct crypt_device *cd,
1194 const char *cipher_mode,
1196 size_t volume_key_size,
1197 struct crypt_params_plain *params)
1199 if (!cipher || !cipher_mode) {
1200 log_err(cd, _("Invalid plain crypt parameters.\n"));
1204 if (volume_key_size > 1024) {
1205 log_err(cd, _("Invalid key size.\n"));
1209 cd->volume_key = crypt_alloc_volume_key(volume_key_size, NULL);
1210 if (!cd->volume_key)
1213 cd->plain_cipher = strdup(cipher);
1214 cd->plain_cipher_mode = strdup(cipher_mode);
1217 cd->plain_uuid = strdup(uuid);
1219 if (params && params->hash)
1220 cd->plain_hdr.hash = strdup(params->hash);
1222 cd->plain_hdr.offset = params ? params->offset : 0;
1223 cd->plain_hdr.skip = params ? params->skip : 0;
1225 if (!cd->plain_cipher || !cd->plain_cipher_mode)
1231 static int _crypt_format_luks1(struct crypt_device *cd,
1233 const char *cipher_mode,
1235 const char *volume_key,
1236 size_t volume_key_size,
1237 struct crypt_params_luks1 *params)
1240 unsigned long required_alignment = DEFAULT_DISK_ALIGNMENT;
1241 unsigned long alignment_offset = 0;
1244 log_err(cd, _("Can't format LUKS without device.\n"));
1249 cd->volume_key = crypt_alloc_volume_key(volume_key_size,
1252 cd->volume_key = crypt_generate_volume_key(cd, volume_key_size);
1257 if (params && params->data_alignment)
1258 required_alignment = params->data_alignment * SECTOR_SIZE;
1260 get_topology_alignment(cd->device, &required_alignment,
1261 &alignment_offset, DEFAULT_DISK_ALIGNMENT);
1263 r = LUKS_generate_phdr(&cd->hdr, cd->volume_key, cipher, cipher_mode,
1264 (params && params->hash) ? params->hash : "sha1",
1266 required_alignment / SECTOR_SIZE,
1267 alignment_offset / SECTOR_SIZE,
1268 cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1272 /* Wipe first 8 sectors - fs magic numbers etc. */
1273 r = wipe_device_header(cd->device, 8);
1276 log_err(cd, _("Cannot format device %s which is still in use.\n"),
1279 log_err(cd, _("Cannot wipe header on device %s.\n"),
1285 r = LUKS_write_phdr(cd->device, &cd->hdr, cd);
1290 static int _crypt_format_loopaes(struct crypt_device *cd,
1293 size_t volume_key_size,
1294 struct crypt_params_loopaes *params)
1297 log_err(cd, _("Can't format LOOPAES without device.\n"));
1301 if (volume_key_size > 1024) {
1302 log_err(cd, _("Invalid key size.\n"));
1306 cd->loopaes_key_size = volume_key_size;
1308 cd->loopaes_cipher = strdup(cipher ?: DEFAULT_LOOPAES_CIPHER);
1311 cd->loopaes_uuid = strdup(uuid);
1313 if (params && params->hash)
1314 cd->loopaes_hdr.hash = strdup(params->hash);
1316 cd->loopaes_hdr.offset = params ? params->offset : 0;
1317 cd->loopaes_hdr.skip = params ? params->skip : 0;
1322 int crypt_format(struct crypt_device *cd,
1325 const char *cipher_mode,
1327 const char *volume_key,
1328 size_t volume_key_size,
1336 log_dbg("Formatting device %s as type %s.", cd->device ?: "(none)", type);
1338 r = init_crypto(cd);
1343 r = _crypt_format_plain(cd, cipher, cipher_mode,
1344 uuid, volume_key_size, params);
1345 else if (isLUKS(type))
1346 r = _crypt_format_luks1(cd, cipher, cipher_mode,
1347 uuid, volume_key, volume_key_size, params);
1348 else if (isLOOPAES(type))
1349 r = _crypt_format_loopaes(cd, cipher, uuid, volume_key_size, params);
1351 /* FIXME: allow plugins here? */
1352 log_err(cd, _("Unknown crypt device type %s requested.\n"), type);
1356 if (!r && !(cd->type = strdup(type)))
1360 crypt_free_volume_key(cd->volume_key);
1361 cd->volume_key = NULL;
1367 int crypt_load(struct crypt_device *cd,
1368 const char *requested_type,
1369 void *params __attribute__((unused)))
1371 struct luks_phdr hdr;
1374 log_dbg("Trying to load %s crypt type from device %s.",
1375 requested_type ?: "any", cd->device ?: "(none)");
1380 if (requested_type && !isLUKS(requested_type))
1383 r = init_crypto(cd);
1387 r = LUKS_read_phdr(cd->device, &hdr, 1, cd);
1390 memcpy(&cd->hdr, &hdr, sizeof(hdr));
1391 cd->type = strdup(CRYPT_LUKS1);
1399 int crypt_resize(struct crypt_device *cd, const char *name, uint64_t new_size)
1401 char *device = NULL, *cipher = NULL, *uuid = NULL, *key = NULL;
1402 uint64_t size, skip, offset;
1403 int key_size, read_only, r;
1405 /* Device context type must be initialised */
1406 if (!cd->type || !crypt_get_uuid(cd))
1409 r = dm_query_device(name, &device, &size, &skip, &offset,
1410 &cipher, &key_size, &key, &read_only, NULL, &uuid);
1412 log_err(NULL, _("Device %s is not active.\n"), name);
1421 r = device_check_and_adjust(cd, device, 0, &new_size, &offset, &read_only);
1425 if (new_size == size) {
1426 log_dbg("Device has already requested size %" PRIu64
1432 log_dbg("Resizing device %s to %" PRIu64 " sectors.", name, new_size);
1434 r = dm_create_device(name, device, cipher, cd->type,
1435 crypt_get_uuid(cd), new_size, skip, offset,
1436 key_size, key, read_only, 1);
1438 crypt_safe_free(key);
1446 int crypt_set_uuid(struct crypt_device *cd, const char *uuid)
1448 if (!isLUKS(cd->type)) {
1449 log_err(cd, _("This operation is not supported for this device type.\n"));
1453 if (uuid && !strncmp(uuid, cd->hdr.uuid, sizeof(cd->hdr.uuid))) {
1454 log_dbg("UUID is the same as requested (%s) for device %s.",
1460 log_dbg("Requested new UUID change to %s for %s.", uuid, cd->device);
1462 log_dbg("Requested new UUID refresh for %s.", cd->device);
1464 if (!crypt_confirm(cd, _("Do you really want to change UUID of device?")))
1467 return LUKS_hdr_uuid_set(cd->device, &cd->hdr, uuid, cd);
1470 int crypt_header_backup(struct crypt_device *cd,
1471 const char *requested_type,
1472 const char *backup_file)
1476 if ((requested_type && !isLUKS(requested_type)) || !backup_file)
1479 r = init_crypto(cd);
1483 log_dbg("Requested header backup of device %s (%s) to "
1484 "file %s.", cd->device, requested_type, backup_file);
1486 return LUKS_hdr_backup(backup_file, cd->device, &cd->hdr, cd);
1489 int crypt_header_restore(struct crypt_device *cd,
1490 const char *requested_type,
1491 const char *backup_file)
1495 if (requested_type && !isLUKS(requested_type))
1498 /* Some hash functions need initialized gcrypt library */
1499 r = init_crypto(cd);
1503 log_dbg("Requested header restore to device %s (%s) from "
1504 "file %s.", cd->device, requested_type, backup_file);
1506 return LUKS_hdr_restore(backup_file, cd->device, &cd->hdr, cd);
1509 void crypt_free(struct crypt_device *cd)
1512 log_dbg("Releasing crypt device %s context.", cd->device);
1514 if (cd->loop_fd != -1)
1518 crypt_free_volume_key(cd->volume_key);
1521 free(cd->backing_file);
1524 /* used in plain device only */
1525 free((char*)cd->plain_hdr.hash);
1526 free(cd->plain_cipher);
1527 free(cd->plain_cipher_mode);
1528 free(cd->plain_uuid);
1530 /* used in loop-AES device only */
1531 free((char*)cd->loopaes_hdr.hash);
1532 free(cd->loopaes_cipher);
1533 free(cd->loopaes_uuid);
1539 int crypt_suspend(struct crypt_device *cd,
1542 crypt_status_info ci;
1543 int r, suspended = 0;
1545 log_dbg("Suspending volume %s.", name);
1547 ci = crypt_status(NULL, name);
1548 if (ci < CRYPT_ACTIVE) {
1549 log_err(cd, _("Volume %s is not active.\n"), name);
1553 if (!cd && dm_init(NULL, 1) < 0)
1556 r = dm_query_device(name, NULL, NULL, NULL, NULL,
1557 NULL, NULL, NULL, NULL, &suspended, NULL);
1562 log_err(cd, _("Volume %s is already suspended.\n"), name);
1567 r = dm_suspend_and_wipe_key(name);
1569 log_err(cd, "Suspend is not supported for device %s.\n", name);
1571 log_err(cd, "Error during suspending device %s.\n", name);
1578 int crypt_resume_by_passphrase(struct crypt_device *cd,
1581 const char *passphrase,
1582 size_t passphrase_size)
1584 struct volume_key *vk = NULL;
1585 int r, suspended = 0;
1587 log_dbg("Resuming volume %s.", name);
1589 if (!isLUKS(cd->type)) {
1590 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1595 r = dm_query_device(name, NULL, NULL, NULL, NULL,
1596 NULL, NULL, NULL, NULL, &suspended, NULL);
1601 log_err(cd, _("Volume %s is not suspended.\n"), name);
1606 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1607 passphrase_size, &cd->hdr, &vk, cd);
1609 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1613 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1615 log_err(cd, "Resume is not supported for device %s.\n", name);
1617 log_err(cd, "Error during resuming device %s.\n", name);
1621 crypt_free_volume_key(vk);
1622 return r < 0 ? r : keyslot;
1625 int crypt_resume_by_keyfile(struct crypt_device *cd,
1628 const char *keyfile,
1629 size_t keyfile_size)
1631 struct volume_key *vk = NULL;
1632 char *passphrase_read = NULL;
1633 size_t passphrase_size_read;
1634 int r, suspended = 0;
1636 log_dbg("Resuming volume %s.", name);
1638 if (!isLUKS(cd->type)) {
1639 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1644 r = dm_query_device(name, NULL, NULL, NULL, NULL,
1645 NULL, NULL, NULL, NULL, &suspended, NULL);
1650 log_err(cd, _("Volume %s is not suspended.\n"), name);
1657 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1658 &passphrase_size_read, keyfile, keyfile_size);
1662 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
1663 passphrase_size_read, &cd->hdr, &vk, cd);
1668 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1670 log_err(cd, "Error during resuming device %s.\n", name);
1672 crypt_safe_free(passphrase_read);
1673 crypt_free_volume_key(vk);
1674 return r < 0 ? r : keyslot;
1677 // slot manipulation
1678 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
1679 int keyslot, // -1 any
1680 const char *passphrase, // NULL -> terminal
1681 size_t passphrase_size,
1682 const char *new_passphrase, // NULL -> terminal
1683 size_t new_passphrase_size)
1685 struct volume_key *vk = NULL;
1686 char *password = NULL, *new_password = NULL;
1687 size_t passwordLen, new_passwordLen;
1690 log_dbg("Adding new keyslot, existing passphrase %sprovided,"
1691 "new passphrase %sprovided.",
1692 passphrase ? "" : "not ", new_passphrase ? "" : "not ");
1694 if (!isLUKS(cd->type)) {
1695 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1699 r = keyslot_verify_or_find_empty(cd, &keyslot);
1703 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1704 /* No slots used, try to use pre-generated key in header */
1705 if (cd->volume_key) {
1706 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1707 r = vk ? 0 : -ENOMEM;
1709 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1712 } else if (passphrase) {
1713 /* Passphrase provided, use it to unlock existing keyslot */
1714 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, passphrase,
1715 passphrase_size, &cd->hdr, &vk, cd);
1717 /* Passphrase not provided, ask first and use it to unlock existing keyslot */
1718 r = key_from_terminal(cd, _("Enter any passphrase: "),
1719 &password, &passwordLen, 0);
1723 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password,
1724 passwordLen, &cd->hdr, &vk, cd);
1725 crypt_safe_free(password);
1731 if (new_passphrase) {
1732 new_password = (char *)new_passphrase;
1733 new_passwordLen = new_passphrase_size;
1735 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1736 &new_password, &new_passwordLen, 1);
1741 r = LUKS_set_key(cd->device, keyslot, new_password, new_passwordLen,
1742 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1747 if (!new_passphrase)
1748 crypt_safe_free(new_password);
1749 crypt_free_volume_key(vk);
1750 return r ?: keyslot;
1753 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
1755 const char *keyfile,
1756 size_t keyfile_size,
1757 const char *new_keyfile,
1758 size_t new_keyfile_size)
1760 struct volume_key *vk = NULL;
1761 char *password = NULL; size_t passwordLen;
1762 char *new_password = NULL; size_t new_passwordLen;
1765 log_dbg("Adding new keyslot, existing keyfile %s, new keyfile %s.",
1766 keyfile ?: "[none]", new_keyfile ?: "[none]");
1768 if (!isLUKS(cd->type)) {
1769 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1773 r = keyslot_verify_or_find_empty(cd, &keyslot);
1777 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1778 /* No slots used, try to use pre-generated key in header */
1779 if (cd->volume_key) {
1780 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1781 r = vk ? 0 : -ENOMEM;
1783 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1787 /* Read password from file of (if NULL) from terminal */
1789 r = key_from_file(cd, _("Enter any passphrase: "),
1790 &password, &passwordLen,
1791 keyfile, keyfile_size);
1793 r = key_from_terminal(cd, _("Enter any passphrase: "),
1794 &password, &passwordLen, 0);
1798 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password, passwordLen,
1806 r = key_from_file(cd, _("Enter new passphrase for key slot: "),
1807 &new_password, &new_passwordLen, new_keyfile,
1810 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1811 &new_password, &new_passwordLen, 1);
1815 r = LUKS_set_key(cd->device, keyslot, new_password, new_passwordLen,
1816 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1818 crypt_safe_free(password);
1819 crypt_safe_free(new_password);
1820 crypt_free_volume_key(vk);
1821 return r < 0 ? r : keyslot;
1824 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
1826 const char *volume_key,
1827 size_t volume_key_size,
1828 const char *passphrase,
1829 size_t passphrase_size)
1831 struct volume_key *vk = NULL;
1833 char *new_password = NULL; size_t new_passwordLen;
1835 log_dbg("Adding new keyslot %d using volume key.", keyslot);
1837 if (!isLUKS(cd->type)) {
1838 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1843 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1844 else if (cd->volume_key)
1845 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1850 r = LUKS_verify_volume_key(&cd->hdr, vk);
1852 log_err(cd, _("Volume key does not match the volume.\n"));
1856 r = keyslot_verify_or_find_empty(cd, &keyslot);
1861 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1862 &new_password, &new_passwordLen, 1);
1865 passphrase = new_password;
1866 passphrase_size = new_passwordLen;
1869 r = LUKS_set_key(cd->device, keyslot, passphrase, passphrase_size,
1870 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1872 crypt_safe_free(new_password);
1873 crypt_free_volume_key(vk);
1874 return (r < 0) ? r : keyslot;
1877 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot)
1879 crypt_keyslot_info ki;
1881 log_dbg("Destroying keyslot %d.", keyslot);
1883 if (!isLUKS(cd->type)) {
1884 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1888 ki = crypt_keyslot_status(cd, keyslot);
1889 if (ki == CRYPT_SLOT_INVALID) {
1890 log_err(cd, _("Key slot %d is invalid.\n"), keyslot);
1894 if (ki == CRYPT_SLOT_INACTIVE) {
1895 log_err(cd, _("Key slot %d is not used.\n"), keyslot);
1899 return LUKS_del_key(cd->device, keyslot, &cd->hdr, cd);
1902 // activation/deactivation of device mapping
1903 int crypt_activate_by_passphrase(struct crypt_device *cd,
1906 const char *passphrase,
1907 size_t passphrase_size,
1910 crypt_status_info ci;
1911 struct volume_key *vk = NULL;
1912 char *read_passphrase = NULL;
1913 size_t passphraseLen = 0;
1916 log_dbg("%s volume %s [keyslot %d] using %spassphrase.",
1917 name ? "Activating" : "Checking", name ?: "",
1918 keyslot, passphrase ? "" : "[none] ");
1921 ci = crypt_status(NULL, name);
1922 if (ci == CRYPT_INVALID)
1924 else if (ci >= CRYPT_ACTIVE) {
1925 log_err(cd, _("Device %s already exists.\n"), name);
1930 /* plain, use hashed passphrase */
1931 if (isPLAIN(cd->type)) {
1933 r = key_from_terminal(cd, NULL, &read_passphrase,
1937 passphrase = read_passphrase;
1938 passphrase_size = passphraseLen;
1940 r = create_device_helper(cd, name, cd->plain_hdr.hash,
1941 cd->plain_cipher, cd->plain_cipher_mode,
1942 NULL, passphrase, passphrase_size,
1943 cd->volume_key->keylength, 0,
1944 cd->plain_hdr.skip, cd->plain_hdr.offset,
1946 flags & CRYPT_ACTIVATE_READONLY, 0);
1948 } else if (isLUKS(cd->type)) {
1949 /* provided passphrase, do not retry */
1951 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1952 passphrase_size, &cd->hdr, &vk, cd);
1954 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1959 r = open_from_hdr_and_vk(cd, vk, name, flags);
1964 crypt_safe_free(read_passphrase);
1965 crypt_free_volume_key(vk);
1967 return r < 0 ? r : keyslot;
1970 int crypt_activate_by_keyfile(struct crypt_device *cd,
1973 const char *keyfile,
1974 size_t keyfile_size,
1977 crypt_status_info ci;
1978 struct volume_key *vk = NULL;
1979 char *passphrase_read = NULL;
1980 size_t passphrase_size_read;
1981 unsigned int key_count = 0;
1984 log_dbg("Activating volume %s [keyslot %d] using keyfile %s.",
1985 name ?: "", keyslot, keyfile ?: "[none]");
1988 ci = crypt_status(NULL, name);
1989 if (ci == CRYPT_INVALID)
1991 else if (ci >= CRYPT_ACTIVE) {
1992 log_err(cd, _("Device %s already exists.\n"), name);
2000 if (isPLAIN(cd->type)) {
2001 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
2002 &passphrase_size_read, keyfile, keyfile_size);
2005 r = create_device_helper(cd, name, cd->plain_hdr.hash,
2006 cd->plain_cipher, cd->plain_cipher_mode,
2007 NULL, passphrase_read, passphrase_size_read,
2008 cd->volume_key->keylength, 0,
2009 cd->plain_hdr.skip, cd->plain_hdr.offset,
2011 flags & CRYPT_ACTIVATE_READONLY, 0);
2012 } else if (isLUKS(cd->type)) {
2013 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
2014 &passphrase_size_read, keyfile, keyfile_size);
2017 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
2018 passphrase_size_read, &cd->hdr, &vk, cd);
2024 r = open_from_hdr_and_vk(cd, vk, name, flags);
2029 } else if (isLOOPAES(cd->type)) {
2030 r = key_from_file(cd, NULL, &passphrase_read, &passphrase_size_read,
2031 keyfile, keyfile_size);
2034 r = LOOPAES_parse_keyfile(cd, &vk, cd->loopaes_hdr.hash, &key_count,
2035 passphrase_read, passphrase_size_read);
2039 r = LOOPAES_activate(cd, name, cd->loopaes_cipher,
2041 cd->loopaes_hdr.offset,
2042 cd->loopaes_hdr.skip,
2048 crypt_safe_free(passphrase_read);
2049 crypt_free_volume_key(vk);
2054 int crypt_activate_by_volume_key(struct crypt_device *cd,
2056 const char *volume_key,
2057 size_t volume_key_size,
2060 crypt_status_info ci;
2061 struct volume_key *vk;
2064 log_dbg("Activating volume %s by volume key.", name);
2066 /* use key directly, no hash */
2067 if (isPLAIN(cd->type)) {
2068 if (!volume_key || !volume_key_size || !cd->volume_key ||
2069 volume_key_size != cd->volume_key->keylength) {
2070 log_err(cd, _("Incorrect volume key specified for plain device.\n"));
2074 return create_device_helper(cd, name, NULL,
2075 cd->plain_cipher, cd->plain_cipher_mode, NULL, volume_key, volume_key_size,
2076 cd->volume_key->keylength, 0, cd->plain_hdr.skip,
2077 cd->plain_hdr.offset, cd->plain_uuid, flags & CRYPT_ACTIVATE_READONLY, 0);
2080 if (!isLUKS(cd->type)) {
2081 log_err(cd, _("Device type is not properly initialised.\n"));
2086 ci = crypt_status(NULL, name);
2087 if (ci == CRYPT_INVALID)
2089 else if (ci >= CRYPT_ACTIVE) {
2090 log_err(cd, _("Device %s already exists.\n"), name);
2095 /* If key is not provided, try to use internal key */
2097 if (!cd->volume_key) {
2098 log_err(cd, _("Volume key does not match the volume.\n"));
2101 volume_key_size = cd->volume_key->keylength;
2102 volume_key = cd->volume_key->key;
2105 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
2108 r = LUKS_verify_volume_key(&cd->hdr, vk);
2111 log_err(cd, _("Volume key does not match the volume.\n"));
2114 r = open_from_hdr_and_vk(cd, vk, name, flags);
2116 crypt_free_volume_key(vk);
2121 int crypt_deactivate(struct crypt_device *cd, const char *name)
2128 log_dbg("Deactivating volume %s.", name);
2130 if (!cd && dm_init(NULL, 1) < 0)
2133 switch (crypt_status(cd, name)) {
2135 r = dm_remove_device(name, 0, 0);
2138 log_err(cd, _("Device %s is busy.\n"), name);
2141 case CRYPT_INACTIVE:
2142 log_err(cd, _("Device %s is not active.\n"), name);
2146 log_err(cd, _("Invalid device %s.\n"), name);
2156 int crypt_volume_key_get(struct crypt_device *cd,
2159 size_t *volume_key_size,
2160 const char *passphrase,
2161 size_t passphrase_size)
2163 struct volume_key *vk;
2164 char *processed_key = NULL;
2168 key_len = crypt_get_volume_key_size(cd);
2169 if (key_len > *volume_key_size) {
2170 log_err(cd, _("Volume key buffer too small.\n"));
2174 if (isPLAIN(cd->type) && cd->plain_hdr.hash) {
2175 processed_key = process_key(cd, cd->plain_hdr.hash, NULL, key_len,
2176 passphrase, passphrase_size);
2177 if (!processed_key) {
2178 log_err(cd, _("Cannot retrieve volume key for plain device.\n"));
2181 memcpy(volume_key, processed_key, key_len);
2182 *volume_key_size = key_len;
2183 crypt_safe_free(processed_key);
2187 if (isLUKS(cd->type)) {
2188 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
2189 passphrase_size, &cd->hdr, &vk, cd);
2192 memcpy(volume_key, vk->key, vk->keylength);
2193 *volume_key_size = vk->keylength;
2196 crypt_free_volume_key(vk);
2200 log_err(cd, _("This operation is not supported for %s crypt device.\n"), cd->type ?: "(none)");
2204 int crypt_volume_key_verify(struct crypt_device *cd,
2205 const char *volume_key,
2206 size_t volume_key_size)
2208 struct volume_key *vk;
2211 if (!isLUKS(cd->type)) {
2212 log_err(cd, _("This operation is supported only for LUKS device.\n"));
2216 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
2220 r = LUKS_verify_volume_key(&cd->hdr, vk);
2223 log_err(cd, _("Volume key does not match the volume.\n"));
2225 crypt_free_volume_key(vk);
2230 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec)
2232 log_dbg("Timeout set to %" PRIu64 " miliseconds.", timeout_sec);
2233 cd->timeout = timeout_sec;
2236 void crypt_set_password_retry(struct crypt_device *cd, int tries)
2238 log_dbg("Password retry count set to %d.", tries);
2242 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms)
2244 log_dbg("Iteration time set to %" PRIu64 " miliseconds.", iteration_time_ms);
2245 cd->iteration_time = iteration_time_ms;
2248 void crypt_set_password_verify(struct crypt_device *cd, int password_verify)
2250 log_dbg("Password verification %s.", password_verify ? "enabled" : "disabled");
2251 cd->password_verify = password_verify ? 1 : 0;
2254 void crypt_set_rng_type(struct crypt_device *cd, int rng_type)
2257 case CRYPT_RNG_URANDOM:
2258 case CRYPT_RNG_RANDOM:
2259 log_dbg("RNG set to %d (%s).", rng_type, rng_type ? "random" : "urandom");
2260 cd->rng_type = rng_type;
2264 int crypt_get_rng_type(struct crypt_device *cd)
2269 return cd->rng_type;
2272 int crypt_memory_lock(struct crypt_device *cd, int lock)
2274 return lock ? crypt_memlock_inc(cd) : crypt_memlock_dec(cd);
2278 crypt_status_info crypt_status(struct crypt_device *cd, const char *name)
2282 if (!cd && dm_init(NULL, 1) < 0)
2283 return CRYPT_INVALID;
2285 r = dm_status_device(name);
2290 if (r < 0 && r != -ENODEV)
2291 return CRYPT_INVALID;
2294 return CRYPT_ACTIVE;
2299 return CRYPT_INACTIVE;
2302 static void hexprintICB(struct crypt_device *cd, char *d, int n)
2305 for(i = 0; i < n; i++)
2306 log_std(cd, "%02hhx ", (char)d[i]);
2309 int crypt_dump(struct crypt_device *cd)
2312 if (!isLUKS(cd->type)) { //FIXME
2313 log_err(cd, _("This operation is supported only for LUKS device.\n"));
2317 log_std(cd, "LUKS header information for %s\n\n", cd->device);
2318 log_std(cd, "Version: \t%d\n", cd->hdr.version);
2319 log_std(cd, "Cipher name: \t%s\n", cd->hdr.cipherName);
2320 log_std(cd, "Cipher mode: \t%s\n", cd->hdr.cipherMode);
2321 log_std(cd, "Hash spec: \t%s\n", cd->hdr.hashSpec);
2322 log_std(cd, "Payload offset:\t%d\n", cd->hdr.payloadOffset);
2323 log_std(cd, "MK bits: \t%d\n", cd->hdr.keyBytes * 8);
2324 log_std(cd, "MK digest: \t");
2325 hexprintICB(cd, cd->hdr.mkDigest, LUKS_DIGESTSIZE);
2327 log_std(cd, "MK salt: \t");
2328 hexprintICB(cd, cd->hdr.mkDigestSalt, LUKS_SALTSIZE/2);
2329 log_std(cd, "\n \t");
2330 hexprintICB(cd, cd->hdr.mkDigestSalt+LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
2332 log_std(cd, "MK iterations: \t%d\n", cd->hdr.mkDigestIterations);
2333 log_std(cd, "UUID: \t%s\n\n", cd->hdr.uuid);
2334 for(i = 0; i < LUKS_NUMKEYS; i++) {
2335 if(cd->hdr.keyblock[i].active == LUKS_KEY_ENABLED) {
2336 log_std(cd, "Key Slot %d: ENABLED\n",i);
2337 log_std(cd, "\tIterations: \t%d\n",
2338 cd->hdr.keyblock[i].passwordIterations);
2339 log_std(cd, "\tSalt: \t");
2340 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt,
2342 log_std(cd, "\n\t \t");
2343 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt +
2344 LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
2347 log_std(cd, "\tKey material offset:\t%d\n",
2348 cd->hdr.keyblock[i].keyMaterialOffset);
2349 log_std(cd, "\tAF stripes: \t%d\n",
2350 cd->hdr.keyblock[i].stripes);
2353 log_std(cd, "Key Slot %d: DISABLED\n", i);
2359 const char *crypt_get_cipher(struct crypt_device *cd)
2361 if (isPLAIN(cd->type))
2362 return cd->plain_cipher;
2364 if (isLUKS(cd->type))
2365 return cd->hdr.cipherName;
2367 if (isLOOPAES(cd->type))
2368 return cd->loopaes_cipher;
2373 const char *crypt_get_cipher_mode(struct crypt_device *cd)
2375 if (isPLAIN(cd->type))
2376 return cd->plain_cipher_mode;
2378 if (isLUKS(cd->type))
2379 return cd->hdr.cipherMode;
2381 if (isLOOPAES(cd->type))
2382 return cd->loopaes_cipher_mode;
2387 const char *crypt_get_uuid(struct crypt_device *cd)
2389 if (isLUKS(cd->type))
2390 return cd->hdr.uuid;
2392 if (isPLAIN(cd->type))
2393 return cd->plain_uuid;
2395 if (isLOOPAES(cd->type))
2396 return cd->loopaes_uuid;
2401 const char *crypt_get_device_name(struct crypt_device *cd)
2406 int crypt_get_volume_key_size(struct crypt_device *cd)
2408 if (isPLAIN(cd->type) && cd->volume_key)
2409 return cd->volume_key->keylength;
2411 if (isLUKS(cd->type))
2412 return cd->hdr.keyBytes;
2414 if (isLOOPAES(cd->type))
2415 return cd->loopaes_key_size;
2420 uint64_t crypt_get_data_offset(struct crypt_device *cd)
2422 if (isPLAIN(cd->type))
2423 return cd->plain_hdr.offset;
2425 if (isLUKS(cd->type))
2426 return cd->hdr.payloadOffset;
2428 if (isLOOPAES(cd->type))
2429 return cd->loopaes_hdr.offset;
2434 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot)
2436 if (!isLUKS(cd->type)) {
2437 log_err(cd, _("This operation is supported only for LUKS device.\n"));
2438 return CRYPT_SLOT_INVALID;
2441 return LUKS_keyslot_info(&cd->hdr, keyslot);
2444 int crypt_keyslot_max(const char *type)
2446 if (type && isLUKS(type))
2447 return LUKS_NUMKEYS;
2452 const char *crypt_get_type(struct crypt_device *cd)
2457 int crypt_get_active_device(struct crypt_device *cd __attribute__((unused)),
2459 struct crypt_active_device *cad)
2463 r = dm_query_device(name, NULL, &cad->size, &cad->iv_offset, &cad->offset,
2464 NULL, NULL, NULL, &readonly, NULL, NULL);
2468 cad->flags = readonly ? CRYPT_ACTIVATE_READONLY : 0;