Trusted Computing based services supporting TPM provisioning and supply chain validation concepts. #nsacyber
Go to file
lareine b0f85c0a3e Added intial RIM Test
script cleanup
2022-02-23 13:51:52 -05:00
.ci Added intial RIM Test 2022-02-23 13:51:52 -05:00
.github/workflows file name refactor 2022-01-26 12:08:29 -05:00
config/checkstyle Modified how unmatched log events are tested. Now it uses the reference event value from the database. 2021-03-23 13:13:17 -04:00
gradle/wrapper Initial release 2018-09-06 09:47:33 -04:00
HIRS_AttestationCA Updated the implementation to return a blank identity claim response. 2022-01-05 16:49:27 -05:00
HIRS_AttestationCAPortal Temporary removal of policy page option for LDevID generation 2022-01-11 10:05:27 -05:00
HIRS_Provisioner [] Firmware validation update part 2 () 2020-06-10 11:17:45 -04:00
HIRS_ProvisionerTPM2 Updated post install script for provisioner to change the permissions on 2022-01-25 08:22:31 -05:00
HIRS_Structs Initial release 2018-09-06 09:47:33 -04:00
HIRS_Utils Merge pull request from nsacyber/issue-381 2021-12-16 10:39:58 -05:00
images Updated images for version 1.1 2019-09-05 17:03:46 -04:00
package This initial commit updates the location of the vendor-table.json which is used by the ACA and the eventlog tool. The previous change moved the vendor-table.json to a separate folder, however the code was not updated to reflect the change. This instead updates how the two install handle the file. The ACA was updated not to clobber the file if it exists and the eventlog tool was updated to do the same through an additional script called post install. 2021-11-09 08:32:04 -05:00
scripts Support for -j|--json option to output validation report data in JSON format. Add shorthand options for script parameters and update help menu. 2021-05-20 12:06:20 -04:00
tools Upgrade log4j to 2.17.1. Remove unnecessary reference to log4j from tcg_eventlog_tool. 2022-01-12 16:19:19 -05:00
tpm_module [] Parallelize Subproject CI Builds and Pull Pre-Built Image 2018-10-12 12:01:46 -04:00
TPM_Utils Initial release 2018-09-06 09:47:33 -04:00
.gitignore This is a change to exclude the jaxb generated files from the git tracked file list just like the protobuf class is. The script runs and generates, the files are ignored by pmd and compile depends on building the xjc directory successfully. 2020-10-01 08:36:59 -04:00
build.gradle Upgrade log4j to 2.17.1. Remove unnecessary reference to log4j from tcg_eventlog_tool. 2022-01-12 16:19:19 -05:00
CONTRIBUTING.md Updated CONTRIBUTING.md 2018-09-07 13:59:31 -04:00
DISCLAIMER.md Initial release 2018-09-06 09:47:33 -04:00
gradle.properties Initial release 2018-09-06 09:47:33 -04:00
gradlew Initial release 2018-09-06 09:47:33 -04:00
gradlew.bat Initial release 2018-09-06 09:47:33 -04:00
LICENSE.md Initial release 2018-09-06 09:47:33 -04:00
NOTICE [] Implementation of Component Class field () 2019-03-25 11:14:19 -04:00
README.md Update README.md 2021-08-26 11:37:30 -04:00
settings.gradle added a eventcheck script to check and event log against a signed RIM 2020-05-27 17:31:15 -04:00
VERSION Update VERSION 2022-01-13 10:58:44 -05:00

Host Integrity at Runtime and Start-up (HIRS)

Build Status

Attestation Certificate Authority (ACA) and TPM Provisioning with Trusted Computing-based Supply Chain Validation

The Host Integrity at Runtime and Start-up Attestation Certificate Authority is a Proof of Concept - Prototype intended to spur interest and adoption of the Trusted Platform Module (TPM). It's intended for testing and development purposes only and is not intended for production. The ACA's functionality supports the provisioning of both the TPM 1.2 and TPM 2.0 with an Attestation Identity Credential (AIC). The ACA can be configured to enforce the Validation of Endorsement and Platform Credentials to illustrate a supply chain validation capability.

The ACA provides a “provisioner” application to be installed on all devices which will be requesting Attestation Credentials. The ACA is a web based server which processes Attestation Identity Requests. TPM Provisioning

