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), \-\-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, \-\-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
 100 set new UUID if \fI\-\-uuid\fR option is specified.
 101 .PP
 102 \fIisLuks\fR <device>
 103 .IP
 104 returns true, if <device> is a LUKS partition. Otherwise, false.
 105 .PP
 106 \fIluksDump\fR <device>
 107 .IP
 108 dumps the header information of a LUKS partition.
 109 .PP
 110 \fIluksHeaderBackup\fR <device> \-\-header-backup-file <file>
 111 .IP
 112 Stores binary backup of LUKS header and keyslot areas.
 113
 114 \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.
 115
 116 Also note that anti-forensic splitter is not used during manipulation with backup file.
 117 .PP
 118 \fIluksHeaderRestore\fR <device> \-\-header-backup-file <file>
 119 .IP
 120
 121 Restores binary backup of LUKS header and keyslot areas from specified file.
 122
 123 \fBWARNING:\fR All the keyslot areas are overwritten, only active keyslots form backup file are available after issuing this command.
 124
 125 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.
 126 .PP
 127
 128 For more information about LUKS, see \fBhttp://code.google.com/p/cryptsetup/wiki/Specification\fR
 129
 130 .SH OPTIONS
 131 .TP
 132 .B "\-\-verbose, \-v"
 133 Print more verbose messages.
 134 .TP
 135 .B "\-\-debug"
 136 Run in debug mode with full diagnostic logs.
 137 .TP
 138 .B "\-\-hash, \-h"
 139 For \fIcreate\fR action specifies hash to use for password hashing.
 140
 141 For \fIluksFormat\fR action specifies hash used in LUKS key setup scheme and volume key digest.
 142
 143 \fBWARNING:\fR setting hash other than \fBsha1\fR causes LUKS device incompatible with older version of cryptsetup.
 144
 145 The hash string is passed to libgcrypt, so all hash algorithms are supported
 146 (for \fIluksFormat\fR algorithm must provide at least 20 byte long hash).
 147 Default is set during compilation, compatible values with old version of cryptsetup are
 148 \fB"ripemd160"\fR for \fIcreate\fR action and \fB"sha1"\fR for \fIluksFormat\fR.
 149
 150 Use \fIcryptsetup \-\-help\fR to show defaults.
 151 .TP
 152 .B "\-\-cipher, \-c"
 153 set cipher specification string.
 154
 155 Default mode is configurable during compilation,
 156 you can see compiled-in default using \fIcryptsetup \-\-help\fR.
 157 If not changed, the default is for plain dm-crypt and LUKS mappings
 158 "aes-cbc-essiv:sha256".
 159
 160 For pre-2.6.10 kernels, use "aes-plain" as they don't understand
 161 the new cipher spec strings. To use ESSIV, use "aes-cbc-essiv:sha256".
 162
 163 For XTS mode, kernel version 2.6.24 or more recent is required.
 164 Use "aes-xts-plain" cipher specification and set key size to 256 (or 512) bits (see \-s option).
 165 .TP
 166 .B "\-\-verify-passphrase, \-y"
 167 query for passwords twice. Useful when creating a (regular) mapping for the first time, or when running \fIluksFormat\fR.
 168 .TP
 169 .B "\-\-key-file, \-d"
 170 use file as key material.
 171
 172 With LUKS, key material supplied in key files via \-d are always used for existing passphrases,
 173 except in \fIluksFormat\fR action where \-d is equivalent to positional key file argument.
 174 If you want to set a new key via a key file, you have to use a positional arg to \fIluksAddKey\fR.
 175
 176 If the key file is "-", stdin will be used. With the "-" key file reading will
 177 not stop when new line character is detected. See section \fBNOTES ON PASSWORD PROCESSING\fR for more information.
 178 .TP
 179 .B "\-\-master-key-file"
 180 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).
 181
 182 For \fIluksAddKey\fR it allows adding new passphrase with only master key knowledge.
 183 .TP
 184 .B "\-\-use-random"
 185 .TP
 186 .B "\-\-use-urandom"
 187 For \fIluksFormat\fR it defines which kernel random number generator will be used for long-term key (volume key).
 188
 189 See \fBNOTES ON RNG\fR for more information. Use \fIcryptsetup \-\-help\fR to show default RNG.
 190 .TP
 191 .B "\-\-key-slot, \-S"
 192 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.
 193 .TP
 194 .B "\-\-key-size, \-s"
 195 set key size in bits.
 196
 197 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.
 198 Can be used for \fIcreate\fR or \fIluksFormat\fR, all other LUKS actions will use key-size specified by the LUKS header.
 199 Default is set during compilation, if not changed it is 256 bits.
 200
 201 Use \fIcryptsetup \-\-help\fR to show defaults.
 202
 203 For \fIluksOpen\fR this option specifies number of bits read from the key-file (default is exhaustive read from key-file).
 204 .TP
 205 .B "\-\-size, \-b"
 206 force the size of the underlying device in sectors.
 207 This option is only relevant for \fIcreate\fR and \fIresize\fR action.
 208 .TP
 209 .B "\-\-offset, \-o"
 210 start offset in the backend device (in 512-byte sectors).
 211 This option is only relevant for \fIcreate\fR action.
 212 .TP
 213 .B "\-\-skip, \-p"
 214 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.
 215 This option is only relevant for \fIcreate\fR action.
 216 .TP
 217 .B "\-\-readonly"
 218 set up a read-only mapping.
 219 .TP
 220 .B "\-\-iter-time, \-i"
 221 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.
 222 .TP
 223 .B "\-\-batch-mode, \-q"
 224 Do not ask for confirmation. Use with care! This option is only relevant for \fIluksFormat\fR, \fIluksAddKey\fR, \fIluksRemoveKey\fR or \fIluksKillSlot\fR.
 225 .TP
 226 .B "\-\-timeout, \-t"
 227 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.
 228 .TP
 229 .B "\-\-tries, \-T"
 230 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.
 231 .TP
 232 .B "\-\-align-payload=\fIvalue\fR"
 233 Align payload at a boundary of \fIvalue\fR 512-byte sectors. This option is relevant for \fIluksFormat\fR.
 234 If not specified, cryptsetup tries to use topology info provided by kernel for underlying device to get optimal alignment.
 235 If not available (or calculated value is multiple of default) data is by default aligned to 1 MiB boundary (2048 512-byte sectors).
 236 .TP
 237 .B "\-\-uuid=\fIUUID\fR"
 238 Use provided \fIUUID\fR in \fIluksFormat\fR command instead of generating new one or change existing UUID in \fIluksUUID\fR command.
 239
 240 The UUID must be provided in standard UUID format (e.g. 12345678-1234-1234-1234-123456789abc).
 241 .TP
 242 .B "\-\-version"
 243 Show the version.
 244
 245 .SH NOTES ON PASSWORD PROCESSING
 246 \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.
 247
 248 \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.
 249 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.
 250
 251 \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.
 252
 253 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.
 254 .SH NOTES ON PASSWORD PROCESSING FOR LUKS
 255 LUKS uses PBKDF2 to protect against dictionary attacks (see RFC 2898).
 256
 257 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.
 258
 259 For any password creation action (luksAddKey, or luksFormat), the user may specify how much the time the password processing should consume.
 260 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.
 261 .SH INCOHERENT BEHAVIOUR FOR INVALID PASSWORDS/KEYS
 262 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.
 263
 264 Please also be sure that you are using the same keyboard and language setting as during device format.
 265 .SH NOTES ON SUPPORTED CIPHERS, MODES, HASHES AND KEY SIZES
 266 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.
 267
 268 For \-\-hash option all algorithms supported by gcrypt library are available.
 269 .SH NOTES ON PASSWORDS
 270 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.
 271 .SH NOTES ON RNG
 272 Random Number Generator (RNG) used in cryptsetup always uses kernel RNG without
 273 any modifications or additions to data stream procudes by kernel (like internal
 274 random pool operations or mixing with the other random sources).
 275
 276 There are two types of randomness cryptsetup/LUKS needs. One type (which always
 277 uses /dev/urandom) is used for salt, AF splitter and for wiping removed
 278 keyslot.
 279
 280 Second type is used for volume (master) key. You can switch between
 281 using /dev/random and /dev/urandom  here, see \fP--use-random\fR and \fP--use-urandom\fR
 282 options. Using /dev/random on system without enough entropy sources
 283 can cause \fPluksFormat\fR to block until the requested amount of random data is gathered.
 284 See \fPurandom(4)\fR for more information.
 285 .SH AUTHORS
 286 cryptsetup is written by Christophe Saout <christophe@saout.de>
 287 .br
 288 LUKS extensions, and man page by Clemens Fruhwirth <clemens@endorphin.org>
 289 .SH "COMPATABILITY WITH OLD SUSE TWOFISH PARTITIONS"
 290 To read images created with SuSE Linux 9.2's loop_fish2 use \-\-cipher
 291 twofish-cbc-null \-s 256 \-h sha512, for images created with even
 292 older SuSE Linux use \-\-cipher twofish-cbc-null \-s 192 \-h
 293 ripemd160:20
 294
 295 .SH DEPRECATED ACTIONS
 296 .PP
 297 \fIreload\fR <name> <device>
 298 .IP
 299 modifies an active mapping <name>. Same options as for
 300 create.
 301 .B WARNING:
 302 Do not use this for LUKS devices, as the semantics
 303 are identical to the create action, which are totally incompatible
 304 with the LUKS key setup.
 305
 306 This action is deprected because it proved to be rarely useful.  It is
 307 uncommon to change the underlying device, key, or offset on the
 308 fly. In case, you really want to do this, you certainly know what you
 309 are doing and then you are probably better off with the swiss knive
 310 tool for device mapper, namely dmsetup. It provides you with the same
 311 functionality, see dmsetup reload.
 312 .PP
 313 \fIluksDelKey\fR <device> <key slot number>
 314 .IP
 315 identical to luksKillSlot, but deprecated action name. This option was
 316 renamed, as we introduced luksRemoveKey, a softer method for disabling
 317 password slots. To make a clear distinction that luksDelKey was more brutal than luksRemoveKey
 318 .PP
 319 \fI\-\-non-exclusive\fR
 320 .IP
 321 This option is ignored. Non-exclusive access to the same block device
 322 can cause data corruption thus this mode is no longer supported by cryptsetup.
 323
 324 .SH "REPORTING BUGS"
 325 Report bugs to <dm-crypt@saout.de> or Issues section on LUKS website.
 326 Please attach output of failed command with added \-\-debug option.
 327 .SH COPYRIGHT
 328 Copyright \(co 2004 Christophe Saout
 329 .br
 330 Copyright \(co 2004-2006 Clemens Fruhwirth
 331 .br
 332 Copyright \(co 2009-2010 Red Hat, Inc.
 333
 334 This is free software; see the source for copying conditions.  There is NO
 335 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 336 .SH "SEE ALSO"
 337
 338 dm-crypt website, \fBhttp://www.saout.de/misc/dm-crypt/\fR
 339
 340 LUKS website, \fBhttp://code.google.com/p/cryptsetup/\fR
 341
 342 dm-crypt TWiki, \fBhttp://www.saout.de/tikiwiki/tiki-index.php\fR