commit | a003d76a998ca46b38fd834ae529abe0a09de992 | [log] [tgz] |
---|---|---|
author | Philip Tricca <philip.b.tricca@intel.com> | Tue Oct 17 13:25:42 2017 -0700 |
committer | Philip Tricca <philip.b.tricca@intel.com> | Mon Oct 23 00:01:52 2017 -0700 |
tree | f0d1513f5245e37746c28ffa8e47386a060f7d51 | |
parent | 473aebeb67de5dedfdf8e51aed28a4776bc785a5 [diff] |
tcti: Reformat code. This commit attempts to align the souce code in the TCTI modules with the coding standard we're currently moving toward. Additionally this commit flattens out the code by doing does away with the pattern where nearly the whole body of a function is wrapped in a conditional checking the result of the common check function. This caused a pile of unnecessary indentation and generally made the code difficult to read. Additionally we take this opportunity to 1) replace the old pattern that put a space after the opening parenthesis in a function call or control flow statement 2) standardizes on placing the open and closing curly braces for a scope change on the same line as the conditional 3) breaks long lines up on 80 characters 4) removes 'goto' usage where a simple 'return' suffices 5) rename internal functions in the tcti module to use snake_case instead of camelCase 6) Remove C++ comments, use c comments. Signed-off-by: Philip Tricca <philip.b.tricca@intel.com>
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-tss are available in the INSTALL file.
If you‘re looking to discuss the source code in this project or get some questions answered you should join the 01org TPM2 mailing list: https://lists.01.org/mailman/listinfo/tpm2. We’ve also got an IRC channel set up on FreeNode called #tpm2.0-tss.
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.
SAPI library, TAB/RM, and Test Code Block Diagram:
├── common : utility functions used by multiple components
├── doc : various bits of documentation
├── include : header files unstalled in $(includedir)
│ ├── sapi : header files for TPM2 types and core libraries
│ └── tcti : header files for TCTI libraries
├── lib : data files used by the build or installed into $(libdir)
├── log : logging functions
├── m4 : autoconf support macros
├── man : man pages
├── marshal : TPM2 typer marshalling library implementation
├── script : scripts used by the build or CI
├── sysapi : system API implementation
│ ├── include : headers internal to the SAPI
│ ├── sysapi : system API implementation
│ └── sysapi_util : utility functions used by system API implementation
├── tcti : TCTI implementation
└── test : test code
├── integration : integration test harness and test cases
├── tpmclient : monolithic, legacy test application
└── unit : unit tests