/xaptum-tpm

Utilities for interacting with the TPM2.0 used to access the Xaptum Edge Network Fabric, an IoT Network Solution.

Primary LanguageCApache License 2.0Apache-2.0

Xaptum TPM

Release Build Status

Utilities for interacting with a TPM2.0 used for access to the Xaptum Edge Network Fabric.

Installation

xaptum-tpm is available for the following distributions. It may also be built from source.

Debian (Jessie or Stretch)

# Install the Xaptum API repo GPG signing key.
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys c615bfaa7fe1b4ca

# Add the repository to your APT sources, replacing <dist> with either jessie or stretch.
echo "deb http://dl.bintray.com/xaptum/deb <dist> main" > /etc/apt/sources.list.d/xaptum.list

# Install the library
sudo apt-get install libxaptum-tpm-dev

Homebrew (MacOS)

# Tap the Xaptum repository.
brew tap xaptum/xaptum

# Install the library.
brew install xaptum-tpm

Installation from Source

Build Dependencies

  • CMake (version 3.0 or higher)
  • A C99-compliant compiler
  • A POSIX-compliant platform

Building

# Create a subdirectory to hold the build
mkdir -p build
cd build

# Configure the build
cmake .. -DCMAKE_BUILD_TYPE=Release

# Build the library
cmake --build .

CMake Options

The following CMake configuration options are supported.

Option Values Default Description
CMAKE_BUILD_TYPE Release With full optimizations.
Debug With debug symbols.
RelWithDebInfo With full optimizations and debug symbols.
RelWithSanitize With address and undefined-behavior sanitizers.
CMAKE_INSTALL_PREFIX /usr/local The directory to install the library in.
BUILD_SHARED_LIBS ON, OFF ON Build shared libraries.
BUILD_STATIC_LIBS ON, OFF OFF Build static libraries.
BUILD_TESTING ON, OFF ON Build the test suite.
BUILD_UTILS ON, OFF ON Build utility programs.
STATIC_SUFFIX Appends a suffix to the static lib name.
CMAKE_POSITION_INDEPENDENT_CODE ON, OFF ON Compile static libs with -fPIC.

Testing

By default, the tests use a device-file-based TCTI. For this reason, sudo privileges may be required to run them.

The tests can instead be build to use a TCP-socket-based TCTI, by using the CMake option TEST_USE_TCP_TPM=ON.

If using the TCP-socket-based TCTI, the tests require a TPM 2.0 simulator running locally on TCP port 2321.

Use the following commands to start the simulator before running the tests.

.travis/install-ibm-tpm2.sh <installation dir>
.travis/run-ibm-tpm2.sh

To run the tests:

cd build
ctest -V

Installing

cd build
cmake --build . --target install

Utilities

The following command-line utilities are provided by xaptum-tpm for interacting with a Xaptum TPM2.0:

  • xtpm_read_nvram
    • Query the value of one of the pre-created NVRAM indices gpk, cred, cred_sig, root_id, root_pubkey, or root_cert:
    • xtpm_read_nvram <index-name> <output-file>

License

Copyright 2017-2018 Xaptum, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License from the LICENSE.txt file or at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.