SYNOPSIS

usage: SWUGenerator [-h] [-K ENCRYPTION_KEY_FILE] [-k SIGN] [-s SW_DESCRIPTION]

[-a ARTIFACTORY] [-o SWU_FILE] [-c CONFIG] command

Generator SWU Packages for SWUpdate

positional arguments:

command:

{create,sign,extract,mender} command to be executed

create creates a SWU file sign signs an existing SWU file provided by -i extract extracts the files of an existing SWU file provided by -i mender wraps an existing SWU file provided by -i into a Mender Artifact

optional arguments:

-h, --help

show this help message and exit

-K ENCRYPTION_KEY_FILE, --encryption-key-file ENCRYPTION_KEY_FILE

AES Key to encrypt artifacts

-n, --no-compress

Do not compress files

-e, --no-encrypt

Do not encrypt files, for artifacts that are already encrypted. encrypted and ivt are kept as set in sw-description

-x, --no-ivt

Do not generate IV when encrypting

--keep-names

Store encrypted artifacts under their name, without the suffix .enc in the SWU and in sw-description

-y, --no-hash

Do not store sha256 hash in sw-description

-k SIGN, --sign SIGN

RSA key or certificate to sign the SWU

-s SW_DESCRIPTION, --sw-description SW_DESCRIPTION

sw-description template for the create command

-t, --encrypt-swdesc

Encrypt sw-description

-a ARTIFACTORY, --artifactory ARTIFACTORY

list of directories where artifacts are searched

-o SWU_FILE, --swu-file SWU_FILE

SWU output file, required for create, sign and mender

-c CONFIG, --config CONFIG

configuration file

The sign, extract and mender commands read an existing SWU, given with -i/–swu-in-file after the command.

Description

swugenerator is a tool running on host to create and modify SWUpdate’s Update files (SWU). SWU file contains a meta description of the release (sw-description), and swugenerator adds components to a template passed from command line. This tool requires openssl to run and to sign the SWU. It is goal of the tool to fill the gap with Yocto/OE, where SWU generation is done by classes in the meta-swupdate layer, but other buildsystems like Debian or Buildroot have no tools to create a SWU.

The tool signs the SWU and can encrypt the artifacts. The tool parses the sw-description, in libconfig or in JSON (a sw-description starting with {), and provides the following features:

• replace occurrencies of variables found in the CONFIG file

• add sha256 to each artifact

• check if an artifact should be encrypted and encrypts it

• sign sw-description with one of the methods accepted by SWUpdate

• pack all artifacts into a SWU file

It maybe run in two steps to create an unsigned swu file and then sign it later in a second call:

swugenerator -o output.swu -a . -s sw-description.in create
swugenerator -o signed_output.swu -k CMS,key.pem,ca.crt sign -i output.swu

swugenerator -o output.swu -a . -s sw-description.in \
    -k CMS,rsa.key,rsa.crt -k CMS,mldsa.key,mldsa.crt --cms-md sha512 create

swugenerator extract -i output.swu -d outdir

swugenerator -o update.mender mender -i signed_output.swu -D board-a -D board-b -N release-2

-i, --swu-in-file SWU_IN_FILE
                      SWU to wrap
-D, --device-type DEVICE_TYPE
                      compatible device type, can be repeated
-N, --artifact-name ARTIFACT_NAME
                      artifact name, default: version in sw-description
-T, --payload-type PAYLOAD_TYPE
                      payload type, default: swu
-C, --compression {gzip,xz,none}
                      compression of header and payload, default: gzip

Installation

To install swugenerator clone the repository, and from the main project folder run pip (pip3 required): For new Linux distributions, replace it with pipx.

pip install .

To uninstall:

pip uninstall swugenerator