[go: up one dir, main page]

File: tpm2.1.md

package info (click to toggle)
tpm2-tools 5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,396 kB
  • sloc: ansic: 35,984; sh: 12,809; xml: 8,089; makefile: 569
file content (253 lines) | stat: -rw-r--r-- 3,283 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
% tpm2(1) tpm2-tools | General Commands Manual

# NAME

**tpm2**(1) - A single small executable that combines the various tpm2-tools
much like a BusyBox that provides a fairly complete environment for any small or
embedded system.

# SYNOPSIS

**tpm2** [*OPTIONS*] [*ARGUMENTS*]

# DESCRIPTION

**tpm2**(1) - To ease installation of tpm2-tools in initrd or embedded systems
where size-optimization and limited resources are important, it is convenient to
have a single executable that can dispatch the various TPM2 functionalities
specified by the argument which is one of the available tool names.

The options and arguments that follow are either the **common options** or those
specific to the **tool name**.

It is important to note that individual tools with prefix **tpm2_** can still be
invoked, however, they are now soft-linked to this **tpm2** executable. And so
unlike BusyBox, full functionality of the individual tools is available in the
executable. For example: **tpm2_getrandom 8** can alternatively be specified as
**tpm2 getrandom 8**.


# ARGUMENTS

List of possible tool names. NOTE: Specify only one of these. Look at examples.

**certifyX509certutil**

**checkquote**

**eventlog**

**print**

**rc_decode**

**activatecredential**

**certify**

**changeauth**

**changeeps**

**changepps**

**clear**

**clearcontrol**

**clockrateadjust**

**create**

**createak**

**createek**

**createpolicy**

**setprimarypolicy**

**createprimary**

**dictionarylockout**

**duplicate**

**getcap**

**gettestresult**

**encryptdecrypt**

**evictcontrol**

**flushcontext**

**getekcertificate**

**getrandom**

**gettime**

**hash**

**hierarchycontrol**

**hmac**

**import**

**incrementalselftest**

**load**

**loadexternal**

**makecredential**

**nvdefine**

**nvextend**

**nvincrement**

**nvreadpublic**

**nvread**

**nvreadlock**

**nvundefine**

**nvwrite**

**nvwritelock**

**nvsetbits**

**pcrallocate**

**pcrevent**

**pcrextend**

**pcrread**

**pcrreset**

**policypcr**

**policyauthorize**

**policyauthorizenv**

**policynv**

**policycountertimer**

**policyor**

**policynamehash**

**policytemplate**

**policycphash**

**policypassword**

**policysigned**

**policyticket**

**policyauthvalue**

**policysecret**

**policyrestart**

**policycommandcode**

**policynvwritten**

**policyduplicationselect**

**policylocality**

**quote**

**readclock**

**readpublic**

**rsadecrypt**

**rsaencrypt**

**send**

**selftest**

**setclock**

**shutdown**

**sign**

**certifycreation**

**nvcertify**

**startauthsession**

**startup**

**stirrandom**

**testparms**

**unseal**

**verifysignature**

**setcommandauditstatus**

**getcommandauditdigest**

**getsessionauditdigest**

**geteccparameters**

**ecephemeral**

**commit**

**ecdhkeygen**

**ecdhzgen**

**zgen2phase**


## References

[common options](common/options.md) collection of common options that provide
information many users may expect.

[common tcti options](common/tcti.md) collection of options used to configure
the various known TCTI modules.

# EXAMPLES

## Get 8 rand bytes from the TPM
```bash
tpm2 getrandom 8 | xxd -p
```

## Send a TPM Startup Command with flags TPM2\_SU\_CLEAR
```bash
tpm2 startup -c
```

[returns](common/returns.md)

[footer](common/footer.md)