NAME
cryptsetup-token - manage LUKS2 tokensSYNOPSIS
cryptsetup token <add|remove|import|export|unassign> [<options>] <device>DESCRIPTION
Action add creates a new keyring token to enable auto-activation of the device. For the auto-activation, the passphrase must be stored in keyring with the specified description. Usually, the passphrase should be stored in user or user-session keyring. The token command is supported only for LUKS2.OPTIONS
--json-fileRead token JSON from a file or write token to
it. --json-file=- reads JSON from standard input or writes it to standard
output respectively.
Replace an existing token when adding or
importing a token with the --token-id option.
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.
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.
Set key description in keyring for use with
token command.
Specify token number. If omitted, first unused
token id is used when adding or importing new token.
Creates new LUKS2 keyring token assigned to no
keyslot. Usable only with add action.
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 |