TrustPoint-Project / trustpoint-client

MIT License
4 stars 0 forks source link

Trustpoint Client
The secure user-driven onboarding utility for Trustpoint.

[!CAUTION] Trustpoint Client is currently in an early technology preview (alpha) state. Do not use it in production.

What is Trustpoint Client?

Trustpoint Client allows you to onboard devices to Trustpoint, which encompasses retrieving the trust store, and requesting and downloading a digital identity (LDevID) and its associated certificate chain. All you need is a command line interface on your device, and a recent version of python.

[!WARNING] Please only onboard devices to your network you are sure you can trust.

Installation

Method 1: Directly from Trustpoint (TBD)

Just download the package from Trustpoint during onboarding and transfer it to the device, e.g. via SCP or a USB drive.

Method 2: From GitHub

  1. Clone git repo: https://github.com/TrustPoint-Project/trustpoint-client
  2. Change into the trustpoint-client directory
    cd trustpoint-client
  3. Install virtual environment and required dependencies
    sudo apt install python3-venv
    python3 -m venv .venv
    source .venv/bin/activate
    pip install --upgrade pip
    pip install -r requirements.txt
  4. Set environment variabels

    Permanent setting

  5. Execute program Trustpoint will generate and display the exact command for you during the onboarding process.

    Note that trustpoint_client executed below is the directory (as package), not the trustpoint_client.py file

    python3 -m trustpoint_client
    python3 -m trustpoint_client provision --otp abc --salt fgh --url xyz