· 06/12/2024 ·

Intel® Trust Authority CLI installation guide

These instructions describe how to build and install the Intel Trust Authority CLI. The Intel Trust Authority CLI is an open-source tool tenants use to make API calls to their instance of Intel Trust Authority. The source code for the Intel Trust Authority CLI is available on GitHub.

Note

Valid characters include: numbers 0 through 9, upper and lowercase English characters, underscore (_), colon (;), period (.), slash (/), dash (-), and a space ( ).

Build the Intel Trust Authority CLI

Follow these instructions to build the Intel Trust Authority CLI.

Prerequisite packages

Install the following prerequisite packages before installing the Intel Trust Authority CLI:

Make and Makeself

To instal the make and makeself packages, run the following command:

apt -y install make makeself

Golang

The supported Golang version is 1.20.x

  1. To install Golang version 1.20.x, follow the install instructions on the golang website https://go.dev/doc/install.

  2. Add the local binary path, namely $HOME/.local/bin/, to your PATH environment variable if not already present.

Supported operating system

  • Ubuntu LTS 20.04
Note

You must be a Tenant Admin to install the CLI, however, both the admin and users can use the CLI.

Build the CLI

  1. Create a directory on the build machine named CLI.

    mkdir cli

  2. Go to the CLI directory.

    cd cli

  3. To clone the Intel Trust Authority CLI code to the newly created CLI directory, run the following command.

    git clone https://github.com/intel/trustauthority-cli

  4. Create the CLI installer in the newly created CLI directory.

    cd trust-authority-cli and run "make installer"

Install the Intel Trust Authority CLI

Before beginning these instructions, have the following information available:

  • URL of API Gateway
  • API Key of the Tenant

  1. If you have not already navigated to the CLI directory in which the CLI was built, navigate to it.

    cd cli

  2. Copy the binary installer to the system on which it is being deployed.

    trustauthorityctl-{version}.bin

  3. The trustauthorityctl.env file enables the CLI to contact a specific Intel Trust Authority instance so it can be used to make changes. Create the trustauthorityctl.env file in your home directory and add the following contents:

    • TRUSTAUTHORITY_URL=https://api.trustauthority.intel.com
    • TRUSTAUTHORITY_API_KEY="< Admin API Key >

    > [!NOTE] > The portal and API URLs for Intel Trust Authority differ by your region (US vs EU). Use the right URLs for your region:

    Region BaseUrl ApiUrl
    World/US https://portal.trustauthority.intel.com https://api.trustauthority.intel.com
    EU https://portal.eu.trustauthority.intel.com https://api.eu.trustauthority.intel.com
    Intel® Trust Authority is not currently available to customers residing in the People's Republic of China. `

  4. To install the tenant CLI on your system, run following command:

    ./trustauthorityctl-{version}.bin

Note

If you're behind a proxy, add the Intel Trust Authority FQDN to the NO_PROXY environment variable.

Directory structure

All files are stored in the user's home directory. The contents of the directories are listed below:

  • Configuration: $HOME/.config/trustauthorityctl/config.yaml
  • Logs: $HOME/.config/trustauthorityctl/logs/trustauthorityctl.log
  • Bin: $HOME/.local/bin/trustauthorityctl
Note

If you cannot access the command, add the binary path to the PATH env variable

Commands

Note

Request ID could be a randomly generated string of at most 128 bytes, which can work as a unique identifier for each CRUD operation. This can be provided as an optional parameter to all the CRUD commands only.

Tenant CLI configuration

Use the command below to configure the tenant CLI. You need to know the file path to the trustauthorityctl.env file created in the previous step.

trustauthorityctl config -v < env file path >

Install Bash completion

Use the following command to install bash completion for the Intel Trust Authority CLI.

trustauthorityctl completion

Retrieve the version

To get the version number of the tenant CLI installed on your system, run the following command:

trustauthorityctl version

Uninstall the CLI

To uninstall the tenant CLI, use the following command:

trustauthorityctl uninstall