Debian Codegraph @

upstream/debian-unstable/man5/integritytab.5

raw
1 '\" t
2 .TH "INTEGRITYTAB" "5" "" "systemd 261~rc3" "integritytab"
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 integritytab \- Configuration for integrity block devices
24 .SH "SYNOPSIS"
25 .PP
26 /etc/integritytab
27 .SH "DESCRIPTION"
28 .PP
29 The
30 /etc/integritytab
31 file describes integrity protected block devices that are set up during system boot\&.
32 .PP
33 Empty lines and lines starting with the
34 "#"
35 character are ignored\&. Each of the remaining lines describes one verity integrity protected block device\&. Fields are delimited by white space\&.
36 .PP
37 Each line is in the form
38 .sp
39 .if n \{\
40 .RS 4
41 .\}
42 .nf
43 \fIvolume\-name\fR \fIblock\-device\fR
44 \fI[keyfile|\-]\fR \fI[options|\-]\fR
45 .fi
46 .if n \{\
47 .RE
48 .\}
49 .sp
50 The first two fields are mandatory, the remaining two are optional and only required if user specified non\-default options during integrity format\&.
51 .PP
52 The first field contains the name of the resulting integrity volume; its block device is set up below
53 /dev/mapper/\&.
54 .PP
55 The second field contains a path to the underlying block device, or a specification of a block device via
56 "UUID="
57 followed by the UUID,
58 "PARTUUID="
59 followed by the partition UUID,
60 "LABEL="
61 followed by the label,
62 "PARTLABEL="
63 followed by the partition label\&.
64 .PP
65 The third field if present contains an absolute filename path to a key file or a
66 "\-"
67 to specify none\&. When the filename is present, the "integrity\-algorithm" defaults to
68 "hmac\-sha256"
69 with the key length derived from the number of bytes in the key file\&. At this time the only supported integrity algorithms when using key file are hmac\-sha256, hmac\-sha512, phmac\-sha256, and hmac\-sha512\&. The maximum size of the key file is 4096 bytes\&.
70 .PP
71 The fourth field, if present, is a comma\-delimited list of options or a
72 "\-"
73 to specify none\&. The following options are recognized:
74 .PP
75 \fBallow\-discards\fR
76 .RS 4
77 Allow the use of discard (TRIM) requests for the device\&. This option is available since the Linux kernel version 5\&.7\&.
78 .sp
79 Added in version 250\&.
80 .RE
81 .PP
82 \fBmode=(journal|bitmap|direct)\fR
83 .RS 4
84 Enable journaled, bitmapped or direct (passthrough) mode\&. Journaled mode is the default when this option is not specified\&. It provides safety against crashes, but can be slow because all data has to be written twice\&. Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it might not be detected\&. Direct mode disables the journal and the bitmap\&. Corresponds to the "direct writes" mode documented in
85 \m[blue]\fBthe dm\-integrity documentation\fR\m[]\&\s-2\u[1]\d\s+2\&. Note that without a journal, if there is a crash, it is possible that the integrity tags and data will not match\&. If used, the journal\-* options below will have no effect if passed\&.
86 .sp
87 Added in version 254\&.
88 .RE
89 .PP
90 \fBjournal\-watermark=[0\&.\&.100]%\fR
91 .RS 4
92 Journal watermark in percent\&. When the journal percentage exceeds this watermark, the journal flush will be started\&. Setting a value of "0%" uses default value\&.
93 .sp
94 Added in version 250\&.
95 .RE
96 .PP
97 \fBjournal\-commit\-time=[0\&.\&.N]\fR
98 .RS 4
99 Commit time in milliseconds\&. When this time passes (and no explicit flush operation was issued), the journal is written\&. Setting a value of zero uses default value\&.
100 .sp
101 Added in version 250\&.
102 .RE
103 .PP
104 \fBdata\-device=/dev/disk/by\-\&.\&.\&.\fR
105 .RS 4
106 Specify a separate block device that contains existing data\&. The second field specified in the integritytab for block device then will contain calculated integrity tags and journal for data\-device, but not the end user data\&.
107 .sp
108 Added in version 250\&.
109 .RE
110 .PP
111 \fBintegrity\-algorithm=[crc32c|crc32|xxhash64|sha1|sha256|hmac\-sha256|hmac\-sha512|phmac\-sha256|phmac\-sha512]\fR
112 .RS 4
113 The algorithm used for integrity checking\&. The default is crc32c\&. Must match option used during format\&.
114 .sp
115 Added in version 250\&.
116 .RE
117 .PP
118 \fB_netdev\fR
119 .RS 4
120 Marks this veritysetup device as requiring network\&. It will be started after the network is available, similarly to
121 \fBsystemd.mount\fR(5)
122 units marked with
123 \fB_netdev\fR\&. The service unit to set up this device will be ordered between
124 remote\-fs\-pre\&.target
125 and
126 remote\-integritysetup\&.target, instead of
127 integritysetup\-pre\&.target
128 and
129 integritysetup\&.target\&.
130 .sp
131 Hint: if this device is used for a mount point that is specified in
132 \fBfstab\fR(5), the
133 \fB_netdev\fR
134 option should also be used for the mount point\&. Otherwise, a dependency loop might be created where the mount point will be pulled in by
135 local\-fs\&.target, while the service to configure the network is usually only started
136 \fIafter\fR
137 the local file system has been mounted\&.
138 .sp
139 Added in version 258\&.
140 .RE
141 .PP
142 \fBnoauto\fR
143 .RS 4
144 This device will not be added to
145 integritysetup\&.target\&. This means that it will not be automatically enabled on boot, unless something else pulls it in\&. In particular, if the device is used for a mount point, it\*(Aqll be enabled automatically during boot, unless the mount point itself is also disabled with
146 \fBnoauto\fR\&.
147 .sp
148 Added in version 258\&.
149 .RE
150 .PP
151 \fBnofail\fR
152 .RS 4
153 This device will not be a hard dependency of
154 integritysetup\&.target\&. It\*(Aqll still be pulled in and started, but the system will not wait for the device to show up and be enabled, and boot will not fail if this is unsuccessful\&. Note that other units that depend on the enabled device may still fail\&. In particular, if the device is used for a mount point, the mount point itself also needs to have the
155 \fBnofail\fR
156 option, or the boot will fail if the device is not enabled successfully\&.
157 .sp
158 Added in version 258\&.
159 .RE
160 .PP
161 At early boot and when the system manager configuration is reloaded, this file is translated into native systemd units by
162 \fBsystemd-integritysetup-generator\fR(8)\&.
163 .SH "EXAMPLES"
164 .PP
165 \fBExample\ \&1.\ \&/etc/integritytab\fR
166 .PP
167 Set up two integrity protected block devices\&.
168 .sp
169 .if n \{\
170 .RS 4
171 .\}
172 .nf
173 home PARTUUID=4973d0b8\-1b15\-c449\-96ec\-94bab7f6a7b8 \- journal\-commit\-time=10,allow\-discards,journal\-watermark=55%
174 data PARTUUID=5d4b1808\-be76\-774d\-88af\-03c4c3a41761 \- allow\-discards
175 .fi
176 .if n \{\
177 .RE
178 .\}
179 .PP
180 \fBExample\ \&2.\ \&/etc/integritytab\fR
181 .PP
182 Set up 1 integrity protected block device using defaults
183 .sp
184 .if n \{\
185 .RS 4
186 .\}
187 .nf
188 home PARTUUID=4973d0b8\-1b15\-c449\-96ec\-94bab7f6a7b8
189 .fi
190 .if n \{\
191 .RE
192 .\}
193 .PP
194 \fBExample\ \&3.\ \&/etc/integritytab\fR
195 .PP
196 Set up 1 integrity device using existing data block device which contains user data
197 .sp
198 .if n \{\
199 .RS 4
200 .\}
201 .nf
202 home PARTUUID=4973d0b8\-1b15\-c449\-96ec\-94bab7f6a7b8 \- data\-device=/dev/disk/by\-uuid/9276d9c0\-d4e3\-4297\-b4ff\-3307cd0d092f
203 .fi
204 .if n \{\
205 .RE
206 .\}
207 .PP
208 \fBExample\ \&4.\ \&/etc/integritytab\fR
209 .PP
210 Set up 1 integrity device using a HMAC key file using defaults
211 .sp
212 .if n \{\
213 .RS 4
214 .\}
215 .nf
216 home PARTUUID=4973d0b8\-1b15\-c449\-96ec\-94bab7f6a7b8 /etc/hmac\&.key
217 .fi
218 .if n \{\
219 .RE
220 .\}
221 .SH "SEE ALSO"
222 .PP
223 \fBsystemd\fR(1), \[email protected]\fR(8), \fBsystemd-integritysetup-generator\fR(8), \fBintegritysetup\fR(8)
224 .SH "NOTES"
225 .IP " 1." 4
226 the dm-integrity documentation
227 .RS 4
228 \%https://docs.kernel.org/admin-guide/device-mapper/dm-integrity.html
229 .RE