]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/cryptsetup/cryptsetup.c
Implement VeraCrypt volume handling in crypttab (#4501)
[thirdparty/systemd.git] / src / cryptsetup / cryptsetup.c
1 /***
2 This file is part of systemd.
3
4 Copyright 2010 Lennart Poettering
5
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <errno.h>
21 #include <libcryptsetup.h>
22 #include <mntent.h>
23 #include <string.h>
24 #include <sys/mman.h>
25
26 #include "sd-device.h"
27
28 #include "alloc-util.h"
29 #include "ask-password-api.h"
30 #include "device-util.h"
31 #include "escape.h"
32 #include "fileio.h"
33 #include "log.h"
34 #include "mount-util.h"
35 #include "parse-util.h"
36 #include "path-util.h"
37 #include "string-util.h"
38 #include "strv.h"
39 #include "util.h"
40
41 static const char *arg_type = NULL; /* CRYPT_LUKS1, CRYPT_TCRYPT or CRYPT_PLAIN */
42 static char *arg_cipher = NULL;
43 static unsigned arg_key_size = 0;
44 static int arg_key_slot = CRYPT_ANY_SLOT;
45 static unsigned arg_keyfile_size = 0;
46 static unsigned arg_keyfile_offset = 0;
47 static char *arg_hash = NULL;
48 static char *arg_header = NULL;
49 static unsigned arg_tries = 3;
50 static bool arg_readonly = false;
51 static bool arg_verify = false;
52 static bool arg_discards = false;
53 static bool arg_tcrypt_hidden = false;
54 static bool arg_tcrypt_system = false;
55 static bool arg_tcrypt_veracrypt = false;
56 static char **arg_tcrypt_keyfiles = NULL;
57 static uint64_t arg_offset = 0;
58 static uint64_t arg_skip = 0;
59 static usec_t arg_timeout = 0;
60
61 /* Options Debian's crypttab knows we don't:
62
63 precheck=
64 check=
65 checkargs=
66 noearly=
67 loud=
68 keyscript=
69 */
70
71 static int parse_one_option(const char *option) {
72 assert(option);
73
74 /* Handled outside of this tool */
75 if (STR_IN_SET(option, "noauto", "auto", "nofail", "fail"))
76 return 0;
77
78 if (startswith(option, "cipher=")) {
79 char *t;
80
81 t = strdup(option+7);
82 if (!t)
83 return log_oom();
84
85 free(arg_cipher);
86 arg_cipher = t;
87
88 } else if (startswith(option, "size=")) {
89
90 if (safe_atou(option+5, &arg_key_size) < 0) {
91 log_error("size= parse failure, ignoring.");
92 return 0;
93 }
94
95 if (arg_key_size % 8) {
96 log_error("size= not a multiple of 8, ignoring.");
97 return 0;
98 }
99
100 arg_key_size /= 8;
101
102 } else if (startswith(option, "key-slot=")) {
103
104 arg_type = CRYPT_LUKS1;
105 if (safe_atoi(option+9, &arg_key_slot) < 0) {
106 log_error("key-slot= parse failure, ignoring.");
107 return 0;
108 }
109
110 } else if (startswith(option, "tcrypt-keyfile=")) {
111
112 arg_type = CRYPT_TCRYPT;
113 if (path_is_absolute(option+15)) {
114 if (strv_extend(&arg_tcrypt_keyfiles, option + 15) < 0)
115 return log_oom();
116 } else
117 log_error("Key file path '%s' is not absolute. Ignoring.", option+15);
118
119 } else if (startswith(option, "keyfile-size=")) {
120
121 if (safe_atou(option+13, &arg_keyfile_size) < 0) {
122 log_error("keyfile-size= parse failure, ignoring.");
123 return 0;
124 }
125
126 } else if (startswith(option, "keyfile-offset=")) {
127
128 if (safe_atou(option+15, &arg_keyfile_offset) < 0) {
129 log_error("keyfile-offset= parse failure, ignoring.");
130 return 0;
131 }
132
133 } else if (startswith(option, "hash=")) {
134 char *t;
135
136 t = strdup(option+5);
137 if (!t)
138 return log_oom();
139
140 free(arg_hash);
141 arg_hash = t;
142
143 } else if (startswith(option, "header=")) {
144 arg_type = CRYPT_LUKS1;
145
146 if (!path_is_absolute(option+7)) {
147 log_error("Header path '%s' is not absolute, refusing.", option+7);
148 return -EINVAL;
149 }
150
151 if (arg_header) {
152 log_error("Duplicate header= options, refusing.");
153 return -EINVAL;
154 }
155
156 arg_header = strdup(option+7);
157 if (!arg_header)
158 return log_oom();
159
160 } else if (startswith(option, "tries=")) {
161
162 if (safe_atou(option+6, &arg_tries) < 0) {
163 log_error("tries= parse failure, ignoring.");
164 return 0;
165 }
166
167 } else if (STR_IN_SET(option, "readonly", "read-only"))
168 arg_readonly = true;
169 else if (streq(option, "verify"))
170 arg_verify = true;
171 else if (STR_IN_SET(option, "allow-discards", "discard"))
172 arg_discards = true;
173 else if (streq(option, "luks"))
174 arg_type = CRYPT_LUKS1;
175 else if (streq(option, "tcrypt"))
176 arg_type = CRYPT_TCRYPT;
177 else if (streq(option, "tcrypt-hidden")) {
178 arg_type = CRYPT_TCRYPT;
179 arg_tcrypt_hidden = true;
180 } else if (streq(option, "tcrypt-system")) {
181 arg_type = CRYPT_TCRYPT;
182 arg_tcrypt_system = true;
183 } else if (streq(option, "tcrypt-veracrypt")) {
184 #ifdef CRYPT_TCRYPT_VERA_MODES
185 arg_type = CRYPT_TCRYPT;
186 arg_tcrypt_veracrypt = true;
187 #else
188 log_error("This version of cryptsetup does not support tcrypt-veracrypt; refusing.");
189 return -EINVAL;
190 #endif
191 } else if (STR_IN_SET(option, "plain", "swap", "tmp"))
192 arg_type = CRYPT_PLAIN;
193 else if (startswith(option, "timeout=")) {
194
195 if (parse_sec(option+8, &arg_timeout) < 0) {
196 log_error("timeout= parse failure, ignoring.");
197 return 0;
198 }
199
200 } else if (startswith(option, "offset=")) {
201
202 if (safe_atou64(option+7, &arg_offset) < 0) {
203 log_error("offset= parse failure, refusing.");
204 return -EINVAL;
205 }
206
207 } else if (startswith(option, "skip=")) {
208
209 if (safe_atou64(option+5, &arg_skip) < 0) {
210 log_error("skip= parse failure, refusing.");
211 return -EINVAL;
212 }
213
214 } else if (!streq(option, "none"))
215 log_error("Encountered unknown /etc/crypttab option '%s', ignoring.", option);
216
217 return 0;
218 }
219
220 static int parse_options(const char *options) {
221 const char *word, *state;
222 size_t l;
223 int r;
224
225 assert(options);
226
227 FOREACH_WORD_SEPARATOR(word, l, options, ",", state) {
228 _cleanup_free_ char *o;
229
230 o = strndup(word, l);
231 if (!o)
232 return -ENOMEM;
233 r = parse_one_option(o);
234 if (r < 0)
235 return r;
236 }
237
238 /* sanity-check options */
239 if (arg_type != NULL && !streq(arg_type, CRYPT_PLAIN)) {
240 if (arg_offset)
241 log_warning("offset= ignored with type %s", arg_type);
242 if (arg_skip)
243 log_warning("skip= ignored with type %s", arg_type);
244 }
245
246 return 0;
247 }
248
249 static void log_glue(int level, const char *msg, void *usrptr) {
250 log_debug("%s", msg);
251 }
252
253 static int disk_major_minor(const char *path, char **ret) {
254 struct stat st;
255
256 assert(path);
257
258 if (stat(path, &st) < 0)
259 return -errno;
260
261 if (!S_ISBLK(st.st_mode))
262 return -EINVAL;
263
264 if (asprintf(ret, "/dev/block/%d:%d", major(st.st_rdev), minor(st.st_rdev)) < 0)
265 return -errno;
266
267 return 0;
268 }
269
270 static char* disk_description(const char *path) {
271
272 static const char name_fields[] =
273 "ID_PART_ENTRY_NAME\0"
274 "DM_NAME\0"
275 "ID_MODEL_FROM_DATABASE\0"
276 "ID_MODEL\0";
277
278 _cleanup_(sd_device_unrefp) sd_device *device = NULL;
279 struct stat st;
280 const char *i;
281 int r;
282
283 assert(path);
284
285 if (stat(path, &st) < 0)
286 return NULL;
287
288 if (!S_ISBLK(st.st_mode))
289 return NULL;
290
291 r = sd_device_new_from_devnum(&device, 'b', st.st_rdev);
292 if (r < 0)
293 return NULL;
294
295 NULSTR_FOREACH(i, name_fields) {
296 const char *name;
297
298 r = sd_device_get_property_value(device, i, &name);
299 if (r >= 0 && !isempty(name))
300 return strdup(name);
301 }
302
303 return NULL;
304 }
305
306 static char *disk_mount_point(const char *label) {
307 _cleanup_free_ char *device = NULL;
308 _cleanup_endmntent_ FILE *f = NULL;
309 struct mntent *m;
310
311 /* Yeah, we don't support native systemd unit files here for now */
312
313 if (asprintf(&device, "/dev/mapper/%s", label) < 0)
314 return NULL;
315
316 f = setmntent("/etc/fstab", "r");
317 if (!f)
318 return NULL;
319
320 while ((m = getmntent(f)))
321 if (path_equal(m->mnt_fsname, device))
322 return strdup(m->mnt_dir);
323
324 return NULL;
325 }
326
327 static int get_password(const char *vol, const char *src, usec_t until, bool accept_cached, char ***ret) {
328 _cleanup_free_ char *description = NULL, *name_buffer = NULL, *mount_point = NULL, *maj_min = NULL, *text = NULL, *escaped_name = NULL;
329 _cleanup_strv_free_erase_ char **passwords = NULL;
330 const char *name = NULL;
331 char **p, *id;
332 int r = 0;
333
334 assert(vol);
335 assert(src);
336 assert(ret);
337
338 description = disk_description(src);
339 mount_point = disk_mount_point(vol);
340
341 if (description && streq(vol, description))
342 /* If the description string is simply the
343 * volume name, then let's not show this
344 * twice */
345 description = mfree(description);
346
347 if (mount_point && description)
348 r = asprintf(&name_buffer, "%s (%s) on %s", description, vol, mount_point);
349 else if (mount_point)
350 r = asprintf(&name_buffer, "%s on %s", vol, mount_point);
351 else if (description)
352 r = asprintf(&name_buffer, "%s (%s)", description, vol);
353
354 if (r < 0)
355 return log_oom();
356
357 name = name_buffer ? name_buffer : vol;
358
359 if (asprintf(&text, "Please enter passphrase for disk %s!", name) < 0)
360 return log_oom();
361
362 if (src)
363 (void) disk_major_minor(src, &maj_min);
364
365 if (maj_min) {
366 escaped_name = maj_min;
367 maj_min = NULL;
368 } else
369 escaped_name = cescape(name);
370
371 if (!escaped_name)
372 return log_oom();
373
374 id = strjoina("cryptsetup:", escaped_name);
375
376 r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", until,
377 ASK_PASSWORD_PUSH_CACHE | (accept_cached*ASK_PASSWORD_ACCEPT_CACHED),
378 &passwords);
379 if (r < 0)
380 return log_error_errno(r, "Failed to query password: %m");
381
382 if (arg_verify) {
383 _cleanup_strv_free_erase_ char **passwords2 = NULL;
384
385 assert(strv_length(passwords) == 1);
386
387 if (asprintf(&text, "Please enter passphrase for disk %s! (verification)", name) < 0)
388 return log_oom();
389
390 id = strjoina("cryptsetup-verification:", escaped_name);
391
392 r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", until, ASK_PASSWORD_PUSH_CACHE, &passwords2);
393 if (r < 0)
394 return log_error_errno(r, "Failed to query verification password: %m");
395
396 assert(strv_length(passwords2) == 1);
397
398 if (!streq(passwords[0], passwords2[0])) {
399 log_warning("Passwords did not match, retrying.");
400 return -EAGAIN;
401 }
402 }
403
404 strv_uniq(passwords);
405
406 STRV_FOREACH(p, passwords) {
407 char *c;
408
409 if (strlen(*p)+1 >= arg_key_size)
410 continue;
411
412 /* Pad password if necessary */
413 c = new(char, arg_key_size);
414 if (!c)
415 return log_oom();
416
417 strncpy(c, *p, arg_key_size);
418 free(*p);
419 *p = c;
420 }
421
422 *ret = passwords;
423 passwords = NULL;
424
425 return 0;
426 }
427
428 static int attach_tcrypt(
429 struct crypt_device *cd,
430 const char *name,
431 const char *key_file,
432 char **passwords,
433 uint32_t flags) {
434
435 int r = 0;
436 _cleanup_free_ char *passphrase = NULL;
437 struct crypt_params_tcrypt params = {
438 .flags = CRYPT_TCRYPT_LEGACY_MODES,
439 .keyfiles = (const char **)arg_tcrypt_keyfiles,
440 .keyfiles_count = strv_length(arg_tcrypt_keyfiles)
441 };
442
443 assert(cd);
444 assert(name);
445 assert(key_file || (passwords && passwords[0]));
446
447 if (arg_tcrypt_hidden)
448 params.flags |= CRYPT_TCRYPT_HIDDEN_HEADER;
449
450 if (arg_tcrypt_system)
451 params.flags |= CRYPT_TCRYPT_SYSTEM_HEADER;
452
453 #ifdef CRYPT_TCRYPT_VERA_MODES
454 if (arg_tcrypt_veracrypt)
455 params.flags |= CRYPT_TCRYPT_VERA_MODES;
456 #endif
457
458 if (key_file) {
459 r = read_one_line_file(key_file, &passphrase);
460 if (r < 0) {
461 log_error_errno(r, "Failed to read password file '%s': %m", key_file);
462 return -EAGAIN;
463 }
464
465 params.passphrase = passphrase;
466 } else
467 params.passphrase = passwords[0];
468 params.passphrase_size = strlen(params.passphrase);
469
470 r = crypt_load(cd, CRYPT_TCRYPT, &params);
471 if (r < 0) {
472 if (key_file && r == -EPERM) {
473 log_error("Failed to activate using password file '%s'.", key_file);
474 return -EAGAIN;
475 }
476 return r;
477 }
478
479 return crypt_activate_by_volume_key(cd, name, NULL, 0, flags);
480 }
481
482 static int attach_luks_or_plain(struct crypt_device *cd,
483 const char *name,
484 const char *key_file,
485 const char *data_device,
486 char **passwords,
487 uint32_t flags) {
488 int r = 0;
489 bool pass_volume_key = false;
490
491 assert(cd);
492 assert(name);
493 assert(key_file || passwords);
494
495 if (!arg_type || streq(arg_type, CRYPT_LUKS1)) {
496 r = crypt_load(cd, CRYPT_LUKS1, NULL);
497 if (r < 0) {
498 log_error("crypt_load() failed on device %s.\n", crypt_get_device_name(cd));
499 return r;
500 }
501
502 if (data_device)
503 r = crypt_set_data_device(cd, data_device);
504 }
505
506 if ((!arg_type && r < 0) || streq_ptr(arg_type, CRYPT_PLAIN)) {
507 struct crypt_params_plain params = {
508 .offset = arg_offset,
509 .skip = arg_skip,
510 };
511 const char *cipher, *cipher_mode;
512 _cleanup_free_ char *truncated_cipher = NULL;
513
514 if (arg_hash) {
515 /* plain isn't a real hash type. it just means "use no hash" */
516 if (!streq(arg_hash, "plain"))
517 params.hash = arg_hash;
518 } else if (!key_file)
519 /* for CRYPT_PLAIN, the behaviour of cryptsetup
520 * package is to not hash when a key file is provided */
521 params.hash = "ripemd160";
522
523 if (arg_cipher) {
524 size_t l;
525
526 l = strcspn(arg_cipher, "-");
527 truncated_cipher = strndup(arg_cipher, l);
528 if (!truncated_cipher)
529 return log_oom();
530
531 cipher = truncated_cipher;
532 cipher_mode = arg_cipher[l] ? arg_cipher+l+1 : "plain";
533 } else {
534 cipher = "aes";
535 cipher_mode = "cbc-essiv:sha256";
536 }
537
538 /* for CRYPT_PLAIN limit reads
539 * from keyfile to key length, and
540 * ignore keyfile-size */
541 arg_keyfile_size = arg_key_size;
542
543 /* In contrast to what the name
544 * crypt_setup() might suggest this
545 * doesn't actually format anything,
546 * it just configures encryption
547 * parameters when used for plain
548 * mode. */
549 r = crypt_format(cd, CRYPT_PLAIN, cipher, cipher_mode, NULL, NULL, arg_keyfile_size, &params);
550
551 /* hash == NULL implies the user passed "plain" */
552 pass_volume_key = (params.hash == NULL);
553 }
554
555 if (r < 0)
556 return log_error_errno(r, "Loading of cryptographic parameters failed: %m");
557
558 log_info("Set cipher %s, mode %s, key size %i bits for device %s.",
559 crypt_get_cipher(cd),
560 crypt_get_cipher_mode(cd),
561 crypt_get_volume_key_size(cd)*8,
562 crypt_get_device_name(cd));
563
564 if (key_file) {
565 r = crypt_activate_by_keyfile_offset(cd, name, arg_key_slot, key_file, arg_keyfile_size, arg_keyfile_offset, flags);
566 if (r < 0) {
567 log_error_errno(r, "Failed to activate with key file '%s': %m", key_file);
568 return -EAGAIN;
569 }
570 } else {
571 char **p;
572
573 STRV_FOREACH(p, passwords) {
574 if (pass_volume_key)
575 r = crypt_activate_by_volume_key(cd, name, *p, arg_key_size, flags);
576 else
577 r = crypt_activate_by_passphrase(cd, name, arg_key_slot, *p, strlen(*p), flags);
578
579 if (r >= 0)
580 break;
581 }
582 }
583
584 return r;
585 }
586
587 static int help(void) {
588
589 printf("%s attach VOLUME SOURCEDEVICE [PASSWORD] [OPTIONS]\n"
590 "%s detach VOLUME\n\n"
591 "Attaches or detaches an encrypted block device.\n",
592 program_invocation_short_name,
593 program_invocation_short_name);
594
595 return 0;
596 }
597
598 int main(int argc, char *argv[]) {
599 int r = EXIT_FAILURE;
600 struct crypt_device *cd = NULL;
601
602 if (argc <= 1) {
603 help();
604 return EXIT_SUCCESS;
605 }
606
607 if (argc < 3) {
608 log_error("This program requires at least two arguments.");
609 return EXIT_FAILURE;
610 }
611
612 log_set_target(LOG_TARGET_AUTO);
613 log_parse_environment();
614 log_open();
615
616 umask(0022);
617
618 if (streq(argv[1], "attach")) {
619 uint32_t flags = 0;
620 int k;
621 unsigned tries;
622 usec_t until;
623 crypt_status_info status;
624 const char *key_file = NULL;
625
626 /* Arguments: systemd-cryptsetup attach VOLUME SOURCE-DEVICE [PASSWORD] [OPTIONS] */
627
628 if (argc < 4) {
629 log_error("attach requires at least two arguments.");
630 goto finish;
631 }
632
633 if (argc >= 5 &&
634 argv[4][0] &&
635 !streq(argv[4], "-") &&
636 !streq(argv[4], "none")) {
637
638 if (!path_is_absolute(argv[4]))
639 log_error("Password file path '%s' is not absolute. Ignoring.", argv[4]);
640 else
641 key_file = argv[4];
642 }
643
644 if (argc >= 6 && argv[5][0] && !streq(argv[5], "-")) {
645 if (parse_options(argv[5]) < 0)
646 goto finish;
647 }
648
649 /* A delicious drop of snake oil */
650 mlockall(MCL_FUTURE);
651
652 if (arg_header) {
653 log_debug("LUKS header: %s", arg_header);
654 k = crypt_init(&cd, arg_header);
655 } else
656 k = crypt_init(&cd, argv[3]);
657 if (k) {
658 log_error_errno(k, "crypt_init() failed: %m");
659 goto finish;
660 }
661
662 crypt_set_log_callback(cd, log_glue, NULL);
663
664 status = crypt_status(cd, argv[2]);
665 if (status == CRYPT_ACTIVE || status == CRYPT_BUSY) {
666 log_info("Volume %s already active.", argv[2]);
667 r = EXIT_SUCCESS;
668 goto finish;
669 }
670
671 if (arg_readonly)
672 flags |= CRYPT_ACTIVATE_READONLY;
673
674 if (arg_discards)
675 flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS;
676
677 if (arg_timeout > 0)
678 until = now(CLOCK_MONOTONIC) + arg_timeout;
679 else
680 until = 0;
681
682 arg_key_size = (arg_key_size > 0 ? arg_key_size : (256 / 8));
683
684 if (key_file) {
685 struct stat st;
686
687 /* Ideally we'd do this on the open fd, but since this is just a
688 * warning it's OK to do this in two steps. */
689 if (stat(key_file, &st) >= 0 && S_ISREG(st.st_mode) && (st.st_mode & 0005))
690 log_warning("Key file %s is world-readable. This is not a good idea!", key_file);
691 }
692
693 for (tries = 0; arg_tries == 0 || tries < arg_tries; tries++) {
694 _cleanup_strv_free_erase_ char **passwords = NULL;
695
696 if (!key_file) {
697 k = get_password(argv[2], argv[3], until, tries == 0 && !arg_verify, &passwords);
698 if (k == -EAGAIN)
699 continue;
700 else if (k < 0)
701 goto finish;
702 }
703
704 if (streq_ptr(arg_type, CRYPT_TCRYPT))
705 k = attach_tcrypt(cd, argv[2], key_file, passwords, flags);
706 else
707 k = attach_luks_or_plain(cd,
708 argv[2],
709 key_file,
710 arg_header ? argv[3] : NULL,
711 passwords,
712 flags);
713 if (k >= 0)
714 break;
715 else if (k == -EAGAIN) {
716 key_file = NULL;
717 continue;
718 } else if (k != -EPERM) {
719 log_error_errno(k, "Failed to activate: %m");
720 goto finish;
721 }
722
723 log_warning("Invalid passphrase.");
724 }
725
726 if (arg_tries != 0 && tries >= arg_tries) {
727 log_error("Too many attempts; giving up.");
728 r = EXIT_FAILURE;
729 goto finish;
730 }
731
732 } else if (streq(argv[1], "detach")) {
733 int k;
734
735 k = crypt_init_by_name(&cd, argv[2]);
736 if (k == -ENODEV) {
737 log_info("Volume %s already inactive.", argv[2]);
738 r = EXIT_SUCCESS;
739 goto finish;
740 } else if (k) {
741 log_error_errno(k, "crypt_init_by_name() failed: %m");
742 goto finish;
743 }
744
745 crypt_set_log_callback(cd, log_glue, NULL);
746
747 k = crypt_deactivate(cd, argv[2]);
748 if (k < 0) {
749 log_error_errno(k, "Failed to deactivate: %m");
750 goto finish;
751 }
752
753 } else {
754 log_error("Unknown verb %s.", argv[1]);
755 goto finish;
756 }
757
758 r = EXIT_SUCCESS;
759
760 finish:
761
762 if (cd)
763 crypt_free(cd);
764
765 free(arg_cipher);
766 free(arg_hash);
767 free(arg_header);
768 strv_free(arg_tcrypt_keyfiles);
769
770 return r;
771 }