Debian Codegraph @

upstream/debian-unstable/man8/systemd-veritysetup-generator.8

raw
1 '\" t
2 .TH "SYSTEMD\-VERITYSETUP\-GENERATOR" "8" "" "systemd 261~rc3" "systemd-veritysetup-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-veritysetup-generator \- Unit generator for verity protected block devices
24 .SH "SYNOPSIS"
25 .PP
26 /usr/lib/systemd/system\-generators/systemd\-veritysetup\-generator
27 .SH "DESCRIPTION"
28 .PP
29 \fBsystemd\-veritysetup\-generator\fR
30 is a generator that translates kernel command line options configuring verity protected block devices into native systemd units early at boot and when configuration of the system manager is reloaded\&. This will create
31 \[email protected]\fR(8)
32 units as necessary\&.
33 .PP
34 Currently, only two verity devices may be set up with this generator, backing the root and
35 /usr
36 file systems of the OS\&.
37 .PP
38 \fBsystemd\-veritysetup\-generator\fR
39 implements
40 \fBsystemd.generator\fR(7)\&.
41 .SH "KERNEL COMMAND LINE"
42 .PP
43 \fBsystemd\-veritysetup\-generator\fR
44 understands the following kernel command line parameters:
45 .PP
46 \fIsystemd\&.verity=\fR, \fIrd\&.systemd\&.verity=\fR
47 .RS 4
48 Takes a boolean argument\&. Defaults to
49 "yes"\&. If
50 "no", disables the generator entirely\&.
51 \fIrd\&.systemd\&.verity=\fR
52 is honored only in the initrd while
53 \fIsystemd\&.verity=\fR
54 is honored by both the main system and in the initrd\&.
55 .sp
56 Added in version 233\&.
57 .RE
58 .PP
59 \fIveritytab=\fR, \fIrd\&.veritytab=\fR
60 .RS 4
61 Takes a boolean argument\&. Defaults to
62 "yes"\&. If
63 "no", causes the generator to ignore any devices configured in
64 /etc/veritytab\&.
65 \fIrd\&.veritytab=\fR
66 is honored only in the initrd while
67 \fIveritytab=\fR
68 is honored by both the main system and in the initrd\&.
69 .sp
70 Added in version 248\&.
71 .RE
72 .PP
73 \fIroothash=\fR
74 .RS 4
75 Takes a root hash value for the root file system\&. Expects a hash value formatted in hexadecimal characters of the appropriate length (i\&.e\&. most likely 256 bit/64 characters, or longer)\&. If not specified via
76 \fIsystemd\&.verity_root_data=\fR
77 and
78 \fIsystemd\&.verity_root_hash=\fR, the hash and data devices to use are automatically derived from the specified hash value\&. Specifically, the data partition device is looked for under a GPT partition UUID derived from the first 128\-bit of the root hash, the hash partition device is looked for under a GPT partition UUID derived from the last 128\-bit of the root hash\&. Hence it is usually sufficient to specify the root hash to boot from a verity protected root file system, as device paths are automatically determined from it \(em as long as the partition table is properly set up\&.
79 .sp
80 Added in version 233\&.
81 .RE
82 .PP
83 \fIsystemd\&.verity_root_data=\fR, \fIsystemd\&.verity_root_hash=\fR
84 .RS 4
85 These two settings take block device paths as arguments and may be used to explicitly configure the data partition and hash partition to use for setting up the verity protection for the root file system\&. If not specified, these paths are automatically derived from the
86 \fIroothash=\fR
87 argument (see above)\&.
88 .sp
89 Added in version 233\&.
90 .RE
91 .PP
92 \fIsystemd\&.verity_root_options=\fR
93 .RS 4
94 Takes a comma\-separated list of dm\-verity options\&. Expects the following options
95 \fBsuperblock=\fR\fB\fIBOOLEAN\fR\fR,
96 \fBformat=\fR\fB\fINUMBER\fR\fR,
97 \fBdata\-block\-size=\fR\fB\fIBYTES\fR\fR,
98 \fBhash\-block\-size=\fR\fB\fIBYTES\fR\fR,
99 \fBdata\-blocks=\fR\fB\fIBLOCKS\fR\fR,
100 \fBhash\-offset=\fR\fB\fIBYTES\fR\fR,
101 \fBsalt=\fR\fB\fIHEX\fR\fR,
102 \fBuuid=\fR\fB\fIUUID\fR\fR,
103 \fBignore\-corruption\fR,
104 \fBrestart\-on\-corruption\fR,
105 \fBignore\-zero\-blocks\fR,
106 \fBcheck\-at\-most\-once\fR,
107 \fBpanic\-on\-corruption\fR,
108 \fBhash=\fR\fB\fIHASH\fR\fR,
109 \fBfec\-device=\fR\fB\fIPATH\fR\fR,
110 \fBfec\-offset=\fR\fB\fIBYTES\fR\fR,
111 \fBfec\-roots=\fR\fB\fINUM\fR\fR
112 and
113 \fBroot\-hash\-signature=\fR\fB\fIPATH\fR\fR\fB|base64:\fR\fB\fIHEX\fR\fR\&. See
114 \fBveritysetup\fR(8)
115 for more details\&.
116 .sp
117 Added in version 248\&.
118 .RE
119 .PP
120 \fIusrhash=\fR, \fIsystemd\&.verity_usr_data=\fR, \fIsystemd\&.verity_usr_hash=\fR, \fIsystemd\&.verity_usr_options=\fR
121 .RS 4
122 Equivalent to their counterparts for the root file system as described above, but apply to the
123 /usr/
124 file system instead\&.
125 .sp
126 Added in version 250\&.
127 .RE
128 .SH "SEE ALSO"
129 .PP
130 \fBsystemd\fR(1), \[email protected]\fR(8), \fBveritysetup\fR(8), \fBsystemd-fstab-generator\fR(8)