CRYPTSETUP-LUKSRESUME(8)

📦
version 2.8.8 · 17 versions
, in arch rolling, fedora 44, nixpkgs unstable

💖 CRYPTSETUP-LUKSRESUME 💖

ok so this is cryptsetup luksResume, a maintenance command from the cryptsetup manual pages, and bestie it's literally the "wake up babe, we're going back in" command 🫶

✨ NAME ✨

cryptsetup-luksResume — resume a suspended device and reinstate the key 🔑

🦋 SYNOPSIS 🦋

cryptsetup luksResume [<options>] <name>

🌸 DESCRIPTION 🌸

So like. Your device got suspended, right? This command resumes it and reinstate the encryption key. It's giving resurrection, it's giving main character energy ✨

If there's no usable token (LUKS2 only, iykyk) or you didn't pass --key-file, it will prompt you interactively for a passphrase. So it'll just, like, ask you. Politely.

And the <options> can be any of these little guys:

--key-file, --keyfile-size, --keyfile-offset, --key-slot, --header, --disable-keyring, --disable-locks, --token-id, --token-only, --token-type, --disable-external-tokens, --type, --tries, --timeout, --verify-passphrase, --volume-key-keyring, --link-vk-to-keyring, --external-tokens-path

no cap, that's the whole roster 💅

💅 OPTIONS 💅

  • --batch-mode, -q — Suppresses all confirmation questions. Use with care! 😭 And if you didn't also pass --verify-passphrase, this option switches off the passphrase verification too. So like, zero double-checking, straight to business.
  • --debug or --debug-json — Run in debug mode with full diagnostic logs. Every debug output line is always prefixed by #. If you use --debug-json, you also get extra LUKS2 JSON data structures printed out. Very "show me everything" of it 🔍
  • --disable-external-tokens — Disable loading of plugins for external LUKS2 tokens. That's it, that's the vibe.
  • --disable-keyring — Do not load the volume key in the kernel keyring; store it directly in the dm-crypt target instead. Heads up: this option is supported only for the LUKS2 type.
  • --disable-locks — Disable lock protection for metadata on disk. Valid only for LUKS2, and it just gets ignored for other formats.
⚠️ WARNING: Do not use this option unless you run cryptsetup in a restricted environment where locking is impossible to perform (where /run directory cannot be used). fr fr, don't just casually turn this on 💀
  • --external-tokens-path <absolute path> — Override the system directory path where cryptsetup searches for external token handlers (or token plugins). It must be an absolute path (starting with the '/' character). No relative paths, we don't do that here 🚫
  • --header <device or file storing the LUKS header> — Use a detached (separated) metadata device or file where the LUKS header is stored. This option allows one to store the ciphertext and LUKS header on different devices. For commands that change the LUKS header (e.g., luksAddKey), specify the device or file with the LUKS header directly as the LUKS device. Detached header, detached problems 🎀
  • --help, -? — Show help text and default parameters. Your girl's got you 🫶
  • --key-description text — Set the key description in the keyring that will be used for passphrase retrieval.
  • --key-file, -d file — Read the passphrase from the file. If the name given is "-", then the passphrase will be read from stdin — and in that case, reading will not stop at newline characters. See section NOTES ON PASSPHRASE PROCESSING in cryptsetup(8) for more information.
  • --keyfile-offset value — Skip value bytes at the beginning of the key file. Just, like, yeeting the first chunk 🏃‍♀️
  • --keyfile-size, -l value — Read a maximum of value bytes from the key file. The default is to read the whole file up to the compiled-in maximum, which you can query with --help. Supplying more data than the compiled-in maximum aborts the operation. This option is useful to cut trailing newlines, for example. If --keyfile-offset is also given, the size count starts after the offset. Math! ✨
  • --key-slot, -S <0-N> — For LUKS operations that add key material, this option lets you specify which keyslot is selected for the new key. The maximum number of keyslots depends on the LUKS version: LUKS1 can have up to 8 keyslots. LUKS2 can have up to 32 keyslots based on keyslot area size and key size, but a valid keyslot ID can always be between 0 and 31 for LUKS2. Numbers, bestie 📊
  • --link-vk-to-keyring <keyring description>::<key description> — Link the volume key in a keyring with the specified key name. The volume key is linked only if the requested action is successfully finished — with --test-passphrase, the verified volume key is linked in a keyring without taking further action.

