Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 4.56 KB

README.md

File metadata and controls

67 lines (39 loc) · 4.56 KB
Raw

Official TPM 2.0 Reference Implementation (by Microsoft)

Build Status

This is the official TCG reference implementation of the TPM 2.0 Specification. The project contains complete source code of the reference implementation with a Microsoft Visual Studio solution and Linux autotools build scripts.

See the definition of the SPEC_VERSION, SPEC_YEAR and SPEC_DAY_OF_YEAR values in the TpmTypes.h header for the exact revision/date of the TPM 2.0 specification, which the given source tree snapshot corresponds to.

The reference implementation can be directly used via the TPM 2.0 simulator that emulates a TPM 2.0 device and can be accessed via a custom TCP based protocol. The simplest way to work with the simulator is to use a TSS library for the programming language of your choice - C#/.Net, C++, Java, Python, JavaScript/Node.js are currently supported. The C language TSS implementing the TCG's TSS API specifiaction is available here.

Windows build

Windows build is implemented as a Visual Studio 2017 solution. Before building it:

  • Setup one or both of the following underlying cryptographic libraries:

    OpenSSL library

    1. Create TPMCmd/lib folder and place a static OpenSSL library (libcrypto.lib) built for the x86 architecture there. For the x64 architecture use the TPMCmd/lib/x64 folder.

      The static libs can be either static libraries proper, or import libraries accompanying the corresponding DLLs. In the latter case you'll need to ensure that ther is a matching copy of the OpenSSL DLL in the standard Windows search path, so that it is available when you run the simulator executable (e.g. copy it into the same folder where simulator.exe is located).

      Recommended version of OpenSSL is 1.1.1d or higher.

    2. Create TPMCmd/OsslInclude/openssl folder and copy there the contents of the openssl/include/openssl folder in the OpenSSL source tree used to build the OpenSSL library.

      If you enable SM{2,3,4} algorithms in TpmProfile.h, the build may fail because of missing SM{2,3,4}.h headers. In this case you will need to manually copy them over from OpenSSL's include/crypt folder.

    3. Build the solution with either Debug or Release as the active configuration.

    Wolfcrypt library (wolfSSL)

    1. WolfSSL is included as a submodule. Initialize and update the submodule to fetch the project and checkout the appropriate commit.

      git submodule init git submodule update

      The current commit will point the minimum recommended version of wolfSSL. Moving to a more recent tag or commit should also be supported but might not be tested.

    2. Build the solution with either WolfDebug or WolfRelease as the active configuration, either from inside the Visual Studio or with the following command line:

      msbuild TPMCmd\simulator.sln /p:Configuration=WolfDebug

  • If necessary, update the definitions of the following macros in the VendorString.h header: MANUFACTURER, VENDOR_STRING_1, FIRMWARE_V1 and FIRMWARE_V2

Linux build

Follows the common ./bootstrap && ./configure && make convention.

Note that autotools scripts require the following prerequisite packages: autoconf-archive, pkg-config, and sometimes build-essential and automake. Their absence is not automatically detected. The build also needs gcc and libssl-dev packages.

Similarly to the Windows build, if you enable SM{2,3,4} algorithms in TpmProfile.h, the build may fail because of missing SM{2,3,4}.h headers. In this case you will need to manually copy them over from OpenSSL's include/crypt folder.

Mac OS X build

As with the Linux build, use ./bootstrap, ./configure, and make. If you used Homebrew to install OpenSSL, you may need to include its path in PKG_CONFIG_PATH. OS X compilers treat uninitialized global variables as common symbols, which can be eliminated with the -fno-common compiler option. Future updates to the autotools configurations may automate one or both of these steps.

./bootstrap
PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig" EXTRA_CFLAGS=-fno-common ./configure
make