src/cryptsetup/cryptsetup.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include <errno.h>
   4 #include <mntent.h>
   5 #include <sys/mman.h>
   6 #include <sys/stat.h>
   7 #include <sys/types.h>
   8 #include <unistd.h>
   9
  10 #include "sd-device.h"
  11
  12 #include "alloc-util.h"
  13 #include "ask-password-api.h"
  14 #include "cryptsetup-fido2.h"
  15 #include "cryptsetup-keyfile.h"
  16 #include "cryptsetup-pkcs11.h"
  17 #include "cryptsetup-tpm2.h"
  18 #include "cryptsetup-util.h"
  19 #include "device-util.h"
  20 #include "efi-api.h"
  21 #include "env-util.h"
  22 #include "escape.h"
  23 #include "fileio.h"
  24 #include "fs-util.h"
  25 #include "fstab-util.h"
  26 #include "hexdecoct.h"
  27 #include "libfido2-util.h"
  28 #include "log.h"
  29 #include "main-func.h"
  30 #include "memory-util.h"
  31 #include "mount-util.h"
  32 #include "nulstr-util.h"
  33 #include "parse-util.h"
  34 #include "path-util.h"
  35 #include "pkcs11-util.h"
  36 #include "pretty-print.h"
  37 #include "random-util.h"
  38 #include "string-util.h"
  39 #include "strv.h"
  40 #include "tpm2-util.h"
  41
  42 /* internal helper */
  43 #define ANY_LUKS "LUKS"
  44 /* as in src/cryptsetup.h */
  45 #define CRYPT_SECTOR_SIZE 512
  46 #define CRYPT_MAX_SECTOR_SIZE 4096
  47
  48 static const char *arg_type = NULL; /* ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2, CRYPT_TCRYPT, CRYPT_BITLK or CRYPT_PLAIN */
  49 static char *arg_cipher = NULL;
  50 static unsigned arg_key_size = 0;
  51 static unsigned arg_sector_size = CRYPT_SECTOR_SIZE;
  52 static int arg_key_slot = CRYPT_ANY_SLOT;
  53 static unsigned arg_keyfile_size = 0;
  54 static uint64_t arg_keyfile_offset = 0;
  55 static bool arg_keyfile_erase = false;
  56 static bool arg_try_empty_password = false;
  57 static char *arg_hash = NULL;
  58 static char *arg_header = NULL;
  59 static unsigned arg_tries = 3;
  60 static bool arg_readonly = false;
  61 static bool arg_verify = false;
  62 static AskPasswordFlags arg_ask_password_flags = 0;
  63 static bool arg_discards = false;
  64 static bool arg_same_cpu_crypt = false;
  65 static bool arg_submit_from_crypt_cpus = false;
  66 static bool arg_no_read_workqueue = false;
  67 static bool arg_no_write_workqueue = false;
  68 static bool arg_tcrypt_hidden = false;
  69 static bool arg_tcrypt_system = false;
  70 static bool arg_tcrypt_veracrypt = false;
  71 static char **arg_tcrypt_keyfiles = NULL;
  72 static uint64_t arg_offset = 0;
  73 static uint64_t arg_skip = 0;
  74 static usec_t arg_timeout = USEC_INFINITY;
  75 static char *arg_pkcs11_uri = NULL;
  76 static bool arg_pkcs11_uri_auto = false;
  77 static char *arg_fido2_device = NULL;
  78 static bool arg_fido2_device_auto = false;
  79 static void *arg_fido2_cid = NULL;
  80 static size_t arg_fido2_cid_size = 0;
  81 static char *arg_fido2_rp_id = NULL;
  82 static char *arg_tpm2_device = NULL;
  83 static bool arg_tpm2_device_auto = false;
  84 static uint32_t arg_tpm2_pcr_mask = UINT32_MAX;
  85 static bool arg_tpm2_pin = false;
  86 static bool arg_headless = false;
  87 static usec_t arg_token_timeout_usec = 30*USEC_PER_SEC;
  88
  89 STATIC_DESTRUCTOR_REGISTER(arg_cipher, freep);
  90 STATIC_DESTRUCTOR_REGISTER(arg_hash, freep);
  91 STATIC_DESTRUCTOR_REGISTER(arg_header, freep);
  92 STATIC_DESTRUCTOR_REGISTER(arg_tcrypt_keyfiles, strv_freep);
  93 STATIC_DESTRUCTOR_REGISTER(arg_pkcs11_uri, freep);
  94 STATIC_DESTRUCTOR_REGISTER(arg_fido2_device, freep);
  95 STATIC_DESTRUCTOR_REGISTER(arg_fido2_cid, freep);
  96 STATIC_DESTRUCTOR_REGISTER(arg_fido2_rp_id, freep);
  97 STATIC_DESTRUCTOR_REGISTER(arg_tpm2_device, freep);
  98
  99 /* Options Debian's crypttab knows we don't:
 100
 101     check=
 102     checkargs=
 103     noearly
 104     loud
 105     quiet
 106     keyscript=
 107     initramfs
 108 */
 109
 110 static int parse_one_option(const char *option) {
 111         const char *val;
 112         int r;
 113
 114         assert(option);
 115
 116         /* Handled outside of this tool */
 117         if (STR_IN_SET(option, "noauto", "auto", "nofail", "fail", "_netdev", "keyfile-timeout"))
 118                 return 0;
 119
 120         if (startswith(option, "keyfile-timeout="))
 121                 return 0;
 122
 123         if ((val = startswith(option, "cipher="))) {
 124                 r = free_and_strdup(&arg_cipher, val);
 125                 if (r < 0)
 126                         return log_oom();
 127
 128         } else if ((val = startswith(option, "size="))) {
 129
 130                 r = safe_atou(val, &arg_key_size);
 131                 if (r < 0) {
 132                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 133                         return 0;
 134                 }
 135
 136                 if (arg_key_size % 8) {
 137                         log_error("size= not a multiple of 8, ignoring.");
 138                         return 0;
 139                 }
 140
 141                 arg_key_size /= 8;
 142
 143         } else if ((val = startswith(option, "sector-size="))) {
 144
 145                 r = safe_atou(val, &arg_sector_size);
 146                 if (r < 0) {
 147                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 148                         return 0;
 149                 }
 150
 151                 if (arg_sector_size % 2) {
 152                         log_error("sector-size= not a multiple of 2, ignoring.");
 153                         return 0;
 154                 }
 155
 156                 if (arg_sector_size < CRYPT_SECTOR_SIZE || arg_sector_size > CRYPT_MAX_SECTOR_SIZE) {
 157                         log_error("sector-size= is outside of %u and %u, ignoring.", CRYPT_SECTOR_SIZE, CRYPT_MAX_SECTOR_SIZE);
 158                         return 0;
 159                 }
 160
 161         } else if ((val = startswith(option, "key-slot=")) ||
 162                    (val = startswith(option, "keyslot="))) {
 163
 164                 arg_type = ANY_LUKS;
 165                 r = safe_atoi(val, &arg_key_slot);
 166                 if (r < 0) {
 167                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 168                         return 0;
 169                 }
 170
 171         } else if ((val = startswith(option, "tcrypt-keyfile="))) {
 172
 173                 arg_type = CRYPT_TCRYPT;
 174                 if (path_is_absolute(val)) {
 175                         if (strv_extend(&arg_tcrypt_keyfiles, val) < 0)
 176                                 return log_oom();
 177                 } else
 178                         log_error("Key file path \"%s\" is not absolute. Ignoring.", val);
 179
 180         } else if ((val = startswith(option, "keyfile-size="))) {
 181
 182                 r = safe_atou(val, &arg_keyfile_size);
 183                 if (r < 0) {
 184                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 185                         return 0;
 186                 }
 187
 188         } else if ((val = startswith(option, "keyfile-offset="))) {
 189
 190                 r = safe_atou64(val, &arg_keyfile_offset);
 191                 if (r < 0) {
 192                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 193                         return 0;
 194                 }
 195
 196         } else if ((val = startswith(option, "keyfile-erase="))) {
 197
 198                 r = parse_boolean(val);
 199                 if (r < 0) {
 200                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 201                         return 0;
 202                 }
 203
 204                 arg_keyfile_erase = r;
 205
 206         } else if (streq(option, "keyfile-erase"))
 207                 arg_keyfile_erase = true;
 208
 209         else if ((val = startswith(option, "hash="))) {
 210                 r = free_and_strdup(&arg_hash, val);
 211                 if (r < 0)
 212                         return log_oom();
 213
 214         } else if ((val = startswith(option, "header="))) {
 215                 arg_type = ANY_LUKS;
 216
 217                 if (!path_is_absolute(val))
 218                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 219                                                "Header path \"%s\" is not absolute, refusing.", val);
 220
 221                 if (arg_header)
 222                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 223                                                "Duplicate header= option, refusing.");
 224
 225                 arg_header = strdup(val);
 226                 if (!arg_header)
 227                         return log_oom();
 228
 229         } else if ((val = startswith(option, "tries="))) {
 230
 231                 r = safe_atou(val, &arg_tries);
 232                 if (r < 0) {
 233                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 234                         return 0;
 235                 }
 236
 237         } else if (STR_IN_SET(option, "readonly", "read-only"))
 238                 arg_readonly = true;
 239         else if (streq(option, "verify"))
 240                 arg_verify = true;
 241         else if ((val = startswith(option, "password-echo="))) {
 242                 if (streq(val, "masked"))
 243                         arg_ask_password_flags &= ~(ASK_PASSWORD_ECHO|ASK_PASSWORD_SILENT);
 244                 else {
 245                         r = parse_boolean(val);
 246                         if (r < 0) {
 247                                 log_warning_errno(r, "Invalid password-echo= option \"%s\", ignoring.", val);
 248                                 return 0;
 249                         }
 250
 251                         SET_FLAG(arg_ask_password_flags, ASK_PASSWORD_ECHO, r);
 252                         SET_FLAG(arg_ask_password_flags, ASK_PASSWORD_SILENT, !r);
 253                 }
 254         } else if (STR_IN_SET(option, "allow-discards", "discard"))
 255                 arg_discards = true;
 256         else if (streq(option, "same-cpu-crypt"))
 257                 arg_same_cpu_crypt = true;
 258         else if (streq(option, "submit-from-crypt-cpus"))
 259                 arg_submit_from_crypt_cpus = true;
 260         else if (streq(option, "no-read-workqueue"))
 261                 arg_no_read_workqueue = true;
 262         else if (streq(option, "no-write-workqueue"))
 263                 arg_no_write_workqueue = true;
 264         else if (streq(option, "luks"))
 265                 arg_type = ANY_LUKS;
 266 /* since cryptsetup 2.3.0 (Feb 2020) */
 267 #ifdef CRYPT_BITLK
 268         else if (streq(option, "bitlk"))
 269                 arg_type = CRYPT_BITLK;
 270 #endif
 271         else if (streq(option, "tcrypt"))
 272                 arg_type = CRYPT_TCRYPT;
 273         else if (STR_IN_SET(option, "tcrypt-hidden", "tcrypthidden")) {
 274                 arg_type = CRYPT_TCRYPT;
 275                 arg_tcrypt_hidden = true;
 276         } else if (streq(option, "tcrypt-system")) {
 277                 arg_type = CRYPT_TCRYPT;
 278                 arg_tcrypt_system = true;
 279         } else if (STR_IN_SET(option, "tcrypt-veracrypt", "veracrypt")) {
 280                 arg_type = CRYPT_TCRYPT;
 281                 arg_tcrypt_veracrypt = true;
 282         } else if (STR_IN_SET(option, "plain", "swap", "tmp") ||
 283                    startswith(option, "tmp="))
 284                 arg_type = CRYPT_PLAIN;
 285         else if ((val = startswith(option, "timeout="))) {
 286
 287                 r = parse_sec_fix_0(val, &arg_timeout);
 288                 if (r < 0) {
 289                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 290                         return 0;
 291                 }
 292
 293         } else if ((val = startswith(option, "offset="))) {
 294
 295                 r = safe_atou64(val, &arg_offset);
 296                 if (r < 0)
 297                         return log_error_errno(r, "Failed to parse %s: %m", option);
 298
 299         } else if ((val = startswith(option, "skip="))) {
 300
 301                 r = safe_atou64(val, &arg_skip);
 302                 if (r < 0)
 303                         return log_error_errno(r, "Failed to parse %s: %m", option);
 304
 305         } else if ((val = startswith(option, "pkcs11-uri="))) {
 306
 307                 if (streq(val, "auto")) {
 308                         arg_pkcs11_uri = mfree(arg_pkcs11_uri);
 309                         arg_pkcs11_uri_auto = true;
 310                 } else {
 311                         if (!pkcs11_uri_valid(val))
 312                                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "pkcs11-uri= parameter expects a PKCS#11 URI, refusing");
 313
 314                         r = free_and_strdup(&arg_pkcs11_uri, val);
 315                         if (r < 0)
 316                                 return log_oom();
 317
 318                         arg_pkcs11_uri_auto = false;
 319                 }
 320
 321         } else if ((val = startswith(option, "fido2-device="))) {
 322
 323                 if (streq(val, "auto")) {
 324                         arg_fido2_device = mfree(arg_fido2_device);
 325                         arg_fido2_device_auto = true;
 326                 } else {
 327                         r = free_and_strdup(&arg_fido2_device, val);
 328                         if (r < 0)
 329                                 return log_oom();
 330
 331                         arg_fido2_device_auto = false;
 332                 }
 333
 334         } else if ((val = startswith(option, "fido2-cid="))) {
 335
 336                 if (streq(val, "auto"))
 337                         arg_fido2_cid = mfree(arg_fido2_cid);
 338                 else {
 339                         _cleanup_free_ void *cid = NULL;
 340                         size_t cid_size;
 341
 342                         r = unbase64mem(val, SIZE_MAX, &cid, &cid_size);
 343                         if (r < 0)
 344                                 return log_error_errno(r, "Failed to decode FIDO2 CID data: %m");
 345
 346                         free(arg_fido2_cid);
 347                         arg_fido2_cid = TAKE_PTR(cid);
 348                         arg_fido2_cid_size = cid_size;
 349                 }
 350
 351                 /* Turn on FIDO2 as side-effect, if not turned on yet. */
 352                 if (!arg_fido2_device && !arg_fido2_device_auto)
 353                         arg_fido2_device_auto = true;
 354
 355         } else if ((val = startswith(option, "fido2-rp="))) {
 356
 357                 r = free_and_strdup(&arg_fido2_rp_id, val);
 358                 if (r < 0)
 359                         return log_oom();
 360
 361         } else if ((val = startswith(option, "tpm2-device="))) {
 362
 363                 if (streq(val, "auto")) {
 364                         arg_tpm2_device = mfree(arg_tpm2_device);
 365                         arg_tpm2_device_auto = true;
 366                 } else {
 367                         r = free_and_strdup(&arg_tpm2_device, val);
 368                         if (r < 0)
 369                                 return log_oom();
 370
 371                         arg_tpm2_device_auto = false;
 372                 }
 373
 374         } else if ((val = startswith(option, "tpm2-pcrs="))) {
 375
 376                 if (isempty(val))
 377                         arg_tpm2_pcr_mask = 0;
 378                 else {
 379                         uint32_t mask;
 380
 381                         r = tpm2_parse_pcrs(val, &mask);
 382                         if (r < 0)
 383                                 return r;
 384
 385                         if (arg_tpm2_pcr_mask == UINT32_MAX)
 386                                 arg_tpm2_pcr_mask = mask;
 387                         else
 388                                 arg_tpm2_pcr_mask |= mask;
 389                 }
 390
 391         } else if ((val = startswith(option, "tpm2-pin="))) {
 392
 393                 r = parse_boolean(val);
 394                 if (r < 0) {
 395                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 396                         return 0;
 397                 }
 398
 399                 arg_tpm2_pin = r;
 400
 401         } else if ((val = startswith(option, "try-empty-password="))) {
 402
 403                 r = parse_boolean(val);
 404                 if (r < 0) {
 405                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 406                         return 0;
 407                 }
 408
 409                 arg_try_empty_password = r;
 410
 411         } else if (streq(option, "try-empty-password"))
 412                 arg_try_empty_password = true;
 413         else if ((val = startswith(option, "headless="))) {
 414
 415                 r = parse_boolean(val);
 416                 if (r < 0) {
 417                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 418                         return 0;
 419                 }
 420
 421                 arg_headless = r;
 422         } else if (streq(option, "headless"))
 423                 arg_headless = true;
 424
 425         else if ((val = startswith(option, "token-timeout="))) {
 426
 427                 r = parse_sec_fix_0(val, &arg_token_timeout_usec);
 428                 if (r < 0) {
 429                         log_error_errno(r, "Failed to parse %s, ignoring: %m", option);
 430                         return 0;
 431                 }
 432
 433         } else if (!streq(option, "x-initrd.attach"))
 434                 log_warning("Encountered unknown /etc/crypttab option '%s', ignoring.", option);
 435
 436         return 0;
 437 }
 438
 439 static int parse_options(const char *options) {
 440         assert(options);
 441
 442         for (;;) {
 443                 _cleanup_free_ char *word = NULL;
 444                 int r;
 445
 446                 r = extract_first_word(&options, &word, ",", EXTRACT_DONT_COALESCE_SEPARATORS | EXTRACT_UNESCAPE_SEPARATORS);
 447                 if (r < 0)
 448                         return log_error_errno(r, "Failed to parse options: %m");
 449                 if (r == 0)
 450                         break;
 451
 452                 r = parse_one_option(word);
 453                 if (r < 0)
 454                         return r;
 455         }
 456
 457         /* sanity-check options */
 458         if (arg_type && !streq(arg_type, CRYPT_PLAIN)) {
 459                 if (arg_offset != 0)
 460                       log_warning("offset= ignored with type %s", arg_type);
 461                 if (arg_skip != 0)
 462                       log_warning("skip= ignored with type %s", arg_type);
 463         }
 464
 465         return 0;
 466 }
 467
 468 static char* disk_description(const char *path) {
 469         static const char name_fields[] =
 470                 "DM_NAME\0"
 471                 "ID_MODEL_FROM_DATABASE\0"
 472                 "ID_MODEL\0";
 473
 474         _cleanup_(sd_device_unrefp) sd_device *device = NULL;
 475         const char *i, *name;
 476         struct stat st;
 477
 478         assert(path);
 479
 480         if (stat(path, &st) < 0)
 481                 return NULL;
 482
 483         if (!S_ISBLK(st.st_mode))
 484                 return NULL;
 485
 486         if (sd_device_new_from_stat_rdev(&device, &st) < 0)
 487                 return NULL;
 488
 489         if (sd_device_get_property_value(device, "ID_PART_ENTRY_NAME", &name) >= 0) {
 490                 _cleanup_free_ char *unescaped = NULL;
 491                 ssize_t l;
 492
 493                 /* ID_PART_ENTRY_NAME uses \x style escaping, using libblkid's blkid_encode_string(). Let's
 494                  * reverse this here to make the string more human friendly in case people embed spaces or
 495                  * other weird stuff. */
 496
 497                 l = cunescape(name, UNESCAPE_RELAX, &unescaped);
 498                 if (l < 0) {
 499                         log_debug_errno(l, "Failed to unescape ID_PART_ENTRY_NAME, skipping device: %m");
 500                         return NULL;
 501                 }
 502
 503                 if (!isempty(unescaped) && !string_has_cc(unescaped, NULL))
 504                         return TAKE_PTR(unescaped);
 505         }
 506
 507         /* These need no unescaping. */
 508         NULSTR_FOREACH(i, name_fields)
 509                 if (sd_device_get_property_value(device, i, &name) >= 0 &&
 510                     !isempty(name))
 511                         return strdup(name);
 512
 513         return NULL;
 514 }
 515
 516 static char *disk_mount_point(const char *label) {
 517         _cleanup_free_ char *device = NULL;
 518         _cleanup_endmntent_ FILE *f = NULL;
 519         struct mntent *m;
 520
 521         /* Yeah, we don't support native systemd unit files here for now */
 522
 523         device = strjoin("/dev/mapper/", label);
 524         if (!device)
 525                 return NULL;
 526
 527         f = setmntent(fstab_path(), "re");
 528         if (!f)
 529                 return NULL;
 530
 531         while ((m = getmntent(f)))
 532                 if (path_equal(m->mnt_fsname, device))
 533                         return strdup(m->mnt_dir);
 534
 535         return NULL;
 536 }
 537
 538 static char *friendly_disk_name(const char *src, const char *vol) {
 539         _cleanup_free_ char *description = NULL, *mount_point = NULL;
 540         char *name_buffer = NULL;
 541         int r;
 542
 543         assert(src);
 544         assert(vol);
 545
 546         description = disk_description(src);
 547         mount_point = disk_mount_point(vol);
 548
 549         /* If the description string is simply the volume name, then let's not show this twice */
 550         if (description && streq(vol, description))
 551                 description = mfree(description);
 552
 553         if (mount_point && description)
 554                 r = asprintf(&name_buffer, "%s (%s) on %s", description, vol, mount_point);
 555         else if (mount_point)
 556                 r = asprintf(&name_buffer, "%s on %s", vol, mount_point);
 557         else if (description)
 558                 r = asprintf(&name_buffer, "%s (%s)", description, vol);
 559         else
 560                 return strdup(vol);
 561         if (r < 0)
 562                 return NULL;
 563
 564         return name_buffer;
 565 }
 566
 567 static int get_password(
 568                 const char *vol,
 569                 const char *src,
 570                 usec_t until,
 571                 bool accept_cached,
 572                 char ***ret) {
 573
 574         _cleanup_free_ char *friendly = NULL, *text = NULL, *disk_path = NULL;
 575         _cleanup_strv_free_erase_ char **passwords = NULL;
 576         char *id;
 577         int r = 0;
 578         AskPasswordFlags flags = arg_ask_password_flags | ASK_PASSWORD_PUSH_CACHE;
 579
 580         assert(vol);
 581         assert(src);
 582         assert(ret);
 583
 584         if (arg_headless)
 585                 return log_error_errno(SYNTHETIC_ERRNO(ENOPKG), "Password querying disabled via 'headless' option.");
 586
 587         friendly = friendly_disk_name(src, vol);
 588         if (!friendly)
 589                 return log_oom();
 590
 591         if (asprintf(&text, "Please enter passphrase for disk %s:", friendly) < 0)
 592                 return log_oom();
 593
 594         disk_path = cescape(src);
 595         if (!disk_path)
 596                 return log_oom();
 597
 598         id = strjoina("cryptsetup:", disk_path);
 599
 600         r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", "cryptsetup.passphrase", until,
 601                               flags | (accept_cached*ASK_PASSWORD_ACCEPT_CACHED),
 602                               &passwords);
 603         if (r < 0)
 604                 return log_error_errno(r, "Failed to query password: %m");
 605
 606         if (arg_verify) {
 607                 _cleanup_strv_free_erase_ char **passwords2 = NULL;
 608
 609                 assert(strv_length(passwords) == 1);
 610
 611                 if (asprintf(&text, "Please enter passphrase for disk %s (verification):", friendly) < 0)
 612                         return log_oom();
 613
 614                 id = strjoina("cryptsetup-verification:", disk_path);
 615
 616                 r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", "cryptsetup.passphrase", until, flags, &passwords2);
 617                 if (r < 0)
 618                         return log_error_errno(r, "Failed to query verification password: %m");
 619
 620                 assert(strv_length(passwords2) == 1);
 621
 622                 if (!streq(passwords[0], passwords2[0]))
 623                         return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN),
 624                                                  "Passwords did not match, retrying.");
 625         }
 626
 627         strv_uniq(passwords);
 628
 629         STRV_FOREACH(p, passwords) {
 630                 char *c;
 631
 632                 if (strlen(*p)+1 >= arg_key_size)
 633                         continue;
 634
 635                 /* Pad password if necessary */
 636                 c = new(char, arg_key_size);
 637                 if (!c)
 638                         return log_oom();
 639
 640                 strncpy(c, *p, arg_key_size);
 641                 erase_and_free(*p);
 642                 *p = TAKE_PTR(c);
 643         }
 644
 645         *ret = TAKE_PTR(passwords);
 646
 647         return 0;
 648 }
 649
 650 static int attach_tcrypt(
 651                 struct crypt_device *cd,
 652                 const char *name,
 653                 const char *key_file,
 654                 const void *key_data,
 655                 size_t key_data_size,
 656                 char **passwords,
 657                 uint32_t flags) {
 658
 659         int r = 0;
 660         _cleanup_(erase_and_freep) char *passphrase = NULL;
 661         struct crypt_params_tcrypt params = {
 662                 .flags = CRYPT_TCRYPT_LEGACY_MODES,
 663                 .keyfiles = (const char **)arg_tcrypt_keyfiles,
 664                 .keyfiles_count = strv_length(arg_tcrypt_keyfiles)
 665         };
 666
 667         assert(cd);
 668         assert(name);
 669         assert(key_file || key_data || !strv_isempty(passwords));
 670
 671         if (arg_pkcs11_uri || arg_pkcs11_uri_auto || arg_fido2_device || arg_fido2_device_auto || arg_tpm2_device || arg_tpm2_device_auto)
 672                 /* Ask for a regular password */
 673                 return log_error_errno(SYNTHETIC_ERRNO(EAGAIN),
 674                                        "Sorry, but tcrypt devices are currently not supported in conjunction with pkcs11/fido2/tpm2 support.");
 675
 676         if (arg_tcrypt_hidden)
 677                 params.flags |= CRYPT_TCRYPT_HIDDEN_HEADER;
 678
 679         if (arg_tcrypt_system)
 680                 params.flags |= CRYPT_TCRYPT_SYSTEM_HEADER;
 681
 682         if (arg_tcrypt_veracrypt)
 683                 params.flags |= CRYPT_TCRYPT_VERA_MODES;
 684
 685         if (key_data) {
 686                 params.passphrase = key_data;
 687                 params.passphrase_size = key_data_size;
 688         } else {
 689                 if (key_file) {
 690                         r = read_one_line_file(key_file, &passphrase);
 691                         if (r < 0) {
 692                                 log_error_errno(r, "Failed to read password file '%s': %m", key_file);
 693                                 return -EAGAIN; /* log with the actual error, but return EAGAIN */
 694                         }
 695
 696                         params.passphrase = passphrase;
 697                 } else
 698                         params.passphrase = passwords[0];
 699
 700                 params.passphrase_size = strlen(params.passphrase);
 701         }
 702
 703         r = crypt_load(cd, CRYPT_TCRYPT, &params);
 704         if (r < 0) {
 705                 if (r == -EPERM) {
 706                         if (key_data)
 707                                 log_error_errno(r, "Failed to activate using discovered key. (Key not correct?)");
 708
 709                         if (key_file)
 710                                 log_error_errno(r, "Failed to activate using password file '%s'. (Key data not correct?)", key_file);
 711
 712                         return -EAGAIN; /* log the actual error, but return EAGAIN */
 713                 }
 714
 715                 return log_error_errno(r, "Failed to load tcrypt superblock on device %s: %m", crypt_get_device_name(cd));
 716         }
 717
 718         r = crypt_activate_by_volume_key(cd, name, NULL, 0, flags);
 719         if (r < 0)
 720                 return log_error_errno(r, "Failed to activate tcrypt device %s: %m", crypt_get_device_name(cd));
 721
 722         return 0;
 723 }
 724
 725 static char *make_bindname(const char *volume) {
 726         char *s;
 727
 728         if (asprintf(&s, "@%" PRIx64"/cryptsetup/%s", random_u64(), volume) < 0)
 729                 return NULL;
 730
 731         return s;
 732 }
 733
 734 static int make_security_device_monitor(
 735                 sd_event **ret_event,
 736                 sd_device_monitor **ret_monitor) {
 737         _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
 738         _cleanup_(sd_event_unrefp) sd_event *event = NULL;
 739         int r;
 740
 741         assert(ret_event);
 742         assert(ret_monitor);
 743
 744         /* Waits for a device with "security-device" tag to show up in udev */
 745
 746         r = sd_event_default(&event);
 747         if (r < 0)
 748                 return log_error_errno(r, "Failed to allocate event loop: %m");
 749
 750         r = sd_event_add_time_relative(event, NULL, CLOCK_MONOTONIC, arg_token_timeout_usec, USEC_PER_SEC, NULL, INT_TO_PTR(-ETIMEDOUT));
 751         if (r < 0)
 752                 return log_error_errno(r, "Failed to install timeout event source: %m");
 753
 754         r = sd_device_monitor_new(&monitor);
 755         if (r < 0)
 756                 return log_error_errno(r, "Failed to allocate device monitor: %m");
 757
 758         r = sd_device_monitor_filter_add_match_tag(monitor, "security-device");
 759         if (r < 0)
 760                 return log_error_errno(r, "Failed to configure device monitor: %m");
 761
 762         r = sd_device_monitor_attach_event(monitor, event);
 763         if (r < 0)
 764                 return log_error_errno(r, "Failed to attach device monitor: %m");
 765
 766         r = sd_device_monitor_start(monitor, NULL, NULL);
 767         if (r < 0)
 768                 return log_error_errno(r, "Failed to start device monitor: %m");
 769
 770         *ret_event = TAKE_PTR(event);
 771         *ret_monitor = TAKE_PTR(monitor);
 772         return 0;
 773 }
 774
 775 static int run_security_device_monitor(
 776                 sd_event *event,
 777                 sd_device_monitor *monitor) {
 778         bool processed = false;
 779         int r;
 780
 781         assert(event);
 782         assert(monitor);
 783
 784         /* Runs the event loop for the device monitor until either something happens, or the time-out is
 785          * hit. */
 786
 787         for (;;) {
 788                 int x;
 789
 790                 r = sd_event_get_exit_code(event, &x);
 791                 if (r < 0) {
 792                         if (r != -ENODATA)
 793                                 return log_error_errno(r, "Failed to query exit code from event loop: %m");
 794
 795                         /* On ENODATA we aren't told to exit yet. */
 796                 } else {
 797                         assert(x == -ETIMEDOUT);
 798                         return log_notice_errno(SYNTHETIC_ERRNO(EAGAIN),
 799                                                 "Timed out waiting for security device, aborting security device based authentication attempt.");
 800                 }
 801
 802                 /* Wait for one event, and then eat all subsequent events until there are no further ones */
 803                 r = sd_event_run(event, processed ? 0 : UINT64_MAX);
 804                 if (r < 0)
 805                         return log_error_errno(r, "Failed to run event loop: %m");
 806                 if (r == 0) /* no events queued anymore */
 807                         return 0;
 808
 809                 processed = true;
 810         }
 811 }
 812
 813 static bool libcryptsetup_plugins_support(void) {
 814 #if HAVE_LIBCRYPTSETUP_PLUGINS
 815         int r;
 816
 817         /* Permit a way to disable libcryptsetup token module support, for debugging purposes. */
 818         r = getenv_bool("SYSTEMD_CRYPTSETUP_USE_TOKEN_MODULE");
 819         if (r < 0 && r != -ENXIO)
 820                 log_debug_errno(r, "Failed to parse $SYSTEMD_CRYPTSETUP_USE_TOKEN_MODULE env var: %m");
 821         if (r == 0)
 822                 return false;
 823
 824         return crypt_token_external_path();
 825 #else
 826         return false;
 827 #endif
 828 }
 829
 830 #if HAVE_LIBCRYPTSETUP_PLUGINS
 831 static int acquire_pins_from_env_variable(char ***ret_pins) {
 832         _cleanup_(erase_and_freep) char *envpin = NULL;
 833         _cleanup_strv_free_erase_ char **pins = NULL;
 834         int r;
 835
 836         assert(ret_pins);
 837
 838         r = getenv_steal_erase("PIN", &envpin);
 839         if (r < 0)
 840                 return log_error_errno(r, "Failed to acquire PIN from environment: %m");
 841         if (r > 0) {
 842                 pins = strv_new(envpin);
 843                 if (!pins)
 844                         return log_oom();
 845         }
 846
 847         *ret_pins = TAKE_PTR(pins);
 848
 849         return 0;
 850 }
 851 #endif
 852
 853 static int attach_luks2_by_fido2(
 854                 struct crypt_device *cd,
 855                 const char *name,
 856                 usec_t until,
 857                 bool headless,
 858                 void *usrptr,
 859                 uint32_t activation_flags) {
 860
 861 #if HAVE_LIBCRYPTSETUP_PLUGINS
 862         AskPasswordFlags flags = ASK_PASSWORD_PUSH_CACHE | ASK_PASSWORD_ACCEPT_CACHED;
 863         _cleanup_strv_free_erase_ char **pins = NULL;
 864         int r;
 865
 866         r = crypt_activate_by_token_pin(cd, name, "systemd-fido2", CRYPT_ANY_TOKEN, NULL, 0, usrptr, activation_flags);
 867         if (r > 0) /* returns unlocked keyslot id on success */
 868                 r = 0;
 869         if (r != -ENOANO) /* needs pin or pin is wrong */
 870                 return r;
 871
 872         r = acquire_pins_from_env_variable(&pins);
 873         if (r < 0)
 874                 return r;
 875
 876         STRV_FOREACH(p, pins) {
 877                 r = crypt_activate_by_token_pin(cd, name, "systemd-fido2", CRYPT_ANY_TOKEN, *p, strlen(*p), usrptr, activation_flags);
 878                 if (r > 0) /* returns unlocked keyslot id on success */
 879                         r = 0;
 880                 if (r != -ENOANO) /* needs pin or pin is wrong */
 881                         return r;
 882         }
 883
 884         if (headless)
 885                 return log_error_errno(SYNTHETIC_ERRNO(ENOPKG), "PIN querying disabled via 'headless' option. Use the '$PIN' environment variable.");
 886
 887         for (;;) {
 888                 pins = strv_free_erase(pins);
 889                 r = ask_password_auto("Please enter security token PIN:", "drive-harddisk", NULL, "fido2-pin", "cryptsetup.fido2-pin", until, flags, &pins);
 890                 if (r < 0)
 891                         return r;
 892
 893                 STRV_FOREACH(p, pins) {
 894                         r = crypt_activate_by_token_pin(cd, name, "systemd-fido2", CRYPT_ANY_TOKEN, *p, strlen(*p), usrptr, activation_flags);
 895                         if (r > 0) /* returns unlocked keyslot id on success */
 896                                 r = 0;
 897                         if (r != -ENOANO) /* needs pin or pin is wrong */
 898                                 return r;
 899                 }
 900
 901                 flags &= ~ASK_PASSWORD_ACCEPT_CACHED;
 902         }
 903         return r;
 904 #else
 905         return -EOPNOTSUPP;
 906 #endif
 907 }
 908
 909 static int attach_luks_or_plain_or_bitlk_by_fido2(
 910                 struct crypt_device *cd,
 911                 const char *name,
 912                 const char *key_file,
 913                 const void *key_data,
 914                 size_t key_data_size,
 915                 usec_t until,
 916                 uint32_t flags,
 917                 bool pass_volume_key) {
 918
 919         _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
 920         _cleanup_(erase_and_freep) void *decrypted_key = NULL;
 921         _cleanup_(sd_event_unrefp) sd_event *event = NULL;
 922         _cleanup_free_ void *discovered_salt = NULL, *discovered_cid = NULL;
 923         size_t discovered_salt_size, discovered_cid_size, decrypted_key_size, cid_size = 0;
 924         _cleanup_free_ char *friendly = NULL, *discovered_rp_id = NULL;
 925         int keyslot = arg_key_slot, r;
 926         const char *rp_id = NULL;
 927         const void *cid = NULL;
 928         Fido2EnrollFlags required;
 929         bool use_libcryptsetup_plugin = libcryptsetup_plugins_support();
 930
 931         assert(cd);
 932         assert(name);
 933         assert(arg_fido2_device || arg_fido2_device_auto);
 934
 935         if (arg_fido2_cid) {
 936                 if (!key_file && !key_data)
 937                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 938                                                "FIDO2 mode with manual parameters selected, but no keyfile specified, refusing.");
 939
 940                 rp_id = arg_fido2_rp_id;
 941                 cid = arg_fido2_cid;
 942                 cid_size = arg_fido2_cid_size;
 943
 944                 /* For now and for compatibility, if the user explicitly configured FIDO2 support and we do
 945                  * not read FIDO2 metadata off the LUKS2 header, default to the systemd 248 logic, where we
 946                  * use PIN + UP when needed, and do not configure UV at all. Eventually, we should make this
 947                  * explicitly configurable. */
 948                 required = FIDO2ENROLL_PIN_IF_NEEDED | FIDO2ENROLL_UP_IF_NEEDED | FIDO2ENROLL_UV_OMIT;
 949         } else if (!use_libcryptsetup_plugin) {
 950                 r = find_fido2_auto_data(
 951                                 cd,
 952                                 &discovered_rp_id,
 953                                 &discovered_salt,
 954                                 &discovered_salt_size,
 955                                 &discovered_cid,
 956                                 &discovered_cid_size,
 957                                 &keyslot,
 958                                 &required);
 959
 960                 if (IN_SET(r, -ENOTUNIQ, -ENXIO))
 961                         return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
 962                                                "Automatic FIDO2 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking.");
 963                 if (r < 0)
 964                         return r;
 965
 966                 if ((required & (FIDO2ENROLL_PIN | FIDO2ENROLL_UP | FIDO2ENROLL_UV)) && arg_headless)
 967                         return log_error_errno(SYNTHETIC_ERRNO(ENOPKG),
 968                                                "Local verification is required to unlock this volume, but the 'headless' parameter was set.");
 969
 970                 rp_id = discovered_rp_id;
 971                 key_data = discovered_salt;
 972                 key_data_size = discovered_salt_size;
 973                 cid = discovered_cid;
 974                 cid_size = discovered_cid_size;
 975         }
 976
 977         friendly = friendly_disk_name(crypt_get_device_name(cd), name);
 978         if (!friendly)
 979                 return log_oom();
 980
 981         for (;;) {
 982                 if (use_libcryptsetup_plugin && !arg_fido2_cid) {
 983                         r = attach_luks2_by_fido2(cd, name, until, arg_headless, arg_fido2_device, flags);
 984                         if (IN_SET(r, -ENOTUNIQ, -ENXIO, -ENOENT))
 985                                 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
 986                                                        "Automatic FIDO2 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking.");
 987
 988                 } else {
 989                         r = acquire_fido2_key(
 990                                         name,
 991                                         friendly,
 992                                         arg_fido2_device,
 993                                         rp_id,
 994                                         cid, cid_size,
 995                                         key_file, arg_keyfile_size, arg_keyfile_offset,
 996                                         key_data, key_data_size,
 997                                         until,
 998                                         arg_headless,
 999                                         required,
1000                                         &decrypted_key, &decrypted_key_size,
1001                                         arg_ask_password_flags);
1002                         if (r >= 0)
1003                                 break;
1004                 }
1005
1006                 if (r != -EAGAIN) /* EAGAIN means: token not found */
1007                         return r;
1008
1009                 if (!monitor) {
1010                         /* We didn't find the token. In this case, watch for it via udev. Let's
1011                          * create an event loop and monitor first. */
1012
1013                         assert(!event);
1014
1015                         r = make_security_device_monitor(&event, &monitor);
1016                         if (r < 0)
1017                                 return r;
1018
1019                         log_notice("Security token not present for unlocking volume %s, please plug it in.", friendly);
1020
1021                         /* Let's immediately rescan in case the token appeared in the time we needed
1022                          * to create and configure the monitor */
1023                         continue;
1024                 }
1025
1026                 r = run_security_device_monitor(event, monitor);
1027                 if (r < 0)
1028                         return r;
1029
1030                 log_debug("Got one or more potentially relevant udev events, rescanning FIDO2...");
1031         }
1032
1033         if (pass_volume_key)
1034                 r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags);
1035         else {
1036                 _cleanup_(erase_and_freep) char *base64_encoded = NULL;
1037
1038                 /* Before using this key as passphrase we base64 encode it, for compat with homed */
1039
1040                 r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded);
1041                 if (r < 0)
1042                         return log_oom();
1043
1044                 r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags);
1045         }
1046         if (r == -EPERM) {
1047                 log_error_errno(r, "Failed to activate with FIDO2 decrypted key. (Key incorrect?)");
1048                 return -EAGAIN; /* log actual error, but return EAGAIN */
1049         }
1050         if (r < 0)
1051                 return log_error_errno(r, "Failed to activate with FIDO2 acquired key: %m");
1052
1053         return 0;
1054 }
1055
1056 static int attach_luks2_by_pkcs11(
1057                 struct crypt_device *cd,
1058                 const char *name,
1059                 const char *friendly_name,
1060                 usec_t until,
1061                 bool headless,
1062                 uint32_t flags) {
1063
1064 #if HAVE_LIBCRYPTSETUP_PLUGINS
1065         int r;
1066
1067         if (!streq_ptr(crypt_get_type(cd), CRYPT_LUKS2))
1068                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Automatic PKCS#11 metadata requires LUKS2 device.");
1069
1070         systemd_pkcs11_plugin_params params = {
1071                 .friendly_name = friendly_name,
1072                 .until = until,
1073                 .headless = headless
1074         };
1075
1076         r = crypt_activate_by_token_pin(cd, name, "systemd-pkcs11", CRYPT_ANY_TOKEN, NULL, 0, &params, flags);
1077         if (r > 0) /* returns unlocked keyslot id on success */
1078                 r = 0;
1079
1080         return r;
1081 #else
1082         return -EOPNOTSUPP;
1083 #endif
1084 }
1085
1086 static int attach_luks_or_plain_or_bitlk_by_pkcs11(
1087                 struct crypt_device *cd,
1088                 const char *name,
1089                 const char *key_file,
1090                 const void *key_data,
1091                 size_t key_data_size,
1092                 usec_t until,
1093                 uint32_t flags,
1094                 bool pass_volume_key) {
1095
1096         _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
1097         _cleanup_free_ char *friendly = NULL, *discovered_uri = NULL;
1098         size_t decrypted_key_size = 0, discovered_key_size = 0;
1099         _cleanup_(erase_and_freep) void *decrypted_key = NULL;
1100         _cleanup_(sd_event_unrefp) sd_event *event = NULL;
1101         _cleanup_free_ void *discovered_key = NULL;
1102         int keyslot = arg_key_slot, r;
1103         const char *uri = NULL;
1104         bool use_libcryptsetup_plugin = libcryptsetup_plugins_support();
1105
1106         assert(cd);
1107         assert(name);
1108         assert(arg_pkcs11_uri || arg_pkcs11_uri_auto);
1109
1110         if (arg_pkcs11_uri_auto) {
1111                 if (!use_libcryptsetup_plugin) {
1112                         r = find_pkcs11_auto_data(cd, &discovered_uri, &discovered_key, &discovered_key_size, &keyslot);
1113                         if (IN_SET(r, -ENOTUNIQ, -ENXIO))
1114                                 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
1115                                                        "Automatic PKCS#11 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking.");
1116                         if (r < 0)
1117                                 return r;
1118
1119                         uri = discovered_uri;
1120                         key_data = discovered_key;
1121                         key_data_size = discovered_key_size;
1122                 }
1123         } else {
1124                 uri = arg_pkcs11_uri;
1125
1126                 if (!key_file && !key_data)
1127                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "PKCS#11 mode selected but no key file specified, refusing.");
1128         }
1129
1130         friendly = friendly_disk_name(crypt_get_device_name(cd), name);
1131         if (!friendly)
1132                 return log_oom();
1133
1134         for (;;) {
1135                 if (use_libcryptsetup_plugin && arg_pkcs11_uri_auto)
1136                         r = attach_luks2_by_pkcs11(cd, name, friendly, until, arg_headless, flags);
1137                 else {
1138                         r = decrypt_pkcs11_key(
1139                                         name,
1140                                         friendly,
1141                                         uri,
1142                                         key_file, arg_keyfile_size, arg_keyfile_offset,
1143                                         key_data, key_data_size,
1144                                         until,
1145                                         arg_headless,
1146                                         &decrypted_key, &decrypted_key_size);
1147                         if (r >= 0)
1148                                 break;
1149                 }
1150
1151                 if (r != -EAGAIN) /* EAGAIN means: token not found */
1152                         return r;
1153
1154                 if (!monitor) {
1155                         /* We didn't find the token. In this case, watch for it via udev. Let's
1156                          * create an event loop and monitor first. */
1157
1158                         assert(!event);
1159
1160                         r = make_security_device_monitor(&event, &monitor);
1161                         if (r < 0)
1162                                 return r;
1163
1164                         log_notice("Security token %s not present for unlocking volume %s, please plug it in.",
1165                                    uri, friendly);
1166
1167                         /* Let's immediately rescan in case the token appeared in the time we needed
1168                          * to create and configure the monitor */
1169                         continue;
1170                 }
1171
1172                 r = run_security_device_monitor(event, monitor);
1173                 if (r < 0)
1174                         return r;
1175
1176                 log_debug("Got one or more potentially relevant udev events, rescanning PKCS#11...");
1177         }
1178         assert(decrypted_key);
1179
1180         if (pass_volume_key)
1181                 r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags);
1182         else {
1183                 _cleanup_(erase_and_freep) char *base64_encoded = NULL;
1184
1185                 /* Before using this key as passphrase we base64 encode it. Why? For compatibility
1186                  * with homed's PKCS#11 hookup: there we want to use the key we acquired through
1187                  * PKCS#11 for other authentication/decryption mechanisms too, and some of them do
1188                  * not take arbitrary binary blobs, but require NUL-terminated strings — most
1189                  * importantly UNIX password hashes. Hence, for compatibility we want to use a string
1190                  * without embedded NUL here too, and that's easiest to generate from a binary blob
1191                  * via base64 encoding. */
1192
1193                 r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded);
1194                 if (r < 0)
1195                         return log_oom();
1196
1197                 r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags);
1198         }
1199         if (r == -EPERM) {
1200                 log_error_errno(r, "Failed to activate with PKCS#11 decrypted key. (Key incorrect?)");
1201                 return -EAGAIN; /* log actual error, but return EAGAIN */
1202         }
1203         if (r < 0)
1204                 return log_error_errno(r, "Failed to activate with PKCS#11 acquired key: %m");
1205
1206         return 0;
1207 }
1208
1209 static int make_tpm2_device_monitor(
1210                 sd_event **ret_event,
1211                 sd_device_monitor **ret_monitor) {
1212
1213         _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
1214         _cleanup_(sd_event_unrefp) sd_event *event = NULL;
1215         int r;
1216
1217         assert(ret_event);
1218         assert(ret_monitor);
1219
1220         r = sd_event_default(&event);
1221         if (r < 0)
1222                 return log_error_errno(r, "Failed to allocate event loop: %m");
1223
1224         r = sd_event_add_time_relative(event, NULL, CLOCK_MONOTONIC, arg_token_timeout_usec, USEC_PER_SEC, NULL, INT_TO_PTR(-ETIMEDOUT));
1225         if (r < 0)
1226                 return log_error_errno(r, "Failed to install timeout event source: %m");
1227
1228         r = sd_device_monitor_new(&monitor);
1229         if (r < 0)
1230                 return log_error_errno(r, "Failed to allocate device monitor: %m");
1231
1232         r = sd_device_monitor_filter_add_match_subsystem_devtype(monitor, "tpmrm", NULL);
1233         if (r < 0)
1234                 return log_error_errno(r, "Failed to configure device monitor: %m");
1235
1236         r = sd_device_monitor_attach_event(monitor, event);
1237         if (r < 0)
1238                 return log_error_errno(r, "Failed to attach device monitor: %m");
1239
1240         r = sd_device_monitor_start(monitor, NULL, NULL);
1241         if (r < 0)
1242                 return log_error_errno(r, "Failed to start device monitor: %m");
1243
1244         *ret_event = TAKE_PTR(event);
1245         *ret_monitor = TAKE_PTR(monitor);
1246         return 0;
1247 }
1248
1249 static int attach_luks2_by_tpm2(
1250                 struct crypt_device *cd,
1251                 const char *name,
1252                 uint32_t flags) {
1253
1254 #if HAVE_LIBCRYPTSETUP_PLUGINS
1255         int r;
1256
1257         systemd_tpm2_plugin_params params = {
1258                 .search_pcr_mask = arg_tpm2_pcr_mask,
1259                 .device = arg_tpm2_device
1260         };
1261
1262         if (!crypt_token_external_path())
1263                 return log_debug_errno(SYNTHETIC_ERRNO(EOPNOTSUPP),
1264                                        "Libcryptsetup has external plugins support disabled.");
1265
1266         r = crypt_activate_by_token_pin(cd, name, "systemd-tpm2", CRYPT_ANY_TOKEN, NULL, 0, &params, flags);
1267         if (r > 0) /* returns unlocked keyslot id on success */
1268                 r = 0;
1269
1270         return r;
1271 #else
1272         return -EOPNOTSUPP;
1273 #endif
1274 }
1275
1276 static int attach_luks_or_plain_or_bitlk_by_tpm2(
1277                 struct crypt_device *cd,
1278                 const char *name,
1279                 const char *key_file,
1280                 const void *key_data,
1281                 size_t key_data_size,
1282                 usec_t until,
1283                 uint32_t flags,
1284                 bool pass_volume_key) {
1285
1286         _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL;
1287         _cleanup_(erase_and_freep) void *decrypted_key = NULL;
1288         _cleanup_(sd_event_unrefp) sd_event *event = NULL;
1289         _cleanup_free_ char *friendly = NULL;
1290         int keyslot = arg_key_slot, r;
1291         size_t decrypted_key_size;
1292
1293         assert(cd);
1294         assert(name);
1295         assert(arg_tpm2_device || arg_tpm2_device_auto);
1296
1297         friendly = friendly_disk_name(crypt_get_device_name(cd), name);
1298         if (!friendly)
1299                 return log_oom();
1300
1301         for (;;) {
1302                 if (key_file || key_data) {
1303                         /* If key data is specified, use that */
1304
1305                         r = acquire_tpm2_key(
1306                                         name,
1307                                         arg_tpm2_device,
1308                                         arg_tpm2_pcr_mask == UINT32_MAX ? TPM2_PCR_MASK_DEFAULT : arg_tpm2_pcr_mask,
1309                                         UINT16_MAX,
1310                                         0,
1311                                         key_file, arg_keyfile_size, arg_keyfile_offset,
1312                                         key_data, key_data_size,
1313                                         NULL, 0, /* we don't know the policy hash */
1314                                         arg_tpm2_pin,
1315                                         until,
1316                                         arg_headless,
1317                                         arg_ask_password_flags,
1318                                         &decrypted_key, &decrypted_key_size);
1319                         if (r >= 0)
1320                                 break;
1321                         if (IN_SET(r, -EACCES, -ENOLCK))
1322                                 return log_error_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 PIN unlock failed, falling back to traditional unlocking.");
1323                         if (ERRNO_IS_NOT_SUPPORTED(r)) /* TPM2 support not compiled in? */
1324                                 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 support not available, falling back to traditional unlocking.");
1325                         /* EAGAIN means: no tpm2 chip found */
1326                         if (r != -EAGAIN) {
1327                                 log_notice_errno(r, "TPM2 operation failed, falling back to traditional unlocking: %m");
1328                                 return -EAGAIN; /* Mangle error code: let's make any form of TPM2 failure non-fatal. */
1329                         }
1330                 } else {
1331                         r = attach_luks2_by_tpm2(cd, name, flags);
1332                         /* EAGAIN     means: no tpm2 chip found
1333                          * EOPNOTSUPP means: no libcryptsetup plugins support */
1334                         if (r == -ENXIO)
1335                                 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
1336                                                        "No TPM2 metadata matching the current system state found in LUKS2 header, falling back to traditional unlocking.");
1337                         if (r == -ENOENT)
1338                                 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
1339                                                        "No TPM2 metadata enrolled in LUKS2 header or TPM2 support not available, falling back to traditional unlocking.");
1340                         if (!IN_SET(r, -EOPNOTSUPP, -EAGAIN)) {
1341                                 log_notice_errno(r, "TPM2 operation failed, falling back to traditional unlocking: %m");
1342                                 return -EAGAIN; /* Mangle error code: let's make any form of TPM2 failure non-fatal. */
1343                         }
1344                 }
1345
1346                 if (r == -EOPNOTSUPP) {
1347                         _cleanup_free_ void *blob = NULL, *policy_hash = NULL;
1348                         size_t blob_size, policy_hash_size;
1349                         bool found_some = false;
1350                         int token = 0; /* first token to look at */
1351
1352                         /* If no key data is specified, look for it in the header. In order to support
1353                          * software upgrades we'll iterate through all suitable tokens, maybe one of them
1354                          * works. */
1355
1356                         for (;;) {
1357                                 uint32_t pcr_mask;
1358                                 uint16_t pcr_bank, primary_alg;
1359                                 TPM2Flags tpm2_flags;
1360
1361                                 r = find_tpm2_auto_data(
1362                                                 cd,
1363                                                 arg_tpm2_pcr_mask, /* if != UINT32_MAX we'll only look for tokens with this PCR mask */
1364                                                 token, /* search for the token with this index, or any later index than this */
1365                                                 &pcr_mask,
1366                                                 &pcr_bank,
1367                                                 &primary_alg,
1368                                                 &blob, &blob_size,
1369                                                 &policy_hash, &policy_hash_size,
1370                                                 &keyslot,
1371                                                 &token,
1372                                                 &tpm2_flags);
1373                                 if (r == -ENXIO)
1374                                         /* No further TPM2 tokens found in the LUKS2 header. */
1375                                         return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN),
1376                                                                found_some
1377                                                                ? "No TPM2 metadata matching the current system state found in LUKS2 header, falling back to traditional unlocking."
1378                                                                : "No TPM2 metadata enrolled in LUKS2 header, falling back to traditional unlocking.");
1379                                 if (ERRNO_IS_NOT_SUPPORTED(r))  /* TPM2 support not compiled in? */
1380                                         return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 support not available, falling back to traditional unlocking.");
1381                                 if (r < 0)
1382                                         return r;
1383
1384                                 found_some = true;
1385
1386                                 r = acquire_tpm2_key(
1387                                                 name,
1388                                                 arg_tpm2_device,
1389                                                 pcr_mask,
1390                                                 pcr_bank,
1391                                                 primary_alg,
1392                                                 NULL, 0, 0, /* no key file */
1393                                                 blob, blob_size,
1394                                                 policy_hash, policy_hash_size,
1395                                                 tpm2_flags,
1396                                                 until,
1397                                                 arg_headless,
1398                                                 arg_ask_password_flags,
1399                                                 &decrypted_key, &decrypted_key_size);
1400                                 if (IN_SET(r, -EACCES, -ENOLCK))
1401                                         return log_error_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 PIN unlock failed, falling back to traditional unlocking.");
1402                                 if (r != -EPERM)
1403                                         break;
1404
1405                                 token++; /* try a different token next time */
1406                         }
1407
1408                         if (r >= 0)
1409                                 break;
1410                         /* EAGAIN means: no tpm2 chip found */
1411                         if (r != -EAGAIN) {
1412                                 log_notice_errno(r, "TPM2 operation failed, falling back to traditional unlocking: %m");
1413                                 return -EAGAIN; /* Mangle error code: let's make any form of TPM2 failure non-fatal. */
1414                         }
1415                 }
1416
1417                 if (!monitor) {
1418                         /* We didn't find the TPM2 device. In this case, watch for it via udev. Let's create
1419                          * an event loop and monitor first. */
1420
1421                         assert(!event);
1422
1423                         if (is_efi_boot() && !efi_has_tpm2())
1424                                 return log_notice_errno(SYNTHETIC_ERRNO(EAGAIN),
1425                                                         "No TPM2 hardware discovered and EFI firmware does not see it either, falling back to traditional unlocking.");
1426
1427                         r = make_tpm2_device_monitor(&event, &monitor);
1428                         if (r < 0)
1429                                 return r;
1430
1431                         log_info("TPM2 device not present for unlocking %s, waiting for it to become available.", friendly);
1432
1433                         /* Let's immediately rescan in case the device appeared in the time we needed
1434                          * to create and configure the monitor */
1435                         continue;
1436                 }
1437
1438                 r = run_security_device_monitor(event, monitor);
1439                 if (r < 0)
1440                         return r;
1441
1442                 log_debug("Got one or more potentially relevant udev events, rescanning for TPM2...");
1443         }
1444         assert(decrypted_key);
1445
1446         if (pass_volume_key)
1447                 r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags);
1448         else {
1449                 _cleanup_(erase_and_freep) char *base64_encoded = NULL;
1450
1451                 /* Before using this key as passphrase we base64 encode it, for compat with homed */
1452
1453                 r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded);
1454                 if (r < 0)
1455                         return log_oom();
1456
1457                 r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags);
1458         }
1459         if (r == -EPERM) {
1460                 log_error_errno(r, "Failed to activate with TPM2 decrypted key. (Key incorrect?)");
1461                 return -EAGAIN; /* log actual error, but return EAGAIN */
1462         }
1463         if (r < 0)
1464                 return log_error_errno(r, "Failed to activate with TPM2 acquired key: %m");
1465
1466         return 0;
1467 }
1468
1469 static int attach_luks_or_plain_or_bitlk_by_key_data(
1470                 struct crypt_device *cd,
1471                 const char *name,
1472                 const void *key_data,
1473                 size_t key_data_size,
1474                 uint32_t flags,
1475                 bool pass_volume_key) {
1476
1477         int r;
1478
1479         assert(cd);
1480         assert(name);
1481         assert(key_data);
1482
1483         if (pass_volume_key)
1484                 r = crypt_activate_by_volume_key(cd, name, key_data, key_data_size, flags);
1485         else
1486                 r = crypt_activate_by_passphrase(cd, name, arg_key_slot, key_data, key_data_size, flags);
1487         if (r == -EPERM) {
1488                 log_error_errno(r, "Failed to activate. (Key incorrect?)");
1489                 return -EAGAIN; /* Log actual error, but return EAGAIN */
1490         }
1491         if (r < 0)
1492                 return log_error_errno(r, "Failed to activate: %m");
1493
1494         return 0;
1495 }
1496
1497 static int attach_luks_or_plain_or_bitlk_by_key_file(
1498                 struct crypt_device *cd,
1499                 const char *name,
1500                 const char *key_file,
1501                 uint32_t flags,
1502                 bool pass_volume_key) {
1503
1504         _cleanup_(erase_and_freep) char *kfdata = NULL;
1505         _cleanup_free_ char *bindname = NULL;
1506         size_t kfsize;
1507         int r;
1508
1509         assert(cd);
1510         assert(name);
1511         assert(key_file);
1512
1513         /* If we read the key via AF_UNIX, make this client recognizable */
1514         bindname = make_bindname(name);
1515         if (!bindname)
1516                 return log_oom();
1517
1518         r = read_full_file_full(
1519                         AT_FDCWD, key_file,
1520                         arg_keyfile_offset == 0 ? UINT64_MAX : arg_keyfile_offset,
1521                         arg_keyfile_size == 0 ? SIZE_MAX : arg_keyfile_size,
1522                         READ_FULL_FILE_SECURE|READ_FULL_FILE_WARN_WORLD_READABLE|READ_FULL_FILE_CONNECT_SOCKET,
1523                         bindname,
1524                         &kfdata, &kfsize);
1525         if (r == -E2BIG) {
1526                 log_error_errno(r, "Failed to activate, key file '%s' too large.", key_file);
1527                 return -EAGAIN;
1528         }
1529         if (r == -ENOENT) {
1530                 log_error_errno(r, "Failed to activate, key file '%s' missing.", key_file);
1531                 return -EAGAIN; /* Log actual error, but return EAGAIN */
1532         }
1533         if (r < 0)
1534                 return log_error_errno(r, "Failed to read key file '%s': %m", key_file);
1535
1536         if (pass_volume_key)
1537                 r = crypt_activate_by_volume_key(cd, name, kfdata, kfsize, flags);
1538         else
1539                 r = crypt_activate_by_passphrase(cd, name, arg_key_slot, kfdata, kfsize, flags);
1540         if (r == -EPERM) {
1541                 log_error_errno(r, "Failed to activate with key file '%s'. (Key data incorrect?)", key_file);
1542                 return -EAGAIN; /* Log actual error, but return EAGAIN */
1543         }
1544         if (r < 0)
1545                 return log_error_errno(r, "Failed to activate with key file '%s': %m", key_file);
1546
1547         return 0;
1548 }
1549
1550 static int attach_luks_or_plain_or_bitlk_by_passphrase(
1551                 struct crypt_device *cd,
1552                 const char *name,
1553                 char **passwords,
1554                 uint32_t flags,
1555                 bool pass_volume_key) {
1556
1557         int r;
1558
1559         assert(cd);
1560         assert(name);
1561
1562         r = -EINVAL;
1563         STRV_FOREACH(p, passwords) {
1564                 if (pass_volume_key)
1565                         r = crypt_activate_by_volume_key(cd, name, *p, arg_key_size, flags);
1566                 else
1567                         r = crypt_activate_by_passphrase(cd, name, arg_key_slot, *p, strlen(*p), flags);
1568                 if (r >= 0)
1569                         break;
1570         }
1571         if (r == -EPERM) {
1572                 log_error_errno(r, "Failed to activate with specified passphrase. (Passphrase incorrect?)");
1573                 return -EAGAIN; /* log actual error, but return EAGAIN */
1574         }
1575         if (r < 0)
1576                 return log_error_errno(r, "Failed to activate with specified passphrase: %m");
1577
1578         return 0;
1579 }
1580
1581 static int attach_luks_or_plain_or_bitlk(
1582                 struct crypt_device *cd,
1583                 const char *name,
1584                 const char *key_file,
1585                 const void *key_data,
1586                 size_t key_data_size,
1587                 char **passwords,
1588                 uint32_t flags,
1589                 usec_t until) {
1590
1591         bool pass_volume_key = false;
1592         int r;
1593
1594         assert(cd);
1595         assert(name);
1596
1597         if ((!arg_type && !crypt_get_type(cd)) || streq_ptr(arg_type, CRYPT_PLAIN)) {
1598                 struct crypt_params_plain params = {
1599                         .offset = arg_offset,
1600                         .skip = arg_skip,
1601                         .sector_size = arg_sector_size,
1602                 };
1603                 const char *cipher, *cipher_mode;
1604                 _cleanup_free_ char *truncated_cipher = NULL;
1605
1606                 if (streq_ptr(arg_hash, "plain"))
1607                         /* plain isn't a real hash type. it just means "use no hash" */
1608                         params.hash = NULL;
1609                 else if (arg_hash)
1610                         params.hash = arg_hash;
1611                 else if (!key_file)
1612                         /* for CRYPT_PLAIN, the behaviour of cryptsetup package is to not hash when a key
1613                          * file is provided */
1614                         params.hash = "ripemd160";
1615
1616                 if (arg_cipher) {
1617                         size_t l;
1618
1619                         l = strcspn(arg_cipher, "-");
1620                         truncated_cipher = strndup(arg_cipher, l);
1621                         if (!truncated_cipher)
1622                                 return log_oom();
1623
1624                         cipher = truncated_cipher;
1625                         cipher_mode = arg_cipher[l] ? arg_cipher+l+1 : "plain";
1626                 } else {
1627                         cipher = "aes";
1628                         cipher_mode = "cbc-essiv:sha256";
1629                 }
1630
1631                 /* for CRYPT_PLAIN limit reads from keyfile to key length, and ignore keyfile-size */
1632                 arg_keyfile_size = arg_key_size;
1633
1634                 /* In contrast to what the name crypt_format() might suggest this doesn't actually format
1635                  * anything, it just configures encryption parameters when used for plain mode. */
1636                 r = crypt_format(cd, CRYPT_PLAIN, cipher, cipher_mode, NULL, NULL, arg_keyfile_size, &params);
1637                 if (r < 0)
1638                         return log_error_errno(r, "Loading of cryptographic parameters failed: %m");
1639
1640                 /* hash == NULL implies the user passed "plain" */
1641                 pass_volume_key = !params.hash;
1642         }
1643
1644         log_info("Set cipher %s, mode %s, key size %i bits for device %s.",
1645                  crypt_get_cipher(cd),
1646                  crypt_get_cipher_mode(cd),
1647                  crypt_get_volume_key_size(cd)*8,
1648                  crypt_get_device_name(cd));
1649
1650         if (arg_tpm2_device || arg_tpm2_device_auto)
1651                 return attach_luks_or_plain_or_bitlk_by_tpm2(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key);
1652         if (arg_fido2_device || arg_fido2_device_auto)
1653                 return attach_luks_or_plain_or_bitlk_by_fido2(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key);
1654         if (arg_pkcs11_uri || arg_pkcs11_uri_auto)
1655                 return attach_luks_or_plain_or_bitlk_by_pkcs11(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key);
1656         if (key_data)
1657                 return attach_luks_or_plain_or_bitlk_by_key_data(cd, name, key_data, key_data_size, flags, pass_volume_key);
1658         if (key_file)
1659                 return attach_luks_or_plain_or_bitlk_by_key_file(cd, name, key_file, flags, pass_volume_key);
1660
1661         return attach_luks_or_plain_or_bitlk_by_passphrase(cd, name, passwords, flags, pass_volume_key);
1662 }
1663
1664 static int help(void) {
1665         _cleanup_free_ char *link = NULL;
1666         int r;
1667
1668         r = terminal_urlify_man("systemd-cryptsetup@.service", "8", &link);
1669         if (r < 0)
1670                 return log_oom();
1671
1672         printf("%s attach VOLUME SOURCEDEVICE [KEY-FILE] [OPTIONS]\n"
1673                "%s detach VOLUME\n\n"
1674                "Attaches or detaches an encrypted block device.\n"
1675                "\nSee the %s for details.\n",
1676                program_invocation_short_name,
1677                program_invocation_short_name,
1678                link);
1679
1680         return 0;
1681 }
1682
1683 static uint32_t determine_flags(void) {
1684         uint32_t flags = 0;
1685
1686         if (arg_readonly)
1687                 flags |= CRYPT_ACTIVATE_READONLY;
1688
1689         if (arg_discards)
1690                 flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS;
1691
1692         if (arg_same_cpu_crypt)
1693                 flags |= CRYPT_ACTIVATE_SAME_CPU_CRYPT;
1694
1695         if (arg_submit_from_crypt_cpus)
1696                 flags |= CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS;
1697
1698         if (arg_no_read_workqueue)
1699                 flags |= CRYPT_ACTIVATE_NO_READ_WORKQUEUE;
1700
1701         if (arg_no_write_workqueue)
1702                 flags |= CRYPT_ACTIVATE_NO_WRITE_WORKQUEUE;
1703
1704 #ifdef CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF
1705         /* Try to decrease the risk of OOM event if memory hard key derivation function is in use */
1706         /* https://gitlab.com/cryptsetup/cryptsetup/issues/446/ */
1707         flags |= CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF;
1708 #endif
1709
1710         return flags;
1711 }
1712
1713 static void remove_and_erasep(const char **p) {
1714         int r;
1715
1716         if (!*p)
1717                 return;
1718
1719         r = unlinkat_deallocate(AT_FDCWD, *p, UNLINK_ERASE);
1720         if (r < 0 && r != -ENOENT)
1721                 log_warning_errno(r, "Unable to erase key file '%s', ignoring: %m", *p);
1722 }
1723
1724 static int run(int argc, char *argv[]) {
1725         _cleanup_(crypt_freep) struct crypt_device *cd = NULL;
1726         const char *verb;
1727         int r;
1728
1729         if (argc <= 1)
1730                 return help();
1731
1732         if (argc < 3)
1733                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1734                                        "This program requires at least two arguments.");
1735
1736         log_setup();
1737
1738         cryptsetup_enable_logging(NULL);
1739
1740         umask(0022);
1741
1742         verb = argv[1];
1743
1744         if (streq(verb, "attach")) {
1745                 _unused_ _cleanup_(remove_and_erasep) const char *destroy_key_file = NULL;
1746                 _cleanup_(erase_and_freep) void *key_data = NULL;
1747                 const char *volume, *source, *key_file, *options;
1748                 crypt_status_info status;
1749                 size_t key_data_size = 0;
1750                 uint32_t flags = 0;
1751                 unsigned tries;
1752                 usec_t until;
1753
1754                 /* Arguments: systemd-cryptsetup attach VOLUME SOURCE-DEVICE [KEY-FILE] [OPTIONS] */
1755
1756                 if (argc < 4)
1757                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "attach requires at least two arguments.");
1758
1759                 volume = argv[2];
1760                 source = argv[3];
1761                 key_file = argc >= 5 && !STR_IN_SET(argv[4], "", "-", "none") ? argv[4] : NULL;
1762                 options = argc >= 6 && !STR_IN_SET(argv[5], "", "-", "none") ? argv[5] : NULL;
1763
1764                 if (!filename_is_valid(volume))
1765                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Volume name '%s' is not valid.", volume);
1766
1767                 if (key_file && !path_is_absolute(key_file)) {
1768                         log_warning("Password file path '%s' is not absolute. Ignoring.", key_file);
1769                         key_file = NULL;
1770                 }
1771
1772                 if (options) {
1773                         r = parse_options(options);
1774                         if (r < 0)
1775                                 return r;
1776                 }
1777
1778                 log_debug("%s %s ← %s type=%s cipher=%s", __func__,
1779                           volume, source, strempty(arg_type), strempty(arg_cipher));
1780
1781                 /* A delicious drop of snake oil */
1782                 (void) mlockall(MCL_FUTURE);
1783
1784                 if (!key_file) {
1785                         _cleanup_free_ char *bindname = NULL;
1786                         const char *fn;
1787
1788                         bindname = make_bindname(volume);
1789                         if (!bindname)
1790                                 return log_oom();
1791
1792                         /* If a key file is not explicitly specified, search for a key in a well defined
1793                          * search path, and load it. */
1794
1795                         fn = strjoina(volume, ".key");
1796                         r = find_key_file(
1797                                         fn,
1798                                         STRV_MAKE("/etc/cryptsetup-keys.d", "/run/cryptsetup-keys.d"),
1799                                         bindname,
1800                                         &key_data, &key_data_size);
1801                         if (r < 0)
1802                                 return r;
1803                         if (r > 0)
1804                                 log_debug("Automatically discovered key for volume '%s'.", volume);
1805                 } else if (arg_keyfile_erase)
1806                         destroy_key_file = key_file; /* let's get this baby erased when we leave */
1807
1808                 if (arg_header) {
1809                         log_debug("LUKS header: %s", arg_header);
1810                         r = crypt_init(&cd, arg_header);
1811                 } else
1812                         r = crypt_init(&cd, source);
1813                 if (r < 0)
1814                         return log_error_errno(r, "crypt_init() failed: %m");
1815
1816                 cryptsetup_enable_logging(cd);
1817
1818                 status = crypt_status(cd, volume);
1819                 if (IN_SET(status, CRYPT_ACTIVE, CRYPT_BUSY)) {
1820                         log_info("Volume %s already active.", volume);
1821                         return 0;
1822                 }
1823
1824                 flags = determine_flags();
1825
1826                 until = usec_add(now(CLOCK_MONOTONIC), arg_timeout);
1827                 if (until == USEC_INFINITY)
1828                         until = 0;
1829
1830                 arg_key_size = (arg_key_size > 0 ? arg_key_size : (256 / 8));
1831
1832                 if (key_file) {
1833                         struct stat st;
1834
1835                         /* Ideally we'd do this on the open fd, but since this is just a
1836                          * warning it's OK to do this in two steps. */
1837                         if (stat(key_file, &st) >= 0 && S_ISREG(st.st_mode) && (st.st_mode & 0005))
1838                                 log_warning("Key file %s is world-readable. This is not a good idea!", key_file);
1839                 }
1840
1841                 if (!arg_type || STR_IN_SET(arg_type, ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2)) {
1842                         r = crypt_load(cd, !arg_type || streq(arg_type, ANY_LUKS) ? CRYPT_LUKS : arg_type, NULL);
1843                         if (r < 0)
1844                                 return log_error_errno(r, "Failed to load LUKS superblock on device %s: %m", crypt_get_device_name(cd));
1845
1846                         if (arg_header) {
1847                                 r = crypt_set_data_device(cd, source);
1848                                 if (r < 0)
1849                                         return log_error_errno(r, "Failed to set LUKS data device %s: %m", source);
1850                         }
1851
1852                         /* Tokens are available in LUKS2 only, but it is ok to call (and fail) with LUKS1. */
1853                         if (!key_file && !key_data) {
1854                                 r = crypt_activate_by_token(cd, volume, CRYPT_ANY_TOKEN, NULL, flags);
1855                                 if (r >= 0) {
1856                                         log_debug("Volume %s activated with LUKS token id %i.", volume, r);
1857                                         return 0;
1858                                 }
1859
1860                                 log_debug_errno(r, "Token activation unsuccessful for device %s: %m", crypt_get_device_name(cd));
1861                         }
1862                 }
1863
1864 /* since cryptsetup 2.3.0 (Feb 2020) */
1865 #ifdef CRYPT_BITLK
1866                 if (streq_ptr(arg_type, CRYPT_BITLK)) {
1867                         r = crypt_load(cd, CRYPT_BITLK, NULL);
1868                         if (r < 0)
1869                                 return log_error_errno(r, "Failed to load Bitlocker superblock on device %s: %m", crypt_get_device_name(cd));
1870                 }
1871 #endif
1872
1873                 for (tries = 0; arg_tries == 0 || tries < arg_tries; tries++) {
1874                         _cleanup_strv_free_erase_ char **passwords = NULL;
1875
1876                         /* When we were able to acquire multiple keys, let's always process them in this order:
1877                          *
1878                          *    1. A key acquired via PKCS#11 or FIDO2 token, or TPM2 chip
1879                          *    2. The discovered key: i.e. key_data + key_data_size
1880                          *    3. The configured key: i.e. key_file + arg_keyfile_offset + arg_keyfile_size
1881                          *    4. The empty password, in case arg_try_empty_password is set
1882                          *    5. We enquire the user for a password
1883                          */
1884
1885                         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) {
1886
1887                                 if (arg_try_empty_password) {
1888                                         /* Hmm, let's try an empty password now, but only once */
1889                                         arg_try_empty_password = false;
1890
1891                                         key_data = strdup("");
1892                                         if (!key_data)
1893                                                 return log_oom();
1894
1895                                         key_data_size = 0;
1896                                 } else {
1897                                         /* Ask the user for a passphrase only as last resort, if we have
1898                                          * nothing else to check for */
1899
1900                                         r = get_password(volume, source, until, tries == 0 && !arg_verify, &passwords);
1901                                         if (r == -EAGAIN)
1902                                                 continue;
1903                                         if (r < 0)
1904                                                 return r;
1905                                 }
1906                         }
1907
1908                         if (streq_ptr(arg_type, CRYPT_TCRYPT))
1909                                 r = attach_tcrypt(cd, volume, key_file, key_data, key_data_size, passwords, flags);
1910                         else
1911                                 r = attach_luks_or_plain_or_bitlk(cd, volume, key_file, key_data, key_data_size, passwords, flags, until);
1912                         if (r >= 0)
1913                                 break;
1914                         if (r != -EAGAIN)
1915                                 return r;
1916
1917                         /* Key not correct? Let's try again! */
1918
1919                         key_file = NULL;
1920                         key_data = erase_and_free(key_data);
1921                         key_data_size = 0;
1922                         arg_pkcs11_uri = mfree(arg_pkcs11_uri);
1923                         arg_pkcs11_uri_auto = false;
1924                         arg_fido2_device = mfree(arg_fido2_device);
1925                         arg_fido2_device_auto = false;
1926                         arg_tpm2_device = mfree(arg_tpm2_device);
1927                         arg_tpm2_device_auto = false;
1928                 }
1929
1930                 if (arg_tries != 0 && tries >= arg_tries)
1931                         return log_error_errno(SYNTHETIC_ERRNO(EPERM), "Too many attempts to activate; giving up.");
1932
1933         } else if (streq(verb, "detach")) {
1934                 const char *volume;
1935
1936                 volume = argv[2];
1937
1938                 if (!filename_is_valid(volume))
1939                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Volume name '%s' is not valid.", volume);
1940
1941                 r = crypt_init_by_name(&cd, volume);
1942                 if (r == -ENODEV) {
1943                         log_info("Volume %s already inactive.", volume);
1944                         return 0;
1945                 }
1946                 if (r < 0)
1947                         return log_error_errno(r, "crypt_init_by_name() failed: %m");
1948
1949                 cryptsetup_enable_logging(cd);
1950
1951                 r = crypt_deactivate(cd, volume);
1952                 if (r < 0)
1953                         return log_error_errno(r, "Failed to deactivate: %m");
1954
1955         } else
1956                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Unknown verb %s.", verb);
1957
1958         return 0;
1959 }
1960
1961 DEFINE_MAIN_FUNCTION(run);