man/veritytab.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1-or-later
   7
   8 This is based on crypttab(5).
   9
  10 -->
  11 <refentry id="veritytab" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude">
  12
  13   <refentryinfo>
  14     <title>veritytab</title>
  15     <productname>systemd</productname>
  16   </refentryinfo>
  17
  18   <refmeta>
  19     <refentrytitle>veritytab</refentrytitle>
  20     <manvolnum>5</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>veritytab</refname>
  25     <refpurpose>Configuration for verity block devices</refpurpose>
  26   </refnamediv>
  27
  28   <refsynopsisdiv>
  29     <para><filename>/etc/veritytab</filename></para>
  30   </refsynopsisdiv>
  31
  32   <refsect1>
  33     <title>Description</title>
  34
  35     <para>The <filename>/etc/veritytab</filename> file describes
  36     verity protected block devices that are set up during
  37     system boot.</para>
  38
  39     <para>Empty lines and lines starting with the <literal>#</literal>
  40     character are ignored. Each of the remaining lines describes one
  41     verity protected block device. Fields are delimited by
  42     white space.</para>
  43
  44     <para>Each line is in the form<programlisting><replaceable>volume-name</replaceable> <replaceable>data-device</replaceable> <replaceable>hash-device</replaceable> <replaceable>roothash</replaceable> <replaceable>options</replaceable></programlisting>
  45     The first four fields are mandatory, the remaining one is optional.</para>
  46
  47     <para>The first field contains the name of the resulting verity volume; its block device is set up
  48     below <filename>/dev/mapper/</filename>.</para>
  49
  50     <para>The second field contains a path to the underlying block data device, or a specification of a block device via
  51     <literal>UUID=</literal> followed by the UUID.</para>
  52
  53     <para>The third field contains a path to the underlying block hash device, or a specification of a block device via
  54     <literal>UUID=</literal> followed by the UUID.</para>
  55
  56     <para>The fourth field is the <literal>roothash</literal> in hexadecimal.</para>
  57
  58     <para>The fifth field, if present, is a comma-delimited list of options. The following options are
  59     recognized:</para>
  60
  61     <variablelist class='fstab-options'>
  62
  63       <varlistentry>
  64         <term><option>superblock=<replaceable>BOOL</replaceable></option></term>
  65
  66         <listitem><para>Use dm-verity with or without permanent on-disk superblock.</para>
  67
  68         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
  69       </varlistentry>
  70
  71       <varlistentry>
  72         <term><option>format=<replaceable>NUMBER</replaceable></option></term>
  73
  74         <listitem><para>Specifies the hash version type. Format type 0 is original Chrome OS version. Format type 1 is
  75         modern version.</para>
  76
  77         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
  78       </varlistentry>
  79
  80       <varlistentry>
  81         <term><option>data-block-size=<replaceable>BYTES</replaceable></option></term>
  82
  83         <listitem><para>Used block size for the data device. (Note kernel supports only page-size as maximum
  84         here; Multiples of 512 bytes.) </para>
  85
  86         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term><option>hash-block-size=<replaceable>BYTES</replaceable></option></term>
  91
  92         <listitem><para>Used block size for the hash device. (Note kernel supports only page-size as maximum
  93         here; Multiples of 512 bytes.)</para>
  94
  95         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>data-blocks=<replaceable>BLOCKS</replaceable></option></term>
 100
 101         <listitem><para>Number of blocks of data device used in verification. If not specified, the whole device is
 102         used.</para>
 103
 104         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term><option>hash-offset=<replaceable>BYTES</replaceable></option></term>
 109
 110         <listitem><para>Offset of hash area/superblock on <literal>hash-device</literal>. (Multiples of 512 bytes.)
 111         </para>
 112
 113         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 114       </varlistentry>
 115
 116       <varlistentry>
 117         <term><option>salt=<replaceable>HEX</replaceable></option></term>
 118
 119         <listitem><para>Salt used for format or verification. Format is a hexadecimal string; 256 bytes long maximum;
 120         <literal>-</literal>is the special value for empty.</para>
 121
 122         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term><option>uuid=<replaceable>UUID</replaceable></option></term>
 127
 128         <listitem><para>Use the provided UUID for format command instead of generating new one. The UUID must be
 129         provided in standard UUID format, e.g. 12345678-1234-1234-1234-123456789abc.</para>
 130
 131         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 132         <listitem><para></para></listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term><option>ignore-corruption</option></term>
 137         <term><option>restart-on-corruption</option></term>
 138         <term><option>panic-on-corruption</option></term>
 139
 140         <listitem><para>Defines what to do if a data verity problem is detected (data corruption). Without these
 141         options kernel fails the IO operation with I/O error. With <literal>--ignore-corruption</literal> option the
 142         corruption is only logged. With <literal>--restart-on-corruption</literal> or
 143         <literal>--panic-on-corruption</literal> the kernel is restarted (panicked) immediately.
 144
 145         (You have to provide way how to avoid restart loops.)</para>
 146
 147         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 148       </varlistentry>
 149
 150       <varlistentry>
 151         <term><option>ignore-zero-blocks</option></term>
 152
 153         <listitem><para>Instruct kernel to not verify blocks that are expected to contain zeroes and always directly
 154         return zeroes instead.
 155
 156         WARNING: Use this option only in very specific cases. This option is available since Linux kernel version 4.5.
 157         </para>
 158
 159         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 160       </varlistentry>
 161
 162       <varlistentry>
 163         <term><option>check-at-most-once</option></term>
 164
 165         <listitem><para>Instruct kernel to verify blocks only the first time they are read from the data device, rather
 166         than every time.
 167
 168         WARNING: It provides a reduced level of security because only offline tampering of the data device's content
 169         will be detected, not online tampering. This option is available since Linux kernel version 4.17.
 170         </para>
 171
 172         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 173       </varlistentry>
 174
 175       <varlistentry>
 176         <term><option>hash=<replaceable>HASH</replaceable></option></term>
 177
 178         <listitem><para>Hash algorithm for dm-verity. This should be the name of the algorithm, like "sha1". For default
 179         see <command>veritysetup --help</command>.</para>
 180
 181         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term><option>fec-device=<replaceable>PATH</replaceable></option></term>
 186
 187         <listitem><para>Use forward error correction (FEC) to recover from corruption if hash verification fails. Use
 188         encoding data from the specified device. The fec device argument can be block device or file image. For format,
 189         if fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must
 190         match. Also, if the verity data_device is encrypted the fec_device should be too.</para>
 191
 192         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term><option>fec-offset=<replaceable>BYTES</replaceable></option></term>
 197
 198         <listitem><para>This is the offset, in bytes, from the start of the FEC device to the beginning of the encoding
 199         data. (Aligned on 512 bytes.)</para>
 200
 201         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term><option>fec-roots=<replaceable>NUM</replaceable></option></term>
 206
 207         <listitem><para>Number of generator roots. This equals to the number of parity bytes in the encoding data. In
 208         RS(M, N) encoding, the number of roots is M-N. M is 255 and M-N is between 2 and 24 (including).</para>
 209
 210         <xi:include href="version-info.xml" xpointer="v254"/>
 211         </listitem>
 212       </varlistentry>
 213
 214       <varlistentry>
 215         <term><option>root-hash-signature=<replaceable>PATH</replaceable>|base64:<replaceable>HEX</replaceable></option></term>
 216
 217         <listitem><para>A base64 string encoding the root hash signature prefixed by <literal>base64:</literal> or a
 218         path to roothash signature file used to verify the root hash (in kernel). This feature requires Linux kernel
 219         version 5.4 or more recent.</para>
 220
 221         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 222       </varlistentry>
 223
 224       <varlistentry>
 225         <term><option>_netdev</option></term>
 226
 227         <listitem><para>Marks this veritysetup device as requiring network. It will be
 228         started after the network is available, similarly to
 229         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 230         units marked with <option>_netdev</option>. The service unit to set up this device
 231         will be ordered between <filename>remote-fs-pre.target</filename> and
 232         <filename>remote-veritysetup.target</filename>, instead of
 233         <filename>veritysetup-pre.target</filename> and
 234         <filename>veritysetup.target</filename>.</para>
 235
 236         <para>Hint: if this device is used for a mount point that is specified in
 237         <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 238         the <option>_netdev</option> option should also be used for the mount
 239         point. Otherwise, a dependency loop might be created where the mount point
 240         will be pulled in by <filename>local-fs.target</filename>, while the
 241         service to configure the network is usually only started <emphasis>after</emphasis>
 242         the local file system has been mounted.</para>
 243
 244         <xi:include href="version-info.xml" xpointer="v248"/>
 245         </listitem>
 246       </varlistentry>
 247
 248       <varlistentry>
 249         <term><option>noauto</option></term>
 250
 251         <listitem><para>This device will not be added to <filename>veritysetup.target</filename>.
 252         This means that it will not be automatically enabled on boot, unless something else pulls
 253         it in. In particular, if the device is used for a mount point, it'll be enabled
 254         automatically during boot, unless the mount point itself is also disabled with
 255         <option>noauto</option>.</para>
 256
 257         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 258       </varlistentry>
 259
 260       <varlistentry>
 261         <term><option>nofail</option></term>
 262
 263         <listitem><para>This device will not be a hard dependency of
 264         <filename>veritysetup.target</filename>. It'll still be pulled in and started, but the system
 265         will not wait for the device to show up and be enabled, and boot will not fail if this is
 266         unsuccessful. Note that other units that depend on the enabled device may still fail. In
 267         particular, if the device is used for a mount point, the mount point itself also needs to
 268         have the <option>nofail</option> option, or the boot will fail if the device is not enabled
 269         successfully.</para>
 270
 271         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 272       </varlistentry>
 273
 274       <varlistentry>
 275         <term><option>x-initrd.attach</option></term>
 276
 277         <listitem><para>Setup this verity protected block device in the initrd, similarly to
 278         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 279         units marked with <option>x-initrd.mount</option>.</para>
 280
 281         <para>Although it's not necessary to mark the mount entry for the root file system with
 282         <option>x-initrd.mount</option>, <option>x-initrd.attach</option> is still recommended with
 283         the verity protected block device containing the root file system as otherwise systemd
 284         will attempt to detach the device during the regular system shutdown while it's still in
 285         use. With this option the device will still be detached but later after the root file
 286         system is unmounted.</para>
 287
 288         <para>All other verity protected block devices that contain file systems mounted in the initrd should
 289         use this option.</para>
 290
 291         <xi:include href="version-info.xml" xpointer="v248"/>
 292         </listitem>
 293       </varlistentry>
 294
 295     </variablelist>
 296
 297     <para>At early boot and when the system manager configuration is
 298     reloaded, this file is translated into native systemd units by
 299     <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 300   </refsect1>
 301
 302   <refsect1>
 303     <title>Examples</title>
 304     <example>
 305       <title>/etc/veritytab example</title>
 306       <para>Set up two verity protected block devices. One using device blocks, another using files.</para>
 307
 308       <programlisting>usr  PARTUUID=783e45ae-7aa3-484a-beef-a80ff9c19cbb PARTUUID=21dc1dfe-4c33-8b48-98a9-918a22eb3e37 36e3f740ad502e2c25e2a23d9c7c17bf0fdad2300b7580842d4b7ec1fb0fa263 auto
 309 data /etc/data /etc/hash a5ee4b42f70ae1f46a08a7c92c2e0a20672ad2f514792730f5d49d7606ab8fdf auto
 310 </programlisting>
 311     </example>
 312   </refsect1>
 313
 314   <refsect1>
 315     <title>See Also</title>
 316     <para>
 317       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 318       <citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 319       <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 320       <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 321       <citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 322     </para>
 323   </refsect1>
 324
 325 </refentry>