diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-06 00:31:19 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-06 00:31:19 +0000 |
commit | 6e33fee6f4a7e2041dd276995b402ca036fcab14 (patch) | |
tree | 85be5c41f2715d7d4d24cfa220197f1e2c778259 /src | |
parent | Initial commit. (diff) | |
download | cryptsetup-upstream/2%2.1.0.tar.xz cryptsetup-upstream/2%2.1.0.zip |
Adding upstream version 2:2.1.0.upstream/2%2.1.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src')
-rw-r--r-- | src/Makemodule.am | 131 | ||||
-rw-r--r-- | src/cryptsetup.c | 2964 | ||||
-rw-r--r-- | src/cryptsetup.h | 122 | ||||
-rw-r--r-- | src/cryptsetup_reencrypt.c | 1761 | ||||
-rw-r--r-- | src/integritysetup.c | 688 | ||||
-rw-r--r-- | src/utils_luks2.c | 139 | ||||
-rw-r--r-- | src/utils_password.c | 331 | ||||
-rw-r--r-- | src/utils_tools.c | 594 | ||||
-rw-r--r-- | src/veritysetup.c | 567 |
9 files changed, 7297 insertions, 0 deletions
diff --git a/src/Makemodule.am b/src/Makemodule.am new file mode 100644 index 0000000..3510f20 --- /dev/null +++ b/src/Makemodule.am @@ -0,0 +1,131 @@ +# cryptsetup +if CRYPTSETUP + +cryptsetup_SOURCES = \ + lib/utils_crypt.c \ + lib/utils_loop.c \ + lib/utils_io.c \ + lib/utils_blkid.c \ + src/utils_tools.c \ + src/utils_password.c \ + src/utils_luks2.c \ + src/cryptsetup.c \ + src/cryptsetup.h + +cryptsetup_LDADD = -lm \ + libcryptsetup.la \ + @POPT_LIBS@ \ + @PWQUALITY_LIBS@ \ + @PASSWDQC_LIBS@ \ + @UUID_LIBS@ \ + @BLKID_LIBS@ + +sbin_PROGRAMS += cryptsetup + +if STATIC_TOOLS +sbin_PROGRAMS += cryptsetup.static +cryptsetup_static_SOURCES = $(cryptsetup_SOURCES) +cryptsetup_static_LDFLAGS = $(AM_LDFLAGS) -all-static +cryptsetup_static_LDADD = \ + $(cryptsetup_LDADD) \ + @CRYPTO_STATIC_LIBS@ \ + @PWQUALITY_STATIC_LIBS@ \ + @DEVMAPPER_STATIC_LIBS@ +endif +endif + +# veritysetup +if VERITYSETUP + +veritysetup_SOURCES = \ + lib/utils_crypt.c \ + lib/utils_loop.c \ + lib/utils_io.c \ + lib/utils_blkid.c \ + src/utils_tools.c \ + src/veritysetup.c \ + src/cryptsetup.h + +veritysetup_LDADD = -lm \ + libcryptsetup.la \ + @POPT_LIBS@ \ + @BLKID_LIBS@ + +sbin_PROGRAMS += veritysetup + +if STATIC_TOOLS +sbin_PROGRAMS += veritysetup.static +veritysetup_static_SOURCES = $(veritysetup_SOURCES) +veritysetup_static_LDFLAGS = $(AM_LDFLAGS) -all-static +veritysetup_static_LDADD = \ + $(veritysetup_LDADD) \ + @CRYPTO_STATIC_LIBS@ \ + @DEVMAPPER_STATIC_LIBS@ \ + @UUID_LIBS@ +endif +endif + +# integritysetup +if INTEGRITYSETUP + +integritysetup_SOURCES = \ + lib/utils_crypt.c \ + lib/utils_loop.c \ + lib/utils_io.c \ + lib/utils_blkid.c \ + src/utils_tools.c \ + src/integritysetup.c \ + src/cryptsetup.h + +integritysetup_LDADD = -lm \ + libcryptsetup.la \ + @POPT_LIBS@ \ + @UUID_LIBS@ \ + @BLKID_LIBS@ + +sbin_PROGRAMS += integritysetup + +if STATIC_TOOLS +sbin_PROGRAMS += integritysetup.static +integritysetup_static_SOURCES = $(integritysetup_SOURCES) +integritysetup_static_LDFLAGS = $(AM_LDFLAGS) -all-static +integritysetup_static_LDADD = \ + $(integritysetup_LDADD) \ + @CRYPTO_STATIC_LIBS@ \ + @DEVMAPPER_STATIC_LIBS@ \ + @UUID_LIBS@ +endif +endif + +# reencrypt +if REENCRYPT +cryptsetup_reencrypt_SOURCES = \ + lib/utils_crypt.c \ + lib/utils_io.c \ + lib/utils_blkid.c \ + src/utils_tools.c \ + src/utils_password.c \ + src/cryptsetup_reencrypt.c \ + src/cryptsetup.h + +cryptsetup_reencrypt_LDADD = -lm \ + libcryptsetup.la \ + @POPT_LIBS@ \ + @PWQUALITY_LIBS@ \ + @PASSWDQC_LIBS@ \ + @UUID_LIBS@ \ + @BLKID_LIBS@ + +sbin_PROGRAMS += cryptsetup-reencrypt + +if STATIC_TOOLS +sbin_PROGRAMS += cryptsetup-reencrypt.static +cryptsetup_reencrypt_static_SOURCES = $(cryptsetup_reencrypt_SOURCES) +cryptsetup_reencrypt_static_LDFLAGS = $(AM_LDFLAGS) -all-static +cryptsetup_reencrypt_static_LDADD = \ + $(cryptsetup_reencrypt_LDADD) \ + @CRYPTO_STATIC_LIBS@ \ + @PWQUALITY_STATIC_LIBS@ \ + @DEVMAPPER_STATIC_LIBS@ +endif +endif diff --git a/src/cryptsetup.c b/src/cryptsetup.c new file mode 100644 index 0000000..13aa656 --- /dev/null +++ b/src/cryptsetup.c @@ -0,0 +1,2964 @@ +/* + * cryptsetup - setup cryptographic volumes for dm-crypt + * + * Copyright (C) 2004 Jana Saout <jana@saout.de> + * Copyright (C) 2004-2007 Clemens Fruhwirth <clemens@endorphin.org> + * Copyright (C) 2009-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2009-2019 Milan Broz + * + * 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. + */ + +#include "cryptsetup.h" +#include <uuid/uuid.h> + +static const char *opt_cipher = NULL; +static const char *opt_keyslot_cipher = NULL; +static const char *opt_hash = NULL; +static int opt_verify_passphrase = 0; + +static const char *opt_json_file = NULL; +static const char *opt_key_file = NULL; +static const char *opt_keyfile_stdin = NULL; +static int opt_keyfiles_count = 0; +static const char *opt_keyfiles[MAX_KEYFILES]; + +static const char *opt_master_key_file = NULL; +static const char *opt_header_backup_file = NULL; +static const char *opt_uuid = NULL; +static const char *opt_header_device = NULL; +static const char *opt_type = "luks"; +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_version_mode = 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; +//FIXME: check uint32 overflow for long type +static const char *opt_pbkdf = NULL; +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 const char *opt_priority = NULL; /* normal */ +static const char *opt_integrity = NULL; /* none */ +static int opt_integrity_nojournal = 0; +static int opt_integrity_no_wipe = 0; +static const char *opt_key_description = NULL; +static int opt_sector_size = SECTOR_SIZE; +static int opt_persistent = 0; +static const char *opt_label = NULL; +static const char *opt_subsystem = NULL; +static int opt_unbound = 0; +static int opt_refresh = 0; + +static const char *opt_luks2_metadata_size_str = NULL; +static uint64_t opt_luks2_metadata_size = 0; +static const char *opt_luks2_keyslots_size_str = NULL; +static uint64_t opt_luks2_keyslots_size = 0; + +static const char **action_argv; +static int action_argc; +static const char *null_action_argv[] = {NULL, NULL}; + +static const char *uuid_or_device_header(const char **data_device) +{ + if (data_device) + *data_device = opt_header_device ? action_argv[0] : NULL; + + return uuid_or_device(opt_header_device ?: action_argv[0]); +} + +static const char *luksType(const char *type) +{ + if (type && !strcmp(type, "luks2")) + return CRYPT_LUKS2; + + if (type && !strcmp(type, "luks1")) + return CRYPT_LUKS1; + + if (type && !strcmp(type, "luks")) + return CRYPT_LUKS; /* NULL */ + + if (type && *type) + return type; + + return CRYPT_LUKS; /* NULL */ +} + +static int _verify_passphrase(int def) +{ + /* Batch mode switch off verify - if not overridden by -y */ + if (opt_verify_passphrase) + def = 1; + else if (opt_batch_mode) + def = 0; + + /* Non-tty input doesn't allow verify */ + if (def && !isatty(STDIN_FILENO)) { + if (opt_verify_passphrase) + log_err(_("Can't do passphrase verification on non-tty inputs.")); + def = 0; + } + + return def; +} + +static void _set_activation_flags(uint32_t *flags) +{ + if (opt_readonly) + *flags |= CRYPT_ACTIVATE_READONLY; + + if (opt_allow_discards) + *flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS; + + if (opt_perf_same_cpu_crypt) + *flags |= CRYPT_ACTIVATE_SAME_CPU_CRYPT; + + if (opt_perf_submit_from_crypt_cpus) + *flags |= CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS; + + if (opt_integrity_nojournal) + *flags |= CRYPT_ACTIVATE_NO_JOURNAL; + + /* In persistent mode, we use what is set on command line */ + if (opt_persistent) + *flags |= CRYPT_ACTIVATE_IGNORE_PERSISTENT; + + /* Only for LUKS2 but ignored elsewhere */ + if (opt_test_passphrase) + *flags |= CRYPT_ACTIVATE_ALLOW_UNBOUND_KEY; +} + +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) + return 0; + + if (!type || strcmp(type, CRYPT_LUKS2)) { + log_err(_("Keyslot encryption parameters can be set only for LUKS2 device.")); + return -EINVAL; + } + + return crypt_keyslot_set_encryption(cd, opt_keyslot_cipher, opt_keyslot_key_size / 8); +} + +static int action_open_plain(void) +{ + struct crypt_device *cd = NULL, *cd1 = NULL; + const char *pcipher, *pmode; + 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, + }; + 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; + uint32_t activate_flags = 0; + int r; + + r = crypt_parse_name_and_mode(opt_cipher ?: DEFAULT_CIPHER(PLAIN), + cipher, NULL, cipher_mode); + if (r < 0) { + log_err(_("No known cipher specification pattern detected.")); + goto out; + } + + /* FIXME: temporary hack, no hashing for keyfiles in plain mode */ + if (opt_key_file && !tools_is_stdin(opt_key_file)) { + params.hash = NULL; + if (!opt_batch_mode && opt_hash) + log_std(_("WARNING: The --hash parameter is being ignored " + "in plain mode with keyfile specified.\n")); + } + + 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) + 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) { + activated_name = action_argc > 1 ? action_argv[1] : action_argv[0]; + r = crypt_init_by_name_and_header(&cd1, activated_name, NULL); + if (r) + goto out; + r = crypt_get_active_device(cd1, activated_name, &cad); + if (r) + goto out; + + /* copy known parameters from existing device */ + params.skip = crypt_get_iv_offset(cd1); + params.offset = crypt_get_data_offset(cd1); + params.size = cad.size; + params.sector_size = crypt_get_sector_size(cd1); + key_size = crypt_get_volume_key_size(cd1); + + if ((r = crypt_init(&cd, crypt_get_device_name(cd1)))) + goto out; + + activate_flags |= CRYPT_ACTIVATE_REFRESH; + + pcipher = crypt_get_cipher(cd1); + pmode = crypt_get_cipher_mode(cd1); + } else { + activated_name = action_argv[1]; + if ((r = crypt_init(&cd, action_argv[0]))) + goto out; + + /* Skip blkid scan when activating plain device with offset */ + if (!opt_offset) { + /* Print all present signatures in read-only mode */ + r = tools_detect_signatures(action_argv[0], 0, &signatures); + if (r < 0) + goto out; + } + + if (signatures) { + r = asprintf(&msg, _("Detected device signature(s) on %s. Proceeding further may damage existing data."), action_argv[0]); + if (r == -1) { + r = -ENOMEM; + goto out; + } + + r = yesDialog(msg, _("Operation aborted.\n")) ? 0 : -EINVAL; + free(msg); + if (r < 0) + goto out; + } + + pcipher = cipher; + pmode = cipher_mode; + } + + r = crypt_format(cd, CRYPT_PLAIN, + pcipher, pmode, + NULL, NULL, + key_size, + ¶ms); + check_signal(&r); + if (r < 0) + goto out; + + if (opt_shared) + activate_flags |= CRYPT_ACTIVATE_SHARED; + + _set_activation_flags(&activate_flags); + + if (!tools_is_stdin(opt_key_file)) { + /* 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. + */ + key_size_max = params.hash ? (size_t)opt_keyfile_size : 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); + } else { + key_size_max = (opt_key_file && !params.hash) ? key_size : (size_t)opt_keyfile_size; + r = tools_get_key(NULL, &password, &passwordLen, + opt_keyfile_offset, key_size_max, + opt_key_file, opt_timeout, + _verify_passphrase(0), 0, cd); + if (r < 0) + goto out; + + r = crypt_activate_by_passphrase(cd, activated_name, + CRYPT_ANY_SLOT, password, passwordLen, activate_flags); + } +out: + crypt_free(cd); + crypt_free(cd1); + crypt_safe_free(password); + + return r; +} + +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, + }; + unsigned int key_size = (opt_key_size ?: DEFAULT_LOOPAES_KEYBITS) / 8; + uint32_t activate_flags = 0; + const char *activated_name = NULL; + int r; + + if (!opt_key_file) { + log_err(_("Option --key-file is required.")); + return -EINVAL; + } + + if (opt_refresh) { + activated_name = action_argc > 1 ? action_argv[1] : action_argv[0]; + if ((r = crypt_init_by_name(&cd, activated_name))) + goto out; + activate_flags |= CRYPT_ACTIVATE_REFRESH; + } else { + activated_name = action_argv[1]; + if ((r = crypt_init(&cd, action_argv[0]))) + goto out; + + r = crypt_format(cd, CRYPT_LOOPAES, opt_cipher ?: DEFAULT_LOOPAES_CIPHER, + NULL, NULL, NULL, key_size, ¶ms); + check_signal(&r); + if (r < 0) + goto out; + } + + _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); +out: + crypt_free(cd); + + return r; +} + +static int tcrypt_load(struct crypt_device *cd, struct crypt_params_tcrypt *params) +{ + int r, tries = opt_tries, eperm = 0; + + if (opt_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, + _verify_passphrase(0), 0, cd); + if (r < 0) + continue; + + if (opt_veracrypt_query_pim) { + char *tmp_pim_nptr = NULL; + char *tmp_pim_end = NULL; + size_t tmp_pim_size = 0; + unsigned long long tmp_pim_ull = 0; + + r = tools_get_key(_("Enter VeraCrypt PIM: "), + CONST_CAST(char**)&tmp_pim_nptr, + &tmp_pim_size, 0, 0, opt_keyfile_stdin, opt_timeout, + _verify_passphrase(0), 0, cd); + if (r < 0) + continue; + + tmp_pim_ull = strtoull(tmp_pim_nptr, &tmp_pim_end, 10); + if (*tmp_pim_nptr == '\0' || !tmp_pim_end || *tmp_pim_end != '\0') { + log_err(_("Invalid PIM value: parse error.")); + r = -EINVAL; + } else if (tmp_pim_ull == 0) { + log_err(_("Invalid PIM value: 0.")); + r = -EINVAL; + } else if (tmp_pim_ull > UINT32_MAX) { + log_err(_("Invalid PIM value: outside of range.")); + r = -ERANGE; + } + crypt_safe_free(CONST_CAST(char*)tmp_pim_nptr); + if (r < 0) + continue; + + params->veracrypt_pim = (uint32_t)tmp_pim_ull; + crypt_memzero(&tmp_pim_ull, sizeof(tmp_pim_ull)); + } + + if (opt_tcrypt_hidden) + params->flags |= CRYPT_TCRYPT_HIDDEN_HEADER; + + if (opt_tcrypt_system) + params->flags |= CRYPT_TCRYPT_SYSTEM_HEADER; + + if (opt_tcrypt_backup) + params->flags |= CRYPT_TCRYPT_BACKUP_HEADER; + + r = crypt_load(cd, CRYPT_TCRYPT, params); + + if (r == -EPERM) { + log_err(_("No device header detected with this passphrase.")); + eperm = 1; + } + + if (r < 0) { + crypt_safe_free(CONST_CAST(char*)params->passphrase); + params->passphrase = NULL; + params->passphrase_size = 0; + } + check_signal(&r); + } while ((r == -EPERM || r == -ERANGE) && (--tries > 0)); + + /* Report wrong passphrase if at least one try failed */ + if (eperm && r == -EPIPE) + r = -EPERM; + + return r; +} + +static int action_open_tcrypt(void) +{ + struct crypt_device *cd = NULL; + struct crypt_params_tcrypt params = { + .keyfiles = opt_keyfiles, + .keyfiles_count = opt_keyfiles_count, + .flags = CRYPT_TCRYPT_LEGACY_MODES | + (opt_veracrypt ? CRYPT_TCRYPT_VERA_MODES : 0), + .veracrypt_pim = (opt_veracrypt_pim > 0) ? opt_veracrypt_pim : 0, + }; + const char *activated_name; + uint32_t activate_flags = 0; + int r; + + activated_name = opt_test_passphrase ? NULL : action_argv[1]; + + if ((r = crypt_init(&cd, action_argv[0]))) + goto out; + + r = tcrypt_load(cd, ¶ms); + if (r < 0) + goto out; + + _set_activation_flags(&activate_flags); + + if (activated_name) + r = crypt_activate_by_volume_key(cd, activated_name, NULL, 0, activate_flags); +out: + crypt_free(cd); + crypt_safe_free(CONST_CAST(char*)params.passphrase); + crypt_memzero(¶ms.veracrypt_pim, sizeof(params.veracrypt_pim)); + return r; +} + +static int tcryptDump_with_volume_key(struct crypt_device *cd) +{ + char *vk = NULL; + size_t vk_size; + unsigned i; + int r; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + if (!yesDialog( + _("Header dump with volume key is sensitive information\n" + "which allows access to encrypted partition without passphrase.\n" + "This dump should be always stored encrypted on safe place."), + NULL)) + return -EPERM; + + vk_size = crypt_get_volume_key_size(cd); + vk = crypt_safe_alloc(vk_size); + if (!vk) + return -ENOMEM; + + r = crypt_volume_key_get(cd, CRYPT_ANY_SLOT, vk, &vk_size, NULL, 0); + if (r < 0) + goto out; + + log_std("TCRYPT header information for %s\n", crypt_get_device_name(cd)); + log_std("Cipher chain: \t%s\n", crypt_get_cipher(cd)); + log_std("Cipher mode: \t%s\n", crypt_get_cipher_mode(cd)); + log_std("Payload offset:\t%d\n", (int)crypt_get_data_offset(cd)); + log_std("MK bits: \t%d\n", (int)vk_size * 8); + log_std("MK dump:\t"); + + for(i = 0; i < vk_size; i++) { + if (i && !(i % 16)) + log_std("\n\t\t"); + log_std("%02hhx ", (char)vk[i]); + } + log_std("\n"); +out: + crypt_safe_free(vk); + return r; +} + +static int action_tcryptDump(void) +{ + struct crypt_device *cd = NULL; + struct crypt_params_tcrypt params = { + .keyfiles = opt_keyfiles, + .keyfiles_count = opt_keyfiles_count, + .flags = CRYPT_TCRYPT_LEGACY_MODES | + (opt_veracrypt ? CRYPT_TCRYPT_VERA_MODES : 0), + .veracrypt_pim = (opt_veracrypt_pim > 0) ? opt_veracrypt_pim : 0, + }; + int r; + + if ((r = crypt_init(&cd, action_argv[0]))) + goto out; + + r = tcrypt_load(cd, ¶ms); + if (r < 0) + goto out; + + if (opt_dump_master_key) + r = tcryptDump_with_volume_key(cd); + else + r = crypt_dump(cd); +out: + crypt_free(cd); + crypt_safe_free(CONST_CAST(char*)params.passphrase); + return r; +} + +static int action_close(void) +{ + struct crypt_device *cd = NULL; + crypt_status_info ci; + uint32_t flags = 0; + int r; + + if (opt_deferred_remove) + 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) { + 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"), + action_argv[0]); + } + + crypt_free(cd); + return r; +} + +static int action_resize(void) +{ + int r; + size_t passwordLen; + struct crypt_active_device cad; + char *password = NULL; + struct crypt_device *cd = NULL; + + r = crypt_init_by_name_and_header(&cd, action_argv[0], opt_header_device); + if (r) + goto out; + + /* FIXME: LUKS2 may enforce fixed size and it must not be changed */ + r = crypt_get_active_device(cd, action_argv[0], &cad); + if (r) + goto out; + + if (cad.flags & CRYPT_ACTIVATE_KEYRING_KEY) { + if (opt_disable_keyring) { + r = -EINVAL; + log_err(_("Resize of active device requires volume key " + "in keyring but --disable-keyring option is set.")); + goto out; + } + + /* try load VK in kernel keyring using token */ + r = crypt_activate_by_token(cd, NULL, opt_token, NULL, + CRYPT_ACTIVATE_KEYRING_KEY); + tools_keyslot_msg(r, UNLOCKED); + if (r < 0 && opt_token_only) + 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); + if (r < 0) + goto out; + + r = crypt_activate_by_passphrase(cd, NULL, opt_key_slot, + password, passwordLen, + CRYPT_ACTIVATE_KEYRING_KEY); + tools_passphrase_msg(r); + tools_keyslot_msg(r, UNLOCKED); + crypt_safe_free(password); + } + + if (r >= 0) + r = crypt_resize(cd, action_argv[0], opt_size); +out: + crypt_free(cd); + return r; +} + +static int action_status(void) +{ + crypt_status_info ci; + struct crypt_active_device cad; + struct crypt_params_integrity ip = {}; + struct crypt_device *cd = NULL; + char *backing_file; + const char *device; + int path = 0, r = 0; + + /* perhaps a path, not a dm device name */ + if (strchr(action_argv[0], '/')) + path = 1; + + ci = crypt_status(NULL, action_argv[0]); + switch (ci) { + case CRYPT_INVALID: + r = -EINVAL; + break; + case CRYPT_INACTIVE: + if (path) + log_std("%s is inactive.\n", action_argv[0]); + else + log_std("%s/%s is inactive.\n", crypt_get_dir(), action_argv[0]); + r = -ENODEV; + break; + case CRYPT_ACTIVE: + case CRYPT_BUSY: + if (path) + log_std("%s is active%s.\n", action_argv[0], + ci == CRYPT_BUSY ? " and is in use" : ""); + else + 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); + if (r < 0) + goto out; + + log_std(" type: %s\n", crypt_get_type(cd) ?: "n/a"); + + r = crypt_get_active_device(cd, action_argv[0], &cad); + if (r < 0) + goto out; + + r = crypt_get_integrity_info(cd, &ip); + if (r < 0 && r != -ENOTSUP) + goto out; + + log_std(" cipher: %s-%s\n", crypt_get_cipher(cd), crypt_get_cipher_mode(cd)); + log_std(" keysize: %d bits\n", crypt_get_volume_key_size(cd) * 8); + log_std(" key location: %s\n", (cad.flags & CRYPT_ACTIVATE_KEYRING_KEY) ? "keyring" : "dm-crypt"); + if (ip.integrity) + log_std(" integrity: %s\n", ip.integrity); + if (ip.integrity_key_size) + log_std(" integrity keysize: %d bits\n", ip.integrity_key_size * 8); + device = crypt_get_device_name(cd); + log_std(" device: %s\n", device); + if (crypt_loop_device(device)) { + backing_file = crypt_loop_backing_file(device); + log_std(" loop: %s\n", backing_file); + free(backing_file); + } + log_std(" sector size: %d\n", crypt_get_sector_size(cd)); + log_std(" offset: %" PRIu64 " sectors\n", cad.offset); + log_std(" size: %" PRIu64 " sectors\n", cad.size); + if (cad.iv_offset) + log_std(" skipped: %" PRIu64 " sectors\n", cad.iv_offset); + log_std(" mode: %s\n", cad.flags & CRYPT_ACTIVATE_READONLY ? + "readonly" : "read/write"); + if (cad.flags & (CRYPT_ACTIVATE_ALLOW_DISCARDS| + CRYPT_ACTIVATE_SAME_CPU_CRYPT| + CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS)) + log_std(" flags: %s%s%s\n", + (cad.flags & CRYPT_ACTIVATE_ALLOW_DISCARDS) ? "discards " : "", + (cad.flags & CRYPT_ACTIVATE_SAME_CPU_CRYPT) ? "same_cpu_crypt " : "", + (cad.flags & CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS) ? "submit_from_crypt_cpus" : ""); + } +out: + crypt_free(cd); + if (r == -ENOTSUP) + r = 0; + return r; +} + +static int benchmark_callback(uint32_t time_ms, void *usrptr) +{ + struct crypt_pbkdf_type *pbkdf = usrptr; + int r = 0; + + check_signal(&r); + if (r) + log_err(_("Benchmark interrupted.")); + else + log_dbg("PBKDF benchmark: memory cost = %u, iterations = %u, " + "threads = %u (took %u ms)", pbkdf->max_memory_kb, + pbkdf->iterations, pbkdf->parallel_threads, time_ms); + return r; +} + +static int action_benchmark_kdf(const char *kdf, const char *hash, size_t key_size) +{ + int r; + if (!strcmp(kdf, CRYPT_KDF_PBKDF2)) { + struct crypt_pbkdf_type pbkdf = { + .type = CRYPT_KDF_PBKDF2, + .hash = hash, + .time_ms = 1000, + }; + + r = crypt_benchmark_pbkdf(NULL, &pbkdf, "foo", 3, "bar", 3, key_size, + &benchmark_callback, &pbkdf); + if (r < 0) + log_std(_("PBKDF2-%-9s N/A\n"), hash); + else + log_std(_("PBKDF2-%-9s %7u iterations per second for %zu-bit key\n"), + hash, pbkdf.iterations, key_size * 8); + } 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, + }; + + r = crypt_benchmark_pbkdf(NULL, &pbkdf, "foo", 3, + "0123456789abcdef0123456789abcdef", 32, + key_size, &benchmark_callback, &pbkdf); + if (r < 0) + log_std(_("%-10s N/A\n"), kdf); + else + log_std(_("%-10s %4u iterations, %5u memory, " + "%1u parallel threads (CPUs) for " + "%zu-bit key (requested %u ms time)\n"), kdf, + pbkdf.iterations, pbkdf.max_memory_kb, pbkdf.parallel_threads, + key_size * 8, pbkdf.time_ms); + } + + return r; +} + +static int benchmark_cipher_loop(const char *cipher, const char *cipher_mode, + size_t volume_key_size, size_t iv_size, + double *encryption_mbs, double *decryption_mbs) +{ + int r, buffer_size = 1024 * 1024; + + do { + r = crypt_benchmark(NULL, cipher, cipher_mode, + volume_key_size, iv_size, buffer_size, + encryption_mbs, decryption_mbs); + if (r == -ERANGE) { + if (buffer_size < 1024 * 1024 * 65) + buffer_size *= 2; + else { + log_err(_("Result of benchmark is not reliable.")); + r = -ENOENT; + } + } + } while (r == -ERANGE); + + return r; +} + +static int action_benchmark(void) +{ + static struct { + const char *cipher; + const char *mode; + size_t key_size; + size_t iv_size; + } bciphers[] = { + { "aes", "cbc", 16, 16 }, + { "serpent", "cbc", 16, 16 }, + { "twofish", "cbc", 16, 16 }, + { "aes", "cbc", 32, 16 }, + { "serpent", "cbc", 32, 16 }, + { "twofish", "cbc", 32, 16 }, + { "aes", "xts", 32, 16 }, + { "serpent", "xts", 32, 16 }, + { "twofish", "xts", 32, 16 }, + { "aes", "xts", 64, 16 }, + { "serpent", "xts", 64, 16 }, + { "twofish", "xts", 64, 16 }, + { NULL, NULL, 0, 0 } + }; + static struct { + const char *type; + const char *hash; + } bkdfs[] = { + { CRYPT_KDF_PBKDF2, "sha1" }, + { CRYPT_KDF_PBKDF2, "sha256" }, + { CRYPT_KDF_PBKDF2, "sha512" }, + { CRYPT_KDF_PBKDF2, "ripemd160" }, + { CRYPT_KDF_PBKDF2, "whirlpool" }, + { CRYPT_KDF_ARGON2I, NULL }, + { CRYPT_KDF_ARGON2ID, NULL }, + { NULL, NULL } + }; + 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 iv_size = 16, skipped = 0, width; + char *c; + int i, r; + + log_std(_("# Tests are approximate using memory only (no storage IO).\n")); + if (opt_pbkdf || opt_hash) { + if (!opt_pbkdf && opt_hash) + opt_pbkdf = CRYPT_KDF_PBKDF2; + r = action_benchmark_kdf(opt_pbkdf, opt_hash, key_size); + } else if (opt_cipher) { + r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, cipher_mode); + if (r < 0) { + log_err(_("No known cipher specification pattern detected.")); + return r; + } + if ((c = strchr(cipher_mode, '-'))) + *c = '\0'; + + /* FIXME: not really clever :) */ + if (strstr(cipher, "des") || + strstr(cipher, "blowfish") || + strstr(cipher, "cast5")) + iv_size = 8; + + if (!strcmp(cipher_mode, "ecb")) + iv_size = 0; + + if (!strcmp(cipher_mode, "adiantum")) + iv_size = 32; + + r = benchmark_cipher_loop(cipher, cipher_mode, + key_size, iv_size, + &enc_mbr, &dec_mbr); + if (!r) { + width = strlen(cipher) + strlen(cipher_mode) + 1; + if (width < 11) + width = 11; + /* TRANSLATORS: The string is header of a table and must be exactly (right side) aligned. */ + log_std(_("#%*s Algorithm | Key | Encryption | Decryption\n"), width - 11, ""); + 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 == -ENOENT) + log_err(_("Cipher %s is not available."), opt_cipher); + } else { + for (i = 0; bkdfs[i].type; i++) { + r = action_benchmark_kdf(bkdfs[i].type, bkdfs[i].hash, key_size); + check_signal(&r); + if (r == -EINTR) + break; + } + + for (i = 0; bciphers[i].cipher; i++) { + r = benchmark_cipher_loop(bciphers[i].cipher, bciphers[i].mode, + bciphers[i].key_size, bciphers[i].iv_size, + &enc_mbr, &dec_mbr); + check_signal(&r); + if (r == -ENOTSUP || r == -EINTR) + break; + if (r == -ENOENT) + skipped++; + if (i == 0) + /* TRANSLATORS: The string is header of a table and must be exactly (right side) aligned. */ + log_std(_("# Algorithm | Key | Encryption | Decryption\n")); + + snprintf(cipher, MAX_CIPHER_LEN, "%s-%s", + bciphers[i].cipher, bciphers[i].mode); + if (!r) + log_std("%15s %9zub %10.1f MiB/s %10.1f MiB/s\n", + cipher, bciphers[i].key_size*8, enc_mbr, dec_mbr); + else + log_std("%15s %9zub %17s %17s\n", cipher, + bciphers[i].key_size*8, _("N/A"), _("N/A")); + } + if (skipped && skipped == i) + r = -ENOTSUP; + } + + if (r == -ENOTSUP) { + log_err(_("Required kernel crypto interface not available.")); +#ifdef ENABLE_AF_ALG + log_err( _("Ensure you have algif_skcipher kernel module loaded.")); +#endif + } + return r; +} + +static int set_pbkdf_params(struct crypt_device *cd, const char *dev_type) +{ + const struct crypt_pbkdf_type *pbkdf_default; + struct crypt_pbkdf_type pbkdf = {}; + + pbkdf_default = crypt_get_pbkdf_default(dev_type); + if (!pbkdf_default) + return -EINVAL; + + pbkdf.type = opt_pbkdf ?: pbkdf_default->type; + pbkdf.hash = opt_hash ?: pbkdf_default->hash; + pbkdf.time_ms = (uint32_t)opt_iteration_time ?: pbkdf_default->time_ms; + if (strcmp(pbkdf.type, CRYPT_KDF_PBKDF2)) { + pbkdf.max_memory_kb = opt_pbkdf_memory ?: pbkdf_default->max_memory_kb; + pbkdf.parallel_threads = opt_pbkdf_parallel ?: pbkdf_default->parallel_threads; + } + + if (opt_pbkdf_iterations) { + pbkdf.iterations = opt_pbkdf_iterations; + pbkdf.flags |= CRYPT_PBKDF_NO_BENCHMARK; + } + + return crypt_set_pbkdf_type(cd, &pbkdf); +} + +static int action_luksRepair(void) +{ + struct crypt_device *cd = NULL; + int r; + + if ((r = crypt_init(&cd, action_argv[0]))) + goto out; + + crypt_set_log_callback(cd, quiet_log, NULL); + r = crypt_load(cd, luksType(opt_type), NULL); + crypt_set_log_callback(cd, tool_log, NULL); + if (r == 0) { + log_verbose(_("No known problems detected for LUKS header.")); + goto out; + } + + r = tools_detect_signatures(action_argv[0], 1, NULL); + if (r < 0) + goto out; + + r = yesDialog(_("Really try to repair LUKS device header?"), + _("Operation aborted.\n")) ? 0 : -EINVAL; + if (r == 0) + r = crypt_repair(cd, luksType(opt_type), NULL); +out: + crypt_free(cd); + return r; +} + +static int _wipe_data_device(struct crypt_device *cd) +{ + char tmp_name[64], tmp_path[128], tmp_uuid[40]; + uuid_t tmp_uuid_bin; + int r; + + if (!opt_batch_mode) + 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")); + + /* Activate the device a temporary one */ + uuid_generate(tmp_uuid_bin); + uuid_unparse(tmp_uuid_bin, tmp_uuid); + if (snprintf(tmp_name, sizeof(tmp_name), "temporary-cryptsetup-%s", tmp_uuid) < 0) + return -EINVAL; + if (snprintf(tmp_path, sizeof(tmp_path), "%s/%s", crypt_get_dir(), tmp_name) < 0) + return -EINVAL; + + r = crypt_activate_by_volume_key(cd, tmp_name, NULL, 0, + CRYPT_ACTIVATE_PRIVATE | CRYPT_ACTIVATE_NO_JOURNAL); + if (r < 0) + return r; + + /* Wipe the device */ + set_int_handler(0); + r = crypt_wipe(cd, tmp_path, CRYPT_WIPE_ZERO, 0, 0, DEFAULT_WIPE_BLOCK, + 0, &tools_wipe_progress, NULL); + if (crypt_deactivate(cd, tmp_name)) + log_err(_("Cannot deactivate temporary device %s."), tmp_path); + set_int_block(0); + + return r; +} + +static int action_luksFormat(void) +{ + int r = -EINVAL, keysize, integrity_keysize = 0, fd, created = 0; + struct stat st; + const char *header_device, *type; + char *msg = NULL, *key = NULL, *password = NULL; + char cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN], integrity[MAX_CIPHER_LEN]; + 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, + }; + struct crypt_params_luks2 params2 = { + .data_alignment = params1.data_alignment, + .data_device = params1.data_device, + .sector_size = opt_sector_size, + .label = opt_label, + .subsystem = opt_subsystem + }; + void *params; + + type = luksType(opt_type); + if (!type) + type = crypt_get_default_type(); + + if (!strcmp(type, CRYPT_LUKS2)) { + params = ¶ms2; + } else if (!strcmp(type, CRYPT_LUKS1)) { + params = ¶ms1; + + if (opt_sector_size > SECTOR_SIZE) { + log_err(_("Unsupported encryption sector size.")); + return -EINVAL; + } + + if (opt_integrity) { + log_err(_("Integrity option can be used only for LUKS2 format.")); + return -EINVAL; + } + + if (opt_luks2_keyslots_size || opt_luks2_metadata_size) { + log_err(_("Unsupported LUKS2 metadata size options.")); + return -EINVAL; + } + } else + 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 && + !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); + if (fd == -1 || posix_fallocate(fd, 0, 4096)) + log_err(_("Cannot create header file %s."), opt_header_device); + else { + r = 0; + created = 1; + } + if (fd != -1) + close(fd); + if (r < 0) + return r; + } + + header_device = opt_header_device ?: action_argv[0]; + + r = crypt_parse_name_and_mode(opt_cipher ?: 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 (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + goto out; + } + params2.integrity = integrity; + /* FIXME: we use default integrity_params (set to NULL) */ + } + + /* Never call pwquality if using null cipher */ + if (tools_is_cipher_null(cipher)) + opt_force_password = 1; + + if ((r = crypt_init(&cd, header_device))) { + if (opt_header_device) + 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 (r < 0) { + log_err(_("Unsupported LUKS2 metadata size options.")); + goto out; + } + } + + if (opt_offset) { + r = crypt_set_data_offset(cd, opt_offset); + if (r < 0) + goto out; + } + + /* Print all present signatures in read-only mode */ + r = tools_detect_signatures(header_device, 0, &signatures); + if (r < 0) + goto out; + + if (!created) { + r = asprintf(&msg, _("This will overwrite data on %s irrevocably."), header_device); + if (r == -1) { + r = -ENOMEM; + goto out; + } + + r = yesDialog(msg, _("Operation aborted.\n")) ? 0 : -EINVAL; + free(msg); + if (r < 0) + goto out; + } + +#ifdef ENABLE_LUKS_ADJUST_XTS_KEYSIZE + if (!opt_key_size && !strncmp(cipher_mode, "xts-", 4)) { + if (DEFAULT_LUKS1_KEYBITS == 128) + opt_key_size = 256; + else if (DEFAULT_LUKS1_KEYBITS == 256) + opt_key_size = 512; + } +#endif + keysize = (opt_key_size ?: DEFAULT_LUKS1_KEYBITS) / 8 + integrity_keysize; + + if (opt_random) + crypt_set_rng_type(cd, CRYPT_RNG_RANDOM); + else if (opt_urandom) + 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); + if (r < 0) + goto out; + + if (opt_master_key_file) { + r = tools_read_mk(opt_master_key_file, &key, keysize); + if (r < 0) + goto out; + } + + r = set_pbkdf_params(cd, type); + if (r) { + log_err(_("Failed to set pbkdf parameters.")); + goto out; + } + + /* Signature candidates found */ + if (signatures && ((r = tools_wipe_all_signatures(header_device)) < 0)) + goto out; + + r = crypt_format(cd, type, cipher, cipher_mode, + opt_uuid, key, keysize, params); + check_signal(&r); + if (r < 0) + goto out; + + r = _set_keyslot_encryption_params(cd); + if (r < 0) + goto out; + + r = crypt_keyslot_add_by_volume_key(cd, opt_key_slot, + key, keysize, + password, passwordLen); + if (r < 0) { + (void) tools_wipe_all_signatures(header_device); + goto out; + } + tools_keyslot_msg(r, CREATED); + + if (opt_integrity && !opt_integrity_no_wipe) + r = _wipe_data_device(cd); +out: + crypt_free(cd); + crypt_safe_free(key); + crypt_safe_free(password); + + return r; +} + +static int action_open_luks(void) +{ + struct crypt_active_device cad; + struct crypt_device *cd = NULL; + const char *data_device, *header_device, *activated_name; + char *key = NULL; + uint32_t activate_flags = 0; + int r, keysize, tries; + char *password = NULL; + size_t passwordLen; + + if (opt_refresh) { + activated_name = action_argc > 1 ? action_argv[1] : action_argv[0]; + r = crypt_init_by_name_and_header(&cd, activated_name, opt_header_device); + 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]; + + if ((r = crypt_init_data_device(&cd, header_device, data_device))) + goto out; + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + header_device); + goto out; + } + + if (!data_device && (crypt_get_data_offset(cd) < 8)) { + log_err(_("Reduced data offset is allowed only for detached LUKS header.")); + r = -EINVAL; + goto out; + } + } + + _set_activation_flags(&activate_flags); + + if (opt_master_key_file) { + keysize = crypt_get_volume_key_size(cd); + r = tools_read_mk(opt_master_key_file, &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); + tools_keyslot_msg(r, UNLOCKED); + if (r >= 0 || opt_token_only) + goto out; + + tries = (tools_is_stdin(opt_key_file) && isatty(STDIN_FILENO)) ? opt_tries : 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); + if (r < 0) + goto out; + + r = crypt_activate_by_passphrase(cd, activated_name, + opt_key_slot, password, passwordLen, activate_flags); + tools_keyslot_msg(r, UNLOCKED); + tools_passphrase_msg(r); + check_signal(&r); + crypt_safe_free(password); + password = NULL; + } while ((r == -EPERM || r == -ERANGE) && (--tries > 0)); + } +out: + if (r >= 0 && opt_persistent && + (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.")); + + crypt_safe_free(key); + crypt_safe_free(password); + crypt_free(cd); + return r; +} + +static int verify_keyslot(struct crypt_device *cd, int key_slot, crypt_keyslot_info ki, + char *msg_last, char *msg_pass, char *msg_fail, + const char *key_file, uint64_t keyfile_offset, + int keyfile_size) +{ + char *password = NULL; + size_t passwordLen; + int i, max, r; + + if (ki == CRYPT_SLOT_ACTIVE_LAST && !opt_batch_mode && !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, + _verify_passphrase(0), 0, cd); + if (r < 0) + goto out; + + if (ki == CRYPT_SLOT_ACTIVE_LAST) { + /* check the last keyslot */ + r = crypt_activate_by_passphrase(cd, NULL, key_slot, + password, passwordLen, 0); + } else { + /* try all other keyslots */ + r = crypt_keyslot_max(crypt_get_type(cd)); + if (r < 0) + goto out; + max = r; + + for (i = 0; i < max ; i++) { + if (i == key_slot) + continue; + ki = crypt_keyslot_status(cd, i); + if (ki == CRYPT_SLOT_ACTIVE || ki == CRYPT_SLOT_ACTIVE_LAST) + r = crypt_activate_by_passphrase(cd, NULL, i, + password, passwordLen, 0); + if (r == i) + break; + } + } + + /* Handle inactive keyslots the same as bad password here */ + if (r == -ENOENT) + r = -EPERM; + tools_passphrase_msg(r); +out: + crypt_safe_free(password); + return r; +} + +static int action_luksKillSlot(void) +{ + struct crypt_device *cd = NULL; + crypt_keyslot_info ki; + int r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + ki = crypt_keyslot_status(cd, opt_key_slot); + 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); + break; + case CRYPT_SLOT_INACTIVE: + log_err(_("Keyslot %d is not active."), opt_key_slot); + /* 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, + _("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); + tools_keyslot_msg(r, UNLOCKED); + + if (r == -EPIPE && (!opt_key_file || tools_is_stdin(opt_key_file))) { + log_dbg("Failed read from input, ignoring passphrase."); + r = 0; + } + + if (r < 0) + goto out; + } + + r = crypt_keyslot_destroy(cd, opt_key_slot); + tools_keyslot_msg(opt_key_slot, REMOVED); +out: + crypt_free(cd); + return r; +} + +static int action_luksRemoveKey(void) +{ + struct crypt_device *cd = NULL; + char *password = NULL; + size_t passwordLen; + int r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + r = tools_get_key(_("Enter passphrase to be deleted: "), + &password, &passwordLen, + opt_keyfile_offset, opt_keyfile_size, opt_key_file, + opt_timeout, + _verify_passphrase(0), 0, + cd); + if(r < 0) + goto out; + + r = crypt_activate_by_passphrase(cd, NULL, CRYPT_ANY_SLOT, + password, passwordLen, 0); + tools_passphrase_msg(r); + check_signal(&r); + if (r < 0) + goto out; + tools_keyslot_msg(r, UNLOCKED); + + opt_key_slot = r; + log_verbose(_("Key slot %d selected for deletion."), opt_key_slot); + + if (crypt_keyslot_status(cd, opt_key_slot) == 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"))) { + r = -EPERM; + goto out; + } + + r = crypt_keyslot_destroy(cd, opt_key_slot); + tools_keyslot_msg(opt_key_slot, REMOVED); +out: + crypt_safe_free(password); + crypt_free(cd); + return r; +} + +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); + char *password_new = NULL; + size_t password_new_size = 0; + struct crypt_device *cd = NULL; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + if ((r = crypt_load(cd, CRYPT_LUKS2, NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + r = _set_keyslot_encryption_params(cd); + if (r < 0) + goto out; + + /* Never call pwquality if using null cipher */ + if (tools_is_cipher_null(crypt_get_cipher(cd))) + opt_force_password = 1; + + keysize = opt_key_size / 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 (r < 0) + goto out; + + check_signal(&r); + if (r < 0) + goto out; + } + + 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); + if (r < 0) + goto out; + + r = crypt_keyslot_add_by_key(cd, opt_key_slot, key, keysize, + password_new, password_new_size, CRYPT_VOLUME_KEY_NO_SEGMENT); + tools_keyslot_msg(r, CREATED); +out: + crypt_safe_free(password_new); + crypt_safe_free(key); + crypt_free(cd); + return r; +} + +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); + 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) + return luksAddUnboundKey(); + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + r = _set_keyslot_encryption_params(cd); + if (r < 0) + goto out; + + /* Never call pwquality if using null cipher */ + if (tools_is_cipher_null(crypt_get_cipher(cd))) + opt_force_password = 1; + + keysize = crypt_get_volume_key_size(cd); + 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 (r < 0) + goto out; + + r = crypt_volume_key_verify(cd, key, keysize); + check_signal(&r); + if (r < 0) + goto out; + + 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); + if (r < 0) + goto out; + + r = crypt_keyslot_add_by_volume_key(cd, opt_key_slot, 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); + 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); + + if (r < 0) + goto out; + + /* Check password before asking for new one */ + r = crypt_activate_by_passphrase(cd, NULL, CRYPT_ANY_SLOT, + password, password_size, 0); + check_signal(&r); + tools_passphrase_msg(r); + if (r < 0) + goto out; + tools_keyslot_msg(r, UNLOCKED); + + 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); + if (r < 0) + goto out; + + r = crypt_keyslot_add_by_passphrase(cd, opt_key_slot, + password, password_size, + password_new, password_new_size); + } +out: + tools_keyslot_msg(r, CREATED); + crypt_safe_free(password); + crypt_safe_free(password_new); + crypt_safe_free(key); + crypt_free(cd); + return r; +} + +static int action_luksChangeKey(void) +{ + const char *opt_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; + int r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + r = _set_keyslot_encryption_params(cd); + if (r < 0) + goto out; + + /* Never call pwquality if using null cipher */ + if (tools_is_cipher_null(crypt_get_cipher(cd))) + opt_force_password = 1; + + r = set_pbkdf_params(cd, crypt_get_type(cd)); + if (r) { + log_err(_("Failed to set pbkdf parameters.")); + goto out; + } + + 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); + if (r < 0) + goto out; + + /* Check password before asking for new one */ + r = crypt_activate_by_passphrase(cd, NULL, opt_key_slot, + password, password_size, CRYPT_ACTIVATE_ALLOW_UNBOUND_KEY); + tools_passphrase_msg(r); + check_signal(&r); + if (r < 0) + goto out; + tools_keyslot_msg(r, UNLOCKED); + + 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); + if (r < 0) + goto out; + + r = crypt_keyslot_change_by_passphrase(cd, opt_key_slot, opt_key_slot, + password, password_size, password_new, password_new_size); + tools_keyslot_msg(r, CREATED); +out: + crypt_safe_free(password); + crypt_safe_free(password_new); + crypt_free(cd); + return r; +} + +static int action_luksConvertKey(void) +{ + struct crypt_device *cd = NULL; + char *password = NULL; + size_t password_size = 0; + int r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + if ((r = crypt_load(cd, CRYPT_LUKS2, NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + r = _set_keyslot_encryption_params(cd); + if (r < 0) + goto out; + + if (crypt_keyslot_status(cd, opt_key_slot) == CRYPT_SLOT_INACTIVE) { + r = -EINVAL; + log_err(_("Keyslot %d is not active."), opt_key_slot); + goto out; + } + + r = set_pbkdf_params(cd, crypt_get_type(cd)); + if (r) { + log_err(_("Failed to set pbkdf parameters.")); + goto out; + } + + 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); + if (r < 0) + goto out; + + r = crypt_keyslot_change_by_passphrase(cd, opt_key_slot, opt_key_slot, + password, password_size, password, password_size); + tools_passphrase_msg(r); + tools_keyslot_msg(r, CREATED); +out: + crypt_safe_free(password); + crypt_free(cd); + return r; +} + +static int action_isLuks(void) +{ + struct crypt_device *cd = NULL; + int r; + + /* FIXME: argc > max should be checked for other operations as well */ + if (action_argc > 1) { + log_err(_("Only one device argument for isLuks operation is supported.")); + return -ENODEV; + } + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_log_callback(cd, quiet_log, NULL); + r = crypt_load(cd, luksType(opt_type), NULL); +out: + crypt_free(cd); + return r; +} + +static int action_luksUUID(void) +{ + struct crypt_device *cd = NULL; + const char *existing_uuid = NULL; + int r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, _("Operation aborted.\n")); + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) + goto out; + + if (opt_uuid) + r = crypt_set_uuid(cd, opt_uuid); + else { + existing_uuid = crypt_get_uuid(cd); + log_std("%s\n", existing_uuid ?: ""); + r = existing_uuid ? 0 : 1; + } +out: + crypt_free(cd); + return r; +} + +static int luksDump_with_volume_key(struct crypt_device *cd) +{ + char *vk = NULL, *password = NULL; + size_t passwordLen = 0; + size_t vk_size; + unsigned i; + int r; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + if (!yesDialog( + _("Header dump with volume key is sensitive information\n" + "which allows access to encrypted partition without passphrase.\n" + "This dump should be always stored encrypted on safe place."), + NULL)) + return -EPERM; + + vk_size = crypt_get_volume_key_size(cd); + vk = crypt_safe_alloc(vk_size); + if (!vk) + return -ENOMEM; + + r = tools_get_key(NULL, &password, &passwordLen, + opt_keyfile_offset, opt_keyfile_size, opt_key_file, + opt_timeout, 0, 0, cd); + if (r < 0) + goto out; + + r = crypt_volume_key_get(cd, CRYPT_ANY_SLOT, vk, &vk_size, + password, passwordLen); + tools_passphrase_msg(r); + check_signal(&r); + if (r < 0) + goto out; + tools_keyslot_msg(r, UNLOCKED); + + if (opt_master_key_file) { + r = tools_write_mk(opt_master_key_file, vk, vk_size); + if (r < 0) + goto out; + } + + log_std("LUKS header information for %s\n", crypt_get_device_name(cd)); + log_std("Cipher name: \t%s\n", crypt_get_cipher(cd)); + log_std("Cipher mode: \t%s\n", crypt_get_cipher_mode(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); + goto out; + } + log_std("MK dump:\t"); + + for(i = 0; i < vk_size; i++) { + if (i && !(i % 16)) + log_std("\n\t\t"); + log_std("%02hhx ", (char)vk[i]); + } + log_std("\n"); + +out: + crypt_safe_free(password); + crypt_safe_free(vk); + return r; +} + +static int action_luksDump(void) +{ + struct crypt_device *cd = NULL; + int r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + if (opt_dump_master_key) + r = luksDump_with_volume_key(cd); + else + r = crypt_dump(cd); +out: + crypt_free(cd); + return r; +} + +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)); + if (!r) + r = crypt_suspend(cd, action_argv[0]); + + crypt_free(cd); + return r; +} + +static int action_luksResume(void) +{ + struct crypt_device *cd = NULL; + char *password = NULL; + size_t passwordLen; + int r, tries; + + if ((r = crypt_init_by_name_and_header(&cd, action_argv[0], uuid_or_device(opt_header_device)))) + goto out; + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) + goto out; + + tries = (tools_is_stdin(opt_key_file) && isatty(STDIN_FILENO)) ? opt_tries : 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); + if (r < 0) + goto out; + + r = crypt_resume_by_passphrase(cd, action_argv[0], CRYPT_ANY_SLOT, + password, passwordLen); + tools_passphrase_msg(r); + check_signal(&r); + tools_keyslot_msg(r, UNLOCKED); + + crypt_safe_free(password); + password = NULL; + } while ((r == -EPERM || r == -ERANGE) && (--tries > 0)); +out: + crypt_safe_free(password); + crypt_free(cd); + return r; +} + +static int action_luksBackup(void) +{ + struct crypt_device *cd = NULL; + int r; + + if (!opt_header_backup_file) { + log_err(_("Option --header-backup-file is required.")); + return -EINVAL; + } + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + r = crypt_header_backup(cd, NULL, opt_header_backup_file); +out: + crypt_free(cd); + return r; +} + +static int action_luksRestore(void) +{ + struct crypt_device *cd = NULL; + int r = 0; + + if (!opt_header_backup_file) { + log_err(_("Option --header-backup-file is required.")); + return -EINVAL; + } + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + r = crypt_header_restore(cd, NULL, opt_header_backup_file); +out: + crypt_free(cd); + return r; +} + +static const char *_get_device_type(void) +{ + const char *type, *name = NULL; + struct crypt_device *cd = NULL; + + if (action_argc > 1) + name = action_argv[1]; + else if (action_argc == 1) + name = action_argv[0]; + + if (crypt_init_by_name_and_header(&cd, name, opt_header_device)) + return NULL; + + type = crypt_get_type(cd); + if (!type) { + crypt_free(cd); + log_err(_("%s is not cryptsetup managed device."), name); + return NULL; + } + + if (!strncmp(type, "LUKS", 4)) + type = "luks"; + else if (!strcmp(type, CRYPT_PLAIN)) + type = "plain"; + else if (!strcmp(type, CRYPT_LOOPAES)) + type = "loopaes"; + else { + log_err(_("Refresh is not supported for device type %s"), type); + type = NULL; + } + + crypt_free(cd); + + return type; +} + +static int action_open(void) +{ + if (opt_refresh && !opt_type) + /* read device type from active mapping */ + opt_type = _get_device_type(); + + if (!opt_type) + return -EINVAL; + + if (!strcmp(opt_type, "luks") || + !strcmp(opt_type, "luks1") || + !strcmp(opt_type, "luks2")) { + if (action_argc < 2 && (!opt_test_passphrase && !opt_refresh)) + goto args; + return action_open_luks(); + } else if (!strcmp(opt_type, "plain")) { + if (action_argc < 2 && !opt_refresh) + goto args; + return action_open_plain(); + } else if (!strcmp(opt_type, "loopaes")) { + if (action_argc < 2 && !opt_refresh) + goto args; + return action_open_loopaes(); + } else if (!strcmp(opt_type, "tcrypt")) { + if (action_argc < 2 && !opt_test_passphrase) + goto args; + return action_open_tcrypt(); + } + + log_err(_("Unrecognized metadata device type %s."), opt_type); + return -EINVAL; +args: + log_err(_("Command requires device and mapped name as arguments.")); + return -EINVAL; +} + +static int action_luksErase(void) +{ + struct crypt_device *cd = NULL; + crypt_keyslot_info ki; + char *msg = NULL; + int i, max, r; + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + goto out; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + if ((r = crypt_load(cd, luksType(opt_type), NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + if(asprintf(&msg, _("This operation will erase all keyslots on device %s.\n" + "Device will become unusable after this operation."), + uuid_or_device_header(NULL)) == -1) { + r = -ENOMEM; + goto out; + } + + if (!yesDialog(msg, _("Operation aborted, keyslots were NOT wiped.\n"))) { + r = -EPERM; + goto out; + } + + /* Safety check */ + max = crypt_keyslot_max(crypt_get_type(cd)); + if (max <= 0) + return -EINVAL; + + for (i = 0; i < max; i++) { + ki = crypt_keyslot_status(cd, i); + if (ki == CRYPT_SLOT_ACTIVE || ki == CRYPT_SLOT_ACTIVE_LAST) { + r = crypt_keyslot_destroy(cd, i); + if (r < 0) + goto out; + tools_keyslot_msg(i, REMOVED); + } + } +out: + free(msg); + crypt_free(cd); + return r; +} + +static int action_luksConvert(void) +{ + struct crypt_device *cd = NULL; + char *msg = NULL; + const char *to_type, *from_type; + int r; + + if (!strcmp(opt_type, "luks2")) { + to_type = CRYPT_LUKS2; + } else if (!strcmp(opt_type, "luks1")) { + to_type = CRYPT_LUKS1; + } else { + log_err(_("Invalid LUKS type, only luks1 and luks2 are supported.")); + return -EINVAL; + } + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + return r; + + crypt_set_confirm_callback(cd, yesDialog, NULL); + + if ((r = crypt_load(cd, CRYPT_LUKS, NULL)) || + !(from_type = crypt_get_type(cd))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + crypt_free(cd); + return r; + } + + if (!strcmp(from_type, to_type)) { + log_err(_("Device is already %s type."), to_type); + crypt_free(cd); + return -EINVAL; + } + + if (asprintf(&msg, _("This operation will convert %s to %s format.\n"), + uuid_or_device_header(NULL), to_type) == -1) { + crypt_free(cd); + return -ENOMEM; + } + + if (yesDialog(msg, _("Operation aborted, device was NOT converted.\n"))) + r = crypt_convert(cd, to_type, NULL); + else + r = -EPERM; + + free(msg); + crypt_free(cd); + return r; +} + +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)) + priority = CRYPT_SLOT_PRIORITY_NORMAL; + else if (!strcmp("prefer", opt_priority)) + priority = CRYPT_SLOT_PRIORITY_PREFER; + else if (!strcmp("ignore", opt_priority)) + priority = CRYPT_SLOT_PRIORITY_IGNORE; + + cs = crypt_keyslot_status(cd, opt_key_slot); + if (cs != CRYPT_SLOT_INVALID) + return crypt_keyslot_set_priority(cd, opt_key_slot, priority); + + return -EINVAL; +} + +static int _config_labels(struct crypt_device *cd) +{ + return crypt_set_label(cd, opt_label, opt_subsystem); +} + +static int action_luksConfig(void) +{ + struct crypt_device *cd = NULL; + int r; + + if (!opt_priority && !opt_label && !opt_subsystem) { + log_err(_("Option --priority, --label or --subsystem is missing.")); + return -EINVAL; + } + + if ((r = crypt_init(&cd, uuid_or_device_header(NULL)))) + return r; + + if ((r = crypt_load(cd, CRYPT_LUKS2, NULL))) { + log_err(_("Device %s is not a valid LUKS device."), + uuid_or_device_header(NULL)); + goto out; + } + + if (opt_priority && (r = _config_priority(cd))) + goto out; + + if ((opt_label || opt_subsystem) && (r = _config_labels(cd))) + goto out; +out: + crypt_free(cd); + return r; +} + +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 + }; + + if (opt_token != CRYPT_ANY_TOKEN) { + token_info = crypt_token_status(cd, opt_token, NULL); + if (token_info < CRYPT_TOKEN_INACTIVE) { + log_err(_("Token %d is invalid."), opt_token); + return -EINVAL; + } else if (token_info > CRYPT_TOKEN_INACTIVE) { + log_err(_("Token %d in use."), opt_token); + return -EINVAL; + } + } + + r = crypt_token_luks2_keyring_set(cd, opt_token, ¶ms); + if (r < 0) { + log_err(_("Failed to add luks2-keyring token %d."), opt_token); + return r; + } + + token = r; + tools_token_msg(token, CREATED); + + r = crypt_token_assign_keyslot(cd, token, opt_key_slot); + if (r < 0) { + log_err(_("Failed to assign token %d to keyslot %d."), token, opt_key_slot); + (void) crypt_token_json_set(cd, token, NULL); + } + + return r; +} + +static int _token_remove(struct crypt_device *cd) +{ + crypt_token_info token_info; + int r; + + token_info = crypt_token_status(cd, opt_token, NULL); + if (token_info < CRYPT_TOKEN_INACTIVE) { + log_err(_("Token %d is invalid."), opt_token); + return -EINVAL; + } else if (token_info == CRYPT_TOKEN_INACTIVE) { + log_err(_("Token %d is not in use."), opt_token); + return -EINVAL; + } + + r = crypt_token_json_set(cd, opt_token, NULL); + tools_token_msg(r, REMOVED); + + return r; +} + +static int _token_import(struct crypt_device *cd) +{ + char *json; + size_t json_length; + crypt_token_info token_info; + int r, token; + + if (opt_token != CRYPT_ANY_TOKEN) { + token_info = crypt_token_status(cd, opt_token, NULL); + if (token_info < CRYPT_TOKEN_INACTIVE) { + log_err(_("Token %d is invalid."), opt_token); + return -EINVAL; + } else if (token_info > CRYPT_TOKEN_INACTIVE) { + log_err(_("Token %d in use."), opt_token); + return -EINVAL; + } + } + + r = tools_read_json_file(cd, opt_json_file, &json, &json_length); + if (r) + return r; + + r = crypt_token_json_set(cd, opt_token, json); + free(json); + if (r < 0) { + log_err(_("Failed to import token from file.")); + return r; + } + + 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 (r < 0) { + log_err(_("Failed to assign token %d to keyslot %d."), token, opt_key_slot); + (void) crypt_token_json_set(cd, token, NULL); + } + } + + return r; +} + +static int _token_export(struct crypt_device *cd) +{ + const char *json; + int r; + + r = crypt_token_json_get(cd, opt_token, &json); + if (r < 0) { + log_err(_("Failed to get token %d for export."), opt_token); + return r; + } + + return tools_write_json_file(cd, opt_json_file, json); +} + +static int action_token(void) +{ + int r; + struct crypt_device *cd = NULL; + enum { ADD = 0, REMOVE, IMPORT, EXPORT } action; + + if (!strcmp(action_argv[0], "add")) { + if (!opt_key_description) { + 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) { + log_err(_("Action requires specific token. Use --token-id parameter.")); + return -EINVAL; + } + action = REMOVE; + } else if (!strcmp(action_argv[0], "import")) { + action = IMPORT; + } else if (!strcmp(action_argv[0], "export")) { + if (opt_token == CRYPT_ANY_TOKEN) { + log_err(_("Action requires specific token. Use --token-id parameter.")); + return -EINVAL; + } + action = EXPORT; + } else { + log_err(_("Invalid token operation %s."), action_argv[0]); + return -EINVAL; + } + + if ((r = crypt_init(&cd, uuid_or_device(opt_header_device ?: 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])); + crypt_free(cd); + return r; + } + + if (action == ADD) + r = _token_add(cd); /* adds only luks2-keyring type */ + else if (action == REMOVE) + r = _token_remove(cd); + else if (action == IMPORT) + r = _token_import(cd); + else if (action == EXPORT) + r = _token_export(cd); + else { + log_dbg("Internal token action error."); + r = -EINVAL; + } + + crypt_free(cd); + + return r; +} + +static struct action_type { + const char *type; + int (*handler)(void); + int required_action_argc; + int required_memlock; + const char *arg_desc; + const char *desc; +} action_types[] = { + { "open", action_open, 1, 1, N_("<device> [--type <type>] [<name>]"),N_("open device as mapping <name>") }, + { "close", action_close, 1, 1, N_("<name>"), N_("close device (remove mapping)") }, + { "resize", action_resize, 1, 1, N_("<name>"), N_("resize active device") }, + { "status", action_status, 1, 0, N_("<name>"), N_("show device status") }, + { "benchmark", action_benchmark, 0, 0, N_("[--cipher <cipher>]"), N_("benchmark cipher") }, + { "repair", action_luksRepair, 1, 1, N_("<device>"), N_("try to repair on-disk metadata") }, + { "erase", action_luksErase , 1, 1, N_("<device>"), N_("erase all keyslots (remove encryption key)") }, + { "convert", action_luksConvert, 1, 1, N_("<device>"), N_("convert LUKS from/to LUKS2 format") }, + { "config", action_luksConfig, 1, 1, N_("<device>"), N_("set permanent configuration options for LUKS2") }, + { "luksFormat", action_luksFormat, 1, 1, N_("<device> [<new key file>]"), N_("formats a LUKS device") }, + { "luksAddKey", action_luksAddKey, 1, 1, N_("<device> [<new key file>]"), N_("add key to LUKS device") }, + { "luksRemoveKey",action_luksRemoveKey,1, 1, N_("<device> [<key file>]"), N_("removes supplied key or key file from LUKS device") }, + { "luksChangeKey",action_luksChangeKey,1, 1, N_("<device> [<key file>]"), N_("changes supplied key or key file of LUKS device") }, + { "luksConvertKey",action_luksConvertKey,1, 1, N_("<device> [<key file>]"), N_("converts a key to new pbkdf parameters") }, + { "luksKillSlot", action_luksKillSlot, 2, 1, N_("<device> <key slot>"), N_("wipes key with number <key slot> from LUKS device") }, + { "luksUUID", action_luksUUID, 1, 0, N_("<device>"), N_("print UUID of LUKS device") }, + { "isLuks", action_isLuks, 1, 0, N_("<device>"), N_("tests <device> for LUKS partition header") }, + { "luksDump", action_luksDump, 1, 1, N_("<device>"), N_("dump LUKS partition information") }, + { "tcryptDump", action_tcryptDump, 1, 1, N_("<device>"), N_("dump TCRYPT device information") }, + { "luksSuspend", action_luksSuspend, 1, 1, N_("<device>"), N_("Suspend LUKS device and wipe key (all IOs are frozen)") }, + { "luksResume", action_luksResume, 1, 1, N_("<device>"), N_("Resume suspended LUKS device") }, + { "luksHeaderBackup", action_luksBackup,1,1, N_("<device>"), N_("Backup LUKS device header and keyslots") }, + { "luksHeaderRestore",action_luksRestore,1,1,N_("<device>"), N_("Restore LUKS device header and keyslots") }, + { "token", action_token, 2, 0, N_("<add|remove|import|export> <device>"), N_("Manipulate LUKS2 tokens") }, + {} +}; + +static void help(poptContext popt_context, + enum poptCallbackReason reason __attribute__((unused)), + struct poptOption *key, + const char *arg __attribute__((unused)), + void *data __attribute__((unused))) +{ + if (key->shortName == '?') { + struct action_type *action; + const struct crypt_pbkdf_type *pbkdf_luks1, *pbkdf_luks2; + + log_std("%s\n",PACKAGE_STRING); + + poptPrintHelp(popt_context, stdout, 0); + + log_std(_("\n" + "<action> is one of:\n")); + + for(action = action_types; action->type; action++) + log_std("\t%s %s - %s\n", action->type, _(action->arg_desc), _(action->desc)); + + log_std(_("\n" + "You can also use old <action> syntax aliases:\n" + "\topen: create (plainOpen), luksOpen, loopaesOpen, tcryptOpen\n" + "\tclose: remove (plainClose), luksClose, loopaesClose, tcryptClose\n")); + log_std(_("\n" + "<name> is the device to create under %s\n" + "<device> is the encrypted device\n" + "<key slot> is the LUKS key slot number to modify\n" + "<key file> optional key file for the new key for luksAddKey action\n"), + crypt_get_dir()); + + log_std(_("\nDefault compiled-in metadata format is %s (for luksFormat action).\n"), + crypt_get_default_type()); + + pbkdf_luks1 = crypt_get_pbkdf_default(CRYPT_LUKS1); + pbkdf_luks2 = crypt_get_pbkdf_default(CRYPT_LUKS2); + log_std(_("\nDefault compiled-in key and passphrase parameters:\n" + "\tMaximum keyfile size: %dkB, " + "Maximum interactive passphrase length %d (characters)\n" + "Default PBKDF for LUKS1: %s, iteration time: %d (ms)\n" + "Default PBKDF for LUKS2: %s\n" + "\tIteration time: %d, Memory required: %dkB, Parallel threads: %d\n"), + DEFAULT_KEYFILE_SIZE_MAXKB, DEFAULT_PASSPHRASE_SIZE_MAX, + pbkdf_luks1->type, pbkdf_luks1->time_ms, + pbkdf_luks2->type, pbkdf_luks2->time_ms, pbkdf_luks2->max_memory_kb, + pbkdf_luks2->parallel_threads); + + log_std(_("\nDefault compiled-in device cipher parameters:\n" + "\tloop-AES: %s, Key %d bits\n" + "\tplain: %s, Key: %d bits, Password hashing: %s\n" + "\tLUKS: %s, Key: %d bits, LUKS header hashing: %s, RNG: %s\n"), + DEFAULT_LOOPAES_CIPHER, DEFAULT_LOOPAES_KEYBITS, + DEFAULT_CIPHER(PLAIN), DEFAULT_PLAIN_KEYBITS, DEFAULT_PLAIN_HASH, + DEFAULT_CIPHER(LUKS1), DEFAULT_LUKS1_KEYBITS, DEFAULT_LUKS1_HASH, + DEFAULT_RNG); +#if defined(ENABLE_LUKS_ADJUST_XTS_KEYSIZE) && DEFAULT_LUKS1_KEYBITS != 512 + log_std(_("\tLUKS: Default keysize with XTS mode (two internal keys) will be doubled.\n")); +#endif + exit(EXIT_SUCCESS); + } else + usage(popt_context, EXIT_SUCCESS, NULL, NULL); +} + +static void help_args(struct action_type *action, poptContext popt_context) +{ + char buf[128]; + + snprintf(buf, sizeof(buf), _("%s: requires %s as arguments"), action->type, action->arg_desc); + usage(popt_context, EXIT_FAILURE, buf, poptGetInvocationName(popt_context)); +} + +static int run_action(struct action_type *action) +{ + int r; + + log_dbg("Running command %s.", action->type); + + if (action->required_memlock) + crypt_memory_lock(NULL, 1); + + set_int_handler(0); + r = action->handler(); + + if (action->required_memlock) + crypt_memory_lock(NULL, 0); + + /* Some functions returns keyslot # */ + if (r > 0) + r = 0; + check_signal(&r); + + show_status(r); + return translate_errno(r); +} + +static int strcmp_or_null(const char *str, const char *expected) +{ + return !str ? 0 : strcmp(str, expected); +} + +int main(int argc, const char **argv) +{ + static char *popt_tmp; + static struct poptOption popt_help_options[] = { + { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL }, + { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL }, + { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL }, + POPT_TABLEEND + }; + static struct poptOption popt_options[] = { + { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL }, + { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), 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, &opt_key_file, 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, &popt_tmp, 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, &popt_tmp, 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, &popt_tmp, 1, N_("The size of the device"), N_("SECTORS") }, + { "offset", 'o', POPT_ARG_STRING, &popt_tmp, 2, N_("The start offset in the backend device"), N_("SECTORS") }, + { "skip", 'p', POPT_ARG_STRING, &popt_tmp, 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 <n> 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, plain, loopaes, tcrypt"), 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 }, + { "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 }, + { "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 }, + { "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 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 }, + POPT_TABLEEND + }; + poptContext popt_context; + struct action_type *action; + const char *aname; + int r, total_keyfiles = 0; + + crypt_set_log_callback(NULL, tool_log, NULL); + + setlocale(LC_ALL, ""); + bindtextdomain(PACKAGE, LOCALEDIR); + textdomain(PACKAGE); + + popt_context = poptGetContext(PACKAGE, argc, argv, popt_options, 0); + poptSetOtherOptionHelp(popt_context, + _("[OPTION...] <action> <action-specific>")); + + while((r = poptGetNextOpt(popt_context)) > 0) { + unsigned long long ull_value; + char *endp; + + if (r == 6) { + const char *kf = poptGetOptArg(popt_context); + if (tools_is_stdin(kf)) + opt_keyfile_stdin = kf; + else if (opt_keyfiles_count < MAX_KEYFILES) + opt_keyfiles[opt_keyfiles_count++] = kf; + total_keyfiles++; + continue; + } + + errno = 0; + ull_value = strtoull(popt_tmp, &endp, 0); + if (*endp || !*popt_tmp || !isdigit(*popt_tmp) || + (errno == ERANGE && ull_value == ULLONG_MAX) || + (errno != 0 && ull_value == 0)) + r = POPT_ERROR_BADNUMBER; + + 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; + } + + if (r < -1) + usage(popt_context, EXIT_FAILURE, poptStrerror(r), + poptBadOption(popt_context, POPT_BADOPTION_NOALIAS)); + + if (opt_version_mode) { + log_std("%s %s\n", PACKAGE_NAME, PACKAGE_VERSION); + poptFreeContext(popt_context); + exit(EXIT_SUCCESS); + } + + if (!(aname = poptGetArg(popt_context))) + usage(popt_context, EXIT_FAILURE, _("Argument <action> missing."), + poptGetInvocationName(popt_context)); + + action_argc = 0; + action_argv = poptGetArgs(popt_context); + /* Make return values of poptGetArgs more consistent in case of remaining argc = 0 */ + if(!action_argv) + action_argv = null_action_argv; + + /* Count args, somewhat unnice, change? */ + while(action_argv[action_argc] != NULL) + action_argc++; + + /* Handle aliases */ + if (!strcmp(aname, "create")) { + /* create command had historically switched arguments */ + if (action_argv[0] && action_argv[1]) { + const char *tmp = action_argv[0]; + action_argv[0] = action_argv[1]; + action_argv[1] = tmp; + } + aname = "open"; + opt_type = "plain"; + } else if (!strcmp(aname, "plainOpen")) { + aname = "open"; + opt_type = "plain"; + } else if (!strcmp(aname, "luksOpen")) { + aname = "open"; + opt_type = "luks"; + } else if (!strcmp(aname, "loopaesOpen")) { + aname = "open"; + opt_type = "loopaes"; + } else if (!strcmp(aname, "tcryptOpen")) { + aname = "open"; + opt_type = "tcrypt"; + } else if (!strcmp(aname, "tcryptDump")) { + opt_type = "tcrypt"; + } else if (!strcmp(aname, "remove") || + !strcmp(aname, "plainClose") || + !strcmp(aname, "luksClose") || + !strcmp(aname, "loopaesClose") || + !strcmp(aname, "tcryptClose")) { + aname = "close"; + } else if (!strcmp(aname, "luksErase")) { + aname = "erase"; + opt_type = "luks"; + } else if (!strcmp(aname, "luksConfig")) { + aname = "config"; + opt_type = "luks2"; + } else if (!strcmp(aname, "refresh")) { + aname = "open"; + opt_refresh = 1; + } + + /* ignore user supplied type and query device type instead */ + if (opt_refresh) + opt_type = NULL; + + for(action = action_types; action->type; action++) + if (strcmp(action->type, aname) == 0) + break; + + if (!action->type) + usage(popt_context, EXIT_FAILURE, _("Unknown action."), + poptGetInvocationName(popt_context)); + + if (action_argc < action->required_action_argc) + help_args(action, popt_context); + + /* FIXME: rewrite this from scratch */ + + if (opt_refresh && strcmp(aname, "open")) + usage(popt_context, EXIT_FAILURE, + _("Parameter --refresh is only allowed with open or refresh commands.\n"), + poptGetInvocationName(popt_context)); + + if (opt_refresh && opt_test_passphrase) + usage(popt_context, EXIT_FAILURE, + _("Options --refresh and --test-passphrase are mutually exclusive.\n"), + poptGetInvocationName(popt_context)); + + if (opt_deferred_remove && strcmp(aname, "close")) + usage(popt_context, EXIT_FAILURE, + _("Option --deferred is allowed only for close command.\n"), + poptGetInvocationName(popt_context)); + + if (opt_shared && (strcmp(aname, "open") || strcmp_or_null(opt_type, "plain"))) + usage(popt_context, EXIT_FAILURE, + _("Option --shared is allowed only for open of plain device.\n"), + poptGetInvocationName(popt_context)); + + if (opt_allow_discards && strcmp(aname, "open")) + usage(popt_context, EXIT_FAILURE, + _("Option --allow-discards is allowed only for open operation.\n"), + poptGetInvocationName(popt_context)); + + if (opt_persistent && strcmp(aname, "open")) + usage(popt_context, EXIT_FAILURE, + _("Option --persistent is allowed only for open operation.\n"), + poptGetInvocationName(popt_context)); + + if (opt_persistent && opt_test_passphrase) + usage(popt_context, EXIT_FAILURE, + _("Option --persistent is not allowed with --test-passphrase.\n"), + poptGetInvocationName(popt_context)); + + if (opt_key_size && + strcmp(aname, "luksFormat") && + strcmp(aname, "open") && + strcmp(aname, "benchmark") && + (strcmp(aname, "luksAddKey") || !opt_unbound)) + usage(popt_context, EXIT_FAILURE, + _("Option --key-size is allowed only for luksFormat, luksAddKey (with --unbound),\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).\n"), + poptGetInvocationName(popt_context)); + + if (opt_integrity_no_wipe && !opt_integrity) + usage(popt_context, EXIT_FAILURE, + _("Option --integrity-no-wipe" + " can be used only for format action with integrity extension.\n"), + 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.\n"), + poptGetInvocationName(popt_context)); + + if (opt_test_passphrase && (strcmp(aname, "open") || !opt_type || + (strncmp(opt_type, "luks", 4) && strcmp(opt_type, "tcrypt")))) + usage(popt_context, EXIT_FAILURE, + _("Option --test-passphrase is allowed only for open of LUKS and TCRYPT devices.\n"), + 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 = action_argv[1]; + } + + 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 (total_keyfiles > 1 && (strcmp_or_null(opt_type, "tcrypt"))) + usage(popt_context, EXIT_FAILURE, _("Only one --key-file argument is allowed."), + poptGetInvocationName(popt_context)); + + if (opt_random && opt_urandom) + 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")) + 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) + 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(opt_type, "plain") && strcmp(opt_type, "loopaes")))) + usage(popt_context, EXIT_FAILURE, + _("Option --skip is supported only for open of plain and loopaes devices.\n"), + poptGetInvocationName(popt_context)); + + if (opt_offset && ((strcmp(aname, "open") && strcmp(aname, "luksFormat")) || + (!strcmp(aname, "open") && strcmp_or_null(opt_type, "plain") && strcmp(opt_type, "loopaes")) || + (!strcmp(aname, "luksFormat") && opt_type && strncmp(opt_type, "luks", 4)))) + usage(popt_context, EXIT_FAILURE, + _("Option --offset is supported only for open of plain and loopaes devices and for luksFormat.\n"), + poptGetInvocationName(popt_context)); + + if ((opt_tcrypt_hidden || opt_tcrypt_system || opt_tcrypt_backup) && strcmp(aname, "tcryptDump") && + (strcmp(aname, "open") || !opt_type || strcmp(opt_type, "tcrypt"))) + usage(popt_context, EXIT_FAILURE, + _("Option --tcrypt-hidden, --tcrypt-system or --tcrypt-backup is supported only for TCRYPT device.\n"), + poptGetInvocationName(popt_context)); + + if (opt_tcrypt_hidden && opt_allow_discards) + usage(popt_context, EXIT_FAILURE, + _("Option --tcrypt-hidden cannot be combined with --allow-discards.\n"), + poptGetInvocationName(popt_context)); + + if (opt_veracrypt && (!opt_type || strcmp(opt_type, "tcrypt"))) + usage(popt_context, EXIT_FAILURE, + _("Option --veracrypt is supported only for TCRYPT device type.\n"), + 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.\n"), + poptGetInvocationName(popt_context)); + } else if (!opt_veracrypt) { + usage(popt_context, EXIT_FAILURE, + _("Option --veracrypt-pim is supported only for VeraCrypt compatible devices.\n"), + poptGetInvocationName(popt_context)); + } + } + + if (opt_veracrypt_query_pim) { + if (!opt_veracrypt) { + usage(popt_context, EXIT_FAILURE, + _("Option --veracrypt-query-pim is supported only for VeraCrypt compatible devices.\n"), + poptGetInvocationName(popt_context)); + } else if (opt_veracrypt_pim != -1) { + usage(popt_context, EXIT_FAILURE, + _("The options --veracrypt-pim and --veracrypt-query-pim are mutually exclusive.\n"), + 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.\n"), + poptGetInvocationName(popt_context)); + + if (!strcmp(aname, "config") && opt_priority && opt_key_slot == CRYPT_ANY_SLOT) + usage(popt_context, EXIT_FAILURE, + _("Keyslot specification is required.\n"), + poptGetInvocationName(popt_context)); + + if (opt_pbkdf && crypt_parse_pbkdf(opt_pbkdf, &opt_pbkdf)) + usage(popt_context, EXIT_FAILURE, + _("Password-based key derivation function (PBKDF) can be only pbkdf2 or argon2i/argon2id.\n"), + poptGetInvocationName(popt_context)); + + if (opt_pbkdf_iterations && opt_iteration_time) + usage(popt_context, EXIT_FAILURE, + _("PBKDF forced iterations cannot be combined with iteration time option.\n"), + poptGetInvocationName(popt_context)); + + if (opt_sector_size != SECTOR_SIZE && strcmp(aname, "luksFormat") && + (strcmp(aname, "open") || strcmp_or_null(opt_type, "plain"))) + usage(popt_context, EXIT_FAILURE, + _("Sector size option is not supported for this command.\n"), + poptGetInvocationName(popt_context)); + + if (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.\n"), + poptGetInvocationName(popt_context)); + + if (opt_unbound && !opt_key_size) + usage(popt_context, EXIT_FAILURE, + _("Key size is required with --unbound option.\n"), + poptGetInvocationName(popt_context)); + + if (opt_unbound && strcmp(aname, "luksAddKey")) + usage(popt_context, EXIT_FAILURE, + _("Option --unbound may be used only with luksAddKey action.\n"), + poptGetInvocationName(popt_context)); + + if (opt_refresh && strcmp(aname, "open")) + usage(popt_context, EXIT_FAILURE, + _("Option --refresh may be used only with open action.\n"), + 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); + dbg_version_and_cmd(argc, argv); + } + + if (opt_disable_locks && crypt_metadata_locking(NULL, 0)) { + log_std(_("Cannot disable metadata locking.\n")); + poptFreeContext(popt_context); + exit(EXIT_FAILURE); + } + + if (opt_disable_keyring) + (void) crypt_volume_key_keyring(NULL, 0); + + r = run_action(action); + poptFreeContext(popt_context); + return r; +} diff --git a/src/cryptsetup.h b/src/cryptsetup.h new file mode 100644 index 0000000..153c7aa --- /dev/null +++ b/src/cryptsetup.h @@ -0,0 +1,122 @@ +/* + * cryptsetup - setup cryptographic volumes for dm-crypt + * + * Copyright (C) 2004 Jana Saout <jana@saout.de> + * Copyright (C) 2004-2007 Clemens Fruhwirth <clemens@endorphin.org> + * Copyright (C) 2009-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2009-2019 Milan Broz + * + * 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_H +#define CRYPTSETUP_H + +#include <string.h> +#include <stdlib.h> +#include <stdarg.h> +#include <stdio.h> +#include <stdint.h> +#include <errno.h> +#include <unistd.h> +#include <inttypes.h> +#include <limits.h> +#include <ctype.h> +#include <fcntl.h> +#include <popt.h> +#include <sys/stat.h> +#include <sys/time.h> + +#include "lib/nls.h" +#include "lib/utils_crypt.h" +#include "lib/utils_loop.h" +#include "lib/utils_fips.h" +#include "lib/utils_io.h" +#include "lib/utils_blkid.h" + +#include "libcryptsetup.h" + +#define CONST_CAST(x) (x)(uintptr_t) +#define DEFAULT_CIPHER(type) (DEFAULT_##type##_CIPHER "-" DEFAULT_##type##_MODE) +#define SECTOR_SIZE 512 +#define MAX_SECTOR_SIZE 4096 +#define ROUND_SECTOR(x) (((x) + SECTOR_SIZE - 1) / SECTOR_SIZE) + +#define DEFAULT_WIPE_BLOCK 1048576 /* 1 MiB */ + +extern int opt_debug; +extern int opt_debug_json; +extern int opt_verbose; +extern int opt_batch_mode; +extern int opt_force_password; +extern int opt_progress_frequency; + +/* Common tools */ +void clogger(struct crypt_device *cd, int level, const char *file, int line, + const char *format, ...) __attribute__ ((format (printf, 5, 6))); +void tool_log(int level, const char *msg, void *usrptr __attribute__((unused))); +void quiet_log(int level, const char *msg, void *usrptr); + +int yesDialog(const char *msg, void *usrptr __attribute__((unused))); +void show_status(int errcode); +const char *uuid_or_device(const char *spec); +__attribute__ ((noreturn)) \ +void usage(poptContext popt_context, int exitcode, const char *error, const char *more); +void dbg_version_and_cmd(int argc, const char **argv); +int translate_errno(int r); + +typedef enum { CREATED, UNLOCKED, REMOVED } crypt_object_op; +void tools_keyslot_msg(int keyslot, crypt_object_op op); +void tools_token_msg(int token, crypt_object_op op); + +extern volatile int quit; +void set_int_block(int block); +void set_int_handler(int block); +void check_signal(int *r); +int tools_signals_blocked(void); + +int tools_get_key(const char *prompt, + char **key, size_t *key_size, + uint64_t keyfile_offset, size_t keyfile_size_max, + const char *key_file, + int timeout, int verify, int pwquality, + struct crypt_device *cd); +void tools_passphrase_msg(int r); +int tools_is_stdin(const char *key_file); +int tools_string_to_size(struct crypt_device *cd, const char *s, uint64_t *size); +int tools_is_cipher_null(const char *cipher); + +void tools_clear_line(void); + +void tools_time_progress(uint64_t device_size, uint64_t bytes, + struct timeval *start_time, struct timeval *end_time); +int tools_wipe_progress(uint64_t size, uint64_t offset, void *usrptr); + +int tools_read_mk(const char *file, char **key, int keysize); +int tools_write_mk(const char *file, const char *key, int keysize); + +int tools_read_json_file(struct crypt_device *cd, const char *file, char **json, size_t *json_size); +int tools_write_json_file(struct crypt_device *cd, const char *file, const char *json); + +int tools_detect_signatures(const char *device, int ignore_luks, size_t *count); +int tools_wipe_all_signatures(const char *path); + +/* Log */ +#define log_dbg(x...) clogger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x) +#define log_std(x...) clogger(NULL, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x) +#define log_verbose(x...) clogger(NULL, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x) +#define log_err(x...) clogger(NULL, CRYPT_LOG_ERROR, __FILE__, __LINE__, x) + +#endif /* CRYPTSETUP_H */ diff --git a/src/cryptsetup_reencrypt.c b/src/cryptsetup_reencrypt.c new file mode 100644 index 0000000..b1c7464 --- /dev/null +++ b/src/cryptsetup_reencrypt.c @@ -0,0 +1,1761 @@ +/* + * cryptsetup-reencrypt - crypt utility for offline re-encryption + * + * Copyright (C) 2012-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2012-2019 Milan Broz All rights reserved. + * + * 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. + */ + +#include "cryptsetup.h" +#include <sys/ioctl.h> +#include <linux/fs.h> +#include <arpa/inet.h> +#include <uuid/uuid.h> + +#define PACKAGE_REENC "crypt_reencrypt" + +#define NO_UUID "cafecafe-cafe-cafe-cafe-cafecafeeeee" + +static const char *opt_cipher = NULL; +static const char *opt_hash = NULL; +static const char *opt_key_file = NULL; +static const char *opt_master_key_file = NULL; +static const char *opt_uuid = NULL; +static const char *opt_type = "luks"; +static long opt_keyfile_size = 0; +static long opt_keyfile_offset = 0; +static int opt_iteration_time = 0; +static const char *opt_pbkdf = NULL; +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_version_mode = 0; +static int opt_random = 0; +static int opt_urandom = 0; +static int opt_bsize = 4; +static int opt_directio = 0; +static int opt_fsync = 0; +static int opt_write_log = 0; +static int opt_tries = 3; +static int opt_key_slot = CRYPT_ANY_SLOT; +static int opt_key_size = 0; +static int opt_new = 0; +static int opt_keep_key = 0; +static int opt_decrypt = 0; +static const char *opt_header_device = NULL; + +static const char *opt_reduce_size_str = NULL; +static uint64_t opt_reduce_size = 0; + +static const char *opt_device_size_str = NULL; +static uint64_t opt_device_size = 0; + +static const char **action_argv; + +#define MAX_SLOT 32 +#define MAX_TOKEN 32 +struct reenc_ctx { + char *device; + char *device_header; + char *device_uuid; + const char *type; + uint64_t device_size; /* overridden by parameter */ + uint64_t device_size_new_real; + uint64_t device_size_org_real; + uint64_t device_offset; + uint64_t device_shift; + uint64_t data_offset; + + unsigned int stained:1; + unsigned int in_progress:1; + enum { FORWARD = 0, BACKWARD = 1 } reencrypt_direction; + enum { REENCRYPT = 0, ENCRYPT = 1, DECRYPT = 2 } reencrypt_mode; + + char header_file_org[PATH_MAX]; + char header_file_tmp[PATH_MAX]; + char header_file_new[PATH_MAX]; + char log_file[PATH_MAX]; + + char crypt_path_org[PATH_MAX]; + char crypt_path_new[PATH_MAX]; + int log_fd; + char log_buf[SECTOR_SIZE]; + + struct { + char *password; + size_t passwordLen; + } p[MAX_SLOT]; + int keyslot; + + struct timeval start_time, end_time; + uint64_t resume_bytes; +}; + +char MAGIC[] = {'L','U','K','S', 0xba, 0xbe}; +char NOMAGIC[] = {'L','U','K','S', 0xde, 0xad}; +int MAGIC_L = 6; + +typedef enum { + MAKE_UNUSABLE, + MAKE_USABLE, + CHECK_UNUSABLE, + CHECK_OPEN, +} header_magic; + +static void _quiet_log(int level, const char *msg, void *usrptr) +{ + if (!opt_debug) + return; + tool_log(level, msg, usrptr); +} + +static int alignment(int fd) +{ + int alignment; + + alignment = fpathconf(fd, _PC_REC_XFER_ALIGN); + if (alignment < 0) + alignment = 4096; + return alignment; +} + +static size_t pagesize(void) +{ + long r = sysconf(_SC_PAGESIZE); + return r < 0 ? 4096 : (size_t)r; +} + +static const char *luksType(const char *type) +{ + if (type && !strcmp(type, "luks2")) + return CRYPT_LUKS2; + + if (type && !strcmp(type, "luks1")) + return CRYPT_LUKS1; + + if (!type || !strcmp(type, "luks")) + return crypt_get_default_type(); + + return NULL; +} + +static const char *hdr_device(const struct reenc_ctx *rc) +{ + return rc->device_header ?: rc->device; +} + +static int set_reencrypt_requirement(const struct reenc_ctx *rc) +{ + uint32_t reqs; + int r = -EINVAL; + struct crypt_device *cd = NULL; + struct crypt_params_integrity ip = { 0 }; + + if (crypt_init(&cd, hdr_device(rc)) || + crypt_load(cd, CRYPT_LUKS2, NULL) || + crypt_persistent_flags_get(cd, CRYPT_FLAGS_REQUIREMENTS, &reqs)) + goto out; + + /* reencrypt already in-progress */ + if (reqs & CRYPT_REQUIREMENT_OFFLINE_REENCRYPT) { + log_err(_("Reencryption already in-progress.")); + goto out; + } + + /* raw integrity info is available since 2.0 */ + if (crypt_get_integrity_info(cd, &ip) || ip.tag_size) { + log_err(_("Reencryption of device with integrity profile is not supported.")); + r = -ENOTSUP; + goto out; + } + + r = crypt_persistent_flags_set(cd, CRYPT_FLAGS_REQUIREMENTS, reqs | CRYPT_REQUIREMENT_OFFLINE_REENCRYPT); +out: + crypt_free(cd); + return r; +} + +/* Depends on the first two fields of LUKS1 header format, magic and version */ +static int device_check(struct reenc_ctx *rc, const char *device, header_magic set_magic) +{ + char *buf = NULL; + int r, devfd; + ssize_t s; + uint16_t version; + size_t buf_size = pagesize(); + + devfd = open(device, O_RDWR | O_EXCL | O_DIRECT); + if (devfd == -1) { + if (errno == EBUSY) { + log_err(_("Cannot exclusively open %s, device in use."), + device); + return -EBUSY; + } + log_err(_("Cannot open device %s."), device); + return -EINVAL; + } + + if (set_magic == CHECK_OPEN) { + r = 0; + goto out; + } + + if (posix_memalign((void *)&buf, alignment(devfd), buf_size)) { + log_err(_("Allocation of aligned memory failed.")); + r = -ENOMEM; + goto out; + } + + s = read(devfd, buf, buf_size); + if (s < 0 || s != (ssize_t)buf_size) { + log_err(_("Cannot read device %s."), device); + r = -EIO; + goto out; + } + + /* Be sure that we do not process new version of header */ + memcpy((void*)&version, &buf[MAGIC_L], sizeof(uint16_t)); + version = ntohs(version); + + if (set_magic == MAKE_UNUSABLE && !memcmp(buf, MAGIC, MAGIC_L) && + version == 1) { + log_verbose(_("Marking LUKS1 device %s unusable."), device); + memcpy(buf, NOMAGIC, MAGIC_L); + r = 0; + } else if (set_magic == MAKE_UNUSABLE && version == 2) { + log_verbose(_("Setting LUKS2 offline reencrypt flag on device %s."), device); + r = set_reencrypt_requirement(rc); + if (!r) + rc->stained = 1; + } else if (set_magic == CHECK_UNUSABLE && version == 1) { + r = memcmp(buf, NOMAGIC, MAGIC_L) ? -EINVAL : 0; + if (!r) + rc->device_uuid = strndup(&buf[0xa8], 40); + goto out; + } else + r = -EINVAL; + + if (!r && version == 1) { + if (lseek(devfd, 0, SEEK_SET) == -1) + goto out; + s = write(devfd, buf, buf_size); + if (s < 0 || s != (ssize_t)buf_size) { + log_err(_("Cannot write device %s."), device); + r = -EIO; + } + if (s > 0 && set_magic == MAKE_UNUSABLE) + rc->stained = 1; + } + if (r) + log_dbg("LUKS signature check failed for %s.", device); +out: + if (buf) + memset(buf, 0, buf_size); + free(buf); + close(devfd); + return r; +} + +static int create_empty_header(const char *new_file, uint64_t data_sectors) +{ + int fd, r = 0; + + data_sectors *= SECTOR_SIZE; + + if (!data_sectors) + data_sectors = 4096; + + log_dbg("Creating empty file %s of size %" PRIu64 ".", new_file, data_sectors); + + /* coverity[toctou] */ + fd = open(new_file, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR); + if (fd == -1 || posix_fallocate(fd, 0, data_sectors)) + r = -EINVAL; + if (fd >= 0) + close(fd); + + return r; +} + +static int write_log(struct reenc_ctx *rc) +{ + ssize_t r; + + memset(rc->log_buf, 0, SECTOR_SIZE); + snprintf(rc->log_buf, SECTOR_SIZE, "# LUKS reencryption log, DO NOT EDIT OR DELETE.\n" + "version = %d\nUUID = %s\ndirection = %d\nmode = %d\n" + "offset = %" PRIu64 "\nshift = %" PRIu64 "\n# EOF\n", + 2, rc->device_uuid, rc->reencrypt_direction, rc->reencrypt_mode, + rc->device_offset, rc->device_shift); + + if (lseek(rc->log_fd, 0, SEEK_SET) == -1) + return -EIO; + + r = write(rc->log_fd, rc->log_buf, SECTOR_SIZE); + if (r < 0 || r != SECTOR_SIZE) { + log_err(_("Cannot write reencryption log file.")); + return -EIO; + } + + return 0; +} + +static int parse_line_log(struct reenc_ctx *rc, const char *line) +{ + uint64_t u64; + int i; + char s[64]; + + /* whole line is comment */ + if (*line == '#') + return 0; + + if (sscanf(line, "version = %d", &i) == 1) { + if (i < 1 || i > 2) { + log_dbg("Log: Unexpected version = %i", i); + return -EINVAL; + } + } else if (sscanf(line, "UUID = %40s", s) == 1) { + if (!rc->device_uuid || strcmp(rc->device_uuid, s)) { + log_dbg("Log: Unexpected UUID %s", s); + return -EINVAL; + } + } else if (sscanf(line, "direction = %d", &i) == 1) { + log_dbg("Log: direction = %i", i); + rc->reencrypt_direction = i; + } else if (sscanf(line, "offset = %" PRIu64, &u64) == 1) { + log_dbg("Log: offset = %" PRIu64, u64); + rc->device_offset = u64; + } else if (sscanf(line, "shift = %" PRIu64, &u64) == 1) { + log_dbg("Log: shift = %" PRIu64, u64); + rc->device_shift = u64; + } else if (sscanf(line, "mode = %d", &i) == 1) { /* added in v2 */ + log_dbg("Log: mode = %i", i); + rc->reencrypt_mode = i; + if (rc->reencrypt_mode != REENCRYPT && + rc->reencrypt_mode != ENCRYPT && + rc->reencrypt_mode != DECRYPT) + return -EINVAL; + } else + return -EINVAL; + + return 0; +} + +static int parse_log(struct reenc_ctx *rc) +{ + char *start, *end; + ssize_t s; + + s = read(rc->log_fd, rc->log_buf, SECTOR_SIZE); + if (s == -1) { + log_err(_("Cannot read reencryption log file.")); + return -EIO; + } + + rc->log_buf[SECTOR_SIZE - 1] = '\0'; + start = rc->log_buf; + do { + end = strchr(start, '\n'); + if (end) { + *end++ = '\0'; + if (parse_line_log(rc, start)) { + log_err("Wrong log format."); + return -EINVAL; + } + } + + start = end; + } while (start); + + return 0; +} + +static void close_log(struct reenc_ctx *rc) +{ + log_dbg("Closing LUKS reencryption log file %s.", rc->log_file); + if (rc->log_fd != -1) + close(rc->log_fd); +} + +static int open_log(struct reenc_ctx *rc) +{ + int flags = opt_fsync ? O_SYNC : 0; + + rc->log_fd = open(rc->log_file, O_RDWR|O_EXCL|O_CREAT|flags, S_IRUSR|S_IWUSR); + if (rc->log_fd != -1) { + log_dbg("Created LUKS reencryption log file %s.", rc->log_file); + rc->stained = 0; + } else if (errno == EEXIST) { + log_std(_("Log file %s exists, resuming reencryption.\n"), rc->log_file); + rc->log_fd = open(rc->log_file, O_RDWR|flags); + rc->in_progress = 1; + } + + if (rc->log_fd == -1) + return -EINVAL; + + if (!rc->in_progress && write_log(rc) < 0) { + close_log(rc); + return -EIO; + } + + /* Be sure it is correct format */ + return parse_log(rc); +} + +static int activate_luks_headers(struct reenc_ctx *rc) +{ + struct crypt_device *cd = NULL, *cd_new = NULL; + const char *pwd_old, *pwd_new, pwd_empty[] = ""; + size_t pwd_old_len, pwd_new_len; + int r; + + log_dbg("Activating LUKS devices from headers."); + + /* Never use real password for empty header processing */ + if (rc->reencrypt_mode == REENCRYPT) { + pwd_old = rc->p[rc->keyslot].password; + pwd_old_len = rc->p[rc->keyslot].passwordLen; + pwd_new = pwd_old; + pwd_new_len = pwd_old_len; + } else if (rc->reencrypt_mode == DECRYPT) { + pwd_old = rc->p[rc->keyslot].password; + pwd_old_len = rc->p[rc->keyslot].passwordLen; + pwd_new = pwd_empty; + pwd_new_len = 0; + } else if (rc->reencrypt_mode == ENCRYPT) { + pwd_old = pwd_empty; + pwd_old_len = 0; + pwd_new = rc->p[rc->keyslot].password; + pwd_new_len = rc->p[rc->keyslot].passwordLen; + } else + return -EINVAL; + + if ((r = crypt_init_data_device(&cd, rc->header_file_org, rc->device)) || + (r = crypt_load(cd, CRYPT_LUKS, NULL))) + goto out; + + log_verbose(_("Activating temporary device using old LUKS header.")); + if ((r = crypt_activate_by_passphrase(cd, rc->header_file_org, + opt_key_slot, pwd_old, pwd_old_len, + CRYPT_ACTIVATE_READONLY|CRYPT_ACTIVATE_PRIVATE)) < 0) + goto out; + + if ((r = crypt_init_data_device(&cd_new, rc->header_file_new, rc->device)) || + (r = crypt_load(cd_new, CRYPT_LUKS, NULL))) + goto out; + + log_verbose(_("Activating temporary device using new LUKS header.")); + if ((r = crypt_activate_by_passphrase(cd_new, rc->header_file_new, + opt_key_slot, pwd_new, pwd_new_len, + CRYPT_ACTIVATE_SHARED|CRYPT_ACTIVATE_PRIVATE)) < 0) + goto out; + r = 0; +out: + crypt_free(cd); + crypt_free(cd_new); + if (r < 0) + log_err(_("Activation of temporary devices failed.")); + return r; +} + +static int set_pbkdf_params(struct crypt_device *cd, const char *dev_type) +{ + const struct crypt_pbkdf_type *pbkdf_default; + struct crypt_pbkdf_type pbkdf = {}; + + pbkdf_default = crypt_get_pbkdf_default(dev_type); + if (!pbkdf_default) + return -EINVAL; + + pbkdf.type = opt_pbkdf ?: pbkdf_default->type; + pbkdf.hash = opt_hash ?: pbkdf_default->hash; + pbkdf.time_ms = (uint32_t)opt_iteration_time ?: pbkdf_default->time_ms; + if (strcmp(pbkdf.type, CRYPT_KDF_PBKDF2)) { + pbkdf.max_memory_kb = opt_pbkdf_memory ?: pbkdf_default->max_memory_kb; + pbkdf.parallel_threads = opt_pbkdf_parallel ?: pbkdf_default->parallel_threads; + } + + if (opt_pbkdf_iterations) { + pbkdf.iterations = opt_pbkdf_iterations; + pbkdf.flags |= CRYPT_PBKDF_NO_BENCHMARK; + } + + return crypt_set_pbkdf_type(cd, &pbkdf); +} + +static int create_new_keyslot(struct reenc_ctx *rc, int keyslot, + struct crypt_device *cd_old, + struct crypt_device *cd_new) +{ + int r; + char *key = NULL; + size_t key_size; + + if (cd_old && crypt_keyslot_status(cd_old, keyslot) == CRYPT_SLOT_UNBOUND) { + key_size = 4096; + key = crypt_safe_alloc(key_size); + if (!key) + return -ENOMEM; + r = crypt_volume_key_get(cd_old, keyslot, key, &key_size, + rc->p[keyslot].password, rc->p[keyslot].passwordLen); + if (r == keyslot) { + r = crypt_keyslot_add_by_key(cd_new, keyslot, key, key_size, + rc->p[keyslot].password, rc->p[keyslot].passwordLen, + CRYPT_VOLUME_KEY_NO_SEGMENT); + } else + r = -EINVAL; + crypt_safe_free(key); + } else + r = crypt_keyslot_add_by_volume_key(cd_new, keyslot, NULL, 0, + rc->p[keyslot].password, rc->p[keyslot].passwordLen); + + return r; +} + +static int create_new_header(struct reenc_ctx *rc, struct crypt_device *cd_old, + const char *cipher, const char *cipher_mode, + const char *uuid, + const char *key, int key_size, + const char *type, + uint64_t metadata_size, + uint64_t keyslots_size, + void *params) +{ + struct crypt_device *cd_new = NULL; + int i, r; + + if ((r = crypt_init(&cd_new, rc->header_file_new))) + goto out; + + if (opt_random) + crypt_set_rng_type(cd_new, CRYPT_RNG_RANDOM); + else if (opt_urandom) + crypt_set_rng_type(cd_new, CRYPT_RNG_URANDOM); + + r = set_pbkdf_params(cd_new, type); + if (r) { + log_err(_("Failed to set PBKDF parameters.")); + goto out; + } + + r = crypt_set_data_offset(cd_new, rc->data_offset); + if (r) { + log_err(_("Failed to set data offset.")); + goto out; + } + + r = crypt_set_metadata_size(cd_new, metadata_size, keyslots_size); + if (r) { + log_err(_("Failed to set metadata size.")); + goto out; + } + + r = crypt_format(cd_new, type, cipher, cipher_mode, uuid, key, key_size, params); + check_signal(&r); + if (r < 0) + goto out; + log_verbose(_("New LUKS header for device %s created."), rc->device); + + for (i = 0; i < crypt_keyslot_max(type); i++) { + if (!rc->p[i].password) + continue; + + r = create_new_keyslot(rc, i, cd_old, cd_new); + check_signal(&r); + if (r < 0) + goto out; + tools_keyslot_msg(r, CREATED); + r = 0; + } +out: + crypt_free(cd_new); + return r; +} + +static int isLUKS2(const char *type) +{ + return (type && !strcmp(type, CRYPT_LUKS2)); +} + +static int luks2_metadata_copy(struct reenc_ctx *rc) +{ + const char *json, *type; + crypt_token_info ti; + uint32_t flags; + int i, r = -EINVAL; + struct crypt_device *cd_old = NULL, *cd_new = NULL; + + if (crypt_init(&cd_old, rc->header_file_tmp) || + crypt_load(cd_old, CRYPT_LUKS2, NULL)) + goto out; + + if (crypt_init(&cd_new, rc->header_file_new) || + crypt_load(cd_new, CRYPT_LUKS2, NULL)) + goto out; + + /* + * we have to erase keyslots missing in new header so that we can + * transfer tokens from old header to new one + */ + for (i = 0; i < crypt_keyslot_max(CRYPT_LUKS2); i++) + if (!rc->p[i].password && crypt_keyslot_status(cd_old, i) == CRYPT_SLOT_ACTIVE) { + r = crypt_keyslot_destroy(cd_old, i); + if (r < 0) + goto out; + } + + for (i = 0; i < MAX_TOKEN; i++) { + ti = crypt_token_status(cd_old, i, &type); + switch (ti) { + case CRYPT_TOKEN_INVALID: + log_dbg("Internal error."); + r = -EINVAL; + goto out; + case CRYPT_TOKEN_INACTIVE: + break; + case CRYPT_TOKEN_INTERNAL_UNKNOWN: + log_err(_("This version of cryptsetup-reencrypt can't handle new internal token type %s."), type); + r = -EINVAL; + goto out; + case CRYPT_TOKEN_INTERNAL: + /* fallthrough */ + case CRYPT_TOKEN_EXTERNAL: + /* fallthrough */ + case CRYPT_TOKEN_EXTERNAL_UNKNOWN: + if (crypt_token_json_get(cd_old, i, &json) != i) { + log_dbg("Failed to get %s token (%d).", type, i); + r = -EINVAL; + goto out; + } + if (crypt_token_json_set(cd_new, i, json) != i) { + log_dbg("Failed to create %s token (%d).", type, i); + r = -EINVAL; + goto out; + } + } + } + + if ((r = crypt_persistent_flags_get(cd_old, CRYPT_FLAGS_ACTIVATION, &flags))) { + log_err(_("Failed to read activation flags from backup header.")); + goto out; + } + if ((r = crypt_persistent_flags_set(cd_new, CRYPT_FLAGS_ACTIVATION, flags))) { + log_err(_("Failed to write activation flags to new header.")); + goto out; + } + if ((r = crypt_persistent_flags_get(cd_old, CRYPT_FLAGS_REQUIREMENTS, &flags))) { + log_err(_("Failed to read requirements from backup header.")); + goto out; + } + if ((r = crypt_persistent_flags_set(cd_new, CRYPT_FLAGS_REQUIREMENTS, flags))) + log_err(_("Failed to read requirements from backup header.")); +out: + crypt_free(cd_old); + crypt_free(cd_new); + unlink(rc->header_file_tmp); + + return r; +} + +static int backup_luks_headers(struct reenc_ctx *rc) +{ + struct crypt_device *cd = NULL; + struct crypt_params_luks1 params = {0}; + struct crypt_params_luks2 params2 = {0}; + struct stat st; + char cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN]; + char *key = NULL; + size_t key_size; + uint64_t mdata_size = 0, keyslots_size = 0; + int r; + + log_dbg("Creating LUKS header backup for device %s.", hdr_device(rc)); + + if ((r = crypt_init(&cd, hdr_device(rc))) || + (r = crypt_load(cd, CRYPT_LUKS, NULL))) + goto out; + + if ((r = crypt_header_backup(cd, CRYPT_LUKS, rc->header_file_org))) + goto out; + if (isLUKS2(rc->type)) { + if ((r = crypt_header_backup(cd, CRYPT_LUKS2, rc->header_file_tmp))) + goto out; + if ((r = stat(rc->header_file_tmp, &st))) + goto out; + /* coverity[toctou] */ + if ((r = chmod(rc->header_file_tmp, st.st_mode | S_IWUSR))) + goto out; + } + log_verbose(_("%s header backup of device %s created."), isLUKS2(rc->type) ? "LUKS2" : "LUKS1", rc->device); + + /* For decrypt, new header will be fake one, so we are done here. */ + if (rc->reencrypt_mode == DECRYPT) + goto out; + + rc->data_offset = crypt_get_data_offset(cd) + ROUND_SECTOR(opt_reduce_size); + + if ((r = create_empty_header(rc->header_file_new, rc->data_offset))) + goto out; + + params.hash = opt_hash ?: DEFAULT_LUKS1_HASH; + params2.data_device = params.data_device = rc->device; + params2.sector_size = crypt_get_sector_size(cd); + + if (opt_cipher) { + r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, cipher_mode); + if (r < 0) { + log_err(_("No known cipher specification pattern detected.")); + goto out; + } + } + + key_size = opt_key_size ? opt_key_size / 8 : crypt_get_volume_key_size(cd); + + if (opt_keep_key) { + log_dbg("Keeping key from old header."); + key_size = crypt_get_volume_key_size(cd); + key = crypt_safe_alloc(key_size); + if (!key) { + r = -ENOMEM; + goto out; + } + r = crypt_volume_key_get(cd, CRYPT_ANY_SLOT, key, &key_size, + rc->p[rc->keyslot].password, rc->p[rc->keyslot].passwordLen); + } else if (opt_master_key_file) { + log_dbg("Loading new key from file."); + r = tools_read_mk(opt_master_key_file, &key, key_size); + } + + if (r < 0) + goto out; + + if (isLUKS2(crypt_get_type(cd)) && crypt_get_metadata_size(cd, &mdata_size, &keyslots_size)) + goto out; + + r = create_new_header(rc, cd, + opt_cipher ? cipher : crypt_get_cipher(cd), + opt_cipher ? cipher_mode : crypt_get_cipher_mode(cd), + crypt_get_uuid(cd), + key, + key_size, + rc->type, + mdata_size, + keyslots_size, + isLUKS2(rc->type) ? (void*)¶ms2 : (void*)¶ms); + + if (!r && isLUKS2(rc->type)) + r = luks2_metadata_copy(rc); +out: + crypt_free(cd); + crypt_safe_free(key); + if (r) + log_err(_("Creation of LUKS backup headers failed.")); + return r; +} + +/* Create fake header for original device */ +static int backup_fake_header(struct reenc_ctx *rc) +{ + struct crypt_device *cd_new = NULL; + struct crypt_params_luks1 params = {0}; + struct crypt_params_luks2 params2 = {0}; + char cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN]; + const char *header_file_fake; + int r; + + log_dbg("Creating fake (cipher_null) header for %s device.", + (rc->reencrypt_mode == DECRYPT) ? "new" : "original"); + + header_file_fake = (rc->reencrypt_mode == DECRYPT) ? rc->header_file_new : rc->header_file_org; + + if (!opt_key_size) + opt_key_size = DEFAULT_LUKS1_KEYBITS; + + if (opt_cipher) { + r = crypt_parse_name_and_mode(opt_cipher, cipher, NULL, cipher_mode); + if (r < 0) { + log_err(_("No known cipher specification pattern detected.")); + goto out; + } + } + + r = create_empty_header(header_file_fake, 0); + if (r < 0) + return r; + + params.hash = opt_hash ?: DEFAULT_LUKS1_HASH; + params2.data_alignment = params.data_alignment = 0; + params2.data_device = params.data_device = rc->device; + params2.sector_size = crypt_get_sector_size(NULL); + params2.pbkdf = crypt_get_pbkdf_default(CRYPT_LUKS2); + + r = crypt_init(&cd_new, header_file_fake); + if (r < 0) + return r; + + r = crypt_format(cd_new, CRYPT_LUKS1, "cipher_null", "ecb", + NO_UUID, NULL, opt_key_size / 8, ¶ms); + check_signal(&r); + if (r < 0) + goto out; + + r = crypt_keyslot_add_by_volume_key(cd_new, rc->keyslot, NULL, 0, + rc->p[rc->keyslot].password, rc->p[rc->keyslot].passwordLen); + check_signal(&r); + if (r < 0) + goto out; + + /* The real header is backup header created in backup_luks_headers() */ + if (rc->reencrypt_mode == DECRYPT) + goto out; + + r = create_empty_header(rc->header_file_new, ROUND_SECTOR(opt_reduce_size)); + if (r < 0) + goto out; + + params2.data_alignment = params.data_alignment = ROUND_SECTOR(opt_reduce_size); + r = create_new_header(rc, NULL, + opt_cipher ? cipher : DEFAULT_LUKS1_CIPHER, + opt_cipher ? cipher_mode : DEFAULT_LUKS1_MODE, + NULL, NULL, + (opt_key_size ? opt_key_size : DEFAULT_LUKS1_KEYBITS) / 8, + rc->type, + 0, + 0, + isLUKS2(rc->type) ? (void*)¶ms2 : (void*)¶ms); +out: + crypt_free(cd_new); + return r; +} + +static void remove_headers(struct reenc_ctx *rc) +{ + struct crypt_device *cd = NULL; + + log_dbg("Removing headers."); + + if (crypt_init(&cd, NULL)) + return; + crypt_set_log_callback(cd, _quiet_log, NULL); + if (*rc->header_file_org) + (void)crypt_deactivate(cd, rc->header_file_org); + if (*rc->header_file_new) + (void)crypt_deactivate(cd, rc->header_file_new); + crypt_free(cd); +} + +static int restore_luks_header(struct reenc_ctx *rc) +{ + struct stat st; + struct crypt_device *cd = NULL; + int fd, r; + + log_dbg("Restoring header for %s from %s.", hdr_device(rc), rc->header_file_new); + + /* + * For new encryption and new detached header in file just move it. + * For existing file try to ensure we have prealocated space for restore. + */ + if (opt_new && rc->device_header) { + r = stat(rc->device_header, &st); + if (r == -1) { + r = rename(rc->header_file_new, rc->device_header); + goto out; + } else if ((st.st_mode & S_IFMT) == S_IFREG && + stat(rc->header_file_new, &st) != -1) { + /* coverity[toctou] */ + fd = open(rc->device_header, O_WRONLY); + if (fd != -1) { + if (posix_fallocate(fd, 0, st.st_size)) {}; + close(fd); + } + } + } + + r = crypt_init(&cd, hdr_device(rc)); + if (r == 0) { + r = crypt_header_restore(cd, rc->type, rc->header_file_new); + } + + crypt_free(cd); +out: + if (r) + log_err(_("Cannot restore %s header on device %s."), isLUKS2(rc->type) ? "LUKS2" : "LUKS1", hdr_device(rc)); + else { + log_verbose(_("%s header on device %s restored."), isLUKS2(rc->type) ? "LUKS2" : "LUKS1", hdr_device(rc)); + rc->stained = 0; + } + return r; +} + +static ssize_t read_buf(int fd, void *buf, size_t count) +{ + size_t read_size = 0; + ssize_t s; + + do { + /* This expects that partial read is aligned in buffer */ + s = read(fd, buf, count - read_size); + if (s == -1 && errno != EINTR) + return s; + if (s == 0) + return (ssize_t)read_size; + if (s > 0) { + if (s != (ssize_t)count) + log_dbg("Partial read %zd / %zu.", s, count); + read_size += (size_t)s; + buf = (uint8_t*)buf + s; + } + } while (read_size != count); + + return (ssize_t)count; +} + +static int copy_data_forward(struct reenc_ctx *rc, int fd_old, int fd_new, + size_t block_size, void *buf, uint64_t *bytes) +{ + ssize_t s1, s2; + + log_dbg("Reencrypting in forward direction."); + + if (lseek64(fd_old, rc->device_offset, SEEK_SET) < 0 || + lseek64(fd_new, rc->device_offset, SEEK_SET) < 0) { + log_err(_("Cannot seek to device offset.")); + return -EIO; + } + + rc->resume_bytes = *bytes = rc->device_offset; + + if (write_log(rc) < 0) + return -EIO; + + while (!quit && rc->device_offset < rc->device_size) { + s1 = read_buf(fd_old, buf, block_size); + if (s1 < 0 || ((size_t)s1 != block_size && + (rc->device_offset + s1) != rc->device_size)) { + log_dbg("Read error, expecting %zu, got %zd.", + block_size, s1); + return -EIO; + } + + /* If device_size is forced, never write more than limit */ + if ((s1 + rc->device_offset) > rc->device_size) + s1 = rc->device_size - rc->device_offset; + + s2 = write(fd_new, buf, s1); + if (s2 < 0) { + log_dbg("Write error, expecting %zu, got %zd.", + block_size, s2); + return -EIO; + } + + rc->device_offset += s1; + if (opt_write_log && write_log(rc) < 0) + return -EIO; + + if (opt_fsync && fsync(fd_new) < 0) { + log_dbg("Write error, fsync."); + return -EIO; + } + + *bytes += (uint64_t)s2; + tools_time_progress(rc->device_size, *bytes, + &rc->start_time, &rc->end_time); + } + + return quit ? -EAGAIN : 0; +} + +static int copy_data_backward(struct reenc_ctx *rc, int fd_old, int fd_new, + size_t block_size, void *buf, uint64_t *bytes) +{ + ssize_t s1, s2, working_block; + off64_t working_offset; + + log_dbg("Reencrypting in backward direction."); + + if (!rc->in_progress) { + rc->device_offset = rc->device_size; + rc->resume_bytes = 0; + *bytes = 0; + } else { + rc->resume_bytes = rc->device_size - rc->device_offset; + *bytes = rc->resume_bytes; + } + + if (write_log(rc) < 0) + return -EIO; + + /* dirty the device during ENCRYPT mode */ + rc->stained = 1; + + while (!quit && rc->device_offset) { + if (rc->device_offset < block_size) { + working_offset = 0; + working_block = rc->device_offset; + } else { + working_offset = rc->device_offset - block_size; + working_block = block_size; + } + + if (lseek64(fd_old, working_offset, SEEK_SET) < 0 || + lseek64(fd_new, working_offset, SEEK_SET) < 0) { + log_err(_("Cannot seek to device offset.")); + return -EIO; + } + + s1 = read_buf(fd_old, buf, working_block); + if (s1 < 0 || (s1 != working_block)) { + log_dbg("Read error, expecting %zu, got %zd.", + block_size, s1); + return -EIO; + } + + s2 = write(fd_new, buf, working_block); + if (s2 < 0) { + log_dbg("Write error, expecting %zu, got %zd.", + block_size, s2); + return -EIO; + } + + rc->device_offset -= s1; + if (opt_write_log && write_log(rc) < 0) + return -EIO; + + if (opt_fsync && fsync(fd_new) < 0) { + log_dbg("Write error, fsync."); + return -EIO; + } + + *bytes += (uint64_t)s2; + tools_time_progress(rc->device_size, *bytes, + &rc->start_time, &rc->end_time); + } + + return quit ? -EAGAIN : 0; +} + +static void zero_rest_of_device(int fd, size_t block_size, void *buf, + uint64_t *bytes, uint64_t offset) +{ + ssize_t s1, s2; + + log_dbg("Zeroing rest of device."); + + if (lseek64(fd, offset, SEEK_SET) < 0) { + log_dbg(_("Cannot seek to device offset.\n")); + return; + } + + memset(buf, 0, block_size); + s1 = block_size; + + while (!quit && *bytes) { + if (*bytes < (uint64_t)s1) + s1 = *bytes; + + s2 = write(fd, buf, s1); + if (s2 != s1) { + log_dbg("Write error, expecting %zd, got %zd.", + s1, s2); + return; + } + + if (opt_fsync && fsync(fd) < 0) { + log_dbg("Write error, fsync."); + return; + } + + *bytes -= s2; + } +} + +static int copy_data(struct reenc_ctx *rc) +{ + size_t block_size = opt_bsize * 1024 * 1024; + int fd_old = -1, fd_new = -1; + int r = -EINVAL; + void *buf = NULL; + uint64_t bytes = 0; + + log_dbg("Data copy preparation."); + + fd_old = open(rc->crypt_path_org, O_RDONLY | (opt_directio ? O_DIRECT : 0)); + if (fd_old == -1) { + log_err(_("Cannot open temporary LUKS device.")); + goto out; + } + + fd_new = open(rc->crypt_path_new, O_WRONLY | (opt_directio ? O_DIRECT : 0)); + if (fd_new == -1) { + log_err(_("Cannot open temporary LUKS device.")); + goto out; + } + + if (ioctl(fd_old, BLKGETSIZE64, &rc->device_size_org_real) < 0) { + log_err(_("Cannot get device size.")); + goto out; + } + + if (ioctl(fd_new, BLKGETSIZE64, &rc->device_size_new_real) < 0) { + log_err(_("Cannot get device size.")); + goto out; + } + + if (opt_device_size) + rc->device_size = opt_device_size; + else if (rc->reencrypt_mode == DECRYPT) + rc->device_size = rc->device_size_org_real; + else + rc->device_size = rc->device_size_new_real; + + if (posix_memalign((void *)&buf, alignment(fd_new), block_size)) { + log_err(_("Allocation of aligned memory failed.")); + r = -ENOMEM; + goto out; + } + + set_int_handler(0); + tools_time_progress(rc->device_size, bytes, + &rc->start_time, &rc->end_time); + + if (rc->reencrypt_direction == FORWARD) + r = copy_data_forward(rc, fd_old, fd_new, block_size, buf, &bytes); + else + r = copy_data_backward(rc, fd_old, fd_new, block_size, buf, &bytes); + + /* Zero (wipe) rest of now plain-only device when decrypting. + * (To not leave any sign of encryption here.) */ + if (!r && rc->reencrypt_mode == DECRYPT && + rc->device_size_new_real > rc->device_size_org_real) { + bytes = rc->device_size_new_real - rc->device_size_org_real; + zero_rest_of_device(fd_new, block_size, buf, &bytes, rc->device_size_org_real); + } + + set_int_block(1); + + if (r == -EAGAIN) + log_err(_("Interrupted by a signal.")); + else if (r < 0) + log_err(_("IO error during reencryption.")); + + (void)write_log(rc); +out: + if (fd_old != -1) + close(fd_old); + if (fd_new != -1) + close(fd_new); + free(buf); + return r; +} + +static int initialize_uuid(struct reenc_ctx *rc) +{ + struct crypt_device *cd = NULL; + int r; + uuid_t device_uuid; + + log_dbg("Initialising UUID."); + + if (opt_new) { + rc->device_uuid = strdup(NO_UUID); + rc->type = luksType(opt_type); + return 0; + } + + if (opt_decrypt && opt_uuid) { + r = uuid_parse(opt_uuid, device_uuid); + if (!r) + rc->device_uuid = strdup(opt_uuid); + else + log_err(_("Provided UUID is invalid.")); + + return r; + } + + /* Try to load LUKS from device */ + if ((r = crypt_init(&cd, hdr_device(rc)))) + return r; + crypt_set_log_callback(cd, _quiet_log, NULL); + r = crypt_load(cd, CRYPT_LUKS, NULL); + if (!r) + rc->device_uuid = strdup(crypt_get_uuid(cd)); + else + /* Reencryption already in progress - magic header? */ + r = device_check(rc, hdr_device(rc), CHECK_UNUSABLE); + + if (!r) + rc->type = isLUKS2(crypt_get_type(cd)) ? CRYPT_LUKS2 : CRYPT_LUKS1; + + crypt_free(cd); + return r; +} + +static int init_passphrase1(struct reenc_ctx *rc, struct crypt_device *cd, + const char *msg, int slot_to_check, int check, int verify) +{ + crypt_keyslot_info ki; + char *password; + int r = -EINVAL, retry_count; + size_t passwordLen; + + /* mode ENCRYPT call this without header */ + if (cd && slot_to_check != CRYPT_ANY_SLOT) { + ki = crypt_keyslot_status(cd, slot_to_check); + if (ki < CRYPT_SLOT_ACTIVE) + return -ENOENT; + } else + ki = CRYPT_SLOT_ACTIVE; + + retry_count = opt_tries ?: 1; + while (retry_count--) { + r = tools_get_key(msg, &password, &passwordLen, 0, 0, + NULL /*opt_key_file*/, 0, verify, 0 /*pwquality*/, cd); + if (r < 0) + return r; + if (quit) { + crypt_safe_free(password); + password = NULL; + passwordLen = 0; + return -EAGAIN; + } + + if (check) + r = crypt_activate_by_passphrase(cd, NULL, slot_to_check, + password, passwordLen, CRYPT_ACTIVATE_ALLOW_UNBOUND_KEY); + else + r = (slot_to_check == CRYPT_ANY_SLOT) ? 0 : slot_to_check; + + if (r < 0) { + crypt_safe_free(password); + password = NULL; + passwordLen = 0; + } + if (r < 0 && r != -EPERM) + return r; + + if (r >= 0) { + tools_keyslot_msg(r, UNLOCKED); + rc->p[r].password = password; + rc->p[r].passwordLen = passwordLen; + if (ki != CRYPT_SLOT_UNBOUND) + rc->keyslot = r; + break; + } + tools_passphrase_msg(r); + } + + password = NULL; + passwordLen = 0; + + return r; +} + +static int init_keyfile(struct reenc_ctx *rc, struct crypt_device *cd, int slot_check) +{ + char *password; + int r; + size_t passwordLen; + + r = tools_get_key(NULL, &password, &passwordLen, opt_keyfile_offset, + opt_keyfile_size, opt_key_file, 0, 0, 0, cd); + if (r < 0) + return r; + + r = crypt_activate_by_passphrase(cd, NULL, slot_check, password, + passwordLen, 0); + + /* + * Allow keyslot only if it is last slot or if user explicitly + * specify which slot to use (IOW others will be disabled). + */ + if (r >= 0 && opt_key_slot == CRYPT_ANY_SLOT && + crypt_keyslot_status(cd, r) != CRYPT_SLOT_ACTIVE_LAST) { + log_err(_("Key file can be used only with --key-slot or with " + "exactly one key slot active.")); + r = -EINVAL; + } + + if (r < 0) { + crypt_safe_free(password); + tools_passphrase_msg(r); + } else { + rc->keyslot = r; + rc->p[r].password = password; + rc->p[r].passwordLen = passwordLen; + } + + password = NULL; + passwordLen = 0; + + return r; +} + +static int initialize_passphrase(struct reenc_ctx *rc, const char *device) +{ + struct crypt_device *cd = NULL; + char msg[256]; + int i, r; + + log_dbg("Passphrases initialization."); + + if (rc->reencrypt_mode == ENCRYPT && !rc->in_progress) { + r = init_passphrase1(rc, cd, _("Enter new passphrase: "), opt_key_slot, 0, 1); + return r > 0 ? 0 : r; + } + + if ((r = crypt_init_data_device(&cd, device, rc->device)) || + (r = crypt_load(cd, CRYPT_LUKS, NULL))) { + crypt_free(cd); + return r; + } + + if (opt_key_slot != CRYPT_ANY_SLOT) + snprintf(msg, sizeof(msg), + _("Enter passphrase for key slot %u: "), opt_key_slot); + else + snprintf(msg, sizeof(msg), _("Enter any existing passphrase: ")); + + if (opt_key_file) { + r = init_keyfile(rc, cd, opt_key_slot); + } else if (rc->in_progress || + opt_key_slot != CRYPT_ANY_SLOT || + rc->reencrypt_mode == DECRYPT) { + r = init_passphrase1(rc, cd, msg, opt_key_slot, 1, 0); + } else for (i = 0; i < crypt_keyslot_max(crypt_get_type(cd)); i++) { + snprintf(msg, sizeof(msg), _("Enter passphrase for key slot %u: "), i); + r = init_passphrase1(rc, cd, msg, i, 1, 0); + if (r == -ENOENT) { + r = 0; + continue; + } + if (r < 0) + break; + } + + crypt_free(cd); + return r > 0 ? 0 : r; +} + +static int initialize_context(struct reenc_ctx *rc, const char *device) +{ + log_dbg("Initialising reencryption context."); + + rc->log_fd = -1; + + /* FIXME: replace MAX_KEYSLOT with crypt_keyslot_max(CRYPT_LUKS2) */ + if (crypt_keyslot_max(CRYPT_LUKS2) > MAX_SLOT) { + log_dbg("Internal error"); + return -EINVAL; + } + + if (!(rc->device = strndup(device, PATH_MAX))) + return -ENOMEM; + + if (opt_header_device && !(rc->device_header = strndup(opt_header_device, PATH_MAX))) + return -ENOMEM; + + if (device_check(rc, rc->device, CHECK_OPEN) < 0) + return -EINVAL; + + if (initialize_uuid(rc)) { + log_err(_("Device %s is not a valid LUKS device."), device); + return -EINVAL; + } + + if (opt_key_slot != CRYPT_ANY_SLOT && + opt_key_slot >= crypt_keyslot_max(rc->type)) { + log_err(_("Key slot is invalid.")); + return -EINVAL; + } + + /* Prepare device names */ + if (snprintf(rc->log_file, PATH_MAX, + "LUKS-%s.log", rc->device_uuid) < 0) + return -ENOMEM; + if (snprintf(rc->header_file_org, PATH_MAX, + "LUKS-%s.org", rc->device_uuid) < 0) + return -ENOMEM; + if (snprintf(rc->header_file_new, PATH_MAX, + "LUKS-%s.new", rc->device_uuid) < 0) + return -ENOMEM; + if (snprintf(rc->header_file_tmp, PATH_MAX, + "LUKS-%s.tmp", rc->device_uuid) < 0) + return -ENOMEM; + + /* Paths to encrypted devices */ + if (snprintf(rc->crypt_path_org, PATH_MAX, + "%s/%s", crypt_get_dir(), rc->header_file_org) < 0) + return -ENOMEM; + if (snprintf(rc->crypt_path_new, PATH_MAX, + "%s/%s", crypt_get_dir(), rc->header_file_new) < 0) + return -ENOMEM; + + remove_headers(rc); + + if (open_log(rc) < 0) { + log_err(_("Cannot open reencryption log file.")); + return -EINVAL; + } + + if (!rc->in_progress) { + if (opt_uuid) { + log_err(_("No decryption in progress, provided UUID can " + "be used only to resume suspended decryption process.")); + return -EINVAL; + } + + if (!opt_reduce_size) + rc->reencrypt_direction = FORWARD; + else { + rc->reencrypt_direction = BACKWARD; + rc->device_offset = (uint64_t)~0; + } + + if (opt_new) + rc->reencrypt_mode = ENCRYPT; + else if (opt_decrypt) + rc->reencrypt_mode = DECRYPT; + else + rc->reencrypt_mode = REENCRYPT; + } + + return 0; +} + +static void destroy_context(struct reenc_ctx *rc) +{ + int i; + + log_dbg("Destroying reencryption context."); + + close_log(rc); + remove_headers(rc); + + if (!rc->stained) { + unlink(rc->log_file); + unlink(rc->header_file_org); + unlink(rc->header_file_new); + unlink(rc->header_file_tmp); + } + + for (i = 0; i < MAX_SLOT; i++) + crypt_safe_free(rc->p[i].password); + + free(rc->device); + free(rc->device_header); + free(rc->device_uuid); +} + +static int luks2_change_pbkdf_params(struct reenc_ctx *rc) +{ + int i, r; + struct crypt_device *cd = NULL; + + if ((r = initialize_passphrase(rc, hdr_device(rc)))) + return r; + + if (crypt_init(&cd, hdr_device(rc)) || + crypt_load(cd, CRYPT_LUKS2, NULL)) { + r = -EINVAL; + goto out; + } + + if ((r = set_pbkdf_params(cd, CRYPT_LUKS2))) + goto out; + + log_dbg("LUKS2 keyslot pbkdf params change."); + + r = -EINVAL; + + for (i = 0; i < crypt_keyslot_max(CRYPT_LUKS2); i++) { + if (!rc->p[i].password) + continue; + if ((r = crypt_keyslot_change_by_passphrase(cd, i, i, + rc->p[i].password, rc->p[i].passwordLen, + rc->p[i].password, rc->p[i].passwordLen)) < 0) + goto out; + log_verbose(_("Changed pbkdf parameters in keyslot %i."), r); + r = 0; + } + + if (r) + goto out; + + /* see create_new_header */ + for (i = 0; i < crypt_keyslot_max(CRYPT_LUKS2); i++) + if (!rc->p[i].password) + (void)crypt_keyslot_destroy(cd, i); +out: + crypt_free(cd); + return r; +} + +static int run_reencrypt(const char *device) +{ + int r = -EINVAL; + static struct reenc_ctx rc = { + .stained = 1 + }; + + set_int_handler(0); + + if (initialize_context(&rc, device)) + goto out; + + /* short-circuit LUKS2 keyslot parameters change */ + if (opt_keep_key && isLUKS2(rc.type)) { + r = luks2_change_pbkdf_params(&rc); + goto out; + } + + log_dbg("Running reencryption."); + + if (!rc.in_progress) { + if ((r = initialize_passphrase(&rc, hdr_device(&rc)))) + goto out; + + log_dbg("Storing backup of LUKS headers."); + if (rc.reencrypt_mode == ENCRYPT) { + /* Create fake header for existing device */ + if ((r = backup_fake_header(&rc))) + goto out; + } else { + if ((r = backup_luks_headers(&rc))) + goto out; + /* Create fake header for decrypted device */ + if (rc.reencrypt_mode == DECRYPT && + (r = backup_fake_header(&rc))) + goto out; + if ((r = device_check(&rc, hdr_device(&rc), MAKE_UNUSABLE))) + goto out; + } + } else { + if ((r = initialize_passphrase(&rc, opt_decrypt ? rc.header_file_org : rc.header_file_new))) + goto out; + } + + if (!opt_keep_key) { + log_dbg("Running data area reencryption."); + if ((r = activate_luks_headers(&rc))) + goto out; + + if ((r = copy_data(&rc))) + goto out; + } else + log_dbg("Keeping existing key, skipping data area reencryption."); + + // FIXME: fix error path above to not skip this + if (rc.reencrypt_mode != DECRYPT) + r = restore_luks_header(&rc); + else + rc.stained = 0; +out: + destroy_context(&rc); + return r; +} + +static void help(poptContext popt_context, + enum poptCallbackReason reason __attribute__((unused)), + struct poptOption *key, + const char *arg __attribute__((unused)), + void *data __attribute__((unused))) +{ + if (key->shortName == '?') { + log_std("%s %s\n", PACKAGE_REENC, PACKAGE_VERSION); + poptPrintHelp(popt_context, stdout, 0); + exit(EXIT_SUCCESS); + } else + usage(popt_context, EXIT_SUCCESS, NULL, NULL); +} + +int main(int argc, const char **argv) +{ + static struct poptOption popt_help_options[] = { + { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL }, + { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL }, + { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL }, + POPT_TABLEEND + }; + static struct poptOption popt_options[] = { + { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL }, + { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), 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 }, + { "block-size", 'B', POPT_ARG_INT, &opt_bsize, 0, N_("Reencryption block size"), N_("MiB") }, + { "cipher", 'c', POPT_ARG_STRING, &opt_cipher, 0, N_("The cipher used to encrypt the disk (see /proc/crypto)"), NULL }, + { "key-size", 's', POPT_ARG_INT, &opt_key_size, 0, N_("The size of the encryption key"), N_("BITS") }, + { "hash", 'h', POPT_ARG_STRING, &opt_hash, 0, N_("The hash used to create the encryption key from the passphrase"), NULL }, + { "keep-key", '\0', POPT_ARG_NONE, &opt_keep_key, 0, N_("Do not change key, no data area reencryption"), NULL }, + { "key-file", 'd', POPT_ARG_STRING, &opt_key_file, 0, N_("Read the key from a file"), NULL }, + { "master-key-file", '\0', POPT_ARG_STRING, &opt_master_key_file, 0, N_("Read new volume (master) key from file"), NULL }, + { "iter-time", 'i', POPT_ARG_INT, &opt_iteration_time, 0, N_("PBKDF2 iteration time for LUKS (in ms)"), N_("msecs") }, + { "batch-mode", 'q', POPT_ARG_NONE, &opt_batch_mode, 0, N_("Do not ask for confirmation"), NULL }, + { "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 }, + { "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 }, + { "use-directio", '\0', POPT_ARG_NONE, &opt_directio, 0, N_("Use direct-io when accessing devices"), NULL }, + { "use-fsync", '\0', POPT_ARG_NONE, &opt_fsync, 0, N_("Use fsync after each block"), NULL }, + { "write-log", '\0', POPT_ARG_NONE, &opt_write_log, 0, N_("Update log file after every block"), NULL }, + { "key-slot", 'S', POPT_ARG_INT, &opt_key_slot, 0, N_("Use only this slot (others will be disabled)"), NULL }, + { "keyfile-offset", '\0', POPT_ARG_LONG, &opt_keyfile_offset, 0, N_("Number of bytes to skip in keyfile"), N_("bytes") }, + { "keyfile-size", 'l', POPT_ARG_LONG, &opt_keyfile_size, 0, N_("Limits the read from keyfile"), N_("bytes") }, + { "reduce-device-size",'\0', POPT_ARG_STRING, &opt_reduce_size_str, 0, N_("Reduce data device size (move data offset). DANGEROUS!"), N_("bytes") }, + { "device-size", '\0', POPT_ARG_STRING, &opt_device_size_str, 0, N_("Use only specified device size (ignore rest of device). DANGEROUS!"), N_("bytes") }, + { "new", 'N', POPT_ARG_NONE, &opt_new, 0, N_("Create new header on not encrypted device"), NULL }, + { "decrypt", '\0', POPT_ARG_NONE, &opt_decrypt, 0, N_("Permanently decrypt device (remove encryption)"), NULL }, + { "uuid", '\0', POPT_ARG_STRING, &opt_uuid, 0, N_("The UUID used to resume decryption"), NULL }, + { "type", '\0', POPT_ARG_STRING, &opt_type, 0, N_("Type of LUKS metadata: luks1, luks2"), NULL }, + { "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 }, + { "header", '\0', POPT_ARG_STRING, &opt_header_device, 0, N_("Device or file with separated LUKS header"), NULL }, + POPT_TABLEEND + }; + poptContext popt_context; + int r; + + crypt_set_log_callback(NULL, tool_log, NULL); + + setlocale(LC_ALL, ""); + bindtextdomain(PACKAGE, LOCALEDIR); + textdomain(PACKAGE); + + popt_context = poptGetContext(PACKAGE, argc, argv, popt_options, 0); + poptSetOtherOptionHelp(popt_context, + _("[OPTION...] <device>")); + + while((r = poptGetNextOpt(popt_context)) > 0) ; + if (r < -1) + usage(popt_context, EXIT_FAILURE, poptStrerror(r), + poptBadOption(popt_context, POPT_BADOPTION_NOALIAS)); + + if (opt_version_mode) { + log_std("%s %s\n", PACKAGE_REENC, PACKAGE_VERSION); + poptFreeContext(popt_context); + exit(EXIT_SUCCESS); + } + + if (!opt_batch_mode) + log_verbose(_("Reencryption will change: %s%s%s%s%s%s."), + opt_keep_key ? "" : _("volume key"), + (!opt_keep_key && opt_hash) ? ", " : "", + opt_hash ? _("set hash to ") : "", opt_hash ?: "", + opt_cipher ? _(", set cipher to "): "", opt_cipher ?: ""); + + action_argv = poptGetArgs(popt_context); + if(!action_argv) + usage(popt_context, EXIT_FAILURE, _("Argument required."), + poptGetInvocationName(popt_context)); + + if (opt_random && opt_urandom) + usage(popt_context, EXIT_FAILURE, _("Only one of --use-[u]random options is allowed."), + poptGetInvocationName(popt_context)); + + if (opt_bsize < 0 || opt_key_size < 0 || opt_iteration_time < 0 || + opt_tries < 0 || opt_keyfile_offset < 0 || opt_key_size < 0 || + opt_pbkdf_iterations < 0 || opt_pbkdf_memory < 0 || + opt_pbkdf_parallel < 0) { + usage(popt_context, EXIT_FAILURE, + _("Negative number for option not permitted."), + poptGetInvocationName(popt_context)); + } + + if (opt_pbkdf && crypt_parse_pbkdf(opt_pbkdf, &opt_pbkdf)) + usage(popt_context, EXIT_FAILURE, + _("Password-based key derivation function (PBKDF) can be only pbkdf2 or argon2i/argon2id.\n"), + poptGetInvocationName(popt_context)); + + if (opt_pbkdf_iterations && opt_iteration_time) + usage(popt_context, EXIT_FAILURE, + _("PBKDF forced iterations cannot be combined with iteration time option.\n"), + poptGetInvocationName(popt_context)); + + if (opt_bsize < 1 || opt_bsize > 64) + usage(popt_context, EXIT_FAILURE, + _("Only values between 1 MiB and 64 MiB allowed for reencryption block size."), + poptGetInvocationName(popt_context)); + + if (opt_key_size % 8) + usage(popt_context, EXIT_FAILURE, + _("Key size must be a multiple of 8 bits"), + poptGetInvocationName(popt_context)); + + if (opt_key_slot != CRYPT_ANY_SLOT && + (opt_key_slot < 0 || opt_key_slot >= crypt_keyslot_max(CRYPT_LUKS2))) + usage(popt_context, EXIT_FAILURE, _("Key slot is invalid."), + poptGetInvocationName(popt_context)); + + if (opt_random && opt_urandom) + usage(popt_context, EXIT_FAILURE, _("Only one of --use-[u]random options is allowed."), + 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 device size specification."), + poptGetInvocationName(popt_context)); + + 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 > 64 * 1024 * 1024) + usage(popt_context, EXIT_FAILURE, _("Maximum device reduce size is 64 MiB."), + 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_new && (!opt_reduce_size && !opt_header_device)) + usage(popt_context, EXIT_FAILURE, _("Option --new must be used together with --reduce-device-size or --header."), + poptGetInvocationName(popt_context)); + + if (opt_keep_key && (opt_cipher || opt_new || opt_master_key_file)) + usage(popt_context, EXIT_FAILURE, _("Option --keep-key can be used only with --hash, --iter-time or --pbkdf-force-iterations."), + poptGetInvocationName(popt_context)); + + if (opt_new && opt_decrypt) + usage(popt_context, EXIT_FAILURE, _("Option --new cannot be used together with --decrypt."), + poptGetInvocationName(popt_context)); + + if (opt_decrypt && (opt_cipher || opt_hash || opt_reduce_size || opt_keep_key || opt_device_size)) + usage(popt_context, EXIT_FAILURE, _("Option --decrypt is incompatible with specified parameters."), + poptGetInvocationName(popt_context)); + + if (opt_uuid && !opt_decrypt) + usage(popt_context, EXIT_FAILURE, _("Option --uuid is allowed only together with --decrypt."), + poptGetInvocationName(popt_context)); + + if (!luksType(opt_type)) + usage(popt_context, EXIT_FAILURE, _("Invalid luks type. Use one of these: 'luks', 'luks1' or 'luks2'."), + poptGetInvocationName(popt_context)); + + if (opt_debug) { + opt_verbose = 1; + crypt_set_debug_level(-1); + dbg_version_and_cmd(argc, argv); + } + + r = run_reencrypt(action_argv[0]); + + poptFreeContext(popt_context); + + return translate_errno(r); +} diff --git a/src/integritysetup.c b/src/integritysetup.c new file mode 100644 index 0000000..f451f9b --- /dev/null +++ b/src/integritysetup.c @@ -0,0 +1,688 @@ +/* + * integritysetup - setup integrity protected volumes for dm-integrity + * + * Copyright (C) 2017-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2017-2019 Milan Broz + * + * 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. + */ + +#include "cryptsetup.h" +#include <uuid/uuid.h> + +#define PACKAGE_INTEGRITY "integritysetup" + +#define DEFAULT_TAG_SIZE 4 +#define DEFAULT_ALG_NAME "crc32c" +#define MAX_KEY_SIZE 4096 + +static const char *opt_journal_size_str = NULL; +static uint64_t opt_journal_size = 0; +static int opt_interleave_sectors = 0; +static int opt_journal_watermark = 0; +static int opt_journal_commit_time = 0; +static int opt_tag_size = 0; +static int opt_sector_size = 0; +static int opt_buffer_sectors = 0; + +static int opt_no_wipe = 0; + +static const char *opt_data_device = NULL; + +static const char *opt_integrity = DEFAULT_ALG_NAME; +static const char *opt_integrity_key_file = NULL; +static int opt_integrity_key_size = 0; + +static const char *opt_journal_integrity = NULL; /* none */ +static const char *opt_journal_integrity_key_file = NULL; +static int opt_journal_integrity_key_size = 0; + +static const char *opt_journal_crypt = NULL; /* none */ +static const char *opt_journal_crypt_key_file = NULL; +static int opt_journal_crypt_key_size = 0; + +static int opt_integrity_nojournal = 0; +static int opt_integrity_recovery = 0; + +static int opt_integrity_recalculate = 0; + +static int opt_version_mode = 0; + +static const char **action_argv; +static int action_argc; + +// FIXME: move this to tools and handle EINTR +static int _read_mk(const char *file, char **key, int keysize) +{ + int fd; + + if (keysize <= 0 || keysize > MAX_KEY_SIZE) { + log_err(_("Invalid key size.")); + return -EINVAL; + } + + *key = crypt_safe_alloc(keysize); + if (!*key) + return -ENOMEM; + + fd = open(file, O_RDONLY); + if (fd == -1) { + log_err(_("Cannot read keyfile %s."), file); + goto fail; + } + if ((read(fd, *key, keysize) != keysize)) { + log_err(_("Cannot read %d bytes from keyfile %s."), keysize, file); + close(fd); + goto fail; + } + close(fd); + return 0; +fail: + crypt_safe_free(*key); + *key = NULL; + return -EINVAL; +} + +static int _read_keys(char **integrity_key, struct crypt_params_integrity *params) +{ + char *int_key = NULL, *journal_integrity_key = NULL, *journal_crypt_key = NULL; + int r; + + if (integrity_key && opt_integrity_key_file) { + r = _read_mk(opt_integrity_key_file, &int_key, opt_integrity_key_size); + if (r < 0) + return r; + params->integrity_key_size = opt_integrity_key_size; + } + + if (opt_journal_integrity_key_file) { + r = _read_mk(opt_journal_integrity_key_file, &journal_integrity_key, opt_journal_integrity_key_size); + if (r < 0) { + crypt_safe_free(int_key); + return r; + } + params->journal_integrity_key = journal_integrity_key; + params->journal_integrity_key_size = opt_journal_integrity_key_size; + } + + if (opt_journal_crypt_key_file) { + r = _read_mk(opt_journal_crypt_key_file, &journal_crypt_key, opt_journal_crypt_key_size); + if (r < 0) { + crypt_safe_free(int_key); + crypt_safe_free(journal_integrity_key); + return r; + } + params->journal_crypt_key = journal_crypt_key; + params->journal_crypt_key_size = opt_journal_crypt_key_size; + } + + if (integrity_key) + *integrity_key = int_key; + + return 0; +} + +static int _wipe_data_device(struct crypt_device *cd, const char *integrity_key) +{ + char tmp_name[64], tmp_path[128], tmp_uuid[40]; + uuid_t tmp_uuid_bin; + int r; + + if (!opt_batch_mode) + 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")); + + /* Activate the device a temporary one */ + uuid_generate(tmp_uuid_bin); + uuid_unparse(tmp_uuid_bin, tmp_uuid); + if (snprintf(tmp_name, sizeof(tmp_name), "temporary-cryptsetup-%s", tmp_uuid) < 0) + return -EINVAL; + if (snprintf(tmp_path, sizeof(tmp_path), "%s/%s", crypt_get_dir(), tmp_name) < 0) + return -EINVAL; + + r = crypt_activate_by_volume_key(cd, tmp_name, integrity_key, + opt_integrity_key_size, CRYPT_ACTIVATE_PRIVATE | CRYPT_ACTIVATE_NO_JOURNAL); + if (r < 0) + return r; + + /* Wipe the device */ + set_int_handler(0); + r = crypt_wipe(cd, tmp_path, CRYPT_WIPE_ZERO, 0, 0, DEFAULT_WIPE_BLOCK, + 0, &tools_wipe_progress, NULL); + if (crypt_deactivate(cd, tmp_name)) + log_err(_("Cannot deactivate temporary device %s."), tmp_path); + set_int_block(0); + + return r; +} + +static int action_format(int arg) +{ + struct crypt_device *cd = NULL; + struct crypt_params_integrity params = { + .journal_size = opt_journal_size, + .interleave_sectors = opt_interleave_sectors, + .journal_watermark = opt_journal_watermark, + .journal_commit_time = opt_journal_commit_time, + .buffer_sectors = opt_buffer_sectors, + .tag_size = opt_tag_size, + .sector_size = opt_sector_size ?: SECTOR_SIZE, + }; + char integrity[MAX_CIPHER_LEN], journal_integrity[MAX_CIPHER_LEN], journal_crypt[MAX_CIPHER_LEN]; + char *integrity_key = NULL, *msg = NULL; + int r; + size_t signatures; + + if (opt_integrity) { + r = crypt_parse_hash_integrity_mode(opt_integrity, integrity); + if (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + return r; + } + params.integrity = integrity; + } + + if (opt_journal_integrity) { + r = crypt_parse_hash_integrity_mode(opt_journal_integrity, journal_integrity); + if (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + return r; + } + params.journal_integrity = journal_integrity; + } + + if (opt_journal_crypt) { + r = crypt_parse_hash_integrity_mode(opt_journal_crypt, journal_crypt); + if (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + return r; + } + params.journal_crypt = journal_crypt; + } + + r = _read_keys(&integrity_key, ¶ms); + if (r) + goto out; + + r = crypt_init_data_device(&cd, action_argv[0], opt_data_device); + if (r < 0) + goto out; + + r = asprintf(&msg, _("This will overwrite data on %s irrevocably."), action_argv[0]); + if (r == -1) { + r = -ENOMEM; + goto out; + } + + r = yesDialog(msg, _("Operation aborted.\n")) ? 0 : -EINVAL; + free(msg); + if (r < 0) + goto out; + + r = tools_detect_signatures(action_argv[0], 0, &signatures); + if (r < 0) + goto out; + + /* Signature candidates found */ + if (signatures && ((r = tools_wipe_all_signatures(action_argv[0])) < 0)) + goto out; + + r = crypt_format(cd, CRYPT_INTEGRITY, NULL, NULL, NULL, NULL, 0, ¶ms); + if (r < 0) /* FIXME: call wipe signatures again */ + goto out; + + if (!opt_batch_mode) + log_std(_("Formatted with tag size %u, internal integrity %s.\n"), opt_tag_size, opt_integrity); + + if (!opt_no_wipe) + r = _wipe_data_device(cd, integrity_key); +out: + crypt_safe_free(integrity_key); + crypt_safe_free(CONST_CAST(void*)params.journal_integrity_key); + crypt_safe_free(CONST_CAST(void*)params.journal_crypt_key); + crypt_free(cd); + return r; +} + +static int action_open(int arg) +{ + struct crypt_device *cd = NULL; + struct crypt_params_integrity params = { + .journal_watermark = opt_journal_watermark, + .journal_commit_time = opt_journal_commit_time, + .buffer_sectors = opt_buffer_sectors, + }; + uint32_t activate_flags = 0; + char integrity[MAX_CIPHER_LEN], journal_integrity[MAX_CIPHER_LEN], journal_crypt[MAX_CIPHER_LEN]; + char *integrity_key = NULL; + int r; + + if (opt_integrity) { + r = crypt_parse_hash_integrity_mode(opt_integrity, integrity); + if (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + return r; + } + params.integrity = integrity; + } + + if (opt_journal_integrity) { + r = crypt_parse_hash_integrity_mode(opt_journal_integrity, journal_integrity); + if (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + return r; + + } + params.journal_integrity = journal_integrity; + } + + if (opt_journal_crypt) { + r = crypt_parse_hash_integrity_mode(opt_journal_crypt, journal_crypt); + if (r < 0) { + log_err(_("No known integrity specification pattern detected.")); + return r; + } + params.journal_crypt = journal_crypt; + } + + if (opt_integrity_nojournal) + activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL; + if (opt_integrity_recovery) + activate_flags |= CRYPT_ACTIVATE_RECOVERY; + + if (opt_integrity_recalculate) + activate_flags |= CRYPT_ACTIVATE_RECALCULATE; + + r = _read_keys(&integrity_key, ¶ms); + if (r) + goto out; + + if ((r = crypt_init_data_device(&cd, action_argv[0], opt_data_device))) + goto out; + + r = crypt_load(cd, CRYPT_INTEGRITY, ¶ms); + if (r) + goto out; + + r = crypt_activate_by_volume_key(cd, action_argv[1], integrity_key, + opt_integrity_key_size, activate_flags); +out: + crypt_safe_free(integrity_key); + crypt_safe_free(CONST_CAST(void*)params.journal_integrity_key); + crypt_safe_free(CONST_CAST(void*)params.journal_crypt_key); + crypt_free(cd); + return r; +} + +static int action_close(int arg) +{ + struct crypt_device *cd = NULL; + int r; + + r = crypt_init_by_name(&cd, action_argv[0]); + if (r == 0) + r = crypt_deactivate(cd, action_argv[0]); + + crypt_free(cd); + return r; +} + +static int action_status(int arg) +{ + crypt_status_info ci; + struct crypt_active_device cad; + struct crypt_params_integrity ip = {}; + struct crypt_device *cd = NULL; + char *backing_file; + const char *device, *metadata_device; + int path = 0, r = 0; + + /* perhaps a path, not a dm device name */ + if (strchr(action_argv[0], '/')) + path = 1; + + ci = crypt_status(NULL, action_argv[0]); + switch (ci) { + case CRYPT_INVALID: + r = -EINVAL; + break; + case CRYPT_INACTIVE: + if (path) + log_std("%s is inactive.\n", action_argv[0]); + else + log_std("%s/%s is inactive.\n", crypt_get_dir(), action_argv[0]); + r = -ENODEV; + break; + case CRYPT_ACTIVE: + case CRYPT_BUSY: + if (path) + log_std("%s is active%s.\n", action_argv[0], + ci == CRYPT_BUSY ? " and is in use" : ""); + else + 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], NULL); + if (r < 0) + goto out; + + log_std(" type: %s\n", crypt_get_type(cd) ?: "n/a"); + + r = crypt_get_active_device(cd, action_argv[0], &cad); + if (r < 0) + goto out; + + r = crypt_get_integrity_info(cd, &ip); + if (r < 0) + goto out; + + log_std(" tag size: %u\n", ip.tag_size); + log_std(" integrity: %s\n", ip.integrity ?: "(none)"); + device = crypt_get_device_name(cd); + metadata_device = crypt_get_metadata_device_name(cd); + log_std(" device: %s%s\n", device, metadata_device ? " (detached)" : ""); + if (crypt_loop_device(device)) { + backing_file = crypt_loop_backing_file(device); + log_std(" loop: %s\n", backing_file); + free(backing_file); + } + if (metadata_device) { + log_std(" metadata device: %s\n", metadata_device); + if (crypt_loop_device(metadata_device)) { + backing_file = crypt_loop_backing_file(metadata_device); + log_std(" loop: %s\n", backing_file); + free(backing_file); + } + } + log_std(" sector size: %u bytes\n", crypt_get_sector_size(cd)); + log_std(" interleave sectors: %u\n", ip.interleave_sectors); + log_std(" size: %" PRIu64 " sectors\n", cad.size); + log_std(" mode: %s%s\n", + cad.flags & CRYPT_ACTIVATE_READONLY ? "readonly" : "read/write", + cad.flags & CRYPT_ACTIVATE_RECOVERY ? " recovery" : ""); + log_std(" failures: %" PRIu64 "\n", + crypt_get_active_integrity_failures(cd, action_argv[0])); + if (cad.flags & CRYPT_ACTIVATE_NO_JOURNAL) { + log_std(" journal: not active\n"); + } else { + log_std(" journal size: %" PRIu64 " bytes\n", ip.journal_size); + log_std(" journal watermark: %u%%\n", ip.journal_watermark); + log_std(" journal commit time: %u ms\n", ip.journal_commit_time); + if (ip.journal_integrity) + log_std(" journal integrity MAC: %s\n", ip.journal_integrity); + if (ip.journal_crypt) + log_std(" journal encryption: %s\n", ip.journal_crypt); + } + } +out: + crypt_free(cd); + if (r == -ENOTSUP) + r = 0; + return r; + return -EINVAL; +} + +static int action_dump(int arg) +{ + struct crypt_device *cd = NULL; + struct crypt_params_integrity params = {}; + int r; + + if ((r = crypt_init(&cd, action_argv[0]))) + return r; + + r = crypt_load(cd, CRYPT_INTEGRITY, ¶ms); + if (!r) + crypt_dump(cd); + + crypt_free(cd); + return r; +} + +static struct action_type { + const char *type; + int (*handler)(int); + int required_action_argc; + const char *arg_desc; + const char *desc; +} action_types[] = { + { "format", action_format, 1, N_("<integrity_device>"),N_("format device") }, + { "open", action_open, 2, N_("<integrity_device> <name>"),N_("open device as <name>") }, + { "close", action_close, 1, N_("<name>"),N_("close device (deactivate and remove mapping)") }, + { "status", action_status, 1, N_("<name>"),N_("show active device status") }, + { "dump", action_dump, 1, N_("<integrity_device>"),N_("show on-disk information") }, + { NULL, NULL, 0, NULL, NULL } +}; + +static void help(poptContext popt_context, + enum poptCallbackReason reason __attribute__((unused)), + struct poptOption *key, + const char *arg __attribute__((unused)), + void *data __attribute__((unused))) +{ + struct action_type *action; + + if (key->shortName == '?') { + log_std("%s %s\n", PACKAGE_INTEGRITY, PACKAGE_VERSION); + poptPrintHelp(popt_context, stdout, 0); + log_std(_("\n" + "<action> is one of:\n")); + for(action = action_types; action->type; action++) + log_std("\t%s %s - %s\n", action->type, _(action->arg_desc), _(action->desc)); + log_std(_("\n" + "<name> is the device to create under %s\n" + "<integrity_device> is the device containing data with integrity tags\n"), + crypt_get_dir()); + + log_std(_("\nDefault compiled-in dm-integrity parameters:\n" + "\tTag size: %u bytes, Checksum algorithm: %s\n"), + DEFAULT_TAG_SIZE, DEFAULT_ALG_NAME); + exit(EXIT_SUCCESS); + } else + usage(popt_context, EXIT_SUCCESS, NULL, NULL); +} + +static int run_action(struct action_type *action) +{ + int r; + + log_dbg("Running command %s.", action->type); + + r = action->handler(0); + + show_status(r); + return translate_errno(r); +} + +int main(int argc, const char **argv) +{ + static const char *null_action_argv[] = {NULL}; + static struct poptOption popt_help_options[] = { + { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL }, + { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL }, + { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL }, + POPT_TABLEEND + }; + static struct poptOption popt_options[] = { + { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL }, + { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), 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 }, + { "batch-mode", 'q', POPT_ARG_NONE, &opt_batch_mode, 0, N_("Do not ask for confirmation"), NULL }, + { "progress-frequency", '\0', POPT_ARG_INT, &opt_progress_frequency, 0, N_("Progress line update (in seconds)"), N_("secs") }, + { "no-wipe", '\0', POPT_ARG_NONE, &opt_no_wipe, 0, N_("Do not wipe device after format"), NULL }, + + { "data-device", '\0', POPT_ARG_STRING, &opt_data_device, 0, N_("Path to data device (if separated)"), N_("path") }, + + { "journal-size", 'j', POPT_ARG_STRING,&opt_journal_size_str, 0, N_("Journal size"), N_("bytes") }, + { "interleave-sectors", '\0', POPT_ARG_INT, &opt_interleave_sectors, 0, N_("Interleave sectors"), N_("SECTORS") }, + { "journal-watermark", '\0', POPT_ARG_INT, &opt_journal_watermark, 0, N_("Journal watermark"),N_("percent") }, + { "journal-commit-time",'\0', POPT_ARG_INT, &opt_journal_commit_time,0, N_("Journal commit time"), N_("ms") }, + { "tag-size", 't', POPT_ARG_INT, &opt_tag_size, 0, N_("Tag size (per-sector)"), N_("bytes") }, + { "sector-size", 's', POPT_ARG_INT, &opt_sector_size, 0, N_("Sector size"), N_("bytes") }, + { "buffer-sectors", '\0', POPT_ARG_INT, &opt_buffer_sectors, 0, N_("Buffers size"), N_("SECTORS") }, + + { "integrity", 'I', POPT_ARG_STRING, &opt_integrity, 0, N_("Data integrity algorithm"), NULL }, + { "integrity-key-size", '\0', POPT_ARG_INT, &opt_integrity_key_size, 0, N_("The size of the data integrity key"), N_("BITS") }, + { "integrity-key-file", '\0', POPT_ARG_STRING, &opt_integrity_key_file, 0, N_("Read the integrity key from a file"), NULL }, + + { "journal-integrity", '\0', POPT_ARG_STRING, &opt_journal_integrity, 0, N_("Journal integrity algorithm"), NULL }, + { "journal-integrity-key-size",'\0', POPT_ARG_INT, &opt_journal_integrity_key_size,0, N_("The size of the journal integrity key"), N_("BITS") }, + { "journal-integrity-key-file",'\0', POPT_ARG_STRING, &opt_journal_integrity_key_file,0, N_("Read the journal integrity key from a file"), NULL }, + + { "journal-crypt", '\0', POPT_ARG_STRING, &opt_journal_crypt, 0, N_("Journal encryption algorithm"), NULL }, + { "journal-crypt-key-size", '\0', POPT_ARG_INT, &opt_journal_crypt_key_size, 0, N_("The size of the journal encryption key"), N_("BITS") }, + { "journal-crypt-key-file", '\0', POPT_ARG_STRING, &opt_journal_crypt_key_file, 0, N_("Read the journal encryption key from a file"), NULL }, + + { "integrity-no-journal", 'D', POPT_ARG_NONE, &opt_integrity_nojournal, 0, N_("Disable journal for integrity device"), NULL }, + { "integrity-recovery-mode", 'R', POPT_ARG_NONE, &opt_integrity_recovery, 0, N_("Recovery mode (no journal, no tag checking)"), NULL }, + { "integrity-recalculate", '\0', POPT_ARG_NONE, &opt_integrity_recalculate, 0, N_("Recalculate initial tags automatically."), NULL }, + POPT_TABLEEND + }; + poptContext popt_context; + struct action_type *action; + const char *aname; + int r; + + crypt_set_log_callback(NULL, tool_log, NULL); + + setlocale(LC_ALL, ""); + bindtextdomain(PACKAGE, LOCALEDIR); + textdomain(PACKAGE); + + popt_context = poptGetContext("integrity", argc, argv, popt_options, 0); + poptSetOtherOptionHelp(popt_context, + _("[OPTION...] <action> <action-specific>")); + + + while ((r = poptGetNextOpt(popt_context)) >= 0) { + } + + if (r < -1) + usage(popt_context, EXIT_FAILURE, poptStrerror(r), + poptBadOption(popt_context, POPT_BADOPTION_NOALIAS)); + + if (opt_version_mode) { + log_std("%s %s\n", PACKAGE_INTEGRITY, PACKAGE_VERSION); + poptFreeContext(popt_context); + exit(EXIT_SUCCESS); + } + + if (!(aname = poptGetArg(popt_context))) + usage(popt_context, EXIT_FAILURE, _("Argument <action> missing."), + poptGetInvocationName(popt_context)); + + action_argc = 0; + action_argv = poptGetArgs(popt_context); + /* Make return values of poptGetArgs more consistent in case of remaining argc = 0 */ + if (!action_argv) + action_argv = null_action_argv; + + /* Count args, somewhat unnice, change? */ + while (action_argv[action_argc] != NULL) + action_argc++; + + /* Handle aliases */ + if (!strcmp(aname, "create") && action_argc > 1) { + /* create command had historically switched arguments */ + if (action_argv[0] && action_argv[1]) { + const char *tmp = action_argv[0]; + action_argv[0] = action_argv[1]; + action_argv[1] = tmp; + } + aname = "open"; + } else if (!strcmp(aname, "remove")) { + aname = "close"; + } + + for (action = action_types; action->type; action++) + if (strcmp(action->type, aname) == 0) + break; + + if (!action->type) + usage(popt_context, EXIT_FAILURE, _("Unknown action."), + poptGetInvocationName(popt_context)); + + if (action_argc < action->required_action_argc) { + char buf[128]; + snprintf(buf, 128,_("%s: requires %s as arguments"), action->type, action->arg_desc); + usage(popt_context, EXIT_FAILURE, buf, + poptGetInvocationName(popt_context)); + } + + if (!strcmp(aname, "format") && opt_tag_size == 0) + opt_tag_size = DEFAULT_TAG_SIZE; + + if (opt_integrity_recalculate && strcmp(aname, "open")) + usage(popt_context, EXIT_FAILURE, + _("Option --integrity-recalculate can be used only for open action."), + poptGetInvocationName(popt_context)); + + if (opt_interleave_sectors < 0 || opt_journal_watermark < 0 || + opt_journal_commit_time < 0 || opt_tag_size < 0 || + opt_sector_size < 0 || opt_buffer_sectors < 0 || + opt_integrity_key_size < 0 || opt_journal_integrity_key_size < 0 || + opt_journal_crypt_key_size < 0) + usage(popt_context, EXIT_FAILURE, + _("Negative number for option not permitted."), + poptGetInvocationName(popt_context)); + + if (strcmp(aname, "format") && (opt_journal_size_str || opt_interleave_sectors || + opt_sector_size || opt_tag_size || opt_no_wipe )) + usage(popt_context, EXIT_FAILURE, + _("Options --journal-size, --interleave-sectors, --sector-size, --tag-size" + " and --no-wipe can be used only for format action.\n"), + poptGetInvocationName(popt_context)); + + if (opt_journal_size_str && + tools_string_to_size(NULL, opt_journal_size_str, &opt_journal_size)) + usage(popt_context, EXIT_FAILURE, _("Invalid journal size specification."), + poptGetInvocationName(popt_context)); + + if ((opt_integrity_key_file && !opt_integrity_key_size) || + (!opt_integrity_key_file && opt_integrity_key_size)) + usage(popt_context, EXIT_FAILURE, _("Both key file and key size options must be specified."), + poptGetInvocationName(popt_context)); + if (!opt_integrity && opt_integrity_key_file) + usage(popt_context, EXIT_FAILURE, _("Integrity algorithm must be specified if integrity key is used."), + poptGetInvocationName(popt_context)); + + if ((opt_journal_integrity_key_file && !opt_journal_integrity_key_size) || + (!opt_journal_integrity_key_file && opt_journal_integrity_key_size)) + usage(popt_context, EXIT_FAILURE, _("Both journal integrity key file and key size options must be specified."), + poptGetInvocationName(popt_context)); + if (!opt_journal_integrity && opt_journal_integrity_key_file) + usage(popt_context, EXIT_FAILURE, _("Journal integrity algorithm must be specified if journal integrity key is used."), + poptGetInvocationName(popt_context)); + + if ((opt_journal_crypt_key_file && !opt_journal_crypt_key_size) || + (!opt_journal_crypt_key_file && opt_journal_crypt_key_size)) + usage(popt_context, EXIT_FAILURE, _("Both journal encryption key file and key size options must be specified."), + poptGetInvocationName(popt_context)); + if (!opt_journal_crypt && opt_journal_crypt_key_file) + usage(popt_context, EXIT_FAILURE, _("Journal encryption algorithm must be specified if journal encryption key is used."), + poptGetInvocationName(popt_context)); + + if (opt_debug) { + opt_verbose = 1; + crypt_set_debug_level(-1); + dbg_version_and_cmd(argc, argv); + } + + r = run_action(action); + poptFreeContext(popt_context); + return r; +} diff --git a/src/utils_luks2.c b/src/utils_luks2.c new file mode 100644 index 0000000..d61c430 --- /dev/null +++ b/src/utils_luks2.c @@ -0,0 +1,139 @@ +/* + * Helper utilities for LUKS2 features + * + * Copyright (C) 2018-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2018-2019 Milan Broz + * Copyright (C) 2018-2019 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. + */ + +#include "cryptsetup.h" + +/* + * FIXME: 4MiBs is max LUKS2 mda length (including binary header). + * In future, read max allowed JSON size from config section. + */ +#define LUKS2_MAX_MDA_SIZE 0x400000 +int tools_read_json_file(struct crypt_device *cd, const char *file, char **json, size_t *json_size) +{ + ssize_t ret; + int fd, block, r; + void *buf = NULL; + + block = tools_signals_blocked(); + if (block) + set_int_block(0); + + if (tools_is_stdin(file)) { + fd = STDIN_FILENO; + log_dbg("STDIN descriptor JSON read requested."); + } else { + log_dbg("File descriptor JSON read requested."); + fd = open(file, O_RDONLY); + if (fd < 0) { + log_err(_("Failed to open file %s in read-only mode."), file); + r = -EINVAL; + goto out; + } + } + + buf = malloc(LUKS2_MAX_MDA_SIZE); + if (!buf) { + r = -ENOMEM; + goto out; + } + + if (isatty(fd) && !opt_batch_mode) + log_std(_("Provide valid LUKS2 token JSON:\n")); + + /* we expect JSON (string) */ + r = 0; + ret = read_buffer_intr(fd, buf, LUKS2_MAX_MDA_SIZE - 1, &quit); + if (ret < 0) { + r = -EIO; + log_err(_("Failed to read JSON file.")); + goto out; + } + check_signal(&r); + if (r) { + log_err(_("\nRead interrupted.")); + goto out; + } + + *json_size = (size_t)ret; + *json = buf; + *(*json + ret) = '\0'; +out: + if (block && !quit) + set_int_block(1); + if (fd >= 0 && fd != STDIN_FILENO) + close(fd); + if (r && buf) { + memset(buf, 0, LUKS2_MAX_MDA_SIZE); + free(buf); + } + return r; +} + +int tools_write_json_file(struct crypt_device *cd, const char *file, const char *json) +{ + int block, fd, r; + size_t json_len; + ssize_t ret; + + if (!json || !(json_len = strlen(json)) || json_len >= LUKS2_MAX_MDA_SIZE) + return -EINVAL; + + block = tools_signals_blocked(); + if (block) + set_int_block(0); + + if (tools_is_stdin(file)) { + fd = STDOUT_FILENO; + log_dbg("STDOUT descriptor JSON write requested."); + } else { + log_dbg("File descriptor JSON write requested."); + fd = open(file, O_CREAT | O_WRONLY, S_IRUSR | S_IWUSR); + } + + if (fd < 0) { + log_err(_("Failed to open file %s in write mode."), file ?: ""); + r = -EINVAL; + goto out; + } + + r = 0; + ret = write_buffer_intr(fd, json, json_len, &quit); + check_signal(&r); + if (r) { + log_err(_("\nWrite interrupted.")); + goto out; + } + if (ret < 0 || (size_t)ret != json_len) { + log_err(_("Failed to write JSON file.")); + r = -EIO; + goto out; + } + + if (isatty(fd)) + (void) write_buffer_intr(fd, "\n", 1, &quit); +out: + if (block && !quit) + set_int_block(1); + if (fd >=0 && fd != STDOUT_FILENO) + close(fd); + return r; +} diff --git a/src/utils_password.c b/src/utils_password.c new file mode 100644 index 0000000..125b4f7 --- /dev/null +++ b/src/utils_password.c @@ -0,0 +1,331 @@ +/* + * Password quality check wrapper + * + * Copyright (C) 2012-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2012-2019 Milan Broz + * + * 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. + */ + +#include "cryptsetup.h" +#include <termios.h> + +int opt_force_password = 0; + +#if defined ENABLE_PWQUALITY +#include <pwquality.h> + +static int tools_check_pwquality(const char *password) +{ + int r; + void *auxerror; + pwquality_settings_t *pwq; + + log_dbg("Checking new password using default pwquality settings."); + pwq = pwquality_default_settings(); + if (!pwq) + return -EINVAL; + + r = pwquality_read_config(pwq, NULL, &auxerror); + if (r) { + log_err(_("Cannot check password quality: %s"), + pwquality_strerror(NULL, 0, r, auxerror)); + pwquality_free_settings(pwq); + return -EINVAL; + } + + r = pwquality_check(pwq, password, NULL, NULL, &auxerror); + if (r < 0) { + log_err(_("Password quality check failed:\n %s"), + pwquality_strerror(NULL, 0, r, auxerror)); + r = -EPERM; + } else { + log_dbg("New password libpwquality score is %d.", r); + r = 0; + } + + pwquality_free_settings(pwq); + return r; +} +#elif defined ENABLE_PASSWDQC +#include <passwdqc.h> + +static int tools_check_pwquality(const char *password) +{ + passwdqc_params_t params; + char *parse_reason; + const char *check_reason; + const char *config = PASSWDQC_CONFIG_FILE; + + passwdqc_params_reset(¶ms); + + if (*config && passwdqc_params_load(¶ms, &parse_reason, config)) { + log_err(_("Cannot check password quality: %s"), + (parse_reason ? parse_reason : "Out of memory")); + free(parse_reason); + return -EINVAL; + } + + check_reason = passwdqc_check(¶ms.qc, password, NULL, NULL); + if (check_reason) { + log_err(_("Password quality check failed: Bad passphrase (%s)"), + check_reason); + return -EPERM; + } + + return 0; +} +#else /* !(ENABLE_PWQUALITY || ENABLE_PASSWDQC) */ +static int tools_check_pwquality(const char *password) +{ + return 0; +} +#endif /* ENABLE_PWQUALITY || ENABLE_PASSWDQC */ + +/* Password reading helpers */ +static int untimed_read(int fd, char *pass, size_t maxlen) +{ + ssize_t i; + + i = read(fd, pass, maxlen); + if (i > 0) { + pass[i-1] = '\0'; + i = 0; + } else if (i == 0) { /* EOF */ + *pass = 0; + i = -1; + } + return i; +} + +static int timed_read(int fd, char *pass, size_t maxlen, long timeout) +{ + struct timeval t; + fd_set fds = {}; /* Just to avoid scan-build false report for FD_SET */ + int failed = -1; + + FD_ZERO(&fds); + FD_SET(fd, &fds); + t.tv_sec = timeout; + t.tv_usec = 0; + + if (select(fd+1, &fds, NULL, NULL, &t) > 0) + failed = untimed_read(fd, pass, maxlen); + + return failed; +} + +static int interactive_pass(const char *prompt, char *pass, size_t maxlen, + long timeout) +{ + struct termios orig, tmp; + int failed = -1; + int infd, outfd; + + if (maxlen < 1) + return failed; + + /* Read and write to /dev/tty if available */ + infd = open("/dev/tty", O_RDWR); + if (infd == -1) { + infd = STDIN_FILENO; + outfd = STDERR_FILENO; + } else + outfd = infd; + + if (tcgetattr(infd, &orig)) + goto out_err; + + memcpy(&tmp, &orig, sizeof(tmp)); + tmp.c_lflag &= ~ECHO; + + if (prompt && write(outfd, prompt, strlen(prompt)) < 0) + goto out_err; + + tcsetattr(infd, TCSAFLUSH, &tmp); + if (timeout) + failed = timed_read(infd, pass, maxlen, timeout); + else + failed = untimed_read(infd, pass, maxlen); + tcsetattr(infd, TCSAFLUSH, &orig); + +out_err: + if (!failed && write(outfd, "\n", 1)) {}; + + if (infd != STDIN_FILENO) + close(infd); + return failed; +} + +static int crypt_get_key_tty(const char *prompt, + char **key, size_t *key_size, + int timeout, int verify, + struct crypt_device *cd) +{ + int key_size_max = DEFAULT_PASSPHRASE_SIZE_MAX; + int r = -EINVAL; + char *pass = NULL, *pass_verify = NULL; + + *key = NULL; + *key_size = 0; + + log_dbg("Interactive passphrase entry requested."); + + pass = crypt_safe_alloc(key_size_max + 1); + if (!pass) { + log_err( _("Out of memory while reading passphrase.")); + return -ENOMEM; + } + + if (interactive_pass(prompt, pass, key_size_max, timeout)) { + log_err(_("Error reading passphrase from terminal.")); + goto out_err; + } + pass[key_size_max] = '\0'; + + if (verify) { + pass_verify = crypt_safe_alloc(key_size_max); + if (!pass_verify) { + log_err(_("Out of memory while reading passphrase.")); + r = -ENOMEM; + goto out_err; + } + + if (interactive_pass(_("Verify passphrase: "), + pass_verify, key_size_max, timeout)) { + log_err(_("Error reading passphrase from terminal.")); + goto out_err; + } + + if (strncmp(pass, pass_verify, key_size_max)) { + log_err(_("Passphrases do not match.")); + r = -EPERM; + goto out_err; + } + } + + *key = pass; + *key_size = strlen(pass); + r = 0; +out_err: + crypt_safe_free(pass_verify); + if (r) + crypt_safe_free(pass); + return r; +} + +/* + * Note: --key-file=- is interpreted as a read from a binary file (stdin) + * key_size_max == 0 means detect maximum according to input type (tty/file) + */ +int tools_get_key(const char *prompt, + char **key, size_t *key_size, + uint64_t keyfile_offset, size_t keyfile_size_max, + const char *key_file, + int timeout, int verify, int pwquality, + struct crypt_device *cd) +{ + char tmp[1024]; + int r = -EINVAL, block; + + block = tools_signals_blocked(); + if (block) + set_int_block(0); + + if (tools_is_stdin(key_file)) { + if (isatty(STDIN_FILENO)) { + if (keyfile_offset) { + log_err(_("Cannot use offset with terminal input.")); + } else { + if (!prompt && !crypt_get_device_name(cd)) + snprintf(tmp, sizeof(tmp), _("Enter passphrase: ")); + else if (!prompt) + snprintf(tmp, sizeof(tmp), _("Enter passphrase for %s: "), + crypt_get_device_name(cd)); + r = crypt_get_key_tty(prompt ?: tmp, key, key_size, timeout, verify, cd); + } + } else { + log_dbg("STDIN descriptor passphrase entry requested."); + /* No keyfile means STDIN with EOL handling (\n will end input)). */ + r = crypt_keyfile_device_read(cd, NULL, key, key_size, + keyfile_offset, keyfile_size_max, + key_file ? 0 : CRYPT_KEYFILE_STOP_EOL); + } + } else { + log_dbg("File descriptor passphrase entry requested."); + r = crypt_keyfile_device_read(cd, key_file, key, key_size, + keyfile_offset, keyfile_size_max, 0); + } + + if (block && !quit) + set_int_block(1); + + /* Check pwquality for password (not keyfile) */ + if (pwquality && !opt_force_password && !key_file && !r) + r = tools_check_pwquality(*key); + + return r; +} + +void tools_passphrase_msg(int r) +{ + if (r == -EPERM) + log_err(_("No key available with this passphrase.")); +} + +int tools_read_mk(const char *file, char **key, int keysize) +{ + int fd; + + *key = crypt_safe_alloc(keysize); + if (!*key) + return -ENOMEM; + + fd = open(file, O_RDONLY); + if (fd == -1) { + log_err(_("Cannot read keyfile %s."), file); + goto fail; + } + if ((read(fd, *key, keysize) != keysize)) { + log_err(_("Cannot read %d bytes from keyfile %s."), keysize, file); + close(fd); + goto fail; + } + close(fd); + return 0; +fail: + crypt_safe_free(*key); + *key = NULL; + return -EINVAL; +} + +int tools_write_mk(const char *file, const char *key, int keysize) +{ + int fd, r = -EINVAL; + + fd = open(file, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR); + if (fd < 0) { + log_err(_("Cannot open keyfile %s for write."), file); + return r; + } + + if (write_buffer(fd, key, keysize) == keysize) + r = 0; + else + log_err(_("Cannot write to keyfile %s."), file); + + close(fd); + return r; +} diff --git a/src/utils_tools.c b/src/utils_tools.c new file mode 100644 index 0000000..5b579c9 --- /dev/null +++ b/src/utils_tools.c @@ -0,0 +1,594 @@ +/* + * cryptsetup - setup cryptographic volumes for dm-crypt + * + * Copyright (C) 2004 Jana Saout <jana@saout.de> + * Copyright (C) 2004-2007 Clemens Fruhwirth <clemens@endorphin.org> + * Copyright (C) 2009-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2009-2019 Milan Broz + * + * 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. + */ + +#include "cryptsetup.h" +#include <math.h> +#include <signal.h> + +int opt_verbose = 0; +int opt_debug = 0; +int opt_debug_json = 0; +int opt_batch_mode = 0; +int opt_progress_frequency = 0; + +/* interrupt handling */ +volatile int quit = 0; +static int signals_blocked = 0; + +static void int_handler(int sig __attribute__((__unused__))) +{ + quit++; +} + +int tools_signals_blocked(void) +{ + return signals_blocked; +} + +void set_int_block(int block) +{ + sigset_t signals_open; + + log_dbg("%slocking interruption on signal.", block ? "B" : "Unb"); + + sigemptyset(&signals_open); + sigaddset(&signals_open, SIGINT); + sigaddset(&signals_open, SIGTERM); + sigprocmask(block ? SIG_SETMASK : SIG_UNBLOCK, &signals_open, NULL); + signals_blocked = block; + quit = 0; +} + +void set_int_handler(int block) +{ + struct sigaction sigaction_open; + + log_dbg("Installing SIGINT/SIGTERM handler."); + memset(&sigaction_open, 0, sizeof(struct sigaction)); + sigaction_open.sa_handler = int_handler; + sigaction(SIGINT, &sigaction_open, 0); + sigaction(SIGTERM, &sigaction_open, 0); + set_int_block(block); +} + +void check_signal(int *r) +{ + if (quit && !*r) + *r = -EINTR; +} + +#define LOG_MAX_LEN 4096 + +__attribute__((format(printf, 5, 6))) +void clogger(struct crypt_device *cd, int level, const char *file, int line, + const char *format, ...) +{ + va_list argp; + char target[LOG_MAX_LEN + 2]; + + va_start(argp, format); + + if (vsnprintf(&target[0], LOG_MAX_LEN, format, argp) > 0) { + /* All verbose and error messages in tools end with EOL. */ + if (level == CRYPT_LOG_VERBOSE || level == CRYPT_LOG_ERROR) + strncat(target, "\n", LOG_MAX_LEN); + + crypt_log(cd, level, target); + } + + va_end(argp); +} + +void tool_log(int level, const char *msg, void *usrptr __attribute__((unused))) +{ + switch(level) { + + case CRYPT_LOG_NORMAL: + fprintf(stdout, "%s", msg); + break; + case CRYPT_LOG_VERBOSE: + if (opt_verbose) + fprintf(stdout, "%s", msg); + break; + case CRYPT_LOG_ERROR: + fprintf(stderr, "%s", msg); + break; + case CRYPT_LOG_DEBUG_JSON: + case CRYPT_LOG_DEBUG: + if (opt_debug) + fprintf(stdout, "# %s\n", msg); + break; + } +} + +void quiet_log(int level, const char *msg, void *usrptr) +{ + if (!opt_verbose && (level == CRYPT_LOG_ERROR || level == CRYPT_LOG_NORMAL)) + level = CRYPT_LOG_VERBOSE; + tool_log(level, msg, usrptr); +} + +int yesDialog(const char *msg, void *usrptr) +{ + const char *fail_msg = (const char *)usrptr; + char *answer = NULL; + size_t size = 0; + int r = 1, block; + + block = tools_signals_blocked(); + if (block) + set_int_block(0); + + if (isatty(STDIN_FILENO) && !opt_batch_mode) { + log_std("\nWARNING!\n========\n"); + log_std("%s\n\nAre you sure? (Type uppercase yes): ", msg); + fflush(stdout); + if(getline(&answer, &size, stdin) == -1) { + r = 0; + /* Aborted by signal */ + if (!quit) + log_err(_("Error reading response from terminal.")); + else + log_dbg("Query interrupted on signal."); + } else if (strcmp(answer, "YES\n")) { + r = 0; + if (fail_msg) + log_err("%s", fail_msg); + } + } + + if (block && !quit) + set_int_block(1); + + free(answer); + return r; +} + +void show_status(int errcode) +{ + char *crypt_error; + + if(!opt_verbose) + return; + + if(!errcode) { + log_std(_("Command successful.\n")); + return; + } + + if (errcode < 0) + errcode = translate_errno(errcode); + + if (errcode == 1) + crypt_error = _("wrong or missing parameters"); + else if (errcode == 2) + crypt_error = _("no permission or bad passphrase"); + else if (errcode == 3) + crypt_error = _("out of memory"); + else if (errcode == 4) + crypt_error = _("wrong device or file specified"); + else if (errcode == 5) + crypt_error = _("device already exists or device is busy"); + else + crypt_error = _("unknown error"); + + log_std(_("Command failed with code %i (%s).\n"), -errcode, crypt_error); +} + +const char *uuid_or_device(const char *spec) +{ + static char device[PATH_MAX]; + char s, *ptr; + int i = 0, uuid_len = 5; + + /* Check if it is correct UUID=<LUKS_UUID> format */ + if (spec && !strncmp(spec, "UUID=", uuid_len)) { + strcpy(device, "/dev/disk/by-uuid/"); + ptr = &device[strlen(device)]; + i = uuid_len; + while ((s = spec[i++]) && i < (PATH_MAX - 13)) { + if (!isxdigit(s) && s != '-') + return spec; /* Bail it out */ + if (isalpha(s)) + s = tolower(s); + *ptr++ = s; + } + *ptr = '\0'; + return device; + } + + return spec; +} + +__attribute__ ((noreturn)) void usage(poptContext popt_context, + int exitcode, const char *error, + const char *more) +{ + poptPrintUsage(popt_context, stderr, 0); + if (error) + log_err("%s: %s", more, error); + poptFreeContext(popt_context); + exit(exitcode); +} + +void dbg_version_and_cmd(int argc, const char **argv) +{ + int i; + + log_std("# %s %s processing \"", PACKAGE_NAME, PACKAGE_VERSION); + for (i = 0; i < argc; i++) { + if (i) + log_std(" "); + log_std("%s", argv[i]); + } + log_std("\"\n"); +} + +/* Translate exit code to simple codes */ +int translate_errno(int r) +{ + switch (r) { + case 0: r = EXIT_SUCCESS; break; + case -EEXIST: + case -EBUSY: r = 5; break; + case -ENOTBLK: + case -ENODEV: r = 4; break; + case -ENOMEM: r = 3; break; + case -EPERM: r = 2; break; + case -EINVAL: + case -ENOENT: + case -ENOSYS: + default: r = EXIT_FAILURE; + } + return r; +} + +void tools_keyslot_msg(int keyslot, crypt_object_op op) +{ + if (keyslot < 0) + return; + + if (op == CREATED) + log_verbose(_("Key slot %i created."), keyslot); + else if (op == UNLOCKED) + log_verbose(_("Key slot %i unlocked."), keyslot); + else if (op == REMOVED) + log_verbose(_("Key slot %i removed."), keyslot); +} + +void tools_token_msg(int token, crypt_object_op op) +{ + if (token < 0) + return; + + if (op == CREATED) + log_verbose(_("Token %i created."), token); + else if (op == REMOVED) + log_verbose(_("Token %i removed."), token); +} + +/* + * Device size string parsing, suffixes: + * s|S - 512 bytes sectors + * k |K |m |M |g |G |t |T - 1024 base + * kiB|KiB|miB|MiB|giB|GiB|tiB|TiB - 1024 base + * kb |KB |mM |MB |gB |GB |tB |TB - 1000 base + */ +int tools_string_to_size(struct crypt_device *cd, const char *s, uint64_t *size) +{ + char *endp = NULL; + size_t len; + uint64_t mult_base, mult, tmp; + + *size = strtoull(s, &endp, 10); + if (!isdigit(s[0]) || + (errno == ERANGE && *size == ULLONG_MAX) || + (errno != 0 && *size == 0)) + return -EINVAL; + + if (!endp || !*endp) + return 0; + + len = strlen(endp); + /* Allow "B" and "iB" suffixes */ + if (len > 3 || + (len == 3 && (endp[1] != 'i' || endp[2] != 'B')) || + (len == 2 && endp[1] != 'B')) + return -EINVAL; + + if (len == 1 || len == 3) + mult_base = 1024; + else + mult_base = 1000; + + mult = 1; + switch (endp[0]) { + case 's': + case 'S': mult = 512; + break; + case 't': + case 'T': mult *= mult_base; + /* Fall through */ + case 'g': + case 'G': mult *= mult_base; + /* Fall through */ + case 'm': + case 'M': mult *= mult_base; + /* Fall through */ + case 'k': + case 'K': mult *= mult_base; + break; + default: + return -EINVAL; + } + + tmp = *size * mult; + if (*size && (tmp / *size) != mult) { + log_dbg("Device size overflow."); + return -EINVAL; + } + + *size = tmp; + return 0; +} + +/* Time progress helper */ + +/* The difference in seconds between two times in "timeval" format. */ +static double time_diff(struct timeval *start, struct timeval *end) +{ + return (end->tv_sec - start->tv_sec) + + (end->tv_usec - start->tv_usec) / 1E6; +} + +void tools_clear_line(void) +{ + if (opt_progress_frequency) + return; + /* vt100 code clear line */ + log_std("\33[2K\r"); +} + +void tools_time_progress(uint64_t device_size, uint64_t bytes, + struct timeval *start_time, struct timeval *end_time) +{ + struct timeval now_time; + unsigned long long mbytes, eta; + double tdiff, mib, frequency; + int final = (bytes == device_size); + const char *eol; + + if (opt_batch_mode) + return; + + gettimeofday(&now_time, NULL); + if (start_time->tv_sec == 0 && start_time->tv_usec == 0) { + *start_time = now_time; + *end_time = now_time; + return; + } + + if (opt_progress_frequency) { + frequency = (double)opt_progress_frequency; + eol = "\n"; + } else { + frequency = 0.5; + eol = ""; + } + + if (!final && time_diff(end_time, &now_time) < frequency) + return; + + *end_time = now_time; + + tdiff = time_diff(start_time, end_time); + if (!tdiff) + return; + + mbytes = bytes / 1024 / 1024; + mib = (double)(mbytes) / tdiff; + if (!mib) + return; + + /* FIXME: calculate this from last minute only and remaining space */ + eta = (unsigned long long)(device_size / 1024 / 1024 / mib - tdiff); + + tools_clear_line(); + if (final) + log_std("Finished, time %02llu:%02llu.%03llu, " + "%4llu MiB written, speed %5.1f MiB/s\n", + (unsigned long long)tdiff / 60, + (unsigned long long)tdiff % 60, + (unsigned long long)((tdiff - floor(tdiff)) * 1000.0), + mbytes, mib); + else + log_std("Progress: %5.1f%%, ETA %02llu:%02llu, " + "%4llu MiB written, speed %5.1f MiB/s%s", + (double)bytes / device_size * 100, + eta / 60, eta % 60, mbytes, mib, eol); + fflush(stdout); +} + +int tools_wipe_progress(uint64_t size, uint64_t offset, void *usrptr) +{ + static struct timeval start_time = {}, end_time = {}; + int r = 0; + + tools_time_progress(size, offset, &start_time, &end_time); + + check_signal(&r); + if (r) { + tools_clear_line(); + log_err("\nWipe interrupted."); + } + + return r; +} + +static void report_partition(const char *value, const char *device) +{ + if (opt_batch_mode) + log_dbg("Device %s already contains a '%s' partition signature.", device, value); + else + log_std(_("WARNING: Device %s already contains a '%s' partition signature.\n"), device, value); +} + +static void report_superblock(const char *value, const char *device) +{ + if (opt_batch_mode) + log_dbg("Device %s already contains a '%s' superblock signature.", device, value); + else + log_std(_("WARNING: Device %s already contains a '%s' superblock signature.\n"), device, value); +} + +int tools_detect_signatures(const char *device, int ignore_luks, size_t *count) +{ + int r; + size_t tmp_count; + struct blkid_handle *h; + blk_probe_status pr; + + if (!count) + count = &tmp_count; + + *count = 0; + + if (!blk_supported()) { + log_dbg("Blkid support disabled."); + return 0; + } + + if ((r = blk_init_by_path(&h, device))) { + log_err(_("Failed to initialize device signature probes.")); + return -EINVAL; + } + + blk_set_chains_for_full_print(h); + + if (ignore_luks && blk_superblocks_filter_luks(h)) { + r = -EINVAL; + goto out; + } + + while ((pr = blk_probe(h)) < PRB_EMPTY) { + if (blk_is_partition(h)) + report_partition(blk_get_partition_type(h), device); + else if (blk_is_superblock(h)) + report_superblock(blk_get_superblock_type(h), device); + else { + log_dbg("Internal tools_detect_signatures() error."); + r = -EINVAL; + goto out; + } + (*count)++; + } + + if (pr == PRB_FAIL) + r = -EINVAL; +out: + blk_free(h); + return r; +} + +int tools_wipe_all_signatures(const char *path) +{ + int fd, flags, r; + blk_probe_status pr; + struct stat st; + struct blkid_handle *h = NULL; + + if (!blk_supported()) { + log_dbg("Blkid support disabled."); + return 0; + } + + if (stat(path, &st)) { + log_err(_("Failed to stat device %s."), path); + return -EINVAL; + } + + flags = O_RDWR; + if (S_ISBLK(st.st_mode)) + flags |= O_EXCL; + + /* better than opening regular file with O_EXCL (undefined) */ + /* coverity[toctou] */ + fd = open(path, flags); + if (fd < 0) { + if (errno == EBUSY) + log_err(_("Device %s is in use. Can not proceed with format operation."), path); + else + log_err(_("Failed to open file %s in read/write mode."), path); + return -EINVAL; + } + + if ((r = blk_init_by_fd(&h, fd))) { + log_err(_("Failed to initialize device signature probes.")); + r = -EINVAL; + goto out; + } + + blk_set_chains_for_wipes(h); + + while ((pr = blk_probe(h)) < PRB_EMPTY) { + if (blk_is_partition(h)) + log_verbose("Existing '%s' partition signature on device %s will be wiped.", + blk_get_partition_type(h), path); + if (blk_is_superblock(h)) + log_verbose("Existing '%s' superblock signature on device %s will be wiped.", + blk_get_superblock_type(h), path); + if (blk_do_wipe(h)) { + log_err(_("Failed to wipe device signature.")); + r = -EINVAL; + goto out; + } + } + + if (pr != PRB_EMPTY) { + log_err(_("Failed to probe device %s for a signature."), path); + r = -EINVAL; + } +out: + close(fd); + blk_free(h); + return r; +} + +int tools_is_cipher_null(const char *cipher) +{ + if (!cipher) + return 0; + + return !strcmp(cipher, "cipher_null") ? 1 : 0; +} + +/* + * Keyfile - is standard input treated as a binary file (no EOL handling). + */ +int tools_is_stdin(const char *key_file) +{ + if (!key_file) + return 1; + + return strcmp(key_file, "-") ? 0 : 1; +} diff --git a/src/veritysetup.c b/src/veritysetup.c new file mode 100644 index 0000000..9a02c5b --- /dev/null +++ b/src/veritysetup.c @@ -0,0 +1,567 @@ +/* + * veritysetup - setup cryptographic volumes for dm-verity + * + * Copyright (C) 2012-2019 Red Hat, Inc. All rights reserved. + * Copyright (C) 2012-2019 Milan Broz + * + * 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. + */ + +#include "cryptsetup.h" + +#define PACKAGE_VERITY "veritysetup" + +static int use_superblock = 1; + +static const char *fec_device = NULL; +static int fec_roots = DEFAULT_VERITY_FEC_ROOTS; +static const char *hash_algorithm = NULL; +static int hash_type = 1; +static int data_block_size = DEFAULT_VERITY_DATA_BLOCK; +static int hash_block_size = DEFAULT_VERITY_HASH_BLOCK; +static uint64_t data_blocks = 0; +static const char *salt_string = NULL; +static uint64_t hash_offset = 0; +static uint64_t fec_offset = 0; +static const char *opt_uuid = NULL; +static int opt_restart_on_corruption = 0; +static int opt_ignore_corruption = 0; +static int opt_ignore_zero_blocks = 0; +static int opt_check_at_most_once = 0; + +static int opt_version_mode = 0; + +static const char **action_argv; +static int action_argc; + +static int _prepare_format(struct crypt_params_verity *params, + const char *data_device, + uint32_t flags) +{ + char *salt = NULL; + int len; + + params->hash_name = hash_algorithm ?: DEFAULT_VERITY_HASH; + params->data_device = data_device; + params->fec_device = fec_device; + params->fec_roots = fec_roots; + + if (salt_string && !strcmp(salt_string, "-")) { + params->salt_size = 0; + params->salt = NULL; + } else if (salt_string) { + len = crypt_hex_to_bytes(salt_string, &salt, 0); + if (len < 0) { + log_err(_("Invalid salt string specified.")); + return -EINVAL; + } + params->salt_size = len; + params->salt = salt; + } else { + params->salt_size = DEFAULT_VERITY_SALT_SIZE; + params->salt = NULL; + } + + params->data_block_size = data_block_size; + params->hash_block_size = hash_block_size; + params->data_size = data_blocks; + params->hash_area_offset = hash_offset; + params->fec_area_offset = fec_offset; + params->hash_type = hash_type; + params->flags = flags; + + return 0; +} + +static int action_format(int arg) +{ + struct crypt_device *cd = NULL; + struct crypt_params_verity params = {}; + uint32_t flags = CRYPT_VERITY_CREATE_HASH; + int r; + + /* Try to create hash image if doesn't exist */ + r = open(action_argv[1], O_WRONLY | O_EXCL | O_CREAT, S_IRUSR | S_IWUSR); + if (r < 0 && errno != EEXIST) { + log_err(_("Cannot create hash image %s for writing."), action_argv[1]); + return -EINVAL; + } else if (r >= 0) { + log_dbg("Created hash image %s.", action_argv[1]); + close(r); + } + /* Try to create FEC image if doesn't exist */ + if (fec_device) { + r = open(fec_device, O_WRONLY | O_EXCL | O_CREAT, S_IRUSR | S_IWUSR); + if (r < 0 && errno != EEXIST) { + log_err(_("Cannot create FEC image %s for writing."), fec_device); + return -EINVAL; + } else if (r >= 0) { + log_dbg("Created FEC image %s.", fec_device); + close(r); + } + } + + if ((r = crypt_init(&cd, action_argv[1]))) + goto out; + + if (!use_superblock) + flags |= CRYPT_VERITY_NO_HEADER; + + r = _prepare_format(¶ms, action_argv[0], flags); + if (r < 0) + goto out; + + r = crypt_format(cd, CRYPT_VERITY, NULL, NULL, opt_uuid, NULL, 0, ¶ms); + if (!r) + crypt_dump(cd); +out: + crypt_free(cd); + free(CONST_CAST(char*)params.salt); + return r; +} + +static int _activate(const char *dm_device, + const char *data_device, + const char *hash_device, + const char *root_hash, + uint32_t flags) +{ + struct crypt_device *cd = NULL; + struct crypt_params_verity params = {}; + uint32_t activate_flags = CRYPT_ACTIVATE_READONLY; + char *root_hash_bytes = NULL; + ssize_t hash_size; + int r; + + if ((r = crypt_init_data_device(&cd, hash_device, data_device))) + goto out; + + if (opt_ignore_corruption) + activate_flags |= CRYPT_ACTIVATE_IGNORE_CORRUPTION; + if (opt_restart_on_corruption) + activate_flags |= CRYPT_ACTIVATE_RESTART_ON_CORRUPTION; + if (opt_ignore_zero_blocks) + activate_flags |= CRYPT_ACTIVATE_IGNORE_ZERO_BLOCKS; + if (opt_check_at_most_once) + activate_flags |= CRYPT_ACTIVATE_CHECK_AT_MOST_ONCE; + + if (use_superblock) { + params.flags = flags; + params.hash_area_offset = hash_offset; + params.fec_area_offset = fec_offset; + params.fec_device = fec_device; + params.fec_roots = fec_roots; + r = crypt_load(cd, CRYPT_VERITY, ¶ms); + } else { + r = _prepare_format(¶ms, data_device, flags | CRYPT_VERITY_NO_HEADER); + if (r < 0) + goto out; + r = crypt_format(cd, CRYPT_VERITY, NULL, NULL, NULL, NULL, 0, ¶ms); + } + if (r < 0) + goto out; + + hash_size = crypt_get_volume_key_size(cd); + if (crypt_hex_to_bytes(root_hash, &root_hash_bytes, 0) != hash_size) { + log_err(_("Invalid root hash string specified.")); + r = -EINVAL; + goto out; + } + r = crypt_activate_by_volume_key(cd, dm_device, + root_hash_bytes, + hash_size, + activate_flags); +out: + crypt_free(cd); + free(root_hash_bytes); + free(CONST_CAST(char*)params.salt); + return r; +} + +static int action_open(int arg) +{ + return _activate(action_argv[1], + action_argv[0], + action_argv[2], + action_argv[3], 0); +} + +static int action_verify(int arg) +{ + return _activate(NULL, + action_argv[0], + action_argv[1], + action_argv[2], + CRYPT_VERITY_CHECK_HASH); +} + +static int action_close(int arg) +{ + struct crypt_device *cd = NULL; + int r; + + r = crypt_init_by_name(&cd, action_argv[0]); + if (r == 0) + r = crypt_deactivate(cd, action_argv[0]); + + crypt_free(cd); + return r; +} + +static int action_status(int arg) +{ + crypt_status_info ci; + struct crypt_active_device cad; + struct crypt_params_verity vp = {}; + struct crypt_device *cd = NULL; + struct stat st; + char *backing_file; + unsigned i, path = 0; + int r = 0; + + /* perhaps a path, not a dm device name */ + if (strchr(action_argv[0], '/') && !stat(action_argv[0], &st)) + path = 1; + + ci = crypt_status(NULL, action_argv[0]); + switch (ci) { + case CRYPT_INVALID: + r = -EINVAL; + break; + case CRYPT_INACTIVE: + if (path) + log_std("%s is inactive.\n", action_argv[0]); + else + log_std("%s/%s is inactive.\n", crypt_get_dir(), action_argv[0]); + r = -ENODEV; + break; + case CRYPT_ACTIVE: + case CRYPT_BUSY: + if (path) + log_std("%s is active%s.\n", action_argv[0], + ci == CRYPT_BUSY ? " and is in use" : ""); + else + 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], NULL); + if (r < 0 || !crypt_get_type(cd)) + goto out; + + log_std(" type: %s\n", crypt_get_type(cd)); + + r = crypt_get_active_device(cd, action_argv[0], &cad); + if (r < 0) + goto out; + + log_std(" status: %s\n", + cad.flags & CRYPT_ACTIVATE_CORRUPTED ? "corrupted" : "verified"); + + r = crypt_get_verity_info(cd, &vp); + if (r < 0) + goto out; + + log_std(" hash type: %u\n", vp.hash_type); + log_std(" data block: %u\n", vp.data_block_size); + log_std(" hash block: %u\n", vp.hash_block_size); + log_std(" hash name: %s\n", vp.hash_name); + log_std(" salt: "); + if (vp.salt_size) + for(i = 0; i < vp.salt_size; i++) + log_std("%02hhx", (const char)vp.salt[i]); + else + log_std("-"); + log_std("\n"); + + log_std(" data device: %s\n", vp.data_device); + if (crypt_loop_device(vp.data_device)) { + backing_file = crypt_loop_backing_file(vp.data_device); + log_std(" data loop: %s\n", backing_file); + free(backing_file); + } + log_std(" size: %" PRIu64 " sectors\n", cad.size); + log_std(" mode: %s\n", cad.flags & CRYPT_ACTIVATE_READONLY ? + "readonly" : "read/write"); + + log_std(" hash device: %s\n", vp.hash_device); + if (crypt_loop_device(vp.hash_device)) { + backing_file = crypt_loop_backing_file(vp.hash_device); + log_std(" hash loop: %s\n", backing_file); + free(backing_file); + } + log_std(" hash offset: %" PRIu64 " sectors\n", + vp.hash_area_offset * vp.hash_block_size / 512); + + if (vp.fec_device) { + log_std(" FEC device: %s\n", vp.fec_device); + if (crypt_loop_device(vp.fec_device)) { + backing_file = crypt_loop_backing_file(vp.fec_device); + log_std(" FEC loop: %s\n", backing_file); + free(backing_file); + } + log_std(" FEC offset: %" PRIu64 " sectors\n", + vp.fec_area_offset * vp.hash_block_size / 512); + log_std(" FEC roots: %u\n", vp.fec_roots); + } + if (cad.flags & (CRYPT_ACTIVATE_IGNORE_CORRUPTION| + CRYPT_ACTIVATE_RESTART_ON_CORRUPTION| + CRYPT_ACTIVATE_IGNORE_ZERO_BLOCKS| + CRYPT_ACTIVATE_CHECK_AT_MOST_ONCE)) + log_std(" flags: %s%s%s%s\n", + (cad.flags & CRYPT_ACTIVATE_IGNORE_CORRUPTION) ? "ignore_corruption " : "", + (cad.flags & CRYPT_ACTIVATE_RESTART_ON_CORRUPTION) ? "restart_on_corruption " : "", + (cad.flags & CRYPT_ACTIVATE_IGNORE_ZERO_BLOCKS) ? "ignore_zero_blocks " : "", + (cad.flags & CRYPT_ACTIVATE_CHECK_AT_MOST_ONCE) ? "check_at_most_once" : ""); + } +out: + crypt_free(cd); + if (r == -ENOTSUP) + r = 0; + return r; +} + +static int action_dump(int arg) +{ + struct crypt_device *cd = NULL; + struct crypt_params_verity params = {}; + int r; + + if ((r = crypt_init(&cd, action_argv[0]))) + return r; + + params.hash_area_offset = hash_offset; + params.fec_area_offset = fec_offset; + r = crypt_load(cd, CRYPT_VERITY, ¶ms); + if (!r) + crypt_dump(cd); + crypt_free(cd); + return r; +} + +static struct action_type { + const char *type; + int (*handler)(int); + int required_action_argc; + const char *arg_desc; + const char *desc; +} action_types[] = { + { "format", action_format, 2, N_("<data_device> <hash_device>"),N_("format device") }, + { "verify", action_verify, 3, N_("<data_device> <hash_device> <root_hash>"),N_("verify device") }, + { "open", action_open, 4, N_("<data_device> <name> <hash_device> <root_hash>"),N_("open device as <name>") }, + { "close", action_close, 1, N_("<name>"),N_("close device (deactivate and remove mapping)") }, + { "status", action_status, 1, N_("<name>"),N_("show active device status") }, + { "dump", action_dump, 1, N_("<hash_device>"),N_("show on-disk information") }, + { NULL, NULL, 0, NULL, NULL } +}; + +static void help(poptContext popt_context, + enum poptCallbackReason reason __attribute__((unused)), + struct poptOption *key, + const char *arg __attribute__((unused)), + void *data __attribute__((unused))) +{ + struct action_type *action; + + if (key->shortName == '?') { + log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION); + poptPrintHelp(popt_context, stdout, 0); + log_std(_("\n" + "<action> is one of:\n")); + for(action = action_types; action->type; action++) + log_std("\t%s %s - %s\n", action->type, _(action->arg_desc), _(action->desc)); + log_std(_("\n" + "<name> is the device to create under %s\n" + "<data_device> is the data device\n" + "<hash_device> is the device containing verification data\n" + "<root_hash> hash of the root node on <hash_device>\n"), + crypt_get_dir()); + + log_std(_("\nDefault compiled-in dm-verity parameters:\n" + "\tHash: %s, Data block (bytes): %u, " + "Hash block (bytes): %u, Salt size: %u, Hash format: %u\n"), + DEFAULT_VERITY_HASH, DEFAULT_VERITY_DATA_BLOCK, + DEFAULT_VERITY_HASH_BLOCK, DEFAULT_VERITY_SALT_SIZE, + 1); + exit(EXIT_SUCCESS); + } else + usage(popt_context, EXIT_SUCCESS, NULL, NULL); +} + +static int run_action(struct action_type *action) +{ + int r; + + log_dbg("Running command %s.", action->type); + + r = action->handler(0); + + show_status(r); + return translate_errno(r); +} + +int main(int argc, const char **argv) +{ + static char *popt_tmp; + static const char *null_action_argv[] = {NULL}; + static struct poptOption popt_help_options[] = { + { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL }, + { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL }, + { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL }, + POPT_TABLEEND + }; + static struct poptOption popt_options[] = { + { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL }, + { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), 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 }, + { "no-superblock", 0, POPT_ARG_VAL, &use_superblock, 0, N_("Do not use verity superblock"), NULL }, + { "format", 0, POPT_ARG_INT, &hash_type, 0, N_("Format type (1 - normal, 0 - original Chrome OS)"), N_("number") }, + { "data-block-size", 0, POPT_ARG_INT, &data_block_size, 0, N_("Block size on the data device"), N_("bytes") }, + { "hash-block-size", 0, POPT_ARG_INT, &hash_block_size, 0, N_("Block size on the hash device"), N_("bytes") }, + { "fec-roots", 0, POPT_ARG_INT, &fec_roots, 0, N_("FEC parity bytes"), N_("bytes") }, + { "data-blocks", 0, POPT_ARG_STRING, &popt_tmp, 1, N_("The number of blocks in the data file"), N_("blocks") }, + { "fec-device", 0, POPT_ARG_STRING, &fec_device, 0, N_("Path to device with error correction data"), N_("path") }, + { "hash-offset", 0, POPT_ARG_STRING, &popt_tmp, 2, N_("Starting offset on the hash device"), N_("bytes") }, + { "fec-offset", 0, POPT_ARG_STRING, &popt_tmp, 3, N_("Starting offset on the FEC device"), N_("bytes") }, + { "hash", 'h', POPT_ARG_STRING, &hash_algorithm, 0, N_("Hash algorithm"), N_("string") }, + { "salt", 's', POPT_ARG_STRING, &salt_string, 0, N_("Salt"), N_("hex string") }, + { "uuid", '\0', POPT_ARG_STRING, &opt_uuid, 0, N_("UUID for device to use"), NULL }, + { "restart-on-corruption", 0,POPT_ARG_NONE,&opt_restart_on_corruption, 0, N_("Restart kernel if corruption is detected"), NULL }, + { "ignore-corruption", 0, POPT_ARG_NONE, &opt_ignore_corruption, 0, N_("Ignore corruption, log it only"), NULL }, + { "ignore-zero-blocks", 0, POPT_ARG_NONE, &opt_ignore_zero_blocks, 0, N_("Do not verify zeroed blocks"), NULL }, + { "check-at-most-once", 0, POPT_ARG_NONE, &opt_check_at_most_once, 0, N_("Verify data block only the first time it is read"), NULL }, + POPT_TABLEEND + }; + + poptContext popt_context; + struct action_type *action; + const char *aname; + int r; + + crypt_set_log_callback(NULL, tool_log, NULL); + + setlocale(LC_ALL, ""); + bindtextdomain(PACKAGE, LOCALEDIR); + textdomain(PACKAGE); + + popt_context = poptGetContext("verity", argc, argv, popt_options, 0); + poptSetOtherOptionHelp(popt_context, + _("[OPTION...] <action> <action-specific>")); + + while((r = poptGetNextOpt(popt_context)) > 0) { + unsigned long long ull_value; + char *endp; + + errno = 0; + ull_value = strtoull(popt_tmp, &endp, 10); + if (*endp || !*popt_tmp || !isdigit(*popt_tmp) || + (errno == ERANGE && ull_value == ULLONG_MAX) || + (errno != 0 && ull_value == 0)) + r = POPT_ERROR_BADNUMBER; + + switch(r) { + case 1: + data_blocks = ull_value; + break; + case 2: + hash_offset = ull_value; + break; + case 3: + fec_offset = ull_value; + break; + } + + if (r < 0) + break; + } + + if (r < -1) + usage(popt_context, EXIT_FAILURE, poptStrerror(r), + poptBadOption(popt_context, POPT_BADOPTION_NOALIAS)); + + if (opt_version_mode) { + log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION); + poptFreeContext(popt_context); + exit(EXIT_SUCCESS); + } + + if (!(aname = poptGetArg(popt_context))) + usage(popt_context, EXIT_FAILURE, _("Argument <action> missing."), + poptGetInvocationName(popt_context)); + + action_argc = 0; + action_argv = poptGetArgs(popt_context); + /* Make return values of poptGetArgs more consistent in case of remaining argc = 0 */ + if(!action_argv) + action_argv = null_action_argv; + + /* Count args, somewhat unnice, change? */ + while(action_argv[action_argc] != NULL) + action_argc++; + + /* Handle aliases */ + if (!strcmp(aname, "create") && action_argc > 1) { + /* create command had historically switched arguments */ + if (action_argv[0] && action_argv[1]) { + const char *tmp = action_argv[0]; + action_argv[0] = action_argv[1]; + action_argv[1] = tmp; + } + aname = "open"; + } else if (!strcmp(aname, "remove")) { + aname = "close"; + } + + for (action = action_types; action->type; action++) + if (strcmp(action->type, aname) == 0) + break; + + if (!action->type) + usage(popt_context, EXIT_FAILURE, _("Unknown action."), + poptGetInvocationName(popt_context)); + + if (action_argc < action->required_action_argc) { + char buf[128]; + snprintf(buf, 128,_("%s: requires %s as arguments"), action->type, action->arg_desc); + usage(popt_context, EXIT_FAILURE, buf, + poptGetInvocationName(popt_context)); + } + + if (data_block_size < 0 || hash_block_size < 0 || hash_type < 0) { + usage(popt_context, EXIT_FAILURE, + _("Negative number for option not permitted."), + poptGetInvocationName(popt_context)); + } + + if ((opt_ignore_corruption || opt_restart_on_corruption || opt_ignore_zero_blocks) && strcmp(aname, "open")) + usage(popt_context, EXIT_FAILURE, + _("Option --ignore-corruption, --restart-on-corruption or --ignore-zero-blocks is allowed only for open operation.\n"), + poptGetInvocationName(popt_context)); + + if (opt_ignore_corruption && opt_restart_on_corruption) + usage(popt_context, EXIT_FAILURE, + _("Option --ignore-corruption and --restart-on-corruption cannot be used together.\n"), + poptGetInvocationName(popt_context)); + + if (opt_debug) { + opt_verbose = 1; + crypt_set_debug_level(-1); + dbg_version_and_cmd(argc, argv); + } + + r = run_action(action); + poptFreeContext(popt_context); + return r; +} |