Skip to content

Latest commit

 

History

History
456 lines (343 loc) · 20.4 KB

tpm.md

File metadata and controls

456 lines (343 loc) · 20.4 KB
Raw

Linux* TPM* Implementation

Ubuntu* OS version 20.04 or 22.04 / RHEL* OS version [8.4|8.6|8.8] / Debian 11.4 on x86 was used as a development and execution OS. Follow these steps to compile and execute FIDO Device Onboard (FDO).

The FDO Client SDK execution depends on OpenSSL* toolkit 3.0.14 version. Users must install or upgrade the toolkit before compilation if the toolkit is not available by default in the environment.

1. Packages Requirements when Building Binaries with TPM* 2.0:

  • For Ubuntu* OS version [20.04|22.04] / Debian 11.4:
sudo apt-get install build-essential python-setuptools clang-format dos2unix ruby \
  libglib2.0-dev libpcap-dev autoconf libtool libproxy-dev doxygen cmake mercurial nghttp2 libnghttp2-dev
  • For RHEL* OS version [8.4|8.6|8.8]:
sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms
sudo yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
sudo yum -y install gcc gcc-c++ python3-setuptools git-clang-format dos2unix ruby perl glibc-static \
  glib2-devel libpcap-devel autoconf libtool libproxy-devel mozjs52-devel doxygen cmake make mercurial nghttp2 libnghttp2-devel

OpenSSL* toolkit version 3.0.14. Curl version 8.8.0

Steps to Upgrade the OpenSSL* Toolkit to Version 3.0.14

Following steps will replace the existing versions of OpenSSL and Curl from the system. If you want to keep the existing versions then use Installation-Script script to install Openssl and Curl at a different location.

NOTE: Installation-Script will install OpenSSL and Curl at /opt/ by default. To provide different path, modify these variables in the script OPENSSL_ROOT=/opt/openssl CURL_ROOT=/opt/curl

Script usage command

  • Command to install OpenSSL and Curl 
     sudo ./install_openssl_curl.sh -i -v 3.0.14

  1. If libssl-dev, curl and libcurl are installed, uninstall it:

    sudo apt-get remove --auto-remove libssl-dev
sudo apt-get remove --auto-remove libssl-dev:i386
sudo apt remove curl libcurl4-openssl-dev

    In case of RHEL OS, use below commands to uninstall:

    sudo yum remove libcurl-devel openssl-devel

  2. Pull the tarball:

    wget https://www.openssl.org/source/openssl-3.0.14.tar.gz

  3. Unpack the tarball with:

    tar -zxf openssl-3.0.14.tar.gz && cd openssl-3.0.14

  4. Issue the command:

    ./config --libdir=/usr/local/lib

  5. Issue the command:

    make

  6. Check for possible errors:

    make test

  7. Backup the current OpenSSL* binary:

    sudo mv /usr/bin/openssl ~/tmp

  8. Issue the command:

    sudo make install

  9. Create a symbolic link from the newly installed binary to the default location:

    sudo ln -s /usr/local/bin/openssl /usr/bin/openssl

  10. Run the command to update symlinks and rebuild the library cache:

    grep -qxF '/usr/local/lib/' /etc/ld.so.conf.d/libc.conf || echo /usr/local/lib/ | sudo tee -a /etc/ld.so.conf.d/libc.conf
sudo ldconfig

  11. Assuming no errors in executing steps 4 through 10, you should have successfully installed the new version of the OpenSSL* toolkit. Issue the following command from the terminal:

    openssl version

    Your output should be as follows:

    OpenSSL* 3.0.14  04 Jun 2024

Steps to install curl version 8.8.0 configured with openssl

After installing openssl, proceed with the installation of curl.

  1. Pull the tarball:

    wget https://curl.se/download/curl-8.8.0.tar.gz

  2. Unpack the tarball with:

    tar -zxf curl-8.8.0.tar.gz && cd curl-8.8.0

  3. Issue the command to configure the curl with openssl and nghttp2:

    ./configure --with-openssl="OpenSSL Path" --with-nghttp2 --enable-versioned-symbols --without-libpsl

  4. Issue the command to build curl:

    make -j$(nproc)

  5. Command to install curl:

    sudo make install

  6. Assuming no errors in executing steps 1 through 5, you should have successfully installed curl configured with openssl Issue the following command from the terminal:

    curl --version

    Your output should point to the openssl version which you installed.

    curl 8.8.0 (x86_64-pc-linux-gnu) libcurl/8.8.0 OpenSSL/3.0.14 zlib/1.2.11

