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 .B cryptsetup <options> <action> <action args>
   6 .SH DESCRIPTION
   7 .PP
   8 cryptsetup is used to conveniently setup dm-crypt managed device-mapper mappings.
   9 .SH PLAIN MODE
  10 For basic (plain) dm-crypt mappings, there are four operations.
  11
  12 \fIcreate\fR <name> <device>
  13 .IP
  14 creates a mapping with <name> backed by device <device>.
  15
  16 \fB<options>\fR can be [\-\-hash, \-\-cipher, \-\-verify-passphrase,
  17 \-\-key-file, \-\-key-size, \-\-offset, \-\-skip, \-\-size, \-\-readonly, \-\-shared,
  18 \-\-allow-discards]
  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 .SH LUKS EXTENSION
  34 LUKS, Linux Unified Key Setup, is a standard for hard disk encryption.
  35 It standardizes a partition header, as well as the format of the bulk data.
  36 LUKS can manage multiple passwords, that can be revoked effectively
  37 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,
  46 \-\-key-slot, \-\-key-file (takes precedence over optional second argument),
  47 \-\-keyfile-size, \-\-use-random | \-\-use-urandom, \-\-uuid].
  48 .PP
  49 \fIluksOpen\fR <device> <name>
  50 .IP
  51 opens the LUKS partition <device> and sets up a mapping <name> after
  52 successful verification of the supplied key material
  53 (either via key file by \-\-key-file, or via prompting).
  54
  55 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size, \-\-readonly, \-\-allow-discards].
  56 .PP
  57 \fIluksClose\fR <name>
  58 .IP
  59 identical to \fIremove\fR.
  60 .PP
  61 \fIluksSuspend\fR <name>
  62 .IP
  63 suspends active device (all IO operations are frozen) and wipes encryption
  64 key from kernel. Kernel version 2.6.19 or later is required.
  65
  66 After that operation you have to use \fIluksResume\fR to reinstate
  67 encryption key (and resume device) or \fIluksClose\fR to remove mapped device.
  68
  69 \fBWARNING:\fR never try to suspend device where is the cryptsetup binary itself.
  70 .PP
  71 \fIluksResume\fR <name>
  72 .IP
  73 Resumes suspended device and reinstates encryption key. You will need provide passphrase
  74 identical to \fIluksOpen\fR command (using prompting or key file).
  75
  76 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size]
  77 .PP
  78 \fIluksAddKey\fR <device> [<new key file>]
  79 .IP
  80 add a new key file/passphrase. An existing passphrase or key file
  81 (via \-\-key-file) must be supplied.
  82 The key file with the new material is supplied as a positional argument.
  83
  84 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size, \-\-new-keyfile-size, \-\-key-slot].
  85 .PP
  86 \fIluksRemoveKey\fR <device> [<key file>]
  87 .IP
  88 remove supplied key or key file from LUKS device
  89 .PP
  90 \fIluksChangeKey\fR <device> [<new key file>]
  91 .IP
  92 change existing key file or passphrase. An existing passphrase
  93 or key file (via \-\-key-file) must be supplied.
  94 The key file with the new material is supplied as a positional argument.
  95
  96 If no key slot is specified (and there is still free key slot on device)
  97 new slot is allocated before the old is purged.
  98
  99 If \fB\-\-key\-slot\fR option is specified (or there is no free slot)
 100 command will overwrite existing slot.
 101
 102 \fBWARNING:\fR Be sure you have another slot active or header backup
 103 when using explicit key slot (so you can unlock the device even after
 104 possible media failure during slot swap).
 105
 106 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size,\-\-new-keyfile-size,
 107 \-\-key-slot].
 108 .PP
 109 \fIluksKillSlot\fR <device> <key slot number>
 110 .IP
 111 wipe key with number <key slot> from LUKS device. A remaining passphrase or
 112 key file (via \-\-key-file) must be supplied.
 113
 114 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size].
 115 .PP
 116 \fIluksUUID\fR <device>
 117 .IP
 118 print UUID, if <device> has a LUKS header.
 119
 120 set new UUID if \fI\-\-uuid\fR option is specified.
 121 .PP
 122 \fIisLuks\fR <device>
 123 .IP
 124 returns true, if <device> is a LUKS partition. Otherwise, false.
 125 .PP
 126 \fIluksDump\fR <device>
 127 .IP
 128 dumps the header information of a LUKS partition.
 129
 130 If \-\-dump-master-key option is used, the volume (master) key is dumped
 131 instead of keyslot info.
 132
 133 Because this information can be used to access encrypted device without
 134 passphrase knowledge (even without LUKS header) use this option
 135 very carefully.
 136
 137 Dump with volume key (either printed or stored to file) should be always
 138 stored encrypted and on safe place.
 139
 140 LUKS passphrase or key file is required for volume key dump.
 141
 142 \fB<options>\fR can be [\-\-dump-master-key, \-\-key-file, \-\-keyfile-size].
 143 .PP
 144 \fIluksHeaderBackup\fR <device> \-\-header-backup-file <file>
 145 .IP
 146 Stores binary backup of LUKS header and keyslot areas.
 147
 148 \fBWARNING:\fR Please note that with this backup file (and old passphrase
 149 knowledge) you can decrypt data even if old passphrase was wiped from real device.
 150
 151 Also note that anti-forensic splitter is not used during manipulation with backup file.
 152 .PP
 153 \fIluksHeaderRestore\fR <device> \-\-header-backup-file <file>
 154 .IP
 155 Restores binary backup of LUKS header and keyslot areas from specified file.
 156
 157 \fBWARNING:\fR All the keyslot areas are overwritten, only active keyslots
 158 form backup file are available after issuing this command.
 159
 160 This command allows restoring header if device do not contain LUKS header
 161 or if the master key size and data offset in LUKS header on device match the backup file.
 162 .PP
 163 For more information about LUKS, see
 164 \fBhttp://code.google.com/p/cryptsetup/wiki/Specification\fR
 165 .SH loop-AES EXTENSION
 166 cryptsetup supports mapping of loop-AES encrypted partition using
 167 compatible dm-crypt mode.
 168 .PP
 169 \fIloopaesOpen\fR <device> <name> \-\-key-file <keyfile>
 170 .IP
 171 opens the loop-AES <device> and sets up a mapping <name>.
 172
 173 N.B. If key file is in GPG encrypted format, you have to use
 174 \-\-key-file=- and decrypt it before use.
 175 gpg \-\-decrypt <keyfile> | cryptsetup loopaesOpen \-\-key-file=- <device> <name>
 176
 177 Use \fB\-\-key-file\fR to specify proper key length, default compiled-in
 178 parameters are visible in \fB\-\-help\fR output.
 179
 180 Use \fB\-\-offset\fR to specify device offset. Note the units need to be
 181 specified in 512 bytes sectors.
 182
 183 Use \fB\-\-skip\fR to specify IV offset. If original device used offset
 184 and not used it in IV sector calculations, you have to explicitly use
 185 \fB\-\-skip 0\fR in addition to offset parameter.
 186
 187 Use \fB\-\-hash\fR to override hash function for password hashing
 188 (otherwise it is detected according to key size).
 189
 190 \fB<options>\fR can be [\-\-key-file, \-\-key-size, \-\-offset, \-\-skip,
 191 \-\-hash, \-\-readonly, \-\-allow-discards].
 192 .PP
 193 \fIloopaesClose\fR <name>
 194 .IP
 195 identical to \fIremove\fR.
 196 .PP
 197 For more information about loop-AES, see \fBhttp://loop-aes.sourceforge.net\fR
 198 .SH OPTIONS
 199 .TP
 200 .B "\-\-verbose, \-v"
 201 Print more verbose messages.
 202 .TP
 203 .B "\-\-debug"
 204 Run in debug mode with full diagnostic logs.
 205 .TP
 206 .B "\-\-hash, \-h"
 207 For \fIcreate\fR and \fIloopaesOpen\fR action specifies hash to use for password hashing.
 208
 209 For \fIluksFormat\fR action specifies hash used in LUKS key setup scheme
 210 and volume key digest.
 211
 212 \fBWARNING:\fR setting hash other than \fBsha1\fR causes LUKS device
 213 incompatible with older version of cryptsetup.
 214
 215 The hash string is passed to libgcrypt, so all hash algorithms are supported
 216 (for \fIluksFormat\fR algorithm must provide at least 20 byte long hash).
 217 Default is set during compilation, compatible values with old version of cryptsetup are
 218 \fB"ripemd160"\fR for \fIcreate\fR action and \fB"sha1"\fR for \fIluksFormat\fR.
 219
 220 Use \fIcryptsetup \-\-help\fR to show defaults.
 221 .TP
 222 .B "\-\-cipher, \-c"
 223 set cipher specification string.
 224
 225 Default mode is configurable during compilation,
 226 you can see compiled-in default using \fIcryptsetup \-\-help\fR.
 227 If not changed, the default is for plain dm-crypt and LUKS mappings
 228 "aes-cbc-essiv:sha256".
 229
 230 For XTS mode, kernel version 2.6.24 or more recent is required.
 231 Use "aes-xts-plain64" cipher specification and set key size to 256
 232 (or 512) bits (see \-s option).
 233 Note that plain64 IV (Initialization Vector) is available since kernel version 2.6.33
 234 and it is full 64bit version of plain IV. For more info please see FAQ.
 235 .TP
 236 .B "\-\-verify-passphrase, \-y"
 237 query for passwords twice. Useful when creating a (regular) mapping
 238 for the first time, or when running \fIluksFormat\fR.
 239 .TP
 240 .B "\-\-key-file, \-d"
 241 use file as key material.
 242
 243 With LUKS, key material supplied in key files via \-d are always used
 244 for existing passphrases, except in \fIluksFormat\fR action where
 245 \-d is equivalent to positional key file argument.
 246
 247 If you want to set a new key via a key file, you have to use
 248 a positional arg to \fIluksAddKey\fR.
 249
 250 If the key file is "-", stdin will be used. With the "-" key file
 251 reading will not stop when new line character is detected.
 252
 253 See section \fBNOTES ON PASSWORD PROCESSING\fR for more information.
 254 .TP
 255 .B "\-\-keyfile-size, \-l \fIvalue\fR"
 256 Limits read from key file to \fIvalue\fR bytes.
 257 Usable together with all commands using key file.
 258 .TP
 259 .B "\-\-new-keyfile-size  \fIvalue\fR"
 260 Limits read from new key file to \fIvalue\fR bytes in \fIluksAddKey\fR when
 261 adding new key file. Default is exhaustive read from key file.
 262 .TP
 263 .B "\-\-master-key-file"
 264 Use pre-generated master key stored in file. For \fIluksFormat\fR it allows
 265 LUKS header reformatting with the same master key (if all other parameters
 266 are the same existing encrypted data remains intact).
 267
 268 For \fIluksAddKey\fR it allows adding new passphrase with only master key knowledge.
 269 .TP
 270 .B "\-\-dump-master-key"
 271 For \fIluksDump\fR it allows LUKS header dump including volume (master) key.
 272 Use with care (this information allows access to device without passphrase knowledge).
 273
 274 See \fIluksDump\fR for more info.
 275 .TP
 276 .B "\-\-use-random"
 277 .TP
 278 .B "\-\-use-urandom"
 279 For \fIluksFormat\fR it defines which kernel random number generator will
 280 be used for long-term key (volume key).
 281
 282 See \fBNOTES ON RNG\fR for more information. Use \fIcryptsetup \-\-help\fR
 283 to show default RNG.
 284 .TP
 285 .B "\-\-key-slot, \-S"
 286 For LUKS operations that add key material, this options allows you
 287 to specify which key slot is selected for the new key.
 288 This option can be used for \fIluksFormat\fR and \fIluksAddKey\fR.
 289 .TP
 290 .B "\-\-key-size, \-s"
 291 set key size in bits.
 292
 293 Has to be a multiple of 8 bits. The key size is limited by the used cipher.
 294
 295 See output of /proc/crypto for more information.
 296
 297 Can be used for \fIcreate\fR or \fIluksFormat\fR, all other LUKS actions
 298 will use key-size specified by the LUKS header.
 299 Default is set during compilation, if not changed it is 256 bits.
 300
 301 Use \fIcryptsetup \-\-help\fR to show defaults.
 302 .TP
 303 .B "\-\-size, \-b"
 304 force the size of the underlying device in sectors.
 305 This option is only relevant for \fIcreate\fR and \fIresize\fR action.
 306 .TP
 307 .B "\-\-offset, \-o"
 308 start offset in the backend device (in 512-byte sectors).
 309 This option is only relevant for \fIcreate\fR and \fIloopaesOpen\fR action.
 310 .TP
 311 .B "\-\-skip, \-p"
 312 how many sectors of the encrypted data to skip at the beginning.
 313 This is different from the \-\-offset options with respect to IV calculations.
 314 Using \-\-offset will shift the IV calculation by the same negative amount.
 315 Hence, if \-\-offset \fIn\fR, sector \fIn\fR will be the first sector
 316 on the mapping with IV \fI0\fR. Using \-\-skip would have resulted in sector
 317 \fIn\fR being the first sector also, but with IV \fIn\fR.
 318 This option is only relevant for \fIcreate\fR and \fIloopaesOpen\fR action.
 319 .TP
 320 .B "\-\-readonly"
 321 set up a read-only mapping.
 322 .TP
 323 .B "\-\-shared"
 324 create another non-overlapping mapping to one common ciphertext device,
 325 e.g. to create hidden device inside another encrypted device.
 326 This option is only relevant for \fIcreate\fR action.
 327 Use \-\-offset, \-\-size and \-\-skip to specify mapped area.
 328 .TP
 329 .B "\-\-iter-time, \-i"
 330 The number of milliseconds to spend with PBKDF2 password processing.
 331 This option is only relevant to the LUKS operations as
 332 \fIluksFormat\fR or \fIluksAddKey\fR.
 333 Note that 0 means default.
 334 .TP
 335 .B "\-\-batch-mode, \-q"
 336 Do not ask for confirmation. Use with care! This option is only relevant
 337 for \fIluksFormat\fR, \fIluksAddKey\fR, \fIluksRemoveKey\fR or \fIluksKillSlot\fR.
 338 .TP
 339 .B "\-\-timeout, \-t"
 340 The number of seconds to wait before timeout. This option is relevant every
 341 time a password is asked, like \fIcreate\fR, \fIluksOpen\fR, \fIluksFormat\fR
 342 or \fIluksAddKey\fR. It has no effect if used in conjunction with \-\-key-file.
 343 .TP
 344 .B "\-\-tries, \-T"
 345 How often the input of the passphrase shall be retried. This option is relevant
 346 every time a password is asked, like \fIcreate\fR, \fIluksOpen\fR, \fIluksFormat\fR
 347 or \fIluksAddKey\fR. The default is 3 tries.
 348 .TP
 349 .B "\-\-align-payload=\fIvalue\fR"
 350 Align payload at a boundary of \fIvalue\fR 512-byte sectors.
 351 This option is relevant for \fIluksFormat\fR.
 352
 353 If not specified, cryptsetup tries to use topology info provided by kernel
 354 for underlying device to get optimal alignment.
 355 If not available (or calculated value is multiple of default) data is by
 356 default aligned to 1 MiB boundary (2048 512-byte sectors).
 357 .TP
 358 .B "\-\-uuid=\fIUUID\fR"
 359 Use provided \fIUUID\fR in \fIluksFormat\fR command instead of generating
 360 new one or change existing UUID in \fIluksUUID\fR command.
 361
 362 The UUID must be provided in standard UUID format
 363 (e.g. 12345678-1234-1234-1234-123456789abc).
 364 .TP
 365 .B "\-\-allow-discards\fR"
 366 Allow using of discards (TRIM) requests for device.
 367 This option is only relevant for \fIcreate\fR, \fIluksOpen\fR or \fIloopaesOpen\fR.
 368
 369 \fBWARNING:\fR Assess the specific security risks carefully before enabling this
 370 option.  For example, allowing discards on encrypted devices may lead to the leak
 371 of information about the ciphertext device (filesystem type, used space etc.)
 372 if the discarded blocks can be located easily on the device later.
 373
 374 Kernel version 3.1 or more recent is required.
 375 For older versions is the option ignored.
 376 .TP
 377 .B "\-\-version"
 378 Show the version.
 379 .SH RETURN CODES
 380 Crypsetup returns 0 on success or non-zero on error.
 381
 382 Error codes are: 1 wrong parameters, 2 no permission (bad passphrase),
 383 3 out of memory, 4 wrong device specified, 5 device already exists
 384 or device is busy.
 385 .SH NOTES ON PASSWORD PROCESSING FOR PLAIN MODE
 386 \fBFrom a terminal\fR: Password processing is new-line sensitive,
 387 meaning the reading will stop after encountering \\n.
 388 It will process the read material (without newline) with the default
 389 hash or the hash given by \-\-hash.
 390 After hashing, it will be cropped to the key size given by \-s.
 391
 392 \fBFrom stdin\fR: Reading will continue until EOF (or until
 393 maximum input size is reached), with the trailing newline stripped.
 394 The maximum input size is defined by the same compiled-in default
 395 as for the maximum key file size or can be overwrittten
 396 using \-\-keysfile-size option.
 397
 398 After that the read data will be hashed with the default hash
 399 or the hash given by \-\-hash and the result will be cropped
 400 to the keysize given by \-s.
 401
 402 If "plain" is used as an argument to the hash option, the input
 403 data will not be hashed.
 404 Instead, it will be zero padded (if shorter than the keysize) or
 405 truncated (if longer than the keysize) and used directly as the key.
 406 No warning will be given if the amount of data read from stdin is
 407 less than the keysize.
 408
 409 \fBFrom a key file\fR: It will be cropped to the size given by \-s.
 410 If there is insufficient key material in the key file, cryptsetup
 411 will quit with an error.
 412
 413 If \-\-key-file=- is used for reading the key from stdin, no
 414 trailing newline is stripped from the input. Without that option,
 415 cryptsetup strips trailing newlines from stdin input.
 416 .SH NOTES ON PASSWORD PROCESSING FOR LUKS
 417 LUKS uses PBKDF2 to protect against dictionary attacks (see RFC 2898).
 418
 419 LUKS will always do an exhaustive password reading.
 420 Hence, password can not be read from /dev/random, /dev/zero or any
 421 other stream that does not terminate.
 422 To prevent exhausting of system memory, cryptsetup limits
 423 maximum key file size. Compiled-in default is displayed in \-\-help
 424 output. You can limit reads from key file using \-\-key-size option,
 425 this option takes precedence over compiled-in default.
 426
 427 For any password creation action (luksAddKey, or luksFormat),
 428 the user may specify how much the time the password processing
 429 should consume. Increasing the time will lead to a more secure
 430 password, but also will take luksOpen longer to complete.
 431 The default setting of one second is sufficient for good security.
 432 .SH INCOHERENT BEHAVIOUR FOR INVALID PASSWORDS/KEYS
 433 LUKS checks for a valid password or key when an encrypted partition
 434 is unlocked. Thus the luksOpen action fails with invalid password
 435 or key, contrary to the plain dm-crypt create action.
 436
 437 Please also be sure that you are using the same keyboard and
 438 language setting as during device format.
 439 .SH NOTES ON SUPPORTED CIPHERS, MODES, HASHES AND KEY SIZES
 440 The available combinations of ciphers, modes, hashes and key sizes
 441 depend on kernel support. See /proc/crypto for a list of available
 442 options. You might need to load additional kernel crypto modules
 443 in order to get more options.
 444
 445 For \-\-hash option all algorithms supported by gcrypt library are available.
 446 .SH NOTES ON PASSWORDS
 447 Mathematics can't be bribed. Make sure you keep your passwords safe.
 448 There are a few nice tricks for constructing a fallback, when suddenly
 449 out of (or after being) blue, your brain refuses to cooperate.
 450 These fallbacks are possible with LUKS, as it's only possible with LUKS
 451 to have multiple passwords.
 452 .SH NOTES ON RNG
 453 Random Number Generator (RNG) used in cryptsetup always uses kernel RNG without
 454 any modifications or additions to data stream procudes by kernel (like internal
 455 random pool operations or mixing with the other random sources).
 456
 457 There are two types of randomness cryptsetup/LUKS needs. One type (which always
 458 uses /dev/urandom) is used for salt, AF splitter and for wiping removed
 459 keyslot.
 460
 461 Second type is used for volume (master) key. You can switch between
 462 using /dev/random and /dev/urandom  here, see \fP\-\-use-random\fR and \fP\-\-use-urandom\fR
 463 options. Using /dev/random on system without enough entropy sources
 464 can cause \fPluksFormat\fR to block until the requested amount of random data is gathered.
 465 See \fPurandom(4)\fR for more information.
 466 .SH NOTES ON LOOPBACK DEVICE USE
 467 Cryptsetup is usually used directly over block device (like disk partition or LVM volume).
 468 However if the device argument is file, cryptsetup tries to allocate loopback device
 469 and map it into this file. This mode requires Linux kernel 2.6.25 or more recent which
 470 supports loop autoclear flag (loop device is cleared on last close automatically).
 471
 472 When device mapping is active, you can see loop backing file in status command output.
 473 Also see losetup(8).
 474 .SH AUTHORS
 475 cryptsetup is written by Christophe Saout <christophe@saout.de>
 476 .br
 477 LUKS extensions, and man page by Clemens Fruhwirth <clemens@endorphin.org>
 478 .SH DEPRECATED ACTIONS
 479 .PP
 480 The \fIreload\fR action is no longer supported.
 481 Please use \fIdmsetup(8)\fR if you need to
 482 directly manipulate with the device mapping table.
 483 .PP
 484 The \fIluksDelKey\fR was replaced with \fIluksKillSlot\fR.
 485 .PP
 486 .SH REPORTING BUGS
 487 Report bugs to <dm-crypt@saout.de> or Issues section on LUKS website.
 488 Please attach output of failed command with added \-\-debug option.
 489 .SH COPYRIGHT
 490 Copyright \(co 2004 Christophe Saout
 491 .br
 492 Copyright \(co 2004-2006 Clemens Fruhwirth
 493 .br
 494 Copyright \(co 2009-2011 Red Hat, Inc.
 495
 496 This is free software; see the source for copying conditions.  There is NO
 497 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 498 .SH SEE ALSO
 499 LUKS website, \fBhttp://code.google.com/p/cryptsetup/\fR