]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/cryptsetup/cryptsetup-generator.c
Merge pull request #16080 from YmrDtnJu/9p
[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,
192 "/dev/urandom",
193 "/dev/random",
194 "/dev/hw_random",
195 "/dev/hwrng")) {
196 /* RNG device, add random dep */
197 fputs("After=systemd-random-seed.service\n", f);
198 return 0;
199 }
200
201 _cleanup_free_ char *udev_node = fstab_node_to_udev_node(device_path);
202 if (!udev_node)
203 return log_oom();
204
205 if (path_equal(udev_node, "/dev/null"))
206 return 0;
207
208 if (path_startswith(udev_node, "/dev/")) {
209 /* We are dealing with a block device, add dependency for corresponding unit */
210 _cleanup_free_ char *unit = NULL;
211
212 r = unit_name_from_path(udev_node, ".device", &unit);
213 if (r < 0)
214 return log_error_errno(r, "Failed to generate unit name: %m");
215
216 fprintf(f,
217 "After=%1$s\n"
218 "Requires=%1$s\n", unit);
219 } else {
220 /* Regular file, add mount dependency */
221 _cleanup_free_ char *escaped_path = specifier_escape(device_path);
222 if (!escaped_path)
223 return log_oom();
224
225 fprintf(f, "RequiresMountsFor=%s\n", escaped_path);
226 }
227
228 return 0;
229 }
230
231 static int create_disk(
232 const char *name,
233 const char *device,
234 const char *password,
235 const char *keydev,
236 const char *options) {
237
238 _cleanup_free_ char *n = NULL, *d = NULL, *u = NULL, *e = NULL,
239 *keydev_mount = NULL, *keyfile_timeout_value = NULL,
240 *filtered = NULL, *u_escaped = NULL, *name_escaped = NULL, *header_path = NULL, *password_buffer = NULL,
241 *tmp_fstype = NULL;
242 _cleanup_fclose_ FILE *f = NULL;
243 const char *dmname;
244 bool noauto, nofail, swap, netdev, attach_in_initrd;
245 int r, detached_header, keyfile_can_timeout, tmp;
246
247 assert(name);
248 assert(device);
249
250 noauto = fstab_test_yes_no_option(options, "noauto\0" "auto\0");
251 nofail = fstab_test_yes_no_option(options, "nofail\0" "fail\0");
252 swap = fstab_test_option(options, "swap\0");
253 netdev = fstab_test_option(options, "_netdev\0");
254 attach_in_initrd = fstab_test_option(options, "x-initrd.attach\0");
255
256 keyfile_can_timeout = fstab_filter_options(options, "keyfile-timeout\0", NULL, &keyfile_timeout_value, NULL);
257 if (keyfile_can_timeout < 0)
258 return log_error_errno(keyfile_can_timeout, "Failed to parse keyfile-timeout= option value: %m");
259
260 detached_header = fstab_filter_options(options, "header\0", NULL, &header_path, NULL);
261 if (detached_header < 0)
262 return log_error_errno(detached_header, "Failed to parse header= option value: %m");
263
264 tmp = fstab_filter_options(options, "tmp\0", NULL, &tmp_fstype, NULL);
265 if (tmp < 0)
266 return log_error_errno(tmp, "Failed to parse tmp= option value: %m");
267
268 if (tmp && swap)
269 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
270 "Device '%s' cannot be both 'tmp' and 'swap'. Ignoring.",
271 name);
272
273 name_escaped = specifier_escape(name);
274 if (!name_escaped)
275 return log_oom();
276
277 e = unit_name_escape(name);
278 if (!e)
279 return log_oom();
280
281 u = fstab_node_to_udev_node(device);
282 if (!u)
283 return log_oom();
284
285 r = unit_name_build("systemd-cryptsetup", e, ".service", &n);
286 if (r < 0)
287 return log_error_errno(r, "Failed to generate unit name: %m");
288
289 u_escaped = specifier_escape(u);
290 if (!u_escaped)
291 return log_oom();
292
293 r = unit_name_from_path(u, ".device", &d);
294 if (r < 0)
295 return log_error_errno(r, "Failed to generate unit name: %m");
296
297 if (keydev && !password)
298 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
299 "Key device is specified, but path to the password file is missing.");
300
301 r = generator_open_unit_file(arg_dest, NULL, n, &f);
302 if (r < 0)
303 return r;
304
305 r = generator_write_cryptsetup_unit_section(f, arg_crypttab);
306 if (r < 0)
307 return r;
308
309 if (netdev)
310 fprintf(f, "After=remote-fs-pre.target\n");
311
312 /* If initrd takes care of attaching the disk then it should also detach it during shutdown. */
313 if (!attach_in_initrd)
314 fprintf(f, "Conflicts=umount.target\n");
315
316 if (keydev) {
317 _cleanup_free_ char *unit = NULL;
318
319 r = generate_keydev_mount(name, keydev, keyfile_timeout_value, keyfile_can_timeout > 0, &unit, &keydev_mount);
320 if (r < 0)
321 return log_error_errno(r, "Failed to generate keydev mount unit: %m");
322
323 password_buffer = path_join(keydev_mount, password);
324 if (!password_buffer)
325 return log_oom();
326
327 password = password_buffer;
328
329 fprintf(f, "After=%s\n", unit);
330 if (keyfile_can_timeout > 0)
331 fprintf(f, "Wants=%s\n", unit);
332 else
333 fprintf(f, "Requires=%s\n", unit);
334 }
335
336 if (!nofail)
337 fprintf(f,
338 "Before=%s\n",
339 netdev ? "remote-cryptsetup.target" : "cryptsetup.target");
340
341 if (password && !keydev) {
342 r = print_dependencies(f, password);
343 if (r < 0)
344 return r;
345 }
346
347 /* Check if a header option was specified */
348 if (detached_header > 0) {
349 r = print_dependencies(f, header_path);
350 if (r < 0)
351 return r;
352 }
353
354 if (path_startswith(u, "/dev/"))
355 fprintf(f,
356 "BindsTo=%s\n"
357 "After=%s\n"
358 "Before=umount.target\n",
359 d, d);
360 else
361 /* For loopback devices, add systemd-tmpfiles-setup-dev.service
362 dependency to ensure that loopback support is available in
363 the kernel (/dev/loop-control needs to exist) */
364 fprintf(f,
365 "RequiresMountsFor=%s\n"
366 "Requires=systemd-tmpfiles-setup-dev.service\n"
367 "After=systemd-tmpfiles-setup-dev.service\n",
368 u_escaped);
369
370 r = generator_write_timeouts(arg_dest, device, name, options, &filtered);
371 if (r < 0)
372 log_warning_errno(r, "Failed to write device timeout drop-in: %m");
373
374 r = generator_write_cryptsetup_service_section(f, name, u, password, filtered);
375 if (r < 0)
376 return r;
377
378 if (tmp) {
379 _cleanup_free_ char *tmp_fstype_escaped = NULL;
380
381 if (tmp_fstype) {
382 tmp_fstype_escaped = specifier_escape(tmp_fstype);
383 if (!tmp_fstype_escaped)
384 return log_oom();
385 }
386
387 fprintf(f,
388 "ExecStartPost=" ROOTLIBEXECDIR "/systemd-makefs '%s' '/dev/mapper/%s'\n",
389 tmp_fstype_escaped ?: "ext4", name_escaped);
390 }
391
392 if (swap)
393 fprintf(f,
394 "ExecStartPost=" ROOTLIBEXECDIR "/systemd-makefs swap '/dev/mapper/%s'\n",
395 name_escaped);
396
397 if (keydev)
398 fprintf(f,
399 "ExecStartPost=-" UMOUNT_PATH " %s\n\n",
400 keydev_mount);
401
402 r = fflush_and_check(f);
403 if (r < 0)
404 return log_error_errno(r, "Failed to write unit file %s: %m", n);
405
406 if (!noauto) {
407 r = generator_add_symlink(arg_dest,
408 netdev ? "remote-cryptsetup.target" : "cryptsetup.target",
409 nofail ? "wants" : "requires", n);
410 if (r < 0)
411 return r;
412 }
413
414 dmname = strjoina("dev-mapper-", e, ".device");
415 r = generator_add_symlink(arg_dest, dmname, "requires", n);
416 if (r < 0)
417 return r;
418
419 if (!noauto && !nofail) {
420 r = write_drop_in(arg_dest, dmname, 40, "device-timeout",
421 "# Automatically generated by systemd-cryptsetup-generator\n\n"
422 "[Unit]\nJobTimeoutSec=0");
423 if (r < 0)
424 log_warning_errno(r, "Failed to write device timeout drop-in: %m");
425 }
426
427 return 0;
428 }
429
430 static crypto_device* crypt_device_free(crypto_device *d) {
431 if (!d)
432 return NULL;
433
434 free(d->uuid);
435 free(d->keyfile);
436 free(d->keydev);
437 free(d->name);
438 free(d->options);
439 return mfree(d);
440 }
441
442 static crypto_device *get_crypto_device(const char *uuid) {
443 int r;
444 crypto_device *d;
445
446 assert(uuid);
447
448 d = hashmap_get(arg_disks, uuid);
449 if (!d) {
450 d = new0(struct crypto_device, 1);
451 if (!d)
452 return NULL;
453
454 d->uuid = strdup(uuid);
455 if (!d->uuid)
456 return mfree(d);
457
458 r = hashmap_put(arg_disks, d->uuid, d);
459 if (r < 0) {
460 free(d->uuid);
461 return mfree(d);
462 }
463 }
464
465 return d;
466 }
467
468 static int parse_proc_cmdline_item(const char *key, const char *value, void *data) {
469 _cleanup_free_ char *uuid = NULL, *uuid_value = NULL;
470 crypto_device *d;
471 int r;
472
473 if (streq(key, "luks")) {
474
475 r = value ? parse_boolean(value) : 1;
476 if (r < 0)
477 log_warning("Failed to parse luks= kernel command line switch %s. Ignoring.", value);
478 else
479 arg_enabled = r;
480
481 } else if (streq(key, "luks.crypttab")) {
482
483 r = value ? parse_boolean(value) : 1;
484 if (r < 0)
485 log_warning("Failed to parse luks.crypttab= kernel command line switch %s. Ignoring.", value);
486 else
487 arg_read_crypttab = r;
488
489 } else if (streq(key, "luks.uuid")) {
490
491 if (proc_cmdline_value_missing(key, value))
492 return 0;
493
494 d = get_crypto_device(startswith(value, "luks-") ? value+5 : value);
495 if (!d)
496 return log_oom();
497
498 d->create = arg_whitelist = true;
499
500 } else if (streq(key, "luks.options")) {
501
502 if (proc_cmdline_value_missing(key, value))
503 return 0;
504
505 r = sscanf(value, "%m[0-9a-fA-F-]=%ms", &uuid, &uuid_value);
506 if (r == 2) {
507 d = get_crypto_device(uuid);
508 if (!d)
509 return log_oom();
510
511 free_and_replace(d->options, uuid_value);
512 } else if (free_and_strdup(&arg_default_options, value) < 0)
513 return log_oom();
514
515 } else if (streq(key, "luks.key")) {
516 size_t n;
517 _cleanup_free_ char *keyfile = NULL, *keydev = NULL;
518 const char *keyspec;
519
520 if (proc_cmdline_value_missing(key, value))
521 return 0;
522
523 n = strspn(value, LETTERS DIGITS "-");
524 if (value[n] != '=') {
525 if (free_and_strdup(&arg_default_keyfile, value) < 0)
526 return log_oom();
527 return 0;
528 }
529
530 uuid = strndup(value, n);
531 if (!uuid)
532 return log_oom();
533
534 if (!id128_is_valid(uuid)) {
535 log_warning("Failed to parse luks.key= kernel command line switch. UUID is invalid, ignoring.");
536 return 0;
537 }
538
539 d = get_crypto_device(uuid);
540 if (!d)
541 return log_oom();
542
543 keyspec = value + n + 1;
544 r = split_keyspec(keyspec, &keyfile, &keydev);
545 if (r < 0)
546 return r;
547
548 free_and_replace(d->keyfile, keyfile);
549 free_and_replace(d->keydev, keydev);
550
551 } else if (streq(key, "luks.name")) {
552
553 if (proc_cmdline_value_missing(key, value))
554 return 0;
555
556 r = sscanf(value, "%m[0-9a-fA-F-]=%ms", &uuid, &uuid_value);
557 if (r == 2) {
558 d = get_crypto_device(uuid);
559 if (!d)
560 return log_oom();
561
562 d->create = arg_whitelist = true;
563
564 free_and_replace(d->name, uuid_value);
565 } else
566 log_warning("Failed to parse luks name switch %s. Ignoring.", value);
567 }
568
569 return 0;
570 }
571
572 static int add_crypttab_devices(void) {
573 _cleanup_fclose_ FILE *f = NULL;
574 unsigned crypttab_line = 0;
575 struct stat st;
576 int r;
577
578 if (!arg_read_crypttab)
579 return 0;
580
581 r = fopen_unlocked(arg_crypttab, "re", &f);
582 if (r < 0) {
583 if (errno != ENOENT)
584 log_error_errno(errno, "Failed to open %s: %m", arg_crypttab);
585 return 0;
586 }
587
588 if (fstat(fileno(f), &st) < 0) {
589 log_error_errno(errno, "Failed to stat %s: %m", arg_crypttab);
590 return 0;
591 }
592
593 for (;;) {
594 _cleanup_free_ char *line = NULL, *name = NULL, *device = NULL, *keyspec = NULL, *options = NULL, *keyfile = NULL, *keydev = NULL;
595 crypto_device *d = NULL;
596 char *l, *uuid;
597 int k;
598
599 r = read_line(f, LONG_LINE_MAX, &line);
600 if (r < 0)
601 return log_error_errno(r, "Failed to read %s: %m", arg_crypttab);
602 if (r == 0)
603 break;
604
605 crypttab_line++;
606
607 l = strstrip(line);
608 if (IN_SET(l[0], 0, '#'))
609 continue;
610
611 k = sscanf(l, "%ms %ms %ms %ms", &name, &device, &keyspec, &options);
612 if (k < 2 || k > 4) {
613 log_error("Failed to parse %s:%u, ignoring.", arg_crypttab, crypttab_line);
614 continue;
615 }
616
617 uuid = startswith(device, "UUID=");
618 if (!uuid)
619 uuid = path_startswith(device, "/dev/disk/by-uuid/");
620 if (!uuid)
621 uuid = startswith(name, "luks-");
622 if (uuid)
623 d = hashmap_get(arg_disks, uuid);
624
625 if (arg_whitelist && !d) {
626 log_info("Not creating device '%s' because it was not specified on the kernel command line.", name);
627 continue;
628 }
629
630 r = split_keyspec(keyspec, &keyfile, &keydev);
631 if (r < 0)
632 return r;
633
634 r = create_disk(name, device, keyfile, keydev, (d && d->options) ? d->options : options);
635 if (r < 0)
636 return r;
637
638 if (d)
639 d->create = false;
640 }
641
642 return 0;
643 }
644
645 static int add_proc_cmdline_devices(void) {
646 int r;
647 Iterator i;
648 crypto_device *d;
649
650 HASHMAP_FOREACH(d, arg_disks, i) {
651 _cleanup_free_ char *device = NULL;
652
653 if (!d->create)
654 continue;
655
656 if (!d->name) {
657 d->name = strjoin("luks-", d->uuid);
658 if (!d->name)
659 return log_oom();
660 }
661
662 device = strjoin("UUID=", d->uuid);
663 if (!device)
664 return log_oom();
665
666 r = create_disk(d->name,
667 device,
668 d->keyfile ?: arg_default_keyfile,
669 d->keydev,
670 d->options ?: arg_default_options);
671 if (r < 0)
672 return r;
673 }
674
675 return 0;
676 }
677
678 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(crypt_device_hash_ops, char, string_hash_func, string_compare_func,
679 crypto_device, crypt_device_free);
680
681 static int run(const char *dest, const char *dest_early, const char *dest_late) {
682 int r;
683
684 assert_se(arg_dest = dest);
685
686 arg_crypttab = getenv("SYSTEMD_CRYPTTAB") ?: "/etc/crypttab";
687 arg_runtime_directory = getenv("RUNTIME_DIRECTORY") ?: "/run/systemd/cryptsetup";
688
689 arg_disks = hashmap_new(&crypt_device_hash_ops);
690 if (!arg_disks)
691 return log_oom();
692
693 r = proc_cmdline_parse(parse_proc_cmdline_item, NULL, PROC_CMDLINE_STRIP_RD_PREFIX);
694 if (r < 0)
695 return log_warning_errno(r, "Failed to parse kernel command line: %m");
696
697 if (!arg_enabled)
698 return 0;
699
700 r = add_crypttab_devices();
701 if (r < 0)
702 return r;
703
704 r = add_proc_cmdline_devices();
705 if (r < 0)
706 return r;
707
708 return 0;
709 }
710
711 DEFINE_MAIN_GENERATOR_FUNCTION(run);