~siretart/cryptsetup/debian

« back to all changes in this revision

Viewing changes to debian/crypttab.5.txt

  • Committer: Reinhard Tartler
  • Date: 2008-05-25 20:03:28 UTC
  • Revision ID: siretart@tauware.de-20080525200328-szhw0j5yw0p5kl33
import cryptsetup_1.0.6~pre1+svn45-1.dsc

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
    
17
17
DESCRIPTION
18
18
-----------
19
 
The file *crypttab* (usually located at */etc/crypttab*) contains descriptive information about encrypted file systems.
 
19
The file *crypttab* (usually located at */etc/crypttab*) contains descriptive information about encrypted filesystems.
20
20
*crypttab* is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file.
21
 
Each file system is described on a separate line; fields on each line are separated by tabs or spaces. Lines starting with "'#'" are comments, empty lines are ignored.
 
21
Each filesystem is described on a separate line; fields on each line are separated by tabs or spaces. Lines starting with "'#'" are comments, empty lines are ignored.
22
22
The order of records in *crypttab* is important because the */etc/init.d/cryptdisks* script sequentially iterates through *crypttab* doing its thing.
23
23
Note that all four fields are mandatory and that a missing field will lead to unspecified behaviour.
24
24
 
26
26
It must be a plain filename without any directories.
27
27
A mapped device */dev/mapper/*'device name' will be created by *cryptsetup(8)* crypting data from and onto the 'source device'.
28
28
 
29
 
The second field 'source device' describes either the block special device or file (which will be automatically mounted as loop device) that should hold the encrypted data.
 
29
The second field 'source device' describes either the block special device or file (which will be automatically mounted as a loop device) that should hold the encrypted data.
30
30
 
31
31
The third field 'key file' describes the file to use for decrypting the encrypted data of the 'source device'.
32
32
 
70
70
*swap*::
71
71
Run *mkswap* on the created device.
72
72
 
73
 
*tmp*::
74
 
Run *mke2fs* on the created device.
 
73
*tmp*=<tmpfs>::
 
74
Run *mkfs* with filesystem type <tmpfs> on the created device. Default is ext2.
75
75
 
76
76
*precheck*=<precheck>::
77
 
Check the source device by suitable program; if the check fails the device is
 
77
Check the source device by suitable program; if the check fails, the device is
78
78
not created; <precheck> is a script to check the source device. The source
79
 
device is given as argument to the script.
 
79
device is given as an argument to the script.
80
80
 
81
81
*check*=<check>::
82
 
Check the content of the device by a suitable program; if the check fails the
83
 
device is removed. If a program is provided as argument, it is run, giving the
84
 
decrypted volume (target device) as first, and the value of the checkargs
85
 
option as second argument. Cryptdisks searches for the given program in
86
 
/lib/cryptsetup/checks/. Default is vol_id.
 
82
Check the content of the device by a suitable program; if the check fails, the
 
83
device is removed. If a program is provided as an argument, it is run, giving
 
84
the decrypted volume (target device) as the first argument, and the value of the
 
85
checkargs option as the second argument. Cryptdisks searches for the given program
 
86
in /lib/cryptsetup/checks/. Default is vol_id.
87
87
 
88
88
*checkargs*=<arguments>::
89
 
Give <arguments> as second argument to the check script. See description for
 
89
Give <arguments> as the second argument to the check script. See description for
90
90
CHECKSCRIPTS for more information.
91
91
 
92
92
*tries*=<num>::
93
93
The input of the passphrase is tried <num> times in case that it fails. If you
94
 
want to disable retries, give tries=1 as argument. Default is 3.
 
94
want to disable retries, pass tries=1. Default is 3.
95
95
 
96
96
*timeout*=<sec>::
97
97
If key is "'none'", the cryptdisks script interactively prompts for a
104
104
encrypted disks in a special order. With this option the first invokation of
105
105
cryptdisks ignores the device.
106
106
 
 
107
*noauto*::
 
108
Entirely ignore the device at the boot process. It's still possible to map the device
 
109
manually using cryptdisks_start.
 
110
 
107
111
*loud*::
108
112
Be loud. Print warnings if a device does not exist.
109
113
 
110
114
*keyscript*=<path>::
111
 
The executable at the inidicated path is executed with the 'key file' from the third 
 
115
The executable at the indicated path is executed with the 'key file' from the third 
112
116
field of the crypttab as its only argument and the output is used as the key. This
113
117
also works with encrypted root filesystems via initramfs if the executable is 
114
118
self-contained (i.e. not a shell script which relies on external programs).
150
154
*Encrypted disk with interactive password, use a nondefault check script, no retries*::
151
155
cdisk2 /dev/hdc1 none check=customscript,tries=1
152
156
 
153
 
*Encrypted disk with interactive password and twofish as cipher*::
 
157
*Encrypted disk with interactive password and twofish as the cipher*::
154
158
cdisk3 /dev/sda3 none cipher=twofish
155
159
 
156
160
ENVIRONMENT
164
168
 
165
169
*CRYPTDISKS_CHECK*::
166
170
Specifies the checkscript to be run against the target device, after cryptdisks
167
 
has been invoked. The target device is given as only argument to the
168
 
checkscript. Takes effect, if the 'check' option is given in crypttab with no
169
 
value.
 
171
has been invoked. The target device is passed as the first and only argument to
 
172
the checkscript. Takes effect, if the 'check' option is given in crypttab with
 
173
no value.
170
174
 
171
175
*CRYPTDISKS_PRECHECK*::
172
176
Specifies the checkscript to be run against the source device, before
173
 
cryptdisks has been invoked. The source device is given as only argument to the
174
 
checkscript. Takes effect, if the 'precheck' option is given in crypttab with
175
 
no value.
 
177
cryptdisks has been invoked. The source device is given as the first and only
 
178
argument to the checkscript. Takes effect, if the 'precheck' option is given in
 
179
crypttab with no value.
176
180
 
177
181
*CRYPTDISKS_TIMEOUT*::
178
182
Specifies the time in seconds to wait for the password before timing out. Takes
181
185
 
182
186
SEE ALSO
183
187
--------
184
 
cryptsetup(8), /etc/crypttab
 
188
*cryptsetup*(8), '/etc/crypttab'
185
189
 
186
190
 
187
191
AUTHOR