This repository hosts source code implementing the Trusted Computing Group's (TCG) TPM2 Software Stack (TSS) This stack consists of the following layers from top to bottom:
Instructions to build and install TPM2.0-TSS are available in the INSTALL file.
This repository contains a test suite intended to exercise the TCTI and SAPI code. This test suite is not intended to test a TPM implementation and so this test suite should only be run against a TPM simulator. If this test suite is executed against a TPM other than the software simulator it may cause damage to the TPM (NV storage wear out etc). You have been warned.
The TPM library specification contains reference code sufficient to construct a software TPM 2.0 simulator. This code was provided by Microsoft and they provide a binary download for Windows here. IBM has repackaged this code with a few Makefiles so that the Microsoft code can be built and run on Linux systems. The Linux version of the Microsoft TPM 2.0 simulator can be obtained here. Once you've downloaded and successfully built and execute the simulator it will, by default, be accepting connections on the localhost, port 2321.
Issues building or running the simulator should be reported to the IBM software TPM2 project.
NOTE: The Intel TCG TSS is currently tested against the 532 version of the simulator. Compatibility with later versions has not yet been tested.
The test suite is implemented in the tpmclient program. This is a monolithic C program that exercises various TCTI and SAPI API calls. Once the test environment is set up (simulator is built and running), the tpmclient program can be executed:
$ test/tpmclient/tpmclient
The tpmclient
program will run either until completion, or until an error occurs. Please report failures in a Github ‘issue’ with a full log of the test run. This must include output from the tpmclient
program. This output must include full debug messages which requires that the libraries and binaries be built with debug flags enabled. See INSTALL for instructions to build with debug flags enabled.
We are currently working to decompose the existing monolithic tpmclient
program into individual test programs that can be integrated into an automated test harness. This approach has a number of advantages including the ability to run individual tests in isolation as well as reduced overhead, maintenance and automation.