tpm2_gettestresult(1)

💖 NAME 💖

Hi bestie! Welcome to the General Commands Manual page for tpm2_gettestresult(1) — this is the get the result of tests performed by the TPM tool. It's giving “test-result main character energy,” no cap. ✨

🌸 SYNOPSIS 🌸

tpm2_gettestresult [OPTIONS]

🦋 DESCRIPTION 🦋

tpm2_gettestresult(1) will return the result of the tests conducted by the TPM. Lowkey iconic, highkey useful. 🫶

The error code will state if the test executed successfully or failed.

If pending algorithms are scheduled to be tested, tpm2_gettestresult will return TESTING. Otherwise, FAILED will be returned, or SUCCESS, depending on the result to the test. Literally the vibes are in the return value. 💅

Manufacturer-dependent information will also be printed in raw hex format. 🧪

🎀 OPTIONS 🎀

This tool accepts no tool specific options. That's the tea. 🍵

💅 COMMON OPTIONS 💅

This collection of options are common to many programs and provide information that many users may expect. It's the shared bestie toolkit. 🧰

• -h, --help=[man|no-man] — display the tool's manpage. By default, it attempts to invoke the manpager for the tool; however, on failure it will output a short tool summary. This is the same behavior if the man option argument is specified, but if explicit man is requested, the tool will provide errors from man on stderr. If the no-man option is specified, or the manpager fails, the short options will be output to stdout.

To successfully use the manpages feature requires the manpages to be installed or on MANPATH; see man(1) for more details.

• -v, --version — display version information for this tool, supported tctis and exit. Slay, then bounce. ✌️
• -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. Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.
• -z, --pwd-session — use password session instead of a HMAC session for authentication. A clear text password is passed to the TPM to authorize the action. This option can be used to avoid problems when unsalted sessions are used in OpenSSL FIPS mode. If auth values are used a salted session should be used for authentication.
• -R, --autoflush — enable autoflush for transient objects created by the command. If a parent object is loaded from a context file also the transient parent object will be flushed. Autoflush can also be activated if the environment variable TPM2TOOLS_AUTOFLUSH is set to yes or true.

✨ TCTI Configuration ✨

The TCTI or “Transmission Interface” is the communication mechanism with the TPM. TCTIs can be changed for communication with TPMs across different mediums. It's giving “pick your connector, bestie.” 🔌

To control the TCTI, the tools respect:

1. The command line option -T or --tcti
2. The environment variable: TPM2TOOLS_TCTI

Note: The command line option always overrides the environment variable. Periodt.

The current known TCTIs are:

• tabrmd — the resource manager, called tabrmd. Note that tabrmd and abrmd as a tcti name are synonymous.
• mssim — typically used for communicating to the TPM software simulator.
• device — used when talking directly to a TPM device file.
• none — do not initialize 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 ANY options and MUST BE presented as the exact text of none.

The arguments to either the command line option or the environment variable are in the form:

<tcti-name>:<tcti-option-config>

Specifying an empty string for either the <tcti-name> or <tcti-option-config> results in the default being used for that portion respectively.

💜 TCTI Defaults 💜

When a TCTI is not specified, the default TCTI is searched for using dlopen(3) semantics. The tools will search for tabrmd, device and mssim TCTIs IN THAT ORDER and USE THE FIRST ONE FOUND. You can query what TCTI will be chosen as the default by using the -v option to print the version information. The default-tcti key-value pair will indicate which of the aforementioned TCTIs is the default.

🌈 Custom TCTIs 🌈

Any TCTI that implements the dynamic TCTI interface can be loaded. The tools internally use dlopen(3), and the raw tcti-name value is used for the lookup. Thus, this could be a path to the shared library, or a library name as understood by dlopen(3) semantics. Modularity ate. 🧚

🍓 TCTI OPTIONS 🍓

This collection of options are used to configure the various known TCTI modules available:

• device — for the device TCTI, the TPM character device file for use by the device TCTI can be specified. The default is /dev/tpm0.

Example: -T device:/dev/tpm0 or export TPM2TOOLS_TCTI=“device:/dev/tpm0”

• mssim — 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.

Example: -T mssim:host=localhost,port=2321 or export TPM2TOOLS_TCTI=“mssim:host=localhost,port=2321”

• abrmd — 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.
  • The TCTI abrmd supports two keys:
    1. bus_name — the name of the tabrmd service on the bus (a string).
    2. bus_type — the type of the dbus instance (a string) limited to session and system.

Specify the tabrmd tcti name and a config string of bus_name=com.example.FooBar:

\--tcti=tabrmd:bus_name=com.example.FooBar

Specify the default (abrmd) tcti and a config string of bus_type=session:

\--tcti:bus_type=session

NOTE: abrmd and tabrmd are synonymous.

🌟 EXAMPLES 🌟

🎀 Get the result of the TPM testing 🎀

This is the whole main character move:

tpm2_gettestresult

That's it. The command ate and left no crumbs. 💅

💀 NOTES 💀

This command is the one of the few commands authorized to be submitted to TPM when in failure mode. So yeah, it's a little special, iykyk. 👑

🔥 Returns 🔥

Tools can return any of the following codes:

• 0 — Success.
• 1 — General non-specific error.
• 2 — Options handling error.
• 3 — Authentication error.
• 4 — TCTI related error.
• 5 — Non supported scheme. Applicable to tpm2_testparams.

🐛 BUGS 🐛

Github Issues

🫶 HELP 🫶

See the Mailing List

📜 License 📜

This work is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

Final sign-off: source/version is tpm2-tools, page is tpm2_gettestresult(1), and the footer had no date to spill, so we're not inventing one. Periodt. 💅💖