tpm2_pcrlist
Section: General Commands Manual (1)
Updated: AUGUST 2017
Page Index
NAME
tpm2_pcrlist(1) - List PCR values.
SYNOPSIS
tpm2_pcrlist [OPTIONS]
DESCRIPTION
tpm2_pcrlist(1) Displays PCR values.
Without any options, tpm2_pcrlist outputs all pcrs and their
hash banks.
One can use either the -g or -L mutually exclusive
options to filter the output.
Output is writtien in a YAML format to stdout, with each algorithm
followed by a PCR index and its value.
As a simple example assume just sha1 and sha256 support and only 1 PCR.
The output would be:
-
sha1 :
0 : 0000000000000000000000000000000000000003
sha256 :
0 : 0000000000000000000000000000000000000000000000000000000000000003
OPTIONS
- •
-
-g, -algorithm=HASH_ALGORITHM: Only
output PCR banks with the given algorithm.
Algorithms should follow the "formatting standards, see
section"Algorithm Specifiers". Also, see section"Supported
Hash Algorithms" for a list of supported hash algorithms.
- •
-
-o, -output=FILE: The output file to
write the PCR values in binary format, optional.
- •
-
-L, -sel-list=PCR_SELECTION_LIST:
-
The list of pcr banks and selected PCRs' ids for each bank to display.
PCR_SELECTION_LIST values should follow the pcr bank specifiers
standards, see section "PCR Bank Specfiers".
- •
-
-s, -algs: Output the list of supported
algorithms.
COMMON OPTIONS
This collection of options are common to many programs and provide
information that many users may expect.
- •
-
-h, -help: Display the tools manpage.
This requires the manpages to be installed or on MANPATH, See
man(1) for more details.
- •
-
-v, -version: Display version information for
this tool, supported tctis and exit.
- •
-
-V, -verbose: Increase the information that the
tool prints to the console during its execution.
When using this option the file and line number are printed.
- •
-
-Q, -quiet: Silence normal tool output to stdout.
- •
-
-Z, -enable-errata: Enable the application of
errata fixups.
Useful if an errata fixup needs to be applied to commands sent to the
TPM.
# TCTI ENVIRONMENT
This collection of environment variables that may be used to configure
the various TCTI modules available.
The values passed through these variables can be overridden on a
per-command basis using the available command line options, see the
TCTI_OPTIONS section.
The variables respected depend on how the software was configured.
- •
-
TPM2TOOLS_TCTI_NAME: 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:
-
- •
-
tabrmd - The new resource manager, called
tabrmd (https://github.com/01org/tpm2-abrmd).
- •
-
socket - Typically used with the old resource manager, or talking
directly to a simulator.
- •
-
device - Used when talking directly to a TPM device file.
- •
-
TPM2TOOLS_DEVICE_FILE: When using the device TCTI, specify the
TPM device file.
The default is "/dev/tpm0".
-
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
"/dev/tpmrm", typically "/dev/tpmrm0".
- •
-
TPM2TOOLS_SOCKET_ADDRESS: When using the socket TCTI, specify
the domain name or IP address used.
The default is 127.0.0.1.
- •
-
TPM2TOOLS_SOCKET_PORT: When using the socket TCTI, specify the
port number used.
The default is 2321.
TCTI OPTIONS
This collection of options are used to configure the varous TCTI modules
available.
They override any environment variables.
- •
-
-T,
-tcti=TCTI_NAME[:TCTI_OPTIONS]:
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 TCTI_NAME by appending a : to
TCTI_NAME.
-
- •
-
For the device TCTI, the TPM device file for use by the device TCTI can
be specified.
The default is /dev/tpm0.
Example: -T device:/dev/tpm0
- •
-
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: -T socket:127.0.0.1:2321
- •
-
For the abrmd TCTI, it takes no options.
Example: -T abrmd
PCR Bank Specfiers
PCR Bank Selection lists follow the below specification:
-
<BANK>:<PCR>[,<PCR>]
multiple banks may be separated by `+'.
For example:
-
sha:3,4+sha256:5,6
will select PCRs 3 and 4 from the SHA bank and PCRs 5 and 6 from the
SHA256 bank.
Note
PCR Selections allow for up to 5 hash to pcr selection mappings.
This is a limitaion in design in the single call to the tpm to get the
pcr values.
Supported Hash Algorithms
Supported hash algorithms are:
- •
-
0x4 or sha1 for TPM_ALG_SHA1
(default)
- •
-
0xB or sha256 for TPM_ALG_SHA256
- •
-
0xC or sha384 for TPM_ALG_SHA384
- •
-
0xD or sha512 for TPM_ALG_SHA512
- •
-
0x12 or sm3_256 for TPM_ALG_SM3_256
NOTE: Your TPM may not support all algorithms.
Algorithm Specfiers
Options that take algorithms support "nice-names".
Nice names, like sha1 can be used in place of the raw hex for sha1: 0x4.
The nice names are converted by stripping the leading TPM_ALG_
from the Algorithm Name field and converting it to lower case.
For instance TPM_ALG_SHA3_256 becomes sha3_256.
The algorithms can be found at:
<https://trustedcomputinggroup.org/wp-content/uploads/TCG_Algorithm_Registry_Rev_1.24.pdf>
EXAMPLES
display all PCR values:
-
tpm2_pcrlist
Display the PCR values with a specified bank:
-
tpm2_pcrlist -g sha1
Display the PCR values with specified banks and store in a file:
-
tpm2_pcrlist -L sha1:16,17,18+sha256:16,17,18 -o pcrs
Display the supported PCR bank algorithms and exit:
-
tpm2_pcrlist -s
RETURNS
0 on success or 1 on failure.
BUGS
Github Issues (https://github.com/01org/tpm2-tools/issues)
HELP
See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)