]>
Commit | Line | Data |
---|---|---|
2f3dfc6f LP |
1 | <?xml version="1.0"?> |
2 | <!--*-nxml-*--> | |
3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | <!-- | |
572eb058 | 5 | SPDX-License-Identifier: LGPL-2.1+ |
2f3dfc6f LP |
6 | --> |
7 | <refentry id="systemd-veritysetup-generator" conditional='HAVE_LIBCRYPTSETUP'> | |
8 | ||
9 | <refentryinfo> | |
10 | <title>systemd-veritysetup-generator</title> | |
11 | <productname>systemd</productname> | |
12 | ||
13 | <authorgroup> | |
14 | <author> | |
15 | <contrib>Developer</contrib> | |
16 | <firstname>Lennart</firstname> | |
17 | <surname>Poettering</surname> | |
18 | <email>lennart@poettering.net</email> | |
19 | </author> | |
20 | </authorgroup> | |
21 | </refentryinfo> | |
22 | ||
23 | <refmeta> | |
24 | <refentrytitle>systemd-veritysetup-generator</refentrytitle> | |
25 | <manvolnum>8</manvolnum> | |
26 | </refmeta> | |
27 | ||
28 | <refnamediv> | |
29 | <refname>systemd-veritysetup-generator</refname> | |
30 | <refpurpose>Unit generator for integrity protected block devices</refpurpose> | |
31 | </refnamediv> | |
32 | ||
33 | <refsynopsisdiv> | |
34 | <para><filename>/usr/lib/systemd/system-generators/systemd-veritysetup-generator</filename></para> | |
35 | </refsynopsisdiv> | |
36 | ||
37 | <refsect1> | |
38 | <title>Description</title> | |
39 | ||
40 | <para><filename>systemd-veritysetup-generator</filename> is a generator that translates kernel command line options | |
41 | configuring integrity protected block devices (verity) into native systemd units early at boot and when | |
42 | configuration of the system manager is reloaded. This will create | |
43 | <citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
44 | units as necessary.</para> | |
45 | ||
46 | <para>Currently, only a single verity device may be se up with this generator, backing the root file system of the | |
47 | OS.</para> | |
48 | ||
49 | <para><filename>systemd-veritysetup-generator</filename> implements | |
50 | <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> | |
51 | </refsect1> | |
52 | ||
53 | <refsect1> | |
54 | <title>Kernel Command Line</title> | |
55 | ||
56 | <para><filename>systemd-veritysetup-generator</filename> | |
57 | understands the following kernel command line parameters:</para> | |
58 | ||
59 | <variablelist class='kernel-commandline-options'> | |
60 | <varlistentry> | |
61 | <term><varname>systemd.verity=</varname></term> | |
62 | <term><varname>rd.systemd.verity=</varname></term> | |
63 | ||
64 | <listitem><para>Takes a boolean argument. Defaults to <literal>yes</literal>. If <literal>no</literal>, | |
65 | disables the generator entirely. <varname>rd.systemd.verity=</varname> is honored only by the initial RAM disk | |
66 | (initrd) while <varname>systemd.verity=</varname> is honored by both the host system and the | |
67 | initrd. </para></listitem> | |
68 | </varlistentry> | |
69 | ||
70 | <varlistentry> | |
71 | <term><varname>roothash=</varname></term> | |
72 | ||
73 | <listitem><para>Takes a root hash value for the root file system. Expects a hash value formatted in hexadecimal | |
74 | characters, of the appropriate length (i.e. most likely 256 bit/64 characters, or longer). If not specified via | |
75 | <varname>systemd.verity_root_data=</varname> and <varname>systemd.verity_root_hash=</varname>, the hash and | |
76 | data devices to use are automatically derived from the specified hash value. Specifically, the data partition | |
77 | device is looked for under a GPT partition UUID derived from the first 128bit of the root hash, the hash | |
78 | partition device is looked for under a GPT partition UUID derived from the last 128bit of the root hash. Hence | |
79 | it is usually sufficient to specify the root hash to boot from an integrity protected root file system, as | |
80 | device paths are automatically determined from it — as long as the partition table is properly set up.</para> | |
81 | </listitem> | |
82 | </varlistentry> | |
83 | ||
84 | <varlistentry> | |
85 | <term><varname>systemd.verity_root_data=</varname></term> | |
86 | <term><varname>systemd.verity_root_hash=</varname></term> | |
87 | ||
88 | <listitem><para>These two settings take block device paths as arguments, and may be use to explicitly configure | |
89 | the data partition and hash partition to use for setting up the integrity protection for the root file | |
90 | system. If not specified, these paths are automatically derived from the <varname>roothash=</varname> argument | |
91 | (see above).</para></listitem> | |
92 | </varlistentry> | |
93 | ||
94 | </variablelist> | |
95 | </refsect1> | |
96 | ||
97 | <refsect1> | |
98 | <title>See Also</title> | |
99 | <para> | |
100 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
101 | <citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
102 | <citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
103 | <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
104 | </para> | |
105 | </refsect1> | |
106 | ||
107 | </refentry> |