mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

History

Kaspar Schleiser a622c88105 examples/suit_update: fix redundant check in test script		2023-05-22 12:56:49 +02:00
..
tests-with-config	examples/suit_update: fix redundant check in test script	2023-05-22 12:56:49 +02:00
coap_handler.c	nanocoap: make use of coap_request_ctx_t	2022-07-17 14:29:39 +02:00
main.c	examples/suit_update: add missing include	2023-03-10 02:23:55 +01:00
Makefile	examples/suit_update: improve default module selection	2023-03-10 02:23:51 +01:00
Makefile.board.dep	examples/suit_update: add vfs storage for native	2022-06-03 08:49:44 +02:00
Makefile.ci	examples/suit_update: blacklist GD32V boards	2023-04-18 06:20:14 +02:00
Makefile.suit.custom	examples/suit_update: adapt python test to native	2022-06-03 08:49:44 +02:00
native_steps.svg	examples/suit_update: Add compatibility with native	2021-07-08 10:32:58 +02:00
README.hardware.md	makefiles/suit: place keys in $XDG_DATA_HOME	2022-06-02 13:07:17 +02:00
README.md	makefiles/suit: place keys in $XDG_DATA_HOME	2022-06-02 13:07:17 +02:00
README.native.md	examples/suit_update: add vfs storage for native	2022-06-03 08:49:44 +02:00

README.md

Overview

This example shows how to integrate SUIT-compliant firmware updates into a RIOT application. It implements basic support of the SUIT architecture using the manifest format specified in draft-ietf-suit-manifest-09.

WARNING: This code should not be considered production ready for the time being. It has not seen much exposure or security auditing.

This document describes the preliminary requirements for using the SUIT workflow to update binaries on RIOT.

Table of Contents:

Prerequisites
- Signing key management
workflows

Prerequisites

Install python dependencies (only Python3.6 and later is supported):
```
$ pip3 install --user cbor2 cryptography
```
Install aiocoap from the source
```
$ pip3 install --user aiocoap[linkheader]>=0.4.1
```
See the aiocoap installation instructions for more details.
add ~/.local/bin to PATH

The aiocoap tools are installed to ~/.local/bin. Either add "export PATH=$PATH:~/.local/bin" to your ~/.profile and re-login, or execute that command in every shell you use for this tutorial.

Clone this repository:

$ git clone https://github.com/RIOT-OS/RIOT
$ cd RIOT

In all hardware-based setup below, ethos (EThernet Over Serial) is used to provide an IP link between the host computer and a board.

Just build ethos and uhcpd with the following commands:
```
$ make -C dist/tools/ethos clean all
$ make -C dist/tools/uhcpd clean all
```
It is possible to interact with the device over it's serial terminal as usual using make term, but that requires an already set up tap interface. See [update] for more information.

Key Management

SUIT keys consist of a private and a public key file, stored in $(SUIT_KEY_DIR). Similar to how ssh names its keyfiles, the public key filename equals the private key file, but has an extra .pub appended.

SUIT_KEY_DIR defaults to the keys/ folder in $XDG_DATA_HOME/RIOT (usually ~/.local/share/RIOT/keys).

If the chosen key doesn't exist, it will be generated automatically. That step can be done manually using the suit/genkey target.

Workflows

Two workflows are available with this example. The first one demonstrates the SUIT workflow on a RIOT native instance on Linux. The workflow described aims to update the firmware on real-world hardware.