Debian Codegraph @

upstream/opensuse-tumbleweed/man1/grub2-protect.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH GRUB-PROTECT "1" "May 2026" "GRUB2 2.14" "User Commands"
3 .SH NAME
4 grub-protect \- protect a disk key with a key protector
5 .SH SYNOPSIS
6 .B grub-protect
7 [\fI\,OPTION\/\fR...]
8 .SH DESCRIPTION
9 grub-protect helps to protect a disk encryption key with a specified key protector.
10 .PP
11 Protect a cleartext key using a GRUB key protector that can retrieve the key
12 during boot to unlock fully\-encrypted disks automatically.
13 .TP
14 \fB\-a\fR, \fB\-\-action\fR=\fI\,add\/\fR|remove
15 Add or remove a key protector to or from a key.
16 .TP
17 \fB\-p\fR, \fB\-\-protector\fR=\fI\,tpm2\/\fR
18 Set key protector to use (only tpm2 is currently
19 supported).
20 .TP
21 \fB\-\-tpm2\-asymmetric\fR=\fI\,TYPE\/\fR Set the type of SRK: RSA (RSA2048),
22 RSA3072,
23 RSA4096, and ECC (ECC_NIST_P256). (default: ECC)
24 .TP
25 \fB\-\-tpm2\-bank\fR=\fI\,ALG\/\fR
26 Set the bank of PCRs used to authorize key
27 release: SHA1, SHA256, SHA384, or SHA512.
28 (default: SHA256)
29 .TP
30 \fB\-\-tpm2\-device\fR=\fI\,FILE\/\fR
31 Set the path to the TPM2 device. (default:
32 \fI\,/dev/tpm0\/\fP)
33 .TP
34 \fB\-\-tpm2\-evict\fR
35 Evict a previously persisted SRK from the TPM, if
36 any.
37 .TP
38 \fB\-\-tpm2\-keyfile\fR=\fI\,FILE\/\fR
39 Set the path to a file that contains the
40 cleartext key to protect.
41 .TP
42 \fB\-\-tpm2\-nvindex\fR=\fI\,NUM\/\fR
43 Store the sealed key in a persistent or NV index
44 handle.
45 .TP
46 \fB\-\-tpm2\-outfile\fR=\fI\,FILE\/\fR
47 Set the path to the file that will contain the
48 key after sealing (must be accessible to GRUB
49 during boot).
50 .TP
51 \fB\-\-tpm2\-pcrs\fR=\fI\,0[\/\fR,1]...
52 Set a comma\-separated list of PCRs used to
53 authorize key release e.g., '7,11'. Please be
54 aware that PCR 0~7 are used by the firmware and
55 the measurement result may change after a
56 firmware update (for baremetal systems) or a
57 package (OVMF/SLOF) update in the VM host. This
58 may lead to the failure of key unsealing.
59 (default: 7)
60 .TP
61 \fB\-\-tpm2\-srk\fR=\fI\,NUM\/\fR
62 Set the SRK handle if the SRK is to be made
63 persistent.
64 .TP
65 \fB\-\-tpm2key\fR
66 Use TPM 2.0 Key File format.
67 .TP
68 \-?, \fB\-\-help\fR
69 give this help list
70 .TP
71 \fB\-\-usage\fR
72 give a short usage message
73 .TP
74 \fB\-V\fR, \fB\-\-version\fR
75 print program version
76 .PP
77 Mandatory or optional arguments to long options are also mandatory or optional
78 for any corresponding short options.
79 .SH "REPORTING BUGS"
80 Report bugs to <bug\[email protected]>.
81 .SH "SEE ALSO"
82 The full documentation for
83 .B grub-protect
84 is maintained as a Texinfo manual. If the
85 .B info
86 and
87 .B grub-protect
88 programs are properly installed at your site, the command
89 .IP
90 .B info grub-protect
91 .PP
92 should give you access to the complete manual.