commit | ad7f78b9dee896c28aa51e0096a73d83affdd0db | [log] [tgz] |
---|---|---|
author | David J. Maria <davidjmaria@fb.com> | Thu Aug 09 09:52:50 2018 -0700 |
committer | Tadeusz Struk <tadeusz.struk@intel.com> | Fri Aug 10 14:13:38 2018 -0700 |
tree | c7345d4e4e05ec45435e6e7bf2933bc9898d9d47 | |
parent | 4f437009056d7e4ecf6609ad2cd3e70861063c04 [diff] |
[RFC] ESYS: Add esys_free helper function Add esys_free, a wrapper around free(), to ESYS when building on Windows. Having a wrapper around free is best practice when building libraries on Windows; this is because there is a high chance that the caller program will be built using a different version of the C runtime than the library, which means that the program and the library will have separate heaps. This is an issue because many of the ESYS functions allocate memory for the caller and expect the caller to free the memory, but in the case where the caller was built with a different version of the C runtime, the caller will not be able to free the memory because it does not have access to the esys heap. esys_free allows the caller program to have the library free any memory that the caller didn't allocate. Signed-off-by: David Maria <davidjmaria@fb.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 01.org TPM2 mailing list: https://lists.01.org/mailman/listinfo/tpm2. We also have an IRC channel set up on FreeNode called #tpm2.0-tss.
This repository contains a test suite intended to exercise the TCTI, SAPI and ESAPI code. This test suite is not intended to test a TPM implementation, 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, TCP ports 2321 and 2322.
Issues building or running the simulator should be reported to the IBM software TPM2 project.
NOTE: The Intel TCG TSS is currently tested against version 974 of the simulator. Compatibility with later versions has not yet been tested.
To test the various TCTI, SAPI and ESAPI api calls, unit and integration tests can be run by configuring the build to enable unit testing and running the "check" build target. It is recommended to use a simulator for testing, and the simulator will be automatically launched by the tests. Please review the dependency list in INSTALL for dependencies when building the test suite.
$ ./configure --enable-unit --enable-integration $ make -j$(nproc) check
This will generate a file called "test-suite.log" in the root of the build directory.
Please report failures in a Github 'issue' with a full log of the test run.
NOTE: The unit and integration tests can be enabled independently. The --enable-unit option controls unit tests, and --enable-integration controls the integration tests.
SAPI library, TAB/RM, and Test Code Block Diagram:
├── doc : various bits of documentation
├── include : header files installed in $(includedir)
│ └── tss2 : all public headers for this project
├── lib : data files used by the build or installed into $(libdir)
├── m4 : autoconf support macros
├── man : man pages
├── script : scripts used by the build or CI
├── src : all source files
│ ├── tss2-esys : enhanced system API (ESAPI) implementation
│ │ └── api : ESAPI TPM API implementation
│ ├── tss2-mu : TPM2 type marshaling/unmarshaling (MU) API implementation
│ ├── tss2-sys : system API (SAPI) implementation
│ │ └── api : SAPI public API implementation
│ ├── tss2-tcti : TCTI implementations for device and mssim
│ └── util : Internal utility library (e.g. logging framework)
└── test : test code
├── integration : integration test harness and test cases
├── tpmclient : monolithic, legacy test application
└── unit : unit tests