csu3_am335x/EVSE/GPL/tpm2-tools-5.1/man/man1/tpm2_getekcertificate.1

.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "tpm2_getekcertificate" "1" "" "tpm2\-tools" "General Commands Manual"
.hy
.SH NAME
.PP
\f[B]tpm2_getekcertificate\f[](1) \- Retrieve the Endorsement key
Certificate.
.SH SYNOPSIS
.PP
\f[B]tpm2_getekcertificate\f[] [\f[I]OPTIONS\f[]] [\f[I]ARGUMENT\f[]]
.SH DESCRIPTION
.PP
\f[B]tpm2_getekcertificate\f[](1) \- Retrieve the endorsement key
certificate.
The certificate is present either on the TCG specified TPM NV indices OR
on the TPM manufacturer\[aq]s endorsement certificate hosting server.
Following are the conditions dictating the certificate location lookup.
.IP "1." 3
NV\-Index:
.RS 4
.PP
Default search location when \f[B]ARGUMENT\f[] is not specified.
.RE
.IP "2." 3
Intel\-EK\-certificate\-server:
.RS 4
.PP
Search location when EK certificate could not be found in the NV index
AND tpmEPSgenerated bit is CLEAR AND manufacturer is INTC.
.RE
.IP "3." 3
Intel\-EK\-Re\-certification\-server:
.RS 4
.PP
Search location when EK certificate could not be found in the NV index
AND tpmEPSgenerated bit is SET AND manufacturer is INTC.
.PP
Note:
.PP
In this operation information is provided regarding additional software
to be run as part of the re\-provisioning/ re\-certification service.
.PP
After re\-provisioning/ recertification process is complete, EK
certificates can be read from the NV indexes by running another instance
of \f[B]tpm2_getekcertificate\f[].
.RE
.IP "4." 3
Generic or other EK\-certificate\-server:
.RS 4
.PP
Search location when \f[B]ARGUMENT\f[] specifies the EK certificate web
hosting address.
.RE
.SH OPTIONS
.IP \[bu] 2
\f[B]\-o\f[], \f[B]\-\-ek\-certificate\f[]=\f[I]FILE\f[] or
\f[I]STDOUT\f[]:
.RS 2
.PP
The file to save the Endorsement key certificate.
When EK certificates are found in the TPM NV indices, this option can be
specified additional times to save the RSA and ECC EK certificates in
order.
The tool will warn if additional EK certificates are found on the TPM NV
indices and only a single output file is specified.
If the option isn\[aq]t specified all the EK certificates retrieved
either from the manufacturer web hosting or from the TPM NV indices, are
output to stdout.
.RE
.IP \[bu] 2
\f[B]\-X\f[], \f[B]\-\-allow\-unverified\f[]:
.RS 2
.PP
Specifies to attempt connecting with the TPM manufacturer provisioning
server without verifying server certificate.
This option is irrelevant when EK certificates are found on the TPM NV
indices.
.PP
\f[B]WARNING\f[]: This option should be used only on platforms with
older CA certificates.
.RE
.IP \[bu] 2
\f[B]\-u\f[], \f[B]\-\-ek\-public\f[]=\f[I]FILE\f[]:
.RS 2
.PP
Specifies the file path for the endorsement key public portion in tss
format.
.RE
.IP \[bu] 2
\f[B]\-x\f[], \f[B]\-\-offline\f[]:
.RS 2
.PP
This flags the tool to operate in an offline mode.
In that the certificates can be retrieved for supplied EK public that do
not belong to the platform the tool is run on.
Useful in factory provisioning of multiple platforms that are not
individually connected to the Internet.
In such a scenario a single Internet facing provisioning server can
utilize this tool in this mode.
This forces the tool to not look for the EK certificates on the NV
indices.
.RE
.IP \[bu] 2
\f[B]\-\-raw\f[]:
.RS 2
.PP
This flags the tool to output the EK certificate as is received from the
source: NV/ Web\-Hosting.
.RE
.IP \[bu] 2
\f[B]ARGUMENT\f[] the command line argument specifies the URL address
for the EK certificate portal.
This forces the tool to not look for the EK certificates on the NV
indices.
.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[], \f[B]\-\-help=[man|no\-man]\f[]: 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 "man" option argument is specified,
however if explicit "man" is requested, the tool will provide errors
from man on stderr.
If the "no\-man" 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[], See man(1) for more details.
.RE
.IP \[bu] 2
\f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
tool, supported tctis and exit.
.IP \[bu] 2
\f[B]\-V\f[], \f[B]\-\-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]\-\-quiet\f[]: Silence normal tool output to stdout.
.IP \[bu] 2
\f[B]\-Z\f[], \f[B]\-\-enable\-errata\f[]: 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 "Transmission Interface" 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[] or \f[B]\-\-tcti\f[]
.IP "2." 3
The environment variable: \f[I]TPM2TOOLS_TCTI\f[].
.PP
\f[B]Note:\f[] 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[] options and \f[I]MUST BE\f[] presented as
the exact text of "none".
.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[]
.PP
Specifying an empty string for either the \f[C]<tcti\-name>\f[] or
\f[C]<tcti\-option\-config>\f[] 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[] semantics.
The tools will search for \f[I]tabrmd\f[], \f[I]device\f[] and
\f[I]mssim\f[] TCTIs \f[B]IN THAT ORDER\f[] and \f[B]USE THE FIRST ONE
FOUND\f[].
You can query what TCTI will be chosen as the default by using the
\f[B]\-v\f[] option to print the version information.
The "default\-tcti" 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[], and the raw
\f[I]tcti\-name\f[] 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[] 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[]: 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[].
.RS 2
.PP
Example: \f[B]\-T device:/dev/tpm0\f[] or \f[B]export
\f[I]TPM2TOOLS_TCTI\f[]="device:/dev/tpm0"\f[]
.RE
.IP \[bu] 2
\f[B]mssim\f[]: 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[] or \f[B]export
\f[I]TPM2TOOLS_TCTI\f[]="mssim:host=localhost,port=2321"\f[]
.RE
.IP \[bu] 2
\f[B]abrmd\f[]: For the abrmd TCTI, the configuration string format is a
series of simple key value pairs separated by a \[aq],\[aq] character.
Each key and value string are separated by a \[aq]=\[aq] character.
.RS 2
.IP \[bu] 2
TCTI abrmd supports two keys:
.RS 2
.IP "1." 3
\[aq]bus_name\[aq] : The name of the tabrmd service on the bus (a
string).
.IP "2." 3
\[aq]bus_type\[aq] : The type of the dbus instance (a string) limited to
\[aq]session\[aq] and \[aq]system\[aq].
.RE
.PP
Specify the tabrmd tcti name and a config string of
\f[C]bus_name=com.example.FooBar\f[]:
.PP
\f[C]\\\-\-tcti=tabrmd:bus_name=com.example.FooBar\f[]
.PP
Specify the default (abrmd) tcti and a config string of
\f[C]bus_type=session\f[]:
.PP
\f[C]\\\-\-tcti:bus_type=session\f[]
.PP
\f[B]NOTE\f[]: abrmd and tabrmd are synonymous.
the various known TCTI modules.
.RE
.SH NOTES
.PP
When the verbose option is specified, additional curl debugging
information is provided by setting the curl mode verbose, see
<https://curl.haxx.se/libcurl/c/CURLOPT_VERBOSE.html> for more
information.
.SH EXAMPLES
.SS Retrieve EK certificate from TPM manufacturer backend by supplying
EK public.
.IP
.nf
\f[C]
tpm2_createek\ \-G\ rsa\ \-u\ ek.pub\ \-c\ key.ctx

