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