Skip to content

Latest commit

 

History

History
228 lines (166 loc) · 9 KB

INSTALL.md

File metadata and controls

228 lines (166 loc) · 9 KB
Raw

Building tpm2-tools

Below you will find instructions to build and install the tpm2-tools project.

Download the Source

To obtain the tpm2-tools sources you must clone them as below:

git clone https://github.com/tpm2-software/tpm2-tools

Dependencies

To build and install the tpm2-tools software the following software is required:

  • GNU Autoconf
  • GNU Automake
  • GNU Libtool
  • pkg-config
  • C compiler
  • C Library Development Libraries and Header Files (for pthreads headers)
  • ESAPI - TPM2.0 TSS ESAPI library (tss2-esys) and header files
  • OpenSSL libcrypto library and header files
  • Curl library and header files

Optional Dependencies:

  • To build the man pages you need pandoc
  • To enable the new userspace resource manager, one must get tpm2-tabrmd (recommended).
  • For the tests: tpm2-abrmd (must be on $PATH) and tpm_server
  • Some tests pass only if xxd, bash and python with PyYAML are available

Typical Distro Dependency Installation

Here we are going to satisfy tpm2-tools dependencies with:

Which are necessary for the build example section at the bottom of this file, we need to satisfy the dependencies for each item named above except for the simulator.

Ubuntu 16.04

Satisfying the dependencies for tpm2-tools falls into two general steps, stuff you can easily get via the package manager, and stuff you cannot.

NOTE: The tpm2 Userspace Dependencies may not be the correct version in your distros package manager.

Packages:

The packages in the below command can be ascertained via the package manager.

sudo apt-get install autoconf autoconf-archive automake libtool pkg-config gcc \
    libssl-dev libcurl4-gnutls-dev

Notes:

  • One can substitute gcc for clang if they desire.
  • On pre-ubuntu 16.04 libcurl4-gnutls-dev was provided by libcurl-dev
    • The libcurl dependency can be satisfied in many ways, and likely change with Ubuntu versions:
      • libcurl4-openssl-dev 7.47.0-1ubuntu2.2
      • libcurl4-nss-dev 7.47.0-1ubuntu2.2
      • libcurl4-gnutls-dev 7.47.0-1ubuntu2.2

tpm2 Userspace Dependencies:

The following tpm2 userspace dependencies can be satisfied by getting the source, building and installing them. They can be located here:

Fedora

In case you want to build from source the next command block should cover all the dependencies for tpm2-tools, the enhanced system API (tpm2-tss) and the userspace resource manager (tpm2-abrmd).

$ sudo dnf -y update && sudo dnf -y install automake libtool \
autoconf autoconf-archive libstdc++-devel gcc pkg-config \
uriparser-devel libgcrypt-devel dbus-devel glib2-devel \
compat-openssl10-devel libcurl-devel PyYAML

Some distros have the dependencies already packaged, you can simply install the package that contains the needed build requirements.

$ sudo dnf builddep tpm2-tools

The package installed above contains all the dependencies for tpm2-tools included the projects mentioned at the beginning of this section (tpm2-tss and tpm2-abrmd)

For more detailed information about the dependencies of tpm2-tss and tmp2-abrmd, please consult the corresponding links for each project.

tpm2-tools TSS and ABRMD Dependency Version Chart

tpm2-tools version tpm2-tss version tpm2-abrmd version TSS API
master master master tss2-esys (ESAPI)
3.1.0 2.0.0 2.0.0 tss2-sys (SAPI)
2.1.0 1.2.0 1.1.1 tss2-sys (SAPI)
df751ae(master) 1.1.0 1.0.0 tss2-sys (SAPI)
v2.0.0 1.0 old resourcemgr tss2-sys (SAPI)
v1.1.0 1.0 old resourcemgr tss2-sys (SAPI)
v1.1-beta_1 1.0-beta_1 old resourcemgr tss2-sys (SAPI)
v1.1-beta_0 v1.0-beta_0 old resourcemgr tss2-sys (SAPI)
14a7ff5 210b770 old resourcemgr tss2-sys (SAPI)
4b4cbea d4f23cc old resourcemgr tss2-sys (SAPI)
e8150e4 60ec042 old resourcemgr tss2-sys (SAPI)
84d5f26 371fdbc old resourcemgr tss2-sys (SAPI)
v1.0.1 1.0-alpha_0 old resourcemgr tss2-sys (SAPI)

Building

To compile tpm2-tools execute the following commands from the root of the source directory:

$ ./bootstrap
$ ./configure
$ make

This is sufficient for running as long as you alter PATH so that it points to the tools directory, or just execute them via a full path.

For Example:

./tools/tpm2_getrandom 4

Building from source example

Now we can start building the projects, there are four major steps for building the projects from source:

Bootstrapping the build

With the bootstrap command we run a script which generates the list of source files along with the configure script.

In the project directory:

$  ./bootstrap

Configuring the build

Here we run the configure script, this generates the makefiles needed for the compilation.

$ ./configure

Depending of the project, you can add additional information to the configure script, please refer to the links provided below for more information about the custom options.

Compiling the Libraries

We use the make command for compile the code.

$ make -j$(nproc)

Installing the Libraries

Once we have finish building the projects it's time to install them.

$ sudo make install

Now putting all together:

  • Tpm2-tss
$ git clone https://github.com/tpm2-software/tpm2-tss.git
$ cd tpm2-tss
$ ./bootstrap
$ ./configure --prefix=/usr
$ make -j5
$ sudo make install
  • Tpm2-abrmd
$ git clone https://github.com/tpm2-software/tpm2-abrmd.git
$ cd tpm2-abrmd
$ ./bootstrap
$ ./configure --with-dbuspolicydir=/etc/dbus-1/system.d
--with-udevrulesdir=/usr/lib/udev/rules.d
--with-systemdsystemunitdir=/usr/lib/systemd/system
--libdir=/usr/lib64 --prefix=/usr
$ make -j5
$ sudo make install
  • Tpm2-tools
$ git clone https://github.com/tpm2-software/tpm2-tools.git
$ cd tpm2-tools
$ ./bootstrap
$ ./configure --prefix=/usr
$ make -j5
$ sudo make install
  • TPM simulator
$ mkdir ibmtpm && cd ibmtpm
$ wget https://downloads.sourceforge.net/project/ibmswtpm2/ibmtpm1332.tar.gz
$ tar -zxvf ibmtpm1332.tar.gz
$ cd src
$ make -j5

And it's done, you are ready to run the projects.