SWUGENERATOR(1)

💖 NAME 💖

okay bestie, meet swugenerator — section 1 of the manual, host-side icon behavior only ✨

swugenerator — generate SWUpdate bundles from a manifest

🎀 Name 🎀

swugenerator —

A host tool to generate SWU update package for SWUpdate. fr fr that's the whole job description and she does it gorgeously 💅

---

🌸 SYNOPSIS 🌸

here's the whole vibe at a glance:

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 — the thing you're telling her to do, and you gotta pick one:
  • {create,sign} — command to be executed
    • create — creates a SWU file
    • sign — signs an existing SWU file provided by -i

👑 optional arguments 👑

• -h, --help — show this help message and exit. the classic. she's always there for u 🫶
• -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
• -x, --no-ivt — Do not generate IV when encrypting
• -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
• -i,--swu-in-file SWU_IN_FILE — SWU input file to be signed for the sign command
• -c CONFIG, --config CONFIG — configuration file

---

✨ Description ✨

so swugenerator is a tool running on host to create and modify SWUpdate's Update files (SWU). An 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. not her being the main character solving everyone's problems 😭👑

The tool signs the SWU and can encrypt the artifacts. The tool parses the libconf based sw-description and provides the following features:

⚠️ heads up bestie: tool does not work for JSON based sw-description — libconf only, no cap 💀

• 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 -i output.swu -k CMS,key.pem,ca.crt sign

two-step era, the way that she lets you split create and sign is honestly so considerate 🌈

---

🧚 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

---

and that's the whole page bestie, hope it slayed 💜 shine on — the source/version slot and the date slot on this page are literally just sitting there as swugenerator() with nothing in them, staying mysterious, and honestly? iconic. ✨🎀