NAME
cryptsetup-luksResume - resume a suspended device and reinstate the keySYNOPSIS
cryptsetup luksResume [<options>] <name>DESCRIPTION
Resumes a suspended device and reinstates the encryption key. Prompts interactively for a passphrase if no token is usable (LUKS2 only) or --key-file is not given.OPTIONS
--type <device-type>Specifies required device type, for more info
read BASIC ACTIONS section in cryptsetup(8).
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.
Read the passphrase from file.
If the name given is "-", then the passphrase will be read from stdin.
In this case, reading will not stop at newline characters.
See section NOTES ON PASSPHRASE PROCESSING in cryptsetup(8) for
more information.
Skip value bytes at the beginning of
the key file.
Read a maximum of value bytes from the
key file. The default is to read the whole file up to the compiled-in maximum
that can be queried 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.
For LUKS operations that add key material,
this option allows you to specify which key slot is selected for the new key.
The maximum number of key slots depends on the LUKS version. LUKS1 can have up
to 8 key slots. LUKS2 can have up to 32 key slots based on key slot area size
and key size, but a valid key slot ID can always be between 0 and 31 for
LUKS2.
The number of seconds to wait before 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.
How often the input of the passphrase shall be
retried. The default is 3 tries.
Use a detached (separated) metadata device or
file where the LUKS header is stored. This option allows one to store
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.
Disable loading of plugins for external LUKS2
tokens.
Disable lock protection for metadata on disk.
This option is valid only for LUKS2 and 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).
Do not load volume key in kernel keyring and
store it directly in the dm-crypt target instead. This option is supported
only for the LUKS2 type.
Specify what token to use and allow token PIN
prompt to take precedence over interative keyslot passphrase prompt. If
omitted, all available tokens (not protected by PIN) will be checked before
proceeding further with passphrase prompt.
Do not proceed further with action if token
based keyslot unlock failed. Without the option, action asks for passphrase to
proceed further.
It allows LUKS2 tokens protected by PIN to take precedence over interactive
keyslot passphrase prompt.
Restrict tokens eligible for operation to
specific token type. Mostly useful when no --token-id is specified.
It allows LUKS2 type tokens protected by PIN to take precedence over
interactive keyslot passphrase prompt.
Suppresses all confirmation questions. Use
with care!
If the --verify-passphrase option is not specified, this option also switches
off the passphrase verification.
Run in debug mode with full diagnostic logs.
Debug output lines are always prefixed by #.
If --debug-json is used, additional LUKS2 JSON data structures are
printed.
Show the program version.
Show short option help.
Show help text and default parameters.
REPORTING BUGS
Report bugs at cryptsetup <[email protected]>mailing or in Issues project section <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.SEE ALSO
Cryptsetup FAQ <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>CRYPTSETUP
Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.2023-12-18 | cryptsetup 2.6.1 |