.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "tss2_pcrread" "1" "APRIL 2019" "tpm2-tools" "General Commands Manual"
.hy
.SH NAME
.PP
\f[B]tss2_pcrread\f[R](1) -
.SH SYNOPSIS
.PP
\f[B]tss2_pcrread\f[R] [\f[I]OPTIONS\f[R]]
.SH SEE ALSO
.PP
\f[B]fapi-config(5)\f[R] to adjust Fapi parameters like the used
cryptographic profile and TCTI or directories for the Fapi metadata
storages.
.PP
\f[B]fapi-profile(5)\f[R] to determine the cryptographic algorithms and
parameters for all keys and operations of a specific TPM interaction
like the name hash algorithm, the asymmetric signature algorithm, scheme
and parameters and PCR bank selection.
.SH DESCRIPTION
.PP
\f[B]tss2_pcrread\f[R](1) - This command provides a PCRs value and
corresponding event log.
The PCR bank to be used per PCR is defined in the cryptographic profile
(cf., \f[B]fapi-profile(5)\f[R]).
.SH OPTIONS
.PP
These are the available options:
.IP \[bu] 2
\f[B]-o\f[R], \f[B]--pcrValue\f[R]=\f[I]FILENAME\f[R] or \f[I]-\f[R]
(for stdout):
.RS 2
.PP
Returns PCR digest.
Optional parameter.
.RE
.IP \[bu] 2
\f[B]-x\f[R], \f[B]--pcrIndex\f[R]=\f[I]INTEGER\f[R]:
.RS 2
.PP
Identifies the PCR to read.
.RE
.IP \[bu] 2
\f[B]-f\f[R], \f[B]--force\f[R]:
.RS 2
.PP
Force overwriting the output files.
.RE
.IP \[bu] 2
\f[B]-l\f[R], \f[B]--pcrLog\f[R]=\f[I]FILENAME\f[R] or \f[I]-\f[R] (for
stdout):
.RS 2
.PP
Returns the PCR log for that PCR.
Optional parameter.
.PP
PCR event logs are a list (arbitrary length JSON array) of log entries
with the following content.
.IP
.nf
\f[C]
- recnum: Unique record number
- pcr: PCR index
- digest: The digests
- type: The type of event. At the moment the only possible value is: \[dq]LINUX_IMA\[dq] (legacy IMA)
- eventDigest: Digest of the event; e.g. the digest of the measured file
- eventName: Name of the event; e.g. the name of the measured file.
\f[R]
.fi
.RE
.SH COMMON OPTIONS
.PP
This collection of options are common to all tss2 programs and provide
information that many users may expect.
.IP \[bu] 2
\f[B]-h\f[R], \f[B]--help [man|no-man]\f[R]: Display the tools manpage.
By default, it attempts to invoke the manpager for the tool, however, on
failure will output a short tool summary.
This is the same behavior if the \[lq]man\[rq] option argument is
specified, however if explicit \[lq]man\[rq] is requested, the tool will
provide errors from man on stderr.
If the \[lq]no-man\[rq] option if specified, or the manpager fails, the
short options will be output to stdout.
.RS 2
.PP
To successfully use the manpages feature requires the manpages to be
installed or on \f[I]MANPATH\f[R], See \f[B]man\f[R](1) for more
details.
.RE
.IP \[bu] 2
\f[B]-v\f[R], \f[B]--version\f[R]: Display version information for this
tool, supported tctis and exit.
.SH EXAMPLE
.IP
.nf
\f[C]
tss2_pcrread --pcrIndex=16 --pcrValue=pcrValue.file --pcrLog=pcrLog.file
\f[R]
.fi
.SH RETURNS
.PP
0 on success or 1 on failure.
.SH BUGS
.PP
Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
.SH HELP
.PP
See the Mailing
List (https://lists.linuxfoundation.org/mailman/listinfo/tpm2)