tpm2_getekcertificate\ \-X\ \-o\ ECcert.bin\ \-u\ ek.pub\ \\
https://tpm.manufacturer.com/ekcertserver/
\f[]
.fi
.SS Retrieve EK certificate from Intel backend if certificate not found
on NV.
.IP
.nf
\f[C]
tpm2_createek\ \-G\ rsa\ \-u\ ek.pub\ \-c\ key.ctx

tpm2_getekcertificate\ \-X\ \-o\ ECcert.bin\ \-u\ ek.pub
\f[]
.fi
.SS Retrieve EK certificate from Intel backend for an offline platform.
.IP
.nf
\f[C]
tpm2_getekcertificate\ \-X\ \-x\ \-o\ ECcert.bin\ \-u\ ek.pub
\f[]
.fi
.SS Retrieve EK certificate from TPM NV indices only, fail otherwise.
.IP
.nf
\f[C]
tpm2_getekcertificate\ \-o\ ECcert.bin
\f[]
.fi
.SS Retrieve multiple EK certificates from TPM NV indices only, fail
otherwise.
.IP
.nf
\f[C]
tpm2_getekcertificate\ \-o\ RSA_EK_cert.bin\ \-o\ ECC_EK_cert.bin
\f[]
.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.01.org/mailman/listinfo/tpm2)