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

NAME

6       cryptsetup-config - set permanent configuration options (store to LUKS
7       header)
8

SYNOPSIS

10       cryptsetup config <options> <device>
11

DESCRIPTION

13       Set permanent configuration options (store to LUKS header). The config
14       command is supported only for LUKS2.
15
16       The permanent options can be --priority to set priority (normal,
17       prefer, ignore) for keyslot (specified by --key-slot) or --label and
18       --subsystem.
19
20       <options> can be [--priority, --label, --subsystem, --key-slot,
21       --header, --disable-locks].
22

OPTIONS

24       --key-slot, -S <0-N>
25           For LUKS operations that add key material, this option allows you
26           to specify which key slot is selected for the new key.
27
28           The maximum number of key slots depends on the LUKS version. LUKS1
29           can have up to 8 key slots. LUKS2 can have up to 32 key slots based
30           on key slot area size and key size, but a valid key slot ID can
31           always be between 0 and 31 for LUKS2.
32
33       --header <device or file storing the LUKS header>
34           Use a detached (separated) metadata device or file where the LUKS
35           header is stored. This option allows one to store ciphertext and
36           LUKS header on different devices.
37
38           For commands that change the LUKS header (e.g. luksAddKey), specify
39           the device or file with the LUKS header directly as the LUKS
40           device.
41
42       --disable-locks
43           Disable lock protection for metadata on disk. This option is valid
44           only for LUKS2 and ignored for other formats.
45
46           WARNING: Do not use this option unless you run cryptsetup in a
47           restricted environment where locking is impossible to perform
48           (where /run directory cannot be used).
49
50       --priority <normal|prefer|ignore>
51           Set a priority for LUKS2 keyslot. The prefer priority marked slots
52           are tried before normal priority. The ignored priority means, that
53           slot is never used, if not explicitly requested by --key-slot
54           option.
55
56       --label <LABEL> --subsystem <SUBSYSTEM>
57           Set label and subsystem description for LUKS2 device. The label and
58           subsystem are optional fields and can be later used in udev scripts
59           for triggering user actions once the device marked by these labels
60           is detected.
61
62       --batch-mode, -q
63           Suppresses all confirmation questions. Use with care!
64
65           If the --verify-passphrase option is not specified, this option
66           also switches off the passphrase verification.
67
68       --debug or --debug-json
69           Run in debug mode with full diagnostic logs. Debug output lines are
70           always prefixed by #.
71
72           If --debug-json is used, additional LUKS2 JSON data structures are
73           printed.
74
75       --version, -V
76           Show the program version.
77
78       --usage
79           Show short option help.
80
81       --help, -?
82           Show help text and default parameters.
83

REPORTING BUGS

85       Report bugs at cryptsetup mailing list <cryptsetup@lists.linux.dev> or
86       in Issues project section
87       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.
88
89       Please attach output of the failed command with --debug option added.
90

SEE ALSO

92       Cryptsetup FAQ
93       <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>
94
95       cryptsetup(8), integritysetup(8) and veritysetup(8)
96

CRYPTSETUP

98       Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
99
100
101
102cryptsetup 2.5.0                  2022-07-28              CRYPTSETUP-CONFIG(8)
Impressum