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