1tpm2(1) General Commands Manual tpm2(1)
2
6 tpm2(1) - A single small executable that combines the various
7 tpm2-tools much like a BusyBox that provides a fairly complete environ‐
8 ment for any small or embedded system.
9
11 tpm2 [OPTIONS] [ARGUMENTS]
12
14 tpm2(1) - To ease installation of tpm2-tools in initrd or embedded sys‐
15 tems where size-optimization and limited resources are important, it is
16 convenient to have a single executable that can dispatch the various
17 TPM2 functionalities specified by the argument which is one of the
18 available tool names.
19 The options and arguments that follow are either the common options or
21 those specific to the tool name.
22 It is important to note that individual tools with prefix tpm2_ can
24 still be invoked, however, they are now soft-linked to this tpm2 exe‐
25 cutable. And so unlike BusyBox, full functionality of the individual
26 tools is available in the executable. For example: tpm2_getrandom 8
27 can alternatively be specified as tpm2 getrandom 8.
28
30 List of possible tool names. NOTE: Specify only one of these. Look at
31 examples.
32 certifyX509certutil
34 checkquote
36 eventlog
38 print
40 rc_decode
42 activatecredential
44 certify
46 changeauth
48 changeeps
50 changepps
52 clear
54 clearcontrol
56 clockrateadjust
58 create
60 createak
62 createek
64 createpolicy
66 setprimarypolicy
68 createprimary
70 dictionarylockout
72 duplicate
74 getcap
76 gettestresult
78 encryptdecrypt
80 evictcontrol
82 flushcontext
84 getekcertificate
86 getrandom
88 gettime
90 hash
92 hierarchycontrol
94 hmac
96 import
98 incrementalselftest
100 load
102 loadexternal
104 makecredential
106 nvdefine
108 nvextend
110 nvincrement
112 nvreadpublic
114 nvread
116 nvreadlock
118 nvundefine
120 nvwrite
122 nvwritelock
124 nvsetbits
126 pcrallocate
128 pcrevent
130 pcrextend
132 pcrread
134 pcrreset
136 policypcr
138 policyauthorize
140 policyauthorizenv
142 policynv
144 policycountertimer
146 policyor
148 policynamehash
150 policytemplate
152 policycphash
154 policypassword
156 policysigned
158 policyticket
160 policyauthvalue
162 policysecret
164 policyrestart
166 policycommandcode
168 policynvwritten
170 policyduplicationselect
172 policylocality
174 quote
176 readclock
178 readpublic
180 rsadecrypt
182 rsaencrypt
184 send
186 selftest
188 sessionconfig
190 setclock
192 shutdown
194 sign
196 certifycreation
198 nvcertify
200 startauthsession
202 startup
204 stirrandom
206 testparms
208 unseal
210 verifysignature
212 setcommandauditstatus
214 getcommandauditdigest
216 getsessionauditdigest
218 geteccparameters
220 ecephemeral
222 commit
224 ecdhkeygen
226 ecdhzgen
228 zgen2phase
230 References
233 This collection of options are common to many programs and provide in‐
234 formation that many users may expect.
235 • -h, --help=[man|no-man]: Display the tools manpage. By default, it
237 attempts to invoke the manpager for the tool, however, on failure
238 will output a short tool summary. This is the same behavior if the
239 “man” option argument is specified, however if explicit “man” is re‐
240 quested, the tool will provide errors from man on stderr. If the
241 “no-man” option if specified, or the manpager fails, the short op‐
242 tions will be output to stdout.
243 To successfully use the manpages feature requires the manpages to be
245 installed or on MANPATH, See man(1) for more details.
246 • -v, --version: Display version information for this tool, supported
248 tctis and exit.
249 • -V, --verbose: Increase the information that the tool prints to the
251 console during its execution. When using this option the file and
252 line number are printed.
253 • -Q, --quiet: Silence normal tool output to stdout.
255 • -Z, --enable-errata: Enable the application of errata fixups. Useful
257 if an errata fixup needs to be applied to commands sent to the TPM.
258 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
259 formation many users may expect.
260
262 The TCTI or “Transmission Interface” is the communication mechanism
263 with the TPM. TCTIs can be changed for communication with TPMs across
264 different mediums.
265 To control the TCTI, the tools respect:
267 1. The command line option -T or --tcti
269 2. The environment variable: TPM2TOOLS_TCTI.
271 Note: The command line option always overrides the environment vari‐
273 able.
274 The current known TCTIs are:
276 • tabrmd - The resource manager, called tabrmd
278 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
279 abrmd as a tcti name are synonymous.
280 • mssim - Typically used for communicating to the TPM software simula‐
282 tor.
283 • device - Used when talking directly to a TPM device file.
285 • none - Do not initalize a connection with the TPM. Some tools allow
287 for off-tpm options and thus support not using a TCTI. Tools that do
288 not support it will error when attempted to be used without a TCTI
289 connection. Does not support ANY options and MUST BE presented as
290 the exact text of “none”.
291 The arguments to either the command line option or the environment
293 variable are in the form:
294 <tcti-name>:<tcti-option-config>
296 Specifying an empty string for either the <tcti-name> or <tcti-op‐
298 tion-config> results in the default being used for that portion respec‐
299 tively.
300 TCTI Defaults
302 When a TCTI is not specified, the default TCTI is searched for using
303 dlopen(3) semantics. The tools will search for tabrmd, device and
304 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
305 what TCTI will be chosen as the default by using the -v option to print
306 the version information. The “default-tcti” key-value pair will indi‐
307 cate which of the aforementioned TCTIs is the default.
308 Custom TCTIs
310 Any TCTI that implements the dynamic TCTI interface can be loaded. The
311 tools internally use dlopen(3), and the raw tcti-name value is used for
312 the lookup. Thus, this could be a path to the shared library, or a li‐
313 brary name as understood by dlopen(3) semantics.
314
316 This collection of options are used to configure the various known TCTI
317 modules available:
318 • device: For the device TCTI, the TPM character device file for use by
320 the device TCTI can be specified. The default is /dev/tpm0.
321 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI=“de‐
323 vice:/dev/tpm0”
324 • mssim: For the mssim TCTI, the domain name or IP address and port
326 number used by the simulator can be specified. The default are
327 127.0.0.1 and 2321.
328 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
330 TI=“mssim:host=localhost,port=2321”
331 • abrmd: For the abrmd TCTI, the configuration string format is a se‐
333 ries of simple key value pairs separated by a `,' character. Each
334 key and value string are separated by a `=' character.
335 • TCTI abrmd supports two keys:
337 1. `bus_name' : The name of the tabrmd service on the bus (a
339 string).
340 2. `bus_type' : The type of the dbus instance (a string) limited to
342 `session' and `system'.
343 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
345 ample.FooBar:
346 \--tcti=tabrmd:bus_name=com.example.FooBar
348 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
350 sion:
351 \--tcti:bus_type=session
353 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
355 ules.
356
358 Get 8 rand bytes from the TPM
359 tpm2 getrandom 8 | xxd -p
360 Send a TPM Startup Command with flags TPM2_SU_CLEAR
362 tpm2 startup -c
363
365 Tools can return any of the following codes:
366 • 0 - Success.
368 • 1 - General non-specific error.
370 • 2 - Options handling error.
372 • 3 - Authentication error.
374 • 4 - TCTI related error.
376 • 5 - Non supported scheme. Applicable to tpm2_testparams.
378
380 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
381
383 See the Mailing List (https://lists.linuxfoundation.org/mailman/listin‐
384 fo/tpm2)
385tpm2-tools tpm2(1)