|
 |
ac737d |
From 3f0f7acbc0dd72f1d98feb7af214cf12eb9bc47e Mon Sep 17 00:00:00 2001
|
|
|
ac737d |
From: Ondrej Kozina <okozina@redhat.com>
|
|
|
ac737d |
Date: Tue, 10 Jul 2018 14:36:45 +0200
|
|
|
ac737d |
Subject: [PATCH] Update cryptsetup man page for --type option usage.
|
|
|
ac737d |
|
|
|
ac737d |
Fixes #394.
|
|
|
ac737d |
---
|
|
|
ac737d |
man/cryptsetup.8 | 23 +++++++++++++----------
|
|
|
ac737d |
1 file changed, 13 insertions(+), 10 deletions(-)
|
|
|
ac737d |
|
|
|
ac737d |
diff --git a/man/cryptsetup.8 b/man/cryptsetup.8
|
|
|
ac737d |
index b2ef8cd..96d4fef 100644
|
|
|
ac737d |
--- a/man/cryptsetup.8
|
|
|
ac737d |
+++ b/man/cryptsetup.8
|
|
|
ac737d |
@@ -70,8 +70,8 @@ The following are valid actions for all supported device types.
|
|
|
ac737d |
.IP
|
|
|
ac737d |
Opens (creates a mapping with) <name> backed by device <device>.
|
|
|
ac737d |
|
|
|
ac737d |
-Device type can be \fIplain\fR, \fIluks\fR (default), \fIloopaes\fR
|
|
|
ac737d |
-or \fItcrypt\fR.
|
|
|
ac737d |
+Device type can be \fIplain\fR, \fIluks\fR (default), \fIluks1\fR, \fIluks2\fR,
|
|
|
ac737d |
+\fIloopaes\fR or \fItcrypt\fR.
|
|
|
ac737d |
|
|
|
ac737d |
For backward compatibility there are \fBopen\fR command aliases:
|
|
|
ac737d |
|
|
|
ac737d |
@@ -243,7 +243,7 @@ the command prompts for it interactively.
|
|
|
ac737d |
\fB<options>\fR can be [\-\-key\-file, \-\-keyfile\-offset,
|
|
|
ac737d |
\-\-keyfile\-size, \-\-readonly, \-\-test\-passphrase,
|
|
|
ac737d |
\-\-allow\-discards, \-\-header, \-\-key-slot, \-\-master\-key\-file, \-\-token\-id,
|
|
|
ac737d |
-\-\-token\-only, \-\-disable\-keyring, \-\-disable\-locks].
|
|
|
ac737d |
+\-\-token\-only, \-\-disable\-keyring, \-\-disable\-locks, \-\-type].
|
|
|
ac737d |
.PP
|
|
|
ac737d |
\fIluksSuspend\fR <name>
|
|
|
ac737d |
.IP
|
|
|
ac737d |
@@ -266,7 +266,7 @@ Resumes a suspended device and reinstates the encryption key.
|
|
|
ac737d |
Prompts interactively for a passphrase if \-\-key-file is not given.
|
|
|
ac737d |
|
|
|
ac737d |
\fB<options>\fR can be [\-\-key\-file, \-\-keyfile\-size, \-\-header,
|
|
|
ac737d |
-\-\-disable\-keyring,\-\-disable\-locks]
|
|
|
ac737d |
+\-\-disable\-keyring, \-\-disable\-locks, \-\-type]
|
|
|
ac737d |
.PP
|
|
|
ac737d |
\fIluksAddKey\fR <device> [<key file with new key>]
|
|
|
ac737d |
.IP
|
|
|
ac737d |
@@ -285,7 +285,7 @@ is not required.
|
|
|
ac737d |
\-\-keyfile\-size, \-\-new\-keyfile\-offset,
|
|
|
ac737d |
\-\-new\-keyfile\-size, \-\-key\-slot, \-\-master\-key\-file,
|
|
|
ac737d |
\-\-iter\-time, \-\-force\-password, \-\-header, \-\-disable\-locks,
|
|
|
ac737d |
-\-\-unbound].
|
|
|
ac737d |
+\-\-unbound, \-\-type].
|
|
|
ac737d |
.PP
|
|
|
ac737d |
\fIluksRemoveKey\fR <device> [<key file with passphrase to be removed>]
|
|
|
ac737d |
.IP
|
|
|
ac737d |
@@ -294,7 +294,7 @@ passphrase to be removed can be specified interactively,
|
|
|
ac737d |
as the positional argument or via \-\-key-file.
|
|
|
ac737d |
|
|
|
ac737d |
\fB<options>\fR can be [\-\-key\-file, \-\-keyfile\-offset,
|
|
|
ac737d |
-\-\-keyfile\-size, \-\-header, \-\-disable\-locks]
|
|
|
ac737d |
+\-\-keyfile\-size, \-\-header, \-\-disable\-locks, \-\-type]
|
|
|
ac737d |
|
|
|
ac737d |
\fBWARNING:\fR If you read the passphrase from stdin
|
|
|
ac737d |
(without further argument or with '-' as an argument
|
|
|
ac737d |
@@ -328,7 +328,7 @@ inaccessible.
|
|
|
ac737d |
\fB<options>\fR can be [\-\-key\-file, \-\-keyfile\-offset,
|
|
|
ac737d |
\-\-keyfile\-size, \-\-new\-keyfile\-offset,
|
|
|
ac737d |
\-\-new\-keyfile\-size, \-\-key\-slot, \-\-force\-password, \-\-header,
|
|
|
ac737d |
-\-\-disable\-locks].
|
|
|
ac737d |
+\-\-disable\-locks, \-\-type].
|
|
|
ac737d |
.PP
|
|
|
ac737d |
.PP
|
|
|
ac737d |
\fIluksConvertKey\fR <device>
|
|
|
ac737d |
@@ -364,7 +364,7 @@ an interactive confirmation when doing so. Removing the last
|
|
|
ac737d |
passphrase makes a LUKS container permanently inaccessible.
|
|
|
ac737d |
|
|
|
ac737d |
\fB<options>\fR can be [\-\-key\-file, \-\-keyfile\-offset,
|
|
|
ac737d |
-\-\-keyfile\-size, \-\-header, \-\-disable\-locks].
|
|
|
ac737d |
+\-\-keyfile\-size, \-\-header, \-\-disable\-locks, \-\-type].
|
|
|
ac737d |
|
|
|
ac737d |
\fBWARNING:\fR If you read the passphrase from stdin
|
|
|
ac737d |
(without further argument or with '-' as an argument
|
|
|
ac737d |
@@ -399,6 +399,8 @@ Set new UUID if \fI\-\-uuid\fR option is specified.
|
|
|
ac737d |
Returns true, if <device> is a LUKS device, false otherwise.
|
|
|
ac737d |
Use option \-v to get human-readable feedback. 'Command successful.'
|
|
|
ac737d |
means the device is a LUKS device.
|
|
|
ac737d |
+
|
|
|
ac737d |
+By specifying \-\-type you may query for specific LUKS version.
|
|
|
ac737d |
.PP
|
|
|
ac737d |
\fIluksDump\fR <device>
|
|
|
ac737d |
.IP
|
|
|
ac737d |
@@ -417,7 +419,7 @@ either interactively or via \-\-key\-file.
|
|
|
ac737d |
|
|
|
ac737d |
\fB<options>\fR can be [\-\-dump\-master\-key, \-\-key\-file,
|
|
|
ac737d |
\-\-keyfile\-offset, \-\-keyfile\-size, \-\-header, \-\-disable\-locks,
|
|
|
ac737d |
-\-\-master\-key\-file].
|
|
|
ac737d |
+\-\-master\-key\-file, \-\-type].
|
|
|
ac737d |
|
|
|
ac737d |
\fBWARNING:\fR If \-\-dump\-master\-key is used with \-\-key\-file
|
|
|
ac737d |
and the argument to \-\-key\-file is '-', no validation question
|
|
|
ac737d |
@@ -663,7 +665,8 @@ for LUKS device type.
|
|
|
ac737d |
This command is useful to fix some known benign LUKS metadata
|
|
|
ac737d |
header corruptions. Only basic corruptions of unused keyslot
|
|
|
ac737d |
are fixable. This command will only change the LUKS header, not
|
|
|
ac737d |
-any key-slot data.
|
|
|
ac737d |
+any key-slot data. You may enforce LUKS version by adding \-\-type
|
|
|
ac737d |
+option.
|
|
|
ac737d |
|
|
|
ac737d |
\fBWARNING:\fR Always create a binary backup of the original
|
|
|
ac737d |
header before calling this command.
|
|
|
ac737d |
--
|
|
|
ac737d |
1.8.3.1
|
|
|
ac737d |
|