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"
39 char *metadata_device;
43 struct volume_key *volume_key;
45 uint64_t iteration_time;
50 /* used in CRYPT_LUKS1 */
52 uint64_t PBKDF2_per_sec;
54 /* used in CRYPT_PLAIN */
55 struct crypt_params_plain plain_hdr;
57 char *plain_cipher_mode;
60 /* used in CRYPT_LOOPAES */
61 struct crypt_params_loopaes loopaes_hdr;
63 char *loopaes_cipher_mode;
65 unsigned int loopaes_key_size;
67 /* callbacks definitions */
68 void (*log)(int level, const char *msg, void *usrptr);
70 int (*confirm)(const char *msg, void *usrptr);
72 int (*password)(const char *msg, char *buf, size_t length, void *usrptr);
73 void *password_usrptr;
77 static void (*_default_log)(int level, const char *msg, void *usrptr) = NULL;
78 static int _debug_level = 0;
80 void crypt_set_debug_level(int level)
85 int crypt_get_debug_level(void)
90 void crypt_log(struct crypt_device *cd, int level, const char *msg)
93 cd->log(level, msg, cd->log_usrptr);
94 else if (_default_log)
95 _default_log(level, msg, NULL);
98 __attribute__((format(printf, 5, 6)))
99 void logger(struct crypt_device *cd, int level, const char *file,
100 int line, const char *format, ...)
105 va_start(argp, format);
107 if (vasprintf(&target, format, argp) > 0) {
109 crypt_log(cd, level, target);
111 } else if (_debug_level)
112 printf("# %s:%d %s\n", file ?: "?", line, target);
114 } else if (_debug_level)
115 printf("# %s\n", target);
123 static const char *mdata_device(struct crypt_device *cd)
125 return cd->metadata_device ?: cd->device;
128 static int init_crypto(struct crypt_device *ctx)
132 r = crypt_random_init(ctx);
134 log_err(ctx, _("Cannot initialize crypto RNG backend.\n"));
138 r = crypt_backend_init(ctx);
140 log_err(ctx, _("Cannot initialize crypto backend.\n"));
145 static int process_key(struct crypt_device *cd, const char *hash_name,
146 size_t key_size, const char *pass, size_t passLen,
147 struct volume_key **vk)
154 *vk = crypt_alloc_volume_key(key_size, NULL);
159 r = crypt_plain_hash(cd, hash_name, (*vk)->key, key_size, pass, passLen);
162 log_err(cd, _("Hash algorithm %s not supported.\n"),
165 log_err(cd, _("Key processing error (using hash %s).\n"),
167 crypt_free_volume_key(*vk);
171 } else if (passLen > key_size) {
172 memcpy((*vk)->key, pass, key_size);
174 memcpy((*vk)->key, pass, passLen);
180 static int isPLAIN(const char *type)
182 return (type && !strcmp(CRYPT_PLAIN, type));
185 static int isLUKS(const char *type)
187 return (type && !strcmp(CRYPT_LUKS1, type));
190 static int isLOOPAES(const char *type)
192 return (type && !strcmp(CRYPT_LOOPAES, type));
195 /* keyslot helpers */
196 static int keyslot_verify_or_find_empty(struct crypt_device *cd, int *keyslot)
198 if (*keyslot == CRYPT_ANY_SLOT) {
199 *keyslot = LUKS_keyslot_find_empty(&cd->hdr);
201 log_err(cd, _("All key slots full.\n"));
206 switch (LUKS_keyslot_info(&cd->hdr, *keyslot)) {
207 case CRYPT_SLOT_INVALID:
208 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
209 *keyslot, LUKS_NUMKEYS - 1);
211 case CRYPT_SLOT_INACTIVE:
214 log_err(cd, _("Key slot %d is full, please select another one.\n"),
222 int PLAIN_activate(struct crypt_device *cd,
224 struct volume_key *vk,
229 char *dm_cipher = NULL;
230 struct crypt_dm_active_device dmd = {
231 .device = crypt_get_device_name(cd),
233 .uuid = crypt_get_uuid(cd),
235 .offset = crypt_get_data_offset(cd),
236 .iv_offset = crypt_get_iv_offset(cd),
241 r = device_check_and_adjust(cd, dmd.device,
242 (dmd.flags & CRYPT_ACTIVATE_SHARED) ? DEV_SHARED : DEV_EXCL,
243 &dmd.size, &dmd.offset, &flags);
247 if (crypt_get_cipher_mode(cd))
248 r = asprintf(&dm_cipher, "%s-%s", crypt_get_cipher(cd), crypt_get_cipher_mode(cd));
250 r = asprintf(&dm_cipher, "%s", crypt_get_cipher(cd));
254 dmd.cipher = dm_cipher;
255 log_dbg("Trying to activate PLAIN device %s using cipher %s.", name, dmd.cipher);
257 r = dm_create_device(name, CRYPT_PLAIN, &dmd, 0);
260 if (!cd->plain_uuid && dm_query_device(name, DM_ACTIVE_UUID, &dmd) >= 0)
261 cd->plain_uuid = (char*)dmd.uuid;
267 int crypt_confirm(struct crypt_device *cd, const char *msg)
269 if (!cd || !cd->confirm)
272 return cd->confirm(msg, cd->confirm_usrptr);
275 static int key_from_terminal(struct crypt_device *cd, char *msg, char **key,
276 size_t *key_len, int force_verify)
282 if(!msg && asprintf(&prompt, _("Enter passphrase for %s: "),
283 cd->backing_file ?: crypt_get_device_name(cd)) < 0)
290 *key = crypt_safe_alloc(DEFAULT_PASSPHRASE_SIZE_MAX);
295 r = cd->password(msg, *key, DEFAULT_PASSPHRASE_SIZE_MAX,
296 cd->password_usrptr);
298 crypt_safe_free(*key);
303 r = crypt_get_key(msg, key, key_len, 0, NULL, cd->timeout,
304 (force_verify || cd->password_verify), cd);
307 return (r < 0) ? r: 0;
310 static int volume_key_by_terminal_passphrase(struct crypt_device *cd, int keyslot,
311 struct volume_key **vk)
313 char *passphrase_read = NULL;
314 size_t passphrase_size_read;
315 int r = -EINVAL, eperm = 0, tries = cd->tries;
319 crypt_free_volume_key(*vk);
322 r = key_from_terminal(cd, NULL, &passphrase_read,
323 &passphrase_size_read, 0);
327 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase_read,
328 passphrase_size_read, &cd->hdr, vk, cd);
331 crypt_safe_free(passphrase_read);
332 passphrase_read = NULL;
333 } while (r == -EPERM && (--tries > 0));
336 crypt_free_volume_key(*vk);
339 /* Report wrong passphrase if at least one try failed */
340 if (eperm && r == -EPIPE)
344 crypt_safe_free(passphrase_read);
348 static int key_from_file(struct crypt_device *cd, char *msg,
349 char **key, size_t *key_len,
350 const char *key_file, size_t key_size)
352 return crypt_get_key(msg, key, key_len, key_size, key_file,
356 void crypt_set_log_callback(struct crypt_device *cd,
357 void (*log)(int level, const char *msg, void *usrptr),
364 cd->log_usrptr = usrptr;
368 void crypt_set_confirm_callback(struct crypt_device *cd,
369 int (*confirm)(const char *msg, void *usrptr),
372 cd->confirm = confirm;
373 cd->confirm_usrptr = usrptr;
376 void crypt_set_password_callback(struct crypt_device *cd,
377 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
380 cd->password = password;
381 cd->password_usrptr = usrptr;
384 void crypt_get_error(char *buf, size_t size)
386 const char *error = get_error();
388 if (!buf || size < 1)
391 strncpy(buf, error, size - 1);
392 buf[size - 1] = '\0';
398 const char *crypt_get_dir(void)
403 int crypt_init(struct crypt_device **cd, const char *device)
405 struct crypt_device *h = NULL;
411 log_dbg("Allocating crypt device %s context.", device);
413 if (!(h = malloc(sizeof(struct crypt_device))))
416 memset(h, 0, sizeof(*h));
420 r = device_ready(NULL, device, O_RDONLY);
422 h->device = crypt_loop_get_device();
423 log_dbg("Not a block device, %s%s.",
424 h->device ? "using free loop device " :
425 "no free loop device found",
428 log_err(NULL, _("Cannot find a free loopback device.\n"));
433 /* Keep the loop open, dettached on last close. */
434 h->loop_fd = crypt_loop_attach(h->device, device, 0, 1, &readonly);
435 if (h->loop_fd == -1) {
436 log_err(NULL, _("Attaching loopback device failed "
437 "(loop device with autoclear flag is required).\n"));
442 h->backing_file = crypt_loop_backing_file(h->device);
443 r = device_ready(NULL, h->device, O_RDONLY);
451 if (!h->device && device && !(h->device = strdup(device))) {
456 if (dm_init(h, 1) < 0) {
461 h->iteration_time = 1000;
462 h->password_verify = 0;
464 h->rng_type = crypt_random_default_key_rng();
470 if (h->loop_fd != -1)
473 free(h->backing_file);
479 int crypt_set_data_device(struct crypt_device *cd, const char *device)
484 log_dbg("Setting ciphertext data device to %s.", device ?: "(none)");
486 if (!isLUKS(cd->type)) {
487 log_err(cd, _("This operation is not supported for this device type.\n"));
491 /* metadata device must be set */
495 r = device_ready(NULL, device, O_RDONLY);
499 if (!(data_device = strdup(device)))
502 if (!cd->metadata_device)
503 cd->metadata_device = cd->device;
507 cd->device = data_device;
512 int crypt_init_by_name_and_header(struct crypt_device **cd,
514 const char *header_device)
516 crypt_status_info ci;
517 struct crypt_dm_active_device dmd;
518 char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
522 log_dbg("Allocating crypt device context by device %s.", name);
524 ci = crypt_status(NULL, name);
525 if (ci == CRYPT_INVALID)
528 if (ci < CRYPT_ACTIVE) {
529 log_err(NULL, _("Device %s is not active.\n"), name);
533 r = dm_query_device(name, DM_ACTIVE_DEVICE | DM_ACTIVE_CIPHER |
534 DM_ACTIVE_UUID | DM_ACTIVE_KEYSIZE, &dmd);
541 r = crypt_init(cd, header_device);
543 r = crypt_init(cd, dmd.device);
545 /* Underlying device disappeared but mapping still active */
546 if (!dmd.device || r == -ENOTBLK)
547 log_verbose(NULL, _("Underlying device for crypt device %s disappeared.\n"),
550 /* Underlying device is not readable but crypt mapping exists */
552 free((char*)dmd.device);
554 r = crypt_init(cd, NULL);
562 if (!strncmp(CRYPT_PLAIN, dmd.uuid, sizeof(CRYPT_PLAIN)-1))
563 (*cd)->type = strdup(CRYPT_PLAIN);
564 else if (!strncmp(CRYPT_LOOPAES, dmd.uuid, sizeof(CRYPT_LOOPAES)-1))
565 (*cd)->type = strdup(CRYPT_LOOPAES);
566 else if (!strncmp(CRYPT_LUKS1, dmd.uuid, sizeof(CRYPT_LUKS1)-1))
567 (*cd)->type = strdup(CRYPT_LUKS1);
569 log_dbg("Unknown UUID set, some parameters are not set.");
571 log_dbg("Active device has no UUID set, some parameters are not set.");
574 r = crypt_set_data_device(*cd, dmd.device);
579 /* Try to initialise basic parameters from active device */
581 if (!(*cd)->backing_file && dmd.device && crypt_loop_device(dmd.device) &&
582 !((*cd)->backing_file = crypt_loop_backing_file(dmd.device))) {
587 if (isPLAIN((*cd)->type)) {
588 (*cd)->type = strdup(CRYPT_PLAIN);
589 (*cd)->plain_uuid = strdup(dmd.uuid);
590 (*cd)->plain_hdr.hash = NULL; /* no way to get this */
591 (*cd)->plain_hdr.offset = dmd.offset;
592 (*cd)->plain_hdr.skip = dmd.iv_offset;
594 r = crypt_parse_name_and_mode(dmd.cipher, cipher, NULL, cipher_mode);
596 (*cd)->plain_cipher = strdup(cipher);
597 (*cd)->plain_cipher_mode = strdup(cipher_mode);
599 } else if (isLOOPAES((*cd)->type)) {
600 (*cd)->type = strdup(CRYPT_LOOPAES);
601 (*cd)->loopaes_uuid = strdup(dmd.uuid);
602 (*cd)->loopaes_hdr.offset = dmd.offset;
604 r = crypt_parse_name_and_mode(dmd.cipher, cipher,
605 &key_nums, cipher_mode);
607 (*cd)->loopaes_cipher = strdup(cipher);
608 (*cd)->loopaes_cipher_mode = strdup(cipher_mode);
609 /* version 3 uses last key for IV */
610 if (dmd.vk->keylength % key_nums)
612 (*cd)->loopaes_key_size = dmd.vk->keylength / key_nums;
614 } else if (isLUKS((*cd)->type)) {
615 if (mdata_device(*cd)) {
616 r = crypt_load(*cd, CRYPT_LUKS1, NULL);
618 log_dbg("LUKS device header does not match active device.");
632 crypt_free_volume_key(dmd.vk);
633 free((char*)dmd.device);
634 free((char*)dmd.cipher);
635 free((char*)dmd.uuid);
639 int crypt_init_by_name(struct crypt_device **cd, const char *name)
641 return crypt_init_by_name_and_header(cd, name, NULL);
644 static int _crypt_format_plain(struct crypt_device *cd,
646 const char *cipher_mode,
648 size_t volume_key_size,
649 struct crypt_params_plain *params)
651 if (!cipher || !cipher_mode) {
652 log_err(cd, _("Invalid plain crypt parameters.\n"));
656 if (volume_key_size > 1024) {
657 log_err(cd, _("Invalid key size.\n"));
661 cd->volume_key = crypt_alloc_volume_key(volume_key_size, NULL);
665 cd->plain_cipher = strdup(cipher);
666 cd->plain_cipher_mode = strdup(cipher_mode);
669 cd->plain_uuid = strdup(uuid);
671 if (params && params->hash)
672 cd->plain_hdr.hash = strdup(params->hash);
674 cd->plain_hdr.offset = params ? params->offset : 0;
675 cd->plain_hdr.skip = params ? params->skip : 0;
676 cd->plain_hdr.size = params ? params->size : 0;
678 if (!cd->plain_cipher || !cd->plain_cipher_mode)
684 static int _crypt_format_luks1(struct crypt_device *cd,
686 const char *cipher_mode,
688 const char *volume_key,
689 size_t volume_key_size,
690 struct crypt_params_luks1 *params)
693 unsigned long required_alignment = DEFAULT_DISK_ALIGNMENT;
694 unsigned long alignment_offset = 0;
696 if (!mdata_device(cd)) {
697 log_err(cd, _("Can't format LUKS without device.\n"));
702 cd->volume_key = crypt_alloc_volume_key(volume_key_size,
705 cd->volume_key = crypt_generate_volume_key(cd, volume_key_size);
710 //FIXME: external metadata, ignore alignment
711 if (params && params->data_alignment)
712 required_alignment = params->data_alignment * SECTOR_SIZE;
714 get_topology_alignment(cd->device, &required_alignment,
715 &alignment_offset, DEFAULT_DISK_ALIGNMENT);
717 r = LUKS_generate_phdr(&cd->hdr, cd->volume_key, cipher, cipher_mode,
718 (params && params->hash) ? params->hash : "sha1",
720 required_alignment / SECTOR_SIZE,
721 alignment_offset / SECTOR_SIZE,
722 cd->iteration_time, &cd->PBKDF2_per_sec, cd);
726 /* Wipe first 8 sectors - fs magic numbers etc. */
727 r = wipe_device_header(mdata_device(cd), 8);
730 log_err(cd, _("Cannot format device %s which is still in use.\n"),
733 log_err(cd, _("Cannot wipe header on device %s.\n"),
739 r = LUKS_write_phdr(mdata_device(cd), &cd->hdr, cd);
744 static int _crypt_format_loopaes(struct crypt_device *cd,
747 size_t volume_key_size,
748 struct crypt_params_loopaes *params)
750 if (!mdata_device(cd)) {
751 log_err(cd, _("Can't format LOOPAES without device.\n"));
755 if (volume_key_size > 1024) {
756 log_err(cd, _("Invalid key size.\n"));
760 cd->loopaes_key_size = volume_key_size;
762 cd->loopaes_cipher = strdup(cipher ?: DEFAULT_LOOPAES_CIPHER);
765 cd->loopaes_uuid = strdup(uuid);
767 if (params && params->hash)
768 cd->loopaes_hdr.hash = strdup(params->hash);
770 cd->loopaes_hdr.offset = params ? params->offset : 0;
771 cd->loopaes_hdr.skip = params ? params->skip : 0;
776 int crypt_format(struct crypt_device *cd,
779 const char *cipher_mode,
781 const char *volume_key,
782 size_t volume_key_size,
790 log_dbg("Formatting device %s as type %s.", mdata_device(cd) ?: "(none)", type);
797 r = _crypt_format_plain(cd, cipher, cipher_mode,
798 uuid, volume_key_size, params);
799 else if (isLUKS(type))
800 r = _crypt_format_luks1(cd, cipher, cipher_mode,
801 uuid, volume_key, volume_key_size, params);
802 else if (isLOOPAES(type))
803 r = _crypt_format_loopaes(cd, cipher, uuid, volume_key_size, params);
805 /* FIXME: allow plugins here? */
806 log_err(cd, _("Unknown crypt device type %s requested.\n"), type);
810 if (!r && !(cd->type = strdup(type)))
814 crypt_free_volume_key(cd->volume_key);
815 cd->volume_key = NULL;
821 int crypt_load(struct crypt_device *cd,
822 const char *requested_type,
823 void *params __attribute__((unused)))
825 struct luks_phdr hdr;
828 log_dbg("Trying to load %s crypt type from device %s.",
829 requested_type ?: "any", mdata_device(cd) ?: "(none)");
831 if (!mdata_device(cd))
834 if (requested_type && !isLUKS(requested_type))
841 r = LUKS_read_phdr(mdata_device(cd), &hdr, 1, cd);
844 memcpy(&cd->hdr, &hdr, sizeof(hdr));
846 cd->type = strdup(CRYPT_LUKS1);
854 int crypt_resize(struct crypt_device *cd, const char *name, uint64_t new_size)
856 struct crypt_dm_active_device dmd;
859 /* Device context type must be initialised */
860 if (!cd->type || !crypt_get_uuid(cd))
863 log_dbg("Resizing device %s to %" PRIu64 " sectors.", name, new_size);
865 r = dm_query_device(name, DM_ACTIVE_DEVICE | DM_ACTIVE_CIPHER |
866 DM_ACTIVE_UUID | DM_ACTIVE_KEYSIZE |
867 DM_ACTIVE_KEY, &dmd);
869 log_err(NULL, _("Device %s is not active.\n"), name);
878 r = device_check_and_adjust(cd, dmd.device, DEV_OK, &new_size, &dmd.offset, &dmd.flags);
882 if (new_size == dmd.size) {
883 log_dbg("Device has already requested size %" PRIu64
884 " sectors.", dmd.size);
888 r = dm_create_device(name, cd->type, &dmd, 1);
891 crypt_free_volume_key(dmd.vk);
892 free((char*)dmd.cipher);
893 free((char*)dmd.device);
894 free((char*)dmd.uuid);
899 int crypt_set_uuid(struct crypt_device *cd, const char *uuid)
901 if (!isLUKS(cd->type)) {
902 log_err(cd, _("This operation is not supported for this device type.\n"));
906 if (uuid && !strncmp(uuid, cd->hdr.uuid, sizeof(cd->hdr.uuid))) {
907 log_dbg("UUID is the same as requested (%s) for device %s.",
908 uuid, mdata_device(cd));
913 log_dbg("Requested new UUID change to %s for %s.", uuid, mdata_device(cd));
915 log_dbg("Requested new UUID refresh for %s.", mdata_device(cd));
917 if (!crypt_confirm(cd, _("Do you really want to change UUID of device?")))
920 return LUKS_hdr_uuid_set(mdata_device(cd), &cd->hdr, uuid, cd);
923 int crypt_header_backup(struct crypt_device *cd,
924 const char *requested_type,
925 const char *backup_file)
929 if ((requested_type && !isLUKS(requested_type)) || !backup_file)
936 log_dbg("Requested header backup of device %s (%s) to "
937 "file %s.", mdata_device(cd), requested_type, backup_file);
939 return LUKS_hdr_backup(backup_file, mdata_device(cd), &cd->hdr, cd);
942 int crypt_header_restore(struct crypt_device *cd,
943 const char *requested_type,
944 const char *backup_file)
948 if (requested_type && !isLUKS(requested_type))
951 /* Some hash functions need initialized gcrypt library */
956 log_dbg("Requested header restore to device %s (%s) from "
957 "file %s.", mdata_device(cd), requested_type, backup_file);
959 return LUKS_hdr_restore(backup_file, mdata_device(cd), &cd->hdr, cd);
962 void crypt_free(struct crypt_device *cd)
965 log_dbg("Releasing crypt device %s context.", mdata_device(cd));
967 if (cd->loop_fd != -1)
971 crypt_free_volume_key(cd->volume_key);
974 free(cd->metadata_device);
975 free(cd->backing_file);
978 /* used in plain device only */
979 free((char*)cd->plain_hdr.hash);
980 free(cd->plain_cipher);
981 free(cd->plain_cipher_mode);
982 free(cd->plain_uuid);
984 /* used in loop-AES device only */
985 free((char*)cd->loopaes_hdr.hash);
986 free(cd->loopaes_cipher);
987 free(cd->loopaes_uuid);
993 int crypt_suspend(struct crypt_device *cd,
996 crypt_status_info ci;
999 log_dbg("Suspending volume %s.", name);
1001 if (!isLUKS(cd->type)) {
1002 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1007 ci = crypt_status(NULL, name);
1008 if (ci < CRYPT_ACTIVE) {
1009 log_err(cd, _("Volume %s is not active.\n"), name);
1013 if (!cd && dm_init(NULL, 1) < 0)
1016 r = dm_status_suspended(name);
1021 log_err(cd, _("Volume %s is already suspended.\n"), name);
1026 r = dm_suspend_and_wipe_key(name);
1028 log_err(cd, "Suspend is not supported for device %s.\n", name);
1030 log_err(cd, "Error during suspending device %s.\n", name);
1037 int crypt_resume_by_passphrase(struct crypt_device *cd,
1040 const char *passphrase,
1041 size_t passphrase_size)
1043 struct volume_key *vk = NULL;
1046 log_dbg("Resuming volume %s.", name);
1048 if (!isLUKS(cd->type)) {
1049 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1054 r = dm_status_suspended(name);
1059 log_err(cd, _("Volume %s is not suspended.\n"), name);
1064 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase,
1065 passphrase_size, &cd->hdr, &vk, cd);
1067 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1071 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1073 log_err(cd, "Resume is not supported for device %s.\n", name);
1075 log_err(cd, "Error during resuming device %s.\n", name);
1079 crypt_free_volume_key(vk);
1080 return r < 0 ? r : keyslot;
1083 int crypt_resume_by_keyfile(struct crypt_device *cd,
1086 const char *keyfile,
1087 size_t keyfile_size)
1089 struct volume_key *vk = NULL;
1090 char *passphrase_read = NULL;
1091 size_t passphrase_size_read;
1094 log_dbg("Resuming volume %s.", name);
1096 if (!isLUKS(cd->type)) {
1097 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1102 r = dm_status_suspended(name);
1107 log_err(cd, _("Volume %s is not suspended.\n"), name);
1114 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1115 &passphrase_size_read, keyfile, keyfile_size);
1119 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase_read,
1120 passphrase_size_read, &cd->hdr, &vk, cd);
1125 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1127 log_err(cd, "Error during resuming device %s.\n", name);
1129 crypt_safe_free(passphrase_read);
1130 crypt_free_volume_key(vk);
1131 return r < 0 ? r : keyslot;
1134 // slot manipulation
1135 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
1136 int keyslot, // -1 any
1137 const char *passphrase, // NULL -> terminal
1138 size_t passphrase_size,
1139 const char *new_passphrase, // NULL -> terminal
1140 size_t new_passphrase_size)
1142 struct volume_key *vk = NULL;
1143 char *password = NULL, *new_password = NULL;
1144 size_t passwordLen, new_passwordLen;
1147 log_dbg("Adding new keyslot, existing passphrase %sprovided,"
1148 "new passphrase %sprovided.",
1149 passphrase ? "" : "not ", new_passphrase ? "" : "not ");
1151 if (!isLUKS(cd->type)) {
1152 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1156 r = keyslot_verify_or_find_empty(cd, &keyslot);
1160 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1161 /* No slots used, try to use pre-generated key in header */
1162 if (cd->volume_key) {
1163 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1164 r = vk ? 0 : -ENOMEM;
1166 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1169 } else if (passphrase) {
1170 /* Passphrase provided, use it to unlock existing keyslot */
1171 r = LUKS_open_key_with_hdr(mdata_device(cd), CRYPT_ANY_SLOT, passphrase,
1172 passphrase_size, &cd->hdr, &vk, cd);
1174 /* Passphrase not provided, ask first and use it to unlock existing keyslot */
1175 r = key_from_terminal(cd, _("Enter any passphrase: "),
1176 &password, &passwordLen, 0);
1180 r = LUKS_open_key_with_hdr(mdata_device(cd), CRYPT_ANY_SLOT, password,
1181 passwordLen, &cd->hdr, &vk, cd);
1182 crypt_safe_free(password);
1188 if (new_passphrase) {
1189 new_password = (char *)new_passphrase;
1190 new_passwordLen = new_passphrase_size;
1192 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1193 &new_password, &new_passwordLen, 1);
1198 r = LUKS_set_key(mdata_device(cd), keyslot, new_password, new_passwordLen,
1199 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1204 if (!new_passphrase)
1205 crypt_safe_free(new_password);
1206 crypt_free_volume_key(vk);
1207 return r ?: keyslot;
1210 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
1212 const char *keyfile,
1213 size_t keyfile_size,
1214 const char *new_keyfile,
1215 size_t new_keyfile_size)
1217 struct volume_key *vk = NULL;
1218 char *password = NULL; size_t passwordLen;
1219 char *new_password = NULL; size_t new_passwordLen;
1222 log_dbg("Adding new keyslot, existing keyfile %s, new keyfile %s.",
1223 keyfile ?: "[none]", new_keyfile ?: "[none]");
1225 if (!isLUKS(cd->type)) {
1226 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1230 r = keyslot_verify_or_find_empty(cd, &keyslot);
1234 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1235 /* No slots used, try to use pre-generated key in header */
1236 if (cd->volume_key) {
1237 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1238 r = vk ? 0 : -ENOMEM;
1240 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1244 /* Read password from file of (if NULL) from terminal */
1246 r = key_from_file(cd, _("Enter any passphrase: "),
1247 &password, &passwordLen,
1248 keyfile, keyfile_size);
1250 r = key_from_terminal(cd, _("Enter any passphrase: "),
1251 &password, &passwordLen, 0);
1255 r = LUKS_open_key_with_hdr(mdata_device(cd), CRYPT_ANY_SLOT, password, passwordLen,
1263 r = key_from_file(cd, _("Enter new passphrase for key slot: "),
1264 &new_password, &new_passwordLen, new_keyfile,
1267 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1268 &new_password, &new_passwordLen, 1);
1272 r = LUKS_set_key(mdata_device(cd), keyslot, new_password, new_passwordLen,
1273 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1275 crypt_safe_free(password);
1276 crypt_safe_free(new_password);
1277 crypt_free_volume_key(vk);
1278 return r < 0 ? r : keyslot;
1281 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
1283 const char *volume_key,
1284 size_t volume_key_size,
1285 const char *passphrase,
1286 size_t passphrase_size)
1288 struct volume_key *vk = NULL;
1290 char *new_password = NULL; size_t new_passwordLen;
1292 log_dbg("Adding new keyslot %d using volume key.", keyslot);
1294 if (!isLUKS(cd->type)) {
1295 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1300 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1301 else if (cd->volume_key)
1302 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1307 r = LUKS_verify_volume_key(&cd->hdr, vk);
1309 log_err(cd, _("Volume key does not match the volume.\n"));
1313 r = keyslot_verify_or_find_empty(cd, &keyslot);
1318 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1319 &new_password, &new_passwordLen, 1);
1322 passphrase = new_password;
1323 passphrase_size = new_passwordLen;
1326 r = LUKS_set_key(mdata_device(cd), keyslot, passphrase, passphrase_size,
1327 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1329 crypt_safe_free(new_password);
1330 crypt_free_volume_key(vk);
1331 return (r < 0) ? r : keyslot;
1334 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot)
1336 crypt_keyslot_info ki;
1338 log_dbg("Destroying keyslot %d.", keyslot);
1340 if (!isLUKS(cd->type)) {
1341 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1345 ki = crypt_keyslot_status(cd, keyslot);
1346 if (ki == CRYPT_SLOT_INVALID) {
1347 log_err(cd, _("Key slot %d is invalid.\n"), keyslot);
1351 if (ki == CRYPT_SLOT_INACTIVE) {
1352 log_err(cd, _("Key slot %d is not used.\n"), keyslot);
1356 return LUKS_del_key(mdata_device(cd), keyslot, &cd->hdr, cd);
1359 // activation/deactivation of device mapping
1360 int crypt_activate_by_passphrase(struct crypt_device *cd,
1363 const char *passphrase,
1364 size_t passphrase_size,
1367 crypt_status_info ci;
1368 struct volume_key *vk = NULL;
1369 char *read_passphrase = NULL;
1370 size_t passphraseLen = 0;
1373 log_dbg("%s volume %s [keyslot %d] using %spassphrase.",
1374 name ? "Activating" : "Checking", name ?: "",
1375 keyslot, passphrase ? "" : "[none] ");
1378 ci = crypt_status(NULL, name);
1379 if (ci == CRYPT_INVALID)
1381 else if (ci >= CRYPT_ACTIVE) {
1382 log_err(cd, _("Device %s already exists.\n"), name);
1387 /* plain, use hashed passphrase */
1388 if (isPLAIN(cd->type)) {
1393 r = key_from_terminal(cd, NULL, &read_passphrase,
1397 passphrase = read_passphrase;
1398 passphrase_size = passphraseLen;
1401 r = process_key(cd, cd->plain_hdr.hash,
1402 cd->volume_key->keylength,
1403 passphrase, passphrase_size, &vk);
1407 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1409 } else if (isLUKS(cd->type)) {
1410 /* provided passphrase, do not retry */
1412 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase,
1413 passphrase_size, &cd->hdr, &vk, cd);
1415 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1420 r = LUKS1_activate(cd, name, vk, flags);
1425 crypt_safe_free(read_passphrase);
1426 crypt_free_volume_key(vk);
1428 return r < 0 ? r : keyslot;
1431 int crypt_activate_by_keyfile(struct crypt_device *cd,
1434 const char *keyfile,
1435 size_t keyfile_size,
1438 crypt_status_info ci;
1439 struct volume_key *vk = NULL;
1440 char *passphrase_read = NULL;
1441 size_t passphrase_size_read;
1442 unsigned int key_count = 0;
1445 log_dbg("Activating volume %s [keyslot %d] using keyfile %s.",
1446 name ?: "", keyslot, keyfile ?: "[none]");
1449 ci = crypt_status(NULL, name);
1450 if (ci == CRYPT_INVALID)
1452 else if (ci >= CRYPT_ACTIVE) {
1453 log_err(cd, _("Device %s already exists.\n"), name);
1461 if (isPLAIN(cd->type)) {
1465 r = key_from_file(cd, _("Enter passphrase: "),
1466 &passphrase_read, &passphrase_size_read,
1467 keyfile, keyfile_size);
1471 r = process_key(cd, cd->plain_hdr.hash,
1472 cd->volume_key->keylength,
1473 passphrase_read, passphrase_size_read, &vk);
1477 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1478 } else if (isLUKS(cd->type)) {
1479 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1480 &passphrase_size_read, keyfile, keyfile_size);
1483 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase_read,
1484 passphrase_size_read, &cd->hdr, &vk, cd);
1490 r = LUKS1_activate(cd, name, vk, flags);
1495 } else if (isLOOPAES(cd->type)) {
1496 r = key_from_file(cd, NULL, &passphrase_read, &passphrase_size_read,
1497 keyfile, keyfile_size);
1500 r = LOOPAES_parse_keyfile(cd, &vk, cd->loopaes_hdr.hash, &key_count,
1501 passphrase_read, passphrase_size_read);
1505 r = LOOPAES_activate(cd, name, cd->loopaes_cipher,
1506 key_count, vk, flags);
1511 crypt_safe_free(passphrase_read);
1512 crypt_free_volume_key(vk);
1517 int crypt_activate_by_volume_key(struct crypt_device *cd,
1519 const char *volume_key,
1520 size_t volume_key_size,
1523 crypt_status_info ci;
1524 struct volume_key *vk = NULL;
1527 log_dbg("Activating volume %s by volume key.", name);
1530 ci = crypt_status(NULL, name);
1531 if (ci == CRYPT_INVALID)
1533 else if (ci >= CRYPT_ACTIVE) {
1534 log_err(cd, _("Device %s already exists.\n"), name);
1539 /* use key directly, no hash */
1540 if (isPLAIN(cd->type)) {
1544 if (!volume_key || !volume_key_size || !cd->volume_key ||
1545 volume_key_size != cd->volume_key->keylength) {
1546 log_err(cd, _("Incorrect volume key specified for plain device.\n"));
1550 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1554 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1555 } else if (isLUKS(cd->type)) {
1556 /* If key is not provided, try to use internal key */
1558 if (!cd->volume_key) {
1559 log_err(cd, _("Volume key does not match the volume.\n"));
1562 volume_key_size = cd->volume_key->keylength;
1563 volume_key = cd->volume_key->key;
1566 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1569 r = LUKS_verify_volume_key(&cd->hdr, vk);
1572 log_err(cd, _("Volume key does not match the volume.\n"));
1575 r = LUKS1_activate(cd, name, vk, flags);
1577 log_err(cd, _("Device type is not properly initialised.\n"));
1579 crypt_free_volume_key(vk);
1584 int crypt_deactivate(struct crypt_device *cd, const char *name)
1591 log_dbg("Deactivating volume %s.", name);
1593 if (!cd && dm_init(NULL, 1) < 0)
1596 switch (crypt_status(cd, name)) {
1598 r = dm_remove_device(name, 0, 0);
1601 log_err(cd, _("Device %s is busy.\n"), name);
1604 case CRYPT_INACTIVE:
1605 log_err(cd, _("Device %s is not active.\n"), name);
1609 log_err(cd, _("Invalid device %s.\n"), name);
1619 int crypt_volume_key_get(struct crypt_device *cd,
1622 size_t *volume_key_size,
1623 const char *passphrase,
1624 size_t passphrase_size)
1626 struct volume_key *vk = NULL;
1630 key_len = crypt_get_volume_key_size(cd);
1631 if (key_len > *volume_key_size) {
1632 log_err(cd, _("Volume key buffer too small.\n"));
1636 if (isPLAIN(cd->type) && cd->plain_hdr.hash) {
1637 r = process_key(cd, cd->plain_hdr.hash, key_len,
1638 passphrase, passphrase_size, &vk);
1640 log_err(cd, _("Cannot retrieve volume key for plain device.\n"));
1641 } else if (isLUKS(cd->type)) {
1642 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase,
1643 passphrase_size, &cd->hdr, &vk, cd);
1646 log_err(cd, _("This operation is not supported for %s crypt device.\n"), cd->type ?: "(none)");
1649 memcpy(volume_key, vk->key, vk->keylength);
1650 *volume_key_size = vk->keylength;
1653 crypt_free_volume_key(vk);
1657 int crypt_volume_key_verify(struct crypt_device *cd,
1658 const char *volume_key,
1659 size_t volume_key_size)
1661 struct volume_key *vk;
1664 if (!isLUKS(cd->type)) {
1665 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1669 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1673 r = LUKS_verify_volume_key(&cd->hdr, vk);
1676 log_err(cd, _("Volume key does not match the volume.\n"));
1678 crypt_free_volume_key(vk);
1683 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec)
1685 log_dbg("Timeout set to %" PRIu64 " miliseconds.", timeout_sec);
1686 cd->timeout = timeout_sec;
1689 void crypt_set_password_retry(struct crypt_device *cd, int tries)
1691 log_dbg("Password retry count set to %d.", tries);
1695 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms)
1697 log_dbg("Iteration time set to %" PRIu64 " miliseconds.", iteration_time_ms);
1698 cd->iteration_time = iteration_time_ms;
1701 void crypt_set_password_verify(struct crypt_device *cd, int password_verify)
1703 log_dbg("Password verification %s.", password_verify ? "enabled" : "disabled");
1704 cd->password_verify = password_verify ? 1 : 0;
1707 void crypt_set_rng_type(struct crypt_device *cd, int rng_type)
1710 case CRYPT_RNG_URANDOM:
1711 case CRYPT_RNG_RANDOM:
1712 log_dbg("RNG set to %d (%s).", rng_type, rng_type ? "random" : "urandom");
1713 cd->rng_type = rng_type;
1717 int crypt_get_rng_type(struct crypt_device *cd)
1722 return cd->rng_type;
1725 int crypt_memory_lock(struct crypt_device *cd, int lock)
1727 return lock ? crypt_memlock_inc(cd) : crypt_memlock_dec(cd);
1731 crypt_status_info crypt_status(struct crypt_device *cd, const char *name)
1735 if (!cd && dm_init(NULL, 1) < 0)
1736 return CRYPT_INVALID;
1738 r = dm_status_device(name);
1743 if (r < 0 && r != -ENODEV)
1744 return CRYPT_INVALID;
1747 return CRYPT_ACTIVE;
1752 return CRYPT_INACTIVE;
1755 static void hexprintICB(struct crypt_device *cd, char *d, int n)
1758 for(i = 0; i < n; i++)
1759 log_std(cd, "%02hhx ", (char)d[i]);
1762 int crypt_dump(struct crypt_device *cd)
1765 if (!isLUKS(cd->type)) { //FIXME
1766 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1770 log_std(cd, "LUKS header information for %s\n\n", mdata_device(cd));
1771 log_std(cd, "Version: \t%d\n", cd->hdr.version);
1772 log_std(cd, "Cipher name: \t%s\n", cd->hdr.cipherName);
1773 log_std(cd, "Cipher mode: \t%s\n", cd->hdr.cipherMode);
1774 log_std(cd, "Hash spec: \t%s\n", cd->hdr.hashSpec);
1775 log_std(cd, "Payload offset:\t%d\n", cd->hdr.payloadOffset);
1776 log_std(cd, "MK bits: \t%d\n", cd->hdr.keyBytes * 8);
1777 log_std(cd, "MK digest: \t");
1778 hexprintICB(cd, cd->hdr.mkDigest, LUKS_DIGESTSIZE);
1780 log_std(cd, "MK salt: \t");
1781 hexprintICB(cd, cd->hdr.mkDigestSalt, LUKS_SALTSIZE/2);
1782 log_std(cd, "\n \t");
1783 hexprintICB(cd, cd->hdr.mkDigestSalt+LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1785 log_std(cd, "MK iterations: \t%d\n", cd->hdr.mkDigestIterations);
1786 log_std(cd, "UUID: \t%s\n\n", cd->hdr.uuid);
1787 for(i = 0; i < LUKS_NUMKEYS; i++) {
1788 if(cd->hdr.keyblock[i].active == LUKS_KEY_ENABLED) {
1789 log_std(cd, "Key Slot %d: ENABLED\n",i);
1790 log_std(cd, "\tIterations: \t%d\n",
1791 cd->hdr.keyblock[i].passwordIterations);
1792 log_std(cd, "\tSalt: \t");
1793 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt,
1795 log_std(cd, "\n\t \t");
1796 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt +
1797 LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1800 log_std(cd, "\tKey material offset:\t%d\n",
1801 cd->hdr.keyblock[i].keyMaterialOffset);
1802 log_std(cd, "\tAF stripes: \t%d\n",
1803 cd->hdr.keyblock[i].stripes);
1806 log_std(cd, "Key Slot %d: DISABLED\n", i);
1812 const char *crypt_get_cipher(struct crypt_device *cd)
1814 if (isPLAIN(cd->type))
1815 return cd->plain_cipher;
1817 if (isLUKS(cd->type))
1818 return cd->hdr.cipherName;
1820 if (isLOOPAES(cd->type))
1821 return cd->loopaes_cipher;
1826 const char *crypt_get_cipher_mode(struct crypt_device *cd)
1828 if (isPLAIN(cd->type))
1829 return cd->plain_cipher_mode;
1831 if (isLUKS(cd->type))
1832 return cd->hdr.cipherMode;
1834 if (isLOOPAES(cd->type))
1835 return cd->loopaes_cipher_mode;
1840 const char *crypt_get_uuid(struct crypt_device *cd)
1842 if (isLUKS(cd->type))
1843 return cd->hdr.uuid;
1845 if (isPLAIN(cd->type))
1846 return cd->plain_uuid;
1848 if (isLOOPAES(cd->type))
1849 return cd->loopaes_uuid;
1854 const char *crypt_get_device_name(struct crypt_device *cd)
1860 int crypt_get_volume_key_size(struct crypt_device *cd)
1862 if (isPLAIN(cd->type) && cd->volume_key)
1863 return cd->volume_key->keylength;
1865 if (isLUKS(cd->type))
1866 return cd->hdr.keyBytes;
1868 if (isLOOPAES(cd->type))
1869 return cd->loopaes_key_size;
1874 uint64_t crypt_get_data_offset(struct crypt_device *cd)
1876 if (isPLAIN(cd->type))
1877 return cd->plain_hdr.offset;
1879 if (isLUKS(cd->type))
1880 return cd->hdr.payloadOffset;
1882 if (isLOOPAES(cd->type))
1883 return cd->loopaes_hdr.offset;
1888 uint64_t crypt_get_iv_offset(struct crypt_device *cd)
1890 if (isPLAIN(cd->type))
1891 return cd->plain_hdr.skip;
1893 if (isLUKS(cd->type))
1896 if (isLOOPAES(cd->type))
1897 return cd->loopaes_hdr.skip;
1902 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot)
1904 if (!isLUKS(cd->type)) {
1905 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1906 return CRYPT_SLOT_INVALID;
1909 return LUKS_keyslot_info(&cd->hdr, keyslot);
1912 int crypt_keyslot_max(const char *type)
1914 if (type && isLUKS(type))
1915 return LUKS_NUMKEYS;
1920 const char *crypt_get_type(struct crypt_device *cd)
1925 int crypt_get_active_device(struct crypt_device *cd __attribute__((unused)),
1927 struct crypt_active_device *cad)
1929 struct crypt_dm_active_device dmd;
1932 r = dm_query_device(name, 0, &dmd);
1936 cad->offset = dmd.offset;
1937 cad->iv_offset = dmd.iv_offset;
1938 cad->size = dmd.size;
1939 cad->flags = dmd.flags;