{ "mode": "man", "parameter": "cryptsetup-bitlkDump", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/cryptsetup-bitlkDump/8/json", "generated": "2026-10-04T19:37:59Z", "synopsis": "cryptsetup bitlkDump [] ", "sections": { "NAME": { "content": "cryptsetup-bitlkDump - dump the header information of a BITLK (BitLocker compatible) device\n", "subsections": [] }, "SYNOPSIS": { "content": "cryptsetup bitlkDump [] \n", "subsections": [] }, "DESCRIPTION": { "content": "Dump the header information of a BITLK (BitLocker compatible) device.\n\nIf the --dump-volume-key option is used, the BITLK device volume key is dumped instead of\nheader information. You have to provide password or keyfile to dump volume key.\n\nBeware that the volume key can be used to decrypt the data stored in the container without a\npassphrase. This means that if the volume key is compromised, the whole device has to be\nerased to prevent further access. Use this option carefully.\n\n can be [--dump-volume-key, --volume-key-file, --key-file, --keyfile-offset,\n--keyfile-size, --timeout].\n", "subsections": [] }, "OPTIONS": { "content": "--key-file, -d name\nRead the passphrase from file.\n\nIf the name given is \"-\", then the passphrase will be read from stdin. In this case,\nreading will not stop at newline characters.\n\nSee section NOTES ON PASSPHRASE PROCESSING in cryptsetup(8) for more information.\n\n--keyfile-offset value\nSkip value bytes at the beginning of the key file.\n\n--keyfile-size, -l value\nRead a maximum of value bytes from the key file. The default is to read the whole file up\nto the compiled-in maximum that can be queried with --help. Supplying more data than the\ncompiled-in maximum aborts the operation.\n\nThis option is useful to cut trailing newlines, for example. If --keyfile-offset is also\ngiven, the size count starts after the offset.\n", "subsections": [ { "name": "--volume-key-file, --master-key-file (OBSOLETE alias)", "content": "Use a volume key stored in a file. The volume key is stored in a file instead of being\nprinted out to standard output.\n", "long": "--master-key-file" }, { "name": "--dump-volume-key, --dump-master-key (OBSOLETE alias)", "content": "Print the volume key in the displayed information. Use with care, as the volume key can\nbe used to bypass the passphrases, see also option --volume-key-file.\n", "long": "--dump-master-key" }, { "name": "--timeout, -t ", "content": "The number of seconds to wait before timeout on passphrase input via terminal. It is\nrelevant every time a passphrase is asked. It has no effect if used in conjunction with\n--key-file.\n\nThis option is useful when the system should not stall if the user does not input a\npassphrase, e.g. during boot. The default is a value of 0 seconds, which means to wait\nforever.\n", "flag": "-t", "long": "--timeout" }, { "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-BITLKDUMP(8)", "subsections": [] } }, "summary": "cryptsetup-bitlkDump - dump the header information of a BITLK (BitLocker compatible) device", "flags": [ { "flag": "", "long": "--master-key-file", "arg": null, "description": "Use a volume key stored in a file. The volume key is stored in a file instead of being printed out to standard output." }, { "flag": "", "long": "--dump-master-key", "arg": null, "description": "Print the volume key in the displayed information. Use with care, as the volume key can be used to bypass the passphrases, see also option --volume-key-file." }, { "flag": "-t", "long": "--timeout", "arg": null, "description": "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." }, { "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" } ] }