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