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 · --cphash=FILE
78 File path to record the hash of the command parameters. This is com‐
80 monly termed as cpHash. NOTE: When this option is selected, The tool
81 will not actually execute the command, it simply returns a cpHash.
82 · ARGUMENT the command line argument specifies the NV index or offset
84 number.
85 References
88 The type of a context object, whether it is a handle or file name, is
89 determined according to the following logic in-order:
90 · If the argument is a file path, then the file is loaded as a restored
92 TPM transient object.
93 · If the argument is a prefix match on one of:
95 · owner: the owner hierarchy
97 · platform: the platform hierarchy
99 · endorsement: the endorsement hierarchy
101 · lockout: the lockout control persistent object
103 · If the argument argument can be loaded as a number it will be treat
105 as a handle, e.g. 0x81010013 and used directly.OBJECT.
106
108 Authorization for use of an object in TPM2.0 can come in 3 different
109 forms: 1. Password 2. HMAC 3. Sessions
110 NOTE: "Authorizations default to the EMPTY PASSWORD when not speci‐
112 fied".
113 Passwords
115 Passwords are interpreted in the following forms below using prefix
116 identifiers.
117 Note: By default passwords are assumed to be in the string form when
119 they do not have a prefix.
120 String
122 A string password, specified by prefix "str:" or it's absence (raw
123 string without prefix) is not interpreted, and is directly used for au‐
124 thorization.
125 Examples
127 foobar
128 str:foobar
129 Hex-string
131 A hex-string password, specified by prefix "hex:" is converted from a
132 hexidecimal form into a byte array form, thus allowing passwords with
133 non-printable and/or terminal un-friendly characters.
134 Example
136 hex:0x1122334455667788
137 File
139 A file based password, specified be prefix "file:" should be the path
140 of a file containing the password to be read by the tool or a "-" to
141 use stdin. Storing passwords in files prevents information leakage,
142 passwords passed as options can be read from the process list or common
143 shell history features.
144 Examples
146 # to use stdin and be prompted
147 file:-
148 # to use a file from a path
150 file:path/to/password/file
151 # to echo a password via stdin:
153 echo foobar | tpm2_tool -p file:-
154 # to use a bash here-string via stdin:
156 tpm2_tool -p file:- <<< foobar
158 Sessions
160 When using a policy session to authorize the use of an object, prefix
161 the option argument with the session keyword. Then indicate a path to
162 a session file that was created with tpm2_startauthsession(1). Option‐
163 ally, if the session requires an auth value to be sent with the session
164 handle (eg policy password), then append a + and a string as described
165 in the Passwords section.
166 Examples
168 To use a session context file called session.ctx.
169 session:session.ctx
171 To use a session context file called session.ctx AND send the authvalue
173 mypassword.
174 session:session.ctx+mypassword
176 To use a session context file called session.ctx AND send the HEX auth‐
178 value 0x11223344.
179 session:session.ctx+hex:11223344
181 PCR Authorizations
183 You can satisfy a PCR policy using the "pcr:" prefix and the PCR mini‐
184 language. The PCR minilanguage is as follows:
185 <pcr-spec>=<raw-pcr-file>
186 The PCR spec is documented in in the section "PCR bank specifiers".
188 The raw-pcr-file is an optional the output of the raw PCR contents as
190 returned by tpm2_pcrread(1).
191 PCR bank specifiers (common/pcr.md)
193 Examples
195 To satisfy a PCR policy of sha256 on banks 0, 1, 2 and 3 use a specifi‐
196 er of:
197 pcr:sha256:0,1,2,3
199 specifying AUTH.
201
203 Object Attributes are used to control various properties of created ob‐
204 jects. When specified as an option, either the raw bitfield mask or
205 "nice-names" may be used. The values can be found in Table 31 Part 2
206 of the TPM2.0 specification, which can be found here:
207 <https://trustedcomputinggroup.org/wp-content/uploads/TPM-
209 Rev-2.0-Part-2-Structures-01.38.pdf>
210 Nice names are calculated by taking the name field of table 31 and re‐
212 moving the prefix TPMA_OBJECT_ and lowercasing the result. Thus, TP‐
213 MA_OBJECT_FIXEDTPM becomes fixedtpm. Nice names can be joined using
214 the bitwise or "|" symbol.
215 For instance, to set The fields TPMA_OBJECT_FIXEDTPM, TPMA_OBJECT_NODA,
217 and TPMA_OBJECT_SIGN_ENCRYPT, the argument would be:
218 fixedtpm|noda|sign specifying the nv attributes ATTRIBUTES.
220
222 This collection of options are common to many programs and provide in‐
223 formation that many users may expect.
224 · -h, --help=[man|no-man]: Display the tools manpage. By default, it
226 attempts to invoke the manpager for the tool, however, on failure
227 will output a short tool summary. This is the same behavior if the
228 "man" option argument is specified, however if explicit "man" is re‐
229 quested, the tool will provide errors from man on stderr. If the
230 "no-man" option if specified, or the manpager fails, the short op‐
231 tions will be output to stdout.
232 To successfully use the manpages feature requires the manpages to be
234 installed or on MANPATH, See man(1) for more details.
235 · -v, --version: Display version information for this tool, supported
237 tctis and exit.
238 · -V, --verbose: Increase the information that the tool prints to the
240 console during its execution. When using this option the file and
241 line number are printed.
242 · -Q, --quiet: Silence normal tool output to stdout.
244 · -Z, --enable-errata: Enable the application of errata fixups. Useful
246 if an errata fixup needs to be applied to commands sent to the TPM.
247 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
248 formation many users may expect.
249
251 The TCTI or "Transmission Interface" is the communication mechanism
252 with the TPM. TCTIs can be changed for communication with TPMs across
253 different mediums.
254 To control the TCTI, the tools respect:
256 1. The command line option -T or --tcti
258 2. The environment variable: TPM2TOOLS_TCTI.
260 Note: The command line option always overrides the environment vari‐
262 able.
263 The current known TCTIs are:
265 · tabrmd - The resource manager, called tabrmd
267 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
268 abrmd as a tcti name are synonymous.
269 · mssim - Typically used for communicating to the TPM software simula‐
271 tor.
272 · device - Used when talking directly to a TPM device file.
274 · none - Do not initalize a connection with the TPM. Some tools allow
276 for off-tpm options and thus support not using a TCTI. Tools that do
277 not support it will error when attempted to be used without a TCTI
278 connection. Does not support ANY options and MUST BE presented as
279 the exact text of "none".
280 The arguments to either the command line option or the environment
282 variable are in the form:
283 <tcti-name>:<tcti-option-config>
285 Specifying an empty string for either the <tcti-name> or <tcti-op‐
287 tion-config> results in the default being used for that portion respec‐
288 tively.
289 TCTI Defaults
291 When a TCTI is not specified, the default TCTI is searched for using
292 dlopen(3) semantics. The tools will search for tabrmd, device and
293 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
294 what TCTI will be chosen as the default by using the -v option to print
295 the version information. The "default-tcti" key-value pair will indi‐
296 cate which of the aforementioned TCTIs is the default.
297 Custom TCTIs
299 Any TCTI that implements the dynamic TCTI interface can be loaded. The
300 tools internally use dlopen(3), and the raw tcti-name value is used for
301 the lookup. Thus, this could be a path to the shared library, or a li‐
302 brary name as understood by dlopen(3) semantics.
303
305 This collection of options are used to configure the various known TCTI
306 modules available:
307 · device: For the device TCTI, the TPM character device file for use by
309 the device TCTI can be specified. The default is /dev/tpm0.
310 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI="de‐
312 vice:/dev/tpm0"
313 · mssim: For the mssim TCTI, the domain name or IP address and port
315 number used by the simulator can be specified. The default are
316 127.0.0.1 and 2321.
317 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
319 TI="mssim:host=localhost,port=2321"
320 · abrmd: For the abrmd TCTI, the configuration string format is a se‐
322 ries of simple key value pairs separated by a ',' character. Each
323 key and value string are separated by a '=' character.
324 · TCTI abrmd supports two keys:
326 1. 'bus_name' : The name of the tabrmd service on the bus (a
328 string).
329 2. 'bus_type' : The type of the dbus instance (a string) limited to
331 'session' and 'system'.
332 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
334 ample.FooBar:
335 \--tcti=tabrmd:bus_name=com.example.FooBar
337 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
339 sion:
340 \--tcti:bus_type=session
342 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
344 ules.
345
347 tpm2_nvdefine 0x1500016 -C 0x40000001 -s 32 -a 0x2000A
348 tpm2_nvdefine 0x1500016 -C 0x40000001 -s 32 \
350 -a ownerread|ownerwrite|policywrite -p 1a1b1c
351
353 Tools can return any of the following codes:
354 · 0 - Success.
356 · 1 - General non-specific error.
358 · 2 - Options handling error.
360 · 3 - Authentication error.
362 · 4 - TCTI related error.
364 · 5 - Non supported scheme. Applicable to tpm2_testparams.
366
368 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
369
371 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
372tpm2-tools tpm2_nvdefine(1)