cryptsetup-luksKillSlot(8)

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

NAME

6       cryptsetup-luksKillSlot - wipe a key-slot from the LUKS device
7

SYNOPSIS

9       cryptsetup luksKillSlot [<options>] <device> <key slot number>
10

DESCRIPTION

12       Wipe the key-slot number <key slot> from the LUKS device. Except
13       running in batch-mode (-q) a remaining passphrase must be supplied,
14       either interactively or via --key-file. This command can remove the
15       last remaining key-slot, but requires an interactive confirmation when
16       doing so. Removing the last passphrase makes a LUKS container
17       permanently inaccessible.
18
19       <options> can be [--key-file, --keyfile-offset, --keyfile-size,
20       --header, --disable-locks, --type, --verify-passphrase, --timeout].
21
22       WARNING: If you read the passphrase from stdin (without further
23       argument or with '-' as an argument to --key-file), batch-mode (-q)
24       will be implicitly switched on and no warning will be given when you
25       remove the last remaining passphrase from a LUKS container. Removing
26       the last passphrase makes the LUKS container permanently inaccessible.
27
28       NOTE: If there is no passphrase provided (on stdin or through
29       --key-file argument) and batch-mode (-q) is active, the key-slot is
30       removed without any other warning.
31

OPTIONS

33       --type <device-type>
34           Specifies required device type, for more info read BASIC ACTIONS
35           section in cryptsetup(8).
36
37       --verify-passphrase, -y
38           When interactively asking for a passphrase, ask for it twice and
39           complain if both inputs do not match. Ignored on input from file or
40           stdin.
41
42       --key-file, -d name
43           Read the passphrase from file.
44
45           If the name given is "-", then the passphrase will be read from
46           stdin. In this case, reading will not stop at newline characters.
47
48           With LUKS, the passphrase supplied via --key-file is always the
49           existing passphrase requested by a command, except in the case of
50           luksFormat where --key-file is equivalent to the positional key
51           file argument.
52
53           If you want to set a new passphrase via key file, you have to use a
54           positional argument to luksAddKey.
55
56           See section NOTES ON PASSPHRASE PROCESSING in cryptsetup(8) for
57           more information.
58
59       --keyfile-offset value
60           Skip value bytes at the beginning of the key file.
61
62       --keyfile-size, -l value
63           Read a maximum of value bytes from the key file. The default is to
64           read the whole file up to the compiled-in maximum that can be
65           queried with --help. Supplying more data than the compiled-in
66           maximum aborts the operation.
67
68           This option is useful to cut trailing newlines, for example. If
69           --keyfile-offset is also given, the size count starts after the
70           offset.
71
72       --timeout, -t <number of seconds>
73           The number of seconds to wait before timeout on passphrase input
74           via terminal. It is relevant every time a passphrase is asked. It
75           has no effect if used in conjunction with --key-file.
76
77           This option is useful when the system should not stall if the user
78           does not input a passphrase, e.g. during boot. The default is a
79           value of 0 seconds, which means to wait forever.
80
81       --header <device or file storing the LUKS header>
82           Use a detached (separated) metadata device or file where the LUKS
83           header is stored. This option allows one to store ciphertext and
84           LUKS header on different devices.
85
86           For commands that change the LUKS header (e.g. luksAddKey), specify
87           the device or file with the LUKS header directly as the LUKS
88           device.
89
90       --disable-locks
91           Disable lock protection for metadata on disk. This option is valid
92           only for LUKS2 and ignored for other formats.
93
94           WARNING: Do not use this option unless you run cryptsetup in a
95           restricted environment where locking is impossible to perform
96           (where /run directory cannot be used).
97
98       --batch-mode, -q
99           Suppresses all confirmation questions. Use with care!
100
101           If the --verify-passphrase option is not specified, this option
102           also switches off the passphrase verification.
103
104       --debug or --debug-json
105           Run in debug mode with full diagnostic logs. Debug output lines are
106           always prefixed by #.
107
108           If --debug-json is used, additional LUKS2 JSON data structures are
109           printed.
110
111       --version, -V
112           Show the program version.
113
114       --usage
115           Show short option help.
116
117       --help, -?
118           Show help text and default parameters.
119

REPORTING BUGS

121       Report bugs at cryptsetup mailing list <cryptsetup@lists.linux.dev> or
122       in Issues project section
123       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.
124
125       Please attach output of the failed command with --debug option added.
126

CRYPTSETUP

134       Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
135
136
137
138cryptsetup 2.5.0                  2022-07-28        CRYPTSETUP-LUKSKILLSLOT(8)

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

REPORTING BUGS

SEE ALSO

CRYPTSETUP