1tpm2_nvrelease(1)           General Commands Manual          tpm2_nvrelease(1)
2
3
4

NAME

6       tpm2_nvrelease(1) - Release a Non-Volatile (NV) index.
7

SYNOPSIS

9       tpm2_nvrelease [OPTIONS]
10

DESCRIPTION

12       tpm2_nvrelease(1)  -  Release a Non-Volatile (NV) index that was previ‐
13       ously defined with tpm2_nvdefine(1).
14

OPTIONS

16       · -x, –index=NV_INDEX: Specifies the index to release.
17
18       · -a, –auth-handle=SECRET_DATA_FILE: specifies the handle used  to  au‐
19         thorize:
20
21         · 0x40000001 for TPM_RH_OWNER
22
23         · 0x4000000C for TPM_RH_PLATFORM
24
25       · -s, –size=SIZE: specifies the size of data area in bytes.
26
27       · -P,  –handle-passwd=HANDLE_PASSWORD:  specifies the password of auth‐
28         Handle.  Passwords should follow the “password formatting  standards,
29         see section”Password Formatting“.
30
31       · -S,  –input-session-handle=SIZE: Optional Input session handle from a
32         policy session for authorization.
33

COMMON OPTIONS

35       This collection of options are common to many programs and provide  in‐
36       formation that many users may expect.
37
38       · -h,  –help: Display the tools manpage.  This requires the manpages to
39         be installed or on MANPATH, See man(1) for more details.
40
41       · -v, –version: Display version information for  this  tool,  supported
42         tctis and exit.
43
44       · -V,  –verbose:  Increase  the information that the tool prints to the
45         console during its execution.  When using this option  the  file  and
46         line number are printed.
47
48       · -Q, –quiet: Silence normal tool output to stdout.
49
50       · -Z,  –enable-errata: Enable the application of errata fixups.  Useful
51         if an errata fixup needs to be applied to commands sent to  the  TPM.
52         # TCTI ENVIRONMENT
53
54       This  collection of environment variables that may be used to configure
55       the various TCTI modules available.
56
57       The values passed through  these  variables  can  be  overridden  on  a
58       per-command basis using the available command line options, see the TC‐
59       TI_OPTIONS section.
60
61       The variables respected depend on how the software was configured.
62
63       · TPM2TOOLS_TCTI_NAME: Select the TCTI used for communication with  the
64         next  component down the TSS stack.  In most configurations this will
65         be the TPM but it could be a simulator or proxy.  The  current  known
66         TCTIs are:
67
68         · tabrmd    -    The    new    resource    manager,   called   tabrmd
69           (https://github.com/01org/tpm2-abrmd).
70
71         · socket - Typically used with the old resource manager,  or  talking
72           directly to a simulator.
73
74         · device - Used when talking directly to a TPM device file.
75
76       · TPM2TOOLS_DEVICE_FILE:  When  using  the device TCTI, specify the TPM
77         device file.  The default is “/dev/tpm0”.
78
79         Note: Using the tpm directly requires the users to ensure  that  con‐
80         current access does not occur and that they manage the tpm resources.
81         These tasks are usually managed by a resource  manager.   Linux  4.12
82         and  greater  supports an in kernel resource manager at “/dev/tpmrm”,
83         typically “/dev/tpmrm0”.
84
85       · TPM2TOOLS_SOCKET_ADDRESS: When using the socket TCTI, specify the do‐
86         main name or IP address used.  The default is 127.0.0.1.
87
88       · TPM2TOOLS_SOCKET_PORT:  When  using the socket TCTI, specify the port
89         number used.  The default is 2321.
90

TCTI OPTIONS

92       This collection of options are used to configure the varous  TCTI  mod‐
93       ules available.  They override any environment variables.
94
95       · -T, –tcti=TCTI_NAME[:TCTI_OPTIONS]: Select the TCTI used for communi‐
96         cation with the next component down the TSS stack.  In most  configu‐
97         rations    this    will    be    the    resource    manager:   tabrmd
98         (https://github.com/01org/tpm2-abrmd) Optionally, tcti  specific  op‐
99         tions can appended to TCTI_NAME by appending a : to TCTI_NAME.
100
101         · For the device TCTI, the TPM device file for use by the device TCTI
102           can be specified.  The  default  is  /dev/tpm0.   Example:  -T  de‐
103           vice:/dev/tpm0
104
105         · For  the socket TCTI, the domain name or IP address and port number
106           used by the socket can be specified.  The default are 127.0.0.1 and
107           2321.  Example: -T socket:127.0.0.1:2321
108
109         · For the abrmd TCTI, it takes no options.  Example: -T abrmd
110

Password Formatting

112       Passwords  are  interpreted  in  two  forms,  string and hex-string.  A
113       string password is not interpreted, and is directly used for authoriza‐
114       tion.   A  hex-string, is converted from a hexidecimal form into a byte
115       array form, thus allowing passwords with non-printable and/or  terminal
116       un-friendly characters.
117
118       By  default  passwords  are assumed to be in the string form.  Password
119       form is specified with special prefix values, they are:
120
121       · str: - Used to indicate it is a raw string.  Useful  for  escaping  a
122         password that starts with the “hex:” prefix.
123
124       · hex: - Used when specifying a password in hex string format.
125

EXAMPLES

127              tpm2_nvrelease -x 0x1500016 -a 0x40000001 -P passwd
128

RETURNS

130       0 on success or 1 on failure.
131

BUGS

133       Github Issues (https://github.com/01org/tpm2-tools/issues)
134

HELP

136       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
137
138
139
140tpm2-tools                      SEPTEMBER 2017               tpm2_nvrelease(1)