| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\-CRYPTSETUP\-GENERATOR" "8" "" "systemd 261~rc3" "systemd-cryptsetup-generator" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
systemd-cryptsetup-generator \- Unit generator for /etc/crypttab |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.PP |
| 26 |
/usr/lib/systemd/system\-generators/systemd\-cryptsetup\-generator |
| 27 |
.SH "DESCRIPTION" |
| 28 |
.PP |
| 29 |
systemd\-cryptsetup\-generator |
| 30 |
is a generator that translates |
| 31 |
/etc/crypttab |
| 32 |
into native systemd units early at boot and when configuration of the system manager is reloaded\&. This will create |
| 33 |
\[email protected]\fR(8) |
| 34 |
units as necessary\&. |
| 35 |
.PP |
| 36 |
systemd\-cryptsetup\-generator |
| 37 |
implements |
| 38 |
\fBsystemd.generator\fR(7)\&. |
| 39 |
.SH "KERNEL COMMAND LINE" |
| 40 |
.PP |
| 41 |
systemd\-cryptsetup\-generator |
| 42 |
understands the following kernel command line parameters: |
| 43 |
.PP |
| 44 |
\fIluks=\fR, \fIrd\&.luks=\fR |
| 45 |
.RS 4 |
| 46 |
Takes a boolean argument\&. Defaults to |
| 47 |
"yes"\&. If |
| 48 |
"no", disables the generator entirely\&. |
| 49 |
\fIrd\&.luks=\fR |
| 50 |
is honored only in the initrd while |
| 51 |
\fIluks=\fR |
| 52 |
is honored by both the main system and in the initrd\&. |
| 53 |
.sp |
| 54 |
Added in version 186\&. |
| 55 |
.RE |
| 56 |
.PP |
| 57 |
\fIluks\&.crypttab=\fR, \fIrd\&.luks\&.crypttab=\fR |
| 58 |
.RS 4 |
| 59 |
Takes a boolean argument\&. Defaults to |
| 60 |
"yes"\&. If |
| 61 |
"no", causes the generator to ignore any devices configured in |
| 62 |
/etc/crypttab |
| 63 |
(\fIluks\&.uuid=\fR |
| 64 |
will still work however)\&. |
| 65 |
\fIrd\&.luks\&.crypttab=\fR |
| 66 |
is honored only in initrd while |
| 67 |
\fIluks\&.crypttab=\fR |
| 68 |
is honored by both the main system and in the initrd\&. |
| 69 |
.sp |
| 70 |
Added in version 186\&. |
| 71 |
.RE |
| 72 |
.PP |
| 73 |
\fIluks\&.uuid=\fR, \fIrd\&.luks\&.uuid=\fR |
| 74 |
.RS 4 |
| 75 |
Takes a LUKS superblock UUID as argument\&. This will activate the specified device as part of the boot process as if it was listed in |
| 76 |
/etc/crypttab\&. This option may be specified more than once in order to set up multiple devices\&. |
| 77 |
\fIrd\&.luks\&.uuid=\fR |
| 78 |
is honored only in the initrd, while |
| 79 |
\fIluks\&.uuid=\fR |
| 80 |
is honored by both the main system and in the initrd\&. |
| 81 |
.sp |
| 82 |
If |
| 83 |
/etc/crypttab |
| 84 |
contains entries with the same UUID, then the name, keyfile and options specified there will be used\&. Otherwise, the device will have the name |
| 85 |
"luks\-UUID"\&. |
| 86 |
.sp |
| 87 |
If |
| 88 |
/etc/crypttab |
| 89 |
exists, only those UUIDs specified on the kernel command line will be activated in the initrd or the real root\&. |
| 90 |
.sp |
| 91 |
Added in version 186\&. |
| 92 |
.RE |
| 93 |
.PP |
| 94 |
\fIluks\&.name=\fR, \fIrd\&.luks\&.name=\fR |
| 95 |
.RS 4 |
| 96 |
Takes a LUKS super block UUID followed by an |
| 97 |
"=" |
| 98 |
and a name\&. This implies |
| 99 |
\fIrd\&.luks\&.uuid=\fR |
| 100 |
or |
| 101 |
\fIluks\&.uuid=\fR |
| 102 |
and will additionally make the LUKS device given by the UUID appear under the provided name\&. |
| 103 |
.sp |
| 104 |
This parameter is the analogue of the first |
| 105 |
\fBcrypttab\fR(5) |
| 106 |
field |
| 107 |
\fIvolume\-name\fR\&. |
| 108 |
.sp |
| 109 |
\fIrd\&.luks\&.name=\fR |
| 110 |
is honored only in the initrd, while |
| 111 |
\fIluks\&.name=\fR |
| 112 |
is honored by both the main system and in the initrd\&. |
| 113 |
.sp |
| 114 |
Added in version 218\&. |
| 115 |
.RE |
| 116 |
.PP |
| 117 |
\fIluks\&.data=\fR, \fIrd\&.luks\&.data=\fR |
| 118 |
.RS 4 |
| 119 |
Takes a LUKS super block UUID followed by a |
| 120 |
"=" |
| 121 |
and a block device specification for device hosting encrypted data\&. |
| 122 |
.sp |
| 123 |
For those entries specified with |
| 124 |
\fIrd\&.luks\&.uuid=\fR |
| 125 |
or |
| 126 |
\fIluks\&.uuid=\fR, the data device will be set to the one specified by |
| 127 |
\fIrd\&.luks\&.data=\fR |
| 128 |
or |
| 129 |
\fIluks\&.data=\fR |
| 130 |
of the corresponding UUID\&. |
| 131 |
.sp |
| 132 |
LUKS data device parameter is useful for specifying encrypted data devices with detached headers specified in |
| 133 |
\fIluks\&.options\fR |
| 134 |
entry containing |
| 135 |
"header=" |
| 136 |
argument\&. For example, |
| 137 |
\fIrd\&.luks\&.uuid=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40 |
| 138 |
\fIrd\&.luks\&.options=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40=header=/path/to/luks\&.hdr |
| 139 |
\fIrd\&.luks\&.data=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40=/dev/sdx\&. Hence, in this case, we will attempt to unlock LUKS device assembled from data device |
| 140 |
"/dev/sdx" |
| 141 |
and LUKS header (metadata) put in |
| 142 |
"/path/to/luks\&.hdr" |
| 143 |
file\&. This syntax is for now only supported on a per\-device basis, i\&.e\&. you have to specify LUKS device UUID\&. |
| 144 |
.sp |
| 145 |
This parameter is the analogue of the second |
| 146 |
\fBcrypttab\fR(5) |
| 147 |
field |
| 148 |
\fIencrypted\-device\fR\&. |
| 149 |
.sp |
| 150 |
\fIrd\&.luks\&.data=\fR |
| 151 |
is honored only in the initrd, while |
| 152 |
\fIluks\&.data=\fR |
| 153 |
is honored by both the main system and in the initrd\&. |
| 154 |
.sp |
| 155 |
Added in version 247\&. |
| 156 |
.RE |
| 157 |
.PP |
| 158 |
\fIluks\&.key=\fR, \fIrd\&.luks\&.key=\fR |
| 159 |
.RS 4 |
| 160 |
Takes a password file name as argument or a LUKS super block UUID followed by a |
| 161 |
"=" |
| 162 |
and a password file name\&. |
| 163 |
.sp |
| 164 |
For those entries specified with |
| 165 |
\fIrd\&.luks\&.uuid=\fR |
| 166 |
or |
| 167 |
\fIluks\&.uuid=\fR, the password file will be set to the one specified by |
| 168 |
\fIrd\&.luks\&.key=\fR |
| 169 |
or |
| 170 |
\fIluks\&.key=\fR |
| 171 |
of the corresponding UUID, or the password file that was specified without a UUID\&. |
| 172 |
.sp |
| 173 |
It is also possible to specify an external device which should be mounted before we attempt to unlock the LUKS device\&. systemd\-cryptsetup will use password file stored on that device\&. Device containing password file is specified by appending colon and a device identifier to the password file path\&. For example, |
| 174 |
\fIrd\&.luks\&.uuid=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40 |
| 175 |
\fIrd\&.luks\&.key=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40=/keyfile:LABEL=keydev\&. Hence, in this case, we will attempt to mount file system residing on the block device with label |
| 176 |
"keydev"\&. This syntax is for now only supported on a per\-device basis, i\&.e\&. you have to specify LUKS device UUID\&. |
| 177 |
.sp |
| 178 |
This parameter is the analogue of the third |
| 179 |
\fBcrypttab\fR(5) |
| 180 |
field |
| 181 |
\fIkey\-file\fR\&. |
| 182 |
.sp |
| 183 |
\fIrd\&.luks\&.key=\fR |
| 184 |
is honored only in the initrd, while |
| 185 |
\fIluks\&.key=\fR |
| 186 |
is honored by both the main system and in the initrd\&. |
| 187 |
.sp |
| 188 |
Added in version 202\&. |
| 189 |
.RE |
| 190 |
.PP |
| 191 |
\fIluks\&.options=\fR, \fIrd\&.luks\&.options=\fR |
| 192 |
.RS 4 |
| 193 |
Takes a LUKS super block UUID followed by an |
| 194 |
"=" |
| 195 |
and a string of options separated by commas as argument\&. This will override the options for the given UUID\&. |
| 196 |
.sp |
| 197 |
If only a list of options, without a UUID, is specified, they apply to any UUIDs not specified elsewhere, and without an entry in |
| 198 |
/etc/crypttab\&. |
| 199 |
.sp |
| 200 |
This parameter is the analogue of the fourth |
| 201 |
\fBcrypttab\fR(5) |
| 202 |
field |
| 203 |
\fIoptions\fR\&. |
| 204 |
.sp |
| 205 |
It is possible to specify an external device which should be mounted before we attempt to unlock the LUKS device\&. systemd\-cryptsetup will assemble LUKS device by combining data device specified in |
| 206 |
\fIluks\&.data\fR |
| 207 |
with detached LUKS header found in |
| 208 |
"header=" |
| 209 |
argument\&. For example, |
| 210 |
\fIrd\&.luks\&.uuid=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40 |
| 211 |
\fIrd\&.luks\&.options=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40=header=/luks\&.hdr:LABEL=hdrdev |
| 212 |
\fIrd\&.luks\&.data=\fRb40f1abf\-2a53\-400a\-889a\-2eccc27eaa40=/dev/sdx\&. Hence, in this case, we will attempt to mount file system residing on the block device with label |
| 213 |
"hdrdev", and look for |
| 214 |
"luks\&.hdr" |
| 215 |
on that file system\&. Said header will be used to unlock (decrypt) encrypted data stored on /dev/sdx\&. This syntax is for now only supported on a per\-device basis, i\&.e\&. you have to specify LUKS device UUID\&. |
| 216 |
.sp |
| 217 |
\fIrd\&.luks\&.options=\fR |
| 218 |
is honored only by initial RAM disk (initrd) while |
| 219 |
\fIluks\&.options=\fR |
| 220 |
is honored by both the main system and in the initrd\&. |
| 221 |
.sp |
| 222 |
Added in version 208\&. |
| 223 |
.RE |
| 224 |
.SH "SEE ALSO" |
| 225 |
.PP |
| 226 |
\fBsystemd\fR(1), \fBcrypttab\fR(5), \[email protected]\fR(8), \fBsystemd-cryptenroll\fR(1), \fBcryptsetup\fR(8), \fBsystemd-fstab-generator\fR(8) |