Version 1.1 added support for the Platform Certificate v1.1 Specification. This allows entities that are part of the supply chain (System integrators and Value Added Resellers) the ability to create Delta Platform Certificate to compliment the Base Platform Certificate created by the Platform Manufacturer. See the Article on Base and Delta Platform Certificates for details.

Version 2.0 added support for the PC Client Reference Integrity Manifest (RIM) Specification to provide firmware validation capability to the HIRS ACA. This requires that the manufacturer of a device provide a digitally signed RIM "Bundle" for each device. The HIRS ACA has a new page for uploading and viewing RIM Bundles and a policy setting for requiring Firmware validation.

To support the TCG RIM concept a new tools folder has been added to the HIRS project which contains a tcg_rim_tool command line application. The tcg_rim_tool can be used to create NISTIR 8060 compatible SWID tags that adhere to the TCG PC Client RIM specification. It also supports the ability to digitally sign the Base RIM file as the HIRS ACA will require a valid signature in order to upload any RIM file. See the tgc_rim_tool READ.md for more details.

Features

  • TPM Provisioner
    • Requests an Attestation Identity Credential for the TPM from the ACA.
    • Takes ownership of TPM if not owned
    • Uses REST calls to complete the transaction with the ACA
    • Reads credentials from the TPM's NvRAM as part of the provisioning process.
    • Reads the device's hardware, network, firmware, and OS info for platform validation
  • Attestation Certificate Authority
    • Issues Attestation Identity Credentials to validated devices holding a TPM
    • Configures policies for enabling/disabling validation procedures
    • Performs TCG-based Supply Chain Validation of connecting clients
      • Optionally validates Endorsement and Platform Credentials
  • Endorsement Credential Certificate Chain Validation
  • Platform Credential Certificate Chain Validation
  • Attestation CA Dashboard
    • Displays all Validation Reports, Credentials, and Trust Chains
    • Enables ACA policy configuration for validation of Endorsement and Platform Credentials
    • Enables Import/Export of Certificate (Trust) Chains, Endorsement Credentials, and Platform Credentials
    • Optionally allows uploaded credentials to be used in validation for machines that have been reprovisioned by trusted parties since leaving the OEM
  • Firmware Integrity Validation
    • Checks that firmware and boot related file hashes match those provided by OEMs.
    • Validates the import of All RIM files imported to the ACA (insure all RIM files were signed by trusted sources)
    • Verifies that the firmware hashes captured by the TPMs Platform Configuration Registers (PCRs) match the firmware hashes obtained from the OEM(s).
    • Verifies TCG/UEFI boot variables (e.g. BIOS setup data) have not been altered (e.g secure boot).

Requirements

The HIRS Attestation Certificate Authority (ACA) supports installation on CentOS 6 and 7 instances.

The HIRS Provisioner supports both types of TPMs, 1.2 and 2.0. TPM 1.2 support is available on CentOS 6 and 7. Due to the limitations on the libraries available on Centos 6, TPM 2.0 support is only available on Centos 7.

Installation Instructions

For detailed instructions, see Installation notes.

Packages used for installation (e.g. HIRS_Provisioner*el7.noarch.rpm) can be found on the release page.

Installing the ACA

Simply run the command yum install HIRS_AttestationCA*el6.noarch.rpm or yum install HIRS_AttestationCA*el7.noarch.rpm based on your OS.

Installing the Provisioner

After enabling your TPM in BIOS/UEFI, determine if your machine has a TPM 1.2 or a TPM 2.0 by using the command:
dmesg | grep -i tpm_tis.

To install a TPM 1.2 Provisioner, run:
yum install tpm_module*.rpm
yum install HIRS_Provisioner*el6.noarch.rpm or yum install HIRS_Provisioner*el7.noarch.rpm based on OS
hirs-provisioner -c

To install a TPM 2.0 Provisioner, run:
yum install hirs-provisioner-tpm2*.rpm

To configure the provisioner, edit the hirs-site.config file in /etc/hirs/hirs-site.config. Edit the file to specify the ACA's fully qualified domain name and port.

Usage

To kick off a provision on the client, run the command sudo tpm_aca_provision.

To see the results and interact with the ACA, go to the ACA Portal at https://ACAPortalAddress:ACAPortalPort/HIRS_AttestationCAPortal/portal/index.