logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

cryptsetup-luksHeaderBackup - store a binary backup of the LUKS header and keyslot area

Cryptsetup

       Part of cryptsetupproject <https://gitlab.com/cryptsetup/cryptsetup/>.

cryptsetup 2.8.0                                   2025-07-25                     CRYPTSETUP-LUKSHEADERBACKUP(8)

Description

       Stores a binary backup of the LUKS header and keyslot area.
       NOTE: Using '-' as filename writes the header backup to a file named '-'.

       <options> can be [--header, --header-backup-file, --disable-locks].

       WARNING: This backup file and a passphrase valid at the time of backup allows decryption of the LUKS data
       area, even if the passphrase was later changed or removed from the LUKS device. Also note that with a
       header backup you lose the ability to securely wipe the LUKS device by just overwriting the header and
       key-slots. You either need to securely erase all header backups in addition or overwrite the encrypted
       data area as well. The second option is less secure, as some sectors can survive, e.g., due to defect
       management.

Name

       cryptsetup-luksHeaderBackup - store a binary backup of the LUKS header and keyslot area

Options

--batch-mode,-q
           Suppresses all confirmation questions. Use with care!

           If the --verify-passphrase option is not specified, this option also switches off the passphrase
           verification.

       --debugor--debug-json
           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.

       --disable-locks
           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).

       --header<deviceorfilestoringtheLUKSheader>
           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.

       --header-backup-file<file>
           Specify file with header backup file.

       --help,-?
           Show help text and default parameters.

       --usage
           Show short option help.

       --version,-V
           Show the program version.

Reporting Bugs

       Report bugs at cryptsetupmailinglist <cryptsetup@lists.linux.dev> or in Issuesprojectsection
       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.

       Please attach output of the failed command with --debug option added.

See Also

CryptsetupFAQ <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>

       cryptsetup(8), integritysetup(8) and veritysetup(8)

Synopsis

cryptsetupluksHeaderBackup--header-backup-file<file>[<options>]<device>

See Also