1tpm2_checkquote(1) General Commands Manual tpm2_checkquote(1)
2
6 tpm2_checkquote(1) - Validates a quote provided by a TPM.
7
9 tpm2_checkquote [OPTIONS]
10
12 tpm2_checkquote(1) - Uses the public portion of the provided key to
13 validate a quote generated by a TPM. This will validate the signature
14 against the quote message and, if provided, verify that the qualifying
15 data and PCR values match those in the quote. The PCR values can be
16 provided with or without the TPML_PCR_SELECTION information. An exam‐
17 ple of PCR values without the PCR selection information is the output
18 from tpm2_pcrread. If PCR value is specified without the PCR selection
19 information, then the PCR selection string must be specified using the
20 -l option to interpret the PCR data.
21
23 • -u, --public=FILE:
24 File input for the public portion of the signature verification key.
26 Either the pem file or tss public format file.
27 • -g, --hash-algorithm=ALGORITHM:
29 The hash algorithm used to digest the message.
31 • -m, --message=FILE:
33 The quote message that makes up the data that is signed by the TPM.
35 • -s, --signature=FILE:
37 The input signature file of the signature to be validated.
39 • -f, --pcr=FILE:
41 Optional PCR input file to save the list of PCR values that were in‐
43 cluded in the quote.
44 • -l, --pcr-list=PCR:
46 The list of PCR banks and selected PCRs' ids for each bank.
48 • -q, --qualification=HEX_STRING_OR_PATH:
50 Qualification data for the quote. Can either be a hex string or
52 path. This is typically used to add a nonce against replay attacks.
53 • -F, --format=FORMAT:
55 DEPRECATED and IGNORED as it's superfluous.
57 References
60 Options that take algorithms support "nice-names".
61 There are two major algorithm specification string classes, simple and
63 complex. Only certain algorithms will be accepted by the TPM, based on
64 usage and conditions.
65 Simple specifiers
67 These are strings with no additional specification data. When creating
68 objects, non-specified portions of an object are assumed to defaults.
69 You can find the list of known "Simple Specifiers Below".
70 Asymmetric
72 • rsa
73 • ecc
75 Symmetric
77 • aes
78 • camellia
80 Hashing Algorithms
82 • sha1
83 • sha256
85 • sha384
87 • sha512
89 • sm3_256
91 • sha3_256
93 • sha3_384
95 • sha3_512
97 Keyed Hash
99 • hmac
100 • xor
102 Signing Schemes
104 • rsassa
105 • rsapss
107 • ecdsa
109 • ecdaa
111 • ecschnorr
113 Asymmetric Encryption Schemes
115 • oaep
116 • rsaes
118 • ecdh
120 Modes
122 • ctr
123 • ofb
125 • cbc
127 • cfb
129 • ecb
131 Misc
133 • null
134 Complex Specifiers
136 Objects, when specified for creation by the TPM, have numerous algo‐
137 rithms to populate in the public data. Things like type, scheme and
138 asymmetric details, key size, etc. Below is the general format for
139 specifying this data: <type>:<scheme>:<symmetric-details>
140 Type Specifiers
142 This portion of the complex algorithm specifier is required. The re‐
143 maining scheme and symmetric details will default based on the type
144 specified and the type of the object being created.
145 • aes - Default AES: aes128
147 • aes128<mode> - 128 bit AES with optional mode (ctr|ofb|cbc|cfb|ecb).
149 If mode is not specified, defaults to null.
150 • aes192<mode> - Same as aes128<mode>, except for a 192 bit key size.
152 • aes256<mode> - Same as aes128<mode>, except for a 256 bit key size.
154 • ecc - Elliptical Curve, defaults to ecc256.
156 • ecc192 - 192 bit ECC
158 • ecc224 - 224 bit ECC
160 • ecc256 - 256 bit ECC
162 • ecc384 - 384 bit ECC
164 • ecc521 - 521 bit ECC
166 • rsa - Default RSA: rsa2048
168 • rsa1024 - RSA with 1024 bit keysize.
170 • rsa2048 - RSA with 2048 bit keysize.
172 • rsa4096 - RSA with 4096 bit keysize.
174 Scheme Specifiers
176 Next, is an optional field, it can be skipped.
177 Schemes are usually Signing Schemes or Asymmetric Encryption Schemes.
179 Most signing schemes take a hash algorithm directly following the sign‐
180 ing scheme. If the hash algorithm is missing, it defaults to sha256.
181 Some take no arguments, and some take multiple arguments.
182 Hash Optional Scheme Specifiers
184 These scheme specifiers are followed by a dash and a valid hash algo‐
185 rithm, For example: oaep-sha256.
186 • oaep
188 • ecdh
190 • rsassa
192 • rsapss
194 • ecdsa
196 • ecschnorr
198 Multiple Option Scheme Specifiers
200 This scheme specifier is followed by a count (max size UINT16) then
201 followed by a dash(-) and a valid hash algorithm. * ecdaa For example,
202 ecdaa4-sha256. If no count is specified, it defaults to 4.
203 No Option Scheme Specifiers
205 This scheme specifier takes NO arguments. * rsaes
206 Symmetric Details Specifiers
208 This field is optional, and defaults based on the type of object being
209 created and it's attributes. Generally, any valid Symmetric specifier
210 from the Type Specifiers list should work. If not specified, an asym‐
211 metric objects symmetric details defaults to aes128cfb.
212 Examples
214 Create an rsa2048 key with an rsaes asymmetric encryption scheme
215 tpm2_create -C parent.ctx -G rsa2048:rsaes -u key.pub -r key.priv
216 Create an ecc256 key with an ecdaa signing scheme with a count of 4
218 and sha384 hash
219 /tpm2_create -C parent.ctx -G ecc256:ec‐
221 daa4-sha384 -u key.pub -r key.priv cryptographic algorithms ALGORITHM.
222
224 Format selection for the signature output file. tss (the default) will
225 output a binary blob according to the TPM 2.0 specification and any po‐
226 tential compiler padding. The option plain will output the plain sig‐
227 nature data as defined by the used cryptographic algorithm. signature
228 FORMAT.
229
231 This collection of options are common to many programs and provide in‐
232 formation that many users may expect.
233 • -h, --help=[man|no-man]: Display the tools manpage. By default, it
235 attempts to invoke the manpager for the tool, however, on failure
236 will output a short tool summary. This is the same behavior if the
237 "man" option argument is specified, however if explicit "man" is re‐
238 quested, the tool will provide errors from man on stderr. If the
239 "no-man" option if specified, or the manpager fails, the short op‐
240 tions will be output to stdout.
241 To successfully use the manpages feature requires the manpages to be
243 installed or on MANPATH, See man(1) for more details.
244 • -v, --version: Display version information for this tool, supported
246 tctis and exit.
247 • -V, --verbose: Increase the information that the tool prints to the
249 console during its execution. When using this option the file and
250 line number are printed.
251 • -Q, --quiet: Silence normal tool output to stdout.
253 • -Z, --enable-errata: Enable the application of errata fixups. Useful
255 if an errata fixup needs to be applied to commands sent to the TPM.
256 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
257 formation many users may expect.
258
260 The TCTI or "Transmission Interface" is the communication mechanism
261 with the TPM. TCTIs can be changed for communication with TPMs across
262 different mediums.
263 To control the TCTI, the tools respect:
265 1. The command line option -T or --tcti
267 2. The environment variable: TPM2TOOLS_TCTI.
269 Note: The command line option always overrides the environment vari‐
271 able.
272 The current known TCTIs are:
274 • tabrmd - The resource manager, called tabrmd
276 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
277 abrmd as a tcti name are synonymous.
278 • mssim - Typically used for communicating to the TPM software simula‐
280 tor.
281 • device - Used when talking directly to a TPM device file.
283 • none - Do not initalize a connection with the TPM. Some tools allow
285 for off-tpm options and thus support not using a TCTI. Tools that do
286 not support it will error when attempted to be used without a TCTI
287 connection. Does not support ANY options and MUST BE presented as
288 the exact text of "none".
289 The arguments to either the command line option or the environment
291 variable are in the form:
292 <tcti-name>:<tcti-option-config>
294 Specifying an empty string for either the <tcti-name> or <tcti-op‐
296 tion-config> results in the default being used for that portion respec‐
297 tively.
298 TCTI Defaults
300 When a TCTI is not specified, the default TCTI is searched for using
301 dlopen(3) semantics. The tools will search for tabrmd, device and
302 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
303 what TCTI will be chosen as the default by using the -v option to print
304 the version information. The "default-tcti" key-value pair will indi‐
305 cate which of the aforementioned TCTIs is the default.
306 Custom TCTIs
308 Any TCTI that implements the dynamic TCTI interface can be loaded. The
309 tools internally use dlopen(3), and the raw tcti-name value is used for
310 the lookup. Thus, this could be a path to the shared library, or a li‐
311 brary name as understood by dlopen(3) semantics.
312
314 This collection of options are used to configure the various known TCTI
315 modules available:
316 • device: For the device TCTI, the TPM character device file for use by
318 the device TCTI can be specified. The default is /dev/tpm0.
319 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI="de‐
321 vice:/dev/tpm0"
322 • mssim: For the mssim TCTI, the domain name or IP address and port
324 number used by the simulator can be specified. The default are
325 127.0.0.1 and 2321.
326 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
328 TI="mssim:host=localhost,port=2321"
329 • abrmd: For the abrmd TCTI, the configuration string format is a se‐
331 ries of simple key value pairs separated by a ',' character. Each
332 key and value string are separated by a '=' character.
333 • TCTI abrmd supports two keys:
335 1. 'bus_name' : The name of the tabrmd service on the bus (a
337 string).
338 2. 'bus_type' : The type of the dbus instance (a string) limited to
340 'session' and 'system'.
341 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
343 ample.FooBar:
344 \--tcti=tabrmd:bus_name=com.example.FooBar
346 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
348 sion:
349 \--tcti:bus_type=session
351 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
353 ules.
354
356 Generate a quote with a TPM, then verify it
357 tpm2_createek -c 0x81010001 -G rsa -u ekpub.pem -f pem
358 tpm2_createak -C 0x81010001 -c ak.ctx -G rsa -s rsassa -g sha256 \
360 -u akpub.pem -f pem -n ak.name
361 tpm2_quote -c ak.ctx -l sha256:15,16,22 -q abc123 -m quote.msg -s quote.sig \
363 -o quote.pcrs -g sha256
364 tpm2_checkquote -u akpub.pem -m quote.msg -s quote.sig -f quote.pcrs -g sha256 \
366 -q abc123
367
369 Tools can return any of the following codes:
370 • 0 - Success.
372 • 1 - General non-specific error.
374 • 2 - Options handling error.
376 • 3 - Authentication error.
378 • 4 - TCTI related error.
380 • 5 - Non supported scheme. Applicable to tpm2_testparams.
382
384 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
385
387 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
388tpm2-tools tpm2_checkquote(1)