--- name: "tpm2_pcrlist" section: "1" platform: "linux" package: "tpm2-tools" version: "3.1.3-2" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/tpm2_pcrlist" --- # tpm2\_pcrlist(1) List PCR values. ## NAME [**tpm2\_pcrlist**(1)](/tpm2_pcrlist/1.md) - List PCR values. ## SYNOPSIS **tpm2\_pcrlist** \[*OPTIONS*\] ## DESCRIPTION [**tpm2\_pcrlist**(1)](/tpm2_pcrlist/1.md) 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)](/man/1.md) 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: - ``` :[,] ``` 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: \ ## 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)