1tpm2_quote(1) General Commands Manual tpm2_quote(1)
2
6 tpm2_quote(1) - Provide a quote and signature from the TPM.
7
9 tpm2_quote [OPTIONS]
10
12 tpm2_quote(1) - Provide quote and signature for given list of PCRs in
13 given algorithm/banks.
14
16 · -c, --key-context=OBJECT:
17 Context object for the quote signing key.
19 · -p, --auth=AUTH:
21 Specifies the authorization value for AK specified by option -C.
23 · -l, --pcr-list=PCR:
25 The list of PCR banks and selected PCRs' ids for each bank. Also see
27 NOTES section below.
28 · -m, --message=FILE:
30 Message output file, records the quote message that makes up the data
32 that is signed by the TPM.
33 · -s, --signature=FILE:
35 Signature output file, records the signature in the format specified
37 via the -f option.
38 · -f, --format=FORMAT:
40 Format selection for the signature output file.
42 · -o, --pcr=FILE.
44 PCR output file, optional, records the list of PCR values as defined
46 by -l.
47 · -q, --qualification=HEX_STRING:
49 Data given as a Hex string to qualify the quote, optional. This is
51 typically used to add a nonce against replay attacks.
52 · -g, --hash-algorithm:
54 Hash algorithm for signature. Defaults to sha256.
56 References
59 The type of a context object, whether it is a handle or file name, is
60 determined according to the following logic in-order:
61 · If the argument is a file path, then the file is loaded as a restored
63 TPM transient object.
64 · If the argument is a prefix match on one of:
66 · owner: the owner hierarchy
68 · platform: the platform hierarchy
70 · endorsement: the endorsement hierarchy
72 · lockout: the lockout control persistent object
74 · If the argument argument can be loaded as a number it will be treat
76 as a handle, e.g. 0x81010013 and used directly.OBJECT.
77
79 Authorization for use of an object in TPM2.0 can come in 3 different
80 forms: 1. Password 2. HMAC 3. Sessions
81 NOTE: "Authorizations default to the EMPTY PASSWORD when not speci‐
83 fied".
84 Passwords
86 Passwords are interpreted in the following forms below using prefix
87 identifiers.
88 Note: By default passwords are assumed to be in the string form when
90 they do not have a prefix.
91 String
93 A string password, specified by prefix "str:" or it's absence (raw
94 string without prefix) is not interpreted, and is directly used for au‐
95 thorization.
96 Examples
98 foobar
99 str:foobar
100 Hex-string
102 A hex-string password, specified by prefix "hex:" is converted from a
103 hexidecimal form into a byte array form, thus allowing passwords with
104 non-printable and/or terminal un-friendly characters.
105 Example
107 hex:0x1122334455667788
108 File
110 A file based password, specified be prefix "file:" should be the path
111 of a file containing the password to be read by the tool or a "-" to
112 use stdin. Storing passwords in files prevents information leakage,
113 passwords passed as options can be read from the process list or common
114 shell history features.
115 Examples
117 # to use stdin and be prompted
118 file:-
119 # to use a file from a path
121 file:path/to/password/file
122 # to echo a password via stdin:
124 echo foobar | tpm2_tool -p file:-
125 # to use a bash here-string via stdin:
127 tpm2_tool -p file:- <<< foobar
129 Sessions
131 When using a policy session to authorize the use of an object, prefix
132 the option argument with the session keyword. Then indicate a path to
133 a session file that was created with tpm2_startauthsession(1). Option‐
134 ally, if the session requires an auth value to be sent with the session
135 handle (eg policy password), then append a + and a string as described
136 in the Passwords section.
137 Examples
139 To use a session context file called session.ctx.
140 session:session.ctx
142 To use a session context file called session.ctx AND send the authvalue
144 mypassword.
145 session:session.ctx+mypassword
147 To use a session context file called session.ctx AND send the HEX auth‐
149 value 0x11223344.
150 session:session.ctx+hex:11223344
152 PCR Authorizations
154 You can satisfy a PCR policy using the "pcr:" prefix and the PCR mini‐
155 language. The PCR minilanguage is as follows:
156 <pcr-spec>=<raw-pcr-file>
157 The PCR spec is documented in in the section "PCR bank specifiers".
159 The raw-pcr-file is an optional the output of the raw PCR contents as
161 returned by tpm2_pcrread(1).
162 PCR bank specifiers (common/pcr.md)
164 Examples
166 To satisfy a PCR policy of sha256 on banks 0, 1, 2 and 3 use a specifi‐
167 er of:
168 pcr:sha256:0,1,2,3
170 specifying AUTH.
172
174 Format selection for the signature output file. tss (the default) will
175 output a binary blob according to the TPM 2.0 specification and any po‐
176 tential compiler padding. The option plain will output the plain sig‐
177 nature data as defined by the used cryptographic algorithm. signature
178 FORMAT.
179
181 PCR Bank Selection lists follow the below specification:
182 <BANK>:<PCR>[,<PCR>] or <BANK>:all
184 multiple banks may be separated by '+'.
186 For example:
188 sha1:3,4+sha256:all
190 will select PCRs 3 and 4 from the SHA1 bank and PCRs 0 to 23 from the
192 SHA256 bank.
193 Note
195 PCR Selections allow for up to 5 hash to pcr selection mappings. This
196 is a limitation in design in the single call to the tpm to get the pcr
197 values.
198
200 This collection of options are common to many programs and provide in‐
201 formation that many users may expect.
202 · -h, --help=[man|no-man]: Display the tools manpage. By default, it
204 attempts to invoke the manpager for the tool, however, on failure
205 will output a short tool summary. This is the same behavior if the
206 "man" option argument is specified, however if explicit "man" is re‐
207 quested, the tool will provide errors from man on stderr. If the
208 "no-man" option if specified, or the manpager fails, the short op‐
209 tions will be output to stdout.
210 To successfully use the manpages feature requires the manpages to be
212 installed or on MANPATH, See man(1) for more details.
213 · -v, --version: Display version information for this tool, supported
215 tctis and exit.
216 · -V, --verbose: Increase the information that the tool prints to the
218 console during its execution. When using this option the file and
219 line number are printed.
220 · -Q, --quiet: Silence normal tool output to stdout.
222 · -Z, --enable-errata: Enable the application of errata fixups. Useful
224 if an errata fixup needs to be applied to commands sent to the TPM.
225 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
226 formation many users may expect.
227
229 The TCTI or "Transmission Interface" is the communication mechanism
230 with the TPM. TCTIs can be changed for communication with TPMs across
231 different mediums.
232 To control the TCTI, the tools respect:
234 1. The command line option -T or --tcti
236 2. The environment variable: TPM2TOOLS_TCTI.
238 Note: The command line option always overrides the environment vari‐
240 able.
241 The current known TCTIs are:
243 · tabrmd - The resource manager, called tabrmd
245 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
246 abrmd as a tcti name are synonymous.
247 · mssim - Typically used for communicating to the TPM software simula‐
249 tor.
250 · device - Used when talking directly to a TPM device file.
252 · none - Do not initalize a connection with the TPM. Some tools allow
254 for off-tpm options and thus support not using a TCTI. Tools that do
255 not support it will error when attempted to be used without a TCTI
256 connection. Does not support ANY options and MUST BE presented as
257 the exact text of "none".
258 The arguments to either the command line option or the environment
260 variable are in the form:
261 <tcti-name>:<tcti-option-config>
263 Specifying an empty string for either the <tcti-name> or <tcti-op‐
265 tion-config> results in the default being used for that portion respec‐
266 tively.
267 TCTI Defaults
269 When a TCTI is not specified, the default TCTI is searched for using
270 dlopen(3) semantics. The tools will search for tabrmd, device and
271 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
272 what TCTI will be chosen as the default by using the -v option to print
273 the version information. The "default-tcti" key-value pair will indi‐
274 cate which of the aforementioned TCTIs is the default.
275 Custom TCTIs
277 Any TCTI that implements the dynamic TCTI interface can be loaded. The
278 tools internally use dlopen(3), and the raw tcti-name value is used for
279 the lookup. Thus, this could be a path to the shared library, or a li‐
280 brary name as understood by dlopen(3) semantics.
281
283 This collection of options are used to configure the various known TCTI
284 modules available:
285 · device: For the device TCTI, the TPM character device file for use by
287 the device TCTI can be specified. The default is /dev/tpm0.
288 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI="de‐
290 vice:/dev/tpm0"
291 · mssim: For the mssim TCTI, the domain name or IP address and port
293 number used by the simulator can be specified. The default are
294 127.0.0.1 and 2321.
295 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
297 TI="mssim:host=localhost,port=2321"
298 · abrmd: For the abrmd TCTI, the configuration string format is a se‐
300 ries of simple key value pairs separated by a ',' character. Each
301 key and value string are separated by a '=' character.
302 · TCTI abrmd supports two keys:
304 1. 'bus_name' : The name of the tabrmd service on the bus (a
306 string).
307 2. 'bus_type' : The type of the dbus instance (a string) limited to
309 'session' and 'system'.
310 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
312 ample.FooBar:
313 \--tcti=tabrmd:bus_name=com.example.FooBar
315 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
317 sion:
318 \--tcti:bus_type=session
320 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
322 ules.
323
325 tpm2_createprimary -C e -c primary.ctx
326 tpm2_create -C primary.ctx -u key.pub -r key.priv
328 tpm2_load -C primary.ctx -u key.pub -r key.priv -c key.ctx
330 tpm2_quote -Q -c key.ctx -l 0x0004:16,17,18+0x000b:16,17,18
332
334 The maximum number of PCR that can be quoted at once is associated with
335 the maximum length of a bank.
336 On most TPMs, it means that this tool can quote up to 24 PCRs at once.
338 That this performs a detached signature.
340
342 Tools can return any of the following codes:
343 · 0 - Success.
345 · 1 - General non-specific error.
347 · 2 - Options handling error.
349 · 3 - Authentication error.
351 · 4 - TCTI related error.
353 · 5 - Non supported scheme. Applicable to tpm2_testparams.
355
357 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
358
360 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
361tpm2-tools tpm2_quote(1)