diff --git a/src/Makemodule.am b/src/Makemodule.am index 5c5c675b..4542d0c0 100644 --- a/src/Makemodule.am +++ b/src/Makemodule.am @@ -11,8 +11,12 @@ cryptsetup_SOURCES = \ src/utils_password.c \ src/utils_luks2.c \ src/utils_blockdev.c \ + src/utils_arg_names.h \ + src/utils_arg_macros.h \ src/cryptsetup.c \ - src/cryptsetup.h + src/cryptsetup.h \ + src/cryptsetup_args.h \ + src/cryptsetup_arg_list.h cryptsetup_LDADD = $(LDADD) \ libcryptsetup.la \ diff --git a/src/cryptsetup.c b/src/cryptsetup.c index 70d980c6..1c810924 100644 --- a/src/cryptsetup.c +++ b/src/cryptsetup.c @@ -21,104 +21,17 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -#include "cryptsetup.h" #include -static char *opt_cipher = NULL; -static char *opt_keyslot_cipher = NULL; -static char *opt_hash = NULL; -static char *opt_json_file = NULL; -static char *opt_key_file = NULL; -static char *opt_keyfile_stdin = NULL; -static char *opt_keyfiles[MAX_KEYFILES]; -static char *opt_master_key_file = NULL; -static char *opt_header_backup_file = NULL; -static char *opt_uuid = NULL; -static char *opt_header_device = NULL; -static char *opt_type = NULL; -static char *opt_pbkdf = NULL; -static char *opt_priority = NULL; /* normal */ -static char *opt_integrity = NULL; /* none */ -static char *opt_key_description = NULL; -static char *opt_label = NULL; -static char *opt_subsystem = NULL; -static char *opt_active_name = NULL; -static char *opt_resilience_mode = NULL; /* default value "checksum" */ -static char *opt_resilience_hash = NULL; /* default value "sha256" */ +#include "cryptsetup.h" +#include "cryptsetup_args.h" -/* helper strings converted to uint64_t later */ -static char *opt_reduce_size_str = NULL; -static char *opt_hotzone_size_str = NULL; -static char *opt_device_size_str = NULL; -static char *opt_luks2_metadata_size_str = NULL; -static char *opt_luks2_keyslots_size_str = NULL; +static char *keyfiles[MAX_KEYFILES]; +static char *keyfile_stdin = NULL; -static uint64_t opt_reduce_size = 0; -static uint64_t opt_hotzone_size = 0; -static uint64_t opt_device_size = 0; -static uint64_t opt_luks2_metadata_size = 0; -static uint64_t opt_luks2_keyslots_size = 0; +static int keyfiles_count = 0; +static int64_t data_shift = 0; -static int opt_keyfiles_count = 0; -static int opt_verify_passphrase = 0; -static int opt_key_size = 0; -static int opt_keyslot_key_size = 0; -static long opt_keyfile_size = 0; -static long opt_new_keyfile_size = 0; -static uint64_t opt_keyfile_offset = 0; -static uint64_t opt_new_keyfile_offset = 0; -static int opt_key_slot = CRYPT_ANY_SLOT; -static int opt_token = CRYPT_ANY_TOKEN; -static int opt_token_only = 0; -static uint64_t opt_size = 0; -static uint64_t opt_offset = 0; -static uint64_t opt_skip = 0; -static int opt_skip_valid = 0; -static int opt_readonly = 0; -static int opt_timeout = 0; -static int opt_tries = 3; -static int opt_align_payload = 0; -static int opt_random = 0; -static int opt_urandom = 0; -static int opt_dump_master_key = 0; -static int opt_shared = 0; -static int opt_allow_discards = 0; -static int opt_perf_same_cpu_crypt = 0; -static int opt_perf_submit_from_crypt_cpus = 0; -static int opt_test_passphrase = 0; -static int opt_tcrypt_hidden = 0; -static int opt_tcrypt_system = 0; -static int opt_tcrypt_backup = 0; -static int opt_veracrypt = 0; -static int opt_veracrypt_pim = -1; -static int opt_veracrypt_query_pim = 0; -static int opt_deferred_remove = 0; -static int opt_serialize_memory_hard_pbkdf = 0; -//FIXME: check uint32 overflow for long type -static long opt_pbkdf_memory = DEFAULT_LUKS2_MEMORY_KB; -static long opt_pbkdf_parallel = DEFAULT_LUKS2_PARALLEL_THREADS; -static long opt_pbkdf_iterations = 0; -static int opt_iteration_time = 0; -static int opt_disable_locks = 0; -static int opt_disable_keyring = 0; -static int opt_integrity_nojournal = 0; -static int opt_integrity_no_wipe = 0; -static int opt_integrity_legacy_padding = 0; -static int opt_sector_size = 0; -static int opt_iv_large_sectors = 0; -static int opt_persistent = 0; -static int opt_unbound = 0; -static int opt_refresh = 0; -static int opt_test_args = 0; - -/* LUKS2 reencryption parameters */ -static int opt_encrypt = 0; -static int opt_reencrypt_init_only = 0; -static int opt_reencrypt_resume_only = 0; -static int opt_decrypt = 0; - -/* do not set from command line, use helpers above */ -static int64_t opt_data_shift; static const char *device_type = "luks"; static const char *set_pbkdf = NULL; @@ -129,42 +42,24 @@ static int total_keyfiles = 0; void tools_cleanup(void) { - FREE_AND_NULL(opt_cipher); - FREE_AND_NULL(opt_keyslot_cipher); - FREE_AND_NULL(opt_hash); - FREE_AND_NULL(opt_json_file); - FREE_AND_NULL(opt_key_file); - FREE_AND_NULL(opt_keyfile_stdin); - FREE_AND_NULL(opt_master_key_file); - FREE_AND_NULL(opt_header_backup_file); - FREE_AND_NULL(opt_uuid); - FREE_AND_NULL(opt_header_device); - FREE_AND_NULL(opt_type); - FREE_AND_NULL(opt_pbkdf); - FREE_AND_NULL(opt_priority); - FREE_AND_NULL(opt_integrity); - FREE_AND_NULL(opt_key_description); - FREE_AND_NULL(opt_label); - FREE_AND_NULL(opt_subsystem); - FREE_AND_NULL(opt_active_name); - FREE_AND_NULL(opt_resilience_mode); - FREE_AND_NULL(opt_resilience_hash); - FREE_AND_NULL(opt_reduce_size_str); - FREE_AND_NULL(opt_hotzone_size_str); - FREE_AND_NULL(opt_device_size_str); - FREE_AND_NULL(opt_luks2_metadata_size_str); - FREE_AND_NULL(opt_luks2_keyslots_size_str); + tools_args_free(tool_core_args, ARRAY_SIZE(tool_core_args)); - while (opt_keyfiles_count) - free(opt_keyfiles[--opt_keyfiles_count]); + FREE_AND_NULL(keyfile_stdin); + + while (keyfiles_count) + free(keyfiles[--keyfiles_count]); + + total_keyfiles = 0; + + args_reset_default_values(tool_core_args); } static const char *uuid_or_device_header(const char **data_device) { if (data_device) - *data_device = opt_header_device ? action_argv[0] : NULL; + *data_device = ARG_SET(OPT_HEADER_ID) ? action_argv[0] : NULL; - return uuid_or_device(opt_header_device ?: action_argv[0]); + return uuid_or_device(ARG_STR(OPT_HEADER_ID) ?: action_argv[0]); } static const char *luksType(const char *type) @@ -187,14 +82,14 @@ static const char *luksType(const char *type) static int _verify_passphrase(int def) { /* Batch mode switch off verify - if not overridden by -y */ - if (opt_verify_passphrase) + if (ARG_SET(OPT_VERIFY_PASSPHRASE_ID)) def = 1; - else if (opt_batch_mode) + else if (ARG_SET(OPT_BATCH_MODE_ID)) def = 0; /* Non-tty input doesn't allow verify */ if (def && !isatty(STDIN_FILENO)) { - if (opt_verify_passphrase) + if (ARG_SET(OPT_VERIFY_PASSPHRASE_ID)) log_err(_("Can't do passphrase verification on non-tty inputs.")); def = 0; } @@ -204,43 +99,43 @@ static int _verify_passphrase(int def) static void _set_activation_flags(uint32_t *flags) { - if (opt_readonly) + if (ARG_SET(OPT_READONLY_ID)) *flags |= CRYPT_ACTIVATE_READONLY; - if (opt_allow_discards) + if (ARG_SET(OPT_ALLOW_DISCARDS_ID)) *flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS; - if (opt_perf_same_cpu_crypt) + if (ARG_SET(OPT_PERF_SAME_CPU_CRYPT_ID)) *flags |= CRYPT_ACTIVATE_SAME_CPU_CRYPT; - if (opt_perf_submit_from_crypt_cpus) + if (ARG_SET(OPT_PERF_SUBMIT_FROM_CRYPT_CPUS_ID)) *flags |= CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS; - if (opt_integrity_nojournal) + if (ARG_SET(OPT_INTEGRITY_NO_JOURNAL_ID)) *flags |= CRYPT_ACTIVATE_NO_JOURNAL; /* In persistent mode, we use what is set on command line */ - if (opt_persistent) + if (ARG_SET(OPT_PERSISTENT_ID)) *flags |= CRYPT_ACTIVATE_IGNORE_PERSISTENT; /* Only for LUKS2 but ignored elsewhere */ - if (opt_test_passphrase) + if (ARG_SET(OPT_TEST_PASSPHRASE_ID)) *flags |= CRYPT_ACTIVATE_ALLOW_UNBOUND_KEY; - if (opt_serialize_memory_hard_pbkdf) + if (ARG_SET(OPT_SERIALIZE_MEMORY_HARD_PBKDF_ID)) *flags |= CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF; /* Only for plain */ - if (opt_iv_large_sectors) + if (ARG_SET(OPT_IV_LARGE_SECTORS_ID)) *flags |= CRYPT_ACTIVATE_IV_LARGE_SECTORS; } static void _set_reencryption_flags(uint32_t *flags) { - if (opt_reencrypt_init_only) + if (ARG_SET(OPT_INIT_ONLY_ID)) *flags |= CRYPT_REENCRYPT_INITIALIZE_ONLY; - if (opt_reencrypt_resume_only) + if (ARG_SET(OPT_RESUME_ONLY_ID)) *flags |= CRYPT_REENCRYPT_RESUME_ONLY; } @@ -248,7 +143,7 @@ static int _set_keyslot_encryption_params(struct crypt_device *cd) { const char *type = crypt_get_type(cd); - if (!opt_keyslot_key_size && !opt_keyslot_cipher) + if (!ARG_SET(OPT_KEYSLOT_KEY_SIZE_ID) && !ARG_SET(OPT_KEYSLOT_CIPHER_ID)) return 0; if (!type || strcmp(type, CRYPT_LUKS2)) { @@ -256,7 +151,7 @@ static int _set_keyslot_encryption_params(struct crypt_device *cd) return -EINVAL; } - return crypt_keyslot_set_encryption(cd, opt_keyslot_cipher, opt_keyslot_key_size / 8); + return crypt_keyslot_set_encryption(cd, ARG_STR(OPT_KEYSLOT_CIPHER_ID), ARG_UINT32(OPT_KEYSLOT_KEY_SIZE_ID) / 8); } static int action_open_plain(void) @@ -266,20 +161,20 @@ static int action_open_plain(void) char *msg, cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN]; struct crypt_active_device cad; struct crypt_params_plain params = { - .hash = opt_hash ?: DEFAULT_PLAIN_HASH, - .skip = opt_skip, - .offset = opt_offset, - .size = opt_size, - .sector_size = opt_sector_size ?: SECTOR_SIZE + .hash = ARG_SET(OPT_HASH_ID) ? ARG_STR(OPT_HASH_ID) : DEFAULT_PLAIN_HASH, + .skip = ARG_UINT64(OPT_SKIP_ID), + .offset = ARG_UINT64(OPT_OFFSET_ID), + .size = ARG_UINT64(OPT_SIZE_ID), + .sector_size = ARG_UINT32(OPT_SECTOR_SIZE_ID) ?: SECTOR_SIZE }; char *password = NULL; const char *activated_name = NULL; size_t passwordLen, key_size_max, signatures = 0, - key_size = (opt_key_size ?: DEFAULT_PLAIN_KEYBITS) / 8; + key_size = (ARG_UINT32(OPT_KEY_SIZE_ID) ?: DEFAULT_PLAIN_KEYBITS) / 8; uint32_t activate_flags = 0; int r; - r = crypt_parse_name_and_mode(opt_cipher ?: DEFAULT_CIPHER(PLAIN), + r = crypt_parse_name_and_mode(ARG_STR(OPT_CIPHER_ID) ?: DEFAULT_CIPHER(PLAIN), cipher, NULL, cipher_mode); if (r < 0) { log_err(_("No known cipher specification pattern detected.")); @@ -287,9 +182,9 @@ static int action_open_plain(void) } /* FIXME: temporary hack, no hashing for keyfiles in plain mode */ - if (opt_key_file && !tools_is_stdin(opt_key_file)) { + if (ARG_SET(OPT_KEY_FILE_ID) && !tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID))) { params.hash = NULL; - if (!opt_batch_mode && opt_hash) + if (!ARG_SET(OPT_BATCH_MODE_ID) && ARG_SET(OPT_HASH_ID)) log_std(_("WARNING: The --hash parameter is being ignored " "in plain mode with keyfile specified.\n")); } @@ -297,11 +192,11 @@ static int action_open_plain(void) if (params.hash && !strcmp(params.hash, "plain")) params.hash = NULL; - if (!opt_batch_mode && !params.hash && opt_key_file && !tools_is_stdin(opt_key_file) && opt_keyfile_size) + if (!ARG_SET(OPT_BATCH_MODE_ID) && !params.hash && ARG_SET(OPT_KEY_FILE_ID) && !tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)) && ARG_SET(OPT_KEYFILE_SIZE_ID)) log_std(_("WARNING: The --keyfile-size option is being ignored, " "the read size is the same as the encryption key size.\n")); - if (opt_refresh) { + if (ARG_SET(OPT_REFRESH_ID)) { activated_name = action_argc > 1 ? action_argv[1] : action_argv[0]; r = crypt_init_by_name_and_header(&cd1, activated_name, NULL); if (r) @@ -330,7 +225,7 @@ static int action_open_plain(void) goto out; /* Skip blkid scan when activating plain device with offset */ - if (!opt_offset) { + if (!ARG_UINT64(OPT_OFFSET_ID)) { /* Print all present signatures in read-only mode */ r = tools_detect_signatures(action_argv[0], 0, &signatures); if (r < 0) @@ -363,26 +258,26 @@ static int action_open_plain(void) if (r < 0) goto out; - if (opt_shared) + if (ARG_SET(OPT_SHARED_ID)) activate_flags |= CRYPT_ACTIVATE_SHARED; _set_activation_flags(&activate_flags); - if (!tools_is_stdin(opt_key_file)) { + if (!tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID))) { /* If no hash, key is read directly, read size is always key_size - * (possible opt_keyfile_size is ignored. - * If hash is specified, opt_keyfile_size is applied. - * The opt_keyfile_offset is applied always. + * (possible --keyfile_size is ignored. + * If hash is specified, --keyfile_size is applied. + * The --keyfile_offset is applied always. */ - key_size_max = params.hash ? (size_t)opt_keyfile_size : key_size; + key_size_max = params.hash ? ARG_UINT32(OPT_KEYFILE_SIZE_ID) : key_size; r = crypt_activate_by_keyfile_device_offset(cd, action_argv[1], - CRYPT_ANY_SLOT, opt_key_file, key_size_max, - opt_keyfile_offset, activate_flags); + CRYPT_ANY_SLOT, ARG_STR(OPT_KEY_FILE_ID), key_size_max, + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), activate_flags); } else { - key_size_max = (opt_key_file && !params.hash) ? key_size : (size_t)opt_keyfile_size; + key_size_max = (ARG_SET(OPT_KEY_FILE_ID) && !params.hash) ? key_size : ARG_UINT32(OPT_KEYFILE_SIZE_ID); r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, key_size_max, - opt_key_file, opt_timeout, + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), key_size_max, + ARG_STR(OPT_KEY_FILE_ID), ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; @@ -402,21 +297,21 @@ static int action_open_loopaes(void) { struct crypt_device *cd = NULL; struct crypt_params_loopaes params = { - .hash = opt_hash ?: NULL, - .offset = opt_offset, - .skip = opt_skip_valid ? opt_skip : opt_offset, + .hash = ARG_STR(OPT_HASH_ID), + .offset = ARG_UINT64(OPT_OFFSET_ID), + .skip = ARG_SET(OPT_SKIP_ID) ? ARG_UINT64(OPT_SKIP_ID) : ARG_UINT64(OPT_OFFSET_ID) }; - unsigned int key_size = (opt_key_size ?: DEFAULT_LOOPAES_KEYBITS) / 8; + unsigned int key_size = (ARG_UINT32(OPT_KEY_SIZE_ID) ?: DEFAULT_LOOPAES_KEYBITS) / 8; uint32_t activate_flags = 0; const char *activated_name = NULL; int r; - if (!opt_key_file) { + if (!ARG_SET(OPT_KEY_FILE_ID)) { log_err(_("Option --key-file is required.")); return -EINVAL; } - if (opt_refresh) { + if (ARG_SET(OPT_REFRESH_ID)) { activated_name = action_argc > 1 ? action_argv[1] : action_argv[0]; if ((r = crypt_init_by_name(&cd, activated_name))) goto out; @@ -426,7 +321,7 @@ static int action_open_loopaes(void) if ((r = crypt_init(&cd, action_argv[0]))) goto out; - r = crypt_format(cd, CRYPT_LOOPAES, opt_cipher ?: DEFAULT_LOOPAES_CIPHER, + r = crypt_format(cd, CRYPT_LOOPAES, ARG_STR(OPT_CIPHER_ID) ?: DEFAULT_LOOPAES_CIPHER, NULL, NULL, NULL, key_size, ¶ms); check_signal(&r); if (r < 0) @@ -436,8 +331,8 @@ static int action_open_loopaes(void) _set_activation_flags(&activate_flags); r = crypt_activate_by_keyfile_device_offset(cd, activated_name, CRYPT_ANY_SLOT, - tools_is_stdin(opt_key_file) ? "/dev/stdin" : opt_key_file, opt_keyfile_size, - opt_keyfile_offset, activate_flags); + tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)) ? "/dev/stdin" : ARG_STR(OPT_KEY_FILE_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), activate_flags); out: crypt_free(cd); @@ -446,20 +341,20 @@ out: static int tcrypt_load(struct crypt_device *cd, struct crypt_params_tcrypt *params) { - int r, tries = opt_tries, eperm = 0; + int r, tries = ARG_UINT32(OPT_TRIES_ID), eperm = 0; - if (opt_keyfile_stdin) + if (keyfile_stdin) tries = 1; do { /* TCRYPT header is encrypted, get passphrase now */ r = tools_get_key(NULL, CONST_CAST(char**)¶ms->passphrase, - ¶ms->passphrase_size, 0, 0, opt_keyfile_stdin, opt_timeout, + ¶ms->passphrase_size, 0, 0, keyfile_stdin, ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) continue; - if (opt_veracrypt_query_pim) { + if (ARG_SET(OPT_VERACRYPT_QUERY_PIM_ID)) { char *tmp_pim_nptr = NULL; char *tmp_pim_end = NULL; size_t tmp_pim_size = 0; @@ -467,7 +362,7 @@ static int tcrypt_load(struct crypt_device *cd, struct crypt_params_tcrypt *para r = tools_get_key(_("Enter VeraCrypt PIM: "), CONST_CAST(char**)&tmp_pim_nptr, - &tmp_pim_size, 0, 0, opt_keyfile_stdin, opt_timeout, + &tmp_pim_size, 0, 0, keyfile_stdin, ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) continue; @@ -491,13 +386,13 @@ static int tcrypt_load(struct crypt_device *cd, struct crypt_params_tcrypt *para crypt_safe_memzero(&tmp_pim_ull, sizeof(tmp_pim_ull)); } - if (opt_tcrypt_hidden) + if (ARG_SET(OPT_TCRYPT_HIDDEN_ID)) params->flags |= CRYPT_TCRYPT_HIDDEN_HEADER; - if (opt_tcrypt_system) + if (ARG_SET(OPT_TCRYPT_SYSTEM_ID)) params->flags |= CRYPT_TCRYPT_SYSTEM_HEADER; - if (opt_tcrypt_backup) + if (ARG_SET(OPT_TCRYPT_BACKUP_ID)) params->flags |= CRYPT_TCRYPT_BACKUP_HEADER; r = crypt_load(cd, CRYPT_TCRYPT, params); @@ -526,17 +421,17 @@ static int action_open_tcrypt(void) { struct crypt_device *cd = NULL; struct crypt_params_tcrypt params = { - .keyfiles = CONST_CAST(const char **)opt_keyfiles, - .keyfiles_count = opt_keyfiles_count, + .keyfiles = CONST_CAST(const char **)keyfiles, + .keyfiles_count = keyfiles_count, .flags = CRYPT_TCRYPT_LEGACY_MODES | - (opt_veracrypt ? CRYPT_TCRYPT_VERA_MODES : 0), - .veracrypt_pim = (opt_veracrypt_pim > 0) ? opt_veracrypt_pim : 0, + (ARG_SET(OPT_VERACRYPT_ID) ? CRYPT_TCRYPT_VERA_MODES : 0), + .veracrypt_pim = ARG_UINT32(OPT_VERACRYPT_PIM_ID), }; const char *activated_name; uint32_t activate_flags = 0; int r; - activated_name = opt_test_passphrase ? NULL : action_argv[1]; + activated_name = ARG_SET(OPT_TEST_PASSPHRASE_ID) ? NULL : action_argv[1]; if ((r = crypt_init(&cd, action_argv[0]))) goto out; @@ -565,7 +460,7 @@ static int action_open_bitlk(void) char *password = NULL; size_t passwordLen; - activated_name = opt_test_passphrase ? NULL : action_argv[1]; + activated_name = ARG_SET(OPT_TEST_PASSPHRASE_ID) ? NULL : action_argv[1]; if ((r = crypt_init(&cd, action_argv[0]))) goto out; @@ -577,11 +472,11 @@ static int action_open_bitlk(void) } _set_activation_flags(&activate_flags); - tries = (tools_is_stdin(opt_key_file) && isatty(STDIN_FILENO)) ? opt_tries : 1; + tries = (tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)) && isatty(STDIN_FILENO)) ? ARG_UINT32(OPT_TRIES_ID) : 1; do { r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; @@ -644,11 +539,11 @@ static int action_tcryptDump(void) { struct crypt_device *cd = NULL; struct crypt_params_tcrypt params = { - .keyfiles = CONST_CAST(const char **)opt_keyfiles, - .keyfiles_count = opt_keyfiles_count, + .keyfiles = CONST_CAST(const char **)keyfiles, + .keyfiles_count = keyfiles_count, .flags = CRYPT_TCRYPT_LEGACY_MODES | - (opt_veracrypt ? CRYPT_TCRYPT_VERA_MODES : 0), - .veracrypt_pim = (opt_veracrypt_pim > 0) ? opt_veracrypt_pim : 0, + (ARG_SET(OPT_VERACRYPT_ID) ? CRYPT_TCRYPT_VERA_MODES : 0), + .veracrypt_pim = ARG_UINT32(OPT_VERACRYPT_PIM_ID) }; int r; @@ -659,7 +554,7 @@ static int action_tcryptDump(void) if (r < 0) goto out; - if (opt_dump_master_key) + if (ARG_SET(OPT_DUMP_MASTER_KEY_ID)) r = tcryptDump_with_volume_key(cd); else r = crypt_dump(cd); @@ -694,14 +589,14 @@ static int action_close(void) uint32_t flags = 0; int r; - if (opt_deferred_remove) + if (ARG_SET(OPT_DEFERRED_ID)) flags |= CRYPT_DEACTIVATE_DEFERRED; r = crypt_init_by_name(&cd, action_argv[0]); if (r == 0) r = crypt_deactivate_by_name(cd, action_argv[0], flags); - if (!r && opt_deferred_remove) { + if (!r && ARG_SET(OPT_DEFERRED_ID)) { ci = crypt_status(cd, action_argv[0]); if (ci == CRYPT_ACTIVE || ci == CRYPT_BUSY) log_std(_("Device %s is still active and scheduled for deferred removal.\n"), @@ -717,10 +612,11 @@ static int action_resize(void) int r; size_t passwordLen; struct crypt_active_device cad; + uint64_t dev_size; char *password = NULL; struct crypt_device *cd = NULL; - r = crypt_init_by_name_and_header(&cd, action_argv[0], opt_header_device); + r = crypt_init_by_name_and_header(&cd, action_argv[0], ARG_STR(OPT_HEADER_ID)); if (r) goto out; @@ -730,7 +626,7 @@ static int action_resize(void) goto out; if (cad.flags & CRYPT_ACTIVATE_KEYRING_KEY) { - if (opt_disable_keyring) { + if (ARG_SET(OPT_DISABLE_KEYRING_ID)) { r = -EINVAL; log_err(_("Resize of active device requires volume key " "in keyring but --disable-keyring option is set.")); @@ -738,19 +634,19 @@ static int action_resize(void) } /* try load VK in kernel keyring using token */ - r = crypt_activate_by_token(cd, NULL, opt_token, NULL, + r = crypt_activate_by_token(cd, NULL, ARG_INT32(OPT_TOKEN_ID_ID), NULL, CRYPT_ACTIVATE_KEYRING_KEY); tools_keyslot_msg(r, UNLOCKED); - if (r < 0 && opt_token_only) + if (r < 0 && ARG_SET(OPT_TOKEN_ONLY_ID)) goto out; r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; - r = crypt_activate_by_passphrase(cd, NULL, opt_key_slot, + r = crypt_activate_by_passphrase(cd, NULL, ARG_INT32(OPT_KEY_SLOT_ID), password, passwordLen, CRYPT_ACTIVATE_KEYRING_KEY); tools_passphrase_msg(r); @@ -758,11 +654,13 @@ static int action_resize(void) crypt_safe_free(password); } - if (opt_device_size) - opt_size = opt_device_size / SECTOR_SIZE; + if (ARG_UINT64(OPT_DEVICE_SIZE_ID)) + dev_size = ARG_UINT64(OPT_DEVICE_SIZE_ID) / SECTOR_SIZE; + else + dev_size = ARG_UINT64(OPT_SIZE_ID); if (r >= 0) - r = crypt_resize(cd, action_argv[0], opt_size); + r = crypt_resize(cd, action_argv[0], dev_size); out: crypt_free(cd); return r; @@ -804,7 +702,7 @@ static int action_status(void) log_std("%s/%s is active%s.\n", crypt_get_dir(), action_argv[0], ci == CRYPT_BUSY ? " and is in use" : ""); - r = crypt_init_by_name_and_header(&cd, action_argv[0], opt_header_device); + r = crypt_init_by_name_and_header(&cd, action_argv[0], ARG_STR(OPT_HEADER_ID)); if (r < 0) goto out; @@ -897,9 +795,9 @@ static int action_benchmark_kdf(const char *kdf, const char *hash, size_t key_si } else { struct crypt_pbkdf_type pbkdf = { .type = kdf, - .time_ms = opt_iteration_time ?: DEFAULT_LUKS2_ITER_TIME, - .max_memory_kb = opt_pbkdf_memory, - .parallel_threads = opt_pbkdf_parallel, + .time_ms = ARG_UINT32(OPT_ITER_TIME_ID) ?: DEFAULT_LUKS2_ITER_TIME, + .max_memory_kb = ARG_UINT32(OPT_PBKDF_MEMORY_ID), + .parallel_threads = ARG_UINT32(OPT_PBKDF_PARALLEL_ID) }; r = crypt_benchmark_pbkdf(NULL, &pbkdf, "foo", 3, @@ -977,18 +875,18 @@ static int action_benchmark(void) }; char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN]; double enc_mbr = 0, dec_mbr = 0; - int key_size = (opt_key_size ?: DEFAULT_PLAIN_KEYBITS) / 8; + int key_size = (ARG_UINT32(OPT_KEY_SIZE_ID) ?: DEFAULT_PLAIN_KEYBITS) / 8; int skipped = 0, width; char *c; int i, r; log_std(_("# Tests are approximate using memory only (no storage IO).\n")); - if (set_pbkdf || opt_hash) { - if (!set_pbkdf && opt_hash) + if (set_pbkdf || ARG_SET(OPT_HASH_ID)) { + if (!set_pbkdf && ARG_SET(OPT_HASH_ID)) set_pbkdf = CRYPT_KDF_PBKDF2; - r = action_benchmark_kdf(set_pbkdf, opt_hash, key_size); - } else if (opt_cipher) { - r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, cipher_mode); + r = action_benchmark_kdf(set_pbkdf, ARG_STR(OPT_HASH_ID), key_size); + } else if (ARG_SET(OPT_CIPHER_ID)) { + r = crypt_parse_name_and_mode(ARG_STR(OPT_CIPHER_ID), cipher, NULL, cipher_mode); if (r < 0) { log_err(_("No known cipher specification pattern detected.")); return r; @@ -1006,7 +904,7 @@ static int action_benchmark(void) log_std("%*s-%s %9db %10.1f MiB/s %10.1f MiB/s\n", width - (int)strlen(cipher_mode) - 1, cipher, cipher_mode, key_size*8, enc_mbr, dec_mbr); } else if (r < 0) - log_err(_("Cipher %s (with %i bits key) is not available."), opt_cipher, key_size * 8); + log_err(_("Cipher %s (with %i bits key) is not available."), ARG_STR(OPT_CIPHER_ID), key_size * 8); } else { for (i = 0; bkdfs[i].type; i++) { r = action_benchmark_kdf(bkdfs[i].type, bkdfs[i].hash, key_size); @@ -1059,15 +957,15 @@ static int set_pbkdf_params(struct crypt_device *cd, const char *dev_type) return -EINVAL; pbkdf.type = set_pbkdf ?: pbkdf_default->type; - pbkdf.hash = opt_hash ?: pbkdf_default->hash; - pbkdf.time_ms = (uint32_t)opt_iteration_time ?: pbkdf_default->time_ms; + pbkdf.hash = ARG_STR(OPT_HASH_ID) ?: pbkdf_default->hash; + pbkdf.time_ms = ARG_UINT32(OPT_ITER_TIME_ID) ?: pbkdf_default->time_ms; if (strcmp(pbkdf.type, CRYPT_KDF_PBKDF2)) { - pbkdf.max_memory_kb = (uint32_t)opt_pbkdf_memory ?: pbkdf_default->max_memory_kb; - pbkdf.parallel_threads = (uint32_t)opt_pbkdf_parallel ?: pbkdf_default->parallel_threads; + pbkdf.max_memory_kb = ARG_UINT32(OPT_PBKDF_MEMORY_ID) ?: pbkdf_default->max_memory_kb; + pbkdf.parallel_threads = ARG_UINT32(OPT_PBKDF_PARALLEL_ID) ?: pbkdf_default->parallel_threads; } - if (opt_pbkdf_iterations) { - pbkdf.iterations = opt_pbkdf_iterations; + if (ARG_SET(OPT_PBKDF_FORCE_ITERATIONS_ID)) { + pbkdf.iterations = ARG_UINT32(OPT_PBKDF_FORCE_ITERATIONS_ID); pbkdf.time_ms = 0; pbkdf.flags |= CRYPT_PBKDF_NO_BENCHMARK; } @@ -1089,7 +987,7 @@ static int set_keyslot_params(struct crypt_device *cd, int keyslot) return -EINVAL; /* if requested any of those just reinitialize context pbkdf */ - if (set_pbkdf || opt_hash || opt_pbkdf_iterations || opt_iteration_time) + if (set_pbkdf || ARG_SET(OPT_HASH_ID) || ARG_SET(OPT_PBKDF_FORCE_ITERATIONS_ID) || ARG_SET(OPT_ITER_TIME_ID)) return set_pbkdf_params(cd, CRYPT_LUKS2); if (crypt_keyslot_get_pbkdf(cd, keyslot, &pbkdf)) @@ -1130,19 +1028,19 @@ static int _do_luks2_reencrypt_recovery(struct crypt_device *cd) } r = tools_get_key(_("Enter passphrase for reencryption recovery: "), - &password, &passwordLen, opt_keyfile_offset, - opt_keyfile_size, opt_key_file, opt_timeout, + &password, &passwordLen, ARG_UINT64(OPT_KEYFILE_OFFSET_ID), + ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) return r; - r = crypt_activate_by_passphrase(cd, NULL, opt_key_slot, + r = crypt_activate_by_passphrase(cd, NULL, ARG_INT32(OPT_KEY_SLOT_ID), password, passwordLen, 0); if (r < 0) goto out; r = crypt_reencrypt_init_by_passphrase(cd, NULL, password, passwordLen, - opt_key_slot, opt_key_slot, NULL, NULL, &recovery_params); + ARG_INT32(OPT_KEY_SLOT_ID), ARG_INT32(OPT_KEY_SLOT_ID), NULL, NULL, &recovery_params); if (r > 0) r = 0; out: @@ -1156,7 +1054,7 @@ static int action_luksRepair(void) struct crypt_device *cd = NULL; int r; - if ((r = crypt_init_data_device(&cd, opt_header_device ?: action_argv[0], + if ((r = crypt_init_data_device(&cd, ARG_STR(OPT_HEADER_ID) ?: action_argv[0], action_argv[0]))) goto out; @@ -1190,7 +1088,7 @@ static int _wipe_data_device(struct crypt_device *cd) uuid_t tmp_uuid_bin; int r; - if (!opt_batch_mode) + if (!ARG_SET(OPT_BATCH_MODE_ID)) log_std(_("Wiping device to initialize integrity checksum.\n" "You can interrupt this by pressing CTRL+c " "(rest of not wiped device will contain invalid checksum).\n")); @@ -1234,16 +1132,16 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ size_t passwordLen, signatures; struct crypt_device *cd = NULL; struct crypt_params_luks1 params1 = { - .hash = opt_hash ?: DEFAULT_LUKS1_HASH, - .data_alignment = opt_align_payload, - .data_device = opt_header_device ? action_argv[0] : NULL, + .hash = ARG_STR(OPT_HASH_ID) ?: DEFAULT_LUKS1_HASH, + .data_alignment = ARG_UINT32(OPT_ALIGN_PAYLOAD_ID), + .data_device = ARG_SET(OPT_HEADER_ID) ? action_argv[0] : NULL, }; struct crypt_params_luks2 params2 = { .data_alignment = params1.data_alignment, .data_device = params1.data_device, - .sector_size = opt_sector_size ?: SECTOR_SIZE, - .label = opt_label, - .subsystem = opt_subsystem + .sector_size = ARG_UINT32(OPT_SECTOR_SIZE_ID) ?: SECTOR_SIZE, + .label = ARG_STR(OPT_LABEL_ID), + .subsystem = ARG_STR(OPT_SUBSYSTEM_ID) }; void *params; @@ -1256,17 +1154,17 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ } else if (!strcmp(type, CRYPT_LUKS1)) { params = ¶ms1; - if (opt_sector_size > SECTOR_SIZE) { + if (ARG_UINT32(OPT_SECTOR_SIZE_ID) > SECTOR_SIZE) { log_err(_("Unsupported encryption sector size.")); return -EINVAL; } - if (opt_integrity) { + if (ARG_SET(OPT_INTEGRITY_ID)) { log_err(_("Integrity option can be used only for LUKS2 format.")); return -EINVAL; } - if (opt_luks2_keyslots_size || opt_luks2_metadata_size) { + if (ARG_SET(OPT_LUKS2_KEYSLOTS_SIZE_ID) || ARG_SET(OPT_LUKS2_METADATA_SIZE_ID)) { log_err(_("Unsupported LUKS2 metadata size options.")); return -EINVAL; } @@ -1274,17 +1172,17 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ return -EINVAL; /* Create header file (must contain at least one sector)? */ - if (opt_header_device && stat(opt_header_device, &st) < 0 && errno == ENOENT) { - if (!opt_batch_mode && + if (ARG_SET(OPT_HEADER_ID) && stat(ARG_STR(OPT_HEADER_ID), &st) < 0 && errno == ENOENT) { + if (!ARG_SET(OPT_BATCH_MODE_ID) && !yesDialog("Header file does not exist, do you want to create it?", _("Operation aborted.\n"))) return -EPERM; log_dbg("Creating header file."); /* coverity[toctou] */ - fd = open(opt_header_device, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR); + fd = open(ARG_STR(OPT_HEADER_ID), O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR); if (fd == -1 || posix_fallocate(fd, 0, 4096)) - log_err(_("Cannot create header file %s."), opt_header_device); + log_err(_("Cannot create header file %s."), ARG_STR(OPT_HEADER_ID)); else { r = 0; created = 1; @@ -1295,17 +1193,17 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ return r; } - header_device = opt_header_device ?: action_argv[0]; + header_device = ARG_STR(OPT_HEADER_ID) ?: action_argv[0]; - r = crypt_parse_name_and_mode(opt_cipher ?: DEFAULT_CIPHER(LUKS1), + r = crypt_parse_name_and_mode(ARG_STR(OPT_CIPHER_ID) ?: DEFAULT_CIPHER(LUKS1), cipher, NULL, cipher_mode); if (r < 0) { log_err(_("No known cipher specification pattern detected.")); goto out; } - if (opt_integrity) { - r = crypt_parse_integrity_mode(opt_integrity, integrity, &integrity_keysize); + if (ARG_SET(OPT_INTEGRITY_ID)) { + r = crypt_parse_integrity_mode(ARG_STR(OPT_INTEGRITY_ID), integrity, &integrity_keysize); if (r < 0) { log_err(_("No known integrity specification pattern detected.")); goto out; @@ -1316,24 +1214,24 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ /* Never call pwquality if using null cipher */ if (tools_is_cipher_null(cipher)) - opt_force_password = 1; + ARG_SET(OPT_FORCE_PASSWORD_ID) = true; if ((r = crypt_init(&cd, header_device))) { - if (opt_header_device) + if (ARG_SET(OPT_HEADER_ID)) log_err(_("Cannot use %s as on-disk header."), header_device); return r; } - if (opt_luks2_keyslots_size || opt_luks2_metadata_size) { - r = crypt_set_metadata_size(cd, opt_luks2_metadata_size, opt_luks2_keyslots_size); + if (ARG_SET(OPT_LUKS2_KEYSLOTS_SIZE_ID) || ARG_SET(OPT_LUKS2_METADATA_SIZE_ID)) { + r = crypt_set_metadata_size(cd, ARG_UINT64(OPT_LUKS2_METADATA_SIZE_ID), ARG_UINT64(OPT_LUKS2_KEYSLOTS_SIZE_ID)); if (r < 0) { log_err(_("Unsupported LUKS2 metadata size options.")); goto out; } } - if (opt_offset) { - r = crypt_set_data_offset(cd, opt_offset); + if (ARG_SET(OPT_OFFSET_ID)) { + r = crypt_set_data_offset(cd, ARG_UINT64(OPT_OFFSET_ID)); if (r < 0) goto out; } @@ -1357,28 +1255,28 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ } #ifdef ENABLE_LUKS_ADJUST_XTS_KEYSIZE - if (!opt_key_size && !strncmp(cipher_mode, "xts-", 4)) { + if (!ARG_SET(OPT_KEY_SIZE_ID) && !strncmp(cipher_mode, "xts-", 4)) { if (DEFAULT_LUKS1_KEYBITS == 128) - opt_key_size = 256; + ARG_SET_UINT32(OPT_KEY_SIZE_ID, 256); else if (DEFAULT_LUKS1_KEYBITS == 256) - opt_key_size = 512; + ARG_SET_UINT32(OPT_KEY_SIZE_ID, 512); } #endif - keysize = (opt_key_size ?: DEFAULT_LUKS1_KEYBITS) / 8 + integrity_keysize; + keysize = (ARG_UINT32(OPT_KEY_SIZE_ID) ?: DEFAULT_LUKS1_KEYBITS) / 8 + integrity_keysize; - if (opt_random) + if (ARG_SET(OPT_USE_RANDOM_ID)) crypt_set_rng_type(cd, CRYPT_RNG_RANDOM); - else if (opt_urandom) + else if (ARG_SET(OPT_USE_URANDOM_ID)) crypt_set_rng_type(cd, CRYPT_RNG_URANDOM); r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(1), 1, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(1), 1, cd); if (r < 0) goto out; - if (opt_master_key_file) { - r = tools_read_mk(opt_master_key_file, &key, keysize); + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + r = tools_read_mk(ARG_STR(OPT_MASTER_KEY_FILE_ID), &key, keysize); if (r < 0) goto out; } @@ -1393,11 +1291,11 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ if (signatures && ((r = tools_wipe_all_signatures(header_device)) < 0)) goto out; - if (opt_integrity_legacy_padding) + if (ARG_SET(OPT_INTEGRITY_LEGACY_PADDING_ID)) crypt_set_compatibility(cd, CRYPT_COMPAT_LEGACY_INTEGRITY_PADDING); r = crypt_format(cd, type, cipher, cipher_mode, - opt_uuid, key, keysize, params); + ARG_STR(OPT_UUID_ID), key, keysize, params); check_signal(&r); if (r < 0) goto out; @@ -1406,7 +1304,7 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ if (r < 0) goto out; - r = crypt_keyslot_add_by_volume_key(cd, opt_key_slot, + r = crypt_keyslot_add_by_volume_key(cd, ARG_INT32(OPT_KEY_SLOT_ID), key, keysize, password, passwordLen); if (r < 0) { @@ -1415,7 +1313,7 @@ static int _luksFormat(struct crypt_device **r_cd, char **r_password, size_t *r_ } tools_keyslot_msg(r, CREATED); - if (opt_integrity && !opt_integrity_no_wipe && + if (ARG_SET(OPT_INTEGRITY_ID) && !ARG_SET(OPT_INTEGRITY_NO_WIPE_ID) && strcmp_or_null(params2.integrity, "none")) r = _wipe_data_device(cd); out: @@ -1449,16 +1347,16 @@ static int action_open_luks(void) char *password = NULL; size_t passwordLen; - if (opt_refresh) { + if (ARG_SET(OPT_REFRESH_ID)) { activated_name = action_argc > 1 ? action_argv[1] : action_argv[0]; - r = crypt_init_by_name_and_header(&cd, activated_name, opt_header_device); + r = crypt_init_by_name_and_header(&cd, activated_name, ARG_STR(OPT_HEADER_ID)); if (r) goto out; activate_flags |= CRYPT_ACTIVATE_REFRESH; } else { header_device = uuid_or_device_header(&data_device); - activated_name = opt_test_passphrase ? NULL : action_argv[1]; + activated_name = ARG_SET(OPT_TEST_PASSPHRASE_ID) ? NULL : action_argv[1]; if ((r = crypt_init_data_device(&cd, header_device, data_device))) goto out; @@ -1469,7 +1367,7 @@ static int action_open_luks(void) goto out; } - if (!data_device && (crypt_get_data_offset(cd) < 8) && !opt_test_passphrase) { + if (!data_device && (crypt_get_data_offset(cd) < 8) && !ARG_SET(OPT_TEST_PASSPHRASE_ID)) { log_err(_("Reduced data offset is allowed only for detached LUKS header.")); r = -EINVAL; goto out; @@ -1478,48 +1376,48 @@ static int action_open_luks(void) _set_activation_flags(&activate_flags); - if (opt_master_key_file) { + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { keysize = crypt_get_volume_key_size(cd); - if (!keysize && !opt_key_size) { + if (!keysize && !ARG_SET(OPT_KEY_SIZE_ID)) { log_err(_("Cannot determine volume key size for LUKS without keyslots, please use --key-size option.")); r = -EINVAL; goto out; } else if (!keysize) - keysize = opt_key_size / 8; + keysize = ARG_UINT32(OPT_KEY_SIZE_ID) / 8; - r = tools_read_mk(opt_master_key_file, &key, keysize); + r = tools_read_mk(ARG_STR(OPT_MASTER_KEY_FILE_ID), &key, keysize); if (r < 0) goto out; r = crypt_activate_by_volume_key(cd, activated_name, key, keysize, activate_flags); } else { - r = crypt_activate_by_token(cd, activated_name, opt_token, NULL, activate_flags); + r = crypt_activate_by_token(cd, activated_name, ARG_INT32(OPT_TOKEN_ID_ID), NULL, activate_flags); tools_keyslot_msg(r, UNLOCKED); /* Token requires PIN, but ask only there will be no password query later */ - if (opt_token_only && r == -EAGAIN) { + if (ARG_SET(OPT_TOKEN_ONLY_ID) && r == -EAGAIN) { r = tools_get_key(_("Enter token PIN:"), &password, &passwordLen, 0, 0, NULL, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; - r = crypt_activate_by_pin_token(cd, activated_name, opt_token, + r = crypt_activate_by_pin_token(cd, activated_name, ARG_INT32(OPT_TOKEN_ID_ID), password, NULL, activate_flags); tools_keyslot_msg(r, UNLOCKED); } - if (r >= 0 || opt_token_only) + if (r >= 0 || ARG_SET(OPT_TOKEN_ONLY_ID)) goto out; - tries = (tools_is_stdin(opt_key_file) && isatty(STDIN_FILENO)) ? opt_tries : 1; + tries = (tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)) && isatty(STDIN_FILENO)) ? ARG_UINT32(OPT_TRIES_ID) : 1; do { r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; r = crypt_activate_by_passphrase(cd, activated_name, - opt_key_slot, password, passwordLen, activate_flags); + ARG_INT32(OPT_KEY_SLOT_ID), password, passwordLen, activate_flags); tools_keyslot_msg(r, UNLOCKED); tools_passphrase_msg(r); check_signal(&r); @@ -1528,7 +1426,7 @@ static int action_open_luks(void) } while ((r == -EPERM || r == -ERANGE) && (--tries > 0)); } out: - if (r >= 0 && opt_persistent && + if (r >= 0 && ARG_SET(OPT_PERSISTENT_ID) && (crypt_get_active_device(cd, activated_name, &cad) || crypt_persistent_flags_set(cd, CRYPT_FLAGS_ACTIVATION, cad.flags & activate_flags))) log_err(_("Device activated but cannot make flags persistent.")); @@ -1548,12 +1446,12 @@ static int verify_keyslot(struct crypt_device *cd, int key_slot, crypt_keyslot_i size_t passwordLen; int i, max, r; - if (ki == CRYPT_SLOT_ACTIVE_LAST && !opt_batch_mode && !key_file && + if (ki == CRYPT_SLOT_ACTIVE_LAST && !ARG_SET(OPT_BATCH_MODE_ID) && !key_file && msg_last && !yesDialog(msg_last, msg_fail)) return -EPERM; r = tools_get_key(msg_pass, &password, &passwordLen, - keyfile_offset, keyfile_size, key_file, opt_timeout, + keyfile_offset, keyfile_size, key_file, ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; @@ -1607,30 +1505,30 @@ static int action_luksKillSlot(void) goto out; } - ki = crypt_keyslot_status(cd, opt_key_slot); + ki = crypt_keyslot_status(cd, ARG_INT32(OPT_KEY_SLOT_ID)); switch (ki) { case CRYPT_SLOT_ACTIVE_LAST: case CRYPT_SLOT_ACTIVE: case CRYPT_SLOT_UNBOUND: - log_verbose(_("Keyslot %d is selected for deletion."), opt_key_slot); + log_verbose(_("Keyslot %d is selected for deletion."), ARG_INT32(OPT_KEY_SLOT_ID)); break; case CRYPT_SLOT_INACTIVE: - log_err(_("Keyslot %d is not active."), opt_key_slot); + log_err(_("Keyslot %d is not active."), ARG_INT32(OPT_KEY_SLOT_ID)); /* fall through */ case CRYPT_SLOT_INVALID: r = -EINVAL; goto out; } - if (!opt_batch_mode || opt_key_file || !isatty(STDIN_FILENO)) { - r = verify_keyslot(cd, opt_key_slot, ki, + if (!ARG_SET(OPT_BATCH_MODE_ID) || ARG_SET(OPT_KEY_FILE_ID) || !isatty(STDIN_FILENO)) { + r = verify_keyslot(cd, ARG_INT32(OPT_KEY_SLOT_ID), ki, _("This is the last keyslot. Device will become unusable after purging this key."), _("Enter any remaining passphrase: "), _("Operation aborted, the keyslot was NOT wiped.\n"), - opt_key_file, opt_keyfile_offset, opt_keyfile_size); + ARG_STR(OPT_KEY_FILE_ID), ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID)); tools_keyslot_msg(r, UNLOCKED); - if (r == -EPIPE && (!opt_key_file || tools_is_stdin(opt_key_file))) { + if (r == -EPIPE && (!ARG_SET(OPT_KEY_FILE_ID) || tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)))) { log_dbg("Failed read from input, ignoring passphrase."); r = 0; } @@ -1639,8 +1537,8 @@ static int action_luksKillSlot(void) goto out; } - r = crypt_keyslot_destroy(cd, opt_key_slot); - tools_keyslot_msg(opt_key_slot, REMOVED); + r = crypt_keyslot_destroy(cd, ARG_INT32(OPT_KEY_SLOT_ID)); + tools_keyslot_msg(ARG_INT32(OPT_KEY_SLOT_ID), REMOVED); out: crypt_free(cd); return r; @@ -1666,8 +1564,8 @@ static int action_luksRemoveKey(void) r = tools_get_key(_("Enter passphrase to be deleted: "), &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if(r < 0) @@ -1681,10 +1579,10 @@ static int action_luksRemoveKey(void) goto out; tools_keyslot_msg(r, UNLOCKED); - opt_key_slot = r; - log_verbose(_("Keyslot %d is selected for deletion."), opt_key_slot); + ARG_SET_INT32(OPT_KEY_SLOT_ID, r); + log_verbose(_("Keyslot %d is selected for deletion."), ARG_INT32(OPT_KEY_SLOT_ID)); - if (crypt_keyslot_status(cd, opt_key_slot) == CRYPT_SLOT_ACTIVE_LAST && + if (crypt_keyslot_status(cd, ARG_INT32(OPT_KEY_SLOT_ID)) == CRYPT_SLOT_ACTIVE_LAST && !yesDialog(_("This is the last keyslot. " "Device will become unusable after purging this key."), _("Operation aborted, the keyslot was NOT wiped.\n"))) { @@ -1692,8 +1590,8 @@ static int action_luksRemoveKey(void) goto out; } - r = crypt_keyslot_destroy(cd, opt_key_slot); - tools_keyslot_msg(opt_key_slot, REMOVED); + r = crypt_keyslot_destroy(cd, ARG_INT32(OPT_KEY_SLOT_ID)); + tools_keyslot_msg(ARG_INT32(OPT_KEY_SLOT_ID), REMOVED); out: crypt_safe_free(password); crypt_free(cd); @@ -1704,7 +1602,7 @@ static int luksAddUnboundKey(void) { int r = -EINVAL, keysize = 0; char *key = NULL; - const char *opt_new_key_file = (action_argc > 1 ? action_argv[1] : NULL); + const char *new_key_file = (action_argc > 1 ? action_argv[1] : NULL); char *password_new = NULL; size_t password_new_size = 0; struct crypt_device *cd = NULL; @@ -1726,17 +1624,17 @@ static int luksAddUnboundKey(void) /* Never call pwquality if using null cipher */ if (tools_is_cipher_null(crypt_get_cipher(cd))) - opt_force_password = 1; + ARG_SET(OPT_FORCE_PASSWORD_ID) = true; - keysize = opt_key_size / 8; + keysize = ARG_UINT32(OPT_KEY_SIZE_ID) / 8; r = set_pbkdf_params(cd, crypt_get_type(cd)); if (r) { log_err(_("Failed to set pbkdf parameters.")); goto out; } - if (opt_master_key_file) { - r = tools_read_mk(opt_master_key_file, &key, keysize); + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + r = tools_read_mk(ARG_STR(OPT_MASTER_KEY_FILE_ID), &key, keysize); if (r < 0) goto out; @@ -1747,13 +1645,13 @@ static int luksAddUnboundKey(void) r = tools_get_key(_("Enter new passphrase for key slot: "), &password_new, &password_new_size, - opt_new_keyfile_offset, opt_new_keyfile_size, - opt_new_key_file, opt_timeout, + ARG_UINT64(OPT_NEW_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_NEW_KEYFILE_SIZE_ID), + new_key_file, ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(1), 1, cd); if (r < 0) goto out; - r = crypt_keyslot_add_by_key(cd, opt_key_slot, key, keysize, + r = crypt_keyslot_add_by_key(cd, ARG_INT32(OPT_KEY_SLOT_ID), key, keysize, password_new, password_new_size, CRYPT_VOLUME_KEY_NO_SEGMENT); tools_keyslot_msg(r, CREATED); out: @@ -1767,13 +1665,13 @@ static int action_luksAddKey(void) { int r = -EINVAL, keysize = 0; char *key = NULL; - const char *opt_new_key_file = (action_argc > 1 ? action_argv[1] : NULL); + const char *new_key_file = (action_argc > 1 ? action_argv[1] : NULL); char *password = NULL, *password_new = NULL; size_t password_size = 0, password_new_size = 0; struct crypt_device *cd = NULL; /* Unbound keyslot (no assigned data segment) is special case */ - if (opt_unbound) + if (ARG_SET(OPT_UNBOUND_ID)) return luksAddUnboundKey(); if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) @@ -1793,7 +1691,7 @@ static int action_luksAddKey(void) /* Never call pwquality if using null cipher */ if (tools_is_cipher_null(crypt_get_cipher(cd))) - opt_force_password = 1; + ARG_SET(OPT_FORCE_PASSWORD_ID) = true; keysize = crypt_get_volume_key_size(cd); r = set_pbkdf_params(cd, crypt_get_type(cd)); @@ -1802,15 +1700,15 @@ static int action_luksAddKey(void) goto out; } - if (opt_master_key_file) { - if (!keysize && !opt_key_size) { + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + if (!keysize && !ARG_SET(OPT_KEY_SIZE_ID)) { log_err(_("Cannot determine volume key size for LUKS without keyslots, please use --key-size option.")); r = -EINVAL; goto out; } else if (!keysize) - keysize = opt_key_size / 8; + keysize = ARG_UINT32(OPT_KEY_SIZE_ID) / 8; - r = tools_read_mk(opt_master_key_file, &key, keysize); + r = tools_read_mk(ARG_STR(OPT_MASTER_KEY_FILE_ID), &key, keysize); if (r < 0) goto out; @@ -1821,25 +1719,25 @@ static int action_luksAddKey(void) r = tools_get_key(_("Enter new passphrase for key slot: "), &password_new, &password_new_size, - opt_new_keyfile_offset, opt_new_keyfile_size, - opt_new_key_file, opt_timeout, + ARG_UINT64(OPT_NEW_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_NEW_KEYFILE_SIZE_ID), + new_key_file, ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(1), 1, cd); if (r < 0) goto out; - r = crypt_keyslot_add_by_volume_key(cd, opt_key_slot, key, keysize, + r = crypt_keyslot_add_by_volume_key(cd, ARG_INT32(OPT_KEY_SLOT_ID), key, keysize, password_new, password_new_size); - } else if (opt_key_file && !tools_is_stdin(opt_key_file) && - opt_new_key_file && !tools_is_stdin(opt_new_key_file)) { - r = crypt_keyslot_add_by_keyfile_device_offset(cd, opt_key_slot, - opt_key_file, opt_keyfile_size, opt_keyfile_offset, - opt_new_key_file, opt_new_keyfile_size, opt_new_keyfile_offset); + } else if (ARG_SET(OPT_KEY_FILE_ID) && !tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)) && + new_key_file && !tools_is_stdin(new_key_file)) { + r = crypt_keyslot_add_by_keyfile_device_offset(cd, ARG_INT32(OPT_KEY_SLOT_ID), + ARG_STR(OPT_KEY_FILE_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_UINT64(OPT_KEYFILE_OFFSET_ID), + new_key_file, ARG_UINT32(OPT_NEW_KEYFILE_SIZE_ID), ARG_UINT64(OPT_NEW_KEYFILE_OFFSET_ID)); tools_passphrase_msg(r); } else { r = tools_get_key(_("Enter any existing passphrase: "), &password, &password_size, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; @@ -1855,12 +1753,12 @@ static int action_luksAddKey(void) r = tools_get_key(_("Enter new passphrase for key slot: "), &password_new, &password_new_size, - opt_new_keyfile_offset, opt_new_keyfile_size, opt_new_key_file, - opt_timeout, _verify_passphrase(1), 1, cd); + ARG_UINT64(OPT_NEW_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_NEW_KEYFILE_SIZE_ID), new_key_file, + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(1), 1, cd); if (r < 0) goto out; - r = crypt_keyslot_add_by_passphrase(cd, opt_key_slot, + r = crypt_keyslot_add_by_passphrase(cd, ARG_INT32(OPT_KEY_SLOT_ID), password, password_size, password_new, password_new_size); } @@ -1875,7 +1773,7 @@ out: static int action_luksChangeKey(void) { - const char *opt_new_key_file = (action_argc > 1 ? action_argv[1] : NULL); + const char *new_key_file = (action_argc > 1 ? action_argv[1] : NULL); struct crypt_device *cd = NULL; char *password = NULL, *password_new = NULL; size_t password_size = 0, password_new_size = 0; @@ -1896,7 +1794,7 @@ static int action_luksChangeKey(void) /* Never call pwquality if using null cipher */ if (tools_is_cipher_null(crypt_get_cipher(cd))) - opt_force_password = 1; + ARG_SET(OPT_FORCE_PASSWORD_ID) = true; r = set_pbkdf_params(cd, crypt_get_type(cd)); if (r) { @@ -1906,13 +1804,13 @@ static int action_luksChangeKey(void) r = tools_get_key(_("Enter passphrase to be changed: "), &password, &password_size, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; /* Check password before asking for new one */ - r = crypt_activate_by_passphrase(cd, NULL, opt_key_slot, + r = crypt_activate_by_passphrase(cd, NULL, ARG_INT32(OPT_KEY_SLOT_ID), password, password_size, CRYPT_ACTIVATE_ALLOW_UNBOUND_KEY); tools_passphrase_msg(r); check_signal(&r); @@ -1922,13 +1820,13 @@ static int action_luksChangeKey(void) r = tools_get_key(_("Enter new passphrase: "), &password_new, &password_new_size, - opt_new_keyfile_offset, opt_new_keyfile_size, - opt_new_key_file, - opt_timeout, _verify_passphrase(1), 1, cd); + ARG_UINT64(OPT_NEW_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_NEW_KEYFILE_SIZE_ID), + new_key_file, + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(1), 1, cd); if (r < 0) goto out; - r = crypt_keyslot_change_by_passphrase(cd, opt_key_slot, opt_key_slot, + r = crypt_keyslot_change_by_passphrase(cd, ARG_INT32(OPT_KEY_SLOT_ID), ARG_INT32(OPT_KEY_SLOT_ID), password, password_size, password_new, password_new_size); tools_keyslot_msg(r, CREATED); out: @@ -1958,9 +1856,9 @@ static int action_luksConvertKey(void) if (r < 0) goto out; - if (crypt_keyslot_status(cd, opt_key_slot) == CRYPT_SLOT_INACTIVE) { + if (crypt_keyslot_status(cd, ARG_INT32(OPT_KEY_SLOT_ID)) == CRYPT_SLOT_INACTIVE) { r = -EINVAL; - log_err(_("Keyslot %d is not active."), opt_key_slot); + log_err(_("Keyslot %d is not active."), ARG_INT32(OPT_KEY_SLOT_ID)); goto out; } @@ -1972,12 +1870,12 @@ static int action_luksConvertKey(void) r = tools_get_key(_("Enter passphrase for keyslot to be converted: "), &password, &password_size, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; - r = crypt_keyslot_change_by_passphrase(cd, opt_key_slot, opt_key_slot, + r = crypt_keyslot_change_by_passphrase(cd, ARG_INT32(OPT_KEY_SLOT_ID), ARG_INT32(OPT_KEY_SLOT_ID), password, password_size, password, password_size); tools_passphrase_msg(r); tools_keyslot_msg(r, CREATED); @@ -2022,8 +1920,8 @@ static int action_luksUUID(void) if ((r = crypt_load(cd, luksType(device_type), NULL))) goto out; - if (opt_uuid) - r = crypt_set_uuid(cd, opt_uuid); + if (ARG_SET(OPT_UUID_ID)) + r = crypt_set_uuid(cd, ARG_STR(OPT_UUID_ID)); else { existing_uuid = crypt_get_uuid(cd); log_std("%s\n", existing_uuid ?: ""); @@ -2056,8 +1954,8 @@ static int luksDump_with_volume_key(struct crypt_device *cd) return -ENOMEM; r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, 0, 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), 0, 0, cd); if (r < 0) goto out; @@ -2069,8 +1967,8 @@ static int luksDump_with_volume_key(struct crypt_device *cd) goto out; tools_keyslot_msg(r, UNLOCKED); - if (opt_master_key_file) { - r = tools_write_mk(opt_master_key_file, vk, vk_size); + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + r = tools_write_mk(ARG_STR(OPT_MASTER_KEY_FILE_ID), vk, vk_size); if (r < 0) goto out; } @@ -2081,8 +1979,8 @@ static int luksDump_with_volume_key(struct crypt_device *cd) log_std("Payload offset:\t%d\n", (int)crypt_get_data_offset(cd)); log_std("UUID: \t%s\n", crypt_get_uuid(cd)); log_std("MK bits: \t%d\n", (int)vk_size * 8); - if (opt_master_key_file) { - log_std("Key stored to file %s.\n", opt_master_key_file); + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + log_std("Key stored to file %s.\n", ARG_STR(OPT_MASTER_KEY_FILE_ID)); goto out; } log_std("MK dump:\t"); @@ -2107,9 +2005,9 @@ static int luksDump_with_unbound_key(struct crypt_device *cd) size_t uk_size, passwordLen = 0; int i, r; - ki = crypt_keyslot_status(cd, opt_key_slot); + ki = crypt_keyslot_status(cd, ARG_INT32(OPT_KEY_SLOT_ID)); if (ki != CRYPT_SLOT_UNBOUND) { - log_err(_("Keyslot %d does not contain unbound key."), opt_key_slot); + log_err(_("Keyslot %d does not contain unbound key."), ARG_INT32(OPT_KEY_SLOT_ID)); return -EINVAL; } @@ -2120,7 +2018,7 @@ static int luksDump_with_unbound_key(struct crypt_device *cd) NULL)) return -EPERM; - r = crypt_keyslot_get_key_size(cd, opt_key_slot); + r = crypt_keyslot_get_key_size(cd, ARG_INT32(OPT_KEY_SLOT_ID)); if (r < 0) return -EINVAL; uk_size = r; @@ -2129,12 +2027,12 @@ static int luksDump_with_unbound_key(struct crypt_device *cd) return -ENOMEM; r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, 0, 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), 0, 0, cd); if (r < 0) goto out; - r = crypt_volume_key_get(cd, opt_key_slot, uk, &uk_size, + r = crypt_volume_key_get(cd, ARG_INT32(OPT_KEY_SLOT_ID), uk, &uk_size, password, passwordLen); tools_passphrase_msg(r); check_signal(&r); @@ -2142,18 +2040,18 @@ static int luksDump_with_unbound_key(struct crypt_device *cd) goto out; tools_keyslot_msg(r, UNLOCKED); - if (opt_master_key_file) { - r = tools_write_mk(opt_master_key_file, uk, uk_size); + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + r = tools_write_mk(ARG_STR(OPT_MASTER_KEY_FILE_ID), uk, uk_size); if (r < 0) goto out; } log_std("LUKS header information for %s\n", crypt_get_device_name(cd)); log_std("UUID: \t%s\n", crypt_get_uuid(cd)); - log_std("Keyslot: \t%d\n", opt_key_slot); + log_std("Keyslot: \t%d\n", ARG_INT32(OPT_KEY_SLOT_ID)); log_std("Key bits:\t%d\n", (int)uk_size * 8); - if (opt_master_key_file) { - log_std("Key stored to file %s.\n", opt_master_key_file); + if (ARG_SET(OPT_MASTER_KEY_FILE_ID)) { + log_std("Key stored to file %s.\n", ARG_STR(OPT_MASTER_KEY_FILE_ID)); goto out; } log_std("Unbound Key:\t"); @@ -2184,9 +2082,9 @@ static int action_luksDump(void) goto out; } - if (opt_dump_master_key) + if (ARG_SET(OPT_DUMP_MASTER_KEY_ID)) r = luksDump_with_volume_key(cd); - else if (opt_unbound) + else if (ARG_SET(OPT_UNBOUND_ID)) r = luksDump_with_unbound_key(cd); else r = crypt_dump(cd); @@ -2200,7 +2098,7 @@ static int action_luksSuspend(void) struct crypt_device *cd = NULL; int r; - r = crypt_init_by_name_and_header(&cd, action_argv[0], uuid_or_device(opt_header_device)); + r = crypt_init_by_name_and_header(&cd, action_argv[0], uuid_or_device(ARG_STR(OPT_HEADER_ID))); if (!r) r = crypt_suspend(cd, action_argv[0]); @@ -2215,17 +2113,17 @@ static int action_luksResume(void) size_t passwordLen; int r, tries; - if ((r = crypt_init_by_name_and_header(&cd, action_argv[0], uuid_or_device(opt_header_device)))) + if ((r = crypt_init_by_name_and_header(&cd, action_argv[0], uuid_or_device(ARG_STR(OPT_HEADER_ID))))) goto out; if ((r = crypt_load(cd, luksType(device_type), NULL))) goto out; - tries = (tools_is_stdin(opt_key_file) && isatty(STDIN_FILENO)) ? opt_tries : 1; + tries = (tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID)) && isatty(STDIN_FILENO)) ? ARG_UINT32(OPT_TRIES_ID) : 1; do { r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) goto out; @@ -2249,7 +2147,7 @@ static int action_luksBackup(void) struct crypt_device *cd = NULL; int r; - if (!opt_header_backup_file) { + if (!ARG_SET(OPT_HEADER_BACKUP_FILE_ID)) { log_err(_("Option --header-backup-file is required.")); return -EINVAL; } @@ -2259,7 +2157,7 @@ static int action_luksBackup(void) crypt_set_confirm_callback(cd, yesDialog, NULL); - r = crypt_header_backup(cd, NULL, opt_header_backup_file); + r = crypt_header_backup(cd, NULL, ARG_STR(OPT_HEADER_BACKUP_FILE_ID)); out: crypt_free(cd); return r; @@ -2270,7 +2168,7 @@ static int action_luksRestore(void) struct crypt_device *cd = NULL; int r = 0; - if (!opt_header_backup_file) { + if (!ARG_SET(OPT_HEADER_BACKUP_FILE_ID)) { log_err(_("Option --header-backup-file is required.")); return -EINVAL; } @@ -2279,7 +2177,7 @@ static int action_luksRestore(void) goto out; crypt_set_confirm_callback(cd, yesDialog, NULL); - r = crypt_header_restore(cd, NULL, opt_header_backup_file); + r = crypt_header_restore(cd, NULL, ARG_STR(OPT_HEADER_BACKUP_FILE_ID)); out: crypt_free(cd); return r; @@ -2295,7 +2193,7 @@ static const char *_get_device_type(void) else if (action_argc == 1) name = action_argv[0]; - if (crypt_init_by_name_and_header(&cd, name, opt_header_device)) + if (crypt_init_by_name_and_header(&cd, name, ARG_STR(OPT_HEADER_ID))) return NULL; type = crypt_get_type(cd); @@ -2323,7 +2221,7 @@ static const char *_get_device_type(void) static int action_open(void) { - if (opt_refresh && !device_type) + if (ARG_SET(OPT_REFRESH_ID) && !device_type) /* read device type from active mapping */ device_type = _get_device_type(); @@ -2333,23 +2231,23 @@ static int action_open(void) if (!strcmp(device_type, "luks") || !strcmp(device_type, "luks1") || !strcmp(device_type, "luks2")) { - if (action_argc < 2 && (!opt_test_passphrase && !opt_refresh)) + if (action_argc < 2 && (!ARG_SET(OPT_TEST_PASSPHRASE_ID) && !ARG_SET(OPT_REFRESH_ID))) goto args; return action_open_luks(); } else if (!strcmp(device_type, "plain")) { - if (action_argc < 2 && !opt_refresh) + if (action_argc < 2 && !ARG_SET(OPT_REFRESH_ID)) goto args; return action_open_plain(); } else if (!strcmp(device_type, "loopaes")) { - if (action_argc < 2 && !opt_refresh) + if (action_argc < 2 && !ARG_SET(OPT_REFRESH_ID)) goto args; return action_open_loopaes(); } else if (!strcmp(device_type, "tcrypt")) { - if (action_argc < 2 && !opt_test_passphrase) + if (action_argc < 2 && !ARG_SET(OPT_TEST_PASSPHRASE_ID)) goto args; return action_open_tcrypt(); } else if (!strcmp(device_type, "bitlk")) { - if (action_argc < 2 && !opt_test_passphrase) + if (action_argc < 2 && !ARG_SET(OPT_TEST_PASSPHRASE_ID)) goto args; return action_open_bitlk(); } @@ -2467,23 +2365,22 @@ static int _config_priority(struct crypt_device *cd) crypt_keyslot_info cs; crypt_keyslot_priority priority = CRYPT_SLOT_PRIORITY_INVALID; - if (!strcmp("normal", opt_priority)) + if (!strcmp("normal", ARG_STR(OPT_PRIORITY_ID))) priority = CRYPT_SLOT_PRIORITY_NORMAL; - else if (!strcmp("prefer", opt_priority)) + else if (!strcmp("prefer", ARG_STR(OPT_PRIORITY_ID))) priority = CRYPT_SLOT_PRIORITY_PREFER; - else if (!strcmp("ignore", opt_priority)) + else if (!strcmp("ignore", ARG_STR(OPT_PRIORITY_ID))) priority = CRYPT_SLOT_PRIORITY_IGNORE; - cs = crypt_keyslot_status(cd, opt_key_slot); + cs = crypt_keyslot_status(cd, ARG_INT32(OPT_KEY_SLOT_ID)); if (cs != CRYPT_SLOT_INVALID) - return crypt_keyslot_set_priority(cd, opt_key_slot, priority); - + return crypt_keyslot_set_priority(cd, ARG_INT32(OPT_KEY_SLOT_ID), priority); return -EINVAL; } static int _config_labels(struct crypt_device *cd) { - return crypt_set_label(cd, opt_label, opt_subsystem); + return crypt_set_label(cd, ARG_STR(OPT_LABEL_ID), ARG_STR(OPT_SUBSYSTEM_ID)); } static int action_luksConfig(void) @@ -2491,7 +2388,7 @@ static int action_luksConfig(void) struct crypt_device *cd = NULL; int r; - if (!opt_priority && !opt_label && !opt_subsystem) { + if (!ARG_SET(OPT_PRIORITY_ID) && !ARG_SET(OPT_LABEL_ID) && !ARG_SET(OPT_SUBSYSTEM_ID)) { log_err(_("Option --priority, --label or --subsystem is missing.")); return -EINVAL; } @@ -2505,10 +2402,10 @@ static int action_luksConfig(void) goto out; } - if (opt_priority && (r = _config_priority(cd))) + if (ARG_SET(OPT_PRIORITY_ID) && (r = _config_priority(cd))) goto out; - if ((opt_label || opt_subsystem) && (r = _config_labels(cd))) + if ((ARG_SET(OPT_LABEL_ID) || ARG_SET(OPT_SUBSYSTEM_ID)) && (r = _config_labels(cd))) goto out; out: crypt_free(cd); @@ -2520,32 +2417,32 @@ static int _token_add(struct crypt_device *cd) int r, token; crypt_token_info token_info; const struct crypt_token_params_luks2_keyring params = { - .key_description = opt_key_description + .key_description = ARG_STR(OPT_KEY_DESCRIPTION_ID) }; - if (opt_token != CRYPT_ANY_TOKEN) { - token_info = crypt_token_status(cd, opt_token, NULL); + if (ARG_INT32(OPT_TOKEN_ID_ID) != CRYPT_ANY_TOKEN) { + token_info = crypt_token_status(cd, ARG_INT32(OPT_TOKEN_ID_ID), NULL); if (token_info < CRYPT_TOKEN_INACTIVE) { - log_err(_("Token %d is invalid."), opt_token); + log_err(_("Token %d is invalid."), ARG_INT32(OPT_TOKEN_ID_ID)); return -EINVAL; } else if (token_info > CRYPT_TOKEN_INACTIVE) { - log_err(_("Token %d in use."), opt_token); + log_err(_("Token %d in use."), ARG_INT32(OPT_TOKEN_ID_ID)); return -EINVAL; } } - r = crypt_token_luks2_keyring_set(cd, opt_token, ¶ms); + r = crypt_token_luks2_keyring_set(cd, ARG_INT32(OPT_TOKEN_ID_ID), ¶ms); if (r < 0) { - log_err(_("Failed to add luks2-keyring token %d."), opt_token); + log_err(_("Failed to add luks2-keyring token %d."), ARG_INT32(OPT_TOKEN_ID_ID)); return r; } token = r; tools_token_msg(token, CREATED); - r = crypt_token_assign_keyslot(cd, token, opt_key_slot); + r = crypt_token_assign_keyslot(cd, token, ARG_INT32(OPT_KEY_SLOT_ID)); if (r < 0) { - log_err(_("Failed to assign token %d to keyslot %d."), token, opt_key_slot); + log_err(_("Failed to assign token %d to keyslot %d."), token, ARG_INT32(OPT_KEY_SLOT_ID)); (void) crypt_token_json_set(cd, token, NULL); } @@ -2557,16 +2454,16 @@ static int _token_remove(struct crypt_device *cd) crypt_token_info token_info; int r; - token_info = crypt_token_status(cd, opt_token, NULL); + token_info = crypt_token_status(cd, ARG_INT32(OPT_TOKEN_ID_ID), NULL); if (token_info < CRYPT_TOKEN_INACTIVE) { - log_err(_("Token %d is invalid."), opt_token); + log_err(_("Token %d is invalid."), ARG_INT32(OPT_TOKEN_ID_ID)); return -EINVAL; } else if (token_info == CRYPT_TOKEN_INACTIVE) { - log_err(_("Token %d is not in use."), opt_token); + log_err(_("Token %d is not in use."), ARG_INT32(OPT_TOKEN_ID_ID)); return -EINVAL; } - r = crypt_token_json_set(cd, opt_token, NULL); + r = crypt_token_json_set(cd, ARG_INT32(OPT_TOKEN_ID_ID), NULL); tools_token_msg(r, REMOVED); return r; @@ -2579,22 +2476,22 @@ static int _token_import(struct crypt_device *cd) crypt_token_info token_info; int r, token; - if (opt_token != CRYPT_ANY_TOKEN) { - token_info = crypt_token_status(cd, opt_token, NULL); + if (ARG_INT32(OPT_TOKEN_ID_ID) != CRYPT_ANY_TOKEN) { + token_info = crypt_token_status(cd, ARG_INT32(OPT_TOKEN_ID_ID), NULL); if (token_info < CRYPT_TOKEN_INACTIVE) { - log_err(_("Token %d is invalid."), opt_token); + log_err(_("Token %d is invalid."), ARG_INT32(OPT_TOKEN_ID_ID)); return -EINVAL; } else if (token_info > CRYPT_TOKEN_INACTIVE) { - log_err(_("Token %d in use."), opt_token); + log_err(_("Token %d in use."), ARG_INT32(OPT_TOKEN_ID_ID)); return -EINVAL; } } - r = tools_read_json_file(cd, opt_json_file, &json, &json_length); + r = tools_read_json_file(cd, ARG_STR(OPT_JSON_FILE_ID), &json, &json_length); if (r) return r; - r = crypt_token_json_set(cd, opt_token, json); + r = crypt_token_json_set(cd, ARG_INT32(OPT_TOKEN_ID_ID), json); free(json); if (r < 0) { log_err(_("Failed to import token from file.")); @@ -2604,10 +2501,10 @@ static int _token_import(struct crypt_device *cd) token = r; tools_token_msg(token, CREATED); - if (opt_key_slot != CRYPT_ANY_SLOT) { - r = crypt_token_assign_keyslot(cd, token, opt_key_slot); + if (ARG_INT32(OPT_KEY_SLOT_ID) != CRYPT_ANY_SLOT) { + r = crypt_token_assign_keyslot(cd, token, ARG_INT32(OPT_KEY_SLOT_ID)); if (r < 0) { - log_err(_("Failed to assign token %d to keyslot %d."), token, opt_key_slot); + log_err(_("Failed to assign token %d to keyslot %d."), token, ARG_INT32(OPT_KEY_SLOT_ID)); (void) crypt_token_json_set(cd, token, NULL); } } @@ -2620,13 +2517,13 @@ static int _token_export(struct crypt_device *cd) const char *json; int r; - r = crypt_token_json_get(cd, opt_token, &json); + r = crypt_token_json_get(cd, ARG_INT32(OPT_TOKEN_ID_ID), &json); if (r < 0) { - log_err(_("Failed to get token %d for export."), opt_token); + log_err(_("Failed to get token %d for export."), ARG_INT32(OPT_TOKEN_ID_ID)); return r; } - return tools_write_json_file(cd, opt_json_file, json); + return tools_write_json_file(cd, ARG_STR(OPT_JSON_FILE_ID), json); } static int action_token(void) @@ -2636,13 +2533,13 @@ static int action_token(void) enum { ADD = 0, REMOVE, IMPORT, EXPORT } action; if (!strcmp(action_argv[0], "add")) { - if (!opt_key_description) { + if (!ARG_SET(OPT_KEY_DESCRIPTION_ID)) { log_err(_("--key-description parameter is mandatory for token add action.")); return -EINVAL; } action = ADD; } else if (!strcmp(action_argv[0], "remove")) { - if (opt_token == CRYPT_ANY_TOKEN) { + if (ARG_INT32(OPT_TOKEN_ID_ID) == CRYPT_ANY_TOKEN) { log_err(_("Action requires specific token. Use --token-id parameter.")); return -EINVAL; } @@ -2650,7 +2547,7 @@ static int action_token(void) } else if (!strcmp(action_argv[0], "import")) { action = IMPORT; } else if (!strcmp(action_argv[0], "export")) { - if (opt_token == CRYPT_ANY_TOKEN) { + if (ARG_INT32(OPT_TOKEN_ID_ID)== CRYPT_ANY_TOKEN) { log_err(_("Action requires specific token. Use --token-id parameter.")); return -EINVAL; } @@ -2660,12 +2557,12 @@ static int action_token(void) return -EINVAL; } - if ((r = crypt_init(&cd, uuid_or_device(opt_header_device ?: action_argv[1])))) + if ((r = crypt_init(&cd, uuid_or_device(ARG_STR(OPT_HEADER_ID) ?: action_argv[1])))) return r; if ((r = crypt_load(cd, CRYPT_LUKS2, NULL))) { log_err(_("Device %s is not a valid LUKS device."), - uuid_or_device(opt_header_device ?: action_argv[1])); + uuid_or_device(ARG_STR(OPT_HEADER_ID) ?: action_argv[1])); crypt_free(cd); return r; } @@ -2710,7 +2607,7 @@ static int _get_device_active_name(struct crypt_device *cd, const char *data_dev log_err(_("Device %s is still in use."), data_device); return -EINVAL; } - if (!opt_batch_mode) + if (!ARG_SET(OPT_BATCH_MODE_ID)) log_std(_("Auto-detected active dm device '%s' for data device %s.\n"), buffer, data_device); } if (r < 0) { @@ -2739,20 +2636,20 @@ static int action_reencrypt_load(struct crypt_device *cd) char dm_name[PATH_MAX] = {}, *password = NULL; const char *active_name = NULL; struct crypt_params_reencrypt params = { - .resilience = opt_resilience_mode ?: "checksum", - .hash = opt_resilience_hash ?: "sha256", - .max_hotzone_size = opt_hotzone_size / SECTOR_SIZE, - .device_size = opt_device_size / SECTOR_SIZE, + .resilience = ARG_STR(OPT_RESILIENCE_ID) ?: "checksum", + .hash = ARG_STR(OPT_RESILIENCE_HASH_ID) ?: "sha256", + .max_hotzone_size = ARG_UINT64(OPT_HOTZONE_SIZE_ID) / SECTOR_SIZE, + .device_size = ARG_UINT64(OPT_DEVICE_SIZE_ID) / SECTOR_SIZE, .flags = CRYPT_REENCRYPT_RESUME_ONLY }; r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) return r; - if (!opt_active_name) { + if (!ARG_SET(OPT_ACTIVE_NAME_ID)) { r = _get_device_active_name(cd, action_argv[0], dm_name, sizeof(dm_name)); if (r > 0) active_name = dm_name; @@ -2761,9 +2658,9 @@ static int action_reencrypt_load(struct crypt_device *cd) return -EINVAL; } } else - active_name = opt_active_name; + active_name = ARG_STR(OPT_ACTIVE_NAME_ID); - r = crypt_reencrypt_init_by_passphrase(cd, active_name, password, passwordLen, opt_key_slot, opt_key_slot, NULL, NULL, ¶ms); + r = crypt_reencrypt_init_by_passphrase(cd, active_name, password, passwordLen, ARG_INT32(OPT_KEY_SLOT_ID), ARG_INT32(OPT_KEY_SLOT_ID), NULL, NULL, ¶ms); crypt_safe_free(password); @@ -2772,6 +2669,7 @@ static int action_reencrypt_load(struct crypt_device *cd) static int action_encrypt_luks2(struct crypt_device **cd) { + char *tmp; const char *type, *activated_name = NULL; int keyslot, r, fd; uuid_t uuid; @@ -2779,15 +2677,15 @@ static int action_encrypt_luks2(struct crypt_device **cd) char *msg, uuid_str[37], header_file[PATH_MAX] = { 0 }, *password = NULL; uint32_t activate_flags = 0; const struct crypt_params_luks2 luks2_params = { - .sector_size = opt_sector_size ?: SECTOR_SIZE + .sector_size = ARG_UINT32(OPT_SECTOR_SIZE_ID) ?: SECTOR_SIZE }; struct crypt_params_reencrypt params = { .mode = CRYPT_REENCRYPT_ENCRYPT, - .direction = opt_data_shift < 0 ? CRYPT_REENCRYPT_BACKWARD : CRYPT_REENCRYPT_FORWARD, - .resilience = opt_resilience_mode ?: "checksum", - .hash = opt_resilience_hash ?: "sha256", - .max_hotzone_size = opt_hotzone_size / SECTOR_SIZE, - .device_size = opt_device_size / SECTOR_SIZE, + .direction = data_shift < 0 ? CRYPT_REENCRYPT_BACKWARD : CRYPT_REENCRYPT_FORWARD, + .resilience = ARG_STR(OPT_RESILIENCE_ID) ?: "checksum", + .hash = ARG_STR(OPT_RESILIENCE_HASH_ID) ?: "sha256", + .max_hotzone_size = ARG_UINT64(OPT_HOTZONE_SIZE_ID) / SECTOR_SIZE, + .device_size = ARG_UINT64(OPT_DEVICE_SIZE_ID) / SECTOR_SIZE, .luks2 = &luks2_params, .flags = CRYPT_REENCRYPT_INITIALIZE_ONLY }; @@ -2803,22 +2701,22 @@ static int action_encrypt_luks2(struct crypt_device **cd) return -EINVAL; } - if (!opt_data_shift && !opt_header_device) { + if (!data_shift && !ARG_SET(OPT_HEADER_ID)) { log_err(_("Encryption without detached header (--header) is not possible without data device size reduction (--reduce-device-size).")); return -ENOTSUP; } - if (!opt_header_device && opt_offset && opt_data_shift && (opt_offset > (imaxabs(opt_data_shift) / (2 * SECTOR_SIZE)))) { + if (!ARG_SET(OPT_HEADER_ID) && ARG_UINT64(OPT_OFFSET_ID) && data_shift && (ARG_UINT64(OPT_OFFSET_ID) > (imaxabs(data_shift) / (2 * SECTOR_SIZE)))) { log_err(_("Requested data offset must be less than or equal to half of --reduce-device-size parameter.")); return -EINVAL; } /* TODO: ask user to confirm. It's useless to do data device reduction and than use smaller value */ - if (!opt_header_device && opt_offset && opt_data_shift && (opt_offset < (imaxabs(opt_data_shift) / (2 * SECTOR_SIZE)))) { - opt_data_shift = -(opt_offset * 2 * SECTOR_SIZE); - if (opt_data_shift >= 0) + if (!ARG_SET(OPT_HEADER_ID) && ARG_UINT64(OPT_OFFSET_ID) && data_shift && (ARG_UINT64(OPT_OFFSET_ID) < (imaxabs(data_shift) / (2 * SECTOR_SIZE)))) { + data_shift = -(ARG_UINT64(OPT_OFFSET_ID) * 2 * SECTOR_SIZE); + if (data_shift >= 0) return -EINVAL; - log_std(_("Adjusting --reduce-device-size value to twice the --offset %" PRIu64 " (sectors).\n"), opt_offset * 2); + log_std(_("Adjusting --reduce-device-size value to twice the --offset %" PRIu64 " (sectors).\n"), ARG_UINT64(OPT_OFFSET_ID) * 2); } if (strncmp(type, CRYPT_LUKS2, strlen(CRYPT_LUKS2))) { @@ -2826,16 +2724,17 @@ static int action_encrypt_luks2(struct crypt_device **cd) return -EINVAL; } - if (opt_uuid && uuid_parse(opt_uuid, uuid) == -1) { + if (ARG_SET(OPT_UUID_ID) && uuid_parse(ARG_STR(OPT_UUID_ID), uuid) == -1) { log_err(_("Wrong LUKS UUID format provided.")); return -EINVAL; } - if (!opt_uuid) { + if (!ARG_SET(OPT_UUID_ID)) { uuid_generate(uuid); uuid_unparse(uuid, uuid_str); - if (!(opt_uuid = strdup(uuid_str))) + if (!(tmp = strdup(uuid_str))) return -ENOMEM; + ARG_SET_STR(OPT_UUID_ID, tmp); } /* Check the data device is not LUKS device already */ @@ -2855,8 +2754,8 @@ static int action_encrypt_luks2(struct crypt_device **cd) return r; } - if (!opt_header_device) { - snprintf(header_file, sizeof(header_file), "LUKS2-temp-%s.new", opt_uuid); + if (!ARG_SET(OPT_HEADER_ID)) { + snprintf(header_file, sizeof(header_file), "LUKS2-temp-%s.new", ARG_STR(OPT_UUID_ID)); fd = open(header_file, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR); if (fd == -1) { if (errno == EEXIST) @@ -2874,25 +2773,26 @@ static int action_encrypt_luks2(struct crypt_device **cd) goto err; } - if (!(opt_header_device = strdup(header_file))) { + if (!(tmp = strdup(header_file))) { r = -ENOMEM; goto err; } + ARG_SET_STR(OPT_HEADER_ID, tmp); + /* * FIXME: just override offset here, but we should support both. * offset and implicit offset via data shift (lvprepend?) */ - if (!opt_offset) - opt_offset = imaxabs(opt_data_shift) / (2 * SECTOR_SIZE); - opt_data_shift >>= 1; + if (!ARG_UINT64(OPT_OFFSET_ID)) + ARG_SET_UINT64(OPT_OFFSET_ID, imaxabs(data_shift) / (2 * SECTOR_SIZE)); + data_shift >>= 1; params.flags |= CRYPT_REENCRYPT_MOVE_FIRST_SEGMENT; - } else if (opt_data_shift < 0) { - if (!opt_luks2_metadata_size) - opt_luks2_metadata_size = 0x4000; /* missing default here */ - if (!opt_luks2_keyslots_size) - opt_luks2_keyslots_size = -opt_data_shift - 2 * opt_luks2_metadata_size; - - if (2 * opt_luks2_metadata_size + opt_luks2_keyslots_size > (uint64_t)-opt_data_shift) { + } else if (data_shift < 0) { + if (!ARG_SET(OPT_LUKS2_METADATA_SIZE_ID)) + ARG_SET_UINT64(OPT_LUKS2_METADATA_SIZE_ID, 0x4000); /* missing default here */ + if (!ARG_SET(OPT_LUKS2_KEYSLOTS_SIZE_ID)) + ARG_SET_UINT64(OPT_LUKS2_KEYSLOTS_SIZE_ID, -data_shift - 2 * ARG_UINT64(OPT_LUKS2_METADATA_SIZE_ID)); + if (2 * ARG_UINT64(OPT_LUKS2_METADATA_SIZE_ID) + ARG_UINT64(OPT_LUKS2_KEYSLOTS_SIZE_ID) > (uint64_t)-data_shift) { log_err("LUKS2 metadata size is larger than data shift value."); return -EINVAL; } @@ -2902,11 +2802,11 @@ static int action_encrypt_luks2(struct crypt_device **cd) if (r < 0) goto err; - if (opt_data_shift) { - params.data_shift = imaxabs(opt_data_shift) / SECTOR_SIZE, + if (data_shift) { + params.data_shift = imaxabs(data_shift) / SECTOR_SIZE, params.resilience = "datashift"; } - keyslot = opt_key_slot < 0 ? 0 : opt_key_slot; + keyslot = !ARG_SET(OPT_KEY_SLOT_ID) ? 0 : ARG_INT32(OPT_KEY_SLOT_ID); r = crypt_reencrypt_init_by_passphrase(*cd, NULL, password, passwordLen, CRYPT_ANY_SLOT, keyslot, crypt_get_cipher(*cd), crypt_get_cipher_mode(*cd), ¶ms); @@ -2934,7 +2834,7 @@ static int action_encrypt_luks2(struct crypt_device **cd) if (action_argc > 1) { activated_name = action_argv[1]; _set_activation_flags(&activate_flags); - r = crypt_activate_by_passphrase(*cd, activated_name, opt_key_slot, password, passwordLen, activate_flags); + r = crypt_activate_by_passphrase(*cd, activated_name, ARG_INT32(OPT_KEY_SLOT_ID), password, passwordLen, activate_flags); if (r >= 0) log_std(_("%s/%s is now active and ready for online encryption.\n"), crypt_get_dir(), activated_name); } @@ -2943,7 +2843,7 @@ static int action_encrypt_luks2(struct crypt_device **cd) goto err; /* just load reencryption context to continue reencryption */ - if (!opt_reencrypt_init_only) { + if (!ARG_SET(OPT_INIT_ONLY_ID)) { params.flags &= ~CRYPT_REENCRYPT_INITIALIZE_ONLY; r = crypt_reencrypt_init_by_passphrase(*cd, activated_name, password, passwordLen, CRYPT_ANY_SLOT, keyslot, NULL, NULL, ¶ms); @@ -2962,37 +2862,37 @@ static int action_decrypt_luks2(struct crypt_device *cd) const char *active_name = NULL; struct crypt_params_reencrypt params = { .mode = CRYPT_REENCRYPT_DECRYPT, - .direction = opt_data_shift > 0 ? CRYPT_REENCRYPT_FORWARD : CRYPT_REENCRYPT_BACKWARD, - .resilience = opt_data_shift ? "datashift" : (opt_resilience_mode ?: "checksum"), - .hash = opt_resilience_hash ?: "sha256", - .data_shift = imaxabs(opt_data_shift) / SECTOR_SIZE, - .device_size = opt_device_size / SECTOR_SIZE, - .max_hotzone_size = opt_hotzone_size / SECTOR_SIZE, + .direction = data_shift > 0 ? CRYPT_REENCRYPT_FORWARD : CRYPT_REENCRYPT_BACKWARD, + .resilience = data_shift ? "datashift" : (ARG_STR(OPT_RESILIENCE_ID) ?: "checksum"), + .hash = ARG_STR(OPT_RESILIENCE_HASH_ID) ?: "sha256", + .data_shift = imaxabs(data_shift) / SECTOR_SIZE, + .device_size = ARG_UINT64(OPT_DEVICE_SIZE_ID) / SECTOR_SIZE, + .max_hotzone_size = ARG_UINT64(OPT_HOTZONE_SIZE_ID) / SECTOR_SIZE, }; size_t passwordLen; _set_reencryption_flags(¶ms.flags); r = tools_get_key(NULL, &password, &passwordLen, - opt_keyfile_offset, opt_keyfile_size, opt_key_file, - opt_timeout, _verify_passphrase(0), 0, cd); + ARG_UINT64(OPT_KEYFILE_OFFSET_ID), ARG_UINT32(OPT_KEYFILE_SIZE_ID), ARG_STR(OPT_KEY_FILE_ID), + ARG_UINT32(OPT_TIMEOUT_ID), _verify_passphrase(0), 0, cd); if (r < 0) return r; - if (!opt_active_name) { + if (!ARG_SET(OPT_ACTIVE_NAME_ID)) { r = _get_device_active_name(cd, action_argv[0], dm_name, sizeof(dm_name)); if (r > 0) active_name = dm_name; if (r < 0) goto err; } else - active_name = opt_active_name; + active_name = ARG_STR(OPT_ACTIVE_NAME_ID); if (!active_name) log_dbg("Device %s seems unused. Proceeding with offline operation.", action_argv[0]); r = crypt_reencrypt_init_by_passphrase(cd, active_name, password, - passwordLen, opt_key_slot, CRYPT_ANY_SLOT, NULL, NULL, ¶ms); + passwordLen, ARG_INT32(OPT_KEY_SLOT_ID), CRYPT_ANY_SLOT, NULL, NULL, ¶ms); err: crypt_safe_free(password); return r; @@ -3032,10 +2932,10 @@ static int init_passphrase(struct keyslot_passwords *kp, size_t keyslot_password return -ENOENT; } - retry_count = (opt_tries && !opt_key_file) ? opt_tries : 1; + retry_count = (ARG_UINT32(OPT_TRIES_ID) && !ARG_SET(OPT_KEY_FILE_ID)) ? ARG_UINT32(OPT_TRIES_ID) : 1; while (retry_count--) { r = tools_get_key(msg, &password, &passwordLen, 0, 0, - opt_key_file, 0, 0, 0 /*pwquality*/, cd); + ARG_STR(OPT_KEY_FILE_ID), 0, 0, 0 /*pwquality*/, cd); if (r < 0) return r; if (quit) { @@ -3104,7 +3004,7 @@ static int _check_luks2_keyslots(struct crypt_device *cd) return -EINVAL; } - if ((opt_key_slot == CRYPT_ANY_SLOT) && + if ((ARG_INT32(OPT_KEY_SLOT_ID) == CRYPT_ANY_SLOT) && (2 * active + unbound > max - 1)) { log_err(_("Not enough free keyslots for reencryption.")); return -EINVAL; @@ -3120,7 +3020,7 @@ static int fill_keyslot_passwords(struct crypt_device *cd, crypt_keyslot_info ki; int i, r = 0; - if (opt_key_slot == CRYPT_ANY_SLOT && opt_key_file) { + if (ARG_INT32(OPT_KEY_SLOT_ID) == CRYPT_ANY_SLOT && ARG_SET(OPT_KEY_FILE_ID)) { for (i = 0; (size_t)i < kp_size; i++) { ki = crypt_keyslot_status(cd, i); if (ki == CRYPT_SLOT_INVALID) @@ -3133,7 +3033,7 @@ static int fill_keyslot_passwords(struct crypt_device *cd, } } - if (opt_key_slot == CRYPT_ANY_SLOT) { + if (ARG_INT32(OPT_KEY_SLOT_ID) == CRYPT_ANY_SLOT) { for (i = 0; (size_t)i < kp_size; i++) { snprintf(msg, sizeof(msg), _("Enter passphrase for key slot %d: "), i); r = init_passphrase(kp, kp_size, cd, msg, i); @@ -3143,8 +3043,8 @@ static int fill_keyslot_passwords(struct crypt_device *cd, break; } } else { - snprintf(msg, sizeof(msg), _("Enter passphrase for key slot %u: "), opt_key_slot); - r = init_passphrase(kp, kp_size, cd, msg, opt_key_slot); + snprintf(msg, sizeof(msg), _("Enter passphrase for key slot %u: "), ARG_INT32(OPT_KEY_SLOT_ID)); + r = init_passphrase(kp, kp_size, cd, msg, ARG_INT32(OPT_KEY_SLOT_ID)); } return r < 0 ? r : 0; @@ -3175,36 +3075,36 @@ static int action_reencrypt_luks2(struct crypt_device *cd) struct crypt_params_luks2 luks2_params = {}; struct crypt_params_reencrypt params = { .mode = CRYPT_REENCRYPT_REENCRYPT, - .direction = opt_data_shift < 0 ? CRYPT_REENCRYPT_BACKWARD : CRYPT_REENCRYPT_FORWARD, - .resilience = opt_data_shift ? "datashift" : (opt_resilience_mode ?: "checksum"), - .hash = opt_resilience_hash ?: "sha256", - .data_shift = imaxabs(opt_data_shift) / SECTOR_SIZE, - .max_hotzone_size = opt_hotzone_size / SECTOR_SIZE, - .device_size = opt_device_size / SECTOR_SIZE, + .direction = data_shift < 0 ? CRYPT_REENCRYPT_BACKWARD : CRYPT_REENCRYPT_FORWARD, + .resilience = data_shift ? "datashift" : (ARG_STR(OPT_RESILIENCE_ID) ?: "checksum"), + .hash = ARG_STR(OPT_RESILIENCE_HASH_ID) ?: "sha256", + .data_shift = imaxabs(data_shift) / SECTOR_SIZE, + .max_hotzone_size = ARG_UINT64(OPT_HOTZONE_SIZE_ID) / SECTOR_SIZE, + .device_size = ARG_UINT64(OPT_DEVICE_SIZE_ID) / SECTOR_SIZE, .luks2 = &luks2_params, }; _set_reencryption_flags(¶ms.flags); - if (!opt_cipher) { + if (!ARG_SET(OPT_CIPHER_ID)) { strncpy(cipher, crypt_get_cipher(cd), MAX_CIPHER_LEN - 1); strncpy(mode, crypt_get_cipher_mode(cd), MAX_CIPHER_LEN - 1); cipher[MAX_CIPHER_LEN-1] = '\0'; mode[MAX_CIPHER_LEN-1] = '\0'; - } else if ((r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, mode))) { + } else if ((r = crypt_parse_name_and_mode(ARG_STR(OPT_CIPHER_ID), cipher, NULL, mode))) { log_err(_("No known cipher specification pattern detected.")); return r; } - luks2_params.sector_size = opt_sector_size ?: crypt_get_sector_size(cd); + luks2_params.sector_size = ARG_UINT32(OPT_SECTOR_SIZE_ID) ?: (uint32_t)crypt_get_sector_size(cd); r = _check_luks2_keyslots(cd); if (r) return r; - if (opt_key_size) - key_size = opt_key_size / 8; - else if (opt_cipher) + if (ARG_SET(OPT_KEY_SIZE_ID)) + key_size = ARG_UINT32(OPT_KEY_SIZE_ID) / 8; + else if (ARG_SET(OPT_CIPHER_ID)) key_size = DEFAULT_LUKS1_KEYBITS / 8; else key_size = crypt_get_volume_key_size(cd); @@ -3275,16 +3175,16 @@ static int action_reencrypt_luks2(struct crypt_device *cd) if (r < 0) goto err; - if (!opt_active_name && !opt_reencrypt_init_only) { + if (!ARG_SET(OPT_ACTIVE_NAME_ID) && !ARG_SET(OPT_INIT_ONLY_ID)) { r = _get_device_active_name(cd, action_argv[0], dm_name, sizeof(dm_name)); if (r > 0) active_name = dm_name; if (r < 0) goto err; - } else if (opt_active_name) - active_name = opt_active_name; + } else if (ARG_SET(OPT_ACTIVE_NAME_ID)) + active_name = ARG_STR(OPT_ACTIVE_NAME_ID); - if (!active_name && !opt_reencrypt_init_only) + if (!active_name && !ARG_SET(OPT_INIT_ONLY_ID)) log_dbg("Device %s seems unused. Proceeding with offline operation.", action_argv[0]); r = crypt_reencrypt_init_by_passphrase(cd, active_name, kp[keyslot_old].password, @@ -3309,26 +3209,26 @@ static int action_reencrypt(void) struct crypt_params_integrity ip = { 0 }; int r = 0; - if (action_argc < 1 && (!opt_active_name || opt_encrypt)) { + if (action_argc < 1 && (!ARG_SET(OPT_ACTIVE_NAME_ID) || ARG_SET(OPT_ENCRYPT_ID))) { log_err(_("Command requires device as argument.")); return -EINVAL; } - if (!opt_encrypt || opt_reencrypt_resume_only) { - if (opt_active_name) { - r = crypt_init_by_name_and_header(&cd, opt_active_name, opt_header_device); + if (!ARG_SET(OPT_ENCRYPT_ID) || ARG_SET(OPT_RESUME_ONLY_ID)) { + if (ARG_SET(OPT_ACTIVE_NAME_ID)) { + r = crypt_init_by_name_and_header(&cd, ARG_STR(OPT_ACTIVE_NAME_ID), ARG_STR(OPT_HEADER_ID)); if (r || !crypt_get_type(cd) || strcmp(crypt_get_type(cd), CRYPT_LUKS2)) { - log_err(_("Device %s is not a valid LUKS device."), opt_active_name); + log_err(_("Device %s is not a valid LUKS device."), ARG_STR(OPT_ACTIVE_NAME_ID)); r = -EINVAL; goto out; } } else { - if ((r = crypt_init_data_device(&cd, uuid_or_device(opt_header_device ?: action_argv[0]), action_argv[0]))) + if ((r = crypt_init_data_device(&cd, uuid_or_device(ARG_STR(OPT_HEADER_ID) ?: action_argv[0]), action_argv[0]))) return r; if ((r = crypt_load(cd, CRYPT_LUKS, NULL))) { log_err(_("Device %s is not a valid LUKS device."), - uuid_or_device(opt_header_device ?: action_argv[0])); + uuid_or_device(ARG_STR(OPT_HEADER_ID) ?: action_argv[0])); goto out; } if (strcmp(crypt_get_type(cd), CRYPT_LUKS2)) { @@ -3361,21 +3261,21 @@ static int action_reencrypt(void) } if (r == -EBUSY) { - if (opt_reencrypt_init_only) + if (ARG_SET(OPT_INIT_ONLY_ID)) log_err(_("LUKS2 reencryption already initialized. Aborting operation.")); else r = action_reencrypt_load(cd); - } else if (!r && opt_reencrypt_resume_only) { + } else if (!r && ARG_SET(OPT_RESUME_ONLY_ID)) { log_err(_("LUKS2 device is not in reencryption.")); r = -EINVAL; - } else if (opt_decrypt) + } else if (ARG_SET(OPT_DECRYPT_ID)) r = action_decrypt_luks2(cd); - else if (opt_encrypt && !opt_reencrypt_resume_only) + else if (ARG_SET(OPT_ENCRYPT_ID) && !ARG_SET(OPT_RESUME_ONLY_ID)) r = action_encrypt_luks2(&cd); else r = action_reencrypt_luks2(cd); - if (r >= 0 && !opt_reencrypt_init_only) { + if (r >= 0 && !ARG_SET(OPT_INIT_ONLY_ID)) { set_int_handler(0); r = crypt_reencrypt(cd, tools_reencrypt_progress, NULL); } @@ -3393,32 +3293,32 @@ static struct action_type { const char *arg_desc; const char *desc; } action_types[] = { - { "open", action_open, 1, 1, N_(" [--type ] []"),N_("open device as ") }, - { "close", action_close, 1, 1, N_(""), N_("close device (remove mapping)") }, - { "resize", action_resize, 1, 1, N_(""), N_("resize active device") }, - { "status", action_status, 1, 0, N_(""), N_("show device status") }, - { "benchmark", action_benchmark, 0, 0, N_("[--cipher ]"), N_("benchmark cipher") }, - { "repair", action_luksRepair, 1, 1, N_(""), N_("try to repair on-disk metadata") }, - { "reencrypt", action_reencrypt, 0, 0, N_(""), N_("reencrypt LUKS2 device") }, - { "erase", action_luksErase , 1, 1, N_(""), N_("erase all keyslots (remove encryption key)") }, - { "convert", action_luksConvert, 1, 1, N_(""), N_("convert LUKS from/to LUKS2 format") }, - { "config", action_luksConfig, 1, 1, N_(""), N_("set permanent configuration options for LUKS2") }, - { "luksFormat", action_luksFormat, 1, 1, N_(" []"), N_("formats a LUKS device") }, - { "luksAddKey", action_luksAddKey, 1, 1, N_(" []"), N_("add key to LUKS device") }, - { "luksRemoveKey",action_luksRemoveKey,1, 1, N_(" []"), N_("removes supplied key or key file from LUKS device") }, - { "luksChangeKey",action_luksChangeKey,1, 1, N_(" []"), N_("changes supplied key or key file of LUKS device") }, - { "luksConvertKey",action_luksConvertKey,1, 1, N_(" []"), N_("converts a key to new pbkdf parameters") }, - { "luksKillSlot", action_luksKillSlot, 2, 1, N_(" "), N_("wipes key with number from LUKS device") }, - { "luksUUID", action_luksUUID, 1, 0, N_(""), N_("print UUID of LUKS device") }, - { "isLuks", action_isLuks, 1, 0, N_(""), N_("tests for LUKS partition header") }, - { "luksDump", action_luksDump, 1, 1, N_(""), N_("dump LUKS partition information") }, - { "tcryptDump", action_tcryptDump, 1, 1, N_(""), N_("dump TCRYPT device information") }, - { "bitlkDump", action_bitlkDump, 1, 1, N_(""), N_("dump BITLK device information") }, - { "luksSuspend", action_luksSuspend, 1, 1, N_(""), N_("Suspend LUKS device and wipe key (all IOs are frozen)") }, - { "luksResume", action_luksResume, 1, 1, N_(""), N_("Resume suspended LUKS device") }, - { "luksHeaderBackup", action_luksBackup,1,1, N_(""), N_("Backup LUKS device header and keyslots") }, - { "luksHeaderRestore",action_luksRestore,1,1,N_(""), N_("Restore LUKS device header and keyslots") }, - { "token", action_token, 2, 0, N_(" "), N_("Manipulate LUKS2 tokens") }, + { OPEN_ACTION, action_open, 1, 1, N_(" [--type ] []"),N_("open device as ") }, + { CLOSE_ACTION, action_close, 1, 1, N_(""), N_("close device (remove mapping)") }, + { RESIZE_ACTION, action_resize, 1, 1, N_(""), N_("resize active device") }, + { STATUS_ACTION, action_status, 1, 0, N_(""), N_("show device status") }, + { BENCHMARK_ACTION, action_benchmark, 0, 0, N_("[--cipher ]"), N_("benchmark cipher") }, + { REPAIR_ACTION, action_luksRepair, 1, 1, N_(""), N_("try to repair on-disk metadata") }, + { REENCRYPT_ACTION, action_reencrypt, 0, 0, N_(""), N_("reencrypt LUKS2 device") }, + { ERASE_ACTION, action_luksErase, 1, 1, N_(""), N_("erase all keyslots (remove encryption key)") }, + { CONVERT_ACTION, action_luksConvert, 1, 1, N_(""), N_("convert LUKS from/to LUKS2 format") }, + { CONFIG_ACTION, action_luksConfig, 1, 1, N_(""), N_("set permanent configuration options for LUKS2") }, + { FORMAT_ACTION, action_luksFormat, 1, 1, N_(" []"), N_("formats a LUKS device") }, + { ADDKEY_ACTION, action_luksAddKey, 1, 1, N_(" []"), N_("add key to LUKS device") }, + { REMOVEKEY_ACTION, action_luksRemoveKey, 1, 1, N_(" []"), N_("removes supplied key or key file from LUKS device") }, + { CHANGEKEY_ACTION, action_luksChangeKey, 1, 1, N_(" []"), N_("changes supplied key or key file of LUKS device") }, + { CONVERTKEY_ACTION, action_luksConvertKey, 1, 1, N_(" []"), N_("converts a key to new pbkdf parameters") }, + { KILLKEY_ACTION, action_luksKillSlot, 2, 1, N_(" "), N_("wipes key with number from LUKS device") }, + { UUID_ACTION, action_luksUUID, 1, 0, N_(""), N_("print UUID of LUKS device") }, + { ISLUKS_ACTION, action_isLuks, 1, 0, N_(""), N_("tests for LUKS partition header") }, + { LUKSDUMP_ACTION, action_luksDump, 1, 1, N_(""), N_("dump LUKS partition information") }, + { TCRYPTDUMP_ACTION, action_tcryptDump, 1, 1, N_(""), N_("dump TCRYPT device information") }, + { BITLKDUMP_ACTION, action_bitlkDump, 1, 1, N_(""), N_("dump BITLK device information") }, + { SUSPEND_ACTION, action_luksSuspend, 1, 1, N_(""), N_("Suspend LUKS device and wipe key (all IOs are frozen)") }, + { RESUME_ACTION, action_luksResume, 1, 1, N_(""), N_("Resume suspended LUKS device") }, + { HEADERBACKUP_ACTION, action_luksBackup, 1, 1, N_(""), N_("Backup LUKS device header and keyslots") }, + { HEADERRESTORE_ACTION, action_luksRestore, 1, 1, N_(""), N_("Restore LUKS device header and keyslots") }, + { TOKEN_ACTION, action_token, 2, 0, N_(" "), N_("Manipulate LUKS2 tokens") }, {} }; @@ -3524,6 +3424,97 @@ static int run_action(struct action_type *action) return translate_errno(r); } +static bool needs_size_conversion(unsigned arg_id) +{ + return (arg_id == OPT_DEVICE_SIZE_ID || arg_id == OPT_HOTZONE_SIZE_ID || + arg_id == OPT_LUKS2_KEYSLOTS_SIZE_ID || arg_id == OPT_LUKS2_METADATA_SIZE_ID || + arg_id == OPT_REDUCE_DEVICE_SIZE_ID); +} + +static void check_key_slot_value(poptContext popt_context) +{ + if (ARG_INT32(OPT_KEY_SLOT_ID) < 0) + usage(popt_context, EXIT_FAILURE, _("Key slot is invalid."), + poptGetInvocationName(popt_context)); +} + +static void basic_options_cb(poptContext popt_context, + enum poptCallbackReason reason __attribute__((unused)), + struct poptOption *key, + const char *arg, + void *data __attribute__((unused))) +{ + tools_parse_arg_value(popt_context, tool_core_args[key->val].type, tool_core_args + key->val, arg, key->val, needs_size_conversion); + + /* special cases additional handling */ + switch (key->val) { + case OPT_DEVICE_SIZE_ID: + if (ARG_UINT64(OPT_DEVICE_SIZE_ID) == 0) + usage(popt_context, EXIT_FAILURE, poptStrerror(POPT_ERROR_BADNUMBER), + poptGetInvocationName(popt_context)); + if (ARG_UINT64(OPT_DEVICE_SIZE_ID) % SECTOR_SIZE) + usage(popt_context, EXIT_FAILURE, _("Device size must be multiple of 512 bytes sector."), + poptGetInvocationName(popt_context)); + break; + case OPT_HOTZONE_SIZE_ID: + if (ARG_UINT64(OPT_HOTZONE_SIZE_ID) == 0) + usage(popt_context, EXIT_FAILURE, _("Invalid max reencryption hotzone size specification."), + poptGetInvocationName(popt_context)); + break; + case OPT_KEY_FILE_ID: + if (tools_is_stdin(ARG_STR(OPT_KEY_FILE_ID))) { + free(keyfile_stdin); + keyfile_stdin = strdup(ARG_STR(OPT_KEY_FILE_ID)); + } else if (keyfiles_count < MAX_KEYFILES) + keyfiles[keyfiles_count++] = strdup(ARG_STR(OPT_KEY_FILE_ID)); + total_keyfiles++; + break; + case OPT_KEY_SIZE_ID: + if (ARG_UINT32(OPT_KEY_SIZE_ID) % 8) + usage(popt_context, EXIT_FAILURE, + _("Key size must be a multiple of 8 bits"), + poptGetInvocationName(popt_context)); + break; + case OPT_KEY_SLOT_ID: + check_key_slot_value(popt_context); + break; + case OPT_KEYSLOT_KEY_SIZE_ID: + if (ARG_UINT32(OPT_KEYSLOT_KEY_SIZE_ID) == 0) + usage(popt_context, EXIT_FAILURE, poptStrerror(POPT_ERROR_BADNUMBER), + poptGetInvocationName(popt_context)); + if (ARG_UINT32(OPT_KEYSLOT_KEY_SIZE_ID) % 8) + usage(popt_context, EXIT_FAILURE, + _("Key size must be a multiple of 8 bits"), + poptGetInvocationName(popt_context)); + break; + case OPT_REDUCE_DEVICE_SIZE_ID: + if (ARG_UINT64(OPT_REDUCE_DEVICE_SIZE_ID) > 1024 * 1024 * 1024) + usage(popt_context, EXIT_FAILURE, _("Maximum device reduce size is 1 GiB."), + poptGetInvocationName(popt_context)); + if (ARG_UINT64(OPT_REDUCE_DEVICE_SIZE_ID) % SECTOR_SIZE) + usage(popt_context, EXIT_FAILURE, _("Reduce size must be multiple of 512 bytes sector."), + poptGetInvocationName(popt_context)); + data_shift = -(int64_t)ARG_UINT64(OPT_REDUCE_DEVICE_SIZE_ID); + break; + case OPT_SECTOR_SIZE_ID: + if (ARG_UINT32(OPT_SECTOR_SIZE_ID) < SECTOR_SIZE || + ARG_UINT32(OPT_SECTOR_SIZE_ID) > MAX_SECTOR_SIZE || + (ARG_UINT32(OPT_SECTOR_SIZE_ID) & (ARG_UINT32(OPT_SECTOR_SIZE_ID) - 1))) + usage(popt_context, EXIT_FAILURE, + _("Unsupported encryption sector size."), + poptGetInvocationName(popt_context)); + break; + case OPT_PRIORITY_ID: + if (strcmp(ARG_STR(OPT_PRIORITY_ID), "normal") && + strcmp(ARG_STR(OPT_PRIORITY_ID), "prefer") && + strcmp(ARG_STR(OPT_PRIORITY_ID), "ignore")) + usage(popt_context, EXIT_FAILURE, + _("Option --priority can be only ignore/normal/prefer."), + poptGetInvocationName(popt_context)); + break; + } +} + int main(int argc, const char **argv) { static struct poptOption popt_help_options[] = { @@ -3533,90 +3524,16 @@ int main(int argc, const char **argv) { "version",'V', POPT_ARG_NONE, NULL, 0, N_("Print package version"), NULL }, POPT_TABLEEND }; + static struct poptOption popt_basic_options[] = { + { NULL, '\0', POPT_ARG_CALLBACK, basic_options_cb, 0, NULL, NULL }, +#define ARG(A, B, C, D, E, F, G, H) { A, B, C, NULL, A ## _ID, D, E }, +#include "cryptsetup_arg_list.h" +#undef arg + POPT_TABLEEND + }; static struct poptOption popt_options[] = { - { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL }, - { "verbose", 'v', POPT_ARG_NONE, &opt_verbose, 0, N_("Shows more detailed error messages"), NULL }, - { "debug", '\0', POPT_ARG_NONE, &opt_debug, 0, N_("Show debug messages"), NULL }, - { "debug-json", '\0', POPT_ARG_NONE, &opt_debug_json, 0, N_("Show debug messages including JSON metadata"), NULL }, - { "cipher", 'c', POPT_ARG_STRING, &opt_cipher, 0, N_("The cipher used to encrypt the disk (see /proc/crypto)"), NULL }, - { "hash", 'h', POPT_ARG_STRING, &opt_hash, 0, N_("The hash used to create the encryption key from the passphrase"), NULL }, - { "verify-passphrase", 'y', POPT_ARG_NONE, &opt_verify_passphrase, 0, N_("Verifies the passphrase by asking for it twice"), NULL }, - { "key-file", 'd', POPT_ARG_STRING, NULL, 6, N_("Read the key from a file"), NULL }, - { "master-key-file", '\0', POPT_ARG_STRING, &opt_master_key_file, 0, N_("Read the volume (master) key from file."), NULL }, - { "dump-master-key", '\0', POPT_ARG_NONE, &opt_dump_master_key, 0, N_("Dump volume (master) key instead of keyslots info"), NULL }, - { "key-size", 's', POPT_ARG_INT, &opt_key_size, 0, N_("The size of the encryption key"), N_("BITS") }, - { "keyfile-size", 'l', POPT_ARG_LONG, &opt_keyfile_size, 0, N_("Limits the read from keyfile"), N_("bytes") }, - { "keyfile-offset", '\0', POPT_ARG_STRING, NULL, 4, N_("Number of bytes to skip in keyfile"), N_("bytes") }, - { "new-keyfile-size", '\0', POPT_ARG_LONG, &opt_new_keyfile_size, 0, N_("Limits the read from newly added keyfile"), N_("bytes") }, - { "new-keyfile-offset",'\0', POPT_ARG_STRING, NULL, 5, N_("Number of bytes to skip in newly added keyfile"), N_("bytes") }, - { "key-slot", 'S', POPT_ARG_INT, &opt_key_slot, 0, N_("Slot number for new key (default is first free)"), NULL }, - { "size", 'b', POPT_ARG_STRING, NULL, 1, N_("The size of the device"), N_("SECTORS") }, - { "device-size", '\0', POPT_ARG_STRING, &opt_device_size_str, 0, N_("Use only specified device size (ignore rest of device). DANGEROUS!"), N_("bytes") }, - { "offset", 'o', POPT_ARG_STRING, NULL, 2, N_("The start offset in the backend device"), N_("SECTORS") }, - { "skip", 'p', POPT_ARG_STRING, NULL, 3, N_("How many sectors of the encrypted data to skip at the beginning"), N_("SECTORS") }, - { "readonly", 'r', POPT_ARG_NONE, &opt_readonly, 0, N_("Create a readonly mapping"), NULL }, - { "batch-mode", 'q', POPT_ARG_NONE, &opt_batch_mode, 0, N_("Do not ask for confirmation"), NULL }, - { "timeout", 't', POPT_ARG_INT, &opt_timeout, 0, N_("Timeout for interactive passphrase prompt (in seconds)"), N_("secs") }, - { "progress-frequency",'\0', POPT_ARG_INT, &opt_progress_frequency, 0, N_("Progress line update (in seconds)"), N_("secs") }, - { "tries", 'T', POPT_ARG_INT, &opt_tries, 0, N_("How often the input of the passphrase can be retried"), NULL }, - { "align-payload", '\0', POPT_ARG_INT, &opt_align_payload, 0, N_("Align payload at sector boundaries - for luksFormat"), N_("SECTORS") }, - { "header-backup-file",'\0', POPT_ARG_STRING, &opt_header_backup_file, 0, N_("File with LUKS header and keyslots backup"), NULL }, - { "use-random", '\0', POPT_ARG_NONE, &opt_random, 0, N_("Use /dev/random for generating volume key"), NULL }, - { "use-urandom", '\0', POPT_ARG_NONE, &opt_urandom, 0, N_("Use /dev/urandom for generating volume key"), NULL }, - { "shared", '\0', POPT_ARG_NONE, &opt_shared, 0, N_("Share device with another non-overlapping crypt segment"), NULL }, - { "uuid", '\0', POPT_ARG_STRING, &opt_uuid, 0, N_("UUID for device to use"), NULL }, - { "allow-discards", '\0', POPT_ARG_NONE, &opt_allow_discards, 0, N_("Allow discards (aka TRIM) requests for device"), NULL }, - { "header", '\0', POPT_ARG_STRING, &opt_header_device, 0, N_("Device or file with separated LUKS header"), NULL }, - { "test-passphrase", '\0', POPT_ARG_NONE, &opt_test_passphrase, 0, N_("Do not activate device, just check passphrase"), NULL }, - { "tcrypt-hidden", '\0', POPT_ARG_NONE, &opt_tcrypt_hidden, 0, N_("Use hidden header (hidden TCRYPT device)"), NULL }, - { "tcrypt-system", '\0', POPT_ARG_NONE, &opt_tcrypt_system, 0, N_("Device is system TCRYPT drive (with bootloader)"), NULL }, - { "tcrypt-backup", '\0', POPT_ARG_NONE, &opt_tcrypt_backup, 0, N_("Use backup (secondary) TCRYPT header"), NULL }, - { "veracrypt", '\0', POPT_ARG_NONE, &opt_veracrypt, 0, N_("Scan also for VeraCrypt compatible device"), NULL }, - { "veracrypt-pim", '\0', POPT_ARG_INT, &opt_veracrypt_pim, 0, N_("Personal Iteration Multiplier for VeraCrypt compatible device"), NULL }, - { "veracrypt-query-pim", '\0', POPT_ARG_NONE, &opt_veracrypt_query_pim, 0, N_("Query Personal Iteration Multiplier for VeraCrypt compatible device"), NULL }, - { "type", 'M', POPT_ARG_STRING, &opt_type, 0, N_("Type of device metadata: luks, luks1, luks2, plain, loopaes, tcrypt, bitlk"), NULL }, - { "force-password", '\0', POPT_ARG_NONE, &opt_force_password, 0, N_("Disable password quality check (if enabled)"), NULL }, - { "perf-same_cpu_crypt",'\0', POPT_ARG_NONE, &opt_perf_same_cpu_crypt, 0, N_("Use dm-crypt same_cpu_crypt performance compatibility option"), NULL }, - { "perf-submit_from_crypt_cpus",'\0', POPT_ARG_NONE, &opt_perf_submit_from_crypt_cpus,0,N_("Use dm-crypt submit_from_crypt_cpus performance compatibility option"), NULL }, - { "deferred", '\0', POPT_ARG_NONE, &opt_deferred_remove, 0, N_("Device removal is deferred until the last user closes it"), NULL }, - { "serialize-memory-hard-pbkdf", '\0', POPT_ARG_NONE, &opt_serialize_memory_hard_pbkdf, 0, N_("Use global lock to serialize memory hard PBKDF (OOM workaround)"), NULL }, - { "iter-time", 'i', POPT_ARG_INT, &opt_iteration_time, 0, N_("PBKDF iteration time for LUKS (in ms)"), N_("msecs") }, - { "pbkdf", '\0', POPT_ARG_STRING, &opt_pbkdf, 0, N_("PBKDF algorithm (for LUKS2): argon2i, argon2id, pbkdf2"), NULL }, - { "pbkdf-memory", '\0', POPT_ARG_LONG, &opt_pbkdf_memory, 0, N_("PBKDF memory cost limit"), N_("kilobytes") }, - { "pbkdf-parallel", '\0', POPT_ARG_LONG, &opt_pbkdf_parallel, 0, N_("PBKDF parallel cost"), N_("threads") }, - { "pbkdf-force-iterations",'\0',POPT_ARG_LONG, &opt_pbkdf_iterations, 0, N_("PBKDF iterations cost (forced, disables benchmark)"), NULL }, - { "priority", '\0', POPT_ARG_STRING, &opt_priority, 0, N_("Keyslot priority: ignore, normal, prefer"), NULL }, - { "disable-locks", '\0', POPT_ARG_NONE, &opt_disable_locks, 0, N_("Disable locking of on-disk metadata"), NULL }, - { "disable-keyring", '\0', POPT_ARG_NONE, &opt_disable_keyring, 0, N_("Disable loading volume keys via kernel keyring"), NULL }, - { "integrity", 'I', POPT_ARG_STRING, &opt_integrity, 0, N_("Data integrity algorithm (LUKS2 only)"), NULL }, - { "integrity-no-journal",'\0',POPT_ARG_NONE, &opt_integrity_nojournal, 0, N_("Disable journal for integrity device"), NULL }, - { "integrity-no-wipe", '\0', POPT_ARG_NONE, &opt_integrity_no_wipe, 0, N_("Do not wipe device after format"), NULL }, - { "integrity-legacy-padding",'\0', POPT_ARG_NONE, &opt_integrity_legacy_padding,0, N_("Use inefficient legacy padding (old kernels)"), NULL }, - { "token-only", '\0', POPT_ARG_NONE, &opt_token_only, 0, N_("Do not ask for passphrase if activation by token fails"), NULL }, - { "token-id", '\0', POPT_ARG_INT, &opt_token, 0, N_("Token number (default: any)"), NULL }, - { "key-description", '\0', POPT_ARG_STRING, &opt_key_description, 0, N_("Key description"), NULL }, - { "sector-size", '\0', POPT_ARG_INT, &opt_sector_size, 0, N_("Encryption sector size (default: 512 bytes)"), NULL }, - { "iv-large-sectors", '\0', POPT_ARG_NONE, &opt_iv_large_sectors, 0, N_("Use IV counted in sector size (not in 512 bytes)"), NULL }, - { "persistent", '\0', POPT_ARG_NONE, &opt_persistent, 0, N_("Set activation flags persistent for device"), NULL }, - { "label", '\0', POPT_ARG_STRING, &opt_label, 0, N_("Set label for the LUKS2 device"), NULL }, - { "subsystem", '\0', POPT_ARG_STRING, &opt_subsystem, 0, N_("Set subsystem label for the LUKS2 device"), NULL }, - { "unbound", '\0', POPT_ARG_NONE, &opt_unbound, 0, N_("Create or dump unbound (no assigned data segment) LUKS2 keyslot"), NULL }, - { "json-file", '\0', POPT_ARG_STRING, &opt_json_file, 0, N_("Read or write the json from or to a file"), NULL }, - { "luks2-metadata-size",'\0',POPT_ARG_STRING,&opt_luks2_metadata_size_str,0,N_("LUKS2 header metadata area size"), N_("bytes") }, - { "luks2-keyslots-size",'\0',POPT_ARG_STRING,&opt_luks2_keyslots_size_str,0,N_("LUKS2 header keyslots area size"), N_("bytes") }, - { "refresh", '\0', POPT_ARG_NONE, &opt_refresh, 0, N_("Refresh (reactivate) device with new parameters"), NULL }, - { "keyslot-key-size", '\0', POPT_ARG_INT, &opt_keyslot_key_size, 0, N_("LUKS2 keyslot: The size of the encryption key"), N_("BITS") }, - { "keyslot-cipher", '\0', POPT_ARG_STRING, &opt_keyslot_cipher, 0, N_("LUKS2 keyslot: The cipher used for keyslot encryption"), NULL }, - { "encrypt", '\0', POPT_ARG_NONE, &opt_encrypt, 0, N_("Encrypt LUKS2 device (in-place encryption)."), NULL }, - { "decrypt", '\0', POPT_ARG_NONE, &opt_decrypt, 0, N_("Decrypt LUKS2 device (remove encryption)."), NULL }, - { "init-only", '\0', POPT_ARG_NONE, &opt_reencrypt_init_only, 0, N_("Initialize LUKS2 reencryption in metadata only."), NULL }, - { "resume-only", '\0', POPT_ARG_NONE, &opt_reencrypt_resume_only, 0, N_("Resume initialized LUKS2 reencryption only."), NULL }, - { "reduce-device-size",'\0', POPT_ARG_STRING, &opt_reduce_size_str, 0, N_("Reduce data device size (move data offset). DANGEROUS!"), N_("bytes") }, - { "hotzone-size", '\0', POPT_ARG_STRING, &opt_hotzone_size_str, 0, N_("Maximal reencryption hotzone size."), N_("bytes") }, - { "resilience", '\0', POPT_ARG_STRING, &opt_resilience_mode, 0, N_("Reencryption hotzone resilience type (checksum,journal,none)"), NULL }, - { "resilience-hash", '\0', POPT_ARG_STRING, &opt_resilience_hash, 0, N_("Reencryption hotzone checksums hash"), NULL }, - { "active-name", '\0', POPT_ARG_STRING, &opt_active_name, 0, N_("Override device autodetection of dm device to be reencrypted"), NULL }, - { "test-args", '\0', POPT_ARG_NONE, &opt_test_args, 0, N_("Do not run action, just validate all command line parameters"), NULL }, + { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL }, + { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_basic_options, 0, NULL, NULL }, POPT_TABLEEND }; poptContext popt_context; @@ -3634,53 +3551,7 @@ int main(int argc, const char **argv) poptSetOtherOptionHelp(popt_context, _("[OPTION...] ")); - while((r = poptGetNextOpt(popt_context)) > 0) { - unsigned long long ull_value; - char *endp, *str = poptGetOptArg(popt_context); - - if (r == 6) { - free(opt_key_file); - opt_key_file = str; - if (tools_is_stdin(str)) { - free(opt_keyfile_stdin); - opt_keyfile_stdin = strdup(str); - } else if (opt_keyfiles_count < MAX_KEYFILES) - opt_keyfiles[opt_keyfiles_count++] = strdup(str); - total_keyfiles++; - continue; - } - - errno = 0; - ull_value = strtoull(str, &endp, 0); - if (*endp || !*str || !isdigit(*str) || - (errno == ERANGE && ull_value == ULLONG_MAX) || - (errno != 0 && ull_value == 0)) - r = POPT_ERROR_BADNUMBER; - - free(str); - - switch(r) { - case 1: - opt_size = ull_value; - break; - case 2: - opt_offset = ull_value; - break; - case 3: - opt_skip = ull_value; - opt_skip_valid = 1; - break; - case 4: - opt_keyfile_offset = ull_value; - break; - case 5: - opt_new_keyfile_offset = ull_value; - break; - } - - if (r < 0) - break; - } + while ((r = poptGetNextOpt(popt_context)) > 0) {} if (r < -1) usage(popt_context, EXIT_FAILURE, poptStrerror(r), @@ -3708,22 +3579,22 @@ int main(int argc, const char **argv) action_argv[0] = action_argv[1]; action_argv[1] = tmp; } - aname = "open"; + aname = OPEN_ACTION; device_type = "plain"; } else if (!strcmp(aname, "plainOpen")) { - aname = "open"; + aname = OPEN_ACTION; device_type = "plain"; } else if (!strcmp(aname, "luksOpen")) { - aname = "open"; + aname = OPEN_ACTION; device_type = "luks"; } else if (!strcmp(aname, "loopaesOpen")) { - aname = "open"; + aname = OPEN_ACTION; device_type = "loopaes"; } else if (!strcmp(aname, "tcryptOpen")) { - aname = "open"; + aname = OPEN_ACTION; device_type = "tcrypt"; } else if (!strcmp(aname, "bitlkOpen")) { - aname = "open"; + aname = OPEN_ACTION; device_type = "bitlk"; } else if (!strcmp(aname, "tcryptDump")) { device_type = "tcrypt"; @@ -3735,21 +3606,21 @@ int main(int argc, const char **argv) !strcmp(aname, "loopaesClose") || !strcmp(aname, "tcryptClose") || !strcmp(aname, "bitlkClose")) { - aname = "close"; + aname = CLOSE_ACTION; } else if (!strcmp(aname, "luksErase")) { - aname = "erase"; + aname = ERASE_ACTION; device_type = "luks"; } else if (!strcmp(aname, "luksConfig")) { - aname = "config"; + aname = CONFIG_ACTION; device_type = "luks2"; } else if (!strcmp(aname, "refresh")) { - aname = "open"; - opt_refresh = 1; - } else if (opt_type) - device_type = opt_type; + aname = OPEN_ACTION; + ARG_SET(OPT_REFRESH_ID) = true; + } else if (ARG_SET(OPT_TYPE_ID)) + device_type = ARG_STR(OPT_TYPE_ID); /* ignore user supplied type and query device type instead */ - if (opt_refresh) + if (ARG_SET(OPT_REFRESH_ID)) device_type = NULL; for(action = action_types; action->type; action++) @@ -3763,321 +3634,198 @@ int main(int argc, const char **argv) if (action_argc < action->required_action_argc) help_args(action, popt_context); - /* FIXME: rewrite this from scratch */ + /* this routine short circuits to exit() on error */ + tools_check_args(action->type, tool_core_args, ARRAY_SIZE(tool_core_args), popt_context); - if (opt_refresh && opt_test_passphrase) + if (ARG_SET(OPT_REFRESH_ID) && ARG_SET(OPT_TEST_PASSPHRASE_ID)) usage(popt_context, EXIT_FAILURE, _("Options --refresh and --test-passphrase are mutually exclusive."), poptGetInvocationName(popt_context)); - if (opt_deferred_remove && strcmp(aname, "close")) - usage(popt_context, EXIT_FAILURE, - _("Option --deferred is allowed only for close command."), - poptGetInvocationName(popt_context)); - - if (opt_shared && (strcmp(aname, "open") || strcmp_or_null(device_type, "plain"))) + /* open action specific check */ + if (ARG_SET(OPT_SHARED_ID) && strcmp_or_null(device_type, "plain")) usage(popt_context, EXIT_FAILURE, _("Option --shared is allowed only for open of plain device."), poptGetInvocationName(popt_context)); - if (opt_allow_discards && strcmp(aname, "open")) - usage(popt_context, EXIT_FAILURE, - _("Option --allow-discards is allowed only for open operation."), - poptGetInvocationName(popt_context)); - - if (opt_persistent && strcmp(aname, "open")) - usage(popt_context, EXIT_FAILURE, - _("Option --persistent is allowed only for open operation."), - poptGetInvocationName(popt_context)); - - if (opt_serialize_memory_hard_pbkdf && strcmp(aname, "open")) - usage(popt_context, EXIT_FAILURE, - _("Option --serialize-memory-hard-pbkdf is allowed only for open operation."), - poptGetInvocationName(popt_context)); - - if (opt_persistent && opt_test_passphrase) + if (ARG_SET(OPT_PERSISTENT_ID) && ARG_SET(OPT_TEST_PASSPHRASE_ID)) usage(popt_context, EXIT_FAILURE, _("Option --persistent is not allowed with --test-passphrase."), poptGetInvocationName(popt_context)); - if (opt_key_size && - strcmp(aname, "reencrypt") && - strcmp(aname, "luksFormat") && - strcmp(aname, "open") && - strcmp(aname, "benchmark") && - strcmp(aname, "luksAddKey")) - usage(popt_context, EXIT_FAILURE, - _("Option --key-size is allowed only for luksFormat, luksAddKey,\n" - "open and benchmark actions. To limit read from keyfile use --keyfile-size=(bytes)."), - poptGetInvocationName(popt_context)); - - if (opt_integrity && strcmp(aname, "luksFormat")) - usage(popt_context, EXIT_FAILURE, - _("Option --integrity is allowed only for luksFormat (LUKS2)."), - poptGetInvocationName(popt_context)); - - if (opt_integrity_no_wipe && !opt_integrity) + if (ARG_SET(OPT_INTEGRITY_NO_WIPE_ID) && !ARG_SET(OPT_INTEGRITY_ID)) usage(popt_context, EXIT_FAILURE, _("Option --integrity-no-wipe" " can be used only for format action with integrity extension."), poptGetInvocationName(popt_context)); - if ((opt_label || opt_subsystem) && strcmp(aname, "luksFormat") && strcmp(aname, "config")) - usage(popt_context, EXIT_FAILURE, - _("Options --label and --subsystem are allowed only for luksFormat and config LUKS2 operations."), - poptGetInvocationName(popt_context)); - - if (opt_test_passphrase && (strcmp(aname, "open") || !device_type || + if (ARG_SET(OPT_TEST_PASSPHRASE_ID) && (strcmp(aname, OPEN_ACTION) || !device_type || (strncmp(device_type, "luks", 4) && strcmp(device_type, "tcrypt") && strcmp(device_type, "bitlk")))) usage(popt_context, EXIT_FAILURE, _("Option --test-passphrase is allowed only for open of LUKS, TCRYPT and BITLK devices."), poptGetInvocationName(popt_context)); - if (opt_key_size % 8 || opt_keyslot_key_size % 8) - usage(popt_context, EXIT_FAILURE, - _("Key size must be a multiple of 8 bits"), - poptGetInvocationName(popt_context)); - - if (!strcmp(aname, "luksKillSlot") && action_argc > 1) - opt_key_slot = atoi(action_argv[1]); - if (opt_key_slot != CRYPT_ANY_SLOT && opt_key_slot < 0) - usage(popt_context, EXIT_FAILURE, _("Key slot is invalid."), - poptGetInvocationName(popt_context)); - - if ((!strcmp(aname, "luksRemoveKey") || - !strcmp(aname, "luksFormat")) && - action_argc > 1) { - if (opt_key_file) - log_err(_("Option --key-file takes precedence over specified key file argument.")); - else - opt_key_file = strdup(action_argv[1]); + if (!strcmp(aname, KILLKEY_ACTION) && action_argc > 1) { + ARG_SET_INT32(OPT_KEY_SLOT_ID, atoi(action_argv[1])); + check_key_slot_value(popt_context); } - if (opt_keyfile_size < 0 || opt_new_keyfile_size < 0 || opt_key_size < 0) - usage(popt_context, EXIT_FAILURE, - _("Negative number for option not permitted."), - poptGetInvocationName(popt_context)); + if ((!strcmp(aname, REMOVEKEY_ACTION) || + !strcmp(aname, FORMAT_ACTION)) && + action_argc > 1) { + if (ARG_SET(OPT_KEY_FILE_ID)) + log_err(_("Option --key-file takes precedence over specified key file argument.")); + else + ARG_SET_STR(OPT_KEY_FILE_ID, strdup(action_argv[1])); + } if (total_keyfiles > 1 && (strcmp_or_null(device_type, "tcrypt"))) usage(popt_context, EXIT_FAILURE, _("Only one --key-file argument is allowed."), poptGetInvocationName(popt_context)); - if (opt_random && opt_urandom) + if (ARG_SET(OPT_USE_RANDOM_ID) && ARG_SET(OPT_USE_URANDOM_ID)) usage(popt_context, EXIT_FAILURE, _("Only one of --use-[u]random options is allowed."), poptGetInvocationName(popt_context)); - if ((opt_random || opt_urandom) && strcmp(aname, "luksFormat")) - usage(popt_context, EXIT_FAILURE, _("Option --use-[u]random is allowed only for luksFormat."), - poptGetInvocationName(popt_context)); - - if (opt_uuid && strcmp(aname, "luksFormat") && strcmp(aname, "luksUUID")) - usage(popt_context, EXIT_FAILURE, _("Option --uuid is allowed only for luksFormat and luksUUID."), - poptGetInvocationName(popt_context)); - - if (opt_align_payload && strcmp(aname, "luksFormat")) - usage(popt_context, EXIT_FAILURE, _("Option --align-payload is allowed only for luksFormat."), - poptGetInvocationName(popt_context)); - - if ((opt_luks2_metadata_size_str || opt_luks2_keyslots_size_str) && strcmp(aname, "luksFormat") && strcmp(aname, "reencrypt")) - usage(popt_context, EXIT_FAILURE, _("Options --luks2-metadata-size and --opt-luks2-keyslots-size " - "are allowed only for luksFormat with LUKS2."), - poptGetInvocationName(popt_context)); - if (opt_luks2_metadata_size_str && - tools_string_to_size(NULL, opt_luks2_metadata_size_str, &opt_luks2_metadata_size)) - usage(popt_context, EXIT_FAILURE, _("Invalid LUKS2 metadata size specification."), - poptGetInvocationName(popt_context)); - if (opt_luks2_keyslots_size_str && - tools_string_to_size(NULL, opt_luks2_keyslots_size_str, &opt_luks2_keyslots_size)) - usage(popt_context, EXIT_FAILURE, _("Invalid LUKS2 keyslots size specification."), - poptGetInvocationName(popt_context)); - - if (opt_align_payload && opt_offset) + if (ARG_SET(OPT_ALIGN_PAYLOAD_ID) && ARG_SET(OPT_OFFSET_ID)) usage(popt_context, EXIT_FAILURE, _("Options --align-payload and --offset cannot be combined."), poptGetInvocationName(popt_context)); - if (opt_skip && (strcmp(aname, "open") || - (strcmp_or_null(device_type, "plain") && strcmp(device_type, "loopaes")))) + /* open action specific check */ + if (ARG_SET(OPT_SKIP_ID) && strcmp_or_null(device_type, "plain") && strcmp(device_type, "loopaes")) usage(popt_context, EXIT_FAILURE, _("Option --skip is supported only for open of plain and loopaes devices."), poptGetInvocationName(popt_context)); - if (opt_offset && ((strcmp(aname, "reencrypt") && strcmp(aname, "open") && strcmp(aname, "luksFormat")) || - (!strcmp(aname, "open") && strcmp_or_null(device_type, "plain") && strcmp(device_type, "loopaes")) || - (!strcmp(aname, "luksFormat") && device_type && strncmp(device_type, "luks", 4)))) + /* open action specific check */ + if (ARG_SET(OPT_OFFSET_ID) && !strcmp(aname, OPEN_ACTION) && strcmp_or_null(device_type, "plain") && strcmp(device_type, "loopaes")) usage(popt_context, EXIT_FAILURE, - _("Option --offset is supported only for open of plain and loopaes devices, luksFormat and device reencryption."), + _("Option --offset with open action is only supported for plain and loopaes devices."), poptGetInvocationName(popt_context)); - if ((opt_tcrypt_hidden || opt_tcrypt_system || opt_tcrypt_backup) && strcmp(aname, "tcryptDump") && - (strcmp(aname, "open") || !device_type || strcmp(device_type, "tcrypt"))) + /* open action specific check */ + if ((ARG_SET(OPT_TCRYPT_HIDDEN_ID) || ARG_SET(OPT_TCRYPT_SYSTEM_ID) || ARG_SET(OPT_TCRYPT_BACKUP_ID)) && !strcmp(aname, OPEN_ACTION) && (!device_type || strcmp(device_type, "tcrypt"))) usage(popt_context, EXIT_FAILURE, _("Option --tcrypt-hidden, --tcrypt-system or --tcrypt-backup is supported only for TCRYPT device."), poptGetInvocationName(popt_context)); - if (opt_tcrypt_hidden && opt_allow_discards) + if (ARG_SET(OPT_TCRYPT_HIDDEN_ID) && ARG_SET(OPT_ALLOW_DISCARDS_ID)) usage(popt_context, EXIT_FAILURE, _("Option --tcrypt-hidden cannot be combined with --allow-discards."), poptGetInvocationName(popt_context)); - if (opt_veracrypt && (!device_type || strcmp(device_type, "tcrypt"))) + if (ARG_SET(OPT_VERACRYPT_ID) && (!device_type || strcmp(device_type, "tcrypt"))) usage(popt_context, EXIT_FAILURE, _("Option --veracrypt is supported only for TCRYPT device type."), poptGetInvocationName(popt_context)); - if (opt_veracrypt_pim != -1) { - if (opt_veracrypt_pim < -1) { - usage(popt_context, EXIT_FAILURE, - _("Invalid argument for parameter --veracrypt-pim supplied."), - poptGetInvocationName(popt_context)); - } else if (!opt_veracrypt) { - usage(popt_context, EXIT_FAILURE, - _("Option --veracrypt-pim is supported only for VeraCrypt compatible devices."), - poptGetInvocationName(popt_context)); - } - } + if (ARG_SET(OPT_VERACRYPT_PIM_ID) && !ARG_SET(OPT_VERACRYPT_ID)) + usage(popt_context, EXIT_FAILURE, + _("Option --veracrypt-pim is supported only for VeraCrypt compatible devices."), + poptGetInvocationName(popt_context)); - if (opt_veracrypt_query_pim) { - if (!opt_veracrypt) { + if (ARG_SET(OPT_VERACRYPT_QUERY_PIM_ID)) { + if (!ARG_SET(OPT_VERACRYPT_ID)) { usage(popt_context, EXIT_FAILURE, _("Option --veracrypt-query-pim is supported only for VeraCrypt compatible devices."), poptGetInvocationName(popt_context)); - } else if (opt_veracrypt_pim != -1) { + } else if (ARG_SET(OPT_VERACRYPT_PIM_ID)) { usage(popt_context, EXIT_FAILURE, _("The options --veracrypt-pim and --veracrypt-query-pim are mutually exclusive."), poptGetInvocationName(popt_context)); } } - if (opt_priority && strcmp(opt_priority, "normal") && strcmp(opt_priority, "prefer") && strcmp(opt_priority, "ignore")) - usage(popt_context, EXIT_FAILURE, - _("Option --priority can be only ignore/normal/prefer."), - poptGetInvocationName(popt_context)); - - if (!strcmp(aname, "config") && opt_priority && opt_key_slot == CRYPT_ANY_SLOT) + /* config action specific check */ + if (!strcmp(aname, CONFIG_ACTION) && ARG_SET(OPT_PRIORITY_ID) && ARG_INT32(OPT_KEY_SLOT_ID) == CRYPT_ANY_SLOT) usage(popt_context, EXIT_FAILURE, _("Keyslot specification is required."), poptGetInvocationName(popt_context)); - if (opt_pbkdf && crypt_parse_pbkdf(opt_pbkdf, &set_pbkdf)) + if (ARG_SET(OPT_PBKDF_ID) && crypt_parse_pbkdf(ARG_STR(OPT_PBKDF_ID), &set_pbkdf)) usage(popt_context, EXIT_FAILURE, _("Password-based key derivation function (PBKDF) can be only pbkdf2 or argon2i/argon2id."), poptGetInvocationName(popt_context)); - if (opt_pbkdf_iterations && opt_iteration_time) + if (ARG_SET(OPT_PBKDF_FORCE_ITERATIONS_ID) && ARG_SET(OPT_ITER_TIME_ID)) usage(popt_context, EXIT_FAILURE, _("PBKDF forced iterations cannot be combined with iteration time option."), poptGetInvocationName(popt_context)); - if (opt_sector_size && strcmp(aname, "reencrypt") && strcmp(aname, "luksFormat") && - (strcmp(aname, "open") || strcmp_or_null(device_type, "plain"))) + /* open action specific check */ + if (ARG_SET(OPT_SECTOR_SIZE_ID) && !strcmp(aname, OPEN_ACTION) && + (!device_type || strcmp(device_type, "plain"))) usage(popt_context, EXIT_FAILURE, - _("Sector size option is not supported for this command."), + _("Sector size option with open action is supported only for plain devices."), poptGetInvocationName(popt_context)); - if (opt_sector_size && (opt_sector_size < SECTOR_SIZE || opt_sector_size > MAX_SECTOR_SIZE || - (opt_sector_size & (opt_sector_size - 1)))) - usage(popt_context, EXIT_FAILURE, - _("Unsupported encryption sector size."), - poptGetInvocationName(popt_context)); - - if (opt_iv_large_sectors && (strcmp(aname, "open") || strcmp_or_null(opt_type, "plain") || - opt_sector_size <= SECTOR_SIZE)) + /* open action specific check */ + if (ARG_SET(OPT_IV_LARGE_SECTORS_ID) && (!device_type || strcmp(device_type, "plain") || + ARG_UINT32(OPT_SECTOR_SIZE_ID) <= SECTOR_SIZE)) usage(popt_context, EXIT_FAILURE, _("Large IV sectors option is supported only for opening plain type device with sector size larger than 512 bytes."), poptGetInvocationName(popt_context)); - if (opt_unbound && !opt_key_size && !strcmp(aname, "luksAddKey")) + /* luksAddKey action specific check */ + if (ARG_SET(OPT_UNBOUND_ID) && !ARG_UINT32(OPT_KEY_SIZE_ID) && !strcmp(aname, ADDKEY_ACTION)) usage(popt_context, EXIT_FAILURE, _("Key size is required with --unbound option."), poptGetInvocationName(popt_context)); - if (opt_unbound && !strcmp(aname, "luksDump") && opt_key_slot == CRYPT_ANY_SLOT) + /* luksDump action specific check */ + if (ARG_SET(OPT_UNBOUND_ID) && ARG_INT32(OPT_KEY_SLOT_ID) == CRYPT_ANY_SLOT && !strcmp(aname, LUKSDUMP_ACTION)) usage(popt_context, EXIT_FAILURE, _("Keyslot specification is required."), poptGetInvocationName(popt_context)); - if (opt_unbound && strcmp(aname, "luksAddKey") && strcmp(aname, "luksDump")) - usage(popt_context, EXIT_FAILURE, - _("Option --unbound may be used only with luksAddKey and luksDump actions."), - poptGetInvocationName(popt_context)); - - if (opt_refresh && strcmp(aname, "open")) - usage(popt_context, EXIT_FAILURE, - _("Option --refresh may be used only with open action."), - poptGetInvocationName(popt_context)); - - if (opt_debug || opt_debug_json) { - opt_debug = 1; - opt_verbose = 1; - crypt_set_debug_level(opt_debug_json? CRYPT_DEBUG_JSON : CRYPT_DEBUG_ALL); + if (ARG_SET(OPT_DEBUG_ID) || ARG_SET(OPT_DEBUG_JSON_ID)) { + ARG_SET(OPT_DEBUG_ID) = true; + ARG_SET(OPT_VERBOSE_ID) = true; + crypt_set_debug_level(ARG_SET(OPT_DEBUG_JSON_ID)? CRYPT_DEBUG_JSON : CRYPT_DEBUG_ALL); dbg_version_and_cmd(argc, argv); } - if (!opt_test_args && opt_disable_locks && crypt_metadata_locking(NULL, 0)) { - log_std(_("Cannot disable metadata locking.")); - tools_cleanup(); - poptFreeContext(popt_context); - exit(EXIT_FAILURE); - } - - if (!opt_test_args && opt_disable_keyring) - (void) crypt_volume_key_keyring(NULL, 0); - - if (opt_hotzone_size_str && - (tools_string_to_size(NULL, opt_hotzone_size_str, &opt_hotzone_size) || !opt_hotzone_size)) - usage(popt_context, EXIT_FAILURE, _("Invalid max reencryption hotzone size specification."), - poptGetInvocationName(popt_context)); - - if (!opt_hotzone_size && opt_resilience_mode && !strcmp(opt_resilience_mode, "none")) - opt_hotzone_size = 50 * 1024 * 1024; - - if (opt_reduce_size_str && - tools_string_to_size(NULL, opt_reduce_size_str, &opt_reduce_size)) - usage(popt_context, EXIT_FAILURE, _("Invalid device size specification."), - poptGetInvocationName(popt_context)); - if (opt_reduce_size > 1024 * 1024 * 1024) - usage(popt_context, EXIT_FAILURE, _("Maximum device reduce size is 1 GiB."), - poptGetInvocationName(popt_context)); - if (opt_reduce_size % SECTOR_SIZE) - usage(popt_context, EXIT_FAILURE, _("Reduce size must be multiple of 512 bytes sector."), - poptGetInvocationName(popt_context)); - - if (opt_device_size_str && - tools_string_to_size(NULL, opt_device_size_str, &opt_device_size)) - usage(popt_context, EXIT_FAILURE, _("Invalid data size specification."), - poptGetInvocationName(popt_context)); - - opt_data_shift = -(int64_t)opt_reduce_size; - if (opt_data_shift > 0) - usage(popt_context, EXIT_FAILURE, _("Reduce size overflow."), - poptGetInvocationName(popt_context)); - - if (opt_decrypt && !opt_header_device) + /* reencrypt action specific check */ + if (ARG_SET(OPT_DECRYPT_ID) && !ARG_SET(OPT_HEADER_ID)) usage(popt_context, EXIT_FAILURE, _("LUKS2 decryption requires option --header."), poptGetInvocationName(popt_context)); - if (opt_device_size % SECTOR_SIZE) - usage(popt_context, EXIT_FAILURE, _("Device size must be multiple of 512 bytes sector."), - poptGetInvocationName(popt_context)); - - if (opt_data_shift && opt_device_size) + if (ARG_SET(OPT_REDUCE_DEVICE_SIZE_ID) && ARG_SET(OPT_DEVICE_SIZE_ID)) usage(popt_context, EXIT_FAILURE, _("Options --reduce-device-size and --data-size cannot be combined."), poptGetInvocationName(popt_context)); - if (opt_device_size && opt_size) + if (ARG_SET(OPT_DEVICE_SIZE_ID) && ARG_SET(OPT_SIZE_ID)) usage(popt_context, EXIT_FAILURE, _("Options --device-size and --size cannot be combined."), poptGetInvocationName(popt_context)); - if ((opt_keyslot_cipher && !opt_keyslot_key_size) || (!opt_keyslot_cipher && opt_keyslot_key_size)) + if (ARG_SET(OPT_KEYSLOT_CIPHER_ID) != ARG_SET(OPT_KEYSLOT_KEY_SIZE_ID)) usage(popt_context, EXIT_FAILURE, _("Options --keyslot-cipher and --keyslot-key-size must be used together."), poptGetInvocationName(popt_context)); - if (!opt_test_args) { - r = run_action(action); - } else { - r = 0; + if (ARG_SET(OPT_TEST_ARGS_ID)) { log_std(_("No action taken. Invoked with --test-args option.\n")); + tools_cleanup(); + poptFreeContext(popt_context); + return 0; } + + /* TODO: Remove global variables from future cli library */ + opt_verbose = ARG_SET(OPT_VERBOSE_ID) ? 1 : 0; + opt_debug = ARG_SET(OPT_DEBUG_ID) ? 1 : 0; + opt_debug_json = ARG_SET(OPT_DEBUG_JSON_ID) ? 1 : 0; + opt_batch_mode = ARG_SET(OPT_BATCH_MODE_ID) ? 1 : 0; + opt_progress_frequency = ARG_UINT32(OPT_PROGRESS_FREQUENCY_ID); + + if (ARG_SET(OPT_DISABLE_KEYRING_ID)) + (void) crypt_volume_key_keyring(NULL, 0); + + if (ARG_SET(OPT_DISABLE_LOCKS_ID) && crypt_metadata_locking(NULL, 0)) { + log_std(_("Cannot disable metadata locking.")); + r = EXIT_FAILURE; + } else { + r = run_action(action); + } + tools_cleanup(); poptFreeContext(popt_context); return r; diff --git a/src/cryptsetup_arg_list.h b/src/cryptsetup_arg_list.h new file mode 100644 index 00000000..c9550f63 --- /dev/null +++ b/src/cryptsetup_arg_list.h @@ -0,0 +1,186 @@ +/* + * Cryptsetup command line arguments list + * + * Copyright (C) 2020 Red Hat, Inc. All rights reserved. + * Copyright (C) 2020 Ondrej Kozina + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +/* long name, short name, popt type, help description, units, internal argument type, default value, allowed actions (empty=global) */ + +ARG(OPT_ACTIVE_NAME, '\0', POPT_ARG_STRING, N_("Override device autodetection of dm device to be reencrypted"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_ALIGN_PAYLOAD, '\0', POPT_ARG_STRING, N_("Align payload at sector boundaries - for luksFormat"), N_("SECTORS"), CRYPT_ARG_UINT32, {}, OPT_ALIGN_PAYLOAD_ACTIONS) + +ARG(OPT_ALLOW_DISCARDS, '\0', POPT_ARG_NONE, N_("Allow discards (aka TRIM) requests for device"), NULL, CRYPT_ARG_BOOL, {}, OPT_ALLOW_DISCARDS_ACTIONS) + +ARG(OPT_BATCH_MODE, 'q', POPT_ARG_NONE, N_("Do not ask for confirmation"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_CIPHER, 'c', POPT_ARG_STRING, N_("The cipher used to encrypt the disk (see /proc/crypto)"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_DEBUG, '\0', POPT_ARG_NONE, N_("Show debug messages"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_DEBUG_JSON, '\0', POPT_ARG_NONE, N_("Show debug messages including JSON metadata"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_DEFERRED, '\0', POPT_ARG_NONE, N_("Device removal is deferred until the last user closes it"), NULL, CRYPT_ARG_BOOL, {}, OPT_DEFERRED_ACTIONS) + +ARG(OPT_DEVICE_SIZE, '\0', POPT_ARG_STRING, N_("Use only specified device size (ignore rest of device). DANGEROUS!"), N_("bytes"), CRYPT_ARG_UINT64, {}, {}) + +ARG(OPT_DECRYPT, '\0', POPT_ARG_NONE, N_("Decrypt LUKS2 device (remove encryption)."), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_DISABLE_KEYRING, '\0', POPT_ARG_NONE, N_("Disable loading volume keys via kernel keyring"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_DISABLE_LOCKS, '\0', POPT_ARG_NONE, N_("Disable locking of on-disk metadata"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_DUMP_MASTER_KEY, '\0', POPT_ARG_NONE, N_("Dump volume (master) key instead of keyslots info"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_ENCRYPT, '\0', POPT_ARG_NONE, N_("Encrypt LUKS2 device (in-place encryption)."), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_FORCE_PASSWORD, '\0', POPT_ARG_NONE, N_("Disable password quality check (if enabled)"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_HASH, 'h', POPT_ARG_STRING, N_("The hash used to create the encryption key from the passphrase"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_HEADER, '\0', POPT_ARG_STRING, N_("Device or file with separated LUKS header"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_HEADER_BACKUP_FILE, '\0', POPT_ARG_STRING, N_("File with LUKS header and keyslots backup"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_HOTZONE_SIZE, '\0', POPT_ARG_STRING, N_("Maximal reencryption hotzone size."), N_("bytes"), CRYPT_ARG_UINT64, {}, OPT_HOTZONE_SIZE_ACTIONS) + +ARG(OPT_INIT_ONLY, '\0', POPT_ARG_NONE, N_("Initialize LUKS2 reencryption in metadata only."), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_INTEGRITY, 'I', POPT_ARG_STRING, N_("Data integrity algorithm (LUKS2 only)"), NULL, CRYPT_ARG_STRING, {}, OPT_INTEGRITY_ACTIONS) + +ARG(OPT_INTEGRITY_LEGACY_PADDING,'\0', POPT_ARG_NONE, N_("Use inefficient legacy padding (old kernels)"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_INTEGRITY_NO_JOURNAL, '\0', POPT_ARG_NONE, N_("Disable journal for integrity device"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_INTEGRITY_NO_WIPE, '\0', POPT_ARG_NONE, N_("Do not wipe device after format"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_ITER_TIME, 'i', POPT_ARG_STRING, N_("PBKDF iteration time for LUKS (in ms)"), N_("msecs"), CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_IV_LARGE_SECTORS, '\0', POPT_ARG_NONE, N_("Use IV counted in sector size (not in 512 bytes)"), NULL , CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_JSON_FILE, '\0', POPT_ARG_STRING, N_("Read or write the json from or to a file"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_KEY_DESCRIPTION, '\0', POPT_ARG_STRING, N_("Key description"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_KEY_FILE, 'd', POPT_ARG_STRING, N_("Read the key from a file"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_KEY_SIZE, 's', POPT_ARG_STRING, N_("The size of the encryption key"), N_("BITS"), CRYPT_ARG_UINT32, {}, OPT_KEY_SIZE_ACTIONS) + +ARG(OPT_KEY_SLOT, 'S', POPT_ARG_STRING, N_("Slot number for new key (default is first free)"), NULL, CRYPT_ARG_INT32, { .i32_value = CRYPT_ANY_SLOT }, OPT_KEY_SLOT_ACTIONS) + +ARG(OPT_KEYFILE_OFFSET, '\0', POPT_ARG_STRING, N_("Number of bytes to skip in keyfile"), N_("bytes"), CRYPT_ARG_UINT64, {}, {}) + +ARG(OPT_KEYFILE_SIZE, 'l', POPT_ARG_STRING, N_("Limits the read from keyfile"), N_("bytes"), CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_KEYSLOT_CIPHER, '\0', POPT_ARG_STRING, N_("LUKS2 keyslot: The cipher used for keyslot encryption"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_KEYSLOT_KEY_SIZE, '\0', POPT_ARG_STRING, N_("LUKS2 keyslot: The size of the encryption key"), N_("BITS"), CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_LABEL, '\0', POPT_ARG_STRING, N_("Set label for the LUKS2 device"), NULL, CRYPT_ARG_STRING, {}, OPT_LABEL_ACTIONS) + +ARG(OPT_LUKS2_KEYSLOTS_SIZE, '\0', POPT_ARG_STRING, N_("LUKS2 header keyslots area size"), N_("bytes"), CRYPT_ARG_UINT64, {}, OPT_LUKS2_KEYSLOTS_SIZE_ACTIONS) + +ARG(OPT_LUKS2_METADATA_SIZE, '\0', POPT_ARG_STRING, N_("LUKS2 header metadata area size"), N_("bytes"), CRYPT_ARG_UINT64, {}, OPT_LUKS2_METADATA_SIZE_ACTIONS) + +ARG(OPT_MASTER_KEY_FILE, '\0', POPT_ARG_STRING, N_("Read the volume (master) key from file."), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_NEW_KEYFILE_OFFSET , '\0', POPT_ARG_STRING, N_("Number of bytes to skip in newly added keyfile"), N_("bytes"), CRYPT_ARG_UINT64, {}, {}) + +ARG(OPT_NEW_KEYFILE_SIZE, '\0', POPT_ARG_STRING, N_("Limits the read from newly added keyfile"), N_("bytes"), CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_OFFSET, 'o', POPT_ARG_STRING, N_("The start offset in the backend device"), N_("SECTORS"), CRYPT_ARG_UINT64, {}, OPT_OFFSET_ACTIONS) + +ARG(OPT_PBKDF, '\0', POPT_ARG_STRING, N_("PBKDF algorithm (for LUKS2): argon2i, argon2id, pbkdf2"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_PBKDF_FORCE_ITERATIONS, '\0', POPT_ARG_STRING, N_("PBKDF iterations cost (forced, disables benchmark)"), NULL, CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_PBKDF_MEMORY, '\0', POPT_ARG_STRING, N_("PBKDF memory cost limit"), N_("kilobytes"), CRYPT_ARG_UINT32, { .u32_value = DEFAULT_LUKS2_MEMORY_KB }, {}) + +ARG(OPT_PBKDF_PARALLEL, '\0', POPT_ARG_STRING, N_("PBKDF parallel cost"), N_("threads"), CRYPT_ARG_UINT32, { .u32_value = DEFAULT_LUKS2_PARALLEL_THREADS }, {}) + +ARG(OPT_PERF_SAME_CPU_CRYPT, '\0', POPT_ARG_NONE, N_("Use dm-crypt same_cpu_crypt performance compatibility option"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_PERF_SUBMIT_FROM_CRYPT_CPUS, '\0', POPT_ARG_NONE, N_("Use dm-crypt submit_from_crypt_cpus performance compatibility option"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_PERSISTENT, '\0', POPT_ARG_NONE, N_("Set activation flags persistent for device"), NULL, CRYPT_ARG_BOOL, {}, OPT_PERSISTENT_ACTIONS) + +ARG(OPT_PRIORITY, '\0', POPT_ARG_STRING, N_("Keyslot priority: ignore, normal, prefer"), NULL, CRYPT_ARG_STRING, {}, OPT_PRIORITY_ACTIONS) + +ARG(OPT_PROGRESS_FREQUENCY, '\0', POPT_ARG_STRING, N_("Progress line update (in seconds)"), N_("secs"), CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_READONLY, 'r', POPT_ARG_NONE, N_("Create a readonly mapping"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_REDUCE_DEVICE_SIZE, '\0', POPT_ARG_STRING, N_("Reduce data device size (move data offset). DANGEROUS!"), N_("bytes"), CRYPT_ARG_UINT64, {}, {}) + +ARG(OPT_REFRESH, '\0', POPT_ARG_NONE, N_("Refresh (reactivate) device with new parameters"), NULL, CRYPT_ARG_BOOL, {}, OPT_REFRESH_ACTIONS) + +ARG(OPT_RESILIENCE, '\0', POPT_ARG_STRING, N_("Reencryption hotzone resilience type (checksum,journal,none)"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_RESILIENCE_HASH, '\0', POPT_ARG_STRING, N_("Reencryption hotzone checksums hash"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_RESUME_ONLY, '\0', POPT_ARG_NONE, N_("Resume initialized LUKS2 reencryption only."), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_SECTOR_SIZE, '\0', POPT_ARG_STRING, N_("Encryption sector size (default: 512 bytes)"), NULL, CRYPT_ARG_UINT32, {}, OPT_SECTOR_SIZE_ACTIONS) + +ARG(OPT_SERIALIZE_MEMORY_HARD_PBKDF, '\0', POPT_ARG_NONE, N_("Use global lock to serialize memory hard PBKDF (OOM workaround)"), NULL, CRYPT_ARG_BOOL, {}, OPT_SERIALIZE_MEMORY_HARD_PBKDF_ACTIONS) + +ARG(OPT_SHARED, '\0', POPT_ARG_NONE, N_("Share device with another non-overlapping crypt segment"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_SIZE, 'b', POPT_ARG_STRING, N_("The size of the device"), N_("SECTORS"), CRYPT_ARG_UINT64, {}, {}) + +ARG(OPT_SKIP, 'p', POPT_ARG_STRING, N_("How many sectors of the encrypted data to skip at the beginning"), N_("SECTORS"), CRYPT_ARG_UINT64, {}, OPT_SKIP_ACTIONS) + +ARG(OPT_SUBSYSTEM, '\0', POPT_ARG_STRING, N_("Set subsystem label for the LUKS2 device"), NULL, CRYPT_ARG_STRING, {}, OPT_SUBSYSTEM_ACTIONS) + +ARG(OPT_TCRYPT_BACKUP, '\0', POPT_ARG_NONE, N_("Use backup (secondary) TCRYPT header"), NULL, CRYPT_ARG_BOOL, {}, OPT_TCRYPT_BACKUP_ACTIONS) + +ARG(OPT_TCRYPT_HIDDEN, '\0', POPT_ARG_NONE, N_("Use hidden header (hidden TCRYPT device)"), NULL, CRYPT_ARG_BOOL, {}, OPT_TCRYPT_HIDDEN_ACTIONS) + +ARG(OPT_TCRYPT_SYSTEM, '\0', POPT_ARG_NONE, N_("Device is system TCRYPT drive (with bootloader)"), NULL, CRYPT_ARG_BOOL, {}, OPT_TCRYPT_SYSTEM_ACTIONS) + +ARG(OPT_TEST_ARGS, '\0', POPT_ARG_NONE, N_("Do not run action, just validate all command line parameters"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_TEST_PASSPHRASE, '\0', POPT_ARG_NONE, N_("Do not activate device, just check passphrase"), NULL, CRYPT_ARG_BOOL, {}, OPT_TEST_PASSPHRASE_ACTIONS) + +ARG(OPT_TIMEOUT, 't', POPT_ARG_STRING, N_("Timeout for interactive passphrase prompt (in seconds)"), N_("secs"), CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_TOKEN_ID, '\0', POPT_ARG_STRING, N_("Token number (default: any)"), NULL, CRYPT_ARG_INT32, { .i32_value = CRYPT_ANY_TOKEN }, {}) + +ARG(OPT_TOKEN_ONLY, '\0', POPT_ARG_NONE, N_("Do not ask for passphrase if activation by token fails"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_TRIES, 'T', POPT_ARG_STRING, N_("How often the input of the passphrase can be retried"), NULL, CRYPT_ARG_UINT32, { .u32_value = 3 }, {}) + +ARG(OPT_TYPE, 'M', POPT_ARG_STRING, N_("Type of device metadata: luks, luks1, luks2, plain, loopaes, tcrypt, bitlk"), NULL, CRYPT_ARG_STRING, {}, {}) + +ARG(OPT_UNBOUND, '\0', POPT_ARG_NONE, N_("Create or dump unbound (no assigned data segment) LUKS2 keyslot"), NULL, CRYPT_ARG_BOOL, {}, OPT_UNBOUND_ACTIONS) + +ARG(OPT_USE_RANDOM, '\0', POPT_ARG_NONE, N_("Use /dev/random for generating volume key"), NULL, CRYPT_ARG_BOOL, {}, OPT_USE_RANDOM_ACTIONS) + +ARG(OPT_USE_URANDOM, '\0', POPT_ARG_NONE, N_("Use /dev/urandom for generating volume key"), NULL, CRYPT_ARG_BOOL, {}, OPT_USE_URANDOM_ACTIONS) + +ARG(OPT_UUID, '\0', POPT_ARG_STRING, N_("UUID for device to use"), NULL, CRYPT_ARG_STRING, {}, OPT_UUID_ACTIONS) + +ARG(OPT_VERACRYPT, '\0', POPT_ARG_NONE, N_("Scan also for VeraCrypt compatible device"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_VERACRYPT_PIM, '\0', POPT_ARG_STRING, N_("Personal Iteration Multiplier for VeraCrypt compatible device"), NULL, CRYPT_ARG_UINT32, {}, {}) + +ARG(OPT_VERACRYPT_QUERY_PIM, '\0', POPT_ARG_NONE, N_("Query Personal Iteration Multiplier for VeraCrypt compatible device"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_VERBOSE, 'v', POPT_ARG_NONE, N_("Shows more detailed error messages"), NULL, CRYPT_ARG_BOOL, {}, {}) + +ARG(OPT_VERIFY_PASSPHRASE, 'y', POPT_ARG_NONE, N_("Verifies the passphrase by asking for it twice"), NULL, CRYPT_ARG_BOOL, {}, {}) diff --git a/src/cryptsetup_args.h b/src/cryptsetup_args.h new file mode 100644 index 00000000..03e84ed9 --- /dev/null +++ b/src/cryptsetup_args.h @@ -0,0 +1,107 @@ +/* + * Command line arguments helpers + * + * Copyright (C) 2020 Red Hat, Inc. All rights reserved. + * Copyright (C) 2020 Ondrej Kozina + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef CRYPTSETUP_ARGS_H +#define CRYPTSETUP_ARGS_H + +#include "utils_arg_names.h" +#include "utils_arg_macros.h" + +#define BITLKDUMP_ACTION "bitlkDump" +#define BENCHMARK_ACTION "benchmark" +#define CLOSE_ACTION "close" +#define CONFIG_ACTION "config" +#define CONVERT_ACTION "convert" +#define ERASE_ACTION "erase" +#define ISLUKS_ACTION "isLuks" +#define ADDKEY_ACTION "luksAddKey" +#define CHANGEKEY_ACTION "luksChangeKey" +#define CONVERTKEY_ACTION "luksConvertKey" +#define LUKSDUMP_ACTION "luksDump" +#define FORMAT_ACTION "luksFormat" +#define HEADERBACKUP_ACTION "luksHeaderBackup" +#define HEADERRESTORE_ACTION "luksHeaderRestore" +#define KILLKEY_ACTION "luksKillSlot" +#define REMOVEKEY_ACTION "luksRemoveKey" +#define RESUME_ACTION "luksResume" +#define SUSPEND_ACTION "luksSuspend" +#define UUID_ACTION "luksUUID" +#define OPEN_ACTION "open" +#define REENCRYPT_ACTION "reencrypt" +#define REPAIR_ACTION "repair" +#define RESIZE_ACTION "resize" +#define STATUS_ACTION "status" +#define TCRYPTDUMP_ACTION "tcryptDump" +#define TOKEN_ACTION "token" + +/* avoid unshielded commas in ARG() macros later */ +#define OPT_ALIGN_PAYLOAD_ACTIONS { FORMAT_ACTION } +#define OPT_ALLOW_DISCARDS_ACTIONS { OPEN_ACTION } +#define OPT_DEFERRED_ACTIONS { CLOSE_ACTION } +#define OPT_HOTZONE_SIZE_ACTIONS { REENCRYPT_ACTION } +#define OPT_INTEGRITY_ACTIONS { FORMAT_ACTION } +#define OPT_KEY_SIZE_ACTIONS { OPEN_ACTION, BENCHMARK_ACTION, FORMAT_ACTION, REENCRYPT_ACTION, ADDKEY_ACTION } +#define OPT_KEY_SLOT_ACTIONS { OPEN_ACTION, REENCRYPT_ACTION, CONFIG_ACTION, FORMAT_ACTION, ADDKEY_ACTION, CHANGEKEY_ACTION, CONVERTKEY_ACTION, LUKSDUMP_ACTION, TOKEN_ACTION } +#define OPT_LABEL_ACTIONS { CONFIG_ACTION, FORMAT_ACTION } +#define OPT_LUKS2_KEYSLOTS_SIZE_ACTIONS { REENCRYPT_ACTION, FORMAT_ACTION } +#define OPT_LUKS2_METADATA_SIZE_ACTIONS { REENCRYPT_ACTION, FORMAT_ACTION } +#define OPT_OFFSET_ACTIONS { OPEN_ACTION, REENCRYPT_ACTION, FORMAT_ACTION } +#define OPT_PERSISTENT_ACTIONS { OPEN_ACTION } +#define OPT_PRIORITY_ACTIONS { CONFIG_ACTION } +#define OPT_REFRESH_ACTIONS { OPEN_ACTION } +#define OPT_SECTOR_SIZE_ACTIONS { OPEN_ACTION, REENCRYPT_ACTION, FORMAT_ACTION } +#define OPT_SERIALIZE_MEMORY_HARD_PBKDF_ACTIONS { OPEN_ACTION } +#define OPT_SKIP_ACTIONS { OPEN_ACTION } +#define OPT_SUBSYSTEM_ACTIONS { CONFIG_ACTION, FORMAT_ACTION } +#define OPT_TCRYPT_BACKUP_ACTIONS { OPEN_ACTION, TCRYPTDUMP_ACTION } +#define OPT_TCRYPT_HIDDEN_ACTIONS { OPEN_ACTION, TCRYPTDUMP_ACTION } +#define OPT_TCRYPT_SYSTEM_ACTIONS { OPEN_ACTION, TCRYPTDUMP_ACTION } +#define OPT_TEST_PASSPHRASE_ACTIONS { OPEN_ACTION } +#define OPT_UNBOUND_ACTIONS { ADDKEY_ACTION, LUKSDUMP_ACTION } +#define OPT_USE_RANDOM_ACTIONS { FORMAT_ACTION } +#define OPT_USE_URANDOM_ACTIONS { FORMAT_ACTION } +#define OPT_UUID_ACTIONS { FORMAT_ACTION, UUID_ACTION } + +enum { +OPT_UNUSED_ID = 0, /* leave unused due to popt library */ +#define ARG(A, B, C, D, E, F, G, H) A ## _ID, +#include "cryptsetup_arg_list.h" +#undef ARG +}; + +static struct tools_arg tool_core_args[] = { { NULL, false, CRYPT_ARG_BOOL }, /* leave unused due to popt library */ +#define ARG(A, B, C, D, E, F, G, H) { A, false, F, G, H }, +#include "cryptsetup_arg_list.h" +#undef ARG +}; + +static inline void args_reset_default_values(struct tools_arg *args) +{ + struct tools_arg tmp[] = { { NULL, false, CRYPT_ARG_BOOL }, // UNUSED + #define ARG(A, B, C, D, E, F, G, H ) { A, false, F, G, H }, + #include "cryptsetup_arg_list.h" + #undef ARG + }; + + memcpy(args, tmp, sizeof(tmp)); +} + +#endif