Skip to content
This repository has been archived by the owner on Apr 5, 2023. It is now read-only.

Latest commit

 

History

History
29 lines (23 loc) · 2.38 KB

introduction.md

File metadata and controls

29 lines (23 loc) · 2.38 KB
Raw

Introduction

sdo-client-sdk is a portable implementation of the Secure Device Onboarding (SDO) protocol. This component is portable across multiple environments, including to various microprocessors (MPUs) and microcontrollers (MCUs).

At present, sdo-client-sdk is tested to following platforms showcasing SDO capabilities:

  1. Linux* x86 machine (with Ubuntu* OS version 20.04): Reference implementation
  2. NUCLEO-F429ZI STM32 Nucleo* development board running STM32F429ZI Arm* Cortex*-M4 MCU over Arm* Mbed* OS.
  3. NUCLEO-F767ZI STM32 Nucleo-144 development board running STM32F767ZI Arm Cortex-M7 MCU over ARM Mbed OS.
  4. WaRP7 WaRP7 development board running i.MX 7Solo Arm Cortex-A7 MPU over ARM Mbed Linux OS.

Other linux platfoms Raspberrian, yocto based build for different platforms(A7) can be used for SDO build also.

The SDK is to be linked with a customer application that initiates and drives the onboarding functionality. The SDK comes with a sample application that demonstrates how to onboard. The SDK also contains required documentations and an API guide.

The sdo-client-sdk is organized according to the following directory structure:

├── app               : SDO application
├── cmake*            : Cmake files
├── crypto            : Underlying cryptography and SSL/TLS 
├── data              : Data files, For example, device credentials
├── device_modules    : service module implementation
├── docs              : Documentation
├── include           : Top level public headers
├── lib               : SDO Device Library
├── mbedos*           : Arm Mbed OS-specific build
├── network           : OS-specific network abstraction
├── storage           : OS-specific storage abstraction
├── tests             : Unit tests
└── utils             : Utilities