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