The <keyring description> string has to contain the existing kernel keyring description. The keyring name may be optionally prefixed with "%:" or "%keyring:" type descriptions. Or, the keyring may also be specified directly by numeric key id. Also, special keyring notations starting with "@" may be used to select existing predefined kernel keyrings.

The string "::" is a delimiter used to separate the keyring description and key description.

The <key description> part describes key type and key name of volume key linked in the keyring described in <keyring description>. The type may be specified by adding a "%<type_name>:" prefix in front of the key name. If the type is missing, the default user type is applied. If the key of the same name and type already exists (already linked in the keyring), it will get replaced in the process. See also the KEY IDENTIFIERS section of keyctl(1).

  • --timeout, -t seconds — The number of seconds to wait before a timeout on passphrase input via terminal. It is relevant every time a passphrase is asked. It has no effect if used in conjunction with --key-file. This option is useful when the system should not stall if the user does not input a passphrase, e.g., during boot. The default is a value of 0 seconds, which means to wait forever. Forever ever. ⏳
  • --token-id — Specify what token to use and allow the token PIN prompt to take precedence over the interactive keyslot passphrase prompt. If omitted, all available tokens (not protected by PIN) will be checked before proceeding further with the passphrase prompt.
  • --token-only — Do not proceed further with the action if the token-based keyslot unlock failed. Without the option, the action asks for a passphrase to proceed further. It allows LUKS2 tokens protected by PIN to take precedence over the interactive keyslot passphrase prompt. All or nothing, periodt 💅
  • --token-type type — Restrict tokens eligible for operation to a specific token type. Mostly useful when no --token-id is specified. It allows LUKS2 type tokens protected by PIN to take precedence over the interactive keyslot passphrase prompt.
  • --tries, -T — How often the input of the passphrase shall be retried. The default is 3 tries. Three strikes, bestie 🔥
  • --type type — Specifies required device type. For more info, read the BASIC ACTIONS section in cryptsetup(8).
  • --usage — Show short option help. The lil' version 🌱
  • --verify-passphrase, -y — When interactively asking for a passphrase, ask for it twice and complain if both inputs do not match. Ignored on input from file or stdin. Double-check szn ✅
  • --version, -V — Show the program version. 🏷️
  • --volume-key-keyring <key description> — Use a volume key stored in a keyring. This allows one to open luks and plain device types without giving a passphrase. For LUKS, the key and associated type have to be readable from userspace so that the volume key digest may be verified before activation. For devices in reencryption, the option may be used twice to specify both old and new volume keys.

For PLAIN type, the user must ensure that the key in the keyring is unchanged since activation. Otherwise, reloading the key can cause data corruption after an unexpected key change. 😭 don't do that to yourself.

The <key description> uses keyctl-compatible syntax. This can either be a numeric key ID or a string name in the format %<key type>:<key name>. See also the KEY IDENTIFIERS section of keyctl(1). When no %<key type>: prefix is specified, we assume the key type is user (default type).

😭 REPORTING BUGS 😭

Found a bug? Report it at the cryptsetup mailing list <cryptsetup@lists.linux.dev> or in the Issues project section at <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.

Please attach the output of the failed command with the --debug option added. Give us the receipts, bestie 🧾

🔍 SEE ALSO 🔍

👑 CRYPTSETUP 👑

Part of the cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>. Iconic behaviour, honestly 🌈

and that's the whole page, babes 💜 this was cryptsetup 2.8.8, dated 2026-09-07, and it lives at CRYPTSETUP-LUKSRESUME(8) — go resume something and slay ✨🎀

📦 where this page comes from