RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity
630b14b322
RIOT/examples/suit_update/README.md
Benjamin Valentin 5e52d15409 makefiles/suit: place keys in $XDG_DATA_HOME 
Placing the SUIT key in the RIOT repository folder is dangerous as
a repo checkout is by most people considered a volatile location.
Since all important files are stored in git, deleting the entire folder
or it's contents is not an uncommon cleanup operation.

If the user is at that point unaware that SUIT key material is stored
in that folder, that key will then be lost.

Another workflow may involve multiple checkouts of the RIOT repository
to multiple folders to work on several features at the same time, or for
easy cross-referencing or splitting of off features from an integration
into a feature branch.
In that case each checkout would use it's own incompatible SUIT key.

To avoid all these pitfalls, place the SUIT keys outside the RIOT
repository in the $XDG_DATA_HOME directory.
2022-06-02 13:07:17 +02:00

2.6 KiB
Raw Blame History

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

  • 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.