| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\&.PCRLOCK" "5" "" "systemd 261~rc3" "systemd.pcrlock" |
| 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.pcrlock, systemd.pcrlock.d \- PCR measurement prediction files |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.PP |
| 26 |
.RS 4 |
| 27 |
/etc/pcrlock\&.d/*\&.pcrlock |
| 28 |
.RE |
| 29 |
.RS 4 |
| 30 |
/etc/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock |
| 31 |
.RE |
| 32 |
.RS 4 |
| 33 |
/run/pcrlock\&.d/*\&.pcrlock |
| 34 |
.RE |
| 35 |
.RS 4 |
| 36 |
/run/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock |
| 37 |
.RE |
| 38 |
.RS 4 |
| 39 |
/var/lib/pcrlock\&.d/*\&.pcrlock |
| 40 |
.RE |
| 41 |
.RS 4 |
| 42 |
/var/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock |
| 43 |
.RE |
| 44 |
.RS 4 |
| 45 |
/usr/local/lib/pcrlock\&.d/*\&.pcrlock |
| 46 |
.RE |
| 47 |
.RS 4 |
| 48 |
/usr/local/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock |
| 49 |
.RE |
| 50 |
.RS 4 |
| 51 |
/usr/lib/pcrlock\&.d/*\&.pcrlock |
| 52 |
.RE |
| 53 |
.RS 4 |
| 54 |
/usr/lib/pcrlock\&.d/*\&.pcrlock\&.d/*\&.pcrlock |
| 55 |
.RE |
| 56 |
.SH "DESCRIPTION" |
| 57 |
.PP |
| 58 |
*\&.pcrlock |
| 59 |
files define expected TPM2 PCR measurements of components involved in the boot process\&. |
| 60 |
\fBsystemd-pcrlock\fR(8) |
| 61 |
uses such pcrlock files to analyze and predict TPM2 PCR measurements\&. The pcrlock files are JSON arrays that follow a subset of the |
| 62 |
\m[blue]\fBTCG Canonical Event Log Format (CEL\-JSON)\fR\m[]\&\s-2\u[1]\d\s+2 |
| 63 |
specification\&. Specifically the |
| 64 |
"recnum", |
| 65 |
"content", and |
| 66 |
"content_type" |
| 67 |
record fields are not used and ignored if present\&. Each pcrlock file defines one set of expected, ordered PCR measurements of a specific component of the boot\&. |
| 68 |
.PP |
| 69 |
*\&.pcrlock files may be placed in various |
| 70 |
\&.d/ |
| 71 |
drop\-in directories (see above for a full list)\&. All matching files discovered in these directories are sorted alphabetically by their file name (without taking the actual directory they were found in into account): pcrlock files with alphabetically earlier names are expected to cover measurements done before those with alphabetically later names\&. In order to make positioning pcrlock files in the boot process convenient the files are expected (by convention, this is not enforced) to be named |
| 72 |
"\fINNN\fR\-\fIcomponent\fR\&.pcrlock" |
| 73 |
(where |
| 74 |
\fINNN\fR |
| 75 |
is a three\-digit decimal number), for example |
| 76 |
750\-enter\-initrd\&.pcrlock\&. |
| 77 |
.PP |
| 78 |
For various components of the boot process more than one alternative pcrlock file shall be supported (i\&.e\&. "variants")\&. For example to cover multiple kernels installed in parallel in the access policy, or multiple versions of the boot loader\&. This can be done by placing |
| 79 |
*\&.pcrlock\&.d/*\&.pcrlock |
| 80 |
in the drop\-in dirs, i\&.e\&. a common directory for a specific component, that contains one or more pcrlock files each covering one |
| 81 |
\fIvariant\fR |
| 82 |
of the component\&. Example: |
| 83 |
650\-kernel\&.pcrlock\&.d/6\&.5\&.5\-200\&.fc38\&.x86_64\&.pcrlock |
| 84 |
and |
| 85 |
650\-kernel\&.pcrlock\&.d/6\&.5\&.7\-100\&.fc38\&.x86_64\&.pcrlock |
| 86 |
.PP |
| 87 |
Use |
| 88 |
\fBsystemd\-pcrlock list\-components\fR |
| 89 |
to list all pcrlock files currently installed\&. |
| 90 |
.PP |
| 91 |
Use the various |
| 92 |
\fBlock\-*\fR |
| 93 |
commands of |
| 94 |
\fBsystemd\-pcrlock\fR |
| 95 |
to automatically generate suitable pcrlock files for various types of resources\&. |
| 96 |
.SH "WELL\-KNOWN COMPONENTS" |
| 97 |
.PP |
| 98 |
Components of the boot process may be defined freely by the administrator or OS vendor\&. The following components are well\-known however, and are defined by systemd\&. The list below is useful for ordering local pcrlock files properly against these components of the boot\&. |
| 99 |
.PP |
| 100 |
240\-secureboot\-policy\&.pcrlock |
| 101 |
.RS 4 |
| 102 |
The SecureBoot policy, as recorded to PCR 7\&. May be generated via |
| 103 |
\fBsystemd\-pcrlock lock\-secureboot\-policy\fR\&. |
| 104 |
.sp |
| 105 |
Added in version 255\&. |
| 106 |
.RE |
| 107 |
.PP |
| 108 |
250\-firmware\-code\-early\&.pcrlock |
| 109 |
.RS 4 |
| 110 |
Firmware code measurements, as recorded to PCR 0 and 2, up to the separator measurement (see |
| 111 |
400\-secureboot\-separator\&.pcrlock |
| 112 |
below)\&. May be generated via |
| 113 |
\fBsystemd\-pcrlock lock\-firmware\-code\fR\&. |
| 114 |
.sp |
| 115 |
Added in version 255\&. |
| 116 |
.RE |
| 117 |
.PP |
| 118 |
250\-firmware\-config\-early\&.pcrlock |
| 119 |
.RS 4 |
| 120 |
Firmware configuration measurements, as recorded to PCR 1 and 3, up to the separator measurement (see |
| 121 |
400\-secureboot\-separator\&.pcrlock |
| 122 |
below)\&. May be generated via |
| 123 |
\fBsystemd\-pcrlock lock\-firmware\-config\fR\&. |
| 124 |
.sp |
| 125 |
Added in version 255\&. |
| 126 |
.RE |
| 127 |
.PP |
| 128 |
350\-action\-efi\-application\&.pcrlock |
| 129 |
.RS 4 |
| 130 |
The EFI "Application" measurement done once by the firmware\&. Statically defined\&. |
| 131 |
.sp |
| 132 |
Added in version 255\&. |
| 133 |
.RE |
| 134 |
.PP |
| 135 |
400\-secureboot\-separator\&.pcrlock |
| 136 |
.RS 4 |
| 137 |
The EFI "separator" measurement on PCR 7 done once by the firmware to indicate where firmware control transitions into boot loader/OS control\&. Statically defined\&. |
| 138 |
.sp |
| 139 |
Added in version 255\&. |
| 140 |
.RE |
| 141 |
.PP |
| 142 |
500\-separator\&.pcrlock |
| 143 |
.RS 4 |
| 144 |
The EFI "separator" measurements on PCRs 0\-6 done once by the firmware to indicate where firmware control transitions into boot loader/OS control\&. Statically defined\&. |
| 145 |
.sp |
| 146 |
Added in version 255\&. |
| 147 |
.RE |
| 148 |
.PP |
| 149 |
550\-firmware\-code\-late\&.pcrlock |
| 150 |
.RS 4 |
| 151 |
Firmware code measurements, as recorded to PCR 0 and 2, after the separator measurement (see |
| 152 |
400\-secureboot\-separator\&.pcrlock |
| 153 |
above)\&. May be generated via |
| 154 |
\fBsystemd\-pcrlock lock\-firmware\-code\fR\&. |
| 155 |
.sp |
| 156 |
Added in version 255\&. |
| 157 |
.RE |
| 158 |
.PP |
| 159 |
550\-firmware\-config\-late\&.pcrlock |
| 160 |
.RS 4 |
| 161 |
Firmware configuration measurements, as recorded to PCR 1 and 3, after the separator measurement (see |
| 162 |
400\-secureboot\-separator\&.pcrlock |
| 163 |
above)\&. May be generated via |
| 164 |
\fBsystemd\-pcrlock lock\-firmware\-config\fR\&. |
| 165 |
.sp |
| 166 |
Added in version 255\&. |
| 167 |
.RE |
| 168 |
.PP |
| 169 |
600\-gpt\&.pcrlock |
| 170 |
.RS 4 |
| 171 |
The GPT partition table of the booted medium, as recorded to PCR 5 by the firmware\&. May be generated via |
| 172 |
\fBsystemd\-pcrlock lock\-gpt\fR\&. |
| 173 |
.sp |
| 174 |
Added in version 255\&. |
| 175 |
.RE |
| 176 |
.PP |
| 177 |
620\-secureboot\-authority\&.pcrlock |
| 178 |
.RS 4 |
| 179 |
The SecureBoot authority, as recorded to PCR 7\&. May be generated via |
| 180 |
\fBsystemd\-pcrlock lock\-secureboot\-authority\fR\&. |
| 181 |
.sp |
| 182 |
Added in version 255\&. |
| 183 |
.RE |
| 184 |
.PP |
| 185 |
700\-action\-efi\-exit\-boot\-services\&.pcrlock |
| 186 |
.RS 4 |
| 187 |
The EFI action generated when |
| 188 |
\fBExitBootServices()\fR |
| 189 |
is generated, i\&.e\&. when the UEFI environment is left and the OS takes over\&. Covers the PCR 5 measurement\&. Statically defined\&. |
| 190 |
.sp |
| 191 |
Added in version 255\&. |
| 192 |
.RE |
| 193 |
.PP |
| 194 |
710\-kernel\-cmdline\&.pcrlock |
| 195 |
.RS 4 |
| 196 |
The kernel command line, as measured by the Linux kernel to PCR 9\&. May be generated via |
| 197 |
\fBsystemd\-pcrlock lock\-kernel\-cmdline\fR\&. |
| 198 |
.sp |
| 199 |
Added in version 255\&. |
| 200 |
.RE |
| 201 |
.PP |
| 202 |
720\-kernel\-initrd\&.pcrlock |
| 203 |
.RS 4 |
| 204 |
The kernel initrd, as measured by the Linux kernel to PCR 9\&. May be generated via |
| 205 |
\fBsystemd\-pcrlock lock\-kernel\-initrd\fR\&. |
| 206 |
.sp |
| 207 |
Added in version 255\&. |
| 208 |
.RE |
| 209 |
.PP |
| 210 |
750\-enter\-initrd\&.pcrlock |
| 211 |
.RS 4 |
| 212 |
The measurement to PCR 11 |
| 213 |
\fBsystemd-pcrphase-initrd.service\fR(8) |
| 214 |
makes when the initrd initializes\&. Statically defined\&. |
| 215 |
.sp |
| 216 |
Added in version 255\&. |
| 217 |
.RE |
| 218 |
.PP |
| 219 |
800\-leave\-initrd\&.pcrlock |
| 220 |
.RS 4 |
| 221 |
The measurement to PCR 11 |
| 222 |
\fBsystemd-pcrphase-initrd.service\fR(8) |
| 223 |
makes when the initrd finishes\&. Statically defined\&. |
| 224 |
.sp |
| 225 |
Added in version 255\&. |
| 226 |
.RE |
| 227 |
.PP |
| 228 |
820\-machine\-id\&.pcrlock |
| 229 |
.RS 4 |
| 230 |
The measurement to PCR 15 |
| 231 |
\fBsystemd-pcrmachine.service\fR(8) |
| 232 |
makes at boot, covering |
| 233 |
/etc/machine\-id |
| 234 |
contents\&. May be generated via |
| 235 |
\fBsystemd\-pcrlock lock\-machine\-id\fR\&. |
| 236 |
.sp |
| 237 |
Added in version 255\&. |
| 238 |
.RE |
| 239 |
.PP |
| 240 |
830\-root\-file\-system\&.pcrlock |
| 241 |
.RS 4 |
| 242 |
The measurement to PCR 15 |
| 243 |
\fBsystemd-pcrfs-root.service\fR(8) |
| 244 |
makes at boot, covering the root file system identity\&. May be generated via |
| 245 |
\fBsystemd\-pcrlock lock\-file\-system\fR\&. |
| 246 |
.sp |
| 247 |
Added in version 255\&. |
| 248 |
.RE |
| 249 |
.PP |
| 250 |
850\-sysinit\&.pcrlock |
| 251 |
.RS 4 |
| 252 |
The measurement to PCR 11 |
| 253 |
\fBsystemd-pcrphase-sysinit.service\fR(8) |
| 254 |
makes when the main userspace did basic initialization and will now proceed to start regular system services\&. Statically defined\&. |
| 255 |
.sp |
| 256 |
Added in version 255\&. |
| 257 |
.RE |
| 258 |
.PP |
| 259 |
900\-ready\&.pcrlock |
| 260 |
.RS 4 |
| 261 |
The measurement to PCR 11 |
| 262 |
\fBsystemd-pcrphase.service\fR(8) |
| 263 |
makes when the system fully booted up\&. Statically defined\&. |
| 264 |
.sp |
| 265 |
Added in version 255\&. |
| 266 |
.RE |
| 267 |
.PP |
| 268 |
950\-shutdown\&.pcrlock |
| 269 |
.RS 4 |
| 270 |
The measurement to PCR 11 |
| 271 |
\fBsystemd-pcrphase.service\fR(8) |
| 272 |
makes when the system begins shutdown\&. Statically defined\&. |
| 273 |
.sp |
| 274 |
Added in version 255\&. |
| 275 |
.RE |
| 276 |
.PP |
| 277 |
990\-final\&.pcrlock |
| 278 |
.RS 4 |
| 279 |
The measurement to PCR 11 |
| 280 |
\fBsystemd-pcrphase-sysinit.service\fR(8) |
| 281 |
makes when the system is close to finishing shutdown\&. Statically defined\&. |
| 282 |
.sp |
| 283 |
Added in version 255\&. |
| 284 |
.RE |
| 285 |
.SH "SEE ALSO" |
| 286 |
.PP |
| 287 |
\fBsystemd\fR(1), \fBsystemd-pcrlock\fR(8) |
| 288 |
.SH "NOTES" |
| 289 |
.IP " 1." 4 |
| 290 |
TCG Canonical Event Log Format (CEL-JSON) |
| 291 |
.RS 4 |
| 292 |
\%https://trustedcomputinggroup.org/resource/canonical-event-log-format/ |
| 293 |
.RE |