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".
15
17 · -C, --hierarchy=OBJECT:
18 Specifies the handle used to authorize. Defaults to o, TPM_RH_OWNER,
19 when no value has been specified. Supported options are:
20 · o for TPM_RH_OWNER
22 · p for TPM_RH_PLATFORM
24 · <num> where a hierarchy handle or nv-index may be used.
26 · -s, --size=NATURAL_NUMBER:
28 Specifies the size of data area in bytes. Defaults to MAX_NV_IN‐
30 DEX_SIZE which is typically 2048.
31 · -a, --attributes=ATTRIBUTES
33 Specifies the attribute values for the nv region used when creating
35 the entity. Either the raw bitfield mask or "nice-names" may be
36 used. See section "NV Attributes" for more details.
37 · -P, --hierarchy-auth=AUTH:
39 Specifies the authorization value for the hierarchy. Authorization
41 values should follow the "authorization formatting standards", see
42 section "Authorization Formatting".
43 · -p, --index-auth=AUTH:
45 Specifies the password of NV Index when created. HMAC and Password
47 authorization values should follow the "authorization formatting
48 standards", see section "Authorization Formatting".
49 · -L, --policy=FILE:
51 Specifies the policy digest file for policy based authorizations.
53 · ARGUMENT the command line argument specifies the NV index or offset
55 number.
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 Object Attributes are used to control various properties of created ob‐
175 jects. When specified as an option, either the raw bitfield mask or
176 "nice-names" may be used. The values can be found in Table 31 Part 2
177 of the TPM2.0 specification, which can be found here:
178 <https://trustedcomputinggroup.org/wp-content/uploads/TPM-
180 Rev-2.0-Part-2-Structures-01.38.pdf>
181 Nice names are calculated by taking the name field of table 31 and re‐
183 moving the prefix TPMA_OBJECT_ and lowercasing the result. Thus, TP‐
184 MA_OBJECT_FIXEDTPM becomes fixedtpm. Nice names can be joined using
185 the bitwise or "|" symbol.
186 For instance, to set The fields TPMA_OBJECT_FIXEDTPM, TPMA_OBJECT_NODA,
188 and TPMA_OBJECT_SIGN_ENCRYPT, the argument would be:
189 fixedtpm|noda|sign specifying the object attributes ATTRIBUTES.
191
193 This collection of options are common to many programs and provide in‐
194 formation that many users may expect.
195 · -h, --help=[man|no-man]: Display the tools manpage. By default, it
197 attempts to invoke the manpager for the tool, however, on failure
198 will output a short tool summary. This is the same behavior if the
199 "man" option argument is specified, however if explicit "man" is re‐
200 quested, the tool will provide errors from man on stderr. If the
201 "no-man" option if specified, or the manpager fails, the short op‐
202 tions will be output to stdout.
203 To successfully use the manpages feature requires the manpages to be
205 installed or on MANPATH, See man(1) for more details.
206 · -v, --version: Display version information for this tool, supported
208 tctis and exit.
209 · -V, --verbose: Increase the information that the tool prints to the
211 console during its execution. When using this option the file and
212 line number are printed.
213 · -Q, --quiet: Silence normal tool output to stdout.
215 · -Z, --enable-errata: Enable the application of errata fixups. Useful
217 if an errata fixup needs to be applied to commands sent to the TPM.
218 Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent. in‐
219 formation many users may expect.
220
222 The TCTI or "Transmission Interface" is the communication mechanism
223 with the TPM. TCTIs can be changed for communication with TPMs across
224 different mediums.
225 To control the TCTI, the tools respect:
227 1. The command line option -T or --tcti
229 2. The environment variable: TPM2TOOLS_TCTI.
231 Note: The command line option always overrides the environment vari‐
233 able.
234 The current known TCTIs are:
236 · tabrmd - The resource manager, called tabrmd
238 (https://github.com/tpm2-software/tpm2-abrmd). Note that tabrmd and
239 abrmd as a tcti name are synonymous.
240 · mssim - Typically used for communicating to the TPM software simula‐
242 tor.
243 · device - Used when talking directly to a TPM device file.
245 · none - Do not initalize a connection with the TPM. Some tools allow
247 for off-tpm options and thus support not using a TCTI. Tools that do
248 not support it will error when attempted to be used without a TCTI
249 connection. Does not support ANY options and MUST BE presented as
250 the exact text of "none".
251 The arguments to either the command line option or the environment
253 variable are in the form:
254 <tcti-name>:<tcti-option-config>
256 Specifying an empty string for either the <tcti-name> or <tcti-op‐
258 tion-config> results in the default being used for that portion respec‐
259 tively.
260 TCTI Defaults
262 When a TCTI is not specified, the default TCTI is searched for using
263 dlopen(3) semantics. The tools will search for tabrmd, device and
264 mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query
265 what TCTI will be chosen as the default by using the -v option to print
266 the version information. The "default-tcti" key-value pair will indi‐
267 cate which of the aforementioned TCTIs is the default.
268 Custom TCTIs
270 Any TCTI that implements the dynamic TCTI interface can be loaded. The
271 tools internally use dlopen(3), and the raw tcti-name value is used for
272 the lookup. Thus, this could be a path to the shared library, or a li‐
273 brary name as understood by dlopen(3) semantics.
274
276 This collection of options are used to configure the various known TCTI
277 modules available:
278 · device: For the device TCTI, the TPM character device file for use by
280 the device TCTI can be specified. The default is /dev/tpm0.
281 Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI="de‐
283 vice:/dev/tpm0"
284 · mssim: For the mssim TCTI, the domain name or IP address and port
286 number used by the simulator can be specified. The default are
287 127.0.0.1 and 2321.
288 Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TC‐
290 TI="mssim:host=localhost,port=2321"
291 · abrmd: For the abrmd TCTI, the configuration string format is a se‐
293 ries of simple key value pairs separated by a ',' character. Each
294 key and value string are separated by a '=' character.
295 · TCTI abrmd supports two keys:
297 1. 'bus_name' : The name of the tabrmd service on the bus (a
299 string).
300 2. 'bus_type' : The type of the dbus instance (a string) limited to
302 'session' and 'system'.
303 Specify the tabrmd tcti name and a config string of bus_name=com.ex‐
305 ample.FooBar:
306 \--tcti=tabrmd:bus_name=com.example.FooBar
308 Specify the default (abrmd) tcti and a config string of bus_type=ses‐
310 sion:
311 \--tcti:bus_type=session
313 NOTE: abrmd and tabrmd are synonymous. the various known TCTI mod‐
315 ules.
316
318 tpm2_nvdefine 0x1500016 -C 0x40000001 -s 32 -a 0x2000A
319 tpm2_nvdefine 0x1500016 -C 0x40000001 -s 32 \
321 -a ownerread|ownerwrite|policywrite -p 1a1b1c
322
324 Tools can return any of the following codes:
325 · 0 - Success.
327 · 1 - General non-specific error.
329 · 2 - Options handling error.
331 · 3 - Authentication error.
333 · 4 - TCTI related error.
335 · 5 - Non supported scheme. Applicable to tpm2_testparams.
337
339 Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
340
342 See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
343tpm2-tools tpm2_nvdefine(1)