This is the OPTIGA™ Trust M Host Library for C. It is a reference implementation that allows the use of the OPTIGA™ Trust M via a high-level API and serves as a basis of our example host applications.
Information on the Product including Documentation, GetStarted Guides or Application Notes can be found in OPTIGA™ Trust M Overview Repository here
Below are the instructions to get the OPTIGA™ Trust M Host Library for C.
The OPTIGA™ Trust M Host Library for C can be cloned using git command :
git clone --recurse-submodules https://github.com/Infineon/optiga-trust-m.git
Instructions on how to build and test the host library can be found here
Instructions on how to port the host library to a specific platform can be found here
Examples to demonstrate basic functionality of the security chip can be found here
The OPTIGA™ Trust M Host Library for C relies on Mbed TLS. This library is cloned from a submodule under external/mbedtls folder. It comes with a default configuration that needs to be modified to the application purpose. Under config/mbedtls_default_config.h a default configuration is provided and should be changed depending on need.
During compilation, the following define needs to be added:
During compilation, the following define needs to be added :
MBEDTLS_USER_CONFIG_FILE="config/mbedtls_default_config.h"
for Makefile :
-DMBEDTLS_USER_CONFIG_FILE="config/mbedtls_default_config.h"
for CMake :
target_compile_definitions(app PRIVATE MBEDTLS_USER_CONFIG_FILE="${CMAKE_CURRENT_SOURCE_DIR}/config/mbedtls_user_config.h")
The following documentation is available for the host library.
| Topic | Link to documentation |
|---|---|
| API Documentation (High Level) | OPTIGA™ Trust M API - High Level |
| API Documentation (Code) | OPTIGA™ Trust M API - Code |
| I2C Interface Documenation | I2C Interface Documenation |
For more information please refer to the Wiki page of this project
| Host application | Operating System | Status |
|---|---|---|
| OPTIGA™ Trust M Cryptography | Native | Active |
| OPTIGA™ Trust M MQTT Client | FreeRTOS | Active |
| OPTIGA™ Trust M Power management | Native | Active |
| OPTIGA™ Trust M Data management | Native | Active |
| OPTIGA™ Trust M TLS with mbedTLS | Native | Active |
| OPTIGA™ Trust M AWS FreeRTOS | FreeRTOS | Active |
| OPTIGA™ Trust M Microsoft Azure IoT | FreeRTOS | Active |
| OPTIGA™ Trust M PKCS#11 interface | Linux | Active |
| OPTIGA™ Trust M Matter integration | Linux | Active |
| OPTIGA™ Trust M Zephyr PAL & Application | Zephyr | Active |
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Please see our LICENSE for copyright and license information.
This project follows the REUSE approach, so copyright and licensing information is available for every file (including third party components) either in the file header, an individual *.license file or the .reuse/dep5 file. All licenses can be found in the LICENSES folder.