{ "mode": "man", "parameter": "CRYPTSETUP-TOKEN", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/CRYPTSETUP-TOKEN/8/json", "generated": "2026-10-04T09:18:21Z", "synopsis": "cryptsetup token [] ", "sections": { "NAME": { "content": "cryptsetup-token - manage LUKS2 tokens\n", "subsections": [] }, "SYNOPSIS": { "content": "cryptsetup token [] \n", "subsections": [] }, "DESCRIPTION": { "content": "Action add creates a new keyring token to enable auto-activation of the device. For the\nauto-activation, the passphrase must be stored in keyring with the specified description.\nUsually, the passphrase should be stored in user or user-session keyring. The token command\nis supported only for LUKS2.\n\nFor adding new keyring token, option --key-description is mandatory. Also, new token is\nassigned to key slot specified with --key-slot option or to all active key slots in the case\n--key-slot option is omitted.\n\nTo remove existing token, specify the token ID which should be removed with --token-id\noption.\n\nWARNING: The action token remove removes any token type, not just keyring type from token\nslot specified by --token-id option.\n\nAction import can store arbitrary valid token json in LUKS2 header. It may be passed via\nstandard input or via file passed in --json-file option. If you specify --key-slot then\nsuccessfully imported token is also assigned to the key slot.\n\nAction export writes requested token JSON to a file passed with --json-file or to standard\noutput.\n\nAction unassign removes token binding to specified keyslot. Both token and keyslot must be\nspecified by --token-id and --key-slot parameters.\n\nIf --token-id is used with action add or action import and a token with that ID already\nexists, option --token-replace can be used to replace the existing token.\n\n can be [--header, --token-id, --key-slot, --key-description,\n--disable-external-tokens, --disable-locks, --disable-keyring, --json-file, --token-replace,\n--unbound, --external-tokens-path].\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "--json-file", "content": "Read token JSON from a file or write token to it. --json-file=- reads JSON from standard\ninput or writes it to standard output respectively.\n", "long": "--json-file" }, { "name": "--token-replace", "content": "Replace an existing token when adding or importing a token with the --token-id option.\n", "long": "--token-replace" }, { "name": "--key-slot, -S <0-N>", "content": "For LUKS operations that add key material, this option allows you to specify which key\nslot is selected for the new key.\n\nThe maximum number of key slots depends on the LUKS version. LUKS1 can have up to 8 key\nslots. LUKS2 can have up to 32 key slots based on key slot area size and key size, but a\nvalid key slot ID can always be between 0 and 31 for LUKS2.\n", "flag": "-S", "long": "--key-slot", "arg": "<0-N>" }, { "name": "--header ", "content": "Use a detached (separated) metadata device or file where the LUKS header is stored. This\noption allows one to store ciphertext and LUKS header on different devices.\n\nFor commands that change the LUKS header (e.g. luksAddKey), specify the device or file\nwith the LUKS header directly as the LUKS device.\n", "long": "--header", "arg": "LUKS" }, { "name": "--disable-external-tokens", "content": "Disable loading of plugins for external LUKS2 tokens.\n", "long": "--disable-external-tokens" }, { "name": "--disable-locks", "content": "Disable lock protection for metadata on disk. This option is valid only for LUKS2 and\nignored for other formats.\n\nWARNING: Do not use this option unless you run cryptsetup in a restricted environment\nwhere locking is impossible to perform (where /run directory cannot be used).\n", "long": "--disable-locks" }, { "name": "--disable-keyring", "content": "Do not load volume key in kernel keyring and store it directly in the dm-crypt target\ninstead. This option is supported only for the LUKS2 type.\n", "long": "--disable-keyring" }, { "name": "--key-description ", "content": "Set key description in keyring for use with token command.\n", "long": "--key-description", "arg": "" }, { "name": "--token-id", "content": "Specify token number. If omitted, first unused token id is used when adding or importing\nnew token.\n", "long": "--token-id" }, { "name": "--unbound", "content": "Creates new LUKS2 keyring token assigned to no keyslot. Usable only with add action.\n\n--external-tokens-path absolutepath\nOverride system directory path where cryptsetup searches for external token handlers (or\ntoken plugins). It must be absolute path (starting with '/' character).\n", "long": "--unbound" }, { "name": "--batch-mode, -q", "content": "Suppresses all confirmation questions. Use with care!\n\nIf the --verify-passphrase option is not specified, this option also switches off the\npassphrase verification.\n", "flag": "-q", "long": "--batch-mode" }, { "name": "--debug or --debug-json", "content": "Run in debug mode with full diagnostic logs. Debug output lines are always prefixed by #.\n\nIf --debug-json is used, additional LUKS2 JSON data structures are printed.\n", "long": "--debug-json" }, { "name": "--version, -V", "content": "Show the program version.\n", "flag": "-V", "long": "--version" }, { "name": "--usage", "content": "Show short option help.\n", "long": "--usage" }, { "name": "--help, -?", "content": "Show help text and default parameters.\n", "flag": "-?", "long": "--help" } ] }, "REPORTING BUGS": { "content": "Report bugs at cryptsetup mailing list or in Issues project\nsection .\n\nPlease attach output of the failed command with --debug option added.\n", "subsections": [] }, "SEE ALSO": { "content": "Cryptsetup FAQ \n\ncryptsetup(8), integritysetup(8) and veritysetup(8)\n", "subsections": [] }, "CRYPTSETUP": { "content": "Part of cryptsetup project .\n\ncryptsetup 2.7.0 2024-11-14 CRYPTSETUP-TOKEN(8)", "subsections": [] } }, "summary": "cryptsetup-token - manage LUKS2 tokens", "flags": [ { "flag": "", "long": "--json-file", "arg": null, "description": "Read token JSON from a file or write token to it. --json-file=- reads JSON from standard input or writes it to standard output respectively." }, { "flag": "", "long": "--token-replace", "arg": null, "description": "Replace an existing token when adding or importing a token with the --token-id option." }, { "flag": "-S", "long": "--key-slot", "arg": "<0-N>", "description": "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." }, { "flag": "", "long": "--header", "arg": "LUKS", "description": "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." }, { "flag": "", "long": "--disable-external-tokens", "arg": null, "description": "Disable loading of plugins for external LUKS2 tokens." }, { "flag": "", "long": "--disable-locks", "arg": null, "description": "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)." }, { "flag": "", "long": "--disable-keyring", "arg": null, "description": "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." }, { "flag": "", "long": "--key-description", "arg": "", "description": "Set key description in keyring for use with token command." }, { "flag": "", "long": "--token-id", "arg": null, "description": "Specify token number. If omitted, first unused token id is used when adding or importing new token." }, { "flag": "", "long": "--unbound", "arg": null, "description": "Creates new LUKS2 keyring token assigned to no keyslot. Usable only with add action. --external-tokens-path absolutepath Override system directory path where cryptsetup searches for external token handlers (or token plugins). It must be absolute path (starting with '/' character)." }, { "flag": "-q", "long": "--batch-mode", "arg": null, "description": "Suppresses all confirmation questions. Use with care! If the --verify-passphrase option is not specified, this option also switches off the passphrase verification." }, { "flag": "", "long": "--debug-json", "arg": null, "description": "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." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Show the program version." }, { "flag": "", "long": "--usage", "arg": null, "description": "Show short option help." }, { "flag": "-?", "long": "--help", "arg": null, "description": "Show help text and default parameters." } ], "examples": [], "see_also": [ { "name": "cryptsetup", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/cryptsetup/8/json" }, { "name": "integritysetup", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/integritysetup/8/json" }, { "name": "veritysetup", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/veritysetup/8/json" } ] }