'\" t
.\"     Title: cryptsetup-luksremovekey
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2023-07-18
.\"    Manual: Maintenance Commands
.\"    Source: cryptsetup 2.7.2
.\"  Language: English
.\"
.TH "CRYPTSETUP\-LUKSREMOVEKEY" "8" "2023-07-18" "cryptsetup 2.7.2" "Maintenance Commands"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
cryptsetup-luksRemoveKey \- remove the supplied passphrase from the LUKS device
.SH "SYNOPSIS"
.sp
\fBcryptsetup \fIluksRemoveKey\fP [<options>] <device> [<key file with passphrase to be removed>]\fP
.SH "DESCRIPTION"
.sp
Removes the supplied passphrase from the LUKS device. The passphrase to
be removed can be specified interactively, as the positional argument or
via \-\-key\-file.
.sp
\fB<options>\fP can be [\-\-key\-file, \-\-keyfile\-offset, \-\-keyfile\-size,
\-\-header, \-\-disable\-locks, \-\-type, \-\-timeout, \-\-verify\-passphrase].
.sp
\fBWARNING:\fP If you read the passphrase from stdin (without further
argument or with \*(Aq\-\*(Aq as an argument to \-\-key\-file), batch\-mode (\-q) will
be implicitly switched on and no warning will be given when you remove
the last remaining passphrase from a LUKS container. Removing the last
passphrase makes the LUKS container permanently inaccessible.
.SH "OPTIONS"
.sp
\fB\-\-batch\-mode, \-q\fP
.RS 4
Suppresses all confirmation questions. Use with care!
.sp
If the \-\-verify\-passphrase option is not specified, this option also
switches off the passphrase verification.
.RE
.sp
\fB\-\-debug or \-\-debug\-json\fP
.RS 4
Run in debug mode with full diagnostic logs. Debug output lines are
always prefixed by \fB#\fP.
.sp
If \-\-debug\-json is used, additional LUKS2 JSON data structures are printed.
.RE
.sp
\fB\-\-disable\-locks\fP
.RS 4
Disable lock protection for metadata on disk. This option is valid
only for LUKS2 and ignored for other formats.
.sp
\fBWARNING:\fP 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).
.RE
.sp
\fB\-\-header <device or file storing the LUKS header>\fP
.RS 4
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.
.sp
For commands that change the LUKS header (e.g. \fIluksAddKey\fP),
specify the device or file with the LUKS header directly as the LUKS
device.
.RE
.sp
\fB\-\-help, \-?\fP
.RS 4
Show help text and default parameters.
.RE
.sp
\fB\-\-key\-file, \-d\fP \fIname\fP
.RS 4
Read the passphrase from file.
.sp
If the name given is "\-", then the passphrase will be read from stdin.
In this case, reading will not stop at newline characters.
.sp
See section \fINOTES ON PASSPHRASE PROCESSING\fP in \fBcryptsetup\fP(8) for more information.
.RE
.sp
\fB\-\-keyfile\-offset\fP \fIvalue\fP
.RS 4
Skip \fIvalue\fP bytes at the beginning of the key file.
.RE
.sp
\fB\-\-keyfile\-size, \-l\fP \fIvalue\fP
.RS 4
Read a maximum of \fIvalue\fP bytes from the key file. The default is to
read the whole file up to the compiled\-in maximum that can be queried
with \-\-help. Supplying more data than the compiled\-in maximum aborts
the operation.
.sp
This option is useful to cut trailing newlines, for example. If
\-\-keyfile\-offset is also given, the size count starts after the offset.
.RE
.sp
\fB\-\-timeout, \-t <number of seconds>\fP
.RS 4
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.
.sp
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.
.RE
.sp
\fB\-\-type <device\-type>\fP
.RS 4
Specifies required device type, for more info read \fIBASIC ACTIONS\fP section in \fBcryptsetup\fP(8).
.RE
.sp
\fB\-\-usage\fP
.RS 4
Show short option help.
.RE
.sp
\fB\-\-verify\-passphrase, \-y\fP
.RS 4
When interactively asking for a passphrase, ask for it twice and
complain if both inputs do not match.
Ignored on input from file or stdin.
.RE
.sp
\fB\-\-version, \-V\fP
.RS 4
Show the program version.
.RE
.SH "REPORTING BUGS"
.sp
Report bugs at \c
.MTO "cryptsetup\(atlists.linux.dev" "\fBcryptsetup mailing list\fP"
or in \c
.URL "https://gitlab.com/cryptsetup/cryptsetup/\-/issues/new" "\fBIssues project section\fP" "."
.sp
Please attach output of the failed command with \-\-debug option added.
.SH "SEE ALSO"
.sp
.URL "https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions" "\fBCryptsetup FAQ\fP" ""
.sp
\fBcryptsetup\fP(8), \fBintegritysetup\fP(8) and \fBveritysetup\fP(8)
.SH "CRYPTSETUP"
.sp
Part of \c
.URL "https://gitlab.com/cryptsetup/cryptsetup/" "\fBcryptsetup project\fP" "."