1CRYPTSETUP-BITLKDUMP(8)      Maintenance Commands      CRYPTSETUP-BITLKDUMP(8)
2
3
4

NAME

6       cryptsetup-bitlkDump - dump the header information of a BITLK
7       (BitLocker compatible) device
8

SYNOPSIS

10       cryptsetup bitlkDump [<options>] <device>
11

DESCRIPTION

13       Dump the header information of a BITLK (BitLocker compatible) device.
14
15       If the --dump-volume-key option is used, the BITLK device volume key is
16       dumped instead of header information. You have to provide password or
17       keyfile to dump volume key.
18
19       Beware that the volume key can be used to decrypt the data stored in
20       the container without a passphrase. This means that if the volume key
21       is compromised, the whole device has to be erased to prevent further
22       access. Use this option carefully.
23
24       <options> can be [--dump-volume-key, --volume-key-file, --key-file,
25       --keyfile-offset, --keyfile-size, --timeout].
26

OPTIONS

28       --key-file, -d name
29           Read the passphrase from file.
30
31           If the name given is "-", then the passphrase will be read from
32           stdin. In this case, reading will not stop at newline characters.
33
34           See section NOTES ON PASSPHRASE PROCESSING in cryptsetup(8) for
35           more information.
36
37       --keyfile-offset value
38           Skip value bytes at the beginning of the key file.
39
40       --keyfile-size, -l value
41           Read a maximum of value bytes from the key file. The default is to
42           read the whole file up to the compiled-in maximum that can be
43           queried with --help. Supplying more data than the compiled-in
44           maximum aborts the operation.
45
46           This option is useful to cut trailing newlines, for example. If
47           --keyfile-offset is also given, the size count starts after the
48           offset.
49
50       --volume-key-file, --master-key-file (OBSOLETE alias)
51           Use a volume key stored in a file. The volume key is stored in a
52           file instead of being printed out to standard output.
53
54       --dump-volume-key, --dump-master-key (OBSOLETE alias)
55           Print the volume key in the displayed information. Use with care,
56           as the volume key can be used to bypass the passphrases, see also
57           option --volume-key-file.
58
59       --timeout, -t <number of seconds>
60           The number of seconds to wait before timeout on passphrase input
61           via terminal. It is relevant every time a passphrase is asked. It
62           has no effect if used in conjunction with --key-file.
63
64           This option is useful when the system should not stall if the user
65           does not input a passphrase, e.g. during boot. The default is a
66           value of 0 seconds, which means to wait forever.
67
68       --batch-mode, -q
69           Suppresses all confirmation questions. Use with care!
70
71           If the --verify-passphrase option is not specified, this option
72           also switches off the passphrase verification.
73
74       --debug or --debug-json
75           Run in debug mode with full diagnostic logs. Debug output lines are
76           always prefixed by #.
77
78           If --debug-json is used, additional LUKS2 JSON data structures are
79           printed.
80
81       --version, -V
82           Show the program version.
83
84       --usage
85           Show short option help.
86
87       --help, -?
88           Show help text and default parameters.
89

REPORTING BUGS

91       Report bugs at cryptsetup mailing list <cryptsetup@lists.linux.dev> or
92       in Issues project section
93       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.
94
95       Please attach output of the failed command with --debug option added.
96

SEE ALSO

98       Cryptsetup FAQ
99       <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>
100
101       cryptsetup(8), integritysetup(8) and veritysetup(8)
102

CRYPTSETUP

104       Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
105
106
107
108cryptsetup 2.5.0                  2022-07-28           CRYPTSETUP-BITLKDUMP(8)
Impressum