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, ngettext("Cannot read %d byte from key file %s.\n",
163 "Cannot read %d bytes from key file %s.\n", key_size),
164 (int)key_size, key_file);
165 crypt_safe_free(key);
168 memcpy(key, pass, key_size);
172 /* key is coming from tty, fd or binary stdin */
174 r = crypt_plain_hash(cd, hash_name, key, key_size, pass, passLen);
177 log_err(cd, _("Hash algorithm %s not supported.\n"),
180 log_err(cd, _("Key processing error (using hash %s).\n"),
182 crypt_safe_free(key);
185 } else if (passLen > key_size) {
186 memcpy(key, pass, key_size);
188 memcpy(key, pass, passLen);
194 static int isPLAIN(const char *type)
196 return (type && !strcmp(CRYPT_PLAIN, type));
199 static int isLUKS(const char *type)
201 return (type && !strcmp(CRYPT_LUKS1, type));
204 static int isLOOPAES(const char *type)
206 return (type && !strcmp(CRYPT_LOOPAES, type));
209 /* keyslot helpers */
210 static int keyslot_verify_or_find_empty(struct crypt_device *cd, int *keyslot)
212 if (*keyslot == CRYPT_ANY_SLOT) {
213 *keyslot = LUKS_keyslot_find_empty(&cd->hdr);
215 log_err(cd, _("All key slots full.\n"));
220 switch (LUKS_keyslot_info(&cd->hdr, *keyslot)) {
221 case CRYPT_SLOT_INVALID:
222 log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
223 *keyslot, LUKS_NUMKEYS - 1);
225 case CRYPT_SLOT_INACTIVE:
228 log_err(cd, _("Key slot %d is full, please select another one.\n"),
236 static int create_device_helper(struct crypt_device *cd,
240 const char *cipher_mode,
241 const char *key_file,
242 const char *passphrase,
243 size_t passphrase_size,
249 uint32_t activation_flags,
252 crypt_status_info ci;
253 char *dm_cipher = NULL;
254 char *processed_key = NULL;
255 enum devcheck device_check;
261 read_only = activation_flags & CRYPT_ACTIVATE_READONLY ? 1 : 0;
263 device_check = DEV_OK;
264 else if (activation_flags & CRYPT_ACTIVATE_SHARED)
265 device_check = DEV_SHARED;
267 device_check = DEV_EXCL;
269 ci = crypt_status(cd, name);
270 if (ci == CRYPT_INVALID)
273 if (reload && ci < CRYPT_ACTIVE)
276 if (!reload && ci >= CRYPT_ACTIVE) {
277 log_err(cd, _("Device %s already exists.\n"), name);
281 if (key_size > 1024) {
282 log_err(cd, _("Invalid key size %d.\n"), (int)key_size);
286 r = device_check_and_adjust(cd, cd->device, device_check, &size, &offset, &read_only);
290 if (cipher_mode && asprintf(&dm_cipher, "%s-%s", cipher, cipher_mode) < 0)
293 processed_key = process_key(cd, hash, key_file, key_size, passphrase, passphrase_size);
294 if (!processed_key) {
299 r = dm_create_device(name, cd->device, dm_cipher ?: cipher, cd->type, uuid, size, skip, offset,
300 key_size, processed_key, read_only, reload);
302 if (isPLAIN(cd->type) && !uuid)
303 (void)dm_query_device(name, NULL, NULL, NULL, NULL, NULL, NULL,
304 NULL, NULL, NULL, &cd->plain_uuid);
307 crypt_safe_free(processed_key);
311 static int open_from_hdr_and_vk(struct crypt_device *cd,
312 struct volume_key *vk,
316 uint64_t size, offset;
318 int read_only, no_uuid, r;
321 offset = crypt_get_data_offset(cd);
322 read_only = flags & CRYPT_ACTIVATE_READONLY;
323 no_uuid = flags & CRYPT_ACTIVATE_NO_UUID;
325 r = device_check_and_adjust(cd, cd->device, DEV_EXCL, &size, &offset, &read_only);
329 if (asprintf(&cipher, "%s-%s", crypt_get_cipher(cd),
330 crypt_get_cipher_mode(cd)) < 0)
333 r = dm_create_device(name, cd->device, cipher, cd->type,
334 no_uuid ? NULL : crypt_get_uuid(cd),
335 size, 0, offset, vk->keylength, vk->key,
341 int crypt_confirm(struct crypt_device *cd, const char *msg)
343 if (!cd || !cd->confirm)
346 return cd->confirm(msg, cd->confirm_usrptr);
349 static int key_from_terminal(struct crypt_device *cd, char *msg, char **key,
350 size_t *key_len, int force_verify)
356 if(!msg && asprintf(&prompt, _("Enter passphrase for %s: "),
357 cd->backing_file ?: cd->device) < 0)
364 *key = crypt_safe_alloc(DEFAULT_PASSPHRASE_SIZE_MAX);
369 r = cd->password(msg, *key, DEFAULT_PASSPHRASE_SIZE_MAX,
370 cd->password_usrptr);
372 crypt_safe_free(*key);
377 r = crypt_get_key(msg, key, key_len, 0, NULL, cd->timeout,
378 (force_verify || cd->password_verify), cd);
381 return (r < 0) ? r: 0;
384 static int volume_key_by_terminal_passphrase(struct crypt_device *cd, int keyslot,
385 struct volume_key **vk)
387 char *passphrase_read = NULL;
388 size_t passphrase_size_read;
389 int r = -EINVAL, eperm = 0, tries = cd->tries;
393 crypt_free_volume_key(*vk);
396 r = key_from_terminal(cd, NULL, &passphrase_read,
397 &passphrase_size_read, 0);
401 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
402 passphrase_size_read, &cd->hdr, vk, cd);
405 crypt_safe_free(passphrase_read);
406 passphrase_read = NULL;
407 } while (r == -EPERM && (--tries > 0));
410 crypt_free_volume_key(*vk);
413 /* Report wrong passphrase if at least one try failed */
414 if (eperm && r == -EPIPE)
418 crypt_safe_free(passphrase_read);
422 static int key_from_file(struct crypt_device *cd, char *msg,
423 char **key, size_t *key_len,
424 const char *key_file, size_t key_size)
426 return crypt_get_key(msg, key, key_len, key_size, key_file,
430 void crypt_set_log_callback(struct crypt_device *cd,
431 void (*log)(int level, const char *msg, void *usrptr),
438 cd->log_usrptr = usrptr;
442 void crypt_set_confirm_callback(struct crypt_device *cd,
443 int (*confirm)(const char *msg, void *usrptr),
446 cd->confirm = confirm;
447 cd->confirm_usrptr = usrptr;
450 void crypt_set_password_callback(struct crypt_device *cd,
451 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
454 cd->password = password;
455 cd->password_usrptr = usrptr;
458 void crypt_get_error(char *buf, size_t size)
460 const char *error = get_error();
462 if (!buf || size < 1)
465 strncpy(buf, error, size - 1);
466 buf[size - 1] = '\0';
472 const char *crypt_get_dir(void)
477 /////////////////////////////////
482 int crypt_init(struct crypt_device **cd, const char *device)
484 struct crypt_device *h = NULL;
490 log_dbg("Allocating crypt device %s context.", device);
492 if (!(h = malloc(sizeof(struct crypt_device))))
495 memset(h, 0, sizeof(*h));
499 r = device_ready(NULL, device, O_RDONLY);
501 h->device = crypt_loop_get_device();
502 log_dbg("Not a block device, %s%s.",
503 h->device ? "using free loop device " :
504 "no free loop device found",
507 log_err(NULL, _("Cannot find a free loopback device.\n"));
512 /* Keep the loop open, dettached on last close. */
513 h->loop_fd = crypt_loop_attach(h->device, device, 0, 1, &readonly);
514 if (h->loop_fd == -1) {
515 log_err(NULL, _("Attaching loopback device failed "
516 "(loop device with autoclear flag is required).\n"));
521 h->backing_file = crypt_loop_backing_file(h->device);
522 r = device_ready(NULL, h->device, O_RDONLY);
530 if (!h->device && device && !(h->device = strdup(device))) {
535 if (dm_init(h, 1) < 0) {
540 h->iteration_time = 1000;
541 h->password_verify = 0;
543 h->rng_type = crypt_random_default_key_rng();
549 if (h->loop_fd != -1)
552 free(h->backing_file);
558 int crypt_init_by_name(struct crypt_device **cd, const char *name)
560 crypt_status_info ci;
561 struct crypt_active_device cad;
562 char *device = NULL, *cipher_full = NULL, *device_uuid = NULL;
563 char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
565 int key_size = 0, key_nums, r;
568 log_dbg("Allocating crypt device context by device %s.", name);
570 ci = crypt_status(NULL, name);
571 if (ci == CRYPT_INVALID)
574 if (ci < CRYPT_ACTIVE) {
575 log_err(NULL, _("Device %s is not active.\n"), name);
579 r = dm_query_device(name, &device, &cad.size, &cad.iv_offset, &cad.offset,
580 &cipher_full, &key_size, &key, NULL, NULL,
586 r = crypt_init(cd, device);
588 /* Underlying device disappeared but mapping still active */
589 if (!device || r == -ENOTBLK)
590 log_verbose(NULL, _("Underlying device for crypt device %s disappeared.\n"),
593 /* Underlying device is not readable but crypt mapping exists */
597 r = crypt_init(cd, NULL);
603 /* Try to initialise basic parameters from active device */
605 if (!(*cd)->backing_file && device && crypt_loop_device(device) &&
606 !((*cd)->backing_file = crypt_loop_backing_file(device))) {
612 if (!strncmp(CRYPT_PLAIN, device_uuid, sizeof(CRYPT_PLAIN)-1)) {
613 (*cd)->type = strdup(CRYPT_PLAIN);
614 (*cd)->plain_uuid = strdup(device_uuid);
615 (*cd)->plain_hdr.hash = NULL; /* no way to get this */
616 (*cd)->plain_hdr.offset = cad.offset;
617 (*cd)->plain_hdr.skip = cad.iv_offset;
618 (*cd)->volume_key = crypt_alloc_volume_key(key_size, key);
619 if (!(*cd)->volume_key) {
624 r = crypt_parse_name_and_mode(cipher_full, cipher, NULL, cipher_mode);
626 (*cd)->plain_cipher = strdup(cipher);
627 (*cd)->plain_cipher_mode = strdup(cipher_mode);
629 } else if (!strncmp(CRYPT_LOOPAES, device_uuid, sizeof(CRYPT_LOOPAES)-1)) {
630 (*cd)->type = strdup(CRYPT_LOOPAES);
631 (*cd)->loopaes_uuid = strdup(device_uuid);
632 (*cd)->loopaes_hdr.offset = cad.offset;
634 r = crypt_parse_name_and_mode(cipher_full, cipher,
635 &key_nums, cipher_mode);
637 (*cd)->loopaes_cipher = strdup(cipher);
638 (*cd)->loopaes_cipher_mode = strdup(cipher_mode);
639 /* version 3 uses last key for IV */
640 if (key_size % key_nums)
642 (*cd)->loopaes_key_size = key_size / key_nums;
644 } else if (!strncmp(CRYPT_LUKS1, device_uuid, sizeof(CRYPT_LUKS1)-1)) {
646 if (crypt_load(*cd, CRYPT_LUKS1, NULL) < 0 ||
647 crypt_volume_key_verify(*cd, key, key_size) < 0) {
648 log_dbg("LUKS device header does not match active device.");
652 (*cd)->volume_key = crypt_alloc_volume_key(key_size, key);
653 if (!(*cd)->volume_key) {
660 log_dbg("Active device has no UUID set, some parameters are not set.");
667 crypt_safe_free(key);
674 static int _crypt_format_plain(struct crypt_device *cd,
676 const char *cipher_mode,
678 size_t volume_key_size,
679 struct crypt_params_plain *params)
681 if (!cipher || !cipher_mode) {
682 log_err(cd, _("Invalid plain crypt parameters.\n"));
686 if (volume_key_size > 1024) {
687 log_err(cd, _("Invalid key size.\n"));
691 cd->volume_key = crypt_alloc_volume_key(volume_key_size, NULL);
695 cd->plain_cipher = strdup(cipher);
696 cd->plain_cipher_mode = strdup(cipher_mode);
699 cd->plain_uuid = strdup(uuid);
701 if (params && params->hash)
702 cd->plain_hdr.hash = strdup(params->hash);
704 cd->plain_hdr.offset = params ? params->offset : 0;
705 cd->plain_hdr.skip = params ? params->skip : 0;
706 cd->plain_hdr.size = params ? params->size : 0;
708 if (!cd->plain_cipher || !cd->plain_cipher_mode)
714 static int _crypt_format_luks1(struct crypt_device *cd,
716 const char *cipher_mode,
718 const char *volume_key,
719 size_t volume_key_size,
720 struct crypt_params_luks1 *params)
723 unsigned long required_alignment = DEFAULT_DISK_ALIGNMENT;
724 unsigned long alignment_offset = 0;
727 log_err(cd, _("Can't format LUKS without device.\n"));
732 cd->volume_key = crypt_alloc_volume_key(volume_key_size,
735 cd->volume_key = crypt_generate_volume_key(cd, volume_key_size);
740 if (params && params->data_alignment)
741 required_alignment = params->data_alignment * SECTOR_SIZE;
743 get_topology_alignment(cd->device, &required_alignment,
744 &alignment_offset, DEFAULT_DISK_ALIGNMENT);
746 r = LUKS_generate_phdr(&cd->hdr, cd->volume_key, cipher, cipher_mode,
747 (params && params->hash) ? params->hash : "sha1",
749 required_alignment / SECTOR_SIZE,
750 alignment_offset / SECTOR_SIZE,
751 cd->iteration_time, &cd->PBKDF2_per_sec, cd);
755 /* Wipe first 8 sectors - fs magic numbers etc. */
756 r = wipe_device_header(cd->device, 8);
759 log_err(cd, _("Cannot format device %s which is still in use.\n"),
762 log_err(cd, _("Cannot wipe header on device %s.\n"),
768 r = LUKS_write_phdr(cd->device, &cd->hdr, cd);
773 static int _crypt_format_loopaes(struct crypt_device *cd,
776 size_t volume_key_size,
777 struct crypt_params_loopaes *params)
780 log_err(cd, _("Can't format LOOPAES without device.\n"));
784 if (volume_key_size > 1024) {
785 log_err(cd, _("Invalid key size.\n"));
789 cd->loopaes_key_size = volume_key_size;
791 cd->loopaes_cipher = strdup(cipher ?: DEFAULT_LOOPAES_CIPHER);
794 cd->loopaes_uuid = strdup(uuid);
796 if (params && params->hash)
797 cd->loopaes_hdr.hash = strdup(params->hash);
799 cd->loopaes_hdr.offset = params ? params->offset : 0;
800 cd->loopaes_hdr.skip = params ? params->skip : 0;
805 int crypt_format(struct crypt_device *cd,
808 const char *cipher_mode,
810 const char *volume_key,
811 size_t volume_key_size,
819 log_dbg("Formatting device %s as type %s.", cd->device ?: "(none)", type);
826 r = _crypt_format_plain(cd, cipher, cipher_mode,
827 uuid, volume_key_size, params);
828 else if (isLUKS(type))
829 r = _crypt_format_luks1(cd, cipher, cipher_mode,
830 uuid, volume_key, volume_key_size, params);
831 else if (isLOOPAES(type))
832 r = _crypt_format_loopaes(cd, cipher, uuid, volume_key_size, params);
834 /* FIXME: allow plugins here? */
835 log_err(cd, _("Unknown crypt device type %s requested.\n"), type);
839 if (!r && !(cd->type = strdup(type)))
843 crypt_free_volume_key(cd->volume_key);
844 cd->volume_key = NULL;
850 int crypt_load(struct crypt_device *cd,
851 const char *requested_type,
852 void *params __attribute__((unused)))
854 struct luks_phdr hdr;
857 log_dbg("Trying to load %s crypt type from device %s.",
858 requested_type ?: "any", cd->device ?: "(none)");
863 if (requested_type && !isLUKS(requested_type))
870 r = LUKS_read_phdr(cd->device, &hdr, 1, cd);
873 memcpy(&cd->hdr, &hdr, sizeof(hdr));
874 cd->type = strdup(CRYPT_LUKS1);
882 int crypt_resize(struct crypt_device *cd, const char *name, uint64_t new_size)
884 char *device = NULL, *cipher = NULL, *uuid = NULL, *key = NULL;
885 uint64_t size, skip, offset;
886 int key_size, read_only, r;
888 /* Device context type must be initialised */
889 if (!cd->type || !crypt_get_uuid(cd))
892 log_dbg("Resizing device %s to %" PRIu64 " sectors.", name, new_size);
894 r = dm_query_device(name, &device, &size, &skip, &offset,
895 &cipher, &key_size, &key, &read_only, NULL, &uuid);
897 log_err(NULL, _("Device %s is not active.\n"), name);
906 r = device_check_and_adjust(cd, device, DEV_OK, &new_size, &offset, &read_only);
910 if (new_size == size) {
911 log_dbg("Device has already requested size %" PRIu64
917 r = dm_create_device(name, device, cipher, cd->type,
918 crypt_get_uuid(cd), new_size, skip, offset,
919 key_size, key, read_only, 1);
921 crypt_safe_free(key);
929 int crypt_set_uuid(struct crypt_device *cd, const char *uuid)
931 if (!isLUKS(cd->type)) {
932 log_err(cd, _("This operation is not supported for this device type.\n"));
936 if (uuid && !strncmp(uuid, cd->hdr.uuid, sizeof(cd->hdr.uuid))) {
937 log_dbg("UUID is the same as requested (%s) for device %s.",
943 log_dbg("Requested new UUID change to %s for %s.", uuid, cd->device);
945 log_dbg("Requested new UUID refresh for %s.", cd->device);
947 if (!crypt_confirm(cd, _("Do you really want to change UUID of device?")))
950 return LUKS_hdr_uuid_set(cd->device, &cd->hdr, uuid, cd);
953 int crypt_header_backup(struct crypt_device *cd,
954 const char *requested_type,
955 const char *backup_file)
959 if ((requested_type && !isLUKS(requested_type)) || !backup_file)
966 log_dbg("Requested header backup of device %s (%s) to "
967 "file %s.", cd->device, requested_type, backup_file);
969 return LUKS_hdr_backup(backup_file, cd->device, &cd->hdr, cd);
972 int crypt_header_restore(struct crypt_device *cd,
973 const char *requested_type,
974 const char *backup_file)
978 if (requested_type && !isLUKS(requested_type))
981 /* Some hash functions need initialized gcrypt library */
986 log_dbg("Requested header restore to device %s (%s) from "
987 "file %s.", cd->device, requested_type, backup_file);
989 return LUKS_hdr_restore(backup_file, cd->device, &cd->hdr, cd);
992 void crypt_free(struct crypt_device *cd)
995 log_dbg("Releasing crypt device %s context.", cd->device);
997 if (cd->loop_fd != -1)
1001 crypt_free_volume_key(cd->volume_key);
1004 free(cd->backing_file);
1007 /* used in plain device only */
1008 free((char*)cd->plain_hdr.hash);
1009 free(cd->plain_cipher);
1010 free(cd->plain_cipher_mode);
1011 free(cd->plain_uuid);
1013 /* used in loop-AES device only */
1014 free((char*)cd->loopaes_hdr.hash);
1015 free(cd->loopaes_cipher);
1016 free(cd->loopaes_uuid);
1022 int crypt_suspend(struct crypt_device *cd,
1025 crypt_status_info ci;
1026 int r, suspended = 0;
1028 log_dbg("Suspending volume %s.", name);
1030 ci = crypt_status(NULL, name);
1031 if (ci < CRYPT_ACTIVE) {
1032 log_err(cd, _("Volume %s is not active.\n"), name);
1036 if (!cd && dm_init(NULL, 1) < 0)
1039 r = dm_query_device(name, NULL, NULL, NULL, NULL,
1040 NULL, NULL, NULL, NULL, &suspended, NULL);
1045 log_err(cd, _("Volume %s is already suspended.\n"), name);
1050 r = dm_suspend_and_wipe_key(name);
1052 log_err(cd, "Suspend is not supported for device %s.\n", name);
1054 log_err(cd, "Error during suspending device %s.\n", name);
1061 int crypt_resume_by_passphrase(struct crypt_device *cd,
1064 const char *passphrase,
1065 size_t passphrase_size)
1067 struct volume_key *vk = NULL;
1068 int r, suspended = 0;
1070 log_dbg("Resuming volume %s.", name);
1072 if (!isLUKS(cd->type)) {
1073 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1078 r = dm_query_device(name, NULL, NULL, NULL, NULL,
1079 NULL, NULL, NULL, NULL, &suspended, NULL);
1084 log_err(cd, _("Volume %s is not suspended.\n"), name);
1089 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1090 passphrase_size, &cd->hdr, &vk, cd);
1092 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1096 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1098 log_err(cd, "Resume is not supported for device %s.\n", name);
1100 log_err(cd, "Error during resuming device %s.\n", name);
1104 crypt_free_volume_key(vk);
1105 return r < 0 ? r : keyslot;
1108 int crypt_resume_by_keyfile(struct crypt_device *cd,
1111 const char *keyfile,
1112 size_t keyfile_size)
1114 struct volume_key *vk = NULL;
1115 char *passphrase_read = NULL;
1116 size_t passphrase_size_read;
1117 int r, suspended = 0;
1119 log_dbg("Resuming volume %s.", name);
1121 if (!isLUKS(cd->type)) {
1122 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1127 r = dm_query_device(name, NULL, NULL, NULL, NULL,
1128 NULL, NULL, NULL, NULL, &suspended, NULL);
1133 log_err(cd, _("Volume %s is not suspended.\n"), name);
1140 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1141 &passphrase_size_read, keyfile, keyfile_size);
1145 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
1146 passphrase_size_read, &cd->hdr, &vk, cd);
1151 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1153 log_err(cd, "Error during resuming device %s.\n", name);
1155 crypt_safe_free(passphrase_read);
1156 crypt_free_volume_key(vk);
1157 return r < 0 ? r : keyslot;
1160 // slot manipulation
1161 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
1162 int keyslot, // -1 any
1163 const char *passphrase, // NULL -> terminal
1164 size_t passphrase_size,
1165 const char *new_passphrase, // NULL -> terminal
1166 size_t new_passphrase_size)
1168 struct volume_key *vk = NULL;
1169 char *password = NULL, *new_password = NULL;
1170 size_t passwordLen, new_passwordLen;
1173 log_dbg("Adding new keyslot, existing passphrase %sprovided,"
1174 "new passphrase %sprovided.",
1175 passphrase ? "" : "not ", new_passphrase ? "" : "not ");
1177 if (!isLUKS(cd->type)) {
1178 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1182 r = keyslot_verify_or_find_empty(cd, &keyslot);
1186 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1187 /* No slots used, try to use pre-generated key in header */
1188 if (cd->volume_key) {
1189 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1190 r = vk ? 0 : -ENOMEM;
1192 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1195 } else if (passphrase) {
1196 /* Passphrase provided, use it to unlock existing keyslot */
1197 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, passphrase,
1198 passphrase_size, &cd->hdr, &vk, cd);
1200 /* Passphrase not provided, ask first and use it to unlock existing keyslot */
1201 r = key_from_terminal(cd, _("Enter any passphrase: "),
1202 &password, &passwordLen, 0);
1206 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password,
1207 passwordLen, &cd->hdr, &vk, cd);
1208 crypt_safe_free(password);
1214 if (new_passphrase) {
1215 new_password = (char *)new_passphrase;
1216 new_passwordLen = new_passphrase_size;
1218 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1219 &new_password, &new_passwordLen, 1);
1224 r = LUKS_set_key(cd->device, keyslot, new_password, new_passwordLen,
1225 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1230 if (!new_passphrase)
1231 crypt_safe_free(new_password);
1232 crypt_free_volume_key(vk);
1233 return r ?: keyslot;
1236 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
1238 const char *keyfile,
1239 size_t keyfile_size,
1240 const char *new_keyfile,
1241 size_t new_keyfile_size)
1243 struct volume_key *vk = NULL;
1244 char *password = NULL; size_t passwordLen;
1245 char *new_password = NULL; size_t new_passwordLen;
1248 log_dbg("Adding new keyslot, existing keyfile %s, new keyfile %s.",
1249 keyfile ?: "[none]", new_keyfile ?: "[none]");
1251 if (!isLUKS(cd->type)) {
1252 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1256 r = keyslot_verify_or_find_empty(cd, &keyslot);
1260 if (!LUKS_keyslot_active_count(&cd->hdr)) {
1261 /* No slots used, try to use pre-generated key in header */
1262 if (cd->volume_key) {
1263 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1264 r = vk ? 0 : -ENOMEM;
1266 log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1270 /* Read password from file of (if NULL) from terminal */
1272 r = key_from_file(cd, _("Enter any passphrase: "),
1273 &password, &passwordLen,
1274 keyfile, keyfile_size);
1276 r = key_from_terminal(cd, _("Enter any passphrase: "),
1277 &password, &passwordLen, 0);
1281 r = LUKS_open_key_with_hdr(cd->device, CRYPT_ANY_SLOT, password, passwordLen,
1289 r = key_from_file(cd, _("Enter new passphrase for key slot: "),
1290 &new_password, &new_passwordLen, new_keyfile,
1293 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1294 &new_password, &new_passwordLen, 1);
1298 r = LUKS_set_key(cd->device, keyslot, new_password, new_passwordLen,
1299 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1301 crypt_safe_free(password);
1302 crypt_safe_free(new_password);
1303 crypt_free_volume_key(vk);
1304 return r < 0 ? r : keyslot;
1307 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
1309 const char *volume_key,
1310 size_t volume_key_size,
1311 const char *passphrase,
1312 size_t passphrase_size)
1314 struct volume_key *vk = NULL;
1316 char *new_password = NULL; size_t new_passwordLen;
1318 log_dbg("Adding new keyslot %d using volume key.", keyslot);
1320 if (!isLUKS(cd->type)) {
1321 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1326 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1327 else if (cd->volume_key)
1328 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1333 r = LUKS_verify_volume_key(&cd->hdr, vk);
1335 log_err(cd, _("Volume key does not match the volume.\n"));
1339 r = keyslot_verify_or_find_empty(cd, &keyslot);
1344 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1345 &new_password, &new_passwordLen, 1);
1348 passphrase = new_password;
1349 passphrase_size = new_passwordLen;
1352 r = LUKS_set_key(cd->device, keyslot, passphrase, passphrase_size,
1353 &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1355 crypt_safe_free(new_password);
1356 crypt_free_volume_key(vk);
1357 return (r < 0) ? r : keyslot;
1360 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot)
1362 crypt_keyslot_info ki;
1364 log_dbg("Destroying keyslot %d.", keyslot);
1366 if (!isLUKS(cd->type)) {
1367 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1371 ki = crypt_keyslot_status(cd, keyslot);
1372 if (ki == CRYPT_SLOT_INVALID) {
1373 log_err(cd, _("Key slot %d is invalid.\n"), keyslot);
1377 if (ki == CRYPT_SLOT_INACTIVE) {
1378 log_err(cd, _("Key slot %d is not used.\n"), keyslot);
1382 return LUKS_del_key(cd->device, keyslot, &cd->hdr, cd);
1385 // activation/deactivation of device mapping
1386 int crypt_activate_by_passphrase(struct crypt_device *cd,
1389 const char *passphrase,
1390 size_t passphrase_size,
1393 crypt_status_info ci;
1394 struct volume_key *vk = NULL;
1395 char *read_passphrase = NULL;
1396 size_t passphraseLen = 0;
1399 log_dbg("%s volume %s [keyslot %d] using %spassphrase.",
1400 name ? "Activating" : "Checking", name ?: "",
1401 keyslot, passphrase ? "" : "[none] ");
1404 ci = crypt_status(NULL, name);
1405 if (ci == CRYPT_INVALID)
1407 else if (ci >= CRYPT_ACTIVE) {
1408 log_err(cd, _("Device %s already exists.\n"), name);
1413 /* plain, use hashed passphrase */
1414 if (isPLAIN(cd->type)) {
1416 r = key_from_terminal(cd, NULL, &read_passphrase,
1420 passphrase = read_passphrase;
1421 passphrase_size = passphraseLen;
1423 r = create_device_helper(cd, name, cd->plain_hdr.hash,
1424 cd->plain_cipher, cd->plain_cipher_mode,
1425 NULL, passphrase, passphrase_size,
1426 cd->volume_key->keylength, cd->plain_hdr.size,
1427 cd->plain_hdr.skip, cd->plain_hdr.offset,
1428 cd->plain_uuid, flags, 0);
1430 } else if (isLUKS(cd->type)) {
1431 /* provided passphrase, do not retry */
1433 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1434 passphrase_size, &cd->hdr, &vk, cd);
1436 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1441 r = open_from_hdr_and_vk(cd, vk, name, flags);
1446 crypt_safe_free(read_passphrase);
1447 crypt_free_volume_key(vk);
1449 return r < 0 ? r : keyslot;
1452 int crypt_activate_by_keyfile(struct crypt_device *cd,
1455 const char *keyfile,
1456 size_t keyfile_size,
1459 crypt_status_info ci;
1460 struct volume_key *vk = NULL;
1461 char *passphrase_read = NULL;
1462 size_t passphrase_size_read;
1463 unsigned int key_count = 0;
1466 log_dbg("Activating volume %s [keyslot %d] using keyfile %s.",
1467 name ?: "", keyslot, keyfile ?: "[none]");
1470 ci = crypt_status(NULL, name);
1471 if (ci == CRYPT_INVALID)
1473 else if (ci >= CRYPT_ACTIVE) {
1474 log_err(cd, _("Device %s already exists.\n"), name);
1482 if (isPLAIN(cd->type)) {
1483 r = key_from_file(cd, _("Enter passphrase: "),
1484 &passphrase_read, &passphrase_size_read,
1485 keyfile, keyfile_size);
1488 r = create_device_helper(cd, name, cd->plain_hdr.hash,
1489 cd->plain_cipher, cd->plain_cipher_mode,
1490 NULL, passphrase_read, passphrase_size_read,
1491 cd->volume_key->keylength, cd->plain_hdr.size,
1492 cd->plain_hdr.skip, cd->plain_hdr.offset,
1493 cd->plain_uuid, flags, 0);
1494 } else if (isLUKS(cd->type)) {
1495 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1496 &passphrase_size_read, keyfile, keyfile_size);
1499 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase_read,
1500 passphrase_size_read, &cd->hdr, &vk, cd);
1506 r = open_from_hdr_and_vk(cd, vk, name, flags);
1511 } else if (isLOOPAES(cd->type)) {
1512 r = key_from_file(cd, NULL, &passphrase_read, &passphrase_size_read,
1513 keyfile, keyfile_size);
1516 r = LOOPAES_parse_keyfile(cd, &vk, cd->loopaes_hdr.hash, &key_count,
1517 passphrase_read, passphrase_size_read);
1521 r = LOOPAES_activate(cd, name, cd->loopaes_cipher,
1523 cd->loopaes_hdr.offset,
1524 cd->loopaes_hdr.skip,
1530 crypt_safe_free(passphrase_read);
1531 crypt_free_volume_key(vk);
1536 int crypt_activate_by_volume_key(struct crypt_device *cd,
1538 const char *volume_key,
1539 size_t volume_key_size,
1542 crypt_status_info ci;
1543 struct volume_key *vk;
1546 log_dbg("Activating volume %s by volume key.", name);
1548 /* use key directly, no hash */
1549 if (isPLAIN(cd->type)) {
1550 if (!volume_key || !volume_key_size || !cd->volume_key ||
1551 volume_key_size != cd->volume_key->keylength) {
1552 log_err(cd, _("Incorrect volume key specified for plain device.\n"));
1556 return create_device_helper(cd, name, NULL,
1557 cd->plain_cipher, cd->plain_cipher_mode, NULL, volume_key, volume_key_size,
1558 cd->volume_key->keylength, cd->plain_hdr.size, cd->plain_hdr.skip,
1559 cd->plain_hdr.offset, cd->plain_uuid, flags, 0);
1562 if (!isLUKS(cd->type)) {
1563 log_err(cd, _("Device type is not properly initialised.\n"));
1568 ci = crypt_status(NULL, name);
1569 if (ci == CRYPT_INVALID)
1571 else if (ci >= CRYPT_ACTIVE) {
1572 log_err(cd, _("Device %s already exists.\n"), name);
1577 /* If key is not provided, try to use internal key */
1579 if (!cd->volume_key) {
1580 log_err(cd, _("Volume key does not match the volume.\n"));
1583 volume_key_size = cd->volume_key->keylength;
1584 volume_key = cd->volume_key->key;
1587 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1590 r = LUKS_verify_volume_key(&cd->hdr, vk);
1593 log_err(cd, _("Volume key does not match the volume.\n"));
1596 r = open_from_hdr_and_vk(cd, vk, name, flags);
1598 crypt_free_volume_key(vk);
1603 int crypt_deactivate(struct crypt_device *cd, const char *name)
1610 log_dbg("Deactivating volume %s.", name);
1612 if (!cd && dm_init(NULL, 1) < 0)
1615 switch (crypt_status(cd, name)) {
1617 r = dm_remove_device(name, 0, 0);
1620 log_err(cd, _("Device %s is busy.\n"), name);
1623 case CRYPT_INACTIVE:
1624 log_err(cd, _("Device %s is not active.\n"), name);
1628 log_err(cd, _("Invalid device %s.\n"), name);
1638 int crypt_volume_key_get(struct crypt_device *cd,
1641 size_t *volume_key_size,
1642 const char *passphrase,
1643 size_t passphrase_size)
1645 struct volume_key *vk;
1646 char *processed_key = NULL;
1650 key_len = crypt_get_volume_key_size(cd);
1651 if (key_len > *volume_key_size) {
1652 log_err(cd, _("Volume key buffer too small.\n"));
1656 if (isPLAIN(cd->type) && cd->plain_hdr.hash) {
1657 processed_key = process_key(cd, cd->plain_hdr.hash, NULL, key_len,
1658 passphrase, passphrase_size);
1659 if (!processed_key) {
1660 log_err(cd, _("Cannot retrieve volume key for plain device.\n"));
1663 memcpy(volume_key, processed_key, key_len);
1664 *volume_key_size = key_len;
1665 crypt_safe_free(processed_key);
1669 if (isLUKS(cd->type)) {
1670 r = LUKS_open_key_with_hdr(cd->device, keyslot, passphrase,
1671 passphrase_size, &cd->hdr, &vk, cd);
1674 memcpy(volume_key, vk->key, vk->keylength);
1675 *volume_key_size = vk->keylength;
1678 crypt_free_volume_key(vk);
1682 log_err(cd, _("This operation is not supported for %s crypt device.\n"), cd->type ?: "(none)");
1686 int crypt_volume_key_verify(struct crypt_device *cd,
1687 const char *volume_key,
1688 size_t volume_key_size)
1690 struct volume_key *vk;
1693 if (!isLUKS(cd->type)) {
1694 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1698 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1702 r = LUKS_verify_volume_key(&cd->hdr, vk);
1705 log_err(cd, _("Volume key does not match the volume.\n"));
1707 crypt_free_volume_key(vk);
1712 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec)
1714 log_dbg("Timeout set to %" PRIu64 " miliseconds.", timeout_sec);
1715 cd->timeout = timeout_sec;
1718 void crypt_set_password_retry(struct crypt_device *cd, int tries)
1720 log_dbg("Password retry count set to %d.", tries);
1724 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms)
1726 log_dbg("Iteration time set to %" PRIu64 " miliseconds.", iteration_time_ms);
1727 cd->iteration_time = iteration_time_ms;
1730 void crypt_set_password_verify(struct crypt_device *cd, int password_verify)
1732 log_dbg("Password verification %s.", password_verify ? "enabled" : "disabled");
1733 cd->password_verify = password_verify ? 1 : 0;
1736 void crypt_set_rng_type(struct crypt_device *cd, int rng_type)
1739 case CRYPT_RNG_URANDOM:
1740 case CRYPT_RNG_RANDOM:
1741 log_dbg("RNG set to %d (%s).", rng_type, rng_type ? "random" : "urandom");
1742 cd->rng_type = rng_type;
1746 int crypt_get_rng_type(struct crypt_device *cd)
1751 return cd->rng_type;
1754 int crypt_memory_lock(struct crypt_device *cd, int lock)
1756 return lock ? crypt_memlock_inc(cd) : crypt_memlock_dec(cd);
1760 crypt_status_info crypt_status(struct crypt_device *cd, const char *name)
1764 if (!cd && dm_init(NULL, 1) < 0)
1765 return CRYPT_INVALID;
1767 r = dm_status_device(name);
1772 if (r < 0 && r != -ENODEV)
1773 return CRYPT_INVALID;
1776 return CRYPT_ACTIVE;
1781 return CRYPT_INACTIVE;
1784 static void hexprintICB(struct crypt_device *cd, char *d, int n)
1787 for(i = 0; i < n; i++)
1788 log_std(cd, "%02hhx ", (char)d[i]);
1791 int crypt_dump(struct crypt_device *cd)
1794 if (!isLUKS(cd->type)) { //FIXME
1795 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1799 log_std(cd, "LUKS header information for %s\n\n", cd->device);
1800 log_std(cd, "Version: \t%d\n", cd->hdr.version);
1801 log_std(cd, "Cipher name: \t%s\n", cd->hdr.cipherName);
1802 log_std(cd, "Cipher mode: \t%s\n", cd->hdr.cipherMode);
1803 log_std(cd, "Hash spec: \t%s\n", cd->hdr.hashSpec);
1804 log_std(cd, "Payload offset:\t%d\n", cd->hdr.payloadOffset);
1805 log_std(cd, "MK bits: \t%d\n", cd->hdr.keyBytes * 8);
1806 log_std(cd, "MK digest: \t");
1807 hexprintICB(cd, cd->hdr.mkDigest, LUKS_DIGESTSIZE);
1809 log_std(cd, "MK salt: \t");
1810 hexprintICB(cd, cd->hdr.mkDigestSalt, LUKS_SALTSIZE/2);
1811 log_std(cd, "\n \t");
1812 hexprintICB(cd, cd->hdr.mkDigestSalt+LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1814 log_std(cd, "MK iterations: \t%d\n", cd->hdr.mkDigestIterations);
1815 log_std(cd, "UUID: \t%s\n\n", cd->hdr.uuid);
1816 for(i = 0; i < LUKS_NUMKEYS; i++) {
1817 if(cd->hdr.keyblock[i].active == LUKS_KEY_ENABLED) {
1818 log_std(cd, "Key Slot %d: ENABLED\n",i);
1819 log_std(cd, "\tIterations: \t%d\n",
1820 cd->hdr.keyblock[i].passwordIterations);
1821 log_std(cd, "\tSalt: \t");
1822 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt,
1824 log_std(cd, "\n\t \t");
1825 hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt +
1826 LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1829 log_std(cd, "\tKey material offset:\t%d\n",
1830 cd->hdr.keyblock[i].keyMaterialOffset);
1831 log_std(cd, "\tAF stripes: \t%d\n",
1832 cd->hdr.keyblock[i].stripes);
1835 log_std(cd, "Key Slot %d: DISABLED\n", i);
1841 const char *crypt_get_cipher(struct crypt_device *cd)
1843 if (isPLAIN(cd->type))
1844 return cd->plain_cipher;
1846 if (isLUKS(cd->type))
1847 return cd->hdr.cipherName;
1849 if (isLOOPAES(cd->type))
1850 return cd->loopaes_cipher;
1855 const char *crypt_get_cipher_mode(struct crypt_device *cd)
1857 if (isPLAIN(cd->type))
1858 return cd->plain_cipher_mode;
1860 if (isLUKS(cd->type))
1861 return cd->hdr.cipherMode;
1863 if (isLOOPAES(cd->type))
1864 return cd->loopaes_cipher_mode;
1869 const char *crypt_get_uuid(struct crypt_device *cd)
1871 if (isLUKS(cd->type))
1872 return cd->hdr.uuid;
1874 if (isPLAIN(cd->type))
1875 return cd->plain_uuid;
1877 if (isLOOPAES(cd->type))
1878 return cd->loopaes_uuid;
1883 const char *crypt_get_device_name(struct crypt_device *cd)
1888 int crypt_get_volume_key_size(struct crypt_device *cd)
1890 if (isPLAIN(cd->type) && cd->volume_key)
1891 return cd->volume_key->keylength;
1893 if (isLUKS(cd->type))
1894 return cd->hdr.keyBytes;
1896 if (isLOOPAES(cd->type))
1897 return cd->loopaes_key_size;
1902 uint64_t crypt_get_data_offset(struct crypt_device *cd)
1904 if (isPLAIN(cd->type))
1905 return cd->plain_hdr.offset;
1907 if (isLUKS(cd->type))
1908 return cd->hdr.payloadOffset;
1910 if (isLOOPAES(cd->type))
1911 return cd->loopaes_hdr.offset;
1916 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot)
1918 if (!isLUKS(cd->type)) {
1919 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1920 return CRYPT_SLOT_INVALID;
1923 return LUKS_keyslot_info(&cd->hdr, keyslot);
1926 int crypt_keyslot_max(const char *type)
1928 if (type && isLUKS(type))
1929 return LUKS_NUMKEYS;
1934 const char *crypt_get_type(struct crypt_device *cd)
1939 int crypt_get_active_device(struct crypt_device *cd __attribute__((unused)),
1941 struct crypt_active_device *cad)
1945 r = dm_query_device(name, NULL, &cad->size, &cad->iv_offset, &cad->offset,
1946 NULL, NULL, NULL, &readonly, NULL, NULL);
1950 cad->flags = readonly ? CRYPT_ACTIVATE_READONLY : 0;