2 * cryptsetup-reencrypt - crypt utility for offline re-encryption
4 * Copyright (C) 2012, Milan Broz All rights reserved.
5 * Copyright (C) 2012, Red Hat, Inc. All rights reserved.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #define PACKAGE_REENC "crypt_reencrypt"
23 #define _LARGEFILE64_SOURCE
24 #define _FILE_OFFSET_BITS 64
25 #define SECTOR_SIZE 512
26 #define ROUND_SECTOR(x) (((x) + SECTOR_SIZE - 1) / SECTOR_SIZE)
27 #define NO_UUID "cafecafe-cafe-cafe-cafe-cafecafeeeee"
28 #define MAX_BCK_SECTORS 8192
39 #include <sys/ioctl.h>
42 #include <arpa/inet.h>
47 #include "cryptsetup.h"
49 static int opt_verbose = 0;
50 static int opt_debug = 0;
51 static const char *opt_cipher = NULL;
52 static const char *opt_hash = NULL;
53 static const char *opt_key_file = NULL;
54 static long opt_keyfile_size = 0;
55 static long opt_keyfile_offset = 0;
56 static int opt_iteration_time = 1000;
57 static int opt_batch_mode = 0;
58 static int opt_version_mode = 0;
59 static int opt_random = 0;
60 static int opt_urandom = 0;
61 static int opt_bsize = 4;
62 static int opt_directio = 0;
63 static int opt_fsync = 0;
64 static int opt_write_log = 0;
65 static int opt_tries = 3;
66 static int opt_key_slot = CRYPT_ANY_SLOT;
67 static int opt_key_size = 0;
68 static int opt_new = 0;
70 static const char *opt_reduce_size_str = NULL;
71 static uint64_t opt_reduce_size = 0;
73 static const char *opt_device_size_str = NULL;
74 static uint64_t opt_device_size = 0;
76 static const char **action_argv;
78 static volatile int quit = 0;
84 uint64_t device_size; /* overrided by parameter */
85 uint64_t device_size_real;
86 uint64_t device_offset;
87 uint64_t device_shift;
90 enum { FORWARD = 0, BACKWARD = 1 } reencrypt_direction;
92 char header_file_org[PATH_MAX];
93 char header_file_new[PATH_MAX];
94 char log_file[PATH_MAX];
96 char crypt_path_org[PATH_MAX];
97 char crypt_path_new[PATH_MAX];
107 struct timeval start_time, end_time;
108 uint64_t resume_bytes;
111 char MAGIC[] = {'L','U','K','S', 0xba, 0xbe};
112 char NOMAGIC[] = {'L','U','K','S', 0xde, 0xad};
122 __attribute__((format(printf, 5, 6)))
123 static void clogger(struct crypt_device *cd, int level, const char *file,
124 int line, const char *format, ...)
129 va_start(argp, format);
131 if (vasprintf(&target, format, argp) > 0) {
133 crypt_log(cd, level, target);
134 } else if (opt_debug)
135 printf("# %s\n", target);
142 static void _log(int level, const char *msg, void *usrptr __attribute__((unused)))
146 case CRYPT_LOG_NORMAL:
149 case CRYPT_LOG_VERBOSE:
153 case CRYPT_LOG_ERROR:
156 case CRYPT_LOG_DEBUG:
158 printf("# %s\n", msg);
161 fprintf(stderr, "Internal error on logging class for msg: %s", msg);
166 static void _quiet_log(int level, const char *msg, void *usrptr)
170 _log(level, msg, usrptr);
173 static void int_handler(int sig __attribute__((__unused__)))
178 static void set_int_block(int block)
180 sigset_t signals_open;
182 sigemptyset(&signals_open);
183 sigaddset(&signals_open, SIGINT);
184 sigaddset(&signals_open, SIGTERM);
185 sigprocmask(block ? SIG_SETMASK : SIG_UNBLOCK, &signals_open, NULL);
188 static void set_int_handler(void)
190 struct sigaction sigaction_open;
192 memset(&sigaction_open, 0, sizeof(struct sigaction));
193 sigaction_open.sa_handler = int_handler;
194 sigaction(SIGINT, &sigaction_open, 0);
195 sigaction(SIGTERM, &sigaction_open, 0);
199 /* The difference in seconds between two times in "timeval" format. */
200 static double time_diff(struct timeval start, struct timeval end)
202 return (end.tv_sec - start.tv_sec)
203 + (end.tv_usec - start.tv_usec) / 1E6;
206 static int alignment(int fd)
210 alignment = fpathconf(fd, _PC_REC_XFER_ALIGN);
216 /* Depends on the first two fields of LUKS1 header format, magic and version */
217 static int device_check(struct reenc_ctx *rc, header_magic set_magic)
224 devfd = open(rc->device, O_RDWR | O_EXCL | O_DIRECT);
226 if (errno == EBUSY) {
227 log_err(_("Cannot exclusively open %s, device in use.\n"),
231 log_err(_("Cannot open device %s\n"), rc->device);
235 if (set_magic == CHECK_OPEN) {
240 if (posix_memalign((void *)&buf, alignment(devfd), SECTOR_SIZE)) {
241 log_err(_("Allocation of aligned memory failed.\n"));
246 s = read(devfd, buf, SECTOR_SIZE);
247 if (s < 0 || s != SECTOR_SIZE) {
248 log_err(_("Cannot read device %s.\n"), rc->device);
253 /* Be sure that we do not process new version of header */
254 memcpy((void*)&version, &buf[MAGIC_L], sizeof(uint16_t));
255 version = ntohs(version);
257 if (set_magic == MAKE_UNUSABLE && !memcmp(buf, MAGIC, MAGIC_L) &&
259 log_verbose(_("Marking LUKS device %s unusable.\n"), rc->device);
260 memcpy(buf, NOMAGIC, MAGIC_L);
262 } else if (set_magic == MAKE_USABLE && !memcmp(buf, NOMAGIC, MAGIC_L) &&
264 log_verbose(_("Marking LUKS device %s usable.\n"), rc->device);
265 memcpy(buf, MAGIC, MAGIC_L);
267 } else if (set_magic == CHECK_UNUSABLE && version == 1) {
268 r = memcmp(buf, NOMAGIC, MAGIC_L) ? -EINVAL : 0;
270 rc->device_uuid = strndup(&buf[0xa8], 40);
276 if (lseek(devfd, 0, SEEK_SET) == -1)
278 s = write(devfd, buf, SECTOR_SIZE);
279 if (s < 0 || s != SECTOR_SIZE) {
280 log_err(_("Cannot write device %s.\n"), rc->device);
284 log_dbg("LUKS signature check failed for %s.", rc->device);
287 memset(buf, 0, SECTOR_SIZE);
293 static int create_empty_header(const char *new_file, const char *old_file,
294 uint64_t data_sector)
301 /* Never create header > 4MiB */
302 if (data_sector > MAX_BCK_SECTORS)
303 data_sector = MAX_BCK_SECTORS;
305 /* new header file of the same size as old backup */
307 if (stat(old_file, &st) == -1 ||
308 (st.st_mode & S_IFMT) != S_IFREG ||
309 (st.st_size > 16 * 1024 * 1024))
315 * if requesting key size change, try to use offset
316 * here can be enough space to fit new key.
319 size = data_sector * SECTOR_SIZE;
321 /* if reducing size, be sure we have enough space */
323 size += opt_reduce_size;
325 log_dbg("Creating empty file %s of size %lu.", new_file, (unsigned long)size);
327 if (!size || !(buf = malloc(size)))
329 memset(buf, 0, size);
331 fd = creat(new_file, S_IRUSR|S_IWUSR);
337 if (write(fd, buf, size) < size)
345 static int write_log(struct reenc_ctx *rc)
349 memset(rc->log_buf, 0, SECTOR_SIZE);
350 snprintf(rc->log_buf, SECTOR_SIZE, "# LUKS reencryption log, DO NOT EDIT OR DELETE.\n"
351 "version = %d\nUUID = %s\ndirection = %d\n"
352 "offset = %" PRIu64 "\nshift = %" PRIu64 "\n# EOF\n",
353 1, rc->device_uuid, rc->reencrypt_direction,
354 rc->device_offset, rc->device_shift);
356 lseek(rc->log_fd, 0, SEEK_SET);
357 r = write(rc->log_fd, rc->log_buf, SECTOR_SIZE);
358 if (r < 0 || r != SECTOR_SIZE) {
359 log_err(_("Cannot write reencryption log file.\n"));
366 static int parse_line_log(struct reenc_ctx *rc, const char *line)
372 /* whole line is comment */
376 if (sscanf(line, "version = %d", &i) == 1) {
378 log_dbg("Log: Unexpected version = %i", i);
381 } else if (sscanf(line, "UUID = %40s", s) == 1) {
382 if (!rc->device_uuid || strcmp(rc->device_uuid, s)) {
383 log_dbg("Log: Unexpected UUID %s", s);
386 } else if (sscanf(line, "direction = %d", &i) == 1) {
387 log_dbg("Log: direction = %i", i);
388 rc->reencrypt_direction = i;
389 } else if (sscanf(line, "offset = %" PRIu64, &u64) == 1) {
390 log_dbg("Log: offset = %" PRIu64, u64);
391 rc->device_offset = u64;
392 } else if (sscanf(line, "shift = %" PRIu64, &u64) == 1) {
393 log_dbg("Log: shift = %" PRIu64, u64);
394 rc->device_shift = u64;
401 static int parse_log(struct reenc_ctx *rc)
406 s = read(rc->log_fd, rc->log_buf, SECTOR_SIZE);
408 log_err(_("Cannot read reencryption log file.\n"));
412 rc->log_buf[SECTOR_SIZE - 1] = '\0';
415 end = strchr(start, '\n');
418 if (parse_line_log(rc, start)) {
419 log_err("Wrong log format.\n");
430 static void close_log(struct reenc_ctx *rc)
432 log_dbg("Closing LUKS reencryption log file %s.", rc->log_file);
433 if (rc->log_fd != -1)
439 static int open_log(struct reenc_ctx *rc)
441 int flags, create_new;
444 if (!stat(rc->log_file, &st))
446 else if (errno == ENOENT)
452 log_dbg("Creating LUKS reencryption log file %s.", rc->log_file);
453 flags = opt_directio ? O_RDWR|O_CREAT|O_DIRECT : O_RDWR|O_CREAT;
454 rc->log_fd = open(rc->log_file, flags, S_IRUSR|S_IWUSR);
455 if (rc->log_fd == -1)
458 log_std(_("Log file %s exists, resuming reencryption.\n"), rc->log_file);
459 flags = opt_directio ? O_RDWR|O_DIRECT : O_RDWR;
460 rc->log_fd = open(rc->log_file, flags);
461 if (rc->log_fd == -1)
466 if (posix_memalign((void *)&rc->log_buf, alignment(rc->log_fd), SECTOR_SIZE)) {
467 log_err(_("Allocation of aligned memory failed.\n"));
472 if (create_new && write_log(rc) < 0) {
477 /* Be sure it is correct format */
478 return parse_log(rc);
481 static int activate_luks_headers(struct reenc_ctx *rc)
483 struct crypt_device *cd = NULL, *cd_new = NULL;
486 log_dbg("Activating LUKS devices from headers.");
488 if ((r = crypt_init(&cd, rc->header_file_org)) ||
489 (r = crypt_load(cd, CRYPT_LUKS1, NULL)) ||
490 (r = crypt_set_data_device(cd, rc->device)))
493 if ((r = crypt_activate_by_passphrase(cd, rc->header_file_org,
494 opt_key_slot, rc->p[rc->keyslot].password, rc->p[rc->keyslot].passwordLen,
495 CRYPT_ACTIVATE_READONLY|CRYPT_ACTIVATE_PRIVATE)) < 0)
498 if ((r = crypt_init(&cd_new, rc->header_file_new)) ||
499 (r = crypt_load(cd_new, CRYPT_LUKS1, NULL)) ||
500 (r = crypt_set_data_device(cd_new, rc->device)))
503 if ((r = crypt_activate_by_passphrase(cd_new, rc->header_file_new,
504 opt_key_slot, rc->p[rc->keyslot].password, rc->p[rc->keyslot].passwordLen,
505 CRYPT_ACTIVATE_SHARED|CRYPT_ACTIVATE_PRIVATE)) < 0)
512 log_err(_("Activation of temporary devices failed.\n"));
516 static int create_new_header(struct reenc_ctx *rc, const char *cipher,
517 const char *cipher_mode, const char *uuid,
518 int key_size, struct crypt_params_luks1 *params)
520 struct crypt_device *cd_new = NULL;
523 if ((r = crypt_init(&cd_new, rc->header_file_new)))
527 crypt_set_rng_type(cd_new, CRYPT_RNG_RANDOM);
528 else if (opt_urandom)
529 crypt_set_rng_type(cd_new, CRYPT_RNG_URANDOM);
531 if (opt_iteration_time)
532 crypt_set_iteration_time(cd_new, opt_iteration_time);
534 if ((r = crypt_format(cd_new, CRYPT_LUKS1, cipher, cipher_mode,
535 uuid, NULL, key_size, params)))
537 log_verbose(_("New LUKS header for device %s created.\n"), rc->device);
539 for (i = 0; i < MAX_SLOT; i++) {
540 if (!rc->p[i].password)
542 if ((r = crypt_keyslot_add_by_volume_key(cd_new, i,
543 NULL, 0, rc->p[i].password, rc->p[i].passwordLen)) < 0)
545 log_verbose(_("Activated keyslot %i.\n"), r);
553 static int backup_luks_headers(struct reenc_ctx *rc)
555 struct crypt_device *cd = NULL;
556 struct crypt_params_luks1 params = {0};
557 char cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
560 log_dbg("Creating LUKS header backup for device %s.", rc->device);
562 if ((r = crypt_init(&cd, rc->device)) ||
563 (r = crypt_load(cd, CRYPT_LUKS1, NULL)))
566 crypt_set_confirm_callback(cd, NULL, NULL);
567 if ((r = crypt_header_backup(cd, CRYPT_LUKS1, rc->header_file_org)))
569 log_verbose(_("LUKS header backup of device %s created.\n"), rc->device);
571 if ((r = create_empty_header(rc->header_file_new, rc->header_file_org,
572 crypt_get_data_offset(cd))))
575 params.hash = opt_hash ?: DEFAULT_LUKS1_HASH;
576 params.data_alignment = crypt_get_data_offset(cd);
577 params.data_alignment += ROUND_SECTOR(opt_reduce_size);
578 params.data_device = rc->device;
581 r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, cipher_mode);
583 log_err(_("No known cipher specification pattern detected.\n"));
588 r = create_new_header(rc,
589 opt_cipher ? cipher : crypt_get_cipher(cd),
590 opt_cipher ? cipher_mode : crypt_get_cipher_mode(cd),
592 opt_key_size ? opt_key_size / 8 : crypt_get_volume_key_size(cd),
597 log_err(_("Creation of LUKS backup headers failed.\n"));
601 /* Create fake header for original device */
602 static int backup_fake_header(struct reenc_ctx *rc)
604 struct crypt_device *cd_new = NULL;
605 struct crypt_params_luks1 params = {0};
606 char cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
610 log_dbg("Creating fake (cipher_null) header for original device.");
613 opt_key_size = DEFAULT_LUKS1_KEYBITS;
616 r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, cipher_mode);
618 log_err(_("No known cipher specification pattern detected.\n"));
623 r = create_empty_header(rc->header_file_org, NULL, 0);
627 params.hash = opt_hash ?: DEFAULT_LUKS1_HASH;
628 params.data_alignment = 0;
629 params.data_device = rc->device;
631 r = crypt_init(&cd_new, rc->header_file_org);
635 r = crypt_format(cd_new, CRYPT_LUKS1, "cipher_null", "ecb",
636 NO_UUID, NULL, opt_key_size / 8, ¶ms);
640 r = crypt_keyslot_add_by_volume_key(cd_new, 0, NULL, 0,
641 rc->p[0].password, rc->p[0].passwordLen);
645 r = create_empty_header(rc->header_file_new, rc->header_file_org, 0);
649 params.data_alignment = ROUND_SECTOR(opt_reduce_size);
650 r = create_new_header(rc,
651 opt_cipher ? cipher : DEFAULT_LUKS1_CIPHER,
652 opt_cipher ? cipher_mode : DEFAULT_LUKS1_MODE,
654 (opt_key_size ? opt_key_size : DEFAULT_LUKS1_KEYBITS) / 8,
661 static void remove_headers(struct reenc_ctx *rc)
663 struct crypt_device *cd = NULL;
665 log_dbg("Removing headers.");
667 if (crypt_init(&cd, NULL))
669 crypt_set_log_callback(cd, _quiet_log, NULL);
670 if (*rc->header_file_org)
671 (void)crypt_deactivate(cd, rc->header_file_org);
672 if (*rc->header_file_new)
673 (void)crypt_deactivate(cd, rc->header_file_new);
677 static int restore_luks_header(struct reenc_ctx *rc)
679 struct crypt_device *cd = NULL;
682 log_dbg("Restoring header for %s from %s.", rc->device, rc->header_file_new);
684 r = crypt_init(&cd, rc->device);
686 crypt_set_confirm_callback(cd, NULL, NULL);
687 r = crypt_header_restore(cd, CRYPT_LUKS1, rc->header_file_new);
692 log_err(_("Cannot restore LUKS header on device %s.\n"), rc->device);
694 log_verbose(_("LUKS header on device %s restored.\n"), rc->device);
698 static void print_progress(struct reenc_ctx *rc, uint64_t bytes, int final)
700 unsigned long long mbytes, eta;
701 struct timeval now_time;
704 gettimeofday(&now_time, NULL);
705 if (!final && time_diff(rc->end_time, now_time) < 0.5)
708 rc->end_time = now_time;
713 tdiff = time_diff(rc->start_time, rc->end_time);
717 mbytes = (bytes - rc->resume_bytes) / 1024 / 1024;
718 mib = (double)(mbytes) / tdiff;
722 eta = (unsigned long long)(rc->device_size / 1024 / 1024 / mib - tdiff);
724 /* vt100 code clear line */
726 log_err(_("Progress: %5.1f%%, ETA %02llu:%02llu, "
727 "%4llu MiB written, speed %5.1f MiB/s%s"),
728 (double)bytes / rc->device_size * 100,
729 eta / 60, eta % 60, mbytes, mib,
733 static int copy_data_forward(struct reenc_ctx *rc, int fd_old, int fd_new,
734 size_t block_size, void *buf, uint64_t *bytes)
738 log_dbg("Reencrypting in forward direction.");
740 if (lseek64(fd_old, rc->device_offset, SEEK_SET) < 0 ||
741 lseek64(fd_new, rc->device_offset, SEEK_SET) < 0) {
742 log_err(_("Cannot seek to device offset.\n"));
746 rc->resume_bytes = *bytes = rc->device_offset;
748 if (write_log(rc) < 0)
751 while (!quit && rc->device_offset < rc->device_size) {
752 s1 = read(fd_old, buf, block_size);
753 if (s1 < 0 || ((size_t)s1 != block_size &&
754 (rc->device_offset + s1) != rc->device_size)) {
755 log_dbg("Read error, expecting %d, got %d.",
756 (int)block_size, (int)s1);
760 /* If device_size is forced, never write more than limit */
761 if ((s1 + rc->device_offset) > rc->device_size)
762 s1 = rc->device_size - rc->device_offset;
764 s2 = write(fd_new, buf, s1);
766 log_dbg("Write error, expecting %d, got %d.",
767 (int)block_size, (int)s2);
771 rc->device_offset += s1;
772 if (opt_write_log && write_log(rc) < 0)
775 if (opt_fsync && fsync(fd_new) < 0) {
776 log_dbg("Write error, fsync.");
780 *bytes += (uint64_t)s2;
781 print_progress(rc, *bytes, 0);
784 return quit ? -EAGAIN : 0;
787 static int copy_data_backward(struct reenc_ctx *rc, int fd_old, int fd_new,
788 size_t block_size, void *buf, uint64_t *bytes)
790 ssize_t s1, s2, working_block;
791 off64_t working_offset;
793 log_dbg("Reencrypting in backward direction.");
795 if (!rc->in_progress) {
796 rc->device_offset = rc->device_size;
797 rc->resume_bytes = 0;
800 rc->resume_bytes = rc->device_size - rc->device_offset;
801 *bytes = rc->resume_bytes;
804 if (write_log(rc) < 0)
807 while (!quit && rc->device_offset) {
808 if (rc->device_offset < block_size) {
810 working_block = rc->device_offset;
812 working_offset = rc->device_offset - block_size;
813 working_block = block_size;
816 if (lseek64(fd_old, working_offset, SEEK_SET) < 0 ||
817 lseek64(fd_new, working_offset, SEEK_SET) < 0) {
818 log_err(_("Cannot seek to device offset.\n"));
822 s1 = read(fd_old, buf, working_block);
823 if (s1 < 0 || (s1 != working_block)) {
824 log_dbg("Read error, expecting %d, got %d.",
825 (int)block_size, (int)s1);
829 s2 = write(fd_new, buf, working_block);
831 log_dbg("Write error, expecting %d, got %d.",
832 (int)block_size, (int)s2);
836 rc->device_offset -= s1;
837 if (opt_write_log && write_log(rc) < 0)
840 if (opt_fsync && fsync(fd_new) < 0) {
841 log_dbg("Write error, fsync.");
845 *bytes += (uint64_t)s2;
846 print_progress(rc, *bytes, 0);
849 return quit ? -EAGAIN : 0;
852 static int copy_data(struct reenc_ctx *rc)
854 size_t block_size = opt_bsize * 1024 * 1024;
855 int fd_old = -1, fd_new = -1;
860 log_dbg("Data copy preparation.");
862 fd_old = open(rc->crypt_path_org, O_RDONLY | (opt_directio ? O_DIRECT : 0));
864 log_err(_("Cannot open temporary LUKS header file.\n"));
868 fd_new = open(rc->crypt_path_new, O_WRONLY | (opt_directio ? O_DIRECT : 0));
870 log_err(_("Cannot open temporary LUKS header file.\n"));
875 if (ioctl(fd_new, BLKGETSIZE64, &rc->device_size_real) < 0) {
876 log_err(_("Cannot get device size.\n"));
880 rc->device_size = opt_device_size ?: rc->device_size_real;
882 if (posix_memalign((void *)&buf, alignment(fd_new), block_size)) {
883 log_err(_("Allocation of aligned memory failed.\n"));
889 gettimeofday(&rc->start_time, NULL);
891 if (rc->reencrypt_direction == FORWARD)
892 r = copy_data_forward(rc, fd_old, fd_new, block_size, buf, &bytes);
894 r = copy_data_backward(rc, fd_old, fd_new, block_size, buf, &bytes);
897 print_progress(rc, bytes, 1);
900 log_err(_("Interrupted by a signal.\n"));
902 log_err(_("IO error during reencryption.\n"));
914 static int initialize_uuid(struct reenc_ctx *rc)
916 struct crypt_device *cd = NULL;
919 log_dbg("Initialising UUID.");
922 rc->device_uuid = strdup(NO_UUID);
926 /* Try to load LUKS from device */
927 if ((r = crypt_init(&cd, rc->device)))
929 crypt_set_log_callback(cd, _quiet_log, NULL);
930 r = crypt_load(cd, CRYPT_LUKS1, NULL);
932 rc->device_uuid = strdup(crypt_get_uuid(cd));
934 /* Reencryption already in progress - magic header? */
935 r = device_check(rc, CHECK_UNUSABLE);
941 static int init_passphrase1(struct reenc_ctx *rc, struct crypt_device *cd,
942 const char *msg, int slot_to_check, int check)
944 int r = -EINVAL, slot, retry_count;
946 slot = (slot_to_check == CRYPT_ANY_SLOT) ? 0 : slot_to_check;
948 retry_count = opt_tries ?: 1;
949 while (retry_count--) {
951 r = crypt_get_key(msg, &rc->p[slot].password,
952 &rc->p[slot].passwordLen,
953 0, 0, NULL /*opt_key_file*/,
960 /* library uses sigint internally, until it is fixed...*/
963 r = crypt_activate_by_passphrase(cd, NULL, slot_to_check,
964 rc->p[slot].password, rc->p[slot].passwordLen, 0);
969 crypt_safe_free(rc->p[slot].password);
970 rc->p[slot].password = NULL;
971 rc->p[slot].passwordLen = 0;
973 if (r < 0 && r != -EPERM)
979 log_err(_("No key available with this passphrase.\n"));
984 static int init_keyfile(struct reenc_ctx *rc, struct crypt_device *cd, int slot_check)
988 slot = (slot_check == CRYPT_ANY_SLOT) ? 0 : slot_check;
989 r = crypt_get_key(NULL, &rc->p[slot].password, &rc->p[slot].passwordLen,
990 opt_keyfile_offset, opt_keyfile_size, opt_key_file, 0, 0, cd);
994 r = crypt_activate_by_passphrase(cd, NULL, slot_check,
995 rc->p[slot].password, rc->p[slot].passwordLen, 0);
998 * Allow keyslot only if it is last slot or if user explicitly
999 * specify whch slot to use (IOW others will be disabled).
1001 if (r >= 0 && opt_key_slot == CRYPT_ANY_SLOT &&
1002 crypt_keyslot_status(cd, r) != CRYPT_SLOT_ACTIVE_LAST) {
1003 log_err(_("Key file can be used only with --key-slot or with "
1004 "exactly one key slot active.\n"));
1009 crypt_safe_free(rc->p[slot].password);
1010 rc->p[slot].password = NULL;
1011 rc->p[slot].passwordLen = 0;
1013 log_err(_("No key available with this passphrase.\n"));
1021 static int initialize_passphrase(struct reenc_ctx *rc, const char *device)
1023 struct crypt_device *cd = NULL;
1024 crypt_keyslot_info ki;
1028 log_dbg("Passhrases initialization.");
1030 if (opt_new && !rc->in_progress) {
1031 r = init_passphrase1(rc, cd, _("Enter new LUKS passphrase: "), 0, 0);
1032 return r > 0 ? 0 : r;
1035 if ((r = crypt_init(&cd, device)) ||
1036 (r = crypt_load(cd, CRYPT_LUKS1, NULL)) ||
1037 (r = crypt_set_data_device(cd, rc->device))) {
1043 r = init_keyfile(rc, cd, opt_key_slot);
1044 } else if (rc->in_progress) {
1045 r = init_passphrase1(rc, cd, _("Enter any LUKS passphrase: "),
1047 } else for (i = 0; i < MAX_SLOT; i++) {
1048 ki = crypt_keyslot_status(cd, i);
1049 if (ki != CRYPT_SLOT_ACTIVE && ki != CRYPT_SLOT_ACTIVE_LAST)
1052 snprintf(msg, sizeof(msg), _("Enter LUKS passphrase for key slot %u: "), i);
1053 r = init_passphrase1(rc, cd, msg, i, 1);
1059 return r > 0 ? 0 : r;
1062 static int initialize_context(struct reenc_ctx *rc, const char *device)
1064 log_dbg("Initialising reencryption context.");
1068 if (!(rc->device = strndup(device, PATH_MAX)))
1071 if (device_check(rc, CHECK_OPEN) < 0)
1074 if (initialize_uuid(rc)) {
1075 log_err(_("Device %s is not a valid LUKS device.\n"), device);
1079 /* Prepare device names */
1080 if (snprintf(rc->log_file, PATH_MAX,
1081 "LUKS-%s.log", rc->device_uuid) < 0)
1083 if (snprintf(rc->header_file_org, PATH_MAX,
1084 "LUKS-%s.org", rc->device_uuid) < 0)
1086 if (snprintf(rc->header_file_new, PATH_MAX,
1087 "LUKS-%s.new", rc->device_uuid) < 0)
1090 /* Paths to encrypted devices */
1091 if (snprintf(rc->crypt_path_org, PATH_MAX,
1092 "%s/%s", crypt_get_dir(), rc->header_file_org) < 0)
1094 if (snprintf(rc->crypt_path_new, PATH_MAX,
1095 "%s/%s", crypt_get_dir(), rc->header_file_new) < 0)
1100 if (open_log(rc) < 0) {
1101 log_err(_("Cannot open reencryption log file.\n"));
1105 if (!rc->in_progress) {
1106 if (!opt_reduce_size)
1107 rc->reencrypt_direction = FORWARD;
1109 rc->reencrypt_direction = BACKWARD;
1110 rc->device_offset = (uint64_t)~0;
1117 static void destroy_context(struct reenc_ctx *rc)
1121 log_dbg("Destroying reencryption context.");
1126 if ((rc->reencrypt_direction == FORWARD &&
1127 rc->device_offset == rc->device_size) ||
1128 (rc->reencrypt_direction == BACKWARD &&
1129 (rc->device_offset == 0 || rc->device_offset == (uint64_t)~0))) {
1130 unlink(rc->log_file);
1131 unlink(rc->header_file_org);
1132 unlink(rc->header_file_new);
1135 for (i = 0; i < MAX_SLOT; i++)
1136 crypt_safe_free(rc->p[i].password);
1139 free(rc->device_uuid);
1142 static int run_reencrypt(const char *device)
1145 struct reenc_ctx rc = {};
1147 if (initialize_context(&rc, device))
1150 log_dbg("Running reencryption.");
1152 if (!rc.in_progress) {
1154 if ((r = initialize_passphrase(&rc, rc.device)) ||
1155 (r = backup_fake_header(&rc)))
1157 } else if ((r = initialize_passphrase(&rc, rc.device)) ||
1158 (r = backup_luks_headers(&rc)) ||
1159 (r = device_check(&rc, MAKE_UNUSABLE)))
1162 if ((r = initialize_passphrase(&rc, rc.header_file_new)))
1166 if ((r = activate_luks_headers(&rc)))
1169 if ((r = copy_data(&rc)))
1172 r = restore_luks_header(&rc);
1174 destroy_context(&rc);
1178 static __attribute__ ((noreturn)) void usage(poptContext popt_context,
1179 int exitcode, const char *error,
1182 poptPrintUsage(popt_context, stderr, 0);
1184 log_err("%s: %s\n", more, error);
1185 poptFreeContext(popt_context);
1189 static void help(poptContext popt_context,
1190 enum poptCallbackReason reason __attribute__((unused)),
1191 struct poptOption *key,
1192 const char *arg __attribute__((unused)),
1193 void *data __attribute__((unused)))
1195 if (key->shortName == '?') {
1196 log_std("%s %s\n", PACKAGE_REENC, PACKAGE_VERSION);
1197 poptPrintHelp(popt_context, stdout, 0);
1200 usage(popt_context, EXIT_SUCCESS, NULL, NULL);
1203 static void _dbg_version_and_cmd(int argc, const char **argv)
1207 log_std("# %s %s processing \"", PACKAGE_REENC, PACKAGE_VERSION);
1208 for (i = 0; i < argc; i++) {
1211 log_std("%s", argv[i]);
1216 int main(int argc, const char **argv)
1218 static struct poptOption popt_help_options[] = {
1219 { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL },
1220 { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL },
1221 { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL },
1224 static struct poptOption popt_options[] = {
1225 { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL },
1226 { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), NULL },
1227 { "verbose", 'v', POPT_ARG_NONE, &opt_verbose, 0, N_("Shows more detailed error messages"), NULL },
1228 { "debug", '\0', POPT_ARG_NONE, &opt_debug, 0, N_("Show debug messages"), NULL },
1229 { "block-size", 'B', POPT_ARG_INT, &opt_bsize, 0, N_("Reencryption block size"), N_("MiB") },
1230 { "cipher", 'c', POPT_ARG_STRING, &opt_cipher, 0, N_("The cipher used to encrypt the disk (see /proc/crypto)"), NULL },
1231 { "key-size", 's', POPT_ARG_INT, &opt_key_size, 0, N_("The size of the encryption key"), N_("BITS") },
1232 { "hash", 'h', POPT_ARG_STRING, &opt_hash, 0, N_("The hash used to create the encryption key from the passphrase"), NULL },
1233 { "key-file", 'd', POPT_ARG_STRING, &opt_key_file, 0, N_("Read the key from a file."), NULL },
1234 { "iter-time", 'i', POPT_ARG_INT, &opt_iteration_time, 0, N_("PBKDF2 iteration time for LUKS (in ms)"), N_("msecs") },
1235 { "batch-mode", 'q', POPT_ARG_NONE, &opt_batch_mode, 0, N_("Do not ask for confirmation"), NULL },
1236 { "tries", 'T', POPT_ARG_INT, &opt_tries, 0, N_("How often the input of the passphrase can be retried"), NULL },
1237 { "use-random", '\0', POPT_ARG_NONE, &opt_random, 0, N_("Use /dev/random for generating volume key."), NULL },
1238 { "use-urandom", '\0', POPT_ARG_NONE, &opt_urandom, 0, N_("Use /dev/urandom for generating volume key."), NULL },
1239 { "use-directio", '\0', POPT_ARG_NONE, &opt_directio, 0, N_("Use direct-io when accesing devices."), NULL },
1240 { "use-fsync", '\0', POPT_ARG_NONE, &opt_fsync, 0, N_("Use fsync after each block."), NULL },
1241 { "write-log", '\0', POPT_ARG_NONE, &opt_write_log, 0, N_("Update log file after every block."), NULL },
1242 { "key-slot", 'S', POPT_ARG_INT, &opt_key_slot, 0, N_("Use only this slot (others will be disabled)."), NULL },
1243 { "keyfile-offset", '\0', POPT_ARG_LONG, &opt_keyfile_offset, 0, N_("Number of bytes to skip in keyfile"), N_("bytes") },
1244 { "keyfile-size", 'l', POPT_ARG_LONG, &opt_keyfile_size, 0, N_("Limits the read from keyfile"), N_("bytes") },
1245 { "reduce-device-size",'\0', POPT_ARG_STRING, &opt_reduce_size_str, 0, N_("Reduce data device size (move data offset). DANGEROUS!"), N_("bytes") },
1246 { "device-size", '\0', POPT_ARG_STRING, &opt_device_size_str, 0, N_("Use only specified device size (ignore rest of device). DANGEROUS!"), N_("bytes") },
1247 { "new", 'N', POPT_ARG_NONE,&opt_new, 0, N_("Create new header on not encrypted device."), NULL },
1250 poptContext popt_context;
1253 crypt_set_log_callback(NULL, _log, NULL);
1257 setlocale(LC_ALL, "");
1258 bindtextdomain(PACKAGE, LOCALEDIR);
1259 textdomain(PACKAGE);
1261 popt_context = poptGetContext(PACKAGE, argc, argv, popt_options, 0);
1262 poptSetOtherOptionHelp(popt_context,
1263 _("[OPTION...] <device>"));
1265 while((r = poptGetNextOpt(popt_context)) > 0) ;
1267 usage(popt_context, EXIT_FAILURE, poptStrerror(r),
1268 poptBadOption(popt_context, POPT_BADOPTION_NOALIAS));
1270 if (opt_version_mode) {
1271 log_std("%s %s\n", PACKAGE_REENC, PACKAGE_VERSION);
1272 poptFreeContext(popt_context);
1276 if (!opt_batch_mode) {
1277 log_std(_("WARNING: this is experimental code, it can completely break your data.\n"));
1278 log_verbose(_("Reencryption will change: volume key%s%s%s%s.\n"),
1279 opt_hash ? _(", set hash to ") : "", opt_hash ?: "",
1280 opt_cipher ? _(", set cipher to "): "", opt_cipher ?: "");
1283 action_argv = poptGetArgs(popt_context);
1285 usage(popt_context, EXIT_FAILURE, _("Argument required."),
1286 poptGetInvocationName(popt_context));
1288 if (opt_random && opt_urandom)
1289 usage(popt_context, EXIT_FAILURE, _("Only one of --use-[u]random options is allowed."),
1290 poptGetInvocationName(popt_context));
1292 if (opt_bsize < 0 || opt_key_size < 0 || opt_iteration_time < 0 ||
1293 opt_tries < 0 || opt_keyfile_offset < 0 || opt_key_size < 0) {
1294 usage(popt_context, EXIT_FAILURE,
1295 _("Negative number for option not permitted."),
1296 poptGetInvocationName(popt_context));
1299 if (opt_bsize < 1 || opt_bsize > 64)
1300 usage(popt_context, EXIT_FAILURE,
1301 _("Only values between 1 MiB and 64 MiB allowed for reencryption block size."),
1302 poptGetInvocationName(popt_context));
1304 if (opt_key_size % 8)
1305 usage(popt_context, EXIT_FAILURE,
1306 _("Key size must be a multiple of 8 bits"),
1307 poptGetInvocationName(popt_context));
1309 if (opt_key_slot != CRYPT_ANY_SLOT &&
1310 (opt_key_slot < 0 || opt_key_slot >= crypt_keyslot_max(CRYPT_LUKS1)))
1311 usage(popt_context, EXIT_FAILURE, _("Key slot is invalid."),
1312 poptGetInvocationName(popt_context));
1314 if (opt_random && opt_urandom)
1315 usage(popt_context, EXIT_FAILURE, _("Only one of --use-[u]random options is allowed."),
1316 poptGetInvocationName(popt_context));
1318 if (opt_device_size_str &&
1319 crypt_string_to_size(NULL, opt_device_size_str, &opt_device_size))
1320 usage(popt_context, EXIT_FAILURE, _("Invalid device size specification."),
1321 poptGetInvocationName(popt_context));
1323 if (opt_reduce_size_str &&
1324 crypt_string_to_size(NULL, opt_reduce_size_str, &opt_reduce_size))
1325 usage(popt_context, EXIT_FAILURE, _("Invalid device size specification."),
1326 poptGetInvocationName(popt_context));
1327 if (opt_reduce_size > 64 * 1024 * 1024)
1328 usage(popt_context, EXIT_FAILURE, _("Maximum device reduce size is 64 MiB."),
1329 poptGetInvocationName(popt_context));
1330 if (opt_reduce_size % SECTOR_SIZE)
1331 usage(popt_context, EXIT_FAILURE, _("Reduce size must be multiple of 512 bytes sector."),
1332 poptGetInvocationName(popt_context));
1334 if (opt_new && !opt_reduce_size)
1335 usage(popt_context, EXIT_FAILURE, _("Option --new must be used together with --reduce-device-size."),
1336 poptGetInvocationName(popt_context));
1340 crypt_set_debug_level(-1);
1341 _dbg_version_and_cmd(argc, argv);
1344 r = run_reencrypt(action_argv[0]);
1346 poptFreeContext(popt_context);
1348 /* Translate exit code to simple codes */
1350 case 0: r = EXIT_SUCCESS; break;
1352 case -EBUSY: r = 5; break;
1354 case -ENODEV: r = 4; break;
1355 case -ENOMEM: r = 3; break;
1356 case -EPERM: r = 2; break;
1357 default: r = EXIT_FAILURE;