1tpm2_setprimarypolicy(1) General Commands Manual tpm2_setprimarypolicy(1)
2
6 tpm2_setprimarypolicy(1) - Sets the authorization policy for the lock‐
7 out (lockoutPolicy), the platform hierarchy (platformPolicy), the stor‐
8 age hierarchy (ownerPolicy), and the endorsement hierarchy (endorse‐
9 mentPolicy).
10
12 tpm2_setprimarypolicy [OPTIONS]
13
15 tpm2_setprimarypolicy(1) - Sets the authorization policy for the lock‐
16 out (lockoutPolicy), the platform hierarchy (platformPolicy), the stor‐
17 age hierarchy (ownerPolicy), and the endorsement hierarchy (endorse‐
18 mentPolicy).
19
21 These options control creating the policy authorization session:
22 · -C, --hierarchy=OBJECT:
24 Specifies the hierarchy whose authorization policy is to be setup.
26 It can be specified as o|p|e|l
27 · -P, --auth=AUTH:
29 Specifies the authorization value for the hierarchy.
31 · -L, --policy=FILE:
33 The file path of the authorization policy data.
35 · -g, --hash-algorithm=ALGORITHM:
37 The hash algorithm used in computation of the policy digest.
39 References
42 The type of a context object, whether it is a handle or file name, is
43 determined according to the following logic in-order:
44 · If the argument is a file path, then the file is loaded as a restored
46 TPM transient object.
47 · If the argument is a prefix match on one of:
49 · owner: the owner hierarchy
51 · platform: the platform hierarchy
53 · endorsement: the endorsement hierarchy
55 · lockout: the lockout control persistent object
57 · If the argument argument can be loaded as a number it will be treat
59 as a handle, e.g. 0x81010013 and used directly.OBJECT.
60
62 Authorization for use of an object in TPM2.0 can come in 3 different
63 forms: 1. Password 2. HMAC 3. Sessions
64 NOTE: "Authorizations default to the EMPTY PASSWORD when not speci‐
66 fied".
67 Passwords
69 Passwords are interpreted in the following forms below using prefix
70 identifiers.
71 Note: By default passwords are assumed to be in the string form when
73 they do not have a prefix.
74 String
76 A string password, specified by prefix "str:" or it's absence (raw
77 string without prefix) is not interpreted, and is directly used for au‐
78 thorization.
79 Examples
81 foobar
82 str:foobar
83 Hex-string
85 A hex-string password, specified by prefix "hex:" is converted from a
86 hexidecimal form into a byte array form, thus allowing passwords with
87 non-printable and/or terminal un-friendly characters.
88 Example
90 hex:0x1122334455667788
91 File
93 A file based password, specified be prefix "file:" should be the path
94 of a file containing the password to be read by the tool or a "-" to
95 use stdin. Storing passwords in files prevents information leakage,
96 passwords passed as options can be read from the process list or common
97 shell history features.
98 Examples
100 # to use stdin and be prompted
101 file:-
102 # to use a file from a path
104 file:path/to/password/file
105 # to echo a password via stdin:
107 echo foobar | tpm2_tool -p file:-
108 # to use a bash here-string via stdin:
110 tpm2_tool -p file:- <<< foobar
112 Sessions
114 When using a policy session to authorize the use of an object, prefix
115 the option argument with the session keyword. Then indicate a path to
116 a session file that was created with tpm2_startauthsession(1). Option‐
117 ally, if the session requires an auth value to be sent with the session
118 handle (eg policy password), then append a + and a string as described
119 in the Passwords section.
120 Examples
122 To use a session context file called session.ctx.
123 session:session.ctx
125 To use a session context file called session.ctx AND send the authvalue
127 mypassword.
128 session:session.ctx+mypassword
130 To use a session context file called session.ctx AND send the HEX auth‐
132 value 0x11223344.
133 session:session.ctx+hex:11223344
135 PCR Authorizations
137 You can satisfy a PCR policy using the "pcr:" prefix and the PCR mini‐
138 language. The PCR minilanguage is as follows:
139 <pcr-spec>=<raw-pcr-file>
140 The PCR spec is documented in in the section "PCR bank specifiers".
142 The raw-pcr-file is an optional the output of the raw PCR contents as
144 returned by tpm2_pcrread(1).
145 PCR bank specifiers (common/pcr.md)
147 Examples
149 To satisfy a PCR policy of sha256 on banks 0, 1, 2 and 3 use a specifi‐
150 er of:
151 pcr:sha256:0,1,2,3
153 specifying AUTH.
155
157 Options that take algorithms support "nice-names".
158 There are two major algorithm specification string classes, simple and
160 complex. Only certain algorithms will be accepted by the TPM, based on
161 usage and conditions.
162 Simple specifiers
164 These are strings with no additional specification data. When creating
165 objects, non-specified portions of an object are assumed to defaults.
166 You can find the list of known "Simple Specifiers Below".
167 Asymmetric
169 · rsa
170 · ecc
172 Symmetric
174 · aes
175 · camellia
177 Hashing Algorithms
179 · sha1
180 · sha256
182 · sha384
184 · sha512
186 · sm3_256
188 · sha3_256
190 · sha3_384
192 · sha3_512
194 Keyed Hash
196 · hmac
197 · xor
199 Signing Schemes
201 · rsassa
202 · rsapss
204 · ecdsa
206 · ecdaa
208 · ecschnorr
210 Asymmetric Encryption Schemes
212 · oaep
213 · rsaes
215 · ecdh
217 Modes
219 · ctr
220 · ofb
222 · cbc
224 · cfb
226 · ecb
228 Misc
230 · null
231 Complex Specifiers
233 Objects, when specified for creation by the TPM, have numerous algo‐
234 rithms to populate in the public data. Things like type, scheme and
235 asymmetric details, key size, etc. Below is the general format for
236 specifying this data: <type>:<scheme>:<symmetric-details>
237 Type Specifiers
239 This portion of the complex algorithm specifier is required. The re‐
240 maining scheme and symmetric details will default based on the type
241 specified and the type of the object being created.
242 · aes - Default AES: aes128
244 · aes128<mode> - 128 bit AES with optional mode (ctr|ofb|cbc|cfb|ecb).
246 If mode is not specified, defaults to null.
247 · aes192<mode> - Same as aes128<mode>, except for a 192 bit key size.
249 · aes256<mode> - Same as aes128<mode>, except for a 256 bit key size.
251 · ecc - Elliptical Curve, defaults to ecc256.
253 · ecc192 - 192 bit ECC
255 · ecc224 - 224 bit ECC
257 · ecc256 - 256 bit ECC
259 · ecc384 - 384 bit ECC
261 · ecc521 - 521 bit ECC
263 · rsa - Default RSA: rsa2048
265 · rsa1024 - RSA with 1024 bit keysize.
267 · rsa2048 - RSA with 2048 bit keysize.
269 · rsa4096 - RSA with 4096 bit keysize.
271 Scheme Specifiers
273 Next, is an optional field, it can be skipped.
274 Schemes are usually Signing Schemes or Asymmetric Encryption Schemes.
276 Most signing schemes take a hash algorithm directly following the sign‐
277 ing scheme. If the hash algorithm is missing, it defaults to sha256.
278 Some take no arguments, and some take multiple arguments.
279 Hash Optional Scheme Specifiers
281 These scheme specifiers are followed by a dash and a valid hash algo‐
282 rithm, For example: oaep-sha256.
283 · oaep
285 · ecdh
287 · rsassa
289 · rsapss
291 · ecdsa
293 · ecschnorr
295 Multiple Option Scheme Specifiers
297 This scheme specifier is followed by a count (max size UINT16) then
298 folloed by a dash(-) and a valid hash algorithm. * ecdaa For example,
299 ecdaa4-sha256. If no count is specified, it defaults to 4.
300 No Option Scheme Specifiers
302 This scheme specifier takes NO arguments. * rsaes
303 Symmetric Details Specifiers
305 This field is optional, and defaults based on the type of object being
306 created and it's attributes. Generally, any valid Symmetric specifier
307 from the Type Specifiers list should work. If not specified, an asym‐
308 metric objects symmetric details defaults to aes128cfb.
309 Examples
311 Create an rsa2048 key with an rsaes asymmetric encryption scheme
312 tpm2_create -C parent.ctx -G rsa2048:rsaes -u key.pub -r key.priv
313 Create an ecc256 key with an ecdaa signing scheme with a count of 4
315 and sha384 hash
316 /tpm2_create -C parent.ctx -G ecc256:ec‐
318 daa4-sha384 -u key.pub -r key.priv cryptographic algorithms ALGORITHM.
319
321 This collection of options are common to many programs and provide in‐
322 formation that many users may expect.
323 · -h, --help=[man|no-man]: Display the tools manpage. By default, it
325 attempts to invoke the manpager for the tool, however, on failure
326 will output a short tool summary. This is the same behavior if the
327 "man" option argument is specified, however if explicit "man" is re‐
328 quested, the tool will provide errors from man on stderr. If the
329 "no-man" option if specified, or the manpager fails, the short op‐
330 tions will be output to stdout.
331 To successfully use the manpages feature requires the manpages to be
333 installed or on MANPATH, See man(1) for more details.
334 · -v, --version: Display version information for this tool, supported
336 tctis and exit.
337 · -V, --verbose: Increase the information that the tool prints to the
339 console during its execution. When using this option the file and
340 line number are printed.
341 · -Q, --quiet: Silence normal tool output to stdout.
343 · -Z, --enable-errata: Enable the application of errata fixups. Useful
345 if an errata fixup needs to be applied to commands sent to the TPM.
346 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
347 formation many users may expect.
348
350 The TCTI or "Transmission Interface" is the communication mechanism
351 with the TPM. TCTIs can be changed for communication with TPMs across
352 different mediums.
353 To control the TCTI, the tools respect:
355 1. The command line option -T or --tcti
357 2. The environment variable: TPM2TOOLS_TCTI.
359 Note: The command line option always overrides the environment vari‐
361 able.
362 The current known TCTIs are:
364 · tabrmd - The resource manager, called tabrmd
366 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
367 abrmd as a tcti name are synonymous.
368 · mssim - Typically used for communicating to the TPM software simula‐
370 tor.
371 · device - Used when talking directly to a TPM device file.
373 · none - Do not initalize a connection with the TPM. Some tools allow
375 for off-tpm options and thus support not using a TCTI. Tools that do
376 not support it will error when attempted to be used without a TCTI
377 connection. Does not support ANY options and MUST BE presented as
378 the exact text of "none".
379 The arguments to either the command line option or the environment
381 variable are in the form:
382 <tcti-name>:<tcti-option-config>
384 Specifying an empty string for either the <tcti-name> or <tcti-op‐
386 tion-config> results in the default being used for that portion respec‐
387 tively.
388 TCTI Defaults
390 When a TCTI is not specified, the default TCTI is searched for using
391 dlopen(3) semantics. The tools will search for tabrmd, device and
392 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
393 what TCTI will be chosen as the default by using the -v option to print
394 the version information. The "default-tcti" key-value pair will indi‐
395 cate which of the aforementioned TCTIs is the default.
396 Custom TCTIs
398 Any TCTI that implements the dynamic TCTI interface can be loaded. The
399 tools internally use dlopen(3), and the raw tcti-name value is used for
400 the lookup. Thus, this could be a path to the shared library, or a li‐
401 brary name as understood by dlopen(3) semantics.
402
404 This collection of options are used to configure the various known TCTI
405 modules available:
406 · device: For the device TCTI, the TPM character device file for use by
408 the device TCTI can be specified. The default is /dev/tpm0.
409 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI="de‐
411 vice:/dev/tpm0"
412 · mssim: For the mssim TCTI, the domain name or IP address and port
414 number used by the simulator can be specified. The default are
415 127.0.0.1 and 2321.
416 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
418 TI="mssim:host=localhost,port=2321"
419 · abrmd: For the abrmd TCTI, the configuration string format is a se‐
421 ries of simple key value pairs separated by a ',' character. Each
422 key and value string are separated by a '=' character.
423 · TCTI abrmd supports two keys:
425 1. 'bus_name' : The name of the tabrmd service on the bus (a
427 string).
428 2. 'bus_type' : The type of the dbus instance (a string) limited to
430 'session' and 'system'.
431 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
433 ample.FooBar:
434 \--tcti=tabrmd:bus_name=com.example.FooBar
436 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
438 sion:
439 \--tcti:bus_type=session
441 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
443 ules.
444
446 Set a blank authorization policy for endorsement hierarchy
447 tpm2_setprimarypolicy -C e
448
450 Tools can return any of the following codes:
451 · 0 - Success.
453 · 1 - General non-specific error.
455 · 2 - Options handling error.
457 · 3 - Authentication error.
459 · 4 - TCTI related error.
461 · 5 - Non supported scheme. Applicable to tpm2_testparams.
463
465 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
466
468 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
469tpm2-tools tpm2_setprimarypolicy(1)