.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "tpm2" "1" "" "tpm2-tools" "General Commands Manual"
.hy
.SH NAME
.PP
\f[B]tpm2\f[R](1) - A single small executable that combines the various
tpm2-tools much like a BusyBox that provides a fairly complete
environment for any small or embedded system.
.SH SYNOPSIS
.PP
\f[B]tpm2\f[R] [\f[I]OPTIONS\f[R]] [\f[I]ARGUMENTS\f[R]]
.SH DESCRIPTION
.PP
\f[B]tpm2\f[R](1) - To ease installation of tpm2-tools in initrd or
embedded systems where size-optimization and limited resources are
important, it is convenient to have a single executable that can
dispatch the various TPM2 functionalities specified by the argument
which is one of the available tool names.
.PP
The options and arguments that follow are either the \f[B]common
options\f[R] or those specific to the \f[B]tool name\f[R].
.PP
It is important to note that individual tools with prefix
\f[B]tpm2_\f[R] can still be invoked, however, they are now soft-linked
to this \f[B]tpm2\f[R] executable.
And so unlike BusyBox, full functionality of the individual tools is
available in the executable.
For example: \f[B]tpm2_getrandom 8\f[R] can alternatively be specified
as \f[B]tpm2 getrandom 8\f[R].
.SH ARGUMENTS
.PP
List of possible tool names.
NOTE: Specify only one of these.
Look at examples.
.PP
\f[B]certifyX509certutil\f[R]
.PP
\f[B]checkquote\f[R]
.PP
\f[B]eventlog\f[R]
.PP
\f[B]print\f[R]
.PP
\f[B]rc_decode\f[R]
.PP
\f[B]activatecredential\f[R]
.PP
\f[B]certify\f[R]
.PP
\f[B]changeauth\f[R]
.PP
\f[B]changeeps\f[R]
.PP
\f[B]changepps\f[R]
.PP
\f[B]clear\f[R]
.PP
\f[B]clearcontrol\f[R]
.PP
\f[B]clockrateadjust\f[R]
.PP
\f[B]create\f[R]
.PP
\f[B]createak\f[R]
.PP
\f[B]createek\f[R]
.PP
\f[B]createpolicy\f[R]
.PP
\f[B]setprimarypolicy\f[R]
.PP
\f[B]createprimary\f[R]
.PP
\f[B]dictionarylockout\f[R]
.PP
\f[B]duplicate\f[R]
.PP
\f[B]getcap\f[R]
.PP
\f[B]gettestresult\f[R]
.PP
\f[B]encryptdecrypt\f[R]
.PP
\f[B]evictcontrol\f[R]
.PP
\f[B]flushcontext\f[R]
.PP
\f[B]getekcertificate\f[R]
.PP
\f[B]getrandom\f[R]
.PP
\f[B]gettime\f[R]
.PP
\f[B]hash\f[R]
.PP
\f[B]hierarchycontrol\f[R]
.PP
\f[B]hmac\f[R]
.PP
\f[B]import\f[R]
.PP
\f[B]incrementalselftest\f[R]
.PP
\f[B]load\f[R]
.PP
\f[B]loadexternal\f[R]
.PP
\f[B]makecredential\f[R]
.PP
\f[B]nvdefine\f[R]
.PP
\f[B]nvextend\f[R]
.PP
\f[B]nvincrement\f[R]
.PP
\f[B]nvreadpublic\f[R]
.PP
\f[B]nvread\f[R]
.PP
\f[B]nvreadlock\f[R]
.PP
\f[B]nvundefine\f[R]
.PP
\f[B]nvwrite\f[R]
.PP
\f[B]nvwritelock\f[R]
.PP
\f[B]nvsetbits\f[R]
.PP
\f[B]pcrallocate\f[R]
.PP
\f[B]pcrevent\f[R]
.PP
\f[B]pcrextend\f[R]
.PP
\f[B]pcrread\f[R]
.PP
\f[B]pcrreset\f[R]
.PP
\f[B]policypcr\f[R]
.PP
\f[B]policyauthorize\f[R]
.PP
\f[B]policyauthorizenv\f[R]
.PP
\f[B]policynv\f[R]
.PP
\f[B]policycountertimer\f[R]
.PP
\f[B]policyor\f[R]
.PP
\f[B]policynamehash\f[R]
.PP
\f[B]policytemplate\f[R]
.PP
\f[B]policycphash\f[R]
.PP
\f[B]policypassword\f[R]
.PP
\f[B]policysigned\f[R]
.PP
\f[B]policyticket\f[R]
.PP
\f[B]policyauthvalue\f[R]
.PP
\f[B]policysecret\f[R]
.PP
\f[B]policyrestart\f[R]
.PP
\f[B]policycommandcode\f[R]
.PP
\f[B]policynvwritten\f[R]
.PP
\f[B]policyduplicationselect\f[R]
.PP
\f[B]policylocality\f[R]
.PP
\f[B]quote\f[R]
.PP
\f[B]readclock\f[R]
.PP
\f[B]readpublic\f[R]
.PP
\f[B]rsadecrypt\f[R]
.PP
\f[B]rsaencrypt\f[R]
.PP
\f[B]send\f[R]
.PP
\f[B]selftest\f[R]
.PP
\f[B]sessionconfig\f[R]
.PP
\f[B]setclock\f[R]
.PP
\f[B]shutdown\f[R]
.PP
\f[B]sign\f[R]
.PP
\f[B]certifycreation\f[R]
.PP
\f[B]nvcertify\f[R]
.PP
\f[B]startauthsession\f[R]
.PP
\f[B]startup\f[R]
.PP
\f[B]stirrandom\f[R]
.PP
\f[B]testparms\f[R]
.PP
\f[B]unseal\f[R]
.PP
\f[B]verifysignature\f[R]
.PP
\f[B]setcommandauditstatus\f[R]
.PP
\f[B]getcommandauditdigest\f[R]
.PP
\f[B]getsessionauditdigest\f[R]
.PP
\f[B]geteccparameters\f[R]
.PP
\f[B]ecephemeral\f[R]
.PP
\f[B]commit\f[R]
.PP
\f[B]ecdhkeygen\f[R]
.PP
\f[B]ecdhzgen\f[R]
.PP
\f[B]zgen2phase\f[R]
.SS References
.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[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 man(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.
.IP \[bu] 2
\f[B]-V\f[R], \f[B]--verbose\f[R]: 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[R], \f[B]--quiet\f[R]: Silence normal tool output to stdout.
.IP \[bu] 2
\f[B]-Z\f[R], \f[B]--enable-errata\f[R]: Enable the application of
errata fixups.
Useful if an errata fixup needs to be applied to commands sent to the
TPM.
Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.
information many users may expect.
.SH TCTI Configuration
.PP
The TCTI or \[lq]Transmission Interface\[rq] is the communication
mechanism with the TPM.
TCTIs can be changed for communication with TPMs across different
mediums.
.PP
To control the TCTI, the tools respect:
.IP "1." 3
The command line option \f[B]-T\f[R] or \f[B]--tcti\f[R]
.IP "2." 3
The environment variable: \f[I]TPM2TOOLS_TCTI\f[R].
.PP
\f[B]Note:\f[R] The command line option always overrides the environment
variable.
.PP
The current known TCTIs are:
.IP \[bu] 2
tabrmd - The resource manager, called
tabrmd (https://github.com/tpm2-software/tpm2-abrmd).
Note that tabrmd and abrmd as a tcti name are synonymous.
.IP \[bu] 2
mssim - Typically used for communicating to the TPM software simulator.
.IP \[bu] 2
device - Used when talking directly to a TPM device file.
.IP \[bu] 2
none - Do not initalize a connection with the TPM.
Some tools allow for off-tpm options and thus support not using a TCTI.
Tools that do not support it will error when attempted to be used
without a TCTI connection.
Does not support \f[I]ANY\f[R] options and \f[I]MUST BE\f[R] presented
as the exact text of \[lq]none\[rq].
.PP
The arguments to either the command line option or the environment
variable are in the form:
.PP
\f[C]<tcti-name>:<tcti-option-config>\f[R]
.PP
Specifying an empty string for either the \f[C]<tcti-name>\f[R] or
\f[C]<tcti-option-config>\f[R] results in the default being used for
that portion respectively.
.SS TCTI Defaults
.PP
When a TCTI is not specified, the default TCTI is searched for using
\f[I]dlopen(3)\f[R] semantics.
The tools will search for \f[I]tabrmd\f[R], \f[I]device\f[R] and
\f[I]mssim\f[R] TCTIs \f[B]IN THAT ORDER\f[R] and \f[B]USE THE FIRST ONE
FOUND\f[R].
You can query what TCTI will be chosen as the default by using the
\f[B]-v\f[R] option to print the version information.
The \[lq]default-tcti\[rq] key-value pair will indicate which of the
aforementioned TCTIs is the default.
.SS Custom TCTIs
.PP
Any TCTI that implements the dynamic TCTI interface can be loaded.
The tools internally use \f[I]dlopen(3)\f[R], and the raw
\f[I]tcti-name\f[R] value is used for the lookup.
Thus, this could be a path to the shared library, or a library name as
understood by \f[I]dlopen(3)\f[R] semantics.
.SH TCTI OPTIONS
.PP
This collection of options are used to configure the various known TCTI
modules available:
.IP \[bu] 2
\f[B]device\f[R]: For the device TCTI, the TPM character device file for
use by the device TCTI can be specified.
The default is \f[I]/dev/tpm0\f[R].
.RS 2
.PP
Example: \f[B]-T device:/dev/tpm0\f[R] or \f[B]export
\f[BI]TPM2TOOLS_TCTI\f[B]=\[lq]device:/dev/tpm0\[rq]\f[R]
.RE
.IP \[bu] 2
\f[B]mssim\f[R]: For the mssim TCTI, the domain name or IP address and
port number used by the simulator can be specified.
The default are 127.0.0.1 and 2321.
.RS 2
.PP
Example: \f[B]-T mssim:host=localhost,port=2321\f[R] or \f[B]export
\f[BI]TPM2TOOLS_TCTI\f[B]=\[lq]mssim:host=localhost,port=2321\[rq]\f[R]
.RE
.IP \[bu] 2
\f[B]abrmd\f[R]: For the abrmd TCTI, the configuration string format is
a series of simple key value pairs separated by a `,' character.
Each key and value string are separated by a `=' character.
.RS 2
.IP \[bu] 2
TCTI abrmd supports two keys:
.RS 2
.IP "1." 3
`bus_name' : The name of the tabrmd service on the bus (a string).
.IP "2." 3
`bus_type' : The type of the dbus instance (a string) limited to
`session' and `system'.
.RE
.PP
Specify the tabrmd tcti name and a config string of
\f[C]bus_name=com.example.FooBar\f[R]:
.IP
.nf
\f[C]
\[rs]--tcti=tabrmd:bus_name=com.example.FooBar
\f[R]
.fi
.PP
Specify the default (abrmd) tcti and a config string of
\f[C]bus_type=session\f[R]:
.IP
.nf
\f[C]
\[rs]--tcti:bus_type=session
\f[R]
.fi
.PP
\f[B]NOTE\f[R]: abrmd and tabrmd are synonymous.
the various known TCTI modules.
.RE
.SH EXAMPLES
.SS Get 8 rand bytes from the TPM
.IP
.nf
\f[C]
tpm2 getrandom 8 | xxd -p
\f[R]
.fi
.SS Send a TPM Startup Command with flags TPM2_SU_CLEAR
.IP
.nf
\f[C]
tpm2 startup -c
\f[R]
.fi
.SH Returns
.PP
Tools can return any of the following codes:
.IP \[bu] 2
0 - Success.
.IP \[bu] 2
1 - General non-specific error.
.IP \[bu] 2
2 - Options handling error.
.IP \[bu] 2
3 - Authentication error.
.IP \[bu] 2
4 - TCTI related error.
.IP \[bu] 2
5 - Non supported scheme.
Applicable to tpm2_testparams.
.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)