]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/cryptsetup/cryptsetup-generator.c
units: introduce blockdev@.target for properly ordering mounts/swaps against cryptsetup
[thirdparty/systemd.git] / src / cryptsetup / cryptsetup-generator.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2
3 #include <errno.h>
4 #include <fcntl.h>
5 #include <sys/stat.h>
6 #include <sys/types.h>
7
8 #include "alloc-util.h"
9 #include "dropin.h"
10 #include "escape.h"
11 #include "fd-util.h"
12 #include "fileio.h"
13 #include "fstab-util.h"
14 #include "generator.h"
15 #include "hashmap.h"
16 #include "id128-util.h"
17 #include "log.h"
18 #include "mkdir.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"
24 #include "strv.h"
25 #include "unit-name.h"
26 #include "util.h"
27
28 typedef struct crypto_device {
29 char *uuid;
30 char *keyfile;
31 char *keydev;
32 char *name;
33 char *options;
34 bool create;
35 } crypto_device;
36
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;
46
47 STATIC_DESTRUCTOR_REGISTER(arg_disks, hashmap_freep);
48 STATIC_DESTRUCTOR_REGISTER(arg_default_options, freep);
49 STATIC_DESTRUCTOR_REGISTER(arg_default_keyfile, freep);
50
51 static int split_keyspec(const char *keyspec, char **ret_keyfile, char **ret_keydev) {
52 _cleanup_free_ char *keyfile = NULL, *keydev = NULL;
53 const char *c;
54
55 assert(ret_keyfile);
56 assert(ret_keydev);
57
58 if (!keyspec) {
59 *ret_keyfile = *ret_keydev = NULL;
60 return 0;
61 }
62
63 c = strrchr(keyspec, ':');
64 if (c) {
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.
68 *
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. */
73
74 keydev = fstab_node_to_udev_node(c + 1);
75 if (!keydev)
76 return log_oom();
77
78 if (path_is_absolute(keydev))
79 keyfile = strndup(keyspec, c-keyspec);
80 else {
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.",
83 c + 1, keyspec);
84 keydev = mfree(keydev);
85 c = NULL;
86 }
87 }
88
89 if (!c)
90 /* No keydev specified */
91 keyfile = strdup(keyspec);
92
93 if (!keyfile)
94 return log_oom();
95
96 *ret_keyfile = TAKE_PTR(keyfile);
97 *ret_keydev = TAKE_PTR(keydev);
98
99 return 0;
100 }
101
102 static int generate_keydev_mount(
103 const char *name,
104 const char *keydev,
105 const char *keydev_timeout,
106 bool canfail,
107 char **unit,
108 char **mount) {
109
110 _cleanup_free_ char *u = NULL, *where = NULL, *name_escaped = NULL, *device_unit = NULL;
111 _cleanup_fclose_ FILE *f = NULL;
112 int r;
113 usec_t timeout_us;
114
115 assert(name);
116 assert(keydev);
117 assert(unit);
118 assert(mount);
119
120 r = mkdir_parents(arg_runtime_directory, 0755);
121 if (r < 0)
122 return r;
123
124 r = mkdir(arg_runtime_directory, 0700);
125 if (r < 0 && errno != EEXIST)
126 return -errno;
127
128 name_escaped = cescape(name);
129 if (!name_escaped)
130 return -ENOMEM;
131
132 where = strjoin(arg_runtime_directory, "/keydev-", name_escaped);
133 if (!where)
134 return -ENOMEM;
135
136 r = mkdir(where, 0700);
137 if (r < 0 && errno != EEXIST)
138 return -errno;
139
140 r = unit_name_from_path(where, ".mount", &u);
141 if (r < 0)
142 return r;
143
144 r = generator_open_unit_file(arg_dest, NULL, u, &f);
145 if (r < 0)
146 return r;
147
148 fprintf(f,
149 "[Unit]\n"
150 "DefaultDependencies=no\n\n"
151 "[Mount]\n"
152 "What=%s\n"
153 "Where=%s\n"
154 "Options=ro%s\n", keydev, where, canfail ? ",nofail" : "");
155
156 if (keydev_timeout) {
157 r = parse_sec_fix_0(keydev_timeout, &timeout_us);
158 if (r >= 0) {
159 r = unit_name_from_path(keydev, ".device", &device_unit);
160 if (r < 0)
161 return log_error_errno(r, "Failed to generate unit name: %m");
162
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);
166 if (r < 0)
167 return log_error_errno(r, "Failed to write device drop-in: %m");
168
169 } else
170 log_warning_errno(r, "Failed to parse %s, ignoring: %m", keydev_timeout);
171
172 }
173
174 r = fflush_and_check(f);
175 if (r < 0)
176 return r;
177
178 *unit = TAKE_PTR(u);
179 *mount = TAKE_PTR(where);
180
181 return 0;
182 }
183
184 static int print_dependencies(FILE *f, const char* device_path) {
185 int r;
186
187 if (STR_IN_SET(device_path, "-", "none"))
188 /* None, nothing to do */
189 return 0;
190
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);
194 return 0;
195 }
196
197 _cleanup_free_ char *udev_node = fstab_node_to_udev_node(device_path);
198 if (!udev_node)
199 return log_oom();
200
201 if (path_equal(udev_node, "/dev/null"))
202 return 0;
203
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;
207
208 r = unit_name_from_path(udev_node, ".device", &unit);
209 if (r < 0)
210 return log_error_errno(r, "Failed to generate unit name: %m");
211
212 fprintf(f, "After=%1$s\nRequires=%1$s\n", unit);
213 } else {
214 /* Regular file, add mount dependency */
215 _cleanup_free_ char *escaped_path = specifier_escape(device_path);
216 if (!escaped_path)
217 return log_oom();
218
219 fprintf(f, "RequiresMountsFor=%s\n", escaped_path);
220 }
221
222 return 0;
223 }
224
225 static int create_disk(
226 const char *name,
227 const char *device,
228 const char *password,
229 const char *keydev,
230 const char *options) {
231
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;
236 const char *dmname;
237 bool noauto, nofail, tmp, swap, netdev, attach_in_initrd;
238 int r, detached_header, keyfile_can_timeout;
239
240 assert(name);
241 assert(device);
242
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");
249
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");
253
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");
257
258 if (tmp && swap)
259 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
260 "Device '%s' cannot be both 'tmp' and 'swap'. Ignoring.",
261 name);
262
263 name_escaped = specifier_escape(name);
264 if (!name_escaped)
265 return log_oom();
266
267 e = unit_name_escape(name);
268 if (!e)
269 return log_oom();
270
271 u = fstab_node_to_udev_node(device);
272 if (!u)
273 return log_oom();
274
275 r = unit_name_build("systemd-cryptsetup", e, ".service", &n);
276 if (r < 0)
277 return log_error_errno(r, "Failed to generate unit name: %m");
278
279 u_escaped = specifier_escape(u);
280 if (!u_escaped)
281 return log_oom();
282
283 r = unit_name_from_path(u, ".device", &d);
284 if (r < 0)
285 return log_error_errno(r, "Failed to generate unit name: %m");
286
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.");
290
291 r = generator_open_unit_file(arg_dest, NULL, n, &f);
292 if (r < 0)
293 return r;
294
295 r = generator_write_cryptsetup_unit_section(f, arg_crypttab);
296 if (r < 0)
297 return r;
298
299 if (netdev)
300 fprintf(f, "After=remote-fs-pre.target\n");
301
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");
305
306 if (keydev) {
307 _cleanup_free_ char *unit = NULL;
308
309 r = generate_keydev_mount(name, keydev, keyfile_timeout_value, keyfile_can_timeout > 0, &unit, &keydev_mount);
310 if (r < 0)
311 return log_error_errno(r, "Failed to generate keydev mount unit: %m");
312
313 password_buffer = path_join(keydev_mount, password);
314 if (!password_buffer)
315 return log_oom();
316
317 password = password_buffer;
318
319 fprintf(f, "After=%s\n", unit);
320 if (keyfile_can_timeout > 0)
321 fprintf(f, "Wants=%s\n", unit);
322 else
323 fprintf(f, "Requires=%s\n", unit);
324 }
325
326 if (!nofail)
327 fprintf(f,
328 "Before=%s\n",
329 netdev ? "remote-cryptsetup.target" : "cryptsetup.target");
330
331 if (password && !keydev) {
332 r = print_dependencies(f, password);
333 if (r < 0)
334 return r;
335 }
336
337 /* Check if a header option was specified */
338 if (detached_header > 0) {
339 r = print_dependencies(f, header_path);
340 if (r < 0)
341 return r;
342 }
343
344 if (path_startswith(u, "/dev/"))
345 fprintf(f,
346 "BindsTo=%s\n"
347 "After=%s\n"
348 "Before=umount.target\n",
349 d, d);
350 else
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) */
354 fprintf(f,
355 "RequiresMountsFor=%s\n"
356 "Requires=systemd-tmpfiles-setup-dev.service\n"
357 "After=systemd-tmpfiles-setup-dev.service\n",
358 u_escaped);
359
360 r = generator_write_timeouts(arg_dest, device, name, options, &filtered);
361 if (r < 0)
362 log_warning_errno(r, "Failed to write device timeout drop-in: %m");
363
364 r = generator_write_cryptsetup_service_section(f, name, u, password, filtered);
365 if (r < 0)
366 return r;
367
368 if (tmp)
369 fprintf(f,
370 "ExecStartPost=/sbin/mke2fs '/dev/mapper/%s'\n",
371 name_escaped);
372
373 if (swap)
374 fprintf(f,
375 "ExecStartPost=/sbin/mkswap '/dev/mapper/%s'\n",
376 name_escaped);
377
378 if (keydev)
379 fprintf(f,
380 "ExecStartPost=-" UMOUNT_PATH " %s\n\n",
381 keydev_mount);
382
383 r = fflush_and_check(f);
384 if (r < 0)
385 return log_error_errno(r, "Failed to write unit file %s: %m", n);
386
387 if (!noauto) {
388 r = generator_add_symlink(arg_dest,
389 netdev ? "remote-cryptsetup.target" : "cryptsetup.target",
390 nofail ? "wants" : "requires", n);
391 if (r < 0)
392 return r;
393 }
394
395 dmname = strjoina("dev-mapper-", e, ".device");
396 r = generator_add_symlink(arg_dest, dmname, "requires", n);
397 if (r < 0)
398 return r;
399
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");
404 if (r < 0)
405 log_warning_errno(r, "Failed to write device timeout drop-in: %m");
406 }
407
408 return 0;
409 }
410
411 static crypto_device* crypt_device_free(crypto_device *d) {
412 if (!d)
413 return NULL;
414
415 free(d->uuid);
416 free(d->keyfile);
417 free(d->keydev);
418 free(d->name);
419 free(d->options);
420 return mfree(d);
421 }
422
423 static crypto_device *get_crypto_device(const char *uuid) {
424 int r;
425 crypto_device *d;
426
427 assert(uuid);
428
429 d = hashmap_get(arg_disks, uuid);
430 if (!d) {
431 d = new0(struct crypto_device, 1);
432 if (!d)
433 return NULL;
434
435 d->uuid = strdup(uuid);
436 if (!d->uuid)
437 return mfree(d);
438
439 r = hashmap_put(arg_disks, d->uuid, d);
440 if (r < 0) {
441 free(d->uuid);
442 return mfree(d);
443 }
444 }
445
446 return d;
447 }
448
449 static int parse_proc_cmdline_item(const char *key, const char *value, void *data) {
450 _cleanup_free_ char *uuid = NULL, *uuid_value = NULL;
451 crypto_device *d;
452 int r;
453
454 if (streq(key, "luks")) {
455
456 r = value ? parse_boolean(value) : 1;
457 if (r < 0)
458 log_warning("Failed to parse luks= kernel command line switch %s. Ignoring.", value);
459 else
460 arg_enabled = r;
461
462 } else if (streq(key, "luks.crypttab")) {
463
464 r = value ? parse_boolean(value) : 1;
465 if (r < 0)
466 log_warning("Failed to parse luks.crypttab= kernel command line switch %s. Ignoring.", value);
467 else
468 arg_read_crypttab = r;
469
470 } else if (streq(key, "luks.uuid")) {
471
472 if (proc_cmdline_value_missing(key, value))
473 return 0;
474
475 d = get_crypto_device(startswith(value, "luks-") ? value+5 : value);
476 if (!d)
477 return log_oom();
478
479 d->create = arg_whitelist = true;
480
481 } else if (streq(key, "luks.options")) {
482
483 if (proc_cmdline_value_missing(key, value))
484 return 0;
485
486 r = sscanf(value, "%m[0-9a-fA-F-]=%ms", &uuid, &uuid_value);
487 if (r == 2) {
488 d = get_crypto_device(uuid);
489 if (!d)
490 return log_oom();
491
492 free_and_replace(d->options, uuid_value);
493 } else if (free_and_strdup(&arg_default_options, value) < 0)
494 return log_oom();
495
496 } else if (streq(key, "luks.key")) {
497 size_t n;
498 _cleanup_free_ char *keyfile = NULL, *keydev = NULL;
499 const char *keyspec;
500
501 if (proc_cmdline_value_missing(key, value))
502 return 0;
503
504 n = strspn(value, LETTERS DIGITS "-");
505 if (value[n] != '=') {
506 if (free_and_strdup(&arg_default_keyfile, value) < 0)
507 return log_oom();
508 return 0;
509 }
510
511 uuid = strndup(value, n);
512 if (!uuid)
513 return log_oom();
514
515 if (!id128_is_valid(uuid)) {
516 log_warning("Failed to parse luks.key= kernel command line switch. UUID is invalid, ignoring.");
517 return 0;
518 }
519
520 d = get_crypto_device(uuid);
521 if (!d)
522 return log_oom();
523
524 keyspec = value + n + 1;
525 r = split_keyspec(keyspec, &keyfile, &keydev);
526 if (r < 0)
527 return r;
528
529 free_and_replace(d->keyfile, keyfile);
530 free_and_replace(d->keydev, keydev);
531
532 } else if (streq(key, "luks.name")) {
533
534 if (proc_cmdline_value_missing(key, value))
535 return 0;
536
537 r = sscanf(value, "%m[0-9a-fA-F-]=%ms", &uuid, &uuid_value);
538 if (r == 2) {
539 d = get_crypto_device(uuid);
540 if (!d)
541 return log_oom();
542
543 d->create = arg_whitelist = true;
544
545 free_and_replace(d->name, uuid_value);
546 } else
547 log_warning("Failed to parse luks name switch %s. Ignoring.", value);
548 }
549
550 return 0;
551 }
552
553 static int add_crypttab_devices(void) {
554 _cleanup_fclose_ FILE *f = NULL;
555 unsigned crypttab_line = 0;
556 struct stat st;
557 int r;
558
559 if (!arg_read_crypttab)
560 return 0;
561
562 r = fopen_unlocked(arg_crypttab, "re", &f);
563 if (r < 0) {
564 if (errno != ENOENT)
565 log_error_errno(errno, "Failed to open %s: %m", arg_crypttab);
566 return 0;
567 }
568
569 if (fstat(fileno(f), &st) < 0) {
570 log_error_errno(errno, "Failed to stat %s: %m", arg_crypttab);
571 return 0;
572 }
573
574 for (;;) {
575 _cleanup_free_ char *line = NULL, *name = NULL, *device = NULL, *keyspec = NULL, *options = NULL, *keyfile = NULL, *keydev = NULL;
576 crypto_device *d = NULL;
577 char *l, *uuid;
578 int k;
579
580 r = read_line(f, LONG_LINE_MAX, &line);
581 if (r < 0)
582 return log_error_errno(r, "Failed to read %s: %m", arg_crypttab);
583 if (r == 0)
584 break;
585
586 crypttab_line++;
587
588 l = strstrip(line);
589 if (IN_SET(l[0], 0, '#'))
590 continue;
591
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);
595 continue;
596 }
597
598 uuid = startswith(device, "UUID=");
599 if (!uuid)
600 uuid = path_startswith(device, "/dev/disk/by-uuid/");
601 if (!uuid)
602 uuid = startswith(name, "luks-");
603 if (uuid)
604 d = hashmap_get(arg_disks, uuid);
605
606 if (arg_whitelist && !d) {
607 log_info("Not creating device '%s' because it was not specified on the kernel command line.", name);
608 continue;
609 }
610
611 r = split_keyspec(keyspec, &keyfile, &keydev);
612 if (r < 0)
613 return r;
614
615 r = create_disk(name, device, keyfile, keydev, (d && d->options) ? d->options : options);
616 if (r < 0)
617 return r;
618
619 if (d)
620 d->create = false;
621 }
622
623 return 0;
624 }
625
626 static int add_proc_cmdline_devices(void) {
627 int r;
628 Iterator i;
629 crypto_device *d;
630
631 HASHMAP_FOREACH(d, arg_disks, i) {
632 _cleanup_free_ char *device = NULL;
633
634 if (!d->create)
635 continue;
636
637 if (!d->name) {
638 d->name = strjoin("luks-", d->uuid);
639 if (!d->name)
640 return log_oom();
641 }
642
643 device = strjoin("UUID=", d->uuid);
644 if (!device)
645 return log_oom();
646
647 r = create_disk(d->name,
648 device,
649 d->keyfile ?: arg_default_keyfile,
650 d->keydev,
651 d->options ?: arg_default_options);
652 if (r < 0)
653 return r;
654 }
655
656 return 0;
657 }
658
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);
661
662 static int run(const char *dest, const char *dest_early, const char *dest_late) {
663 int r;
664
665 assert_se(arg_dest = dest);
666
667 arg_crypttab = getenv("SYSTEMD_CRYPTTAB") ?: "/etc/crypttab";
668 arg_runtime_directory = getenv("RUNTIME_DIRECTORY") ?: "/run/systemd/cryptsetup";
669
670 arg_disks = hashmap_new(&crypt_device_hash_ops);
671 if (!arg_disks)
672 return log_oom();
673
674 r = proc_cmdline_parse(parse_proc_cmdline_item, NULL, PROC_CMDLINE_STRIP_RD_PREFIX);
675 if (r < 0)
676 return log_warning_errno(r, "Failed to parse kernel command line: %m");
677
678 if (!arg_enabled)
679 return 0;
680
681 r = add_crypttab_devices();
682 if (r < 0)
683 return r;
684
685 r = add_proc_cmdline_devices();
686 if (r < 0)
687 return r;
688
689 return 0;
690 }
691
692 DEFINE_MAIN_GENERATOR_FUNCTION(run);