contrib/cryptsetup/man/cryptsetup.8

   1 .TH CRYPTSETUP "8" "" "cryptsetup" "Maintenance Commands"
   2 .SH NAME
   3 cryptsetup - setup cryptographic volumes for dm-crypt (including LUKS extension)
   4 .SH SYNOPSIS
   5
   6 .B cryptsetup <options> <action> <action args>
   7 .SH DESCRIPTION
   8 .PP
   9 cryptsetup is used to conveniently setup dm-crypt managed device-mapper mappings.
  10 For basic (plain) dm-crypt mappings, there are four operations.
  11 .SH ACTIONS
  12 These strings are valid for \fB<action>\fR, followed by their \fB<action args>\fR:
  13
  14 \fIcreate\fR <name> <device>
  15 .IP
  16 creates a mapping with <name> backed by device <device>.
  17
  18 \fB<options>\fR can be [\-\-hash, \-\-cipher, \-\-verify-passphrase, \-\-key-file, \-\-key-size, \-\-offset, \-\-skip, \-\-readonly]
  19 .PP
  20 \fIremove\fR <name>
  21 .IP
  22 removes an existing mapping <name>.
  23 .PP
  24 \fIstatus\fR <name>
  25 .IP
  26 reports the status for the mapping <name>.
  27 .PP
  28 \fIresize\fR <name>
  29 .IP
  30 resizes an active mapping <name>.
  31
  32 If \-\-size (in sectors) is not specified, the size of the underlying block device is used.
  33 .PP
  34 .br
  35 .SH LUKS EXTENSION
  36
  37 LUKS, Linux Unified Key Setup, is a standard for hard disk encryption. It standardizes a partition header, as well as the format of the bulk data. LUKS can manage multiple passwords, that can be revoked effectively and that are protected against dictionary attacks with PBKDF2.
  38
  39 These are valid LUKS actions:
  40
  41 \fIluksFormat\fR <device> [<key file>]
  42 .IP
  43 initializes a LUKS partition and sets the initial key, either via prompting or via <key file>.
  44
  45 \fB<options>\fR can be [\-\-cipher, \-\-verify-passphrase, \-\-key-size, \-\-key-slot,
  46 \-\-key-file (takes precedence over optional second argument)].
  47
  48 .PP
  49 \fIluksOpen\fR <device> <name>
  50 .IP
  51 opens the LUKS partition <device> and sets up a mapping <name> after successful verification of the supplied key material (either via key file by \-\-key-file, or via prompting).
  52
  53 \fB<options>\fR can be [\-\-key-file, \-\-readonly].
  54 .PP
  55 \fIluksClose\fR <name>
  56 .IP
  57 identical to \fIremove\fR.
  58 .PP
  59 \fIluksSuspend\fR <name>
  60 .IP
  61 suspends active device (all IO operations are frozen) and wipes encryption key from kernel. Kernel version 2.6.19 or later is required.
  62
  63 After that operation you have to use \fIluksResume\fR to reinstate encryption key (and resume device) or \fIluksClose\fR to remove mapped device.
  64
  65 \fBWARNING:\fR never try to suspend device where is the cryptsetup binary itself.
  66 .PP
  67 \fIluksResume\fR <name>
  68 .IP
  69 Resumes suspended device and reinstates encryption key. You will need provide passphrase
  70 identical to \fIluksOpen\fR command (using prompting or key file).
  71
  72 \fB<options>\fR can be [\-\-key-file]
  73 .PP
  74 \fIluksAddKey\fR <device> [<new key file>]
  75 .IP
  76 add a new key file/passphrase. An existing passphrase or key file (via \-\-key-file) must be supplied.
  77 The key file with the new material is supplied as a positional argument.
  78
  79 \fB<options>\fR can be [\-\-key-file, \-\-key-slot].
  80 .PP
  81 \fIluksRemoveKey\fR <device> [<key file>]
  82 .IP
  83 remove supplied key or key file from LUKS device
  84 .PP
  85 \fIluksKillSlot\fR <device> <key slot number>
  86 .IP
  87 wipe key with number <key slot> from LUKS device. A remaining passphrase or
  88 key file (via \-\-key-file) must be supplied.
  89
  90 \fB<options>\fR can be [\-\-key-file].
  91 .PP
  92 \fIluksDelKey\fR <device> <key slot number>
  93 .IP
  94 identical to luksKillSlot, but deprecated action name.
  95 .PP
  96 \fIluksUUID\fR <device>
  97 .IP
  98 print UUID, if <device> has a LUKS header.
  99 .PP
 100 \fIisLuks\fR <device>
 101 .IP
 102 returns true, if <device> is a LUKS partition. Otherwise, false.
 103 .PP
 104 \fIluksDump\fR <device>
 105 .IP
 106 dumps the header information of a LUKS partition.
 107 .PP
 108 \fIluksHeaderBackup\fR <device> \-\-header-backup-file <file>
 109 .IP
 110 Stores binary backup of LUKS header and keyslot areas.
 111
 112 \fBWARNING:\fR Please note that with this backup file (and old passphrase knowledge) you can decrypt data even if old passphrase was wiped from real device.
 113
 114 Also note that anti-forensic splitter is not used during manipulation with backup file.
 115 .PP
 116 \fIluksHeaderRestore\fR <device> \-\-header-backup-file <file>
 117 .IP
 118
 119 Restores binary backup of LUKS header and keyslot areas from specified file.
 120
 121 \fBWARNING:\fR All the keyslot areas are overwritten, only active keyslots form backup file are available after issuing this command.
 122
 123 This command allows restoring header if device do not contain LUKS header or if the master key size and data offset in LUKS header on device match the backup file.
 124 .PP
 125
 126 For more information about LUKS, see \fBhttp://code.google.com/p/cryptsetup/wiki/Specification\fR
 127
 128 .SH OPTIONS
 129 .TP
 130 .B "\-\-verbose, \-v"
 131 Print more verbose messages.
 132 .TP
 133 .B "\-\-debug"
 134 Run in debug mode with full diagnostic logs.
 135 .TP
 136 .B "\-\-hash, \-h"
 137 For \fIcreate\fR action specifies hash to use for password hashing.
 138
 139 For \fIluksFormat\fR action specifies hash used in LUKS key setup scheme and volume key digest.
 140
 141 \fBWARNING:\fR setting hash other than \fBsha1\fR causes LUKS device incompatible with older version of cryptsetup.
 142
 143 The hash string is passed to libgcrypt, so all hashes accepted by gcrypt are supported.
 144 Default is set during compilation, compatible values with old version of cryptsetup are
 145 \fB"ripemd160"\fR for \fIcreate\fR action and \fB"sha1"\fR for \fIluksFormat\fR.
 146
 147 Use \fIcryptsetup \-\-help\fR to show defaults.
 148 .TP
 149 .B "\-\-cipher, \-c"
 150 set cipher specification string.
 151
 152 Default mode is configurable during compilation,
 153 you can see compiled-in default using \fIcryptsetup \-\-help\fR.
 154 If not changed, the default is for plain dm-crypt and LUKS mappings
 155 "aes-cbc-essiv:sha256".
 156
 157 For pre-2.6.10 kernels, use "aes-plain" as they don't understand
 158 the new cipher spec strings. To use ESSIV, use "aes-cbc-essiv:sha256".
 159
 160 For XTS mode, kernel version 2.6.24 or more recent is required.
 161 Use "aes-xts-plain" cipher specification and set key size to 256 (or 512) bits (see \-s option).
 162 .TP
 163 .B "\-\-verify-passphrase, \-y"
 164 query for passwords twice. Useful when creating a (regular) mapping for the first time, or when running \fIluksFormat\fR.
 165 .TP
 166 .B "\-\-key-file, \-d"
 167 use file as key material.
 168
 169 With LUKS, key material supplied in key files via \-d are always used for existing passphrases,
 170 except in \fIluksFormat\fR action where \-d is equivalent to positional key file argument.
 171 If you want to set a new key via a key file, you have to use a positional arg to \fIluksAddKey\fR.
 172
 173 If the key file is "-", stdin will be used. With the "-" key file reading will
 174 not stop when new line character is detected. See section \fBNOTES ON PASSWORD PROCESSING\fR for more information.
 175 .TP
 176 .B "\-\-master-key-file"
 177 Use pre-generated master key stored in file. For \fIluksFormat\fR it allows LUKS header reformatting with the same master key (if all other parameters are the same existing encrypted data remains intact).
 178
 179 For \fIluksAddKey\fR it allows adding new passphrase with only master key knowledge.
 180 .TP
 181 .B "\-\-key-slot, \-S"
 182 For LUKS operations that add key material, this options allows to you specify which key slot is selected for the new key. This option can be used for \fIluksFormat\fR and \fIluksAddKey\fR.
 183 .TP
 184 .B "\-\-key-size, \-s"
 185 set key size in bits.
 186
 187 Has to be a multiple of 8 bits. The key size is limited by the used cipher. See output of /proc/crypto for more information.
 188 Can be used for \fIcreate\fR or \fIluksFormat\fR, all other LUKS actions will use key-size specified by the LUKS header.
 189 Default is set during compilation, if not changed it is 256 bits.
 190
 191 Use \fIcryptsetup \-\-help\fR to show defaults.
 192
 193 For \fIluksOpen\fR this option specifies number of bits read from the key-file (default is exhaustive read from key-file).
 194 .TP
 195 .B "\-\-size, \-b"
 196 force the size of the underlying device in sectors.
 197 This option is only relevant for \fIcreate\fR and \fIresize\fR action.
 198 .TP
 199 .B "\-\-offset, \-o"
 200 start offset in the backend device.
 201 This option is only relevant for \fIcreate\fR action.
 202 .TP
 203 .B "\-\-skip, \-p"
 204 how many sectors of the encrypted data to skip at the beginning. This is different from the \-\-offset options with respect to IV calculations. Using \-\-offset will shift the IV calculation by the same negative amount. Hence, if \-\-offset \fIn\fR, sector \fIn\fR will be the first sector on the mapping with IV \fI0\fR. Using \-\-skip would have resulted in sector \fIn\fR being the first sector also, but with IV \fIn\fR.
 205 This option is only relevant for \fIcreate\fR action.
 206 .TP
 207 .B "\-\-readonly"
 208 set up a read-only mapping.
 209 .TP
 210 .B "\-\-iter-time, \-i"
 211 The number of milliseconds to spend with PBKDF2 password processing. This option is only relevant to the LUKS operations as \fIluksFormat\fR or \fIluksAddKey\fR.
 212 .TP
 213 .B "\-\-batch-mode, \-q"
 214 Do not ask for confirmation. Use with care! This option is only relevant for \fIluksFormat\fR, \fIluksAddKey\fR, \fIluksRemoveKey\fR or \fIluksKillSlot\fR.
 215 .TP
 216 .B "\-\-timeout, \-t"
 217 The number of seconds to wait before timeout. This option is relevant every time a password is asked, like \fIcreate\fR, \fIluksOpen\fR, \fIluksFormat\fR or \fIluksAddKey\fR. It has no effect if used in conjunction with \-\-key-file.
 218 .TP
 219 .B "\-\-tries, \-T"
 220 How often the input of the passphrase shall be retried. This option is relevant every time a password is asked, like \fIcreate\fR, \fIluksOpen\fR, \fIluksFormat\fR or \fIluksAddKey\fR. The default is 3 tries.
 221 .TP
 222 .B "\-\-align-payload=\fIvalue\fR"
 223 Align payload at a boundary of \fIvalue\fR 512-byte sectors. This option is relevant for \fIluksFormat\fR.  If your block device lives on a RAID, it is
 224 useful to align the filesystem at full stripe boundaries so it can take advantage of the RAID's geometry.  See for instance the sunit and swidth options
 225 in the mkfs.xfs manual page. By default, the payload is aligned at an 8 sector (4096 byte) boundary.
 226 .TP
 227 .B "\-\-version"
 228 Show the version.
 229
 230 .SH NOTES ON PASSWORD PROCESSING
 231 \fIFrom a terminal\fR: Password processing is new-line sensitive, meaning the reading will stop after encountering \\n. It will process the read material (without newline) with the default hash or the hash given by \-\-hash. After hashing, it will be cropped to the key size given by \-s.
 232
 233 \fIFrom stdin\fR: Reading will continue until EOF (so using e.g. /dev/random as stdin will not work), with the trailing newline stripped. After that the read data will be hashed with the default hash or the hash given by \-\-hash and the result will be cropped to the keysize given by \-s. If "plain" is used as an argument to the hash option, the input data will not be hashed.
 234 Instead, it will be zero padded (if shorter than the keysize) or truncated (if longer than the keysize) and used directly as the key. No warning will be given if the amount of data read from stdin is less than the keysize.
 235
 236 \fIFrom a key file\fR: It will be cropped to the size given by \-s. If there is insufficient key material in the key file, cryptsetup will quit with an error.
 237
 238 If \-\-key-file=- is used for reading the key from stdin, no trailing newline is stripped from the input. Without that option, cryptsetup strips trailing newlines from stdin input.
 239 .SH NOTES ON PASSWORD PROCESSING FOR LUKS
 240 LUKS uses PBKDF2 to protect against dictionary attacks (see RFC 2898).
 241
 242 LUKS will always do an exhaustive password reading. Hence, password can not be read from /dev/random, /dev/zero or any other stream that does not terminate.
 243
 244 For any password creation action (luksAddKey, or luksFormat), the user may specify how much the time the password processing should consume.
 245 Increasing the time will lead to a more secure password, but also will take luksOpen longer to complete. The default setting of one second is sufficient for good security.
 246 .SH INCOHERENT BEHAVIOUR FOR INVALID PASSWORDS/KEYS
 247 LUKS checks for a valid password or key when an encrypted partition is unlocked. Thus the luksOpen action fails with invalid password or key, contrary to the plain dm-crypt create action.
 248
 249 Please also be sure that you are using the same keyboard and language setting as during device format.
 250 .SH NOTES ON SUPPORTED CIPHERS, MODES, HASHES AND KEY SIZES
 251 The available combinations of ciphers, modes, hashes and key sizes depend on kernel support. See /proc/crypto for a list of available options. You might need to load additional kernel crypto modules in order to get more options.
 252
 253 For \-\-hash option all algorithms supported by gcrypt library are available.
 254 .SH NOTES ON PASSWORDS
 255 Mathematics can't be bribed. Make sure you keep your passwords safe. There are a few nice tricks for constructing a fallback, when suddenly out of (or after being) blue, your brain refuses to cooperate. These fallbacks are possible with LUKS, as it's only possible with LUKS to have multiple passwords.
 256 .SH AUTHORS
 257 cryptsetup is written by Christophe Saout <christophe@saout.de>
 258 .br
 259 LUKS extensions, and man page by Clemens Fruhwirth <clemens@endorphin.org>
 260 .SH "COMPATABILITY WITH OLD SUSE TWOFISH PARTITIONS"
 261 To read images created with SuSE Linux 9.2's loop_fish2 use \-\-cipher
 262 twofish-cbc-null \-s 256 \-h sha512, for images created with even
 263 older SuSE Linux use \-\-cipher twofish-cbc-null \-s 192 \-h
 264 ripemd160:20
 265
 266 .SH DEPRECATED ACTIONS
 267 .PP
 268 \fIreload\fR <name> <device>
 269 .IP
 270 modifies an active mapping <name>. Same options as for
 271 create.
 272 .B WARNING:
 273 Do not use this for LUKS devices, as the semantics
 274 are identical to the create action, which are totally incompatible
 275 with the LUKS key setup.
 276
 277 This action is deprected because it proved to be rarely useful.  It is
 278 uncommon to change the underlying device, key, or offset on the
 279 fly. In case, you really want to do this, you certainly know what you
 280 are doing and then you are probably better off with the swiss knive
 281 tool for device mapper, namely dmsetup. It provides you with the same
 282 functionality, see dmsetup reload.
 283 .PP
 284 \fIluksDelKey\fR <device> <key slot number>
 285 .IP
 286 identical to luksKillSlot, but deprecated action name. This option was
 287 renamed, as we introduced luksRemoveKey, a softer method for disabling
 288 password slots. To make a clear distinction that luksDelKey was more brutal than luksRemoveKey
 289 .PP
 290 \fI\-\-non-exclusive\fR
 291 .IP
 292 This option is ignored. Non-exclusive access to the same block device
 293 can cause data corruption thus this mode is no longer supported by cryptsetup.
 294
 295 .SH "REPORTING BUGS"
 296 Report bugs to <dm-crypt@saout.de> or Issues section on LUKS website.
 297 Please attach output of failed command with added \-\-debug option.
 298 .SH COPYRIGHT
 299 Copyright \(co 2004 Christophe Saout
 300 .br
 301 Copyright \(co 2004-2006 Clemens Fruhwirth
 302 .br
 303 Copyright \(co 2009-2010 Red Hat, Inc.
 304
 305 This is free software; see the source for copying conditions.  There is NO
 306 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 307 .SH "SEE ALSO"
 308
 309 dm-crypt website, \fBhttp://www.saout.de/misc/dm-crypt/\fR
 310
 311 LUKS website, \fBhttp://code.google.com/p/cryptsetup/\fR
 312
 313 dm-crypt TWiki, \fBhttp://www.saout.de/tikiwiki/tiki-index.php\fR