1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include "alloc-util.h"
13 #include "fstab-util.h"
14 #include "generator.h"
16 #include "id128-util.h"
19 #include "parse-util.h"
20 #include "path-util.h"
21 #include "proc-cmdline.h"
22 #include "specifier.h"
23 #include "string-util.h"
25 #include "unit-name.h"
28 typedef struct crypto_device
{
37 static const char *arg_dest
= NULL
;
38 static bool arg_enabled
= true;
39 static bool arg_read_crypttab
= true;
40 static const char *arg_crypttab
= NULL
;
41 static const char *arg_runtime_directory
= NULL
;
42 static bool arg_allow_list
= false;
43 static Hashmap
*arg_disks
= NULL
;
44 static char *arg_default_options
= NULL
;
45 static char *arg_default_keyfile
= NULL
;
47 STATIC_DESTRUCTOR_REGISTER(arg_disks
, hashmap_freep
);
48 STATIC_DESTRUCTOR_REGISTER(arg_default_options
, freep
);
49 STATIC_DESTRUCTOR_REGISTER(arg_default_keyfile
, freep
);
51 static int split_keyspec(const char *keyspec
, char **ret_keyfile
, char **ret_keydev
) {
52 _cleanup_free_
char *keyfile
= NULL
, *keydev
= NULL
;
59 *ret_keyfile
= *ret_keydev
= NULL
;
63 c
= strrchr(keyspec
, ':');
65 /* The keydev part has to be either an absolute path to device node (/dev/something,
66 * /dev/foo/something, or even possibly /dev/foo/something:part), or a fstab device
67 * specification starting with LABEL= or similar. The keyfile part has the same syntax.
69 * Let's try to guess if the second part looks like a keydev specification, or just part of a
70 * filename with a colon. fstab_node_to_udev_node() will convert the fstab device syntax to
71 * an absolute path. If we didn't get an absolute path, assume that it is just part of the
72 * first keyfile argument. */
74 keydev
= fstab_node_to_udev_node(c
+ 1);
78 if (path_is_absolute(keydev
))
79 keyfile
= strndup(keyspec
, c
-keyspec
);
81 log_debug("Keyspec argument contains a colon, but \"%s\" doesn't look like a device specification.\n"
82 "Assuming that \"%s\" is a single device specification.",
84 keydev
= mfree(keydev
);
90 /* No keydev specified */
91 keyfile
= strdup(keyspec
);
96 *ret_keyfile
= TAKE_PTR(keyfile
);
97 *ret_keydev
= TAKE_PTR(keydev
);
102 static int generate_keydev_mount(
105 const char *keydev_timeout
,
110 _cleanup_free_
char *u
= NULL
, *where
= NULL
, *name_escaped
= NULL
, *device_unit
= NULL
;
111 _cleanup_fclose_
FILE *f
= NULL
;
120 r
= mkdir_parents(arg_runtime_directory
, 0755);
124 r
= mkdir(arg_runtime_directory
, 0700);
125 if (r
< 0 && errno
!= EEXIST
)
128 name_escaped
= cescape(name
);
132 where
= strjoin(arg_runtime_directory
, "/keydev-", name_escaped
);
136 r
= mkdir(where
, 0700);
137 if (r
< 0 && errno
!= EEXIST
)
140 r
= unit_name_from_path(where
, ".mount", &u
);
144 r
= generator_open_unit_file(arg_dest
, NULL
, u
, &f
);
150 "DefaultDependencies=no\n\n"
154 "Options=ro%s\n", keydev
, where
, canfail
? ",nofail" : "");
156 if (keydev_timeout
) {
157 r
= parse_sec_fix_0(keydev_timeout
, &timeout_us
);
159 r
= unit_name_from_path(keydev
, ".device", &device_unit
);
161 return log_error_errno(r
, "Failed to generate unit name: %m");
163 r
= write_drop_in_format(arg_dest
, device_unit
, 90, "device-timeout",
164 "# Automatically generated by systemd-cryptsetup-generator \n\n"
165 "[Unit]\nJobRunningTimeoutSec=%s", keydev_timeout
);
167 return log_error_errno(r
, "Failed to write device drop-in: %m");
170 log_warning_errno(r
, "Failed to parse %s, ignoring: %m", keydev_timeout
);
174 r
= fflush_and_check(f
);
179 *mount
= TAKE_PTR(where
);
184 static int generate_keydev_umount(const char *name
,
185 const char *keydev_mount
,
186 char **ret_umount_unit
) {
187 _cleanup_fclose_
FILE *f
= NULL
;
188 _cleanup_free_
char *u
= NULL
, *name_escaped
= NULL
, *mount
= NULL
;
192 assert(ret_umount_unit
);
194 name_escaped
= cescape(name
);
198 u
= strjoin("keydev-", name_escaped
, "-umount.service");
202 r
= unit_name_from_path(keydev_mount
, ".mount", &mount
);
206 r
= generator_open_unit_file(arg_dest
, NULL
, u
, &f
);
212 "DefaultDependencies=no\n"
215 "ExecStart=-" UMOUNT_PATH
" %s\n\n", mount
, keydev_mount
);
217 r
= fflush_and_check(f
);
221 *ret_umount_unit
= TAKE_PTR(u
);
225 static int print_dependencies(FILE *f
, const char* device_path
) {
228 if (STR_IN_SET(device_path
, "-", "none"))
229 /* None, nothing to do */
232 if (PATH_IN_SET(device_path
,
237 /* RNG device, add random dep */
238 fputs("After=systemd-random-seed.service\n", f
);
242 _cleanup_free_
char *udev_node
= fstab_node_to_udev_node(device_path
);
246 if (path_equal(udev_node
, "/dev/null"))
249 if (path_startswith(udev_node
, "/dev/")) {
250 /* We are dealing with a block device, add dependency for corresponding unit */
251 _cleanup_free_
char *unit
= NULL
;
253 r
= unit_name_from_path(udev_node
, ".device", &unit
);
255 return log_error_errno(r
, "Failed to generate unit name: %m");
259 "Requires=%1$s\n", unit
);
261 /* Regular file, add mount dependency */
262 _cleanup_free_
char *escaped_path
= specifier_escape(device_path
);
266 fprintf(f
, "RequiresMountsFor=%s\n", escaped_path
);
272 static int create_disk(
275 const char *password
,
278 const char *source
) {
280 _cleanup_free_
char *n
= NULL
, *d
= NULL
, *u
= NULL
, *e
= NULL
,
281 *keydev_mount
= NULL
, *keyfile_timeout_value
= NULL
,
282 *filtered
= NULL
, *u_escaped
= NULL
, *name_escaped
= NULL
, *header_path
= NULL
, *password_buffer
= NULL
,
284 _cleanup_fclose_
FILE *f
= NULL
;
286 bool noauto
, nofail
, swap
, netdev
, attach_in_initrd
;
287 int r
, detached_header
, keyfile_can_timeout
, tmp
;
292 noauto
= fstab_test_yes_no_option(options
, "noauto\0" "auto\0");
293 nofail
= fstab_test_yes_no_option(options
, "nofail\0" "fail\0");
294 swap
= fstab_test_option(options
, "swap\0");
295 netdev
= fstab_test_option(options
, "_netdev\0");
296 attach_in_initrd
= fstab_test_option(options
, "x-initrd.attach\0");
298 keyfile_can_timeout
= fstab_filter_options(options
, "keyfile-timeout\0", NULL
, &keyfile_timeout_value
, NULL
);
299 if (keyfile_can_timeout
< 0)
300 return log_error_errno(keyfile_can_timeout
, "Failed to parse keyfile-timeout= option value: %m");
302 detached_header
= fstab_filter_options(options
, "header\0", NULL
, &header_path
, NULL
);
303 if (detached_header
< 0)
304 return log_error_errno(detached_header
, "Failed to parse header= option value: %m");
306 tmp
= fstab_filter_options(options
, "tmp\0", NULL
, &tmp_fstype
, NULL
);
308 return log_error_errno(tmp
, "Failed to parse tmp= option value: %m");
311 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
312 "Device '%s' cannot be both 'tmp' and 'swap'. Ignoring.",
315 name_escaped
= specifier_escape(name
);
319 e
= unit_name_escape(name
);
323 u
= fstab_node_to_udev_node(device
);
327 r
= unit_name_build("systemd-cryptsetup", e
, ".service", &n
);
329 return log_error_errno(r
, "Failed to generate unit name: %m");
331 u_escaped
= specifier_escape(u
);
335 r
= unit_name_from_path(u
, ".device", &d
);
337 return log_error_errno(r
, "Failed to generate unit name: %m");
339 if (keydev
&& !password
)
340 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
341 "Key device is specified, but path to the password file is missing.");
343 r
= generator_open_unit_file(arg_dest
, NULL
, n
, &f
);
347 r
= generator_write_cryptsetup_unit_section(f
, source
);
352 fprintf(f
, "After=remote-fs-pre.target\n");
354 /* If initrd takes care of attaching the disk then it should also detach it during shutdown. */
355 if (!attach_in_initrd
)
356 fprintf(f
, "Conflicts=umount.target\n");
359 _cleanup_free_
char *unit
= NULL
, *umount_unit
= NULL
;
361 r
= generate_keydev_mount(name
, keydev
, keyfile_timeout_value
, keyfile_can_timeout
> 0, &unit
, &keydev_mount
);
363 return log_error_errno(r
, "Failed to generate keydev mount unit: %m");
365 r
= generate_keydev_umount(name
, keydev_mount
, &umount_unit
);
367 return log_error_errno(r
, "Failed to generate keydev umount unit: %m");
369 password_buffer
= path_join(keydev_mount
, password
);
370 if (!password_buffer
)
373 password
= password_buffer
;
375 fprintf(f
, "After=%s\n", unit
);
376 if (keyfile_can_timeout
> 0)
377 fprintf(f
, "Wants=%s\n", unit
);
379 fprintf(f
, "Requires=%s\n", unit
);
393 netdev
? "remote-cryptsetup.target" : "cryptsetup.target");
395 if (password
&& !keydev
) {
396 r
= print_dependencies(f
, password
);
401 /* Check if a header option was specified */
402 if (detached_header
> 0) {
403 r
= print_dependencies(f
, header_path
);
408 if (path_startswith(u
, "/dev/"))
412 "Before=umount.target\n",
415 /* For loopback devices, add systemd-tmpfiles-setup-dev.service
416 dependency to ensure that loopback support is available in
417 the kernel (/dev/loop-control needs to exist) */
419 "RequiresMountsFor=%s\n"
420 "Requires=systemd-tmpfiles-setup-dev.service\n"
421 "After=systemd-tmpfiles-setup-dev.service\n",
424 r
= generator_write_timeouts(arg_dest
, device
, name
, options
, &filtered
);
426 log_warning_errno(r
, "Failed to write device timeout drop-in: %m");
428 r
= generator_write_cryptsetup_service_section(f
, name
, u
, password
, filtered
);
433 _cleanup_free_
char *tmp_fstype_escaped
= NULL
;
436 tmp_fstype_escaped
= specifier_escape(tmp_fstype
);
437 if (!tmp_fstype_escaped
)
442 "ExecStartPost=" ROOTLIBEXECDIR
"/systemd-makefs '%s' '/dev/mapper/%s'\n",
443 tmp_fstype_escaped
?: "ext4", name_escaped
);
448 "ExecStartPost=" ROOTLIBEXECDIR
"/systemd-makefs swap '/dev/mapper/%s'\n",
451 r
= fflush_and_check(f
);
453 return log_error_errno(r
, "Failed to write unit file %s: %m", n
);
456 r
= generator_add_symlink(arg_dest
,
457 netdev
? "remote-cryptsetup.target" : "cryptsetup.target",
458 nofail
? "wants" : "requires", n
);
463 dmname
= strjoina("dev-mapper-", e
, ".device");
464 r
= generator_add_symlink(arg_dest
, dmname
, "requires", n
);
468 if (!noauto
&& !nofail
) {
469 r
= write_drop_in(arg_dest
, dmname
, 40, "device-timeout",
470 "# Automatically generated by systemd-cryptsetup-generator\n\n"
471 "[Unit]\nJobTimeoutSec=0");
473 log_warning_errno(r
, "Failed to write device timeout drop-in: %m");
479 static crypto_device
* crypt_device_free(crypto_device
*d
) {
491 static crypto_device
*get_crypto_device(const char *uuid
) {
497 d
= hashmap_get(arg_disks
, uuid
);
499 d
= new0(struct crypto_device
, 1);
503 d
->uuid
= strdup(uuid
);
507 r
= hashmap_put(arg_disks
, d
->uuid
, d
);
517 static int parse_proc_cmdline_item(const char *key
, const char *value
, void *data
) {
518 _cleanup_free_
char *uuid
= NULL
, *uuid_value
= NULL
;
522 if (streq(key
, "luks")) {
524 r
= value
? parse_boolean(value
) : 1;
526 log_warning("Failed to parse luks= kernel command line switch %s. Ignoring.", value
);
530 } else if (streq(key
, "luks.crypttab")) {
532 r
= value
? parse_boolean(value
) : 1;
534 log_warning("Failed to parse luks.crypttab= kernel command line switch %s. Ignoring.", value
);
536 arg_read_crypttab
= r
;
538 } else if (streq(key
, "luks.uuid")) {
540 if (proc_cmdline_value_missing(key
, value
))
543 d
= get_crypto_device(startswith(value
, "luks-") ?: value
);
547 d
->create
= arg_allow_list
= true;
549 } else if (streq(key
, "luks.options")) {
551 if (proc_cmdline_value_missing(key
, value
))
554 r
= sscanf(value
, "%m[0-9a-fA-F-]=%ms", &uuid
, &uuid_value
);
556 d
= get_crypto_device(uuid
);
560 free_and_replace(d
->options
, uuid_value
);
561 } else if (free_and_strdup(&arg_default_options
, value
) < 0)
564 } else if (streq(key
, "luks.key")) {
566 _cleanup_free_
char *keyfile
= NULL
, *keydev
= NULL
;
569 if (proc_cmdline_value_missing(key
, value
))
572 n
= strspn(value
, LETTERS DIGITS
"-");
573 if (value
[n
] != '=') {
574 if (free_and_strdup(&arg_default_keyfile
, value
) < 0)
579 uuid
= strndup(value
, n
);
583 if (!id128_is_valid(uuid
)) {
584 log_warning("Failed to parse luks.key= kernel command line switch. UUID is invalid, ignoring.");
588 d
= get_crypto_device(uuid
);
592 keyspec
= value
+ n
+ 1;
593 r
= split_keyspec(keyspec
, &keyfile
, &keydev
);
597 free_and_replace(d
->keyfile
, keyfile
);
598 free_and_replace(d
->keydev
, keydev
);
600 } else if (streq(key
, "luks.name")) {
602 if (proc_cmdline_value_missing(key
, value
))
605 r
= sscanf(value
, "%m[0-9a-fA-F-]=%ms", &uuid
, &uuid_value
);
607 d
= get_crypto_device(uuid
);
611 d
->create
= arg_allow_list
= true;
613 free_and_replace(d
->name
, uuid_value
);
615 log_warning("Failed to parse luks name switch %s. Ignoring.", value
);
621 static int add_crypttab_devices(void) {
622 _cleanup_fclose_
FILE *f
= NULL
;
623 unsigned crypttab_line
= 0;
626 if (!arg_read_crypttab
)
629 r
= fopen_unlocked(arg_crypttab
, "re", &f
);
632 log_error_errno(errno
, "Failed to open %s: %m", arg_crypttab
);
637 _cleanup_free_
char *line
= NULL
, *name
= NULL
, *device
= NULL
, *keyspec
= NULL
, *options
= NULL
, *keyfile
= NULL
, *keydev
= NULL
;
638 crypto_device
*d
= NULL
;
642 r
= read_line(f
, LONG_LINE_MAX
, &line
);
644 return log_error_errno(r
, "Failed to read %s: %m", arg_crypttab
);
651 if (IN_SET(l
[0], 0, '#'))
654 k
= sscanf(l
, "%ms %ms %ms %ms", &name
, &device
, &keyspec
, &options
);
655 if (k
< 2 || k
> 4) {
656 log_error("Failed to parse %s:%u, ignoring.", arg_crypttab
, crypttab_line
);
660 uuid
= startswith(device
, "UUID=");
662 uuid
= path_startswith(device
, "/dev/disk/by-uuid/");
664 uuid
= startswith(name
, "luks-");
666 d
= hashmap_get(arg_disks
, uuid
);
668 if (arg_allow_list
&& !d
) {
669 log_info("Not creating device '%s' because it was not specified on the kernel command line.", name
);
673 r
= split_keyspec(keyspec
, &keyfile
, &keydev
);
677 r
= create_disk(name
, device
, keyfile
, keydev
, (d
&& d
->options
) ? d
->options
: options
, arg_crypttab
);
688 static int add_proc_cmdline_devices(void) {
692 HASHMAP_FOREACH(d
, arg_disks
) {
693 _cleanup_free_
char *device
= NULL
;
699 d
->name
= strjoin("luks-", d
->uuid
);
704 device
= strjoin("UUID=", d
->uuid
);
708 r
= create_disk(d
->name
,
710 d
->keyfile
?: arg_default_keyfile
,
712 d
->options
?: arg_default_options
,
721 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(crypt_device_hash_ops
, char, string_hash_func
, string_compare_func
,
722 crypto_device
, crypt_device_free
);
724 static int run(const char *dest
, const char *dest_early
, const char *dest_late
) {
727 assert_se(arg_dest
= dest
);
729 arg_crypttab
= getenv("SYSTEMD_CRYPTTAB") ?: "/etc/crypttab";
730 arg_runtime_directory
= getenv("RUNTIME_DIRECTORY") ?: "/run/systemd/cryptsetup";
732 arg_disks
= hashmap_new(&crypt_device_hash_ops
);
736 r
= proc_cmdline_parse(parse_proc_cmdline_item
, NULL
, PROC_CMDLINE_STRIP_RD_PREFIX
);
738 return log_warning_errno(r
, "Failed to parse kernel command line: %m");
743 r
= add_crypttab_devices();
747 r
= add_proc_cmdline_devices();
754 DEFINE_MAIN_GENERATOR_FUNCTION(run
);