Note 1: If you are using no_proxy environment variable to exclude proxying for any FDO server IP addresses, it may not work with curl 8.8.0. Workaround for this is to ensure the no_proxy IP is specified in CIDR notation (https://datatracker.ietf.org/doc/html/rfc1519)

Single IP address example: no_proxy="10.60.132.45/32" Two IP addresses example: no_proxy="10.60.132.45/32,10.60.132.46/32" Range of IP addresses example: no_proxy="10.60.0.0/16"

Note 2: On RHEL, Curl could also be installed using yum package manager as shown below: sudo yum -y install libcurl-devel

2. TPM* Library Installation

TPM* enabled FDO Client SDK uses TPM-TSS 4.0.1, TPM2-ABRMD 3.0.0, and TPM2-TOOLS 5.5 libraries for key and cryptography related operations. The TPM-TSS library is required for compiling the code while all 3 libraries are required for running the code. Create an empty directory, download and execute FDO TPM* TPM-Library-Installation-Script which can be used for both installation and uninstallation of TPM* libraries. Alternatively, perform steps listed in section 2.1 to setup TPM* library without using the TPM* TPM-Library-Installation-Script.

To compile and execute TPM* enabled FDO Client SDK use one of the appropriate commands:

Script usage command

  • On Ubuntu OS version 20.04 or 22.04 / Debian 11.4:

     sudo ./install_tpm_libs.sh -h

  • TPM-TSS library setup to enable TPM* enabled FDO Client SDK code compilation

    • Command to install tpm-tss library
     sudo ./install_tpm_libs.sh -t
    • Command to uninstall tpm-tss library
     sudo ./install_tpm_libs.sh -d

  • TPM* setup to enable TPM* enabled FDO Client SDK code compilation and execution

    • Command to install TPM* libraries
     sudo ./install_tpm_libs.sh -i
    • Command to uninstall TPM* libraries
     sudo ./install_tpm_libs.sh -u

    NOTE: TPM-Library-Installation-Script will use OpenSSL and Curl from /opt/ by default. If you have installed OpenSSL and Curl other than /opt path, use openssl version -a and which curl commands to get the exact path of OpenSSL and Curl and modify these variables in the script OPENSSL3_INCLUDE=/opt/openssl/include (can be /usr/include or /usr/local/include) CURL_INCLUDE=/opt/curl/include (can be /usr/include or /usr/local/include) OPENSSL3_LIB=/opt/openssl/lib64 (can be /usr/lib or /usr/local/lib or /usr/lib/x86_64-linux-gnu) CURL_LIB=/opt/curl/lib (can be /usr/lib or /usr/local/lib or /usr/lib/x86_64-linux-gnu)

  • On RHEL* OS version 8.4 or 8.6:

NOTE: Use TPM-Library-Installation-Script-RHEL for RHEL 8.4 or 8.6. Before executing TPM-Library-Installation-Script-RHEL, make sure OpenSSL v3 and Curl is installed on the system (at /usr/local/ path). Use steps in section 1 to install OpenSSL and Curl on the system.

sudo ./install_tpm_libs_rhel.sh -h

  • TPM-TSS library setup to enable TPM* enabled FDO Client SDK code compilation

    • Command to install tpm-tss library
     sudo ./install_tpm_libs_rhel.sh -t
    • Command to uninstall tpm-tss library
     sudo ./install_tpm_libs_rhel.sh -d

  • TPM* setup to enable TPM* enabled FDO Client SDK code compilation and execution

    • Command to install TPM* libraries
     sudo ./install_tpm_libs_rhel.sh -i
    • Command to uninstall TPM* libraries
     sudo ./install_tpm_libs_rhel.sh -u

2.1 Building and Installing Libraries for Trusted Platform Module (TPM*)

Following steps should be performed if FDO TPM* TPM-Library-Installation-Script script is not used to setup FDO TPM* libraries. Install only tpm2-tss library to enable TPM* enabled FDO Client SDK code compilation. To enable compilation and execution of TPM* enabled FDO Client SDK code, install all libraries namely: tpm2-tss, tpm2-abrmd, tpm2-tools, and tpm2-tss-engine.

  • tpm2-tss-4.0.1

    This is the main library that creates commands per Trusted Computing Group (TCG) specification to use the TPM*. It uses release version 4.0.1 of the library.

  • tpm2-abrmd-3.0.0

    This is an optional but recommended library (daemon) to use TPM* in the device. This daemon will act as a resource manager for the TPM*, for all I/O calls that happen with the device. It uses release version 3.0.0 of the library.

    • Source Code

      The library can be downloaded from tpm2-abrmd-3.0.0-download

      Alternatively, the in-kernel RM /dev/tpmrm0 can be used. Please see section on Compiling FDO.

    • Build and Installation Process

      The build and installation process found at tpm2-abrmd-3.0.0-install

  • tpm2-tools-5.5

    This library provides the necessary tools to interact and perform operations using the TPM*, to the users. It uses release version 5.5 of the library.

  • tpm2-openssl-1.1.1

    This library implements a provider that integrates the TPM 2.0 operations to the OpenSSL 3.0 to perform the OpenSSL* cryptography operation using the keys inside the TPM*. It uses release version 1.1.1 of the library.

    • Source Code

      The library can be downloaded from tpm2-openssl-download

    • Build and Installation Process

      The build and installation process can be found at tpm2-openssl

3. Compiling Intel safestringlib

FDO Client SDK uses safestringlib for string and memory operations to prevent serious security vulnerabilities (For example, buffer overflows). Download safestringlib from intel-safestringlib, checkout to the tag v1.2.0 and follow these instructions to build: From the root of the safestringlib, do the following:

mkdir obj
make

After this step, libsafestring.a library will be created.

4. Compiling Intel TinyCBOR

FDO Client SDK uses TinyCBOR library for Concise Binary Object Representation (CBOR) encoding and decoding. Download TinyCBOR from TinyCBOR, checkout to the tag v0.6.0 and follow these instructions to build: From the root of the TinyCBOR (named tinycbor), do the following:

make

5. Environment Variables

Add these environment variables to ~/.bashrc or similar (replace with actual paths). Provide OpenSSL, Curl, safestringlib and tinycbor paths:

export OPENSSL3_ROOT=path/to/openssl (can be /usr or /usr/local or default provide /opt/openssl)
export CURL_ROOT=path/to/curl (can be /usr or /usr/local or default provide /opt/curl)
export SAFESTRING_ROOT=path/to/safestringlib
export TINYCBOR_ROOT=path/to/tinycbor

6. Compiling FDO Client SDK

The FDO Client SDK build system is based on GNU make. It assumes that all the requirements are set up according to FDO Compilation Setup . The application is built using the make [options] in the root of the repository for all supported platforms. The debug and release build modes are supported in building the FDO Client SDK.

Refer the TPM* Library Setup steps given in section 2 to compile TPM* enabled FDO Client SDK.

For an advanced build configuration, refer to Advanced Build Configuration .

Example command to build TPM* enabled FDO Client SDK with the Resource Manager as TPM2-ABRMD (tabrmd)

make pristine
cmake -DDA=tpm20_ecdsa256 .
make -j$(nproc)

To use the in-kernel Resource Manager '/dev/tpmrm0', use the following command

make pristine
cmake -DDA=tpm20_ecdsa256 -DTPM2_TCTI_TYPE=tpmrm0 .
make -j$(nproc)

NOTE: To run with mTLS connection,

  1. Compile the code with -DMTLS=true flag.
  2. If signing with external CA, copy CA cert and CA key to data folder.
  3. Execute bash utils/user_csr_req.sh . This will generate client CSR and private key.

Several other options to choose when building the device are, but not limited to, the following: device-attestation (DA) methods, Advanced Encryption Standard (AES) encryption modes (AES_MODE), and underlying cryptography library to use (TLS). Refer to the section FDO Build configurations

7. Running the Application

The TPM* enabled FDO Client SDK Linux device is compatible with FDO PRI components - Manufacturer, Reseller, Rendezvous, and Owner.

To test the FDO Client SDK Linux device, setup the FDO PRI Manufacturer, FDO PRI Rendezvous and FDO PRI Owner.

Refer the TPM* Library Setup steps given in section 2 to compile and execute TPM* enabled FDO Client SDK.

After a successful compilation, the FDO Client SDK Linux device executable can be found at <path-to-client-sdk-fidoiot>/build/linux-client.

  • Before executing linux-client, prepare for Device Initialization (DI) by starting the FDO PRI Manufacturer. Refer to Device Initialization Setup . Then, execute the TPM* make ready script. Refer to TPM Make Ready. Alternatively, perform the steps listed in section 7.1 to initialise the device without using TPM Make Ready script.

    Script execution command:

    sudo ./tpm_make_ready_ecdsa.sh -e <ECDSA type 256 or 384> -p <FDO Client SDK data folder location>

NOTE 1: TPM Make Ready script will use OpenSSL from /opt/ by default. To provide a different path, use which openssl command to get the exact path of OpenSSL and modify this variable in the script OPENSSL3_BIN=/opt/openssl/bin (can be /usr/bin or /usr/local/bin)

NOTE 2: Some platforms do not have the support for ECDSA 384 in TPM. TPM Make Ready script with option "-e 384" will fail in those platforms. Please use ECDSA 256 in that case.

  • Once the TPM* make ready script is executed successfully, the device is now initialized with the credentials and is ready for ownership transfer. To run the device against the FDO PRI Manufacturer for the DI protocol, do the following:

    ./build/linux-client

  • To enable the device for Transfer Ownership protocol (TO1 and TO2), configure the FDO PRI Rendezvous and Owner. Refer to Ownership Transfer Setup . After these are set up, execute linux-client again.

    ./build/linux-client

NOTE: Usage:

./build/linux-client -ip <http|https>://<mfg addr>:<port>
if -ip not specified, manufacturer_addr.bin will be used
-ss: specify if backend servers are using self-signed certificates
-r: enable resale

NOTE: linux-client may require elevated privileges. Please use 'sudo' to execute. NOTE: To do the DI again we need to clear the Device status from TPM storage. To clear the TPM storage, execute the clear TPM* script. Refer to Clear TPM.

sudo  ./utils/clear_tpm_nv.sh

NOTE: Enabling LOCK_TPM flag in cmake/cli_input.cmake will lock TPM for further reads/writes. This flag is enabled by default. But note that this may require the user to reboot the system before any consecutive execution of linux-client.

7.1 Prepare FDO Client SDK Data Folder

  • Persistent Storage Index in TPM*

Find a persistent storage index that is unused in the TPM* and note it down. It usually starts from 0x81000000. To see the indexes that are already being used, use the following command. FDO uses the indexes mentioned in the TPM spec for the following command examples.

sudo tpm2_getcap handles-persistent
sudo tpm2_getcap handles-nv-index

NOTE: Please note that the FIDO Alliance specification "Securing FDO Credentials in the TPM" has been published as a Review Draft by the FIDO Alliance, and is still subject to comment and change. With respect to section 4.2, Handles for FDO Credentials, Trusted Computing Group (TCG) has allocated the NVRAM addresses referenced, and is moving towards approval of the persistent object handles.

  • Primary Key Generation from Endorsement Hierarchy
sudo tpm2_createprimary -C e -g sha256 -G ecc256:aes128cfb -c data/tpm_primary_key.ctx -V
sudo tpm2_create -g sha256 -G ecc256 -u data/tpm_ecdsa_pub.key -r data/tpm_ecdsa_priv.key -C data/tpm_primary_key.ctx -a "fixedtpm|sensitivedataorigin|fixedparent|sign|userwithauth" -V
  • Device ECDSA Key-Pair Generation and Load the Primary Key into TPM* Persistent Memory
sudo tpm2_load -C data/tpm_primary_key.ctx -u data/tpm_ecdsa_pub.key -r data/tpm_ecdsa_priv.key -c data/tpm_ecdsa_key.ctx -V
sudo tpm2_evictcontrol -C o 0x81020002 -c data/tpm_primary_key.ctx -V
  • Generate Device MString
sudo openssl req -new -provider tpm2 -provider default -outform DER -out data/tpm_device_csr -key handle:0x81020002 -subj "/CN=fdo-tpm-device" -verbose
  • Define a TPM Non-Volatile (NV) index for TPM Device CSR and Write TPM Device CSR to a Non-Volatile (NV) index
csr_size=$(wc -c < data/tpm_device_csr)
sudo tpm2_nvdefine -Q   0x01D10005 -C o -s csr_size -a "ownerwrite|authwrite|ownerread|authread|no_da|read_stclear|writedefine"
sudo tpm2_nvwrite -Q   0x01D10005 -C o -i data/tpm_device_csr

8. Troubleshooting Details

  • TPM* Authorization Failure while Running tpm2-tools Command.
    Clear TPM* from the BIOS. To run the TPM* enabled FDO Client SDK implementation, the TPM* on the device should not be owned. To reset the TPM*, go to your device BIOS and clear the TPM*. To find the location of the option in the BIOS of your device, refer to your device manual.

  • Clear the Used Persistent Index in TPM*.
    Use the tpm2_evictcontrol command to delete the content or clear TPM* from the BIOS. To run the TPM* based FDO implementation, the TPM* on the device should not be owned. To reset the TPM*, go to your device BIOS and clear the TPM*. To find the location of the option in the BIOS of your device, refer to your device manual.

To clear the TPM storage, execute the clear TPM* script. Refer to Clear TPM.

sudo  ./utils/clear_tpm_nv.sh
  • OpenSSL* Toolkit Library Linking Related Error While Building FDO Client SDK.
    There is a dependency on the OpenSSL* toolkit version 3.0.14 for building and running the FDO Client SDK. Check the version of the OpenSSL* toolkit installed in your machine with the command
  openssl version

If the OpenSSL* toolkit version in your machine is earlier than version 3.0.14, follow the steps given in section 1 to update the OpenSSL* version to 3.0.14.