xref: /dragonfly/share/man/man5/crypttab.5 (revision 59a92d18)
1.\"
2.\" Copyright (c) 2010
3.\"	The DragonFly Project.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in
13.\"    the documentation and/or other materials provided with the
14.\"    distribution.
15.\" 3. Neither the name of The DragonFly Project nor the names of its
16.\"    contributors may be used to endorse or promote products derived
17.\"    from this software without specific, prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd October 22, 2010
33.Dt CRYPTTAB 5
34.Os
35.Sh NAME
36.Nm crypttab
37.Nd encrypted disk device table
38.Sh DESCRIPTION
39The
40.Nm
41file contains a list of the encrypted disk devices of the system. Each
42encrypted volume is described on a separate line; fields on each line are
43separated by tabs or spaces.
44.Pp
45The first field,
46.Pq Fa name ,
47contains the name of the resultant crypto volume device, which will
48be a node in
49.Pa /dev/mapper
50with the given
51.Pa name .
52.Pp
53The second field,
54.Pq Fa device ,
55is the underlying device on which the crypto volume resides and must be
56a full device path to a node in
57.Pa /dev .
58.Pp
59The third field,
60.Pq Fa keyfile ,
61is either the value
62.Pa none
63or the full path on the file system to a keyfile to unlock the crypto
64volume.
65If
66.Pa none
67is specified, the system will prompt for a password during the boot
68sequence.
69.Pp
70The fourth field,
71.Pq Fa options ,
72is currently unused on
73.Dx
74and should be either omitted or set to
75.Pa none .
76.Pp
77Note that the
78.Nm
79file on
80.Dx
81currently only supports LUKS volumes and not raw
82.Xr cryptsetup 8
83volumes.
84.Sh FILES
85.Bl -tag -width ".Pa /etc/crypttab" -compact
86.It Pa /etc/crypttab
87The
88.Nm
89file resides in
90.Pa /etc .
91.El
92.Sh EXAMPLES
93The following line specifies a crypto volume without a keyfile, so
94that a password will be prompted during the boot sequence. Upon
95successful entry of the password the device
96.Pa /dev/mapper/vol1
97will be created.
98.Pp
99.Dl "vol1        /dev/da0s1b        none        none"
100.Pp
101The next example is as the one before but using a keyfile on
102.Pa /boot
103instead of an interactive password prompt.
104.Pp
105.Dl "vol1        /dev/da0s1b        /boot/keyfile.0      none"
106.Sh SEE ALSO
107.Xr cryptsetup 8
108.Sh HISTORY
109The
110.Nm
111file format appeared in
112.Dx 2.9 .
113