/* SPDX-License-Identifier: LGPL-2.1+ */ #include #include #include #include #include #include #include "sd-device.h" #include "alloc-util.h" #include "ask-password-api.h" #include "crypt-util.h" #include "device-util.h" #include "escape.h" #include "fileio.h" #include "log.h" #include "main-func.h" #include "mount-util.h" #include "nulstr-util.h" #include "parse-util.h" #include "path-util.h" #include "pretty-print.h" #include "string-util.h" #include "strv.h" /* internal helper */ #define ANY_LUKS "LUKS" /* as in src/cryptsetup.h */ #define CRYPT_SECTOR_SIZE 512 #define CRYPT_MAX_SECTOR_SIZE 4096 static const char *arg_type = NULL; /* ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2, CRYPT_TCRYPT or CRYPT_PLAIN */ static char *arg_cipher = NULL; static unsigned arg_key_size = 0; static unsigned arg_sector_size = CRYPT_SECTOR_SIZE; static int arg_key_slot = CRYPT_ANY_SLOT; static unsigned arg_keyfile_size = 0; static uint64_t arg_keyfile_offset = 0; static char *arg_hash = NULL; static char *arg_header = NULL; static unsigned arg_tries = 3; static bool arg_readonly = false; static bool arg_verify = false; static bool arg_discards = false; static bool arg_same_cpu_crypt = false; static bool arg_submit_from_crypt_cpus = false; static bool arg_tcrypt_hidden = false; static bool arg_tcrypt_system = false; static bool arg_tcrypt_veracrypt = false; static char **arg_tcrypt_keyfiles = NULL; static uint64_t arg_offset = 0; static uint64_t arg_skip = 0; static usec_t arg_timeout = USEC_INFINITY; STATIC_DESTRUCTOR_REGISTER(arg_cipher, freep); STATIC_DESTRUCTOR_REGISTER(arg_hash, freep); STATIC_DESTRUCTOR_REGISTER(arg_header, freep); STATIC_DESTRUCTOR_REGISTER(arg_tcrypt_keyfiles, strv_freep); /* Options Debian's crypttab knows we don't: precheck= check= checkargs= noearly= loud= keyscript= */ static int parse_one_option(const char *option) { const char *val; int r; assert(option); /* Handled outside of this tool */ if (STR_IN_SET(option, "noauto", "auto", "nofail", "fail", "_netdev", "keyfile-timeout")) return 0; if (startswith(option, "keyfile-timeout=")) return 0; if ((val = startswith(option, "cipher="))) { r = free_and_strdup(&arg_cipher, val); if (r < 0) return log_oom(); } else if ((val = startswith(option, "size="))) { r = safe_atou(val, &arg_key_size); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } if (arg_key_size % 8) { log_error("size= not a multiple of 8, ignoring."); return 0; } arg_key_size /= 8; } else if ((val = startswith(option, "sector-size="))) { r = safe_atou(val, &arg_sector_size); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } if (arg_sector_size % 2) { log_error("sector-size= not a multiple of 2, ignoring."); return 0; } if (arg_sector_size < CRYPT_SECTOR_SIZE || arg_sector_size > CRYPT_MAX_SECTOR_SIZE) { log_error("sector-size= is outside of %u and %u, ignoring.", CRYPT_SECTOR_SIZE, CRYPT_MAX_SECTOR_SIZE); return 0; } } else if ((val = startswith(option, "key-slot="))) { arg_type = ANY_LUKS; r = safe_atoi(val, &arg_key_slot); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } } else if ((val = startswith(option, "tcrypt-keyfile="))) { arg_type = CRYPT_TCRYPT; if (path_is_absolute(val)) { if (strv_extend(&arg_tcrypt_keyfiles, val) < 0) return log_oom(); } else log_error("Key file path \"%s\" is not absolute. Ignoring.", val); } else if ((val = startswith(option, "keyfile-size="))) { r = safe_atou(val, &arg_keyfile_size); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } } else if ((val = startswith(option, "keyfile-offset="))) { r = safe_atou64(val, &arg_keyfile_offset); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } } else if ((val = startswith(option, "hash="))) { r = free_and_strdup(&arg_hash, val); if (r < 0) return log_oom(); } else if ((val = startswith(option, "header="))) { arg_type = ANY_LUKS; if (!path_is_absolute(val)) return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Header path \"%s\" is not absolute, refusing.", val); if (arg_header) return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Duplicate header= option, refusing."); arg_header = strdup(val); if (!arg_header) return log_oom(); } else if ((val = startswith(option, "tries="))) { r = safe_atou(val, &arg_tries); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } } else if (STR_IN_SET(option, "readonly", "read-only")) arg_readonly = true; else if (streq(option, "verify")) arg_verify = true; else if (STR_IN_SET(option, "allow-discards", "discard")) arg_discards = true; else if (streq(option, "same-cpu-crypt")) arg_same_cpu_crypt = true; else if (streq(option, "submit-from-crypt-cpus")) arg_submit_from_crypt_cpus = true; else if (streq(option, "luks")) arg_type = ANY_LUKS; else if (streq(option, "tcrypt")) arg_type = CRYPT_TCRYPT; else if (streq(option, "tcrypt-hidden")) { arg_type = CRYPT_TCRYPT; arg_tcrypt_hidden = true; } else if (streq(option, "tcrypt-system")) { arg_type = CRYPT_TCRYPT; arg_tcrypt_system = true; } else if (streq(option, "tcrypt-veracrypt")) { arg_type = CRYPT_TCRYPT; arg_tcrypt_veracrypt = true; } else if (STR_IN_SET(option, "plain", "swap", "tmp")) arg_type = CRYPT_PLAIN; else if ((val = startswith(option, "timeout="))) { r = parse_sec_fix_0(val, &arg_timeout); if (r < 0) { log_error_errno(r, "Failed to parse %s, ignoring: %m", option); return 0; } } else if ((val = startswith(option, "offset="))) { r = safe_atou64(val, &arg_offset); if (r < 0) return log_error_errno(r, "Failed to parse %s: %m", option); } else if ((val = startswith(option, "skip="))) { r = safe_atou64(val, &arg_skip); if (r < 0) return log_error_errno(r, "Failed to parse %s: %m", option); } else if (!streq(option, "none")) log_warning("Encountered unknown /etc/crypttab option '%s', ignoring.", option); return 0; } static int parse_options(const char *options) { const char *word, *state; size_t l; int r; assert(options); FOREACH_WORD_SEPARATOR(word, l, options, ",", state) { _cleanup_free_ char *o; o = strndup(word, l); if (!o) return -ENOMEM; r = parse_one_option(o); if (r < 0) return r; } /* sanity-check options */ if (arg_type != NULL && !streq(arg_type, CRYPT_PLAIN)) { if (arg_offset) log_warning("offset= ignored with type %s", arg_type); if (arg_skip) log_warning("skip= ignored with type %s", arg_type); } return 0; } static char* disk_description(const char *path) { static const char name_fields[] = "ID_PART_ENTRY_NAME\0" "DM_NAME\0" "ID_MODEL_FROM_DATABASE\0" "ID_MODEL\0"; _cleanup_(sd_device_unrefp) sd_device *device = NULL; const char *i, *name; struct stat st; assert(path); if (stat(path, &st) < 0) return NULL; if (!S_ISBLK(st.st_mode)) return NULL; if (sd_device_new_from_devnum(&device, 'b', st.st_rdev) < 0) return NULL; NULSTR_FOREACH(i, name_fields) if (sd_device_get_property_value(device, i, &name) >= 0 && !isempty(name)) return strdup(name); return NULL; } static char *disk_mount_point(const char *label) { _cleanup_free_ char *device = NULL; _cleanup_endmntent_ FILE *f = NULL; struct mntent *m; /* Yeah, we don't support native systemd unit files here for now */ if (asprintf(&device, "/dev/mapper/%s", label) < 0) return NULL; f = setmntent("/etc/fstab", "re"); if (!f) return NULL; while ((m = getmntent(f))) if (path_equal(m->mnt_fsname, device)) return strdup(m->mnt_dir); return NULL; } static int get_password(const char *vol, const char *src, usec_t until, bool accept_cached, char ***ret) { _cleanup_free_ char *description = NULL, *name_buffer = NULL, *mount_point = NULL, *text = NULL, *disk_path = NULL; _cleanup_strv_free_erase_ char **passwords = NULL; const char *name = NULL; char **p, *id; int r = 0; assert(vol); assert(src); assert(ret); description = disk_description(src); mount_point = disk_mount_point(vol); disk_path = cescape(src); if (!disk_path) return log_oom(); if (description && streq(vol, description)) /* If the description string is simply the * volume name, then let's not show this * twice */ description = mfree(description); if (mount_point && description) r = asprintf(&name_buffer, "%s (%s) on %s", description, vol, mount_point); else if (mount_point) r = asprintf(&name_buffer, "%s on %s", vol, mount_point); else if (description) r = asprintf(&name_buffer, "%s (%s)", description, vol); if (r < 0) return log_oom(); name = name_buffer ? name_buffer : vol; if (asprintf(&text, "Please enter passphrase for disk %s:", name) < 0) return log_oom(); id = strjoina("cryptsetup:", disk_path); r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", until, ASK_PASSWORD_PUSH_CACHE | (accept_cached*ASK_PASSWORD_ACCEPT_CACHED), &passwords); if (r < 0) return log_error_errno(r, "Failed to query password: %m"); if (arg_verify) { _cleanup_strv_free_erase_ char **passwords2 = NULL; assert(strv_length(passwords) == 1); if (asprintf(&text, "Please enter passphrase for disk %s (verification):", name) < 0) return log_oom(); id = strjoina("cryptsetup-verification:", disk_path); r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", until, ASK_PASSWORD_PUSH_CACHE, &passwords2); if (r < 0) return log_error_errno(r, "Failed to query verification password: %m"); assert(strv_length(passwords2) == 1); if (!streq(passwords[0], passwords2[0])) { log_warning("Passwords did not match, retrying."); return -EAGAIN; } } strv_uniq(passwords); STRV_FOREACH(p, passwords) { char *c; if (strlen(*p)+1 >= arg_key_size) continue; /* Pad password if necessary */ c = new(char, arg_key_size); if (!c) return log_oom(); strncpy(c, *p, arg_key_size); free_and_replace(*p, c); } *ret = TAKE_PTR(passwords); return 0; } static int attach_tcrypt( struct crypt_device *cd, const char *name, const char *key_file, char **passwords, uint32_t flags) { int r = 0; _cleanup_free_ char *passphrase = NULL; struct crypt_params_tcrypt params = { .flags = CRYPT_TCRYPT_LEGACY_MODES, .keyfiles = (const char **)arg_tcrypt_keyfiles, .keyfiles_count = strv_length(arg_tcrypt_keyfiles) }; assert(cd); assert(name); assert(key_file || (passwords && passwords[0])); if (arg_tcrypt_hidden) params.flags |= CRYPT_TCRYPT_HIDDEN_HEADER; if (arg_tcrypt_system) params.flags |= CRYPT_TCRYPT_SYSTEM_HEADER; if (arg_tcrypt_veracrypt) params.flags |= CRYPT_TCRYPT_VERA_MODES; if (key_file) { r = read_one_line_file(key_file, &passphrase); if (r < 0) { log_error_errno(r, "Failed to read password file '%s': %m", key_file); return -EAGAIN; /* log with the actual error, but return EAGAIN */ } params.passphrase = passphrase; } else params.passphrase = passwords[0]; params.passphrase_size = strlen(params.passphrase); r = crypt_load(cd, CRYPT_TCRYPT, ¶ms); if (r < 0) { if (key_file && r == -EPERM) { log_error_errno(r, "Failed to activate using password file '%s'. (Key data not correct?)", key_file); return -EAGAIN; /* log the actual error, but return EAGAIN */ } return log_error_errno(r, "Failed to load tcrypt superblock on device %s: %m", crypt_get_device_name(cd)); } r = crypt_activate_by_volume_key(cd, name, NULL, 0, flags); if (r < 0) return log_error_errno(r, "Failed to activate tcrypt device %s: %m", crypt_get_device_name(cd)); return 0; } static int attach_luks_or_plain(struct crypt_device *cd, const char *name, const char *key_file, char **passwords, uint32_t flags) { int r = 0; bool pass_volume_key = false; assert(cd); assert(name); assert(key_file || passwords); if ((!arg_type && !crypt_get_type(cd)) || streq_ptr(arg_type, CRYPT_PLAIN)) { struct crypt_params_plain params = { .offset = arg_offset, .skip = arg_skip, .sector_size = arg_sector_size, }; const char *cipher, *cipher_mode; _cleanup_free_ char *truncated_cipher = NULL; if (arg_hash) { /* plain isn't a real hash type. it just means "use no hash" */ if (!streq(arg_hash, "plain")) params.hash = arg_hash; } else if (!key_file) /* for CRYPT_PLAIN, the behaviour of cryptsetup * package is to not hash when a key file is provided */ params.hash = "ripemd160"; if (arg_cipher) { size_t l; l = strcspn(arg_cipher, "-"); truncated_cipher = strndup(arg_cipher, l); if (!truncated_cipher) return log_oom(); cipher = truncated_cipher; cipher_mode = arg_cipher[l] ? arg_cipher+l+1 : "plain"; } else { cipher = "aes"; cipher_mode = "cbc-essiv:sha256"; } /* for CRYPT_PLAIN limit reads from keyfile to key length, and ignore keyfile-size */ arg_keyfile_size = arg_key_size; /* In contrast to what the name crypt_format() might suggest this doesn't actually format * anything, it just configures encryption parameters when used for plain mode. */ r = crypt_format(cd, CRYPT_PLAIN, cipher, cipher_mode, NULL, NULL, arg_keyfile_size, ¶ms); if (r < 0) return log_error_errno(r, "Loading of cryptographic parameters failed: %m"); /* hash == NULL implies the user passed "plain" */ pass_volume_key = (params.hash == NULL); } log_info("Set cipher %s, mode %s, key size %i bits for device %s.", crypt_get_cipher(cd), crypt_get_cipher_mode(cd), crypt_get_volume_key_size(cd)*8, crypt_get_device_name(cd)); if (key_file) { r = crypt_activate_by_keyfile_device_offset(cd, name, arg_key_slot, key_file, arg_keyfile_size, arg_keyfile_offset, flags); if (r == -EPERM) { log_error_errno(r, "Failed to activate with key file '%s'. (Key data incorrect?)", key_file); return -EAGAIN; /* Log actual error, but return EAGAIN */ } if (r == -EINVAL) { log_error_errno(r, "Failed to activate with key file '%s'. (Key file missing?)", key_file); return -EAGAIN; /* Log actual error, but return EAGAIN */ } if (r < 0) return log_error_errno(r, "Failed to activate with key file '%s': %m", key_file); } else { char **p; r = -EINVAL; STRV_FOREACH(p, passwords) { if (pass_volume_key) r = crypt_activate_by_volume_key(cd, name, *p, arg_key_size, flags); else r = crypt_activate_by_passphrase(cd, name, arg_key_slot, *p, strlen(*p), flags); if (r >= 0) break; } if (r == -EPERM) { log_error_errno(r, "Failed to activate with specified passphrase. (Passphrase incorrect?)"); return -EAGAIN; /* log actual error, but return EAGAIN */ } if (r < 0) return log_error_errno(r, "Failed to activate with specified passphrase: %m"); } return r; } static int help(void) { _cleanup_free_ char *link = NULL; int r; r = terminal_urlify_man("systemd-cryptsetup@.service", "8", &link); if (r < 0) return log_oom(); printf("%s attach VOLUME SOURCEDEVICE [PASSWORD] [OPTIONS]\n" "%s detach VOLUME\n\n" "Attaches or detaches an encrypted block device.\n" "\nSee the %s for details.\n" , program_invocation_short_name , program_invocation_short_name , link ); return 0; } static uint32_t determine_flags(void) { uint32_t flags = 0; if (arg_readonly) flags |= CRYPT_ACTIVATE_READONLY; if (arg_discards) flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS; if (arg_same_cpu_crypt) flags |= CRYPT_ACTIVATE_SAME_CPU_CRYPT; if (arg_submit_from_crypt_cpus) flags |= CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS; return flags; } static int run(int argc, char *argv[]) { _cleanup_(crypt_freep) struct crypt_device *cd = NULL; int r; if (argc <= 1) return help(); if (argc < 3) { log_error("This program requires at least two arguments."); return -EINVAL; } log_setup_service(); crypt_set_log_callback(NULL, cryptsetup_log_glue, NULL); if (DEBUG_LOGGING) /* libcryptsetup won't even consider debug messages by default */ crypt_set_debug_level(CRYPT_DEBUG_ALL); umask(0022); if (streq(argv[1], "attach")) { uint32_t flags = 0; unsigned tries; usec_t until; crypt_status_info status; const char *key_file = NULL; /* Arguments: systemd-cryptsetup attach VOLUME SOURCE-DEVICE [PASSWORD] [OPTIONS] */ if (argc < 4) return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "attach requires at least two arguments."); if (argc >= 5 && argv[4][0] && !streq(argv[4], "-") && !streq(argv[4], "none")) { if (!path_is_absolute(argv[4])) log_warning("Password file path '%s' is not absolute. Ignoring.", argv[4]); else key_file = argv[4]; } if (argc >= 6 && argv[5][0] && !streq(argv[5], "-")) { r = parse_options(argv[5]); if (r < 0) return r; } /* A delicious drop of snake oil */ mlockall(MCL_FUTURE); if (arg_header) { log_debug("LUKS header: %s", arg_header); r = crypt_init(&cd, arg_header); } else r = crypt_init(&cd, argv[3]); if (r < 0) return log_error_errno(r, "crypt_init() failed: %m"); crypt_set_log_callback(cd, cryptsetup_log_glue, NULL); status = crypt_status(cd, argv[2]); if (IN_SET(status, CRYPT_ACTIVE, CRYPT_BUSY)) { log_info("Volume %s already active.", argv[2]); return 0; } flags = determine_flags(); if (arg_timeout == USEC_INFINITY) until = 0; else until = now(CLOCK_MONOTONIC) + arg_timeout; arg_key_size = (arg_key_size > 0 ? arg_key_size : (256 / 8)); if (key_file) { struct stat st; /* Ideally we'd do this on the open fd, but since this is just a * warning it's OK to do this in two steps. */ if (stat(key_file, &st) >= 0 && S_ISREG(st.st_mode) && (st.st_mode & 0005)) log_warning("Key file %s is world-readable. This is not a good idea!", key_file); } if (!arg_type || STR_IN_SET(arg_type, ANY_LUKS, CRYPT_LUKS1)) { r = crypt_load(cd, CRYPT_LUKS, NULL); if (r < 0) return log_error_errno(r, "Failed to load LUKS superblock on device %s: %m", crypt_get_device_name(cd)); if (arg_header) { r = crypt_set_data_device(cd, argv[3]); if (r < 0) return log_error_errno(r, "Failed to set LUKS data device %s: %m", argv[3]); } /* Tokens are available in LUKS2 only, but it is ok to call (and fail) with LUKS1. */ if (!key_file) { r = crypt_activate_by_token(cd, argv[2], CRYPT_ANY_TOKEN, NULL, flags); if (r >= 0) { log_debug("Volume %s activated with LUKS token id %i.", argv[2], r); return 0; } log_debug_errno(r, "Token activation unsuccessful for device %s: %m", crypt_get_device_name(cd)); } } for (tries = 0; arg_tries == 0 || tries < arg_tries; tries++) { _cleanup_strv_free_erase_ char **passwords = NULL; if (!key_file) { r = get_password(argv[2], argv[3], until, tries == 0 && !arg_verify, &passwords); if (r == -EAGAIN) continue; if (r < 0) return r; } if (streq_ptr(arg_type, CRYPT_TCRYPT)) r = attach_tcrypt(cd, argv[2], key_file, passwords, flags); else r = attach_luks_or_plain(cd, argv[2], key_file, passwords, flags); if (r >= 0) break; if (r != -EAGAIN) return r; /* Passphrase not correct? Let's try again! */ key_file = NULL; } if (arg_tries != 0 && tries >= arg_tries) return log_error_errno(SYNTHETIC_ERRNO(EPERM), "Too many attempts to activate; giving up."); } else if (streq(argv[1], "detach")) { r = crypt_init_by_name(&cd, argv[2]); if (r == -ENODEV) { log_info("Volume %s already inactive.", argv[2]); return 0; } if (r < 0) return log_error_errno(r, "crypt_init_by_name() failed: %m"); crypt_set_log_callback(cd, cryptsetup_log_glue, NULL); r = crypt_deactivate(cd, argv[2]); if (r < 0) return log_error_errno(r, "Failed to deactivate: %m"); } else return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Unknown verb %s.", argv[1]); return 0; } DEFINE_MAIN_FUNCTION(run);