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_whitelist
= 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 print_dependencies(FILE *f
, const char* device_path
) {
187 if (STR_IN_SET(device_path
, "-", "none"))
188 /* None, nothing to do */
191 if (PATH_IN_SET(device_path
, "/dev/urandom", "/dev/random", "/dev/hw_random")) {
192 /* RNG device, add random dep */
193 fputs("After=systemd-random-seed.service\n", f
);
197 _cleanup_free_
char *udev_node
= fstab_node_to_udev_node(device_path
);
201 if (path_equal(udev_node
, "/dev/null"))
204 if (path_startswith(udev_node
, "/dev/")) {
205 /* We are dealing with a block device, add dependency for correspoding unit */
206 _cleanup_free_
char *unit
= NULL
;
208 r
= unit_name_from_path(udev_node
, ".device", &unit
);
210 return log_error_errno(r
, "Failed to generate unit name: %m");
212 fprintf(f
, "After=%1$s\nRequires=%1$s\n", unit
);
214 /* Regular file, add mount dependency */
215 _cleanup_free_
char *escaped_path
= specifier_escape(device_path
);
219 fprintf(f
, "RequiresMountsFor=%s\n", escaped_path
);
225 static int create_disk(
228 const char *password
,
230 const char *options
) {
232 _cleanup_free_
char *n
= NULL
, *d
= NULL
, *u
= NULL
, *e
= NULL
,
233 *keydev_mount
= NULL
, *keyfile_timeout_value
= NULL
,
234 *filtered
= NULL
, *u_escaped
= NULL
, *name_escaped
= NULL
, *header_path
= NULL
, *password_buffer
= NULL
;
235 _cleanup_fclose_
FILE *f
= NULL
;
237 bool noauto
, nofail
, tmp
, swap
, netdev
, attach_in_initrd
;
238 int r
, detached_header
, keyfile_can_timeout
;
243 noauto
= fstab_test_yes_no_option(options
, "noauto\0" "auto\0");
244 nofail
= fstab_test_yes_no_option(options
, "nofail\0" "fail\0");
245 tmp
= fstab_test_option(options
, "tmp\0");
246 swap
= fstab_test_option(options
, "swap\0");
247 netdev
= fstab_test_option(options
, "_netdev\0");
248 attach_in_initrd
= fstab_test_option(options
, "x-initrd.attach\0");
250 keyfile_can_timeout
= fstab_filter_options(options
, "keyfile-timeout\0", NULL
, &keyfile_timeout_value
, NULL
);
251 if (keyfile_can_timeout
< 0)
252 return log_error_errno(keyfile_can_timeout
, "Failed to parse keyfile-timeout= option value: %m");
254 detached_header
= fstab_filter_options(options
, "header\0", NULL
, &header_path
, NULL
);
255 if (detached_header
< 0)
256 return log_error_errno(detached_header
, "Failed to parse header= option value: %m");
259 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
260 "Device '%s' cannot be both 'tmp' and 'swap'. Ignoring.",
263 name_escaped
= specifier_escape(name
);
267 e
= unit_name_escape(name
);
271 u
= fstab_node_to_udev_node(device
);
275 r
= unit_name_build("systemd-cryptsetup", e
, ".service", &n
);
277 return log_error_errno(r
, "Failed to generate unit name: %m");
279 u_escaped
= specifier_escape(u
);
283 r
= unit_name_from_path(u
, ".device", &d
);
285 return log_error_errno(r
, "Failed to generate unit name: %m");
287 if (keydev
&& !password
)
288 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
289 "Key device is specified, but path to the password file is missing.");
291 r
= generator_open_unit_file(arg_dest
, NULL
, n
, &f
);
295 r
= generator_write_cryptsetup_unit_section(f
, arg_crypttab
);
300 fprintf(f
, "After=remote-fs-pre.target\n");
302 /* If initrd takes care of attaching the disk then it should also detach it during shutdown. */
303 if (!attach_in_initrd
)
304 fprintf(f
, "Conflicts=umount.target\n");
307 _cleanup_free_
char *unit
= NULL
;
309 r
= generate_keydev_mount(name
, keydev
, keyfile_timeout_value
, keyfile_can_timeout
> 0, &unit
, &keydev_mount
);
311 return log_error_errno(r
, "Failed to generate keydev mount unit: %m");
313 password_buffer
= path_join(keydev_mount
, password
);
314 if (!password_buffer
)
317 password
= password_buffer
;
319 fprintf(f
, "After=%s\n", unit
);
320 if (keyfile_can_timeout
> 0)
321 fprintf(f
, "Wants=%s\n", unit
);
323 fprintf(f
, "Requires=%s\n", unit
);
329 netdev
? "remote-cryptsetup.target" : "cryptsetup.target");
331 if (password
&& !keydev
) {
332 r
= print_dependencies(f
, password
);
337 /* Check if a header option was specified */
338 if (detached_header
> 0) {
339 r
= print_dependencies(f
, header_path
);
344 if (path_startswith(u
, "/dev/"))
348 "Before=umount.target\n",
351 /* For loopback devices, add systemd-tmpfiles-setup-dev.service
352 dependency to ensure that loopback support is available in
353 the kernel (/dev/loop-control needs to exist) */
355 "RequiresMountsFor=%s\n"
356 "Requires=systemd-tmpfiles-setup-dev.service\n"
357 "After=systemd-tmpfiles-setup-dev.service\n",
360 r
= generator_write_timeouts(arg_dest
, device
, name
, options
, &filtered
);
362 log_warning_errno(r
, "Failed to write device timeout drop-in: %m");
364 r
= generator_write_cryptsetup_service_section(f
, name
, u
, password
, filtered
);
370 "ExecStartPost=/sbin/mke2fs '/dev/mapper/%s'\n",
375 "ExecStartPost=/sbin/mkswap '/dev/mapper/%s'\n",
380 "ExecStartPost=-" UMOUNT_PATH
" %s\n\n",
383 r
= fflush_and_check(f
);
385 return log_error_errno(r
, "Failed to write unit file %s: %m", n
);
388 r
= generator_add_symlink(arg_dest
,
389 netdev
? "remote-cryptsetup.target" : "cryptsetup.target",
390 nofail
? "wants" : "requires", n
);
395 dmname
= strjoina("dev-mapper-", e
, ".device");
396 r
= generator_add_symlink(arg_dest
, dmname
, "requires", n
);
400 if (!noauto
&& !nofail
) {
401 r
= write_drop_in(arg_dest
, dmname
, 40, "device-timeout",
402 "# Automatically generated by systemd-cryptsetup-generator\n\n"
403 "[Unit]\nJobTimeoutSec=0");
405 log_warning_errno(r
, "Failed to write device timeout drop-in: %m");
411 static crypto_device
* crypt_device_free(crypto_device
*d
) {
423 static crypto_device
*get_crypto_device(const char *uuid
) {
429 d
= hashmap_get(arg_disks
, uuid
);
431 d
= new0(struct crypto_device
, 1);
435 d
->uuid
= strdup(uuid
);
439 r
= hashmap_put(arg_disks
, d
->uuid
, d
);
449 static int parse_proc_cmdline_item(const char *key
, const char *value
, void *data
) {
450 _cleanup_free_
char *uuid
= NULL
, *uuid_value
= NULL
;
454 if (streq(key
, "luks")) {
456 r
= value
? parse_boolean(value
) : 1;
458 log_warning("Failed to parse luks= kernel command line switch %s. Ignoring.", value
);
462 } else if (streq(key
, "luks.crypttab")) {
464 r
= value
? parse_boolean(value
) : 1;
466 log_warning("Failed to parse luks.crypttab= kernel command line switch %s. Ignoring.", value
);
468 arg_read_crypttab
= r
;
470 } else if (streq(key
, "luks.uuid")) {
472 if (proc_cmdline_value_missing(key
, value
))
475 d
= get_crypto_device(startswith(value
, "luks-") ? value
+5 : value
);
479 d
->create
= arg_whitelist
= true;
481 } else if (streq(key
, "luks.options")) {
483 if (proc_cmdline_value_missing(key
, value
))
486 r
= sscanf(value
, "%m[0-9a-fA-F-]=%ms", &uuid
, &uuid_value
);
488 d
= get_crypto_device(uuid
);
492 free_and_replace(d
->options
, uuid_value
);
493 } else if (free_and_strdup(&arg_default_options
, value
) < 0)
496 } else if (streq(key
, "luks.key")) {
498 _cleanup_free_
char *keyfile
= NULL
, *keydev
= NULL
;
501 if (proc_cmdline_value_missing(key
, value
))
504 n
= strspn(value
, LETTERS DIGITS
"-");
505 if (value
[n
] != '=') {
506 if (free_and_strdup(&arg_default_keyfile
, value
) < 0)
511 uuid
= strndup(value
, n
);
515 if (!id128_is_valid(uuid
)) {
516 log_warning("Failed to parse luks.key= kernel command line switch. UUID is invalid, ignoring.");
520 d
= get_crypto_device(uuid
);
524 keyspec
= value
+ n
+ 1;
525 r
= split_keyspec(keyspec
, &keyfile
, &keydev
);
529 free_and_replace(d
->keyfile
, keyfile
);
530 free_and_replace(d
->keydev
, keydev
);
532 } else if (streq(key
, "luks.name")) {
534 if (proc_cmdline_value_missing(key
, value
))
537 r
= sscanf(value
, "%m[0-9a-fA-F-]=%ms", &uuid
, &uuid_value
);
539 d
= get_crypto_device(uuid
);
543 d
->create
= arg_whitelist
= true;
545 free_and_replace(d
->name
, uuid_value
);
547 log_warning("Failed to parse luks name switch %s. Ignoring.", value
);
553 static int add_crypttab_devices(void) {
554 _cleanup_fclose_
FILE *f
= NULL
;
555 unsigned crypttab_line
= 0;
559 if (!arg_read_crypttab
)
562 r
= fopen_unlocked(arg_crypttab
, "re", &f
);
565 log_error_errno(errno
, "Failed to open %s: %m", arg_crypttab
);
569 if (fstat(fileno(f
), &st
) < 0) {
570 log_error_errno(errno
, "Failed to stat %s: %m", arg_crypttab
);
575 _cleanup_free_
char *line
= NULL
, *name
= NULL
, *device
= NULL
, *keyspec
= NULL
, *options
= NULL
, *keyfile
= NULL
, *keydev
= NULL
;
576 crypto_device
*d
= NULL
;
580 r
= read_line(f
, LONG_LINE_MAX
, &line
);
582 return log_error_errno(r
, "Failed to read %s: %m", arg_crypttab
);
589 if (IN_SET(l
[0], 0, '#'))
592 k
= sscanf(l
, "%ms %ms %ms %ms", &name
, &device
, &keyspec
, &options
);
593 if (k
< 2 || k
> 4) {
594 log_error("Failed to parse %s:%u, ignoring.", arg_crypttab
, crypttab_line
);
598 uuid
= startswith(device
, "UUID=");
600 uuid
= path_startswith(device
, "/dev/disk/by-uuid/");
602 uuid
= startswith(name
, "luks-");
604 d
= hashmap_get(arg_disks
, uuid
);
606 if (arg_whitelist
&& !d
) {
607 log_info("Not creating device '%s' because it was not specified on the kernel command line.", name
);
611 r
= split_keyspec(keyspec
, &keyfile
, &keydev
);
615 r
= create_disk(name
, device
, keyfile
, keydev
, (d
&& d
->options
) ? d
->options
: options
);
626 static int add_proc_cmdline_devices(void) {
631 HASHMAP_FOREACH(d
, arg_disks
, i
) {
632 _cleanup_free_
char *device
= NULL
;
638 d
->name
= strjoin("luks-", d
->uuid
);
643 device
= strjoin("UUID=", d
->uuid
);
647 r
= create_disk(d
->name
,
649 d
->keyfile
?: arg_default_keyfile
,
651 d
->options
?: arg_default_options
);
659 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(crypt_device_hash_ops
, char, string_hash_func
, string_compare_func
,
660 crypto_device
, crypt_device_free
);
662 static int run(const char *dest
, const char *dest_early
, const char *dest_late
) {
665 assert_se(arg_dest
= dest
);
667 arg_crypttab
= getenv("SYSTEMD_CRYPTTAB") ?: "/etc/crypttab";
668 arg_runtime_directory
= getenv("RUNTIME_DIRECTORY") ?: "/run/systemd/cryptsetup";
670 arg_disks
= hashmap_new(&crypt_device_hash_ops
);
674 r
= proc_cmdline_parse(parse_proc_cmdline_item
, NULL
, PROC_CMDLINE_STRIP_RD_PREFIX
);
676 return log_warning_errno(r
, "Failed to parse kernel command line: %m");
681 r
= add_crypttab_devices();
685 r
= add_proc_cmdline_devices();
692 DEFINE_MAIN_GENERATOR_FUNCTION(run
);