.\" Automatically generated by Pandoc 2.0.6
.\"
.TH "tpm2_nvlist" "1" "SEPTEMBER 2017" "tpm2\-tools" "General Commands Manual"
.hy
.SH NAME
.PP
\f[B]tpm2_nvlist\f[](1) \- display all defined Non\-Volatile (NV)s
indices.
.SS SYNOPSIS
.PP
\f[B]tpm2_nvlist\f[] [\f[I]OPTIONS\f[]]
.SS DESCRIPTION
.PP
\f[B]tpm2_nvlist\f[](1) \- display all defined Non\-Volatile (NV)s
indices to stdout in a YAML format.
.PP
Display metadata for all defined NV indices.
Metadata includes:
.IP \[bu] 2
The size of the defined region.
.IP \[bu] 2
The hash algorithm used to compute the name of the index.
.IP \[bu] 2
The auth policy.
.IP \[bu] 2
The NV attributes as defined in section \[lq]NV Attributes\[rq].
.PP
Example Output:
.IP
.nf
\f[C]
0x1500015:
\ \ hash\ algorithm:
\ \ \ \ friendly:\ sha256
\ \ \ \ value:\ 0xB
\ \ attributes:
\ \ \ \ friendly:\ ownerwrite|ownerread
\ \ \ \ value:\ 0x2000200
\ \ size:\ 32
\ \ authorization\ policy:

0x1500017:
\ \ hash\ algorithm:
\ \ \ \ friendly:\ sha256
\ \ \ \ value:\ 0xB
\ \ attributes:
\ \ \ \ friendly:\ ownerwrite|ownerread
\ \ \ \ value:\ 0x2000200
\ \ size:\ 32
\ \ authorization\ policy:
\f[]
.fi
.SH OPTIONS
.PP
This tool takes no tool specific options.
.SH COMMON OPTIONS
.PP
This collection of options are common to many programs and provide
information that many users may expect.
.IP \[bu] 2
\f[B]\-h\f[], \f[B]\[en]help\f[]: Display the tools manpage.
This requires the manpages to be installed or on \f[I]MANPATH\f[], See
man(1) for more details.
.IP \[bu] 2
\f[B]\-v\f[], \f[B]\[en]version\f[]: Display version information for
this tool, supported tctis and exit.
.IP \[bu] 2
\f[B]\-V\f[], \f[B]\[en]verbose\f[]: Increase the information that the
tool prints to the console during its execution.
When using this option the file and line number are printed.
.IP \[bu] 2
\f[B]\-Q\f[], \f[B]\[en]quiet\f[]: Silence normal tool output to stdout.
.IP \[bu] 2
\f[B]\-Z\f[], \f[B]\[en]enable\-errata\f[]: Enable the application of
errata fixups.
Useful if an errata fixup needs to be applied to commands sent to the
TPM.
# TCTI ENVIRONMENT
.PP
This collection of environment variables that may be used to configure
the various TCTI modules available.
.PP
The values passed through these variables can be overridden on a
per\-command basis using the available command line options, see the
\f[I]TCTI_OPTIONS\f[] section.
.PP
The variables respected depend on how the software was configured.
.IP \[bu] 2
\f[I]TPM2TOOLS_TCTI_NAME\f[]: Select the TCTI used for communication
with the next component down the TSS stack.
In most configurations this will be the TPM but it could be a simulator
or proxy.
The current known TCTIs are:
.RS 2
.IP \[bu] 2
tabrmd \- The new resource manager, called
tabrmd (https://github.com/01org/tpm2-abrmd).
.IP \[bu] 2
socket \- Typically used with the old resource manager, or talking
directly to a simulator.
.IP \[bu] 2
device \- Used when talking directly to a TPM device file.
.RE
.IP \[bu] 2
\f[I]TPM2TOOLS_DEVICE_FILE\f[]: When using the device TCTI, specify the
TPM device file.
The default is \[lq]/dev/tpm0\[rq].
.RS 2
.PP
Note: Using the tpm directly requires the users to ensure that
concurrent access does not occur and that they manage the tpm resources.
These tasks are usually managed by a resource manager.
Linux 4.12 and greater supports an in kernel resource manager at
\[lq]/dev/tpmrm\f[B]\f[]\[rq], typically \[lq]/dev/tpmrm0\[rq].
.RE
.IP \[bu] 2
\f[I]TPM2TOOLS_SOCKET_ADDRESS\f[]: When using the socket TCTI, specify
the domain name or IP address used.
The default is 127.0.0.1.
.IP \[bu] 2
\f[I]TPM2TOOLS_SOCKET_PORT\f[]: When using the socket TCTI, specify the
port number used.
The default is 2321.
.SH TCTI OPTIONS
.PP
This collection of options are used to configure the varous TCTI modules
available.
They override any environment variables.
.IP \[bu] 2
\f[B]\-T\f[],
\f[B]\[en]tcti\f[]=\f[I]TCTI_NAME\f[]\f[B][\f[]:\f[I]TCTI_OPTIONS\f[]\f[B]]\f[]:
Select the TCTI used for communication with the next component down the
TSS stack.
In most configurations this will be the resource manager:
tabrmd (https://github.com/01org/tpm2-abrmd) Optionally, tcti specific
options can appended to \f[I]TCTI_NAME\f[] by appending a \f[B]:\f[] to
\f[I]TCTI_NAME\f[].
.RS 2
.IP \[bu] 2
For the device TCTI, the TPM device file for use by the device TCTI can
be specified.
The default is /dev/tpm0.
Example: \f[B]\-T device:/dev/tpm0\f[]
.IP \[bu] 2
For the socket TCTI, the domain name or IP address and port number used
by the socket can be specified.
The default are 127.0.0.1 and 2321.
Example: \f[B]\-T socket:127.0.0.1:2321\f[]
.IP \[bu] 2
For the abrmd TCTI, it takes no options.
Example: \f[B]\-T abrmd\f[]
.RE
.SH NV Attributes
.PP
NV Attributes are used to control various properties of the NV defined
space.
When specified as an option, either the raw bitfield mask or
\[lq]nice\-names\[rq] may be used.
The values can be found in Table 204 Part 2 of the TPM2.0 specification,
which can be found here:
.PP
<https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-2-Structures-01.38.pdf>
.PP
Nice names are calculated by taking the name field of table 204 and
removing the prefix \f[B]TPMA_NV_\f[] and lowercasing the result.
Thus, \f[B]TPMA_NV_PPWRITE\f[] becomes ppwrite.
Nice names can be joined using the bitwise or \[lq]|\[rq] symbol.
.PP
Note that the \f[B]TPM_NT\f[] field is 4 bits wide, and thus can be set
via \f[B]nt=\f[] format.
For instance, to set The fields \f[B]TPMA_NV_OWNERREAD\f[],
\f[B]TPMA_NV_OWNERWRITE\f[], \f[B]TPMA_NV_POLICYWRITE\f[], and
\f[B]TPMA_NT = 0x3\f[], the argument would be:
.PP
\f[B]ownerread|ownerwrite|policywrite|nt=0x3\f[] # EXAMPLES
.PP
To list the defined NV indeces to stdout:
.IP
.nf
\f[C]
tpm2_nvlist
\f[]
.fi
.SH RETURNS
.PP
0 on success or 1 on failure.
.SH BUGS
.PP
Github Issues (https://github.com/01org/tpm2-tools/issues)
.SH HELP
.PP
See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)