]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/cryptsetup/cryptsetup.c
projects / thirdparty / systemd.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
table: drop last SIZE_MAX from table_set_sort() and table_set_display()
[thirdparty/systemd.git] / src / cryptsetup / cryptsetup.c
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
e23a0ce8 2
7f4e0805 3#include <errno.h>
07630cea 4#include <mntent.h>
07630cea 5#include <sys/mman.h>
ca78ad1d
ZJS		 6#include <sys/stat.h>
7#include <sys/types.h>
8#include <unistd.h>
e23a0ce8 9
4f5dd394
LP		 10#include "sd-device.h"
11
b5efdb8a 12#include "alloc-util.h"
4f5dd394 13#include "ask-password-api.h"
2bc5c425 14#include "cryptsetup-fido2.h"
1e2f3230 15#include "cryptsetup-keyfile.h"
08669709 16#include "cryptsetup-pkcs11.h"
18843ecc 17#include "cryptsetup-tpm2.h"
7407f689 18#include "cryptsetup-util.h"
4f5dd394
LP		 19#include "device-util.h"
20#include "escape.h"
8cf3ca80 21#include "fileio.h"
d3d49e76 22#include "fs-util.h"
ed4ad488 23#include "fstab-util.h"
08669709 24#include "hexdecoct.h"
2bc5c425 25#include "libfido2-util.h"
e23a0ce8 26#include "log.h"
3a40f366 27#include "main-func.h"
7407f689 28#include "memory-util.h"
4349cd7c 29#include "mount-util.h"
d8b4d14d 30#include "nulstr-util.h"
6bedfcbb 31#include "parse-util.h"
9eb977db 32#include "path-util.h"
08669709 33#include "pkcs11-util.h"
d8b4d14d 34#include "pretty-print.h"
e2c2f868 35#include "random-util.h"
07630cea 36#include "string-util.h"
21bc923a 37#include "strv.h"
18843ecc 38#include "tpm2-util.h"
7f4e0805 39
b3b4ebab
OK		 40/* internal helper */
41#define ANY_LUKS "LUKS"
a9fc6406
DJL		 42/* as in src/cryptsetup.h */
43#define CRYPT_SECTOR_SIZE 512
44#define CRYPT_MAX_SECTOR_SIZE 4096
b3b4ebab 45
6cc27c29 46static const char *arg_type = NULL; /* ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2, CRYPT_TCRYPT, CRYPT_BITLK or CRYPT_PLAIN */
f75cac37
LP		 47static char *arg_cipher = NULL;
48static unsigned arg_key_size = 0;
a9fc6406 49static unsigned arg_sector_size = CRYPT_SECTOR_SIZE;
f75cac37
LP		 50static int arg_key_slot = CRYPT_ANY_SLOT;
51static unsigned arg_keyfile_size = 0;
dc0a3555 52static uint64_t arg_keyfile_offset = 0;
d3d49e76 53static bool arg_keyfile_erase = false;
0ba6f85e 54static bool arg_try_empty_password = false;
f75cac37 55static char *arg_hash = NULL;
7376e835 56static char *arg_header = NULL;
f75cac37
LP		 57static unsigned arg_tries = 3;
58static bool arg_readonly = false;
59static bool arg_verify = false;
60static bool arg_discards = false;
2c65512e
YW		 61static bool arg_same_cpu_crypt = false;
62static bool arg_submit_from_crypt_cpus = false;
227acf00
JU		 63static bool arg_no_read_workqueue = false;
64static bool arg_no_write_workqueue = false;
f75cac37
LP		 65static bool arg_tcrypt_hidden = false;
66static bool arg_tcrypt_system = false;
52028838 67static bool arg_tcrypt_veracrypt = false;
f75cac37 68static char **arg_tcrypt_keyfiles = NULL;
4eac2773
MP		 69static uint64_t arg_offset = 0;
70static uint64_t arg_skip = 0;
0864d311 71static usec_t arg_timeout = USEC_INFINITY;
08669709 72static char *arg_pkcs11_uri = NULL;
b997d111 73static bool arg_pkcs11_uri_auto = false;
2bc5c425
LP		 74static char *arg_fido2_device = NULL;
75static bool arg_fido2_device_auto = false;
76static void *arg_fido2_cid = NULL;
77static size_t arg_fido2_cid_size = 0;
78static char *arg_fido2_rp_id = NULL;
18843ecc
LP		 79static char *arg_tpm2_device = NULL;
80static bool arg_tpm2_device_auto = false;
81static uint32_t arg_tpm2_pcr_mask = UINT32_MAX;
7f4e0805 82
3a40f366
YW		 83STATIC_DESTRUCTOR_REGISTER(arg_cipher, freep);
84STATIC_DESTRUCTOR_REGISTER(arg_hash, freep);
85STATIC_DESTRUCTOR_REGISTER(arg_header, freep);
86STATIC_DESTRUCTOR_REGISTER(arg_tcrypt_keyfiles, strv_freep);
08669709 87STATIC_DESTRUCTOR_REGISTER(arg_pkcs11_uri, freep);
2bc5c425
LP		 88STATIC_DESTRUCTOR_REGISTER(arg_fido2_device, freep);
89STATIC_DESTRUCTOR_REGISTER(arg_fido2_cid, freep);
90STATIC_DESTRUCTOR_REGISTER(arg_fido2_rp_id, freep);
18843ecc 91STATIC_DESTRUCTOR_REGISTER(arg_tpm2_device, freep);
3a40f366 92
1fc76335
LP		 93/* Options Debian's crypttab knows we don't:
94
1fc76335
LP		 95 check=
96 checkargs=
8ced40c0
LP		 97 noearly
98 loud
99 quiet
1fc76335 100 keyscript=
8ced40c0 101 initramfs
1fc76335
LP		 102*/
103
7f4e0805 104static int parse_one_option(const char *option) {
fb4650aa
ZJS		 105 const char *val;
106 int r;
107
7f4e0805
LP		 108 assert(option);
109
110 /* Handled outside of this tool */
50d2eba2 111 if (STR_IN_SET(option, "noauto", "auto", "nofail", "fail", "_netdev", "keyfile-timeout"))
112 return 0;
113
114 if (startswith(option, "keyfile-timeout="))
7f4e0805
LP		 115 return 0;
116
fb4650aa
ZJS		 117 if ((val = startswith(option, "cipher="))) {
118 r = free_and_strdup(&arg_cipher, val);
119 if (r < 0)
4b93637f 120 return log_oom();
7f4e0805 121
fb4650aa 122 } else if ((val = startswith(option, "size="))) {
7f4e0805 123
fb4650aa
ZJS		 124 r = safe_atou(val, &arg_key_size);
125 if (r < 0) {
126 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
7f4e0805
LP		 127 return 0;
128 }
129
6131a78b
DH		 130 if (arg_key_size % 8) {
131 log_error("size= not a multiple of 8, ignoring.");
132 return 0;
133 }
134
135 arg_key_size /= 8;
136
a9fc6406
DJL		 137 } else if ((val = startswith(option, "sector-size="))) {
138
a9fc6406
DJL		 139 r = safe_atou(val, &arg_sector_size);
140 if (r < 0) {
141 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
142 return 0;
143 }
144
145 if (arg_sector_size % 2) {
146 log_error("sector-size= not a multiple of 2, ignoring.");
147 return 0;
148 }
149
150 if (arg_sector_size < CRYPT_SECTOR_SIZE || arg_sector_size > CRYPT_MAX_SECTOR_SIZE) {
151 log_error("sector-size= is outside of %u and %u, ignoring.", CRYPT_SECTOR_SIZE, CRYPT_MAX_SECTOR_SIZE);
152 return 0;
153 }
a9fc6406 154
8ced40c0
LP		 155 } else if ((val = startswith(option, "key-slot=")) ||
156 (val = startswith(option, "keyslot="))) {
b4a11878 157
b3b4ebab 158 arg_type = ANY_LUKS;
fb4650aa
ZJS		 159 r = safe_atoi(val, &arg_key_slot);
160 if (r < 0) {
161 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
b4a11878
CS		 162 return 0;
163 }
164
fb4650aa 165 } else if ((val = startswith(option, "tcrypt-keyfile="))) {
8cf3ca80 166
f75cac37 167 arg_type = CRYPT_TCRYPT;
fb4650aa
ZJS		 168 if (path_is_absolute(val)) {
169 if (strv_extend(&arg_tcrypt_keyfiles, val) < 0)
4b93637f
LP		 170 return log_oom();
171 } else
fb4650aa 172 log_error("Key file path \"%s\" is not absolute. Ignoring.", val);
8cf3ca80 173
fb4650aa 174 } else if ((val = startswith(option, "keyfile-size="))) {
4271d823 175
fb4650aa
ZJS		 176 r = safe_atou(val, &arg_keyfile_size);
177 if (r < 0) {
178 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
4271d823
TG		 179 return 0;
180 }
181
fb4650aa 182 } else if ((val = startswith(option, "keyfile-offset="))) {
880a599e 183
d90874b4 184 r = safe_atou64(val, &arg_keyfile_offset);
fb4650aa
ZJS		 185 if (r < 0) {
186 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
880a599e
TG		 187 return 0;
188 }
189
d3d49e76
LP		 190 } else if ((val = startswith(option, "keyfile-erase="))) {
191
192 r = parse_boolean(val);
193 if (r < 0) {
194 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
195 return 0;
196 }
197
198 arg_keyfile_erase = r;
199
200 } else if (streq(option, "keyfile-erase"))
201 arg_keyfile_erase = true;
202
203 else if ((val = startswith(option, "hash="))) {
fb4650aa
ZJS		 204 r = free_and_strdup(&arg_hash, val);
205 if (r < 0)
4b93637f 206 return log_oom();
7f4e0805 207
fb4650aa 208 } else if ((val = startswith(option, "header="))) {
b3b4ebab 209 arg_type = ANY_LUKS;
7376e835 210
baaa35ad
ZJS		 211 if (!path_is_absolute(val))
212 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
213 "Header path \"%s\" is not absolute, refusing.", val);
7376e835 214
baaa35ad
ZJS		 215 if (arg_header)
216 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
217 "Duplicate header= option, refusing.");
7376e835 218
fb4650aa 219 arg_header = strdup(val);
7376e835
AC		 220 if (!arg_header)
221 return log_oom();
222
fb4650aa 223 } else if ((val = startswith(option, "tries="))) {
7f4e0805 224
fb4650aa
ZJS		 225 r = safe_atou(val, &arg_tries);
226 if (r < 0) {
227 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
7f4e0805
LP		 228 return 0;
229 }
230
f75cac37
LP		 231 } else if (STR_IN_SET(option, "readonly", "read-only"))
232 arg_readonly = true;
7f4e0805 233 else if (streq(option, "verify"))
f75cac37
LP		 234 arg_verify = true;
235 else if (STR_IN_SET(option, "allow-discards", "discard"))
236 arg_discards = true;
2c65512e
YW		 237 else if (streq(option, "same-cpu-crypt"))
238 arg_same_cpu_crypt = true;
239 else if (streq(option, "submit-from-crypt-cpus"))
240 arg_submit_from_crypt_cpus = true;
227acf00
JU		 241 else if (streq(option, "no-read-workqueue"))
242 arg_no_read_workqueue = true;
243 else if (streq(option, "no-write-workqueue"))
244 arg_no_write_workqueue = true;
260ab287 245 else if (streq(option, "luks"))
b3b4ebab 246 arg_type = ANY_LUKS;
6cc27c29
MF		 247/* since cryptsetup 2.3.0 (Feb 2020) */
248#ifdef CRYPT_BITLK
249 else if (streq(option, "bitlk"))
250 arg_type = CRYPT_BITLK;
251#endif
8cf3ca80 252 else if (streq(option, "tcrypt"))
f75cac37 253 arg_type = CRYPT_TCRYPT;
8ced40c0 254 else if (STR_IN_SET(option, "tcrypt-hidden", "tcrypthidden")) {
f75cac37
LP		 255 arg_type = CRYPT_TCRYPT;
256 arg_tcrypt_hidden = true;
8cf3ca80 257 } else if (streq(option, "tcrypt-system")) {
f75cac37
LP		 258 arg_type = CRYPT_TCRYPT;
259 arg_tcrypt_system = true;
8ced40c0 260 } else if (STR_IN_SET(option, "tcrypt-veracrypt", "veracrypt")) {
52028838
GH		 261 arg_type = CRYPT_TCRYPT;
262 arg_tcrypt_veracrypt = true;
53ac130b
LP		 263 } else if (STR_IN_SET(option, "plain", "swap", "tmp") ||
264 startswith(option, "tmp="))
f75cac37 265 arg_type = CRYPT_PLAIN;
fb4650aa 266 else if ((val = startswith(option, "timeout="))) {
7f4e0805 267
0004f698 268 r = parse_sec_fix_0(val, &arg_timeout);
fb4650aa
ZJS		 269 if (r < 0) {
270 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
7f4e0805
LP		 271 return 0;
272 }
273
fb4650aa 274 } else if ((val = startswith(option, "offset="))) {
4eac2773 275
fb4650aa
ZJS		 276 r = safe_atou64(val, &arg_offset);
277 if (r < 0)
278 return log_error_errno(r, "Failed to parse %s: %m", option);
4eac2773 279
fb4650aa 280 } else if ((val = startswith(option, "skip="))) {
4eac2773 281
fb4650aa
ZJS		 282 r = safe_atou64(val, &arg_skip);
283 if (r < 0)
284 return log_error_errno(r, "Failed to parse %s: %m", option);
4eac2773 285
08669709
LP		 286 } else if ((val = startswith(option, "pkcs11-uri="))) {
287
b997d111
LP		 288 if (streq(val, "auto")) {
289 arg_pkcs11_uri = mfree(arg_pkcs11_uri);
290 arg_pkcs11_uri_auto = true;
291 } else {
292 if (!pkcs11_uri_valid(val))
293 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "pkcs11-uri= parameter expects a PKCS#11 URI, refusing");
08669709 294
b997d111
LP		 295 r = free_and_strdup(&arg_pkcs11_uri, val);
296 if (r < 0)
297 return log_oom();
298
299 arg_pkcs11_uri_auto = false;
300 }
08669709 301
2bc5c425
LP		 302 } else if ((val = startswith(option, "fido2-device="))) {
303
304 if (streq(val, "auto")) {
305 arg_fido2_device = mfree(arg_fido2_device);
306 arg_fido2_device_auto = true;
307 } else {
308 r = free_and_strdup(&arg_fido2_device, val);
309 if (r < 0)
310 return log_oom();
311
312 arg_fido2_device_auto = false;
313 }
314
315 } else if ((val = startswith(option, "fido2-cid="))) {
316
317 if (streq(val, "auto"))
318 arg_fido2_cid = mfree(arg_fido2_cid);
319 else {
320 _cleanup_free_ void *cid = NULL;
321 size_t cid_size;
322
323 r = unbase64mem(val, (size_t) -1, &cid, &cid_size);
324 if (r < 0)
325 return log_error_errno(r, "Failed to decode FIDO2 CID data: %m");
326
327 free(arg_fido2_cid);
328 arg_fido2_cid = TAKE_PTR(cid);
329 arg_fido2_cid_size = cid_size;
330 }
331
332 /* Turn on FIDO2 as side-effect, if not turned on yet. */
333 if (!arg_fido2_device && !arg_fido2_device_auto)
334 arg_fido2_device_auto = true;
335
336 } else if ((val = startswith(option, "fido2-rp="))) {
337
338 r = free_and_strdup(&arg_fido2_rp_id, val);
339 if (r < 0)
340 return log_oom();
341
18843ecc
LP		 342 } else if ((val = startswith(option, "tpm2-device="))) {
343
344 if (streq(val, "auto")) {
345 arg_tpm2_device = mfree(arg_tpm2_device);
346 arg_tpm2_device_auto = true;
347 } else {
348 r = free_and_strdup(&arg_tpm2_device, val);
349 if (r < 0)
350 return log_oom();
351
352 arg_tpm2_device_auto = false;
353 }
354
355 } else if ((val = startswith(option, "tpm2-pcrs="))) {
356
357 if (isempty(val))
358 arg_tpm2_pcr_mask = 0;
359 else {
360 uint32_t mask;
361
362 r = tpm2_parse_pcrs(val, &mask);
363 if (r < 0)
364 return r;
365
366 if (arg_tpm2_pcr_mask == UINT32_MAX)
367 arg_tpm2_pcr_mask = mask;
368 else
369 arg_tpm2_pcr_mask |= mask;
370 }
371
0ba6f85e
LP		 372 } else if ((val = startswith(option, "try-empty-password="))) {
373
374 r = parse_boolean(val);
375 if (r < 0) {
376 log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
377 return 0;
378 }
379
380 arg_try_empty_password = r;
381
382 } else if (streq(option, "try-empty-password"))
383 arg_try_empty_password = true;
384
385 else if (!streq(option, "x-initrd.attach"))
fb4650aa 386 log_warning("Encountered unknown /etc/crypttab option '%s', ignoring.", option);
7f4e0805
LP		 387
388 return 0;
389}
390
391static int parse_options(const char *options) {
7f4e0805
LP		 392 assert(options);
393
dd2fff3a
ZJS		 394 for (;;) {
395 _cleanup_free_ char *word = NULL;
396 int r;
397
7bb553bb 398 r = extract_first_word(&options, &word, ",", EXTRACT_DONT_COALESCE_SEPARATORS | EXTRACT_UNESCAPE_SEPARATORS);
dd2fff3a 399 if (r < 0)
be36bc1e 400 return log_error_errno(r, "Failed to parse options: %m");
dd2fff3a
ZJS		 401 if (r == 0)
402 break;
7f4e0805 403
dd2fff3a 404 r = parse_one_option(word);
7f4e0805
LP		 405 if (r < 0)
406 return r;
407 }
408
4eac2773 409 /* sanity-check options */
9c5253ff
LP		 410 if (arg_type && !streq(arg_type, CRYPT_PLAIN)) {
411 if (arg_offset != 0)
4eac2773 412 log_warning("offset= ignored with type %s", arg_type);
9c5253ff 413 if (arg_skip != 0)
4eac2773
MP		 414 log_warning("skip= ignored with type %s", arg_type);
415 }
416
7f4e0805
LP		 417 return 0;
418}
419
1ca208fb 420static char* disk_description(const char *path) {
f75cac37 421 static const char name_fields[] =
74b1c371
LP		 422 "DM_NAME\0"
423 "ID_MODEL_FROM_DATABASE\0"
f75cac37 424 "ID_MODEL\0";
74b1c371 425
4afd3348 426 _cleanup_(sd_device_unrefp) sd_device *device = NULL;
2c740afd 427 const char *i, *name;
b1a2da0a 428 struct stat st;
fadd34dd 429 int r;
b1a2da0a
LP		 430
431 assert(path);
432
433 if (stat(path, &st) < 0)
434 return NULL;
435
436 if (!S_ISBLK(st.st_mode))
437 return NULL;
438
930aa88f 439 if (sd_device_new_from_stat_rdev(&device, &st) < 0)
1ca208fb 440 return NULL;
b1a2da0a 441
fadd34dd
LP		 442 if (sd_device_get_property_value(device, "ID_PART_ENTRY_NAME", &name) >= 0) {
443 _cleanup_free_ char *unescaped = NULL;
444
445 /* ID_PART_ENTRY_NAME uses \x style escaping, using libblkid's blkid_encode_string(). Let's
446 * reverse this here to make the string more human friendly in case people embed spaces or
447 * other weird stuff. */
448
449 r = cunescape(name, UNESCAPE_RELAX, &unescaped);
450 if (r < 0) {
451 log_debug_errno(r, "Failed to unescape ID_PART_ENTRY_NAME, skipping device: %m");
452 return NULL;
453 }
454
455 if (!isempty(unescaped) && !string_has_cc(unescaped, NULL))
456 return TAKE_PTR(unescaped);
457 }
458
459 /* These need no unescaping. */
2c740afd
YW		 460 NULSTR_FOREACH(i, name_fields)
461 if (sd_device_get_property_value(device, i, &name) >= 0 &&
462 !isempty(name))
1ca208fb 463 return strdup(name);
b1a2da0a 464
1ca208fb 465 return NULL;
b1a2da0a
LP		 466}
467
b61e476f 468static char *disk_mount_point(const char *label) {
e7d90b71 469 _cleanup_free_ char *device = NULL;
5862d652 470 _cleanup_endmntent_ FILE *f = NULL;
b61e476f
LP		 471 struct mntent *m;
472
473 /* Yeah, we don't support native systemd unit files here for now */
474
090685b5
LP		 475 device = strjoin("/dev/mapper/", label);
476 if (!device)
5862d652 477 return NULL;
b61e476f 478
ed4ad488 479 f = setmntent(fstab_path(), "re");
e0295d26 480 if (!f)
5862d652 481 return NULL;
b61e476f
LP		 482
483 while ((m = getmntent(f)))
5862d652
ZJS		 484 if (path_equal(m->mnt_fsname, device))
485 return strdup(m->mnt_dir);
b61e476f 486
5862d652 487 return NULL;
b61e476f
LP		 488}
489
08669709
LP		 490static char *friendly_disk_name(const char *src, const char *vol) {
491 _cleanup_free_ char *description = NULL, *mount_point = NULL;
492 char *name_buffer = NULL;
493 int r;
e7d90b71 494
e51b9486 495 assert(src);
08669709 496 assert(vol);
e7d90b71 497
e51b9486
HH		 498 description = disk_description(src);
499 mount_point = disk_mount_point(vol);
500
08669709 501 /* If the description string is simply the volume name, then let's not show this twice */
ece174c5 502 if (description && streq(vol, description))
97b11eed 503 description = mfree(description);
e51b9486
HH		 504
505 if (mount_point && description)
506 r = asprintf(&name_buffer, "%s (%s) on %s", description, vol, mount_point);
507 else if (mount_point)
508 r = asprintf(&name_buffer, "%s on %s", vol, mount_point);
509 else if (description)
510 r = asprintf(&name_buffer, "%s (%s)", description, vol);
08669709
LP		 511 else
512 return strdup(vol);
e51b9486 513 if (r < 0)
08669709
LP		 514 return NULL;
515
516 return name_buffer;
517}
518
519static int get_password(
520 const char *vol,
521 const char *src,
522 usec_t until,
523 bool accept_cached,
524 char ***ret) {
525
526 _cleanup_free_ char *friendly = NULL, *text = NULL, *disk_path = NULL;
527 _cleanup_strv_free_erase_ char **passwords = NULL;
528 char **p, *id;
529 int r = 0;
530
531 assert(vol);
532 assert(src);
533 assert(ret);
534
535 friendly = friendly_disk_name(src, vol);
536 if (!friendly)
e51b9486
HH		 537 return log_oom();
538
08669709
LP		 539 if (asprintf(&text, "Please enter passphrase for disk %s:", friendly) < 0)
540 return log_oom();
e51b9486 541
08669709
LP		 542 disk_path = cescape(src);
543 if (!disk_path)
e7d90b71
JJ		 544 return log_oom();
545
ea7e7c1e 546 id = strjoina("cryptsetup:", disk_path);
9fa1de96 547
ab84f5b9
ZJS		 548 r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", until,
549 ASK_PASSWORD_PUSH_CACHE | (accept_cached*ASK_PASSWORD_ACCEPT_CACHED),
550 &passwords);
23bbb0de
MS		 551 if (r < 0)
552 return log_error_errno(r, "Failed to query password: %m");
e7d90b71 553
f75cac37 554 if (arg_verify) {
ab84f5b9
ZJS		 555 _cleanup_strv_free_erase_ char **passwords2 = NULL;
556
1602b008 557 assert(strv_length(passwords) == 1);
e7d90b71 558
08669709 559 if (asprintf(&text, "Please enter passphrase for disk %s (verification):", friendly) < 0)
ab84f5b9 560 return log_oom();
e7d90b71 561
ea7e7c1e 562 id = strjoina("cryptsetup-verification:", disk_path);
9fa1de96 563
e287086b 564 r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", until, ASK_PASSWORD_PUSH_CACHE, &passwords2);
ab84f5b9
ZJS		 565 if (r < 0)
566 return log_error_errno(r, "Failed to query verification password: %m");
e7d90b71
JJ		 567
568 assert(strv_length(passwords2) == 1);
569
8bc6ade7
LP		 570 if (!streq(passwords[0], passwords2[0]))
571 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN),
572 "Passwords did not match, retrying.");
e7d90b71
JJ		 573 }
574
1602b008 575 strv_uniq(passwords);
e7d90b71 576
1602b008 577 STRV_FOREACH(p, passwords) {
e7d90b71
JJ		 578 char *c;
579
f75cac37 580 if (strlen(*p)+1 >= arg_key_size)
e7d90b71
JJ		 581 continue;
582
583 /* Pad password if necessary */
1602b008 584 c = new(char, arg_key_size);
ab84f5b9
ZJS		 585 if (!c)
586 return log_oom();
e7d90b71 587
f75cac37 588 strncpy(c, *p, arg_key_size);
d3ad474f
LP		 589 erase_and_free(*p);
590 *p = TAKE_PTR(c);
e7d90b71
JJ		 591 }
592
ae2a15bc 593 *ret = TAKE_PTR(passwords);
1602b008 594
ab84f5b9 595 return 0;
e7d90b71
JJ		 596}
597
1602b008
LP		 598static int attach_tcrypt(
599 struct crypt_device *cd,
600 const char *name,
601 const char *key_file,
7407f689
LP		 602 const void *key_data,
603 size_t key_data_size,
1602b008
LP		 604 char **passwords,
605 uint32_t flags) {
606
8cf3ca80 607 int r = 0;
d3ad474f 608 _cleanup_(erase_and_freep) char *passphrase = NULL;
8cf3ca80
JJ		 609 struct crypt_params_tcrypt params = {
610 .flags = CRYPT_TCRYPT_LEGACY_MODES,
f75cac37
LP		 611 .keyfiles = (const char **)arg_tcrypt_keyfiles,
612 .keyfiles_count = strv_length(arg_tcrypt_keyfiles)
8cf3ca80
JJ		 613 };
614
615 assert(cd);
616 assert(name);
7407f689 617 assert(key_file || key_data || !strv_isempty(passwords));
8cf3ca80 618
18843ecc 619 if (arg_pkcs11_uri || arg_pkcs11_uri_auto || arg_fido2_device || arg_fido2_device_auto || arg_tpm2_device || arg_tpm2_device_auto)
e514aa1e
FS		 620 /* Ask for a regular password */
621 return log_error_errno(SYNTHETIC_ERRNO(EAGAIN),
18843ecc 622 "Sorry, but tcrypt devices are currently not supported in conjunction with pkcs11/fido2/tpm2 support.");
08669709 623
f75cac37 624 if (arg_tcrypt_hidden)
8cf3ca80
JJ		 625 params.flags |= CRYPT_TCRYPT_HIDDEN_HEADER;
626
f75cac37 627 if (arg_tcrypt_system)
8cf3ca80
JJ		 628 params.flags |= CRYPT_TCRYPT_SYSTEM_HEADER;
629
52028838
GH		 630 if (arg_tcrypt_veracrypt)
631 params.flags |= CRYPT_TCRYPT_VERA_MODES;
52028838 632
7407f689
LP		 633 if (key_data) {
634 params.passphrase = key_data;
635 params.passphrase_size = key_data_size;
636 } else {
637 if (key_file) {
638 r = read_one_line_file(key_file, &passphrase);
639 if (r < 0) {
640 log_error_errno(r, "Failed to read password file '%s': %m", key_file);
641 return -EAGAIN; /* log with the actual error, but return EAGAIN */
642 }
8cf3ca80 643
7407f689
LP		 644 params.passphrase = passphrase;
645 } else
646 params.passphrase = passwords[0];
647
648 params.passphrase_size = strlen(params.passphrase);
649 }
8cf3ca80
JJ		 650
651 r = crypt_load(cd, CRYPT_TCRYPT, &params);
652 if (r < 0) {
7407f689 653 if (r == -EPERM) {
cb6c9283 654 if (key_data)
7407f689 655 log_error_errno(r, "Failed to activate using discovered key. (Key not correct?)");
7407f689 656
cb6c9283 657 if (key_file)
7407f689 658 log_error_errno(r, "Failed to activate using password file '%s'. (Key data not correct?)", key_file);
cb6c9283
LP		 659
660 return -EAGAIN; /* log the actual error, but return EAGAIN */
6f177c7d
LP		 661 }
662
663 return log_error_errno(r, "Failed to load tcrypt superblock on device %s: %m", crypt_get_device_name(cd));
8cf3ca80
JJ		 664 }
665
6f177c7d
LP		 666 r = crypt_activate_by_volume_key(cd, name, NULL, 0, flags);
667 if (r < 0)
668 return log_error_errno(r, "Failed to activate tcrypt device %s: %m", crypt_get_device_name(cd));
669
670 return 0;
8cf3ca80
JJ		 671}
672
e2c2f868
LP		 673static char *make_bindname(const char *volume) {
674 char *s;
675
676 if (asprintf(&s, "@%" PRIx64"/cryptsetup/%s", random_u64(), volume) < 0)
677 return NULL;
678
679 return s;
680}
681
8414cd48
LP		 682static int make_security_device_monitor(sd_event *event, sd_device_monitor **ret) {
683 _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
684 int r;
685
686 assert(ret);
687
688 r = sd_device_monitor_new(&monitor);
689 if (r < 0)
690 return log_error_errno(r, "Failed to allocate device monitor: %m");
691
692 r = sd_device_monitor_filter_add_match_tag(monitor, "security-device");
693 if (r < 0)
694 return log_error_errno(r, "Failed to configure device monitor: %m");
695
696 r = sd_device_monitor_attach_event(monitor, event);
697 if (r < 0)
698 return log_error_errno(r, "Failed to attach device monitor: %m");
699
700 r = sd_device_monitor_start(monitor, NULL, NULL);
701 if (r < 0)
702 return log_error_errno(r, "Failed to start device monitor: %m");
703
704 *ret = TAKE_PTR(monitor);
705 return 0;
706}
707
2bc5c425
LP		 708static int attach_luks_or_plain_or_bitlk_by_fido2(
709 struct crypt_device *cd,
710 const char *name,
711 const char *key_file,
712 const void *key_data,
713 size_t key_data_size,
714 usec_t until,
715 uint32_t flags,
716 bool pass_volume_key) {
717
718 _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
719 _cleanup_(erase_and_freep) void *decrypted_key = NULL;
720 _cleanup_(sd_event_unrefp) sd_event *event = NULL;
721 _cleanup_free_ void *discovered_salt = NULL, *discovered_cid = NULL;
722 size_t discovered_salt_size, discovered_cid_size, cid_size, decrypted_key_size;
723 _cleanup_free_ char *friendly = NULL, *discovered_rp_id = NULL;
724 int keyslot = arg_key_slot, r;
725 const char *rp_id;
726 const void *cid;
727
728 assert(cd);
729 assert(name);
730 assert(arg_fido2_device || arg_fido2_device_auto);
731
732 if (arg_fido2_cid) {
733 if (!key_file && !key_data)
734 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "FIDO2 mode selected but no key file specified, refusing.");
735
736 rp_id = arg_fido2_rp_id;
737 cid = arg_fido2_cid;
738 cid_size = arg_fido2_cid_size;
739 } else {
740 r = find_fido2_auto_data(
741 cd,
742 &discovered_rp_id,
743 &discovered_salt,
744 &discovered_salt_size,
745 &discovered_cid,
746 &discovered_cid_size,
747 &keyslot);
748
749 if (IN_SET(r, -ENOTUNIQ, -ENXIO))
750 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
751 "Automatic FIDO2 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking.");
752 if (r < 0)
753 return r;
754
755 rp_id = discovered_rp_id;
756 key_data = discovered_salt;
757 key_data_size = discovered_salt_size;
758 cid = discovered_cid;
759 cid_size = discovered_cid_size;
760 }
761
762 friendly = friendly_disk_name(crypt_get_device_name(cd), name);
763 if (!friendly)
764 return log_oom();
765
766 for (;;) {
767 bool processed = false;
768
769 r = acquire_fido2_key(
770 name,
771 friendly,
772 arg_fido2_device,
773 rp_id,
774 cid, cid_size,
775 key_file, arg_keyfile_size, arg_keyfile_offset,
776 key_data, key_data_size,
777 until,
778 &decrypted_key, &decrypted_key_size);
779 if (r >= 0)
780 break;
781 if (r != -EAGAIN) /* EAGAIN means: token not found */
782 return r;
783
784 if (!monitor) {
785 /* We didn't find the token. In this case, watch for it via udev. Let's
786 * create an event loop and monitor first. */
787
788 assert(!event);
789
790 r = sd_event_default(&event);
791 if (r < 0)
792 return log_error_errno(r, "Failed to allocate event loop: %m");
793
794 r = make_security_device_monitor(event, &monitor);
795 if (r < 0)
796 return r;
797
798 log_notice("Security token not present for unlocking volume %s, please plug it in.", friendly);
799
800 /* Let's immediately rescan in case the token appeared in the time we needed
801 * to create and configure the monitor */
802 continue;
803 }
804
805 for (;;) {
806 /* Wait for one event, and then eat all subsequent events until there are no
807 * further ones */
808 r = sd_event_run(event, processed ? 0 : UINT64_MAX);
809 if (r < 0)
810 return log_error_errno(r, "Failed to run event loop: %m");
811 if (r == 0)
812 break;
813
814 processed = true;
815 }
816
817 log_debug("Got one or more potentially relevant udev events, rescanning FIDO2...");
818 }
819
820 if (pass_volume_key)
821 r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags);
822 else {
823 _cleanup_(erase_and_freep) char *base64_encoded = NULL;
824
825 /* Before using this key as passphrase we base64 encode it, for compat with homed */
826
827 r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded);
828 if (r < 0)
829 return log_oom();
830
831 r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags);
832 }
833 if (r == -EPERM) {
834 log_error_errno(r, "Failed to activate with FIDO2 decrypted key. (Key incorrect?)");
835 return -EAGAIN; /* log actual error, but return EAGAIN */
836 }
837 if (r < 0)
838 return log_error_errno(r, "Failed to activate with FIDO2 acquired key: %m");
839
840 return 0;
841}
842
b8c80b56
LP		 843static int attach_luks_or_plain_or_bitlk_by_pkcs11(
844 struct crypt_device *cd,
845 const char *name,
846 const char *key_file,
847 const void *key_data,
848 size_t key_data_size,
849 usec_t until,
850 uint32_t flags,
851 bool pass_volume_key) {
852
853 _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
854 _cleanup_free_ char *friendly = NULL, *discovered_uri = NULL;
855 size_t decrypted_key_size = 0, discovered_key_size = 0;
856 _cleanup_(erase_and_freep) void *decrypted_key = NULL;
857 _cleanup_(sd_event_unrefp) sd_event *event = NULL;
858 _cleanup_free_ void *discovered_key = NULL;
859 int keyslot = arg_key_slot, r;
860 const char *uri;
861
862 assert(cd);
863 assert(name);
864 assert(arg_pkcs11_uri || arg_pkcs11_uri_auto);
865
866 if (arg_pkcs11_uri_auto) {
867 r = find_pkcs11_auto_data(cd, &discovered_uri, &discovered_key, &discovered_key_size, &keyslot);
868 if (IN_SET(r, -ENOTUNIQ, -ENXIO))
869 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
870 "Automatic PKCS#11 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking.");
871 if (r < 0)
872 return r;
873
874 uri = discovered_uri;
875 key_data = discovered_key;
876 key_data_size = discovered_key_size;
877 } else {
878 uri = arg_pkcs11_uri;
879
880 if (!key_file && !key_data)
881 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "PKCS#11 mode selected but no key file specified, refusing.");
882 }
883
884 friendly = friendly_disk_name(crypt_get_device_name(cd), name);
885 if (!friendly)
886 return log_oom();
887
888 for (;;) {
889 bool processed = false;
890
891 r = decrypt_pkcs11_key(
892 name,
893 friendly,
894 uri,
895 key_file, arg_keyfile_size, arg_keyfile_offset,
896 key_data, key_data_size,
897 until,
898 &decrypted_key, &decrypted_key_size);
899 if (r >= 0)
900 break;
901 if (r != -EAGAIN) /* EAGAIN means: token not found */
902 return r;
903
904 if (!monitor) {
905 /* We didn't find the token. In this case, watch for it via udev. Let's
906 * create an event loop and monitor first. */
907
908 assert(!event);
909
910 r = sd_event_default(&event);
911 if (r < 0)
912 return log_error_errno(r, "Failed to allocate event loop: %m");
913
914 r = make_security_device_monitor(event, &monitor);
915 if (r < 0)
916 return r;
917
918 log_notice("Security token %s not present for unlocking volume %s, please plug it in.",
919 uri, friendly);
920
921 /* Let's immediately rescan in case the token appeared in the time we needed
922 * to create and configure the monitor */
923 continue;
924 }
925
926 for (;;) {
927 /* Wait for one event, and then eat all subsequent events until there are no
928 * further ones */
929 r = sd_event_run(event, processed ? 0 : UINT64_MAX);
930 if (r < 0)
931 return log_error_errno(r, "Failed to run event loop: %m");
932 if (r == 0)
933 break;
934
935 processed = true;
936 }
937
938 log_debug("Got one or more potentially relevant udev events, rescanning PKCS#11...");
939 }
940
941 if (pass_volume_key)
942 r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags);
943 else {
944 _cleanup_(erase_and_freep) char *base64_encoded = NULL;
945
946 /* Before using this key as passphrase we base64 encode it. Why? For compatibility
947 * with homed's PKCS#11 hookup: there we want to use the key we acquired through
948 * PKCS#11 for other authentication/decryption mechanisms too, and some of them do
949 * not not take arbitrary binary blobs, but require NUL-terminated strings — most
950 * importantly UNIX password hashes. Hence, for compatibility we want to use a string
951 * without embedded NUL here too, and that's easiest to generate from a binary blob
952 * via base64 encoding. */
953
954 r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded);
955 if (r < 0)
956 return log_oom();
957
958 r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags);
959 }
960 if (r == -EPERM) {
961 log_error_errno(r, "Failed to activate with PKCS#11 decrypted key. (Key incorrect?)");
962 return -EAGAIN; /* log actual error, but return EAGAIN */
963 }
964 if (r < 0)
965 return log_error_errno(r, "Failed to activate with PKCS#11 acquired key: %m");
966
967 return 0;
968}
969
18843ecc
LP		 970static int make_tpm2_device_monitor(sd_event *event, sd_device_monitor **ret) {
971 _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
972 int r;
973
974 assert(ret);
975
976 r = sd_device_monitor_new(&monitor);
977 if (r < 0)
978 return log_error_errno(r, "Failed to allocate device monitor: %m");
979
980 r = sd_device_monitor_filter_add_match_subsystem_devtype(monitor, "tpmrm", NULL);
981 if (r < 0)
982 return log_error_errno(r, "Failed to configure device monitor: %m");
983
984 r = sd_device_monitor_attach_event(monitor, event);
985 if (r < 0)
986 return log_error_errno(r, "Failed to attach device monitor: %m");
987
988 r = sd_device_monitor_start(monitor, NULL, NULL);
989 if (r < 0)
990 return log_error_errno(r, "Failed to start device monitor: %m");
991
992 *ret = TAKE_PTR(monitor);
993 return 0;
994}
995
996static int attach_luks_or_plain_or_bitlk_by_tpm2(
997 struct crypt_device *cd,
998 const char *name,
999 const char *key_file,
1000 const void *key_data,
1001 size_t key_data_size,
1002 usec_t until,
1003 uint32_t flags,
1004 bool pass_volume_key) {
1005
1006 _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
1007 _cleanup_(erase_and_freep) void *decrypted_key = NULL;
1008 _cleanup_(sd_event_unrefp) sd_event *event = NULL;
1009 _cleanup_free_ char *friendly = NULL;
1010 int keyslot = arg_key_slot, r;
1011 size_t decrypted_key_size;
1012
1013 assert(cd);
1014 assert(name);
1015 assert(arg_tpm2_device || arg_tpm2_device_auto);
1016
1017 friendly = friendly_disk_name(crypt_get_device_name(cd), name);
1018 if (!friendly)
1019 return log_oom();
1020
1021 for (;;) {
1022 bool processed = false;
1023
1024 if (key_file || key_data) {
1025 /* If key data is specified, use that */
1026
1027 r = acquire_tpm2_key(
1028 name,
1029 arg_tpm2_device,
1030 arg_tpm2_pcr_mask == UINT32_MAX ? TPM2_PCR_MASK_DEFAULT : arg_tpm2_pcr_mask,
1031 key_file, arg_keyfile_size, arg_keyfile_offset,
1032 key_data, key_data_size,
1033 NULL, 0, /* we don't know the policy hash */
1034 &decrypted_key, &decrypted_key_size);
1035 if (r >= 0)
1036 break;
1037 if (r != -EAGAIN) /* EAGAIN means: no tpm2 chip found */
1038 return r;
1039 } else {
1040 _cleanup_free_ void *blob = NULL, *policy_hash = NULL;
1041 size_t blob_size, policy_hash_size;
1042 bool found_some = false;
1043 int token = 0; /* first token to look at */
1044
1045 /* If no key data is specified, look for it in the header. In order to support
1046 * software upgrades we'll iterate through all suitable tokens, maybe one of them
1047 * works. */
1048
1049 for (;;) {
1050 uint32_t pcr_mask;
1051
1052 r = find_tpm2_auto_data(
1053 cd,
1054 arg_tpm2_pcr_mask, /* if != UINT32_MAX we'll only look for tokens with this PCR mask */
1055 token, /* search for the token with this index, or any later index than this */
1056 &pcr_mask,
1057 &blob, &blob_size,
1058 &policy_hash, &policy_hash_size,
1059 &keyslot,
1060 &token);
1061 if (r == -ENXIO) {
45861042 1062 /* No further TPM2 tokens found in the LUKS2 header.*/
18843ecc
LP		 1063 if (found_some)
1064 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
1065 "No TPM2 metadata matching the current system state found in LUKS2 header, falling back to traditional unlocking.");
1066 else
1067 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
1068 "No TPM2 metadata enrolled in LUKS2 header, falling back to traditional unlocking.");
1069 }
1070 if (r < 0)
1071 return r;
1072
1073 found_some = true;
1074
1075 r = acquire_tpm2_key(
1076 name,
1077 arg_tpm2_device,
1078 pcr_mask,
1079 NULL, 0, 0, /* no key file */
1080 blob, blob_size,
1081 policy_hash, policy_hash_size,
1082 &decrypted_key, &decrypted_key_size);
1083 if (r != -EPERM)
1084 break;
1085
1086 token++; /* try a different token next time */
1087 }
1088
1089 if (r >= 0)
1090 break;
1091 if (r != -EAGAIN) /* EAGAIN means: no tpm2 chip found */
1092 return r;
1093 }
1094
1095 if (!monitor) {
1096 /* We didn't find the TPM2 device. In this case, watch for it via udev. Let's create
1097 * an event loop and monitor first. */
1098
1099 assert(!event);
1100
1101 r = sd_event_default(&event);
1102 if (r < 0)
1103 return log_error_errno(r, "Failed to allocate event loop: %m");
1104
1105 r = make_tpm2_device_monitor(event, &monitor);
1106 if (r < 0)
1107 return r;
1108
1109 log_info("TPM2 device not present for unlocking %s, waiting for it to become available.", friendly);
1110
1111 /* Let's immediately rescan in case the device appeared in the time we needed
1112 * to create and configure the monitor */
1113 continue;
1114 }
1115
1116 for (;;) {
1117 /* Wait for one event, and then eat all subsequent events until there are no
1118 * further ones */
1119 r = sd_event_run(event, processed ? 0 : UINT64_MAX);
1120 if (r < 0)
1121 return log_error_errno(r, "Failed to run event loop: %m");
1122 if (r == 0)
1123 break;
1124
1125 processed = true;
1126 }
1127
1128 log_debug("Got one or more potentially relevant udev events, rescanning for TPM2...");
1129 }
1130
1131 if (pass_volume_key)
1132 r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags);
1133 else {
1134 _cleanup_(erase_and_freep) char *base64_encoded = NULL;
1135
1136 /* Before using this key as passphrase we base64 encode it, for compat with homed */
1137
1138 r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded);
1139 if (r < 0)
1140 return log_oom();
1141
1142 r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags);
1143 }
1144 if (r == -EPERM) {
1145 log_error_errno(r, "Failed to activate with TPM2 decrypted key. (Key incorrect?)");
1146 return -EAGAIN; /* log actual error, but return EAGAIN */
1147 }
1148 if (r < 0)
1149 return log_error_errno(r, "Failed to activate with TPM2 acquired key: %m");
1150
1151 return 0;
1152}
1153
b8c80b56
LP		 1154static int attach_luks_or_plain_or_bitlk_by_key_data(
1155 struct crypt_device *cd,
1156 const char *name,
1157 const void *key_data,
1158 size_t key_data_size,
1159 uint32_t flags,
1160 bool pass_volume_key) {
1161
1162 int r;
1163
1164 assert(cd);
1165 assert(name);
1166 assert(key_data);
1167
1168 if (pass_volume_key)
1169 r = crypt_activate_by_volume_key(cd, name, key_data, key_data_size, flags);
1170 else
1171 r = crypt_activate_by_passphrase(cd, name, arg_key_slot, key_data, key_data_size, flags);
1172 if (r == -EPERM) {
1173 log_error_errno(r, "Failed to activate. (Key incorrect?)");
1174 return -EAGAIN; /* Log actual error, but return EAGAIN */
1175 }
1176 if (r < 0)
1177 return log_error_errno(r, "Failed to activate: %m");
1178
1179 return 0;
1180}
1181
1182static int attach_luks_or_plain_or_bitlk_by_key_file(
1183 struct crypt_device *cd,
1184 const char *name,
1185 const char *key_file,
1186 uint32_t flags,
1187 bool pass_volume_key) {
1188
1189 _cleanup_(erase_and_freep) char *kfdata = NULL;
1190 _cleanup_free_ char *bindname = NULL;
1191 size_t kfsize;
1192 int r;
1193
1194 assert(cd);
1195 assert(name);
1196 assert(key_file);
1197
1198 /* If we read the key via AF_UNIX, make this client recognizable */
1199 bindname = make_bindname(name);
1200 if (!bindname)
1201 return log_oom();
1202
1203 r = read_full_file_full(
1204 AT_FDCWD, key_file,
1205 arg_keyfile_offset == 0 ? UINT64_MAX : arg_keyfile_offset,
1206 arg_keyfile_size == 0 ? SIZE_MAX : arg_keyfile_size,
1207 READ_FULL_FILE_SECURE|READ_FULL_FILE_WARN_WORLD_READABLE|READ_FULL_FILE_CONNECT_SOCKET,
1208 bindname,
1209 &kfdata, &kfsize);
1210 if (r == -ENOENT) {
1211 log_error_errno(r, "Failed to activate, key file '%s' missing.", key_file);
1212 return -EAGAIN; /* Log actual error, but return EAGAIN */
1213 }
1214
1215 if (pass_volume_key)
1216 r = crypt_activate_by_volume_key(cd, name, kfdata, kfsize, flags);
1217 else
1218 r = crypt_activate_by_passphrase(cd, name, arg_key_slot, kfdata, kfsize, flags);
1219 if (r == -EPERM) {
1220 log_error_errno(r, "Failed to activate with key file '%s'. (Key data incorrect?)", key_file);
1221 return -EAGAIN; /* Log actual error, but return EAGAIN */
1222 }
1223 if (r < 0)
1224 return log_error_errno(r, "Failed to activate with key file '%s': %m", key_file);
1225
1226 return 0;
1227}
1228
1229static int attach_luks_or_plain_or_bitlk_by_passphrase(
1230 struct crypt_device *cd,
1231 const char *name,
1232 char **passwords,
1233 uint32_t flags,
1234 bool pass_volume_key) {
1235
1236 char **p;
1237 int r;
1238
1239 assert(cd);
1240 assert(name);
1241
1242 r = -EINVAL;
1243 STRV_FOREACH(p, passwords) {
1244 if (pass_volume_key)
1245 r = crypt_activate_by_volume_key(cd, name, *p, arg_key_size, flags);
1246 else
1247 r = crypt_activate_by_passphrase(cd, name, arg_key_slot, *p, strlen(*p), flags);
1248 if (r >= 0)
1249 break;
1250 }
1251 if (r == -EPERM) {
1252 log_error_errno(r, "Failed to activate with specified passphrase. (Passphrase incorrect?)");
1253 return -EAGAIN; /* log actual error, but return EAGAIN */
1254 }
1255 if (r < 0)
1256 return log_error_errno(r, "Failed to activate with specified passphrase: %m");
1257
1258 return 0;
1259}
1260
6cc27c29 1261static int attach_luks_or_plain_or_bitlk(
9c5253ff
LP		 1262 struct crypt_device *cd,
1263 const char *name,
1264 const char *key_file,
7407f689
LP		 1265 const void *key_data,
1266 size_t key_data_size,
9c5253ff 1267 char **passwords,
08669709
LP		 1268 uint32_t flags,
1269 usec_t until) {
9c5253ff 1270
10fb4e35 1271 bool pass_volume_key = false;
b8c80b56 1272 int r;
10fb4e35
JJ		 1273
1274 assert(cd);
1275 assert(name);
10fb4e35 1276
2e4beb87 1277 if ((!arg_type && !crypt_get_type(cd)) || streq_ptr(arg_type, CRYPT_PLAIN)) {
4eac2773
MP		 1278 struct crypt_params_plain params = {
1279 .offset = arg_offset,
1280 .skip = arg_skip,
a9fc6406 1281 .sector_size = arg_sector_size,
4eac2773 1282 };
10fb4e35
JJ		 1283 const char *cipher, *cipher_mode;
1284 _cleanup_free_ char *truncated_cipher = NULL;
1285
b8c80b56 1286 if (streq_ptr(arg_hash, "plain"))
10fb4e35 1287 /* plain isn't a real hash type. it just means "use no hash" */
b8c80b56
LP		 1288 params.hash = NULL;
1289 else if (arg_hash)
1290 params.hash = arg_hash;
1291 else if (!key_file)
1292 /* for CRYPT_PLAIN, the behaviour of cryptsetup package is to not hash when a key
1293 * file is provided */
10fb4e35
JJ		 1294 params.hash = "ripemd160";
1295
f75cac37 1296 if (arg_cipher) {
10fb4e35
JJ		 1297 size_t l;
1298
f75cac37
LP		 1299 l = strcspn(arg_cipher, "-");
1300 truncated_cipher = strndup(arg_cipher, l);
10fb4e35
JJ		 1301 if (!truncated_cipher)
1302 return log_oom();
1303
1304 cipher = truncated_cipher;
f75cac37 1305 cipher_mode = arg_cipher[l] ? arg_cipher+l+1 : "plain";
10fb4e35
JJ		 1306 } else {
1307 cipher = "aes";
1308 cipher_mode = "cbc-essiv:sha256";
1309 }
1310
aed68083 1311 /* for CRYPT_PLAIN limit reads from keyfile to key length, and ignore keyfile-size */
6131a78b 1312 arg_keyfile_size = arg_key_size;
10fb4e35 1313
30747265 1314 /* In contrast to what the name crypt_format() might suggest this doesn't actually format
aed68083 1315 * anything, it just configures encryption parameters when used for plain mode. */
1602b008 1316 r = crypt_format(cd, CRYPT_PLAIN, cipher, cipher_mode, NULL, NULL, arg_keyfile_size, &params);
2e4beb87
MB		 1317 if (r < 0)
1318 return log_error_errno(r, "Loading of cryptographic parameters failed: %m");
10fb4e35
JJ		 1319
1320 /* hash == NULL implies the user passed "plain" */
b8c80b56 1321 pass_volume_key = !params.hash;
10fb4e35 1322 }
10fb4e35
JJ		 1323
1324 log_info("Set cipher %s, mode %s, key size %i bits for device %s.",
1325 crypt_get_cipher(cd),
1326 crypt_get_cipher_mode(cd),
1327 crypt_get_volume_key_size(cd)*8,
1328 crypt_get_device_name(cd));
1329
18843ecc
LP		 1330 if (arg_tpm2_device || arg_tpm2_device_auto)
1331 return attach_luks_or_plain_or_bitlk_by_tpm2(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key);
2bc5c425
LP		 1332 if (arg_fido2_device || arg_fido2_device_auto)
1333 return attach_luks_or_plain_or_bitlk_by_fido2(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key);
b8c80b56
LP		 1334 if (arg_pkcs11_uri || arg_pkcs11_uri_auto)
1335 return attach_luks_or_plain_or_bitlk_by_pkcs11(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key);
1336 if (key_data)
1337 return attach_luks_or_plain_or_bitlk_by_key_data(cd, name, key_data, key_data_size, flags, pass_volume_key);
1338 if (key_file)
1339 return attach_luks_or_plain_or_bitlk_by_key_file(cd, name, key_file, flags, pass_volume_key);
10fb4e35 1340
b8c80b56 1341 return attach_luks_or_plain_or_bitlk_by_passphrase(cd, name, passwords, flags, pass_volume_key);
10fb4e35
JJ		 1342}
1343
dd5e696d 1344static int help(void) {
37ec0fdd
LP		 1345 _cleanup_free_ char *link = NULL;
1346 int r;
1347
1348 r = terminal_urlify_man("systemd-cryptsetup@.service", "8", &link);
1349 if (r < 0)
1350 return log_oom();
dd5e696d
LP		 1351
1352 printf("%s attach VOLUME SOURCEDEVICE [PASSWORD] [OPTIONS]\n"
1353 "%s detach VOLUME\n\n"
37ec0fdd 1354 "Attaches or detaches an encrypted block device.\n"
bc556335
DDM		 1355 "\nSee the %s for details.\n",
1356 program_invocation_short_name,
1357 program_invocation_short_name,
1358 link);
dd5e696d
LP		 1359
1360 return 0;
1361}
1362
d5d1ae15
LP		 1363static uint32_t determine_flags(void) {
1364 uint32_t flags = 0;
1365
1366 if (arg_readonly)
1367 flags |= CRYPT_ACTIVATE_READONLY;
1368
1369 if (arg_discards)
1370 flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS;
1371
1372 if (arg_same_cpu_crypt)
1373 flags |= CRYPT_ACTIVATE_SAME_CPU_CRYPT;
1374
1375 if (arg_submit_from_crypt_cpus)
1376 flags |= CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS;
1377
227acf00
JU		 1378 if (arg_no_read_workqueue)
1379 flags |= CRYPT_ACTIVATE_NO_READ_WORKQUEUE;
1380
1381 if (arg_no_write_workqueue)
1382 flags |= CRYPT_ACTIVATE_NO_WRITE_WORKQUEUE;
1383
408c81f6
MS		 1384#ifdef CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF
1385 /* Try to decrease the risk of OOM event if memory hard key derivation function is in use */
1386 /* https://gitlab.com/cryptsetup/cryptsetup/issues/446/ */
1387 flags |= CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF;
1388#endif
1389
d5d1ae15
LP		 1390 return flags;
1391}
1392
d3d49e76
LP		 1393static void remove_and_erasep(const char **p) {
1394 int r;
1395
1396 if (!*p)
1397 return;
1398
1399 r = unlinkat_deallocate(AT_FDCWD, *p, UNLINK_ERASE);
1400 if (r < 0 && r != -ENOENT)
1401 log_warning_errno(r, "Unable to erase key file '%s', ignoring: %m", *p);
1402}
1403
3a40f366 1404static int run(int argc, char *argv[]) {
294bd454 1405 _cleanup_(crypt_freep) struct crypt_device *cd = NULL;
da2268f9 1406 const char *verb;
3a40f366 1407 int r;
e23a0ce8 1408
3a40f366
YW		 1409 if (argc <= 1)
1410 return help();
dd5e696d 1411
d7a0f1f4
FS		 1412 if (argc < 3)
1413 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1414 "This program requires at least two arguments.");
e23a0ce8 1415
d2acb93d 1416 log_setup();
e23a0ce8 1417
efc3b12f 1418 cryptsetup_enable_logging(cd);
568a8404 1419
4c12626c
LP		 1420 umask(0022);
1421
da2268f9
LP		 1422 verb = argv[1];
1423
1424 if (streq(verb, "attach")) {
d3d49e76 1425 _cleanup_(remove_and_erasep) const char *destroy_key_file = NULL;
7407f689 1426 _cleanup_(erase_and_freep) void *key_data = NULL;
da2268f9
LP		 1427 const char *volume, *source, *key_file, *options;
1428 crypt_status_info status;
7407f689 1429 size_t key_data_size = 0;
da2268f9
LP		 1430 uint32_t flags = 0;
1431 unsigned tries;
1432 usec_t until;
7f4e0805 1433
b61e476f
LP		 1434 /* Arguments: systemd-cryptsetup attach VOLUME SOURCE-DEVICE [PASSWORD] [OPTIONS] */
1435
0ffff81a
LP		 1436 if (argc < 4)
1437 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "attach requires at least two arguments.");
7f4e0805 1438
da2268f9
LP		 1439 volume = argv[2];
1440 source = argv[3];
1441 key_file = argc >= 5 && !STR_IN_SET(argv[4], "", "-", "none") ? argv[4] : NULL;
1442 options = argc >= 6 && !STR_IN_SET(argv[5], "", "-", "none") ? argv[5] : NULL;
7407f689 1443
da2268f9
LP		 1444 if (!filename_is_valid(volume))
1445 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Volume name '%s' is not valid.", volume);
1446
1447 if (key_file && !path_is_absolute(key_file)) {
1448 log_warning("Password file path '%s' is not absolute. Ignoring.", key_file);
1449 key_file = NULL;
7f4e0805
LP		 1450 }
1451
da2268f9
LP		 1452 if (options) {
1453 r = parse_options(options);
3a40f366
YW		 1454 if (r < 0)
1455 return r;
74b1c371 1456 }
e23a0ce8 1457
7bb553bb 1458 log_debug("%s %s ← %s type=%s cipher=%s", __func__,
da2268f9 1459 volume, source, strempty(arg_type), strempty(arg_cipher));
7bb553bb 1460
b853f6e9 1461 /* A delicious drop of snake oil */
9c5253ff 1462 (void) mlockall(MCL_FUTURE);
b853f6e9 1463
7407f689 1464 if (!key_file) {
e060ed32 1465 _cleanup_free_ char *bindname = NULL;
7407f689
LP		 1466 const char *fn;
1467
da2268f9 1468 bindname = make_bindname(volume);
e060ed32
LP		 1469 if (!bindname)
1470 return log_oom();
1471
7407f689
LP		 1472 /* If a key file is not explicitly specified, search for a key in a well defined
1473 * search path, and load it. */
1474
da2268f9 1475 fn = strjoina(volume, ".key");
e060ed32
LP		 1476 r = find_key_file(
1477 fn,
1478 STRV_MAKE("/etc/cryptsetup-keys.d", "/run/cryptsetup-keys.d"),
1479 bindname,
1480 &key_data, &key_data_size);
7407f689
LP		 1481 if (r < 0)
1482 return r;
1483 if (r > 0)
da2268f9 1484 log_debug("Automatically discovered key for volume '%s'.", volume);
7407f689 1485 } else if (arg_keyfile_erase)
d3d49e76
LP		 1486 destroy_key_file = key_file; /* let's get this baby erased when we leave */
1487
7376e835
AC		 1488 if (arg_header) {
1489 log_debug("LUKS header: %s", arg_header);
5f4bfe56 1490 r = crypt_init(&cd, arg_header);
7376e835 1491 } else
da2268f9 1492 r = crypt_init(&cd, source);
3a40f366
YW		 1493 if (r < 0)
1494 return log_error_errno(r, "crypt_init() failed: %m");
e23a0ce8 1495
efc3b12f 1496 cryptsetup_enable_logging(cd);
7f4e0805 1497
da2268f9 1498 status = crypt_status(cd, volume);
3742095b 1499 if (IN_SET(status, CRYPT_ACTIVE, CRYPT_BUSY)) {
da2268f9 1500 log_info("Volume %s already active.", volume);
3a40f366 1501 return 0;
7f4e0805
LP		 1502 }
1503
d5d1ae15 1504 flags = determine_flags();
2c65512e 1505
496db330
YW		 1506 until = usec_add(now(CLOCK_MONOTONIC), arg_timeout);
1507 if (until == USEC_INFINITY)
7dcda352 1508 until = 0;
260ab287 1509
6131a78b 1510 arg_key_size = (arg_key_size > 0 ? arg_key_size : (256 / 8));
e2d480b9 1511
10fb4e35
JJ		 1512 if (key_file) {
1513 struct stat st;
e2d480b9 1514
10fb4e35
JJ		 1515 /* Ideally we'd do this on the open fd, but since this is just a
1516 * warning it's OK to do this in two steps. */
3f4d56a0
MP		 1517 if (stat(key_file, &st) >= 0 && S_ISREG(st.st_mode) && (st.st_mode & 0005))
1518 log_warning("Key file %s is world-readable. This is not a good idea!", key_file);
e2d480b9
LP		 1519 }
1520
6930d069
LP		 1521 if (!arg_type || STR_IN_SET(arg_type, ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2)) {
1522 r = crypt_load(cd, !arg_type || streq(arg_type, ANY_LUKS) ? CRYPT_LUKS : arg_type, NULL);
ea9a9d49
MB		 1523 if (r < 0)
1524 return log_error_errno(r, "Failed to load LUKS superblock on device %s: %m", crypt_get_device_name(cd));
1525
1526 if (arg_header) {
da2268f9 1527 r = crypt_set_data_device(cd, source);
ea9a9d49 1528 if (r < 0)
da2268f9 1529 return log_error_errno(r, "Failed to set LUKS data device %s: %m", source);
ea9a9d49 1530 }
d90874b4 1531
894bb3ca 1532 /* Tokens are available in LUKS2 only, but it is ok to call (and fail) with LUKS1. */
7407f689 1533 if (!key_file && !key_data) {
da2268f9 1534 r = crypt_activate_by_token(cd, volume, CRYPT_ANY_TOKEN, NULL, flags);
894bb3ca 1535 if (r >= 0) {
da2268f9 1536 log_debug("Volume %s activated with LUKS token id %i.", volume, r);
894bb3ca
MB		 1537 return 0;
1538 }
1539
1540 log_debug_errno(r, "Token activation unsuccessful for device %s: %m", crypt_get_device_name(cd));
1541 }
ea9a9d49
MB		 1542 }
1543
6cc27c29
MF		 1544/* since cryptsetup 2.3.0 (Feb 2020) */
1545#ifdef CRYPT_BITLK
5af39ac8 1546 if (streq_ptr(arg_type, CRYPT_BITLK)) {
6cc27c29
MF		 1547 r = crypt_load(cd, CRYPT_BITLK, NULL);
1548 if (r < 0)
1549 return log_error_errno(r, "Failed to load Bitlocker superblock on device %s: %m", crypt_get_device_name(cd));
1550 }
1551#endif
1552
f75cac37 1553 for (tries = 0; arg_tries == 0 || tries < arg_tries; tries++) {
ab84f5b9 1554 _cleanup_strv_free_erase_ char **passwords = NULL;
260ab287 1555
0ba6f85e
LP		 1556 /* When we were able to acquire multiple keys, let's always process them in this order:
1557 *
18843ecc 1558 * 1. A key acquired via PKCS#11 or FIDO2 token, or TPM2 chip
0ba6f85e
LP		 1559 * 2. The discovered key: i.e. key_data + key_data_size
1560 * 3. The configured key: i.e. key_file + arg_keyfile_offset + arg_keyfile_size
1561 * 4. The empty password, in case arg_try_empty_password is set
1562 * 5. We enquire the user for a password
1563 */
1564
18843ecc 1565 if (!key_file && !key_data && !arg_pkcs11_uri && !arg_pkcs11_uri_auto && !arg_fido2_device && !arg_fido2_device_auto && !arg_tpm2_device && !arg_tpm2_device_auto) {
0ba6f85e
LP		 1566
1567 if (arg_try_empty_password) {
1568 /* Hmm, let's try an empty password now, but only once */
1569 arg_try_empty_password = false;
1570
1571 key_data = strdup("");
1572 if (!key_data)
1573 return log_oom();
1574
1575 key_data_size = 0;
1576 } else {
1577 /* Ask the user for a passphrase only as last resort, if we have
1578 * nothing else to check for */
1579
da2268f9 1580 r = get_password(volume, source, until, tries == 0 && !arg_verify, &passwords);
0ba6f85e
LP		 1581 if (r == -EAGAIN)
1582 continue;
1583 if (r < 0)
1584 return r;
1585 }
260ab287
LP		 1586 }
1587
f75cac37 1588 if (streq_ptr(arg_type, CRYPT_TCRYPT))
da2268f9 1589 r = attach_tcrypt(cd, volume, key_file, key_data, key_data_size, passwords, flags);
8cf3ca80 1590 else
da2268f9 1591 r = attach_luks_or_plain_or_bitlk(cd, volume, key_file, key_data, key_data_size, passwords, flags, until);
5f4bfe56 1592 if (r >= 0)
260ab287 1593 break;
6f177c7d
LP		 1594 if (r != -EAGAIN)
1595 return r;
260ab287 1596
2424fb7e
LP		 1597 /* Key not correct? Let's try again! */
1598
6f177c7d 1599 key_file = NULL;
7407f689
LP		 1600 key_data = erase_and_free(key_data);
1601 key_data_size = 0;
2424fb7e 1602 arg_pkcs11_uri = mfree(arg_pkcs11_uri);
b997d111 1603 arg_pkcs11_uri_auto = false;
2bc5c425
LP		 1604 arg_fido2_device = mfree(arg_fido2_device);
1605 arg_fido2_device_auto = false;
18843ecc
LP		 1606 arg_tpm2_device = mfree(arg_tpm2_device);
1607 arg_tpm2_device_auto = false;
7f4e0805
LP		 1608 }
1609
0ffff81a
LP		 1610 if (arg_tries != 0 && tries >= arg_tries)
1611 return log_error_errno(SYNTHETIC_ERRNO(EPERM), "Too many attempts to activate; giving up.");
7f4e0805 1612
da2268f9
LP		 1613 } else if (streq(verb, "detach")) {
1614 const char *volume;
1615
1616 volume = argv[2];
7f4e0805 1617
da2268f9
LP		 1618 if (!filename_is_valid(volume))
1619 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Volume name '%s' is not valid.", volume);
7407f689 1620
da2268f9 1621 r = crypt_init_by_name(&cd, volume);
5f4bfe56 1622 if (r == -ENODEV) {
da2268f9 1623 log_info("Volume %s already inactive.", volume);
3a40f366 1624 return 0;
7f4e0805 1625 }
3a40f366
YW		 1626 if (r < 0)
1627 return log_error_errno(r, "crypt_init_by_name() failed: %m");
7f4e0805 1628
efc3b12f 1629 cryptsetup_enable_logging(cd);
7f4e0805 1630
da2268f9 1631 r = crypt_deactivate(cd, volume);
3a40f366
YW		 1632 if (r < 0)
1633 return log_error_errno(r, "Failed to deactivate: %m");
e23a0ce8 1634
0ffff81a 1635 } else
da2268f9 1636 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Unknown verb %s.", verb);
e23a0ce8 1637
3a40f366 1638 return 0;
e23a0ce8 1639}
3a40f366
YW		 1640
1641DEFINE_MAIN_FUNCTION(run);
Unnamed repository; edit this file 'description' to name the repository.