Debian Codegraph @

upstream/debian-unstable/man8/systemd-pcrlock.8

raw
1 '\" t
2 .TH "SYSTEMD\-PCRLOCK" "8" "" "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-file-system.service, systemd-pcrlock-firmware-code.service, systemd-pcrlock-firmware-config.service, systemd-pcrlock-machine-id.service, systemd-pcrlock-make-policy.service, systemd-pcrlock-secureboot-authority.service, systemd-pcrlock-secureboot-policy.service \- Analyze and predict TPM2 PCR states and generate an access policy from the prediction
24 .SH "SYNOPSIS"
25 .HP \w'\fB/usr/lib/systemd/systemd\-pcrlock\fR\ 'u
26 \fB/usr/lib/systemd/systemd\-pcrlock\fR [OPTIONS...]
27 .SH "DESCRIPTION"
28 .PP
29 Note: this command is experimental for now\&. While it is likely to become a regular component of systemd, it might still change in behaviour and interface\&.
30 .PP
31 \fBsystemd\-pcrlock\fR
32 is a tool that may be used to analyze and predict TPM2 PCR measurements, and generate TPM2 access policies from the prediction which it stores in a TPM2 NV index (i\&.e\&. in the TPM2 non\-volatile memory)\&. This may then be used to restrict access to TPM2 objects (such as disk encryption keys) to system boot\-ups in which only specific, trusted components are used\&.
33 .PP
34 \fBsystemd\-pcrlock\fR
35 uses as input for its analysis and prediction:
36 .sp
37 .RS 4
38 .ie n \{\
39 \h'-04'\(bu\h'+03'\c
40 .\}
41 .el \{\
42 .sp -1
43 .IP \(bu 2.3
44 .\}
45 The UEFI firmware TPM2 event log (i\&.e\&.
46 /sys/kernel/security/tpm0/binary_bios_measurements) of the current boot\&.
47 .RE
48 .sp
49 .RS 4
50 .ie n \{\
51 \h'-04'\(bu\h'+03'\c
52 .\}
53 .el \{\
54 .sp -1
55 .IP \(bu 2.3
56 .\}
57 The userspace TPM2 event log (i\&.e\&.
58 /run/log/systemd/tpm2\-measure\&.log) of the current boot\&.
59 .RE
60 .sp
61 .RS 4
62 .ie n \{\
63 \h'-04'\(bu\h'+03'\c
64 .\}
65 .el \{\
66 .sp -1
67 .IP \(bu 2.3
68 .\}
69 The current PCR state of the TPM2 chip\&.
70 .RE
71 .sp
72 .RS 4
73 .ie n \{\
74 \h'-04'\(bu\h'+03'\c
75 .\}
76 .el \{\
77 .sp -1
78 .IP \(bu 2.3
79 .\}
80 Boot component definition files (*\&.pcrlock
81 and
82 *\&.pcrlock\&.d/*\&.pcrlock, see
83 \fBsystemd.pcrlock\fR(5)) that each define expected measurements for one component of the boot process, permitting alternative variants for each\&. (Variants may be used to bless multiple kernel versions or boot loader versions at the same time\&.)
84 .RE
85 .PP
86 It uses these inputs to generate a combined event log, validating it against the PCR states\&. It then attempts to recognize event log records and matches them against the defined components\&. For each PCR where this can be done comprehensively (i\&.e\&. where all listed records and all defined components have been matched) this may then be used to predict future PCR measurements, taking the alternative variants defined for each component into account\&. This prediction may then be converted into a TPM2 access policy (consisting of TPM2
87 \fBPolicyPCR\fR
88 and
89 \fBPolicyOR\fR
90 items), which is then stored in an NV index in the TPM2\&. This may be used to then lock secrets (such as disk encryption keys) to these policies (via a TPM2
91 \fBPolicyAuthorizeNV\fR
92 policy)\&.
93 .PP
94 Use tools such as
95 \fBsystemd-cryptenroll\fR(1)
96 or
97 \fBsystemd-repart\fR(8)
98 to bind disk encryption to such a
99 \fBsystemd\-pcrlock\fR
100 TPM2 policy\&. Specifically, see the
101 \fB\-\-tpm2\-pcrlock=\fR
102 switches of these tools\&.
103 .PP
104 The access policy logic requires a TPM2 device that implements the
105 "PolicyAuthorizeNV"
106 command, i\&.e\&. implements TPM 2\&.0 version 1\&.38 or newer\&.
107 .SH "COMMANDS"
108 .PP
109 The following commands are understood:
110 .PP
111 \fBlog\fR
112 .RS 4
113 This reads the combined TPM2 event log, validates it, matches it against the current PCR values, and outputs both in tabular form\&. Combine with
114 \fB\-\-json=\fR
115 to generate output in JSON format\&.
116 .sp
117 Added in version 255\&.
118 .RE
119 .PP
120 \fBcel\fR
121 .RS 4
122 This reads the combined TPM2 event log and writes it to STDOUT in
123 \m[blue]\fBTCG Canonical Event Log Format (CEL\-JSON)\fR\m[]\&\s-2\u[1]\d\s+2\&.
124 .sp
125 Added in version 255\&.
126 .RE
127 .PP
128 \fBlist\-components\fR
129 .RS 4
130 Shows a list of component definitions and their variants, i\&.e\&. the
131 *\&.pcrlock
132 files discovered in
133 /var/lib/pcrlock\&.d/,
134 /usr/lib/pcrlock\&.d/, and the other supported directories\&. See
135 \fBsystemd.pcrlock\fR(5)
136 for details on these files and the full list of directories searched\&.
137 .sp
138 Added in version 255\&.
139 .RE
140 .PP
141 \fBpredict\fR
142 .RS 4
143 Predicts the PCR state on future boots\&. This will analyze the TPM2 event log as described above, recognize components, and then generate all possible resulting PCR values for all combinations of component variants\&. Note that no prediction is made for PCRs whose value does not match the event log records, for which unrecognized measurements are discovered or for which components are defined that cannot be found in the event log\&. This is a safety measure to ensure that any generated access policy can be fulfilled correctly on current and future boots\&.
144 .sp
145 Added in version 255\&.
146 .RE
147 .PP
148 \fBmake\-policy\fR
149 .RS 4
150 This predicts the PCR state for future boots, much like the
151 \fBpredict\fR
152 command above\&. It then uses this data to generate a TPM2 access policy which it stores in a TPM2 NV index\&. The prediction and information about the used TPM2 and its NV index are written to
153 /var/lib/systemd/pcrlock\&.json\&.
154 .sp
155 The NV index is allocated on first invocation, and updated on subsequent invocations\&.
156 .sp
157 The NV index contents may be changed (and thus the policy stored in it updated) by providing an access PIN\&. This PIN is normally generated automatically and stored in encrypted form (with an access policy binding it to the NV index itself) in the aforementioned JSON policy file\&. This PIN may be chosen by the user, via the
158 \fB\-\-recovery\-pin=\fR
159 switch\&. If specified it may be used as alternative path of access to update the policy\&.
160 .sp
161 If the new prediction matches the old this command terminates quickly and executes no further operation\&. (Unless
162 \fB\-\-force\fR
163 is specified, see below\&.)
164 .sp
165 Starting with v256, a copy of the
166 /var/lib/systemd/pcrlock\&.json
167 policy file is encoded in a credential (see
168 \fBsystemd-creds\fR(1)
169 for details) and written to the EFI System Partition or XBOOTLDR partition, in the
170 /loader/credentials/
171 subdirectory\&. There it is picked up at boot by
172 \fBsystemd-stub\fR(7)
173 and passed to the invoked initrd, where it can be used to unlock the root file system (which typically contains
174 /var/, which is where the primary copy of the policy is located, which hence cannot be used to unlock the root file system)\&. The credential file is named after the boot entry token of the installation (see
175 \fBbootctl\fR(1)), which is configurable via the
176 \fB\-\-entry\-token=\fR
177 switch, see below\&.
178 .sp
179 Added in version 255\&.
180 .RE
181 .PP
182 \fBremove\-policy\fR
183 .RS 4
184 Removes a previously generated policy\&. Deletes the
185 /var/lib/systemd/pcrlock\&.json
186 file, and deallocates the NV index\&.
187 .sp
188 Added in version 255\&.
189 .RE
190 .PP
191 \fBis\-supported\fR
192 .RS 4
193 Checks if the local TPM2 supports all functionality for
194 \fBsystemd\-pcrlock\fR
195 to work correctly\&. This does similar tests as
196 \fBsystemd\-analyze has\-tpm2\fR, but also checks for supported of the TPM2 operations requires by
197 \fBsystemd\-pcrlock\fR\&. Outputs one of
198 "no",
199 "partial"
200 (in case some parts of TPM2 support are available in hardware, firmware, OS, but not complete),
201 "obsolete"
202 (if TPM2 support is available in hardware, firmware and OS, but the operations required for
203 \fBsystemd\-pcrlock\fR
204 are missing),
205 "yes"\&. Returns an exit status of zero if full support is available, otherwise non\-zero\&.
206 .sp
207 If combined with
208 \fB\-\-quiet\fR, suppresses the output of the string\&.
209 .sp
210 Currently, this checks for support for the PolicAuthorizeNV TPM2 command, as well as for support of the SHA\-256 hash algorithm\&.
211 .sp
212 Added in version 258\&.
213 .RE
214 .PP
215 \fBlock\-firmware\-code\fR, \fBunlock\-firmware\-code\fR
216 .RS 4
217 Generates/removes
218 \&.pcrlock
219 files based on the TPM2 event log of the current boot covering all records for PCRs 0 ("platform\-code") and 2 ("external\-code")\&.
220 .sp
221 This operation allows locking the boot process to the current version of the firmware of the system and its extension cards\&. This operation should only be used if the system vendor does not provide suitable pcrlock data ahead of time\&.
222 .sp
223 Note that this data only matches the current version of the firmware\&. If a firmware update is applied this data will be out\-of\-date and any access policy generated from it will no longer pass\&. It is thus recommended to invoke
224 \fBunlock\-firmware\-code\fR
225 before doing a firmware update, followed by
226 \fBmake\-policy\fR
227 to refresh the policy\&.
228 .sp
229 \fBsystemd\-pcrlock lock\-firmware\-code\fR
230 is invoked automatically at boot via the
231 systemd\-pcrlock\-firmware\-code\&.service
232 unit, if enabled\&. This ensures that an access policy managed by
233 \fBsystemd\-pcrlock\fR
234 is automatically locked to the new firmware version whenever the policy has been relaxed temporarily, in order to cover for firmware updates, as described above\&.
235 .sp
236 The files are only generated from the event log if the event log matches the current TPM2 PCR state\&.
237 .sp
238 This writes/removes the files
239 /var/lib/pcrlock\&.d/250\-firmware\-code\-early\&.pcrlock\&.d/generated\&.pcrlock
240 and
241 /var/lib/pcrlock\&.d/550\-firmware\-code\-late\&.pcrlock\&.d/generated\&.pcrlock\&.
242 .sp
243 Added in version 255\&.
244 .RE
245 .PP
246 \fBlock\-firmware\-config\fR, \fBunlock\-firmware\-config\fR
247 .RS 4
248 This is similar to
249 \fBlock\-firmware\-code\fR/\fBunlock\-firmware\-code\fR
250 but locks down the firmware configuration, i\&.e\&. PCRs 1 ("platform\-config") and 3 ("external\-config")\&.
251 .sp
252 This functionality should be used with care as in most scenarios a minor firmware configuration change should not invalidate access policies to TPM2 objects\&. Also note that some systems measure unstable and unpredictable information (e\&.g\&. current CPU voltages, temperatures, as part of SMBIOS data) to these PCRs, which means this form of lockdown cannot be used reliably on such systems\&. Use this functionality only if the system and hardware is well known and does not suffer by these limitations, for example in virtualized environments\&.
253 .sp
254 Use
255 \fBunlock\-firmware\-config\fR
256 before making firmware configuration changes\&. If the
257 systemd\-pcrlock\-firmware\-config\&.service
258 unit is enabled it will automatically generate a pcrlock file from the new measurements\&.
259 .sp
260 This writes/removes the files
261 /var/lib/pcrlock\&.d/250\-firmware\-config\-early\&.pcrlock\&.d/generated\&.pcrlock
262 and
263 /var/lib/pcrlock\&.d/550\-firmware\-config\-late\&.pcrlock\&.d/generated\&.pcrlock\&.
264 .sp
265 Added in version 255\&.
266 .RE
267 .PP
268 \fBlock\-secureboot\-policy\fR, \fBunlock\-secureboot\-policy\fR
269 .RS 4
270 Generates/removes a
271 \&.pcrlock
272 file based on the SecureBoot policy currently enforced\&. This looks at the SecureBoot, PK, KEK, db, dbx, dbt, dbr EFI variables and predicts their measurements to PCR 7 ("secure\-boot\-policy") on the next boot\&.
273 .sp
274 Use
275 \fBunlock\-firmware\-config\fR
276 before applying SecureBoot policy updates\&. If the
277 systemd\-pcrlock\-secureboot\-policy\&.service
278 unit is enabled it will automatically generate a pcrlock file from the policy discovered\&.
279 .sp
280 This writes/removes the file
281 /var/lib/pcrlock\&.d/230\-secureboot\-policy\&.pcrlock\&.d/generated\&.pcrlock\&.
282 .sp
283 Added in version 255\&.
284 .RE
285 .PP
286 \fBlock\-secureboot\-authority\fR, \fBunlock\-secureboot\-authority\fR
287 .RS 4
288 Generates/removes a
289 \&.pcrlock
290 file based on the SecureBoot authorities used to validate the boot path\&. SecureBoot authorities are the specific SecureBoot database entries that where used to validate the UEFI PE binaries executed at boot\&. This looks at the event log of the current boot, and uses relevant measurements on PCR 7 ("secure\-boot\-policy")\&.
291 .sp
292 This writes/removes the file
293 /var/lib/pcrlock\&.d/620\-secureboot\-authority\&.pcrlock\&.d/generated\&.pcrlock\&.
294 .sp
295 Added in version 255\&.
296 .RE
297 .PP
298 \fBlock\-gpt\fR [\fIDEVICE\fR], \fBunlock\-gpt\fR
299 .RS 4
300 Generates/removes a
301 \&.pcrlock
302 file based on the GPT partition table of the specified disk\&. If no disk is specified automatically determines the block device backing the root file system\&. This locks the state of the disk partitioning of the booted medium, which firmware measures to PCR 5 ("boot\-loader\-config")\&.
303 .sp
304 This writes/removes the file
305 /var/lib/pcrlock\&.d/600\-gpt\&.pcrlock\&.d/generated\&.pcrlock\&.
306 .sp
307 Added in version 255\&.
308 .RE
309 .PP
310 \fBlock\-pe\fR [\fIBINARY\fR], \fBunlock\-pe\fR
311 .RS 4
312 Generates/removes a
313 \&.pcrlock
314 file based on the specified PE binary\&. This is useful for predicting measurements the firmware makes to PCR 4 ("boot\-loader\-code") if the specified binary is part of the UEFI boot process\&. Use this on boot loader binaries and suchlike\&. Use
315 \fBlock\-uki\fR
316 (see below) for PE binaries that are unified kernel images (UKIs)\&.
317 .sp
318 Expects a path to the PE binary as argument\&. If not specified, reads the binary from STDIN instead\&.
319 .sp
320 The pcrlock file to write must be specified via the
321 \fB\-\-pcrlock=\fR
322 switch\&.
323 .sp
324 Added in version 255\&.
325 .RE
326 .PP
327 \fBlock\-uki\fR [\fIUKI\fR], \fBunlock\-uki\fR
328 .RS 4
329 Generates/removes a
330 \&.pcrlock
331 file based on the specified UKI PE binary\&. This is useful for predicting measurements the firmware makes to PCR 4 ("boot\-loader\-code"), and
332 \fBsystemd-stub\fR(7)
333 makes to PCR 11 ("kernel\-boot"), if the specified UKI is booted\&. This is a superset of
334 \fBlock\-pe\fR\&.
335 .sp
336 Expects a path to the UKI PE binary as argument\&. If not specified, reads the binary from STDIN instead\&.
337 .sp
338 The pcrlock file to write must be specified via the
339 \fB\-\-pcrlock=\fR
340 switch\&.
341 .sp
342 Added in version 255\&.
343 .RE
344 .PP
345 \fBlock\-machine\-id\fR, \fBunlock\-machine\-id\fR
346 .RS 4
347 Generates/removes a
348 \&.pcrlock
349 file based on
350 /etc/machine\-id\&. This is useful for predicting measurements
351 \fBsystemd-pcrmachine.service\fR(8)
352 makes to PCR 15 ("system\-identity")\&.
353 .sp
354 This writes/removes the file
355 /var/lib/pcrlock\&.d/820\-machine\-id\&.pcrlock\&.
356 .sp
357 Added in version 255\&.
358 .RE
359 .PP
360 \fBlock\-file\-system\fR [\fIPATH\fR], \fBunlock\-file\-system\fR [\fIPATH\fR]
361 .RS 4
362 Generates/removes a
363 \&.pcrlock
364 file based on file system identity\&. This is useful for predicting measurements
365 \[email protected]\fR(8)
366 makes to PCR 15 ("system\-identity") for the root and
367 /var/
368 file systems\&.
369 .sp
370 This writes/removes the files
371 /var/lib/pcrlock\&.d/830\-root\-file\-system\&.pcrlock
372 and
373 /var/lib/pcrlock\&.d/840\-file\-system\-\fIpath\fR\&.pcrlock\&.
374 .sp
375 Added in version 255\&.
376 .RE
377 .PP
378 \fBlock\-kernel\-cmdline\fR [\fIFILE\fR], \fBunlock\-kernel\-cmdline\fR
379 .RS 4
380 Generates/removes a
381 \&.pcrlock
382 file based on
383 /proc/cmdline
384 (or the specified file if given)\&. This is useful for predicting measurements the Linux kernel makes to PCR 9 ("kernel\-initrd")\&.
385 .sp
386 This writes/removes the file
387 /var/lib/pcrlock\&.d/710\-kernel\-cmdline\&.pcrlock/generated\&.pcrlock\&.
388 .sp
389 Added in version 255\&.
390 .RE
391 .PP
392 \fBlock\-kernel\-initrd\fR \fIFILE\fR, \fBunlock\-kernel\-initrd\fR
393 .RS 4
394 Generates/removes a
395 \&.pcrlock
396 file based on a kernel initrd cpio archive\&. This is useful for predicting measurements the Linux kernel makes to PCR 9 ("kernel\-initrd")\&. Do not use for
397 \fBsystemd-stub\fR(7)
398 UKIs, as the initrd is combined dynamically from various sources and hence does not take a single input, like this command\&.
399 .sp
400 This writes/removes the file
401 /var/lib/pcrlock\&.d/720\-kernel\-initrd\&.pcrlock/generated\&.pcrlock\&.
402 .sp
403 Added in version 255\&.
404 .RE
405 .PP
406 \fBlock\-raw\fR [\fIFILE\fR], \fBunlock\-raw\fR
407 .RS 4
408 Generates/removes a
409 \&.pcrlock
410 file based on raw binary data\&. The data is either read from the specified file or from STDIN (if none is specified)\&. This requires that
411 \fB\-\-pcrs=\fR
412 is specified\&. The generated \&.pcrlock file is written to the file specified via
413 \fB\-\-pcrlock=\fR
414 or to STDOUT (if none is specified)\&.
415 .sp
416 Added in version 255\&.
417 .RE
418 .SH "OPTIONS"
419 .PP
420 The following options are understood:
421 .PP
422 \fB\-\-raw\-description\fR
423 .RS 4
424 When displaying the TPM2 event log do not attempt to decode the records to provide a friendly event log description string\&. Instead, show the binary payload data in escaped form\&.
425 .sp
426 Added in version 255\&.
427 .RE
428 .PP
429 \fB\-\-pcr=\fR
430 .RS 4
431 Specifies the PCR number to use\&. May be specified more than once to select multiple PCRs\&.
432 .sp
433 This is used by
434 \fBlock\-raw\fR
435 and
436 \fBlock\-pe\fR
437 to select the PCR to lock against\&.
438 .sp
439 If used with
440 \fBpredict\fR
441 and
442 \fBmake\-policy\fR
443 this will override which PCRs to include in the prediction and policy\&. If unspecified this defaults to PCRs 0\-5, 7, 11, 13\-15\&. Note that these commands will not include any PCRs in the prediction/policy (even if specified explicitly) if there are measurements in the event log that do not match the current PCR value, or there are unrecognized measurements in the event log, or components define measurements not seen in the event log\&.
444 .sp
445 Added in version 255\&.
446 .RE
447 .PP
448 \fB\-\-nv\-index=\fR
449 .RS 4
450 Specifies the NV index to store the policy in\&. Honoured by
451 \fBmake\-policy\fR\&. If not specified, the command will automatically pick a free NV index\&.
452 .sp
453 Added in version 255\&.
454 .RE
455 .PP
456 \fB\-\-components=\fR
457 .RS 4
458 Takes a path to read
459 *\&.pcrlock
460 and
461 *\&.pcrlock\&.d/*\&.pcrlock
462 files from\&. May be used more than once to specify multiple such directories\&. If not specified, defaults to
463 /etc/pcrlock\&.d/,
464 /run/pcrlock\&.d/,
465 /var/lib/pcrlock\&.d/,
466 /usr/local/lib/pcrlock\&.d/,
467 /usr/lib/pcrlock\&.d/\&.
468 .sp
469 Added in version 255\&.
470 .RE
471 .PP
472 \fB\-\-location=\fR
473 .RS 4
474 Takes either a string or a colon\-separated pair of strings\&. Configures up to which point in the sorted list of defined components to analyze/predict PCRs to\&. Typically, the
475 \fBsystemd\-pcrlock\fR
476 tool is invoked from a fully booted system after boot\-up and before shutdown\&. This means various components that are defined for shutdown have not been measured yet, and should not be searched for\&. This option allows one to restrict which components are considered for analysis (taking only components before some point into account, ignoring components after them)\&. The expected string is ordered against the filenames of the components defined\&. Any components with a lexicographically later name are ignored\&. This logic applies to the
477 \fBlog\fR,
478 \fBpredict\fR, and
479 \fBmake\-policy\fR
480 verbs\&. If a colon\-separated pair of strings are specified then they select which phases of the boot to include in the prediction/policy\&. The first string defines where the first prediction shall be made, and the second string defines where the last prediction shall be made\&. All such predictions are then combined into one set\&.
481 .sp
482 If used with
483 \fBlist\-components\fR
484 the selected location range will be highlighted in the component list\&.
485 .sp
486 Defaults to
487 "760\-:940\-", which means the policies generated by default will basically cover the whole runtime of the OS userspace, from the initrd (as
488 "760\-"
489 closely follows
490 750\-enter\-initrd\&.pcrlock) until (and including) the main runtime of the system (as
491 "940\-"
492 is closely followed by
493 950\-shutdown\&.pcrlock)\&. See
494 \fBsystemd.pcrlock\fR(5)
495 for a full list of well\-known components, that illustrate where this range is placed by default\&.
496 .sp
497 Added in version 255\&.
498 .RE
499 .PP
500 \fB\-\-recovery\-pin=\fR
501 .RS 4
502 Takes one of
503 "hide",
504 "show"
505 or
506 "query"\&. Defaults to
507 "hide"\&. Honoured by
508 \fBmake\-policy\fR\&. If
509 "query", will query the user for a PIN to unlock the TPM2 NV index with\&. If no policy was created before, this PIN is used to protect the newly allocated NV index\&. If a policy has been created before, the PIN is used to unlock write access to the NV index\&. If either
510 "hide"
511 or
512 "show"
513 is used, a PIN is automatically generated, and \(em only in case of
514 "show"
515 \(em displayed on screen\&. Regardless if user supplied or automatically generated, it is stored in encrypted form in the policy metadata file\&. The recovery PIN may be used to regain write access to an NV index in case the access policy became out of date\&.
516 .sp
517 Added in version 255\&.
518 .RE
519 .PP
520 \fB\-\-pcrlock=\fR
521 .RS 4
522 Takes a file system path as argument\&. If specified, configures where to write the generated pcrlock data to\&. Honoured by the various
523 \fBlock\-*\fR
524 commands\&. If not specified, a default path is generally used, as documented above\&.
525 .sp
526 Added in version 255\&.
527 .RE
528 .PP
529 \fB\-\-policy=\fR
530 .RS 4
531 Takes a file system path as argument\&. If specified, configures where to write pcrlock policy metadata to\&. If not specified, defaults to
532 /var/lib/systemd/pcrlock\&.json\&.
533 .sp
534 Added in version 255\&.
535 .RE
536 .PP
537 \fB\-\-force\fR
538 .RS 4
539 If specified with
540 \fBmake\-policy\fR, the predicted policy will be written to the NV index even if it is detected to be the same as the previously stored one\&.
541 .sp
542 Added in version 255\&.
543 .RE
544 .PP
545 \fB\-\-entry\-token=\fR
546 .RS 4
547 Sets the boot entry token to use for the file name for the pcrlock policy credential in the EFI System Partition or XBOOTLDR partition\&. See the
548 \fBbootctl\fR(1)
549 option of the same regarding expected values\&. This switch has an effect on the
550 \fBmake\-policy\fR
551 command only\&.
552 .sp
553 Added in version 256\&.
554 .RE
555 .PP
556 \fB\-\-quiet\fR
557 .RS 4
558 If specified suppresses output when invoked for
559 \fBis\-supported\fR\&.
560 .sp
561 Added in version 258\&.
562 .RE
563 .PP
564 \fB\-\-json=\fR\fB\fIMODE\fR\fR
565 .RS 4
566 Shows output formatted as JSON\&. Expects one of
567 "short"
568 (for the shortest possible output without any redundant whitespace or line breaks),
569 "pretty"
570 (for a pretty version of the same, with indentation and line breaks) or
571 "off"
572 (to turn off JSON output, the default)\&.
573 .RE
574 .PP
575 \fB\-\-no\-pager\fR
576 .RS 4
577 Do not pipe output into a pager\&.
578 .RE
579 .PP
580 \fB\-h\fR, \fB\-\-help\fR
581 .RS 4
582 Print a short help text and exit\&.
583 .RE
584 .PP
585 \fB\-\-version\fR
586 .RS 4
587 Print a short version string and exit\&.
588 .RE
589 .SH "EXIT STATUS"
590 .PP
591 On success, 0 is returned, a non\-zero failure code otherwise\&.
592 .SH "SEE ALSO"
593 .PP
594 \fBsystemd\fR(1), \fBsystemd.pcrlock\fR(5), \fBsystemd-cryptenroll\fR(1), \[email protected]\fR(8), \fBsystemd-repart\fR(8), \fBsystemd-pcrmachine.service\fR(8), \fBsystemd-creds\fR(1), \fBsystemd-stub\fR(7), \fBbootctl\fR(1)
595 .SH "NOTES"
596 .IP " 1." 4
597 TCG Canonical Event Log Format (CEL-JSON)
598 .RS 4
599 \%https://trustedcomputinggroup.org/resource/canonical-event-log-format/
600 .RE