11 #include <libcryptsetup.h>
14 #include "../config.h"
16 #include "cryptsetup.h"
18 static int opt_verbose = 0;
19 static int opt_debug = 0;
20 static char *opt_cipher = NULL;
21 static char *opt_hash = NULL;
22 static int opt_verify_passphrase = 0;
23 static char *opt_key_file = NULL;
24 static char *opt_master_key_file = NULL;
25 static unsigned int opt_key_size = 0;
26 static int opt_key_slot = CRYPT_ANY_SLOT;
27 static uint64_t opt_size = 0;
28 static uint64_t opt_offset = 0;
29 static uint64_t opt_skip = 0;
30 static int opt_readonly = 0;
31 static int opt_iteration_time = 1000;
32 static int opt_batch_mode = 0;
33 static int opt_version_mode = 0;
34 static int opt_timeout = 0;
35 static int opt_tries = 3;
36 static int opt_align_payload = 0;
37 static int opt_non_exclusive = 0;
39 static const char **action_argv;
40 static int action_argc;
42 static int action_create(int arg);
43 static int action_remove(int arg);
44 static int action_resize(int arg);
45 static int action_status(int arg);
46 static int action_luksFormat(int arg);
47 static int action_luksOpen(int arg);
48 static int action_luksAddKey(int arg);
49 static int action_luksDelKey(int arg);
50 static int action_luksKillSlot(int arg);
51 static int action_luksRemoveKey(int arg);
52 static int action_isLuks(int arg);
53 static int action_luksUUID(int arg);
54 static int action_luksDump(int arg);
56 static struct action_type {
60 int required_action_argc;
61 int required_dm_backend;
67 { "create", action_create, 0, 2, 1, 1, 1, N_("<name> <device>"),N_("create device") },
68 { "remove", action_remove, 0, 1, 1, 0, 1, N_("<name>"), N_("remove device") },
69 { "resize", action_resize, 0, 1, 1, 1, 1, N_("<name>"), N_("resize active device") },
70 { "status", action_status, 0, 1, 1, 0, 1, N_("<name>"), N_("show device status") },
71 { "luksFormat", action_luksFormat, 0, 1, 1, 1, 1, N_("<device> [<new key file>]"), N_("formats a LUKS device") },
72 { "luksOpen", action_luksOpen, 0, 2, 1, 1, 1, N_("<device> <name> "), N_("open LUKS device as mapping <name>") },
73 { "luksAddKey", action_luksAddKey, 0, 1, 1, 1, 1, N_("<device> [<new key file>]"), N_("add key to LUKS device") },
74 { "luksRemoveKey",action_luksRemoveKey, 0, 1, 1, 1, 1, N_("<device> [<key file>]"), N_("removes supplied key or key file from LUKS device") },
75 { "luksKillSlot", action_luksKillSlot, 0, 2, 1, 1, 1, N_("<device> <key slot>"), N_("wipes key with number <key slot> from LUKS device") },
76 { "luksUUID", action_luksUUID, 0, 1, 0, 0, 1, N_("<device>"), N_("print UUID of LUKS device") },
77 { "isLuks", action_isLuks, 0, 1, 0, 0, 0, N_("<device>"), N_("tests <device> for LUKS partition header") },
78 { "luksClose", action_remove, 0, 1, 1, 0, 1, N_("<name>"), N_("remove LUKS mapping") },
79 { "luksDump", action_luksDump, 0, 1, 0, 0, 1, N_("<device>"), N_("dump LUKS partition information") },
80 { "luksDelKey", action_luksDelKey, 0, 2, 1, 1, 1, N_("<device> <key slot>"), N_("identical to luksKillSlot - DEPRECATED - see man page") },
81 { "reload", action_create, 1, 2, 1, 1, 1, N_("<name> <device>"), N_("modify active device - DEPRECATED - see man page") },
82 { NULL, NULL, 0, 0, 0, 0, 0, NULL, NULL }
85 /* Interface Callbacks */
86 static int yesDialog(char *msg)
92 if(isatty(0) && !opt_batch_mode) {
93 log_std("\nWARNING!\n========\n");
94 log_std("%s\n\nAre you sure? (Type uppercase yes): ", msg);
95 if(getline(&answer, &size, stdin) == -1) {
100 if(strcmp(answer, "YES\n"))
108 static void cmdLineLog(int class, char *msg) {
111 case CRYPT_LOG_NORMAL:
114 case CRYPT_LOG_ERROR:
118 fprintf(stderr, "Internal error on logging class for msg: %s", msg);
123 static struct interface_callbacks cmd_icb = {
124 .yesDialog = yesDialog,
130 static void show_status(int errcode)
134 if(!errcode && opt_verbose) {
135 log_std(_("Command successful.\n"));
139 crypt_get_error(error, sizeof(error));
142 char *error_ = strerror_r(errcode, error, sizeof(error));
143 if (error_ != error) {
144 strncpy(error, error_, sizeof(error));
145 error[sizeof error - 1] = '\0';
149 log_err(_("Command failed"));
151 log_err(": %s\n", error);
157 static int action_create(int reload)
159 struct crypt_options options = {
160 .name = action_argv[0],
161 .device = action_argv[1],
162 .cipher = opt_cipher?opt_cipher:DEFAULT_CIPHER,
163 .hash = opt_hash ?: DEFAULT_HASH,
164 .key_file = opt_key_file,
165 .key_size = ((opt_key_size)?opt_key_size:DEFAULT_KEY_SIZE)/8,
166 .key_slot = opt_key_slot,
169 .offset = opt_offset,
171 .timeout = opt_timeout,
178 log_err(_("The reload action is deprecated. Please use \"dmsetup reload\" in case you really need this functionality.\nWARNING: do not use reload to touch LUKS devices. If that is the case, hit Ctrl-C now.\n"));
180 if (options.hash && strcmp(options.hash, "plain") == 0)
182 if (opt_verify_passphrase)
183 options.flags |= CRYPT_FLAG_VERIFY;
185 options.flags |= CRYPT_FLAG_READONLY;
188 r = crypt_update_device(&options);
190 r = crypt_create_device(&options);
195 static int action_remove(int arg)
197 struct crypt_options options = {
198 .name = action_argv[0],
202 return crypt_remove_device(&options);
205 static int action_resize(int arg)
207 struct crypt_options options = {
208 .name = action_argv[0],
213 return crypt_resize_device(&options);
216 static int action_status(int arg)
218 struct crypt_options options = {
219 .name = action_argv[0],
224 r = crypt_query_device(&options);
230 log_std("%s/%s is inactive.\n", crypt_get_dir(), options.name);
234 log_std("%s/%s is active:\n", crypt_get_dir(), options.name);
235 log_std(" cipher: %s\n", options.cipher);
236 log_std(" keysize: %d bits\n", options.key_size * 8);
237 log_std(" device: %s\n", options.device);
238 log_std(" offset: %" PRIu64 " sectors\n", options.offset);
239 log_std(" size: %" PRIu64 " sectors\n", options.size);
241 log_std(" skipped: %" PRIu64 " sectors\n", options.skip);
242 log_std(" mode: %s\n", (options.flags & CRYPT_FLAG_READONLY)
243 ? "readonly" : "read/write");
244 crypt_put_options(&options);
250 static int _action_luksFormat_generateMK()
252 struct crypt_options options = {
253 .key_size = (opt_key_size ?: DEFAULT_LUKS_KEY_SIZE) / 8,
254 .key_slot = opt_key_slot,
255 .device = action_argv[0],
256 .cipher = opt_cipher ?: DEFAULT_LUKS_CIPHER,
257 .hash = opt_hash ?: DEFAULT_LUKS_HASH,
258 .new_key_file = action_argc > 1 ? action_argv[1] : NULL,
259 .flags = opt_verify_passphrase ? CRYPT_FLAG_VERIFY : (!opt_batch_mode?CRYPT_FLAG_VERIFY_IF_POSSIBLE : 0),
260 .iteration_time = opt_iteration_time,
261 .timeout = opt_timeout,
262 .align_payload = opt_align_payload,
266 return crypt_luksFormat(&options);
269 static int _read_mk(const char *file, char **key, int keysize)
273 *key = malloc(keysize);
277 fd = open(file, O_RDONLY);
279 log_err("Cannot read keyfile %s.\n", file);
282 if ((read(fd, *key, keysize) != keysize)) {
283 log_err("Cannot read %d bytes from keyfile %s.\n", keysize, file);
285 memset(*key, 0, keysize);
293 static int _action_luksFormat_useMK()
295 int r = -EINVAL, keysize;
296 char *key = NULL, cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
297 struct crypt_device *cd = NULL;
298 struct crypt_params_luks1 params = {
299 .hash = opt_hash ?: DEFAULT_LUKS_HASH,
300 .data_alignment = opt_align_payload,
303 if (parse_into_name_and_mode(opt_cipher ?: DEFAULT_LUKS_CIPHER, cipher, cipher_mode)) {
304 log_err("No known cipher specification pattern detected.\n");
308 keysize = (opt_key_size ?: DEFAULT_LUKS_KEY_SIZE) / 8;
309 if (_read_mk(opt_master_key_file, &key, keysize) < 0)
312 if ((r = crypt_init(&cd, action_argv[0])))
315 crypt_set_password_verify(cd, 1);
316 crypt_set_timeout(cd, opt_timeout);
317 if (opt_iteration_time)
318 crypt_set_iterarion_time(cd, opt_iteration_time);
320 if ((r = crypt_format(cd, CRYPT_LUKS1, cipher, cipher_mode, NULL, key, keysize, ¶ms)))
323 r = crypt_keyslot_add_by_volume_key(cd, opt_key_slot, key, keysize, NULL, 0);
328 memset(key, 0, keysize);
334 static int action_luksFormat(int arg)
336 int r = 0; char *msg = NULL;
338 /* Avoid overwriting possibly wrong part of device than user requested by rejecting these options */
339 if (opt_offset || opt_skip) {
340 log_err("Options --offset and --skip are not supported for luksFormat.\n");
344 if(asprintf(&msg, _("This will overwrite data on %s irrevocably."), action_argv[0]) == -1) {
345 log_err(_("memory allocation error in action_luksFormat"));
354 if (opt_master_key_file)
355 return _action_luksFormat_useMK();
357 return _action_luksFormat_generateMK();
360 static int action_luksOpen(int arg)
362 struct crypt_options options = {
363 .name = action_argv[1],
364 .device = action_argv[0],
365 .key_file = opt_key_file,
366 .key_size = opt_key_file ? (opt_key_size / 8) : 0, /* limit bytes read from keyfile */
367 .timeout = opt_timeout,
368 .tries = opt_key_file ? 1 : opt_tries, /* verify is usefull only for tty */
373 options.flags |= CRYPT_FLAG_READONLY;
374 if (opt_non_exclusive)
375 options.flags |= CRYPT_FLAG_NON_EXCLUSIVE_ACCESS;
376 return crypt_luksOpen(&options);
379 static int action_luksDelKey(int arg)
381 log_err("luksDelKey is a deprecated action name.\nPlease use luksKillSlot.\n");
382 return action_luksKillSlot(arg);
385 static int action_luksKillSlot(int arg)
387 struct crypt_options options = {
388 .device = action_argv[0],
389 .key_slot = atoi(action_argv[1]),
390 .key_file = opt_key_file,
391 .timeout = opt_timeout,
392 .flags = !opt_batch_mode?CRYPT_FLAG_VERIFY_ON_DELKEY : 0,
396 return crypt_luksKillSlot(&options);
399 static int action_luksRemoveKey(int arg)
401 struct crypt_options options = {
402 .device = action_argv[0],
403 .new_key_file = action_argc>1?action_argv[1]:NULL,
404 .key_file = opt_key_file,
405 .timeout = opt_timeout,
406 .flags = !opt_batch_mode?CRYPT_FLAG_VERIFY_ON_DELKEY : 0,
410 return crypt_luksRemoveKey(&options);
413 static int _action_luksAddKey_useMK()
415 int r = -EINVAL, keysize;
417 struct crypt_device *cd = NULL;
419 if ((r = crypt_init(&cd, action_argv[0])))
422 if ((r = crypt_load(cd, CRYPT_LUKS1, NULL)))
425 keysize = crypt_get_volume_key_size(cd);
426 crypt_set_password_verify(cd, 1);
427 crypt_set_timeout(cd, opt_timeout);
428 if (opt_iteration_time)
429 crypt_set_iterarion_time(cd, opt_iteration_time);
431 if (_read_mk(opt_master_key_file, &key, keysize) < 0)
434 r = crypt_keyslot_add_by_volume_key(cd, opt_key_slot, key, keysize, NULL, 0);
438 memset(key, 0, keysize);
444 static int action_luksAddKey(int arg)
446 struct crypt_options options = {
447 .device = action_argv[0],
448 .new_key_file = action_argc>1?action_argv[1]:NULL,
449 .key_file = opt_key_file,
450 .key_slot = opt_key_slot,
451 .flags = opt_verify_passphrase ? CRYPT_FLAG_VERIFY : (!opt_batch_mode?CRYPT_FLAG_VERIFY_IF_POSSIBLE : 0),
452 .iteration_time = opt_iteration_time,
453 .timeout = opt_timeout,
457 if (opt_master_key_file)
458 return _action_luksAddKey_useMK();
460 return crypt_luksAddKey(&options);
463 static int action_isLuks(int arg)
465 struct crypt_options options = {
466 .device = action_argv[0],
470 return crypt_isLuks(&options);
473 static int action_luksUUID(int arg)
475 struct crypt_options options = {
476 .device = action_argv[0],
480 return crypt_luksUUID(&options);
483 static int action_luksDump(int arg)
485 struct crypt_options options = {
486 .device = action_argv[0],
490 return crypt_luksDump(&options);
493 static void usage(poptContext popt_context, int exitcode,
494 const char *error, const char *more)
496 poptPrintUsage(popt_context, stderr, 0);
498 log_err("%s: %s\n", more, error);
502 static void help(poptContext popt_context, enum poptCallbackReason reason,
503 struct poptOption *key, const char * arg, void *data)
505 if (key->shortName == '?') {
506 struct action_type *action;
508 log_std("%s\n",PACKAGE_STRING);
510 poptPrintHelp(popt_context, stdout, 0);
513 "<action> is one of:\n"));
515 for(action = action_types; action->type; action++)
516 log_std("\t%s %s - %s\n", action->type, _(action->arg_desc), _(action->desc));
519 "<name> is the device to create under %s\n"
520 "<device> is the encrypted device\n"
521 "<key slot> is the LUKS key slot number to modify\n"
522 "<key file> optional key file for the new key for luksAddKey action\n"),
526 usage(popt_context, 0, NULL, NULL);
529 void set_debug_level(int level);
531 static void _dbg_version_and_cmd(int argc, char **argv)
535 log_std("# %s %s processing \"", PACKAGE_NAME, PACKAGE_VERSION);
536 for (i = 0; i < argc; i++) {
544 static int run_action(struct action_type *action)
548 if (dm_init(NULL, action->required_dm_backend) < 1) {
549 log_err("Cannot communicate with device-mapper. Is dm_mod kernel module loaded?\n");
553 if (action->required_memlock)
554 crypt_memory_lock(NULL, 1);
556 r = action->handler(action->arg);
558 if (action->required_memlock)
559 crypt_memory_lock(NULL, 0);
561 if (action->required_dm_backend)
564 if (r < 0 && (opt_verbose || action->show_status))
570 int main(int argc, char **argv)
572 static char *popt_tmp;
573 static struct poptOption popt_help_options[] = {
574 { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL },
575 { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL },
576 { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL },
579 static struct poptOption popt_options[] = {
580 { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL },
581 { "verbose", 'v', POPT_ARG_NONE, &opt_verbose, 0, N_("Shows more detailed error messages"), NULL },
582 { "debug", '\0', POPT_ARG_NONE, &opt_debug, 0, N_("Show debug messsgages"), NULL },
583 { "cipher", 'c', POPT_ARG_STRING | POPT_ARGFLAG_SHOW_DEFAULT, &opt_cipher, 0, N_("The cipher used to encrypt the disk (see /proc/crypto)"), NULL },
584 { "hash", 'h', POPT_ARG_STRING | POPT_ARGFLAG_SHOW_DEFAULT, &opt_hash, 0, N_("The hash used to create the encryption key from the passphrase"), NULL },
585 { "verify-passphrase", 'y', POPT_ARG_NONE, &opt_verify_passphrase, 0, N_("Verifies the passphrase by asking for it twice"), NULL },
586 { "key-file", 'd', POPT_ARG_STRING, &opt_key_file, 0, N_("Read the key from a file (can be /dev/random)"), NULL },
587 { "master-key-file", '\0', POPT_ARG_STRING, &opt_master_key_file, 0, N_("Read the volume (master) key from file."), NULL },
588 { "key-size", 's', POPT_ARG_INT | POPT_ARGFLAG_SHOW_DEFAULT, &opt_key_size, 0, N_("The size of the encryption key"), N_("BITS") },
589 { "key-slot", 'S', POPT_ARG_INT, &opt_key_slot, 0, N_("Slot number for new key (default is first free)"), NULL },
590 { "size", 'b', POPT_ARG_STRING, &popt_tmp, 1, N_("The size of the device"), N_("SECTORS") },
591 { "offset", 'o', POPT_ARG_STRING, &popt_tmp, 2, N_("The start offset in the backend device"), N_("SECTORS") },
592 { "skip", 'p', POPT_ARG_STRING, &popt_tmp, 3, N_("How many sectors of the encrypted data to skip at the beginning"), N_("SECTORS") },
593 { "readonly", 'r', POPT_ARG_NONE, &opt_readonly, 0, N_("Create a readonly mapping"), NULL },
594 { "iter-time", 'i', POPT_ARG_INT, &opt_iteration_time, 0, N_("PBKDF2 iteration time for LUKS (in ms)"),
596 { "batch-mode", 'q', POPT_ARG_NONE, &opt_batch_mode, 0, N_("Do not ask for confirmation"), NULL },
597 { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), NULL },
598 { "timeout", 't', POPT_ARG_INT, &opt_timeout, 0, N_("Timeout for interactive passphrase prompt (in seconds)"), N_("secs") },
599 { "tries", 'T', POPT_ARG_INT, &opt_tries, 0, N_("How often the input of the passphrase canbe retried"), NULL },
600 { "align-payload", '\0', POPT_ARG_INT, &opt_align_payload, 0, N_("Align payload at <n> sector boundaries - for luksFormat"), N_("SECTORS") },
601 { "non-exclusive", '\0', POPT_ARG_NONE, &opt_non_exclusive, 0, N_("Allows non-exclusive access for luksOpen, WARNING see manpage."), NULL },
604 poptContext popt_context;
605 struct action_type *action;
608 const char *null_action_argv[] = {NULL};
610 set_default_log(cmdLineLog);
612 setlocale(LC_ALL, "");
613 bindtextdomain(PACKAGE, LOCALEDIR);
616 popt_context = poptGetContext(PACKAGE, argc, (const char **)argv,
618 poptSetOtherOptionHelp(popt_context,
619 N_("[OPTION...] <action> <action-specific>]"));
621 while((r = poptGetNextOpt(popt_context)) > 0) {
622 unsigned long long ull_value;
625 ull_value = strtoull(popt_tmp, &endp, 0);
626 if (*endp || !*popt_tmp)
627 r = POPT_ERROR_BADNUMBER;
631 opt_size = ull_value;
634 opt_offset = ull_value;
637 opt_skip = ull_value;
646 usage(popt_context, 1, poptStrerror(r),
647 poptBadOption(popt_context, POPT_BADOPTION_NOALIAS));
648 if (opt_version_mode) {
649 log_std("%s %s\n", PACKAGE_NAME, PACKAGE_VERSION);
653 if (opt_key_size % 8)
654 usage(popt_context, 1,
655 _("Key size must be a multiple of 8 bits"),
656 poptGetInvocationName(popt_context));
658 if (!(aname = (char *)poptGetArg(popt_context)))
659 usage(popt_context, 1, _("Argument <action> missing."),
660 poptGetInvocationName(popt_context));
661 for(action = action_types; action->type; action++)
662 if (strcmp(action->type, aname) == 0)
665 usage(popt_context, 1, _("Unknown action."),
666 poptGetInvocationName(popt_context));
669 action_argv = poptGetArgs(popt_context);
670 /* Make return values of poptGetArgs more consistent in case of remaining argc = 0 */
672 action_argv = null_action_argv;
674 /* Count args, somewhat unnice, change? */
675 while(action_argv[action_argc] != NULL)
678 if(action_argc < action->required_action_argc) {
680 snprintf(buf, 128,_("%s: requires %s as arguments"), action->type, action->arg_desc);
681 usage(popt_context, 1, buf,
682 poptGetInvocationName(popt_context));
687 crypt_set_debug_level(-1);
688 _dbg_version_and_cmd(argc, argv);
691 return run_action(action);