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), \-\-keyfile-size, \-\-use-random | \-\-use-urandom, \-\-uuid].
  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, \-\-keyfile-size, \-\-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, \-\-keyfile-size]
  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, \-\-keyfile-size, \-\-new-keyfile-size, \-\-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 \fIluksChangeKey\fR <device> [<new key file>]
  86 .IP
  87 change existing key file or passphrase. An existing passphrase or key file (via \-\-key-file) must be supplied.
  88 The key file with the new material is supplied as a positional argument.
  89
  90 If no key slot is specified (and there is still free key slot on device) new slot is allocated before the old is purged.
  91
  92 If \fB\-\-key\-slot\fR option is specified (or there is no free slot) command will overwrite existing slot.
  93
  94 \fBWARNING:\fR Be sure you have another slot active or header backup when using explicit key slot (so you can
  95 unlock the device even after possible media failure during slot swap).
  96
  97 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size, \-\-new-keyfile-size, \-\-key-slot].
  98 .PP
  99 \fIluksKillSlot\fR <device> <key slot number>
 100 .IP
 101 wipe key with number <key slot> from LUKS device. A remaining passphrase or
 102 key file (via \-\-key-file) must be supplied.
 103
 104 \fB<options>\fR can be [\-\-key-file, \-\-keyfile-size].
 105 .PP
 106 \fIluksUUID\fR <device>
 107 .IP
 108 print UUID, if <device> has a LUKS header.
 109
 110 set new UUID if \fI\-\-uuid\fR option is specified.
 111 .PP
 112 \fIisLuks\fR <device>
 113 .IP
 114 returns true, if <device> is a LUKS partition. Otherwise, false.
 115 .PP
 116 \fIluksDump\fR <device>
 117 .IP
 118 dumps the header information of a LUKS partition.
 119
 120 If \-\-dump-master-key option is used, the volume (master) key is dumped instead of keyslot info.
 121 Because this information can be used to access encrypted device without passphrase knowledge
 122 (even without LUKS header) use this option very carefully.
 123
 124 Dump with volume key (either printed or stored to file) should be always stored encrypted
 125 and on safe place.
 126
 127 LUKS passphrase or key file is required for volume key dump.
 128
 129 \fB<options>\fR can be [\-\-dump-master-key, \-\-key-file, \-\-keyfile-size].
 130 .PP
 131 \fIluksHeaderBackup\fR <device> \-\-header-backup-file <file>
 132 .IP
 133 Stores binary backup of LUKS header and keyslot areas.
 134
 135 \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.
 136
 137 Also note that anti-forensic splitter is not used during manipulation with backup file.
 138 .PP
 139 \fIluksHeaderRestore\fR <device> \-\-header-backup-file <file>
 140 .IP
 141
 142 Restores binary backup of LUKS header and keyslot areas from specified file.
 143
 144 \fBWARNING:\fR All the keyslot areas are overwritten, only active keyslots form backup file are available after issuing this command.
 145
 146 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.
 147 .PP
 148
 149 For more information about LUKS, see \fBhttp://code.google.com/p/cryptsetup/wiki/Specification\fR
 150
 151 .SH Loop-AES EXTENSION
 152
 153 cryptsetup allows to map loop-AES encrypted partition using compatible dm-crypt mode.
 154
 155 .PP
 156 \fIloopaesOpen\fR <device> <name> \-\-key-file <keyfile>
 157 .IP
 158 opens the loop-AES <device> and sets up a mapping <name>.
 159
 160 N.B. If keyfile is in GPG encrypted format, you have to use \-\-key-file=- and decrypt it before use.
 161 gpg --decrypt <keyfile> | cryptsetup loopaesOpen \-\-key-file=- <device> <name>
 162
 163 \fB<options>\fR can be [\-\-key-file, \-\-key-size, \-\-offset, \-\-readonly].
 164 .PP
 165 \fIloopaesClose\fR <name>
 166 .IP
 167 identical to \fIremove\fR.
 168 .PP
 169 For more information about loop-AES, see \fBhttp://loop-aes.sourceforge.net\fR
 170
 171 .SH OPTIONS
 172 .TP
 173 .B "\-\-verbose, \-v"
 174 Print more verbose messages.
 175 .TP
 176 .B "\-\-debug"
 177 Run in debug mode with full diagnostic logs.
 178 .TP
 179 .B "\-\-hash, \-h"
 180 For \fIcreate\fR action specifies hash to use for password hashing.
 181
 182 For \fIluksFormat\fR action specifies hash used in LUKS key setup scheme and volume key digest.
 183
 184 \fBWARNING:\fR setting hash other than \fBsha1\fR causes LUKS device incompatible with older version of cryptsetup.
 185
 186 The hash string is passed to libgcrypt, so all hash algorithms are supported
 187 (for \fIluksFormat\fR algorithm must provide at least 20 byte long hash).
 188 Default is set during compilation, compatible values with old version of cryptsetup are
 189 \fB"ripemd160"\fR for \fIcreate\fR action and \fB"sha1"\fR for \fIluksFormat\fR.
 190
 191 Use \fIcryptsetup \-\-help\fR to show defaults.
 192 .TP
 193 .B "\-\-cipher, \-c"
 194 set cipher specification string.
 195
 196 Default mode is configurable during compilation,
 197 you can see compiled-in default using \fIcryptsetup \-\-help\fR.
 198 If not changed, the default is for plain dm-crypt and LUKS mappings
 199 "aes-cbc-essiv:sha256".
 200
 201 For pre-2.6.10 kernels, use "aes-plain" as they don't understand
 202 the new cipher spec strings. To use ESSIV, use "aes-cbc-essiv:sha256".
 203
 204 For XTS mode, kernel version 2.6.24 or more recent is required.
 205 Use "aes-xts-plain" cipher specification and set key size to 256 (or 512) bits (see \-s option).
 206 .TP
 207 .B "\-\-verify-passphrase, \-y"
 208 query for passwords twice. Useful when creating a (regular) mapping for the first time, or when running \fIluksFormat\fR.
 209 .TP
 210 .B "\-\-key-file, \-d"
 211 use file as key material.
 212
 213 With LUKS, key material supplied in key files via \-d are always used for existing passphrases,
 214 except in \fIluksFormat\fR action where \-d is equivalent to positional key file argument.
 215 If you want to set a new key via a key file, you have to use a positional arg to \fIluksAddKey\fR.
 216
 217 If the key file is "-", stdin will be used. With the "-" key file reading will
 218 not stop when new line character is detected. See section \fBNOTES ON PASSWORD PROCESSING\fR for more information.
 219 .TP
 220 .B "\-\-keyfile-size, \-d \fIvalue\fR"
 221 Limits read from keyfile to \fIvalue\fR bytes.
 222 Usable together with all comands using key file.
 223 .TP
 224 .B "\-\-new-keyfile-size  \fIvalue\fR"
 225 Limits read from new keyfile to \fIvalue\fR bytes in \fIluksAddKey\fR when adding new key file.
 226 Default is exhaustive read from key file.
 227 .TP
 228 .B "\-\-master-key-file"
 229 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).
 230
 231 For \fIluksAddKey\fR it allows adding new passphrase with only master key knowledge.
 232 .TP
 233 .B "\-\-dump-master-key"
 234 For \fIluksDump\fR it allows LUKS header dump including volume (master) key.
 235 Use with care (this information allows access to device without passphrase knowledge).
 236
 237 See \fIluksDump\fR for more info.
 238 .TP
 239 .B "\-\-use-random"
 240 .TP
 241 .B "\-\-use-urandom"
 242 For \fIluksFormat\fR it defines which kernel random number generator will be used for long-term key (volume key).
 243
 244 See \fBNOTES ON RNG\fR for more information. Use \fIcryptsetup \-\-help\fR to show default RNG.
 245 .TP
 246 .B "\-\-key-slot, \-S"
 247 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.
 248 .TP
 249 .B "\-\-key-size, \-s"
 250 set key size in bits.
 251
 252 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.
 253 Can be used for \fIcreate\fR or \fIluksFormat\fR, all other LUKS actions will use key-size specified by the LUKS header.
 254 Default is set during compilation, if not changed it is 256 bits.
 255
 256 Use \fIcryptsetup \-\-help\fR to show defaults.
 257 .TP
 258 .B "\-\-size, \-b"
 259 force the size of the underlying device in sectors.
 260 This option is only relevant for \fIcreate\fR and \fIresize\fR action.
 261 .TP
 262 .B "\-\-offset, \-o"
 263 start offset in the backend device (in 512-byte sectors).
 264 This option is only relevant for \fIcreate\fR action.
 265 .TP
 266 .B "\-\-skip, \-p"
 267 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.
 268 This option is only relevant for \fIcreate\fR action.
 269 .TP
 270 .B "\-\-readonly"
 271 set up a read-only mapping.
 272 .TP
 273 .B "\-\-iter-time, \-i"
 274 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.
 275 Note that 0 means default.
 276 .TP
 277 .B "\-\-batch-mode, \-q"
 278 Do not ask for confirmation. Use with care! This option is only relevant for \fIluksFormat\fR, \fIluksAddKey\fR, \fIluksRemoveKey\fR or \fIluksKillSlot\fR.
 279 .TP
 280 .B "\-\-timeout, \-t"
 281 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.
 282 .TP
 283 .B "\-\-tries, \-T"
 284 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.
 285 .TP
 286 .B "\-\-align-payload=\fIvalue\fR"
 287 Align payload at a boundary of \fIvalue\fR 512-byte sectors. This option is relevant for \fIluksFormat\fR.
 288 If not specified, cryptsetup tries to use topology info provided by kernel for underlying device to get optimal alignment.
 289 If not available (or calculated value is multiple of default) data is by default aligned to 1 MiB boundary (2048 512-byte sectors).
 290 .TP
 291 .B "\-\-uuid=\fIUUID\fR"
 292 Use provided \fIUUID\fR in \fIluksFormat\fR command instead of generating new one or change existing UUID in \fIluksUUID\fR command.
 293
 294 The UUID must be provided in standard UUID format (e.g. 12345678-1234-1234-1234-123456789abc).
 295 .TP
 296 .B "\-\-version"
 297 Show the version.
 298
 299 .SH NOTES ON PASSWORD PROCESSING
 300 \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.
 301
 302 \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.
 303 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.
 304
 305 \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.
 306
 307 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.
 308 .SH NOTES ON PASSWORD PROCESSING FOR LUKS
 309 LUKS uses PBKDF2 to protect against dictionary attacks (see RFC 2898).
 310
 311 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.
 312
 313 For any password creation action (luksAddKey, or luksFormat), the user may specify how much the time the password processing should consume.
 314 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.
 315 .SH INCOHERENT BEHAVIOUR FOR INVALID PASSWORDS/KEYS
 316 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.
 317
 318 Please also be sure that you are using the same keyboard and language setting as during device format.
 319 .SH NOTES ON SUPPORTED CIPHERS, MODES, HASHES AND KEY SIZES
 320 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.
 321
 322 For \-\-hash option all algorithms supported by gcrypt library are available.
 323 .SH NOTES ON PASSWORDS
 324 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.
 325 .SH NOTES ON RNG
 326 Random Number Generator (RNG) used in cryptsetup always uses kernel RNG without
 327 any modifications or additions to data stream procudes by kernel (like internal
 328 random pool operations or mixing with the other random sources).
 329
 330 There are two types of randomness cryptsetup/LUKS needs. One type (which always
 331 uses /dev/urandom) is used for salt, AF splitter and for wiping removed
 332 keyslot.
 333
 334 Second type is used for volume (master) key. You can switch between
 335 using /dev/random and /dev/urandom  here, see \fP--use-random\fR and \fP--use-urandom\fR
 336 options. Using /dev/random on system without enough entropy sources
 337 can cause \fPluksFormat\fR to block until the requested amount of random data is gathered.
 338 See \fPurandom(4)\fR for more information.
 339 .SH NOTES ON LOOPBACK DEVICE USE
 340 Cryptsetup is usually used directly over block device (like disk partition or LVM volume).
 341 However if the device argument is file, cryptsetup tries to allocate loopback device
 342 and map it into this file. This mode requires Linux kernel 2.6.25 or more recent which
 343 supports loop autoclear flag (loop device is cleared on last close automatically).
 344
 345 When device mapping is active, you can see loop backing file in status command output.
 346 Also see losetup(8).
 347 .SH AUTHORS
 348 cryptsetup is written by Christophe Saout <christophe@saout.de>
 349 .br
 350 LUKS extensions, and man page by Clemens Fruhwirth <clemens@endorphin.org>
 351 .SH DEPRECATED ACTIONS
 352 .PP
 353 The \fIreload\fR action is no longer supported.
 354 Please use \fIdmsetup(8)\fR if you need to
 355 directly manipulate with the device mapping table.
 356 .PP
 357 The \fIluksDelKey\fR was replaced with \fIluksKillSlot\fR.
 358 .PP
 359 .SH "REPORTING BUGS"
 360 Report bugs to <dm-crypt@saout.de> or Issues section on LUKS website.
 361 Please attach output of failed command with added \-\-debug option.
 362 .SH COPYRIGHT
 363 Copyright \(co 2004 Christophe Saout
 364 .br
 365 Copyright \(co 2004-2006 Clemens Fruhwirth
 366 .br
 367 Copyright \(co 2009-2011 Red Hat, Inc.
 368
 369 This is free software; see the source for copying conditions.  There is NO
 370 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 371 .SH "SEE ALSO"
 372
 373 LUKS website, \fBhttp://code.google.com/p/cryptsetup/\fR