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"));
138 static int process_key(struct crypt_device *cd, const char *hash_name,
139 size_t key_size, const char *pass, size_t passLen,
140 struct volume_key **vk)
147 *vk = crypt_alloc_volume_key(key_size, NULL);
152 r = crypt_plain_hash(cd, hash_name, (*vk)->key, key_size, pass, passLen);
155 log_err(cd, _("Hash algorithm %s not supported.\n"),
158 log_err(cd, _("Key processing error (using hash %s).\n"),
160 crypt_free_volume_key(*vk);
164 } else if (passLen > key_size) {
165 memcpy((*vk)->key, pass, key_size);
167 memcpy((*vk)->key, pass, passLen);
173 static int isPLAIN(const char *type)
175 return (type && !strcmp(CRYPT_PLAIN, type));
178 static int isLUKS(const char *type)
180 return (type && !strcmp(CRYPT_LUKS1, type));
183 static int isLOOPAES(const char *type)
185 return (type && !strcmp(CRYPT_LOOPAES, type));
188 /* keyslot helpers */
189 static int keyslot_verify_or_find_empty(struct crypt_device *cd, int *keyslot)
191 if (*keyslot == CRYPT_ANY_SLOT) {
192 *keyslot = LUKS_keyslot_find_empty(&cd->hdr);
194 log_err(cd, _("All key slots full.\n"));
199 switch (LUKS_keyslot_info(&cd->hdr, *keyslot)) {
200 case CRYPT_SLOT_INVALID:
201 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
202 *keyslot, LUKS_NUMKEYS - 1);
204 case CRYPT_SLOT_INACTIVE:
207 log_err(cd, _("Key slot %d is full, please select another one.\n"),
215 int PLAIN_activate(struct crypt_device *cd,
217 struct volume_key *vk,
222 char *dm_cipher = NULL;
223 struct crypt_dm_active_device dmd = {
224 .device = crypt_get_device_name(cd),
226 .uuid = crypt_get_uuid(cd),
228 .offset = crypt_get_data_offset(cd),
229 .iv_offset = crypt_get_iv_offset(cd),
234 r = device_check_and_adjust(cd, dmd.device,
235 (dmd.flags & CRYPT_ACTIVATE_SHARED) ? DEV_SHARED : DEV_EXCL,
236 &dmd.size, &dmd.offset, &flags);
240 if (crypt_get_cipher_mode(cd))
241 r = asprintf(&dm_cipher, "%s-%s", crypt_get_cipher(cd), crypt_get_cipher_mode(cd));
243 r = asprintf(&dm_cipher, "%s", crypt_get_cipher(cd));
247 dmd.cipher = dm_cipher;
248 log_dbg("Trying to activate PLAIN device %s using cipher %s.", name, dmd.cipher);
250 r = dm_create_device(name, CRYPT_PLAIN, &dmd, 0);
253 if (!cd->plain_uuid && dm_query_device(name, DM_ACTIVE_UUID, &dmd) >= 0)
254 cd->plain_uuid = (char*)dmd.uuid;
260 int crypt_confirm(struct crypt_device *cd, const char *msg)
262 if (!cd || !cd->confirm)
265 return cd->confirm(msg, cd->confirm_usrptr);
268 static int key_from_terminal(struct crypt_device *cd, char *msg, char **key,
269 size_t *key_len, int force_verify)
275 if(!msg && asprintf(&prompt, _("Enter passphrase for %s: "),
276 cd->backing_file ?: cd->device) < 0)
283 *key = crypt_safe_alloc(DEFAULT_PASSPHRASE_SIZE_MAX);
288 r = cd->password(msg, *key, DEFAULT_PASSPHRASE_SIZE_MAX,
289 cd->password_usrptr);
291 crypt_safe_free(*key);
296 r = crypt_get_key(msg, key, key_len, 0, NULL, cd->timeout,
297 (force_verify || cd->password_verify), cd);
300 return (r < 0) ? r: 0;
303 static int volume_key_by_terminal_passphrase(struct crypt_device *cd, int keyslot,
304 struct volume_key **vk)
306 char *passphrase_read = NULL;
307 size_t passphrase_size_read;
308 int r = -EINVAL, eperm = 0, tries = cd->tries;
312 crypt_free_volume_key(*vk);
315 r = key_from_terminal(cd, NULL, &passphrase_read,
316 &passphrase_size_read, 0);
320 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
321 passphrase_size_read, &cd->hdr, vk, cd);
324 crypt_safe_free(passphrase_read);
325 passphrase_read = NULL;
326 } while (r == -EPERM && (--tries > 0));
329 crypt_free_volume_key(*vk);
332 /* Report wrong passphrase if at least one try failed */
333 if (eperm && r == -EPIPE)
337 crypt_safe_free(passphrase_read);
341 static int key_from_file(struct crypt_device *cd, char *msg,
342 char **key, size_t *key_len,
343 const char *key_file, size_t key_size)
345 return crypt_get_key(msg, key, key_len, key_size, key_file,
349 void crypt_set_log_callback(struct crypt_device *cd,
350 void (*log)(int level, const char *msg, void *usrptr),
357 cd->log_usrptr = usrptr;
361 void crypt_set_confirm_callback(struct crypt_device *cd,
362 int (*confirm)(const char *msg, void *usrptr),
365 cd->confirm = confirm;
366 cd->confirm_usrptr = usrptr;
369 void crypt_set_password_callback(struct crypt_device *cd,
370 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
373 cd->password = password;
374 cd->password_usrptr = usrptr;
377 void crypt_get_error(char *buf, size_t size)
379 const char *error = get_error();
381 if (!buf || size < 1)
384 strncpy(buf, error, size - 1);
385 buf[size - 1] = '\0';
391 const char *crypt_get_dir(void)
396 int crypt_init(struct crypt_device **cd, const char *device)
398 struct crypt_device *h = NULL;
404 log_dbg("Allocating crypt device %s context.", device);
406 if (!(h = malloc(sizeof(struct crypt_device))))
409 memset(h, 0, sizeof(*h));
413 r = device_ready(NULL, device, O_RDONLY);
415 h->device = crypt_loop_get_device();
416 log_dbg("Not a block device, %s%s.",
417 h->device ? "using free loop device " :
418 "no free loop device found",
421 log_err(NULL, _("Cannot find a free loopback device.\n"));
426 /* Keep the loop open, dettached on last close. */
427 h->loop_fd = crypt_loop_attach(h->device, device, 0, 1, &readonly);
428 if (h->loop_fd == -1) {
429 log_err(NULL, _("Attaching loopback device failed "
430 "(loop device with autoclear flag is required).\n"));
435 h->backing_file = crypt_loop_backing_file(h->device);
436 r = device_ready(NULL, h->device, O_RDONLY);
444 if (!h->device && device && !(h->device = strdup(device))) {
449 if (dm_init(h, 1) < 0) {
454 h->iteration_time = 1000;
455 h->password_verify = 0;
457 h->rng_type = crypt_random_default_key_rng();
463 if (h->loop_fd != -1)
466 free(h->backing_file);
472 int crypt_init_by_name(struct crypt_device **cd, const char *name)
474 crypt_status_info ci;
475 struct crypt_dm_active_device dmd;
476 char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
480 log_dbg("Allocating crypt device context by device %s.", name);
482 ci = crypt_status(NULL, name);
483 if (ci == CRYPT_INVALID)
486 if (ci < CRYPT_ACTIVE) {
487 log_err(NULL, _("Device %s is not active.\n"), name);
491 r = dm_query_device(name, DM_ACTIVE_DEVICE | DM_ACTIVE_CIPHER |
492 DM_ACTIVE_UUID | DM_ACTIVE_KEYSIZE, &dmd);
497 r = crypt_init(cd, dmd.device);
499 /* Underlying device disappeared but mapping still active */
500 if (!dmd.device || r == -ENOTBLK)
501 log_verbose(NULL, _("Underlying device for crypt device %s disappeared.\n"),
504 /* Underlying device is not readable but crypt mapping exists */
506 free((char*)dmd.device);
508 r = crypt_init(cd, NULL);
514 /* Try to initialise basic parameters from active device */
516 if (!(*cd)->backing_file && dmd.device && crypt_loop_device(dmd.device) &&
517 !((*cd)->backing_file = crypt_loop_backing_file(dmd.device))) {
523 if (!strncmp(CRYPT_PLAIN, dmd.uuid, sizeof(CRYPT_PLAIN)-1)) {
524 (*cd)->type = strdup(CRYPT_PLAIN);
525 (*cd)->plain_uuid = strdup(dmd.uuid);
526 (*cd)->plain_hdr.hash = NULL; /* no way to get this */
527 (*cd)->plain_hdr.offset = dmd.offset;
528 (*cd)->plain_hdr.skip = dmd.iv_offset;
530 r = crypt_parse_name_and_mode(dmd.cipher, cipher, NULL, cipher_mode);
532 (*cd)->plain_cipher = strdup(cipher);
533 (*cd)->plain_cipher_mode = strdup(cipher_mode);
535 } else if (!strncmp(CRYPT_LOOPAES, dmd.uuid, sizeof(CRYPT_LOOPAES)-1)) {
536 (*cd)->type = strdup(CRYPT_LOOPAES);
537 (*cd)->loopaes_uuid = strdup(dmd.uuid);
538 (*cd)->loopaes_hdr.offset = dmd.offset;
540 r = crypt_parse_name_and_mode(dmd.cipher, cipher,
541 &key_nums, cipher_mode);
543 (*cd)->loopaes_cipher = strdup(cipher);
544 (*cd)->loopaes_cipher_mode = strdup(cipher_mode);
545 /* version 3 uses last key for IV */
546 if (dmd.vk->keylength % key_nums)
548 (*cd)->loopaes_key_size = dmd.vk->keylength / key_nums;
550 } else if (!strncmp(CRYPT_LUKS1, dmd.uuid, sizeof(CRYPT_LUKS1)-1)) {
552 r = crypt_load(*cd, CRYPT_LUKS1, NULL);
554 log_dbg("LUKS device header does not match active device.");
555 /* initialise empty context */
561 log_dbg("Active device has no UUID set, some parameters are not set.");
568 crypt_free_volume_key(dmd.vk);
569 free((char*)dmd.device);
570 free((char*)dmd.cipher);
571 free((char*)dmd.uuid);
575 static int _crypt_format_plain(struct crypt_device *cd,
577 const char *cipher_mode,
579 size_t volume_key_size,
580 struct crypt_params_plain *params)
582 if (!cipher || !cipher_mode) {
583 log_err(cd, _("Invalid plain crypt parameters.\n"));
587 if (volume_key_size > 1024) {
588 log_err(cd, _("Invalid key size.\n"));
592 cd->volume_key = crypt_alloc_volume_key(volume_key_size, NULL);
596 cd->plain_cipher = strdup(cipher);
597 cd->plain_cipher_mode = strdup(cipher_mode);
600 cd->plain_uuid = strdup(uuid);
602 if (params && params->hash)
603 cd->plain_hdr.hash = strdup(params->hash);
605 cd->plain_hdr.offset = params ? params->offset : 0;
606 cd->plain_hdr.skip = params ? params->skip : 0;
607 cd->plain_hdr.size = params ? params->size : 0;
609 if (!cd->plain_cipher || !cd->plain_cipher_mode)
615 static int _crypt_format_luks1(struct crypt_device *cd,
617 const char *cipher_mode,
619 const char *volume_key,
620 size_t volume_key_size,
621 struct crypt_params_luks1 *params)
624 unsigned long required_alignment = DEFAULT_DISK_ALIGNMENT;
625 unsigned long alignment_offset = 0;
628 log_err(cd, _("Can't format LUKS without device.\n"));
633 cd->volume_key = crypt_alloc_volume_key(volume_key_size,
636 cd->volume_key = crypt_generate_volume_key(cd, volume_key_size);
641 if (params && params->data_alignment)
642 required_alignment = params->data_alignment * SECTOR_SIZE;
644 get_topology_alignment(cd->device, &required_alignment,
645 &alignment_offset, DEFAULT_DISK_ALIGNMENT);
647 r = LUKS_generate_phdr(&cd->hdr, cd->volume_key, cipher, cipher_mode,
648 (params && params->hash) ? params->hash : "sha1",
650 required_alignment / SECTOR_SIZE,
651 alignment_offset / SECTOR_SIZE,
652 cd->iteration_time, &cd->PBKDF2_per_sec, cd);
656 /* Wipe first 8 sectors - fs magic numbers etc. */
657 r = wipe_device_header(cd->device, 8);
660 log_err(cd, _("Cannot format device %s which is still in use.\n"),
663 log_err(cd, _("Cannot wipe header on device %s.\n"),
669 r = LUKS_write_phdr(cd->device, &cd->hdr, cd);
674 static int _crypt_format_loopaes(struct crypt_device *cd,
677 size_t volume_key_size,
678 struct crypt_params_loopaes *params)
681 log_err(cd, _("Can't format LOOPAES without device.\n"));
685 if (volume_key_size > 1024) {
686 log_err(cd, _("Invalid key size.\n"));
690 cd->loopaes_key_size = volume_key_size;
692 cd->loopaes_cipher = strdup(cipher ?: DEFAULT_LOOPAES_CIPHER);
695 cd->loopaes_uuid = strdup(uuid);
697 if (params && params->hash)
698 cd->loopaes_hdr.hash = strdup(params->hash);
700 cd->loopaes_hdr.offset = params ? params->offset : 0;
701 cd->loopaes_hdr.skip = params ? params->skip : 0;
706 int crypt_format(struct crypt_device *cd,
709 const char *cipher_mode,
711 const char *volume_key,
712 size_t volume_key_size,
720 log_dbg("Formatting device %s as type %s.", cd->device ?: "(none)", type);
727 r = _crypt_format_plain(cd, cipher, cipher_mode,
728 uuid, volume_key_size, params);
729 else if (isLUKS(type))
730 r = _crypt_format_luks1(cd, cipher, cipher_mode,
731 uuid, volume_key, volume_key_size, params);
732 else if (isLOOPAES(type))
733 r = _crypt_format_loopaes(cd, cipher, uuid, volume_key_size, params);
735 /* FIXME: allow plugins here? */
736 log_err(cd, _("Unknown crypt device type %s requested.\n"), type);
740 if (!r && !(cd->type = strdup(type)))
744 crypt_free_volume_key(cd->volume_key);
745 cd->volume_key = NULL;
751 int crypt_load(struct crypt_device *cd,
752 const char *requested_type,
753 void *params __attribute__((unused)))
755 struct luks_phdr hdr;
758 log_dbg("Trying to load %s crypt type from device %s.",
759 requested_type ?: "any", cd->device ?: "(none)");
764 if (requested_type && !isLUKS(requested_type))
771 r = LUKS_read_phdr(cd->device, &hdr, 1, cd);
774 memcpy(&cd->hdr, &hdr, sizeof(hdr));
775 cd->type = strdup(CRYPT_LUKS1);
783 int crypt_resize(struct crypt_device *cd, const char *name, uint64_t new_size)
785 struct crypt_dm_active_device dmd;
788 /* Device context type must be initialised */
789 if (!cd->type || !crypt_get_uuid(cd))
792 log_dbg("Resizing device %s to %" PRIu64 " sectors.", name, new_size);
794 r = dm_query_device(name, DM_ACTIVE_DEVICE | DM_ACTIVE_CIPHER |
795 DM_ACTIVE_UUID | DM_ACTIVE_KEYSIZE |
796 DM_ACTIVE_KEY, &dmd);
798 log_err(NULL, _("Device %s is not active.\n"), name);
807 r = device_check_and_adjust(cd, dmd.device, DEV_OK, &new_size, &dmd.offset, &dmd.flags);
811 if (new_size == dmd.size) {
812 log_dbg("Device has already requested size %" PRIu64
813 " sectors.", dmd.size);
817 r = dm_create_device(name, cd->type, &dmd, 1);
820 crypt_free_volume_key(dmd.vk);
821 free((char*)dmd.cipher);
822 free((char*)dmd.device);
823 free((char*)dmd.uuid);
828 int crypt_set_uuid(struct crypt_device *cd, const char *uuid)
830 if (!isLUKS(cd->type)) {
831 log_err(cd, _("This operation is not supported for this device type.\n"));
835 if (uuid && !strncmp(uuid, cd->hdr.uuid, sizeof(cd->hdr.uuid))) {
836 log_dbg("UUID is the same as requested (%s) for device %s.",
842 log_dbg("Requested new UUID change to %s for %s.", uuid, cd->device);
844 log_dbg("Requested new UUID refresh for %s.", cd->device);
846 if (!crypt_confirm(cd, _("Do you really want to change UUID of device?")))
849 return LUKS_hdr_uuid_set(cd->device, &cd->hdr, uuid, cd);
852 int crypt_header_backup(struct crypt_device *cd,
853 const char *requested_type,
854 const char *backup_file)
858 if ((requested_type && !isLUKS(requested_type)) || !backup_file)
865 log_dbg("Requested header backup of device %s (%s) to "
866 "file %s.", cd->device, requested_type, backup_file);
868 return LUKS_hdr_backup(backup_file, cd->device, &cd->hdr, cd);
871 int crypt_header_restore(struct crypt_device *cd,
872 const char *requested_type,
873 const char *backup_file)
877 if (requested_type && !isLUKS(requested_type))
880 /* Some hash functions need initialized gcrypt library */
885 log_dbg("Requested header restore to device %s (%s) from "
886 "file %s.", cd->device, requested_type, backup_file);
888 return LUKS_hdr_restore(backup_file, cd->device, &cd->hdr, cd);
891 void crypt_free(struct crypt_device *cd)
894 log_dbg("Releasing crypt device %s context.", cd->device);
896 if (cd->loop_fd != -1)
900 crypt_free_volume_key(cd->volume_key);
903 free(cd->backing_file);
906 /* used in plain device only */
907 free((char*)cd->plain_hdr.hash);
908 free(cd->plain_cipher);
909 free(cd->plain_cipher_mode);
910 free(cd->plain_uuid);
912 /* used in loop-AES device only */
913 free((char*)cd->loopaes_hdr.hash);
914 free(cd->loopaes_cipher);
915 free(cd->loopaes_uuid);
921 int crypt_suspend(struct crypt_device *cd,
924 crypt_status_info ci;
927 log_dbg("Suspending volume %s.", name);
929 if (!isLUKS(cd->type)) {
930 log_err(cd, _("This operation is supported only for LUKS device.\n"));
935 ci = crypt_status(NULL, name);
936 if (ci < CRYPT_ACTIVE) {
937 log_err(cd, _("Volume %s is not active.\n"), name);
941 if (!cd && dm_init(NULL, 1) < 0)
944 r = dm_status_suspended(name);
949 log_err(cd, _("Volume %s is already suspended.\n"), name);
954 r = dm_suspend_and_wipe_key(name);
956 log_err(cd, "Suspend is not supported for device %s.\n", name);
958 log_err(cd, "Error during suspending device %s.\n", name);
965 int crypt_resume_by_passphrase(struct crypt_device *cd,
968 const char *passphrase,
969 size_t passphrase_size)
971 struct volume_key *vk = NULL;
974 log_dbg("Resuming volume %s.", name);
976 if (!isLUKS(cd->type)) {
977 log_err(cd, _("This operation is supported only for LUKS device.\n"));
982 r = dm_status_suspended(name);
987 log_err(cd, _("Volume %s is not suspended.\n"), name);
992 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
993 passphrase_size, &cd->hdr, &vk, cd);
995 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
999 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1001 log_err(cd, "Resume is not supported for device %s.\n", name);
1003 log_err(cd, "Error during resuming device %s.\n", name);
1007 crypt_free_volume_key(vk);
1008 return r < 0 ? r : keyslot;
1011 int crypt_resume_by_keyfile(struct crypt_device *cd,
1014 const char *keyfile,
1015 size_t keyfile_size)
1017 struct volume_key *vk = NULL;
1018 char *passphrase_read = NULL;
1019 size_t passphrase_size_read;
1022 log_dbg("Resuming volume %s.", name);
1024 if (!isLUKS(cd->type)) {
1025 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1030 r = dm_status_suspended(name);
1035 log_err(cd, _("Volume %s is not suspended.\n"), name);
1042 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1043 &passphrase_size_read, keyfile, keyfile_size);
1047 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
1048 passphrase_size_read, &cd->hdr, &vk, cd);
1053 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1055 log_err(cd, "Error during resuming device %s.\n", name);
1057 crypt_safe_free(passphrase_read);
1058 crypt_free_volume_key(vk);
1059 return r < 0 ? r : keyslot;
1062 // slot manipulation
1063 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
1064 int keyslot, // -1 any
1065 const char *passphrase, // NULL -> terminal
1066 size_t passphrase_size,
1067 const char *new_passphrase, // NULL -> terminal
1068 size_t new_passphrase_size)
1070 struct volume_key *vk = NULL;
1071 char *password = NULL, *new_password = NULL;
1072 size_t passwordLen, new_passwordLen;
1075 log_dbg("Adding new keyslot, existing passphrase %sprovided,"
1076 "new passphrase %sprovided.",
1077 passphrase ? "" : "not ", new_passphrase ? "" : "not ");
1079 if (!isLUKS(cd->type)) {
1080 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1084 r = keyslot_verify_or_find_empty(cd, &keyslot);
1088 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1089 /* No slots used, try to use pre-generated key in header */
1090 if (cd->volume_key) {
1091 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1092 r = vk ? 0 : -ENOMEM;
1094 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1097 } else if (passphrase) {
1098 /* Passphrase provided, use it to unlock existing keyslot */
1099 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, passphrase,
1100 passphrase_size, &cd->hdr, &vk, cd);
1102 /* Passphrase not provided, ask first and use it to unlock existing keyslot */
1103 r = key_from_terminal(cd, _("Enter any passphrase: "),
1104 &password, &passwordLen, 0);
1108 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password,
1109 passwordLen, &cd->hdr, &vk, cd);
1110 crypt_safe_free(password);
1116 if (new_passphrase) {
1117 new_password = (char *)new_passphrase;
1118 new_passwordLen = new_passphrase_size;
1120 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1121 &new_password, &new_passwordLen, 1);
1126 r = LUKS_set_key(cd->device, keyslot, new_password, new_passwordLen,
1127 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1132 if (!new_passphrase)
1133 crypt_safe_free(new_password);
1134 crypt_free_volume_key(vk);
1135 return r ?: keyslot;
1138 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
1140 const char *keyfile,
1141 size_t keyfile_size,
1142 const char *new_keyfile,
1143 size_t new_keyfile_size)
1145 struct volume_key *vk = NULL;
1146 char *password = NULL; size_t passwordLen;
1147 char *new_password = NULL; size_t new_passwordLen;
1150 log_dbg("Adding new keyslot, existing keyfile %s, new keyfile %s.",
1151 keyfile ?: "[none]", new_keyfile ?: "[none]");
1153 if (!isLUKS(cd->type)) {
1154 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1158 r = keyslot_verify_or_find_empty(cd, &keyslot);
1162 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1163 /* No slots used, try to use pre-generated key in header */
1164 if (cd->volume_key) {
1165 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1166 r = vk ? 0 : -ENOMEM;
1168 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1172 /* Read password from file of (if NULL) from terminal */
1174 r = key_from_file(cd, _("Enter any passphrase: "),
1175 &password, &passwordLen,
1176 keyfile, keyfile_size);
1178 r = key_from_terminal(cd, _("Enter any passphrase: "),
1179 &password, &passwordLen, 0);
1183 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password, passwordLen,
1191 r = key_from_file(cd, _("Enter new passphrase for key slot: "),
1192 &new_password, &new_passwordLen, new_keyfile,
1195 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1196 &new_password, &new_passwordLen, 1);
1200 r = LUKS_set_key(cd->device, keyslot, new_password, new_passwordLen,
1201 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1203 crypt_safe_free(password);
1204 crypt_safe_free(new_password);
1205 crypt_free_volume_key(vk);
1206 return r < 0 ? r : keyslot;
1209 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
1211 const char *volume_key,
1212 size_t volume_key_size,
1213 const char *passphrase,
1214 size_t passphrase_size)
1216 struct volume_key *vk = NULL;
1218 char *new_password = NULL; size_t new_passwordLen;
1220 log_dbg("Adding new keyslot %d using volume key.", keyslot);
1222 if (!isLUKS(cd->type)) {
1223 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1228 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1229 else if (cd->volume_key)
1230 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1235 r = LUKS_verify_volume_key(&cd->hdr, vk);
1237 log_err(cd, _("Volume key does not match the volume.\n"));
1241 r = keyslot_verify_or_find_empty(cd, &keyslot);
1246 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1247 &new_password, &new_passwordLen, 1);
1250 passphrase = new_password;
1251 passphrase_size = new_passwordLen;
1254 r = LUKS_set_key(cd->device, keyslot, passphrase, passphrase_size,
1255 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1257 crypt_safe_free(new_password);
1258 crypt_free_volume_key(vk);
1259 return (r < 0) ? r : keyslot;
1262 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot)
1264 crypt_keyslot_info ki;
1266 log_dbg("Destroying keyslot %d.", keyslot);
1268 if (!isLUKS(cd->type)) {
1269 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1273 ki = crypt_keyslot_status(cd, keyslot);
1274 if (ki == CRYPT_SLOT_INVALID) {
1275 log_err(cd, _("Key slot %d is invalid.\n"), keyslot);
1279 if (ki == CRYPT_SLOT_INACTIVE) {
1280 log_err(cd, _("Key slot %d is not used.\n"), keyslot);
1284 return LUKS_del_key(cd->device, keyslot, &cd->hdr, cd);
1287 // activation/deactivation of device mapping
1288 int crypt_activate_by_passphrase(struct crypt_device *cd,
1291 const char *passphrase,
1292 size_t passphrase_size,
1295 crypt_status_info ci;
1296 struct volume_key *vk = NULL;
1297 char *read_passphrase = NULL;
1298 size_t passphraseLen = 0;
1301 log_dbg("%s volume %s [keyslot %d] using %spassphrase.",
1302 name ? "Activating" : "Checking", name ?: "",
1303 keyslot, passphrase ? "" : "[none] ");
1306 ci = crypt_status(NULL, name);
1307 if (ci == CRYPT_INVALID)
1309 else if (ci >= CRYPT_ACTIVE) {
1310 log_err(cd, _("Device %s already exists.\n"), name);
1315 /* plain, use hashed passphrase */
1316 if (isPLAIN(cd->type)) {
1321 r = key_from_terminal(cd, NULL, &read_passphrase,
1325 passphrase = read_passphrase;
1326 passphrase_size = passphraseLen;
1329 r = process_key(cd, cd->plain_hdr.hash,
1330 cd->volume_key->keylength,
1331 passphrase, passphrase_size, &vk);
1335 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1337 } else if (isLUKS(cd->type)) {
1338 /* provided passphrase, do not retry */
1340 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1341 passphrase_size, &cd->hdr, &vk, cd);
1343 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1348 r = LUKS1_activate(cd, name, vk, flags);
1353 crypt_safe_free(read_passphrase);
1354 crypt_free_volume_key(vk);
1356 return r < 0 ? r : keyslot;
1359 int crypt_activate_by_keyfile(struct crypt_device *cd,
1362 const char *keyfile,
1363 size_t keyfile_size,
1366 crypt_status_info ci;
1367 struct volume_key *vk = NULL;
1368 char *passphrase_read = NULL;
1369 size_t passphrase_size_read;
1370 unsigned int key_count = 0;
1373 log_dbg("Activating volume %s [keyslot %d] using keyfile %s.",
1374 name ?: "", keyslot, keyfile ?: "[none]");
1377 ci = crypt_status(NULL, name);
1378 if (ci == CRYPT_INVALID)
1380 else if (ci >= CRYPT_ACTIVE) {
1381 log_err(cd, _("Device %s already exists.\n"), name);
1389 if (isPLAIN(cd->type)) {
1393 r = key_from_file(cd, _("Enter passphrase: "),
1394 &passphrase_read, &passphrase_size_read,
1395 keyfile, keyfile_size);
1399 r = process_key(cd, cd->plain_hdr.hash,
1400 cd->volume_key->keylength,
1401 passphrase_read, passphrase_size_read, &vk);
1405 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1406 } else if (isLUKS(cd->type)) {
1407 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1408 &passphrase_size_read, keyfile, keyfile_size);
1411 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
1412 passphrase_size_read, &cd->hdr, &vk, cd);
1418 r = LUKS1_activate(cd, name, vk, flags);
1423 } else if (isLOOPAES(cd->type)) {
1424 r = key_from_file(cd, NULL, &passphrase_read, &passphrase_size_read,
1425 keyfile, keyfile_size);
1428 r = LOOPAES_parse_keyfile(cd, &vk, cd->loopaes_hdr.hash, &key_count,
1429 passphrase_read, passphrase_size_read);
1433 r = LOOPAES_activate(cd, name, cd->loopaes_cipher,
1434 key_count, vk, flags);
1439 crypt_safe_free(passphrase_read);
1440 crypt_free_volume_key(vk);
1445 int crypt_activate_by_volume_key(struct crypt_device *cd,
1447 const char *volume_key,
1448 size_t volume_key_size,
1451 crypt_status_info ci;
1452 struct volume_key *vk = NULL;
1455 log_dbg("Activating volume %s by volume key.", name);
1458 ci = crypt_status(NULL, name);
1459 if (ci == CRYPT_INVALID)
1461 else if (ci >= CRYPT_ACTIVE) {
1462 log_err(cd, _("Device %s already exists.\n"), name);
1467 /* use key directly, no hash */
1468 if (isPLAIN(cd->type)) {
1472 if (!volume_key || !volume_key_size || !cd->volume_key ||
1473 volume_key_size != cd->volume_key->keylength) {
1474 log_err(cd, _("Incorrect volume key specified for plain device.\n"));
1478 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1482 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1483 } else if (isLUKS(cd->type)) {
1484 /* If key is not provided, try to use internal key */
1486 if (!cd->volume_key) {
1487 log_err(cd, _("Volume key does not match the volume.\n"));
1490 volume_key_size = cd->volume_key->keylength;
1491 volume_key = cd->volume_key->key;
1494 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1497 r = LUKS_verify_volume_key(&cd->hdr, vk);
1500 log_err(cd, _("Volume key does not match the volume.\n"));
1503 r = LUKS1_activate(cd, name, vk, flags);
1505 log_err(cd, _("Device type is not properly initialised.\n"));
1507 crypt_free_volume_key(vk);
1512 int crypt_deactivate(struct crypt_device *cd, const char *name)
1519 log_dbg("Deactivating volume %s.", name);
1521 if (!cd && dm_init(NULL, 1) < 0)
1524 switch (crypt_status(cd, name)) {
1526 r = dm_remove_device(name, 0, 0);
1529 log_err(cd, _("Device %s is busy.\n"), name);
1532 case CRYPT_INACTIVE:
1533 log_err(cd, _("Device %s is not active.\n"), name);
1537 log_err(cd, _("Invalid device %s.\n"), name);
1547 int crypt_volume_key_get(struct crypt_device *cd,
1550 size_t *volume_key_size,
1551 const char *passphrase,
1552 size_t passphrase_size)
1554 struct volume_key *vk = NULL;
1558 key_len = crypt_get_volume_key_size(cd);
1559 if (key_len > *volume_key_size) {
1560 log_err(cd, _("Volume key buffer too small.\n"));
1564 if (isPLAIN(cd->type) && cd->plain_hdr.hash) {
1565 r = process_key(cd, cd->plain_hdr.hash, key_len,
1566 passphrase, passphrase_size, &vk);
1568 log_err(cd, _("Cannot retrieve volume key for plain device.\n"));
1569 } else if (isLUKS(cd->type)) {
1570 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1571 passphrase_size, &cd->hdr, &vk, cd);
1574 log_err(cd, _("This operation is not supported for %s crypt device.\n"), cd->type ?: "(none)");
1577 memcpy(volume_key, vk->key, vk->keylength);
1578 *volume_key_size = vk->keylength;
1581 crypt_free_volume_key(vk);
1585 int crypt_volume_key_verify(struct crypt_device *cd,
1586 const char *volume_key,
1587 size_t volume_key_size)
1589 struct volume_key *vk;
1592 if (!isLUKS(cd->type)) {
1593 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1597 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1601 r = LUKS_verify_volume_key(&cd->hdr, vk);
1604 log_err(cd, _("Volume key does not match the volume.\n"));
1606 crypt_free_volume_key(vk);
1611 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec)
1613 log_dbg("Timeout set to %" PRIu64 " miliseconds.", timeout_sec);
1614 cd->timeout = timeout_sec;
1617 void crypt_set_password_retry(struct crypt_device *cd, int tries)
1619 log_dbg("Password retry count set to %d.", tries);
1623 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms)
1625 log_dbg("Iteration time set to %" PRIu64 " miliseconds.", iteration_time_ms);
1626 cd->iteration_time = iteration_time_ms;
1629 void crypt_set_password_verify(struct crypt_device *cd, int password_verify)
1631 log_dbg("Password verification %s.", password_verify ? "enabled" : "disabled");
1632 cd->password_verify = password_verify ? 1 : 0;
1635 void crypt_set_rng_type(struct crypt_device *cd, int rng_type)
1638 case CRYPT_RNG_URANDOM:
1639 case CRYPT_RNG_RANDOM:
1640 log_dbg("RNG set to %d (%s).", rng_type, rng_type ? "random" : "urandom");
1641 cd->rng_type = rng_type;
1645 int crypt_get_rng_type(struct crypt_device *cd)
1650 return cd->rng_type;
1653 int crypt_memory_lock(struct crypt_device *cd, int lock)
1655 return lock ? crypt_memlock_inc(cd) : crypt_memlock_dec(cd);
1659 crypt_status_info crypt_status(struct crypt_device *cd, const char *name)
1663 if (!cd && dm_init(NULL, 1) < 0)
1664 return CRYPT_INVALID;
1666 r = dm_status_device(name);
1671 if (r < 0 && r != -ENODEV)
1672 return CRYPT_INVALID;
1675 return CRYPT_ACTIVE;
1680 return CRYPT_INACTIVE;
1683 static void hexprintICB(struct crypt_device *cd, char *d, int n)
1686 for(i = 0; i < n; i++)
1687 log_std(cd, "%02hhx ", (char)d[i]);
1690 int crypt_dump(struct crypt_device *cd)
1693 if (!isLUKS(cd->type)) { //FIXME
1694 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1698 log_std(cd, "LUKS header information for %s\n\n", cd->device);
1699 log_std(cd, "Version: \t%d\n", cd->hdr.version);
1700 log_std(cd, "Cipher name: \t%s\n", cd->hdr.cipherName);
1701 log_std(cd, "Cipher mode: \t%s\n", cd->hdr.cipherMode);
1702 log_std(cd, "Hash spec: \t%s\n", cd->hdr.hashSpec);
1703 log_std(cd, "Payload offset:\t%d\n", cd->hdr.payloadOffset);
1704 log_std(cd, "MK bits: \t%d\n", cd->hdr.keyBytes * 8);
1705 log_std(cd, "MK digest: \t");
1706 hexprintICB(cd, cd->hdr.mkDigest, LUKS_DIGESTSIZE);
1708 log_std(cd, "MK salt: \t");
1709 hexprintICB(cd, cd->hdr.mkDigestSalt, LUKS_SALTSIZE/2);
1710 log_std(cd, "\n \t");
1711 hexprintICB(cd, cd->hdr.mkDigestSalt+LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1713 log_std(cd, "MK iterations: \t%d\n", cd->hdr.mkDigestIterations);
1714 log_std(cd, "UUID: \t%s\n\n", cd->hdr.uuid);
1715 for(i = 0; i < LUKS_NUMKEYS; i++) {
1716 if(cd->hdr.keyblock[i].active == LUKS_KEY_ENABLED) {
1717 log_std(cd, "Key Slot %d: ENABLED\n",i);
1718 log_std(cd, "\tIterations: \t%d\n",
1719 cd->hdr.keyblock[i].passwordIterations);
1720 log_std(cd, "\tSalt: \t");
1721 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt,
1723 log_std(cd, "\n\t \t");
1724 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt +
1725 LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1728 log_std(cd, "\tKey material offset:\t%d\n",
1729 cd->hdr.keyblock[i].keyMaterialOffset);
1730 log_std(cd, "\tAF stripes: \t%d\n",
1731 cd->hdr.keyblock[i].stripes);
1734 log_std(cd, "Key Slot %d: DISABLED\n", i);
1740 const char *crypt_get_cipher(struct crypt_device *cd)
1742 if (isPLAIN(cd->type))
1743 return cd->plain_cipher;
1745 if (isLUKS(cd->type))
1746 return cd->hdr.cipherName;
1748 if (isLOOPAES(cd->type))
1749 return cd->loopaes_cipher;
1754 const char *crypt_get_cipher_mode(struct crypt_device *cd)
1756 if (isPLAIN(cd->type))
1757 return cd->plain_cipher_mode;
1759 if (isLUKS(cd->type))
1760 return cd->hdr.cipherMode;
1762 if (isLOOPAES(cd->type))
1763 return cd->loopaes_cipher_mode;
1768 const char *crypt_get_uuid(struct crypt_device *cd)
1770 if (isLUKS(cd->type))
1771 return cd->hdr.uuid;
1773 if (isPLAIN(cd->type))
1774 return cd->plain_uuid;
1776 if (isLOOPAES(cd->type))
1777 return cd->loopaes_uuid;
1782 const char *crypt_get_device_name(struct crypt_device *cd)
1787 int crypt_get_volume_key_size(struct crypt_device *cd)
1789 if (isPLAIN(cd->type) && cd->volume_key)
1790 return cd->volume_key->keylength;
1792 if (isLUKS(cd->type))
1793 return cd->hdr.keyBytes;
1795 if (isLOOPAES(cd->type))
1796 return cd->loopaes_key_size;
1801 uint64_t crypt_get_data_offset(struct crypt_device *cd)
1803 if (isPLAIN(cd->type))
1804 return cd->plain_hdr.offset;
1806 if (isLUKS(cd->type))
1807 return cd->hdr.payloadOffset;
1809 if (isLOOPAES(cd->type))
1810 return cd->loopaes_hdr.offset;
1815 uint64_t crypt_get_iv_offset(struct crypt_device *cd)
1817 if (isPLAIN(cd->type))
1818 return cd->plain_hdr.skip;
1820 if (isLUKS(cd->type))
1823 if (isLOOPAES(cd->type))
1824 return cd->loopaes_hdr.skip;
1829 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot)
1831 if (!isLUKS(cd->type)) {
1832 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1833 return CRYPT_SLOT_INVALID;
1836 return LUKS_keyslot_info(&cd->hdr, keyslot);
1839 int crypt_keyslot_max(const char *type)
1841 if (type && isLUKS(type))
1842 return LUKS_NUMKEYS;
1847 const char *crypt_get_type(struct crypt_device *cd)
1852 int crypt_get_active_device(struct crypt_device *cd __attribute__((unused)),
1854 struct crypt_active_device *cad)
1856 struct crypt_dm_active_device dmd;
1859 r = dm_query_device(name, 0, &dmd);
1863 cad->offset = dmd.offset;
1864 cad->iv_offset = dmd.iv_offset;
1865 cad->size = dmd.size;
1866 cad->flags = dmd.flags;