1tpm2_nvdefine(1) General Commands Manual tpm2_nvdefine(1)
2
6 tpm2_nvdefine(1) - Define a TPM Non-Volatile (NV) index.
7
9 tpm2_nvdefine [OPTIONS] [ARGUMENT]
10
12 tpm2_nvdefine(1) - Define an NV index with given auth value. The index
13 is specified as an argument. It can be specified as raw handle or an
14 offset value to the nv handle range "TPM2_HR_NV_INDEX". If an index
15 isn't specified, the tool uses the first free index. The tool outputs
16 the nv index defined on success.
17
19 · -C, --hierarchy=OBJECT:
20 Specifies the handle used to authorize. Defaults to o, TPM_RH_OWNER,
21 when no value has been specified. Supported options are:
22 · o for TPM_RH_OWNER
24 · p for TPM_RH_PLATFORM
26 · <num> where a hierarchy handle or nv-index may be used.
28 · -s, --size=NATURAL_NUMBER:
30 Specifies the size of data area in bytes. Defaults to MAX_NV_IN‐
32 DEX_SIZE which is typically 2048.
33 · -a, --attributes=ATTRIBUTES
35 Specifies the attribute values for the nv region used when creating
37 the entity. Either the raw bitfield mask or "nice-names" may be
38 used. See section "NV Attributes" for more details. If not speci‐
39 fied, the attributes default to various selections based on the hier‐
40 archy the index is defined in. For the owner hiearchy the defaults
41 are:
42 · TPMA_NV_OWNERWRITE
44 · TPMA_NV_OWNERREAD For the platform hiearchy, the defaults are:
46 · TPMA_NV_PPWRITE
48 · TPMA_NV_PPREAD If a policy file is specified, the hiearchy chosen
50 default attributes are bitwise or'd with:
51 · TPMA_NV_POLICYWRITE
53 · TPMA_NV_POLICYREAD If a policy file is NOT specified, the hiearchy
55 chosen default attributes are bitwise or'd with:
56 · TPMA_NV_AUTHWRITE
58 · TPMA_NV_AUTHREAD
60 · -P, --hierarchy-auth=AUTH:
62 Specifies the authorization value for the hierarchy. Authorization
64 values should follow the "authorization formatting standards", see
65 section "Authorization Formatting".
66 · -p, --index-auth=AUTH:
68 Specifies the password of NV Index when created. HMAC and Password
70 authorization values should follow the "authorization formatting
71 standards", see section "Authorization Formatting".
72 · -L, --policy=FILE:
74 Specifies the policy digest file for policy based authorizations.
76 · ARGUMENT the command line argument specifies the NV index or offset
78 number.
79 References
82 The type of a context object, whether it is a handle or file name, is
83 determined according to the following logic in-order:
84 · If the argument is a file path, then the file is loaded as a restored
86 TPM transient object.
87 · If the argument is a prefix match on one of:
89 · owner: the owner hierarchy
91 · platform: the platform hierarchy
93 · endorsement: the endorsement hierarchy
95 · lockout: the lockout control persistent object
97 · If the argument argument can be loaded as a number it will be treat
99 as a handle, e.g. 0x81010013 and used directly.OBJECT.
100
102 Authorization for use of an object in TPM2.0 can come in 3 different
103 forms: 1. Password 2. HMAC 3. Sessions
104 NOTE: "Authorizations default to the EMPTY PASSWORD when not speci‐
106 fied".
107 Passwords
109 Passwords are interpreted in the following forms below using prefix
110 identifiers.
111 Note: By default passwords are assumed to be in the string form when
113 they do not have a prefix.
114 String
116 A string password, specified by prefix "str:" or it's absence (raw
117 string without prefix) is not interpreted, and is directly used for au‐
118 thorization.
119 Examples
121 foobar
122 str:foobar
123 Hex-string
125 A hex-string password, specified by prefix "hex:" is converted from a
126 hexidecimal form into a byte array form, thus allowing passwords with
127 non-printable and/or terminal un-friendly characters.
128 Example
130 hex:0x1122334455667788
131 File
133 A file based password, specified be prefix "file:" should be the path
134 of a file containing the password to be read by the tool or a "-" to
135 use stdin. Storing passwords in files prevents information leakage,
136 passwords passed as options can be read from the process list or common
137 shell history features.
138 Examples
140 # to use stdin and be prompted
141 file:-
142 # to use a file from a path
144 file:path/to/password/file
145 # to echo a password via stdin:
147 echo foobar | tpm2_tool -p file:-
148 # to use a bash here-string via stdin:
150 tpm2_tool -p file:- <<< foobar
152 Sessions
154 When using a policy session to authorize the use of an object, prefix
155 the option argument with the session keyword. Then indicate a path to
156 a session file that was created with tpm2_startauthsession(1). Option‐
157 ally, if the session requires an auth value to be sent with the session
158 handle (eg policy password), then append a + and a string as described
159 in the Passwords section.
160 Examples
162 To use a session context file called session.ctx.
163 session:session.ctx
165 To use a session context file called session.ctx AND send the authvalue
167 mypassword.
168 session:session.ctx+mypassword
170 To use a session context file called session.ctx AND send the HEX auth‐
172 value 0x11223344.
173 session:session.ctx+hex:11223344
175 PCR Authorizations
177 You can satisfy a PCR policy using the "pcr:" prefix and the PCR mini‐
178 language. The PCR minilanguage is as follows:
179 <pcr-spec>=<raw-pcr-file>
180 The PCR spec is documented in in the section "PCR bank specifiers".
182 The raw-pcr-file is an optional the output of the raw PCR contents as
184 returned by tpm2_pcrread(1).
185 PCR bank specifiers (common/pcr.md)
187 Examples
189 To satisfy a PCR policy of sha256 on banks 0, 1, 2 and 3 use a specifi‐
190 er of:
191 pcr:sha256:0,1,2,3
193 specifying AUTH.
195
197 Object Attributes are used to control various properties of created ob‐
198 jects. When specified as an option, either the raw bitfield mask or
199 "nice-names" may be used. The values can be found in Table 31 Part 2
200 of the TPM2.0 specification, which can be found here:
201 <https://trustedcomputinggroup.org/wp-content/uploads/TPM-
203 Rev-2.0-Part-2-Structures-01.38.pdf>
204 Nice names are calculated by taking the name field of table 31 and re‐
206 moving the prefix TPMA_OBJECT_ and lowercasing the result. Thus, TP‐
207 MA_OBJECT_FIXEDTPM becomes fixedtpm. Nice names can be joined using
208 the bitwise or "|" symbol.
209 For instance, to set The fields TPMA_OBJECT_FIXEDTPM, TPMA_OBJECT_NODA,
211 and TPMA_OBJECT_SIGN_ENCRYPT, the argument would be:
212 fixedtpm|noda|sign specifying the nv attributes ATTRIBUTES.
214
216 This collection of options are common to many programs and provide in‐
217 formation that many users may expect.
218 · -h, --help=[man|no-man]: Display the tools manpage. By default, it
220 attempts to invoke the manpager for the tool, however, on failure
221 will output a short tool summary. This is the same behavior if the
222 "man" option argument is specified, however if explicit "man" is re‐
223 quested, the tool will provide errors from man on stderr. If the
224 "no-man" option if specified, or the manpager fails, the short op‐
225 tions will be output to stdout.
226 To successfully use the manpages feature requires the manpages to be
228 installed or on MANPATH, See man(1) for more details.
229 · -v, --version: Display version information for this tool, supported
231 tctis and exit.
232 · -V, --verbose: Increase the information that the tool prints to the
234 console during its execution. When using this option the file and
235 line number are printed.
236 · -Q, --quiet: Silence normal tool output to stdout.
238 · -Z, --enable-errata: Enable the application of errata fixups. Useful
240 if an errata fixup needs to be applied to commands sent to the TPM.
241 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
242 formation many users may expect.
243
245 The TCTI or "Transmission Interface" is the communication mechanism
246 with the TPM. TCTIs can be changed for communication with TPMs across
247 different mediums.
248 To control the TCTI, the tools respect:
250 1. The command line option -T or --tcti
252 2. The environment variable: TPM2TOOLS_TCTI.
254 Note: The command line option always overrides the environment vari‐
256 able.
257 The current known TCTIs are:
259 · tabrmd - The resource manager, called tabrmd
261 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
262 abrmd as a tcti name are synonymous.
263 · mssim - Typically used for communicating to the TPM software simula‐
265 tor.
266 · device - Used when talking directly to a TPM device file.
268 · none - Do not initalize a connection with the TPM. Some tools allow
270 for off-tpm options and thus support not using a TCTI. Tools that do
271 not support it will error when attempted to be used without a TCTI
272 connection. Does not support ANY options and MUST BE presented as
273 the exact text of "none".
274 The arguments to either the command line option or the environment
276 variable are in the form:
277 <tcti-name>:<tcti-option-config>
279 Specifying an empty string for either the <tcti-name> or <tcti-op‐
281 tion-config> results in the default being used for that portion respec‐
282 tively.
283 TCTI Defaults
285 When a TCTI is not specified, the default TCTI is searched for using
286 dlopen(3) semantics. The tools will search for tabrmd, device and
287 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
288 what TCTI will be chosen as the default by using the -v option to print
289 the version information. The "default-tcti" key-value pair will indi‐
290 cate which of the aforementioned TCTIs is the default.
291 Custom TCTIs
293 Any TCTI that implements the dynamic TCTI interface can be loaded. The
294 tools internally use dlopen(3), and the raw tcti-name value is used for
295 the lookup. Thus, this could be a path to the shared library, or a li‐
296 brary name as understood by dlopen(3) semantics.
297
299 This collection of options are used to configure the various known TCTI
300 modules available:
301 · device: For the device TCTI, the TPM character device file for use by
303 the device TCTI can be specified. The default is /dev/tpm0.
304 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI="de‐
306 vice:/dev/tpm0"
307 · mssim: For the mssim TCTI, the domain name or IP address and port
309 number used by the simulator can be specified. The default are
310 127.0.0.1 and 2321.
311 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
313 TI="mssim:host=localhost,port=2321"
314 · abrmd: For the abrmd TCTI, the configuration string format is a se‐
316 ries of simple key value pairs separated by a ',' character. Each
317 key and value string are separated by a '=' character.
318 · TCTI abrmd supports two keys:
320 1. 'bus_name' : The name of the tabrmd service on the bus (a
322 string).
323 2. 'bus_type' : The type of the dbus instance (a string) limited to
325 'session' and 'system'.
326 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
328 ample.FooBar:
329 \--tcti=tabrmd:bus_name=com.example.FooBar
331 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
333 sion:
334 \--tcti:bus_type=session
336 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
338 ules.
339
341 tpm2_nvdefine 0x1500016 -C 0x40000001 -s 32 -a 0x2000A
342 tpm2_nvdefine 0x1500016 -C 0x40000001 -s 32 \
344 -a ownerread|ownerwrite|policywrite -p 1a1b1c
345
347 Tools can return any of the following codes:
348 · 0 - Success.
350 · 1 - General non-specific error.
352 · 2 - Options handling error.
354 · 3 - Authentication error.
356 · 4 - TCTI related error.
358 · 5 - Non supported scheme. Applicable to tpm2_testparams.
360
362 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
363
365 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
366tpm2-tools tpm2_nvdefine(1)