Installing the Trust Platform Design Suite v1

Last modified by Microchip on 2023/11/10 11:18

Please note this page is for Trust Platform Design Suite v1. Training for Trust Platform Design Suite v2 is available.

This page shows you how to install and set up Microchip's Trust Platform Design Suite for CryptoAuthentication™. The design suite dramatically reduces the time you'll spend provisioning and using Microchip's secure elements.

Trust family logos

Installing the Design Suite

  1. Installing the Trust Platform Design Suite Graphical User Interface (GUI)
    • Includes the Trust Platform GUI, Python, and Jupyter Notebook.
  2. Cloning the Trust Platform Repository
    • The Trust Platform repository is hosted on GitHub and must be downloaded separately.
    •  Includes Python packages, C projects, and use case user guides.
  3. Setting the Path to the MPLAB X IDE Installation Folder
    • Enables the GUI to re-program the CryptoAuth Trust Platform board.

After Installation

  1. Choosing the Right Trust Platform Family
  2. Starting Jupyter Notebook
    • Start Jupyter Notebook to provision the secure element.

Back to Top


Installing the Trust Platform Design Suite Graphical User Interface

The Trust Platform Design suite helps you with:

  • Selecting the appropriate secure element family for your use case.
  • Provisioning the secure element for your use case.
  • Prototyping your use case using C-based example projects and the CryptoAuth Trust Platform hardware prototyping kit.
  • Generating an encrypted file to share your secure element's provisioning secrets with Microchip.

The Trust Platform Design Suite includes Anaconda (Python distribution) and Jupyter Notebook (open-sourced Python-based application). Jupyter Notebook communicates with a secure element on the CryptoAuth Trust Platform development board to provision it for your specific use case. The CryptoAuth Trust Platform board includes all three Trust Platform devices: Trust&GO (pre-configured and pre-provisioned black box), TrustFLEX (pre-configured), and TrustCUSTOM (full custom). These devices are based on the ATECC608B CryptoAuthentication device.

Supported operating systems:

  • Microsoft Windows® 10 64-bit
  • Linux® Ubuntu 20.04 LTS or newer
  • macOS® Mojave 10.14.6 or newer

Supported Integrated Development Environments (for the C-based projects):

  • MPLAB® X IDE v5.25 and XC32 C compiler v2.30 or later

Supported web browsers: Google Chrome and Apple Safari

Choose your operating system for installation instructions:

Windows Installation

Download and run the installer.

Windows Installation Welcome Screen


 

 

Review and accept the end-user license agreement terms. Then, select the installation type as Just Me (recommended).

Select Installation Type


 

 

Browse to the installation folder of your choice.

Browse to the Installation Folder


 

 

Leave the top two Advanced Installation Option boxes unchecked.

Clear Package Cache Dialog


 

Start the Trust Platform Design Suite. Click on the Windows Start icon and search for "Trust Platform V1.3.1". A message will open saying the repository is not found. You will clone the repository in the next step.

Start the Trust Platform Design Suite

Back to Top


MacOS Installation

The Trust Platform Design Suite macOS version can run equally well with both Google Chrome and Apple Safari web browsers.

 

Download and run the installer.

If you have macOS Catalina or newer (i.e., macOS v>=10.15) you may get this error.
You will need to go to your System Preferences > Security & Privacy and authorize the binary to open.

Warning Dialog


 

Review and accept the terms of the software license agreement.

Review Terms Dialog


 

Right after accepting the above terms, the installer will jump directly to Installation Type and will not allow you to select the installation location.
When prompted with this screen, click on Change Install Location.

Standard Installation Dialog


 

When this screen opens, make sure to select Install for me only.

Upon completion of the installation, Anaconda Navigator will be added to your Applications.

Install for me Only Dialog


 

Start the Trust Platform Design Suite. Open Applications > Trust Platform V1.3.1. A message will open saying the repository is not found. You will clone the repository in the next step.

Back to Top


Cloning the Trust Platform Repository

 

Click Design Suite > Setup > Repository to clone (download) the Trust Platform Design Suite repository from GitHub, and install the Python packages.

Repository Setup Dialog


 

Wait for this process to complete. Please be patient as this may take up to 30 minutes. You'll know it's done when you see the following message displayed:
"Python package update - Done."

Python Package Update

Back to Top


Setting the Path to the MPLAB X IDE Installation Folder

If you want to re-provision the secure element after using the CryptoAuth Trust Platform board to prototype your use case, you will have to reprogram the board with factory firmware. The Trust Platform Design Suite can do this for you if you tell it where MPLAB X IDE lives on your computer. On the top left of the Trust Platform Design Suite window, select File > Preferences to specify the path to MPLAB X IDE.

Specify PATH in Preferences Dialog

The CryptoAuth Trust Platform board comes pre-programmed with firmware. This firmware enables Jupyter Notebook to provision the secure element on the CryptoAuth Trust Platform board for your specific use case. Once the secure element is provisioned, you can re-program the board to prototype your use case using one of the example projects that come with the Trust Platform Design Suite.

Back to Top


Choosing the Right Trust Platform Family

Click the Getting Started button to open the "Start Here" webpage. This page helps you choose which Trust Platform family (Trust&GO, TrustFLEX, or TrustCUSTOM) is right for your use case.

Getting Started Dialog

This page is filled with useful information including:

  • Development boards (including user guides)
  • Datasheets
  • Part numbers
  • Links to web pages providing details for each family's use cases
    • Trust&GO
      • Cloud Connect Amazon
      • Cloud Connect Google
      • Cloud Connect Microsoft Azure®
      • Accessory/Disposable Asymmetric Authentication
    • TrustFLEX
      • Firmware Validation, Secure OTA
      • Secure Public Key Rotation
      • IP/Firmware Protection
      • Accessory/Disposable Symmetric Authentication
      • Accessory/Disposable Asymmetric Authentication
      • Custom Public Key Infrastructure - Amazon & Microsoft Azure
      • Cloud Connect Google - IoT

The Trust&GO and TrustFLEX family web pages include detailed transaction diagrams for each use case including Application Programming Interfaces (APIs) with links to their implementation in example code. The TrustFLEX webpage also includes each use case's slot configuration and provisioning.

Back to Top


Starting Jupyter Notebook

Click the Start Jupyter button to open Jupyter Notebook in your web browser.

This is used to provision a secure element on the CryptoAuth Trust Platform board. See the user guides (in the docs folder) for detailed instructions on running Jupyter Notebook for each use case.

Start Jupyter

Jupyter Notebook is an open-source web application that allows you to create documents that contain code and narrative text that can be executed in place. It provides Graphical User Interface (GUI) elements, the ability to add images, and gives the interactive look that is absent in normal code files.

The cells of the Jupyter Notebook can be used to write code or text using markdown. The code cells contain executable code and the text cells contain the explanation of the code's functionality.

assets folder:

  • CryptoAuth Trust Platform board firmware.
  • WINC1500 board firmware.

docs folder:

  • Datasheets.
  • CryptoAuth Trust Platform board user's guide.
  • Detailed use-case guides.

TrustFLEX folder:

  • Jupyter notebook packages
  • C-based projects

TrustnGO folder:

  • Jupyter notebook packages
  • C-based projects

Screenshot of Jupyter Notebook

Back to Top