1tpm2_gettestresult(1)       General Commands Manual      tpm2_gettestresult(1)
2
3
4

NAME

6       tpm2_gettestresult(1) - Get the result of tests performed by the TPM
7

SYNOPSIS

9       tpm2_gettestresult [OPTIONS]
10

DESCRIPTION

12       tpm2_gettestresult(1)  will return the result of the tests conducted by
13       the TPM.
14
15       Error code will state if the test executed successfully or have failed.
16
17       If pending algorithms are scheduled to  be  tested,  tpm2_gettestresult
18       will  return  “TESTING”.   Otherwise “FAILED” will be returned or “SUC‐
19       CESS” depending on the result to the test.
20
21       Manufacturer-dependent information will also be printed in raw hex for‐
22       mat.
23

OPTIONS

25       This tool accepts no tool specific options.
26

COMMON OPTIONS

28       This  collection of options are common to many programs and provide in‐
29       formation that many users may expect.
30
31-h, --help=[man|no-man]: Display the tools manpage.  By  default,  it
32         attempts  to  invoke  the  manpager for the tool, however, on failure
33         will output a short tool summary.  This is the same behavior  if  the
34         “man”  option argument is specified, however if explicit “man” is re‐
35         quested, the tool will provide errors from man  on  stderr.   If  the
36         “no-man”  option  if  specified, or the manpager fails, the short op‐
37         tions will be output to stdout.
38
39         To successfully use the manpages feature requires the manpages to  be
40         installed or on MANPATH, See man(1) for more details.
41
42-v,  --version:  Display version information for this tool, supported
43         tctis and exit.
44
45-V, --verbose: Increase the information that the tool prints  to  the
46         console  during  its  execution.  When using this option the file and
47         line number are printed.
48
49-Q, --quiet: Silence normal tool output to stdout.
50
51-Z, --enable-errata: Enable the application of errata fixups.  Useful
52         if  an  errata fixup needs to be applied to commands sent to the TPM.
53         Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.
54

TCTI Configuration

56       The TCTI or “Transmission Interface”  is  the  communication  mechanism
57       with  the TPM.  TCTIs can be changed for communication with TPMs across
58       different mediums.
59
60       To control the TCTI, the tools respect:
61
62       1. The command line option -T or --tcti
63
64       2. The environment variable: TPM2TOOLS_TCTI.
65
66       Note: The command line option always overrides  the  environment  vari‐
67       able.
68
69       The current known TCTIs are:
70
71       • tabrmd      -     The     resource     manager,     called     tabrmd
72         (https://github.com/tpm2-software/tpm2-abrmd).  Note that tabrmd  and
73         abrmd as a tcti name are synonymous.
74
75       • mssim  - Typically used for communicating to the TPM software simula‐
76         tor.
77
78       • device - Used when talking directly to a TPM device file.
79
80       • none - Do not initalize a connection with the TPM.  Some tools  allow
81         for off-tpm options and thus support not using a TCTI.  Tools that do
82         not support it will error when attempted to be used  without  a  TCTI
83         connection.   Does  not  support ANY options and MUST BE presented as
84         the exact text of “none”.
85
86       The arguments to either the command  line  option  or  the  environment
87       variable are in the form:
88
89       <tcti-name>:<tcti-option-config>
90
91       Specifying  an  empty  string  for  either the <tcti-name> or <tcti-op‐
92       tion-config> results in the default being used for that portion respec‐
93       tively.
94
95   TCTI Defaults
96       When  a  TCTI  is not specified, the default TCTI is searched for using
97       dlopen(3) semantics.  The tools will  search  for  tabrmd,  device  and
98       mssim  TCTIs  IN THAT ORDER and USE THE FIRST ONE FOUND.  You can query
99       what TCTI will be chosen as the default by using the -v option to print
100       the  version information.  The “default-tcti” key-value pair will indi‐
101       cate which of the aforementioned TCTIs is the default.
102
103   Custom TCTIs
104       Any TCTI that implements the dynamic TCTI interface can be loaded.  The
105       tools internally use dlopen(3), and the raw tcti-name value is used for
106       the lookup.  Thus, this could be a path to the shared library, or a li‐
107       brary name as understood by dlopen(3) semantics.
108

TCTI OPTIONS

110       This collection of options are used to configure the various known TCTI
111       modules available:
112
113device: For the device TCTI, the TPM character device file for use by
114         the device TCTI can be specified.  The default is /dev/tpm0.
115
116         Example:    -T   device:/dev/tpm0   or   export   TPM2TOOLS_TCTI=“de‐
117         vice:/dev/tpm0”
118
119mssim: For the mssim TCTI, the domain name or  IP  address  and  port
120         number  used  by  the  simulator  can  be specified.  The default are
121         127.0.0.1 and 2321.
122
123         Example: -T mssim:host=localhost,port=2321  or  export  TPM2TOOLS_TC‐
124         TI=“mssim:host=localhost,port=2321”
125
126abrmd:  For  the abrmd TCTI, the configuration string format is a se‐
127         ries of simple key value pairs separated by a  `,'  character.   Each
128         key and value string are separated by a `=' character.
129
130         • TCTI abrmd supports two keys:
131
132           1. `bus_name'  :  The  name  of  the  tabrmd  service on the bus (a
133              string).
134
135           2. `bus_type' : The type of the dbus instance (a string) limited to
136              `session' and `system'.
137
138         Specify  the tabrmd tcti name and a config string of bus_name=com.ex‐
139         ample.FooBar:
140
141                \--tcti=tabrmd:bus_name=com.example.FooBar
142
143         Specify the default (abrmd) tcti and a config string of bus_type=ses‐
144         sion:
145
146                \--tcti:bus_type=session
147
148         NOTE: abrmd and tabrmd are synonymous.
149

EXAMPLES

151   Get the result of the TPM testing
152              tpm2_gettestresult
153

NOTES

155       This  command is the one of the few commands authorized to be submitted
156       to TPM when in failure mode.
157

Returns

159       Tools can return any of the following codes:
160
161       • 0 - Success.
162
163       • 1 - General non-specific error.
164
165       • 2 - Options handling error.
166
167       • 3 - Authentication error.
168
169       • 4 - TCTI related error.
170
171       • 5 - Non supported scheme.  Applicable to tpm2_testparams.
172

BUGS

174       Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
175

HELP

177       See the Mailing List (https://lists.linuxfoundation.org/mailman/listin
178       fo/tpm2)
179
180
181
182tpm2-tools                                               tpm2_gettestresult(1)
Impressum