# sbabic/swugenerator architecture

> Architecture diagram of the GitHub repository sbabic/swugenerator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sbabic/swugenerator
- Repository: https://github.com/sbabic/swugenerator

## Overview

swugenerator is a host-side SWUpdate package tool. Its main workflow parses a create command, processes a libconf sw-description template and artifacts, then writes a SWU archive; users can also sign an existing archive in a separate command. The graph distinguishes template preparation, artifact transformation, archive handling, and signing. Core source modules are represented; edges are limited to calls shown in excerpts or capabilities and relationships explicitly documented by the README.

Main entry points: [`swugenerator/swu_sign.py`](https://github.com/sbabic/swugenerator/blob/main/swugenerator/swu_sign.py) (Signing methods), [`swugenerator/main.py`](https://github.com/sbabic/swugenerator/blob/main/swugenerator/main.py) (CLI commands), [`swugenerator/generator.py`](https://github.com/sbabic/swugenerator/blob/main/swugenerator/generator.py) (Template processor), [`swugenerator/signer.py`](https://github.com/sbabic/swugenerator/blob/main/swugenerator/signer.py) (Existing SWU signer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Command interface"]
  node_cli["CLI commands<br/>[main.py]"]
  node_metadata["Package metadata<br/>[__about__.py]"]
end

subgraph group_creation["Package creation"]
  node_generator["Template processor<br/>[generator.py]"]
  node_artifact["Artifact processing<br/>[artifact.py]"]
end

subgraph group_archive["Archive handling"]
  node_swu_writer["SWU archive writer<br/>[swu_file.py]"]
end

subgraph group_signing["Signing"]
  node_existing_signer["Existing SWU signer<br/>[signer.py]"]
  node_sign_methods["Signing methods<br/>[swu_sign.py]"]
end

node_user(("Operator"))
node_openssl["OpenSSL"]
node_pkcs11["PKCS&#35;11 tool"]
node_custom_signer["Custom signer"]
node_swu_output["SWU package"]

node_user -->|"runs command"| node_cli
node_cli -->|"reads version"| node_metadata
node_cli -->|"creates package"| node_generator
node_cli -->|"signs archive"| node_existing_signer
node_generator -->|"processes files"| node_artifact
node_generator -->|"adds artifacts"| node_swu_writer
node_generator -->|"signs description"| node_sign_methods
node_artifact -->|"encrypts files"| node_openssl
node_existing_signer -->|"extracts and repacks"| node_swu_writer
node_existing_signer -->|"signs description"| node_sign_methods
node_sign_methods -->|"runs OpenSSL"| node_openssl
node_sign_methods -->|"runs tool"| node_pkcs11
node_sign_methods -->|"runs command"| node_custom_signer
node_swu_writer -->|"writes archive"| node_swu_output
node_existing_signer -->|"writes archive"| node_swu_output

click node_cli "https://github.com/sbabic/swugenerator/blob/main/swugenerator/main.py"
click node_metadata "https://github.com/sbabic/swugenerator/blob/main/swugenerator/__about__.py"
click node_generator "https://github.com/sbabic/swugenerator/blob/main/swugenerator/generator.py"
click node_artifact "https://github.com/sbabic/swugenerator/blob/main/swugenerator/artifact.py"
click node_swu_writer "https://github.com/sbabic/swugenerator/blob/main/swugenerator/swu_file.py"
click node_existing_signer "https://github.com/sbabic/swugenerator/blob/main/swugenerator/signer.py"
click node_sign_methods "https://github.com/sbabic/swugenerator/blob/main/swugenerator/swu_sign.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_metadata toneBlue
class node_generator,node_artifact toneAmber
class node_swu_writer toneMint
class node_existing_signer,node_sign_methods toneRose
class node_user,node_openssl,node_pkcs11,node_custom_signer,node_swu_output toneIndigo
```

## Components

### Command interface

- [CLI commands](https://github.com/sbabic/swugenerator/blob/main/swugenerator/main.py): `swugenerator/main.py`
- [Package metadata](https://github.com/sbabic/swugenerator/blob/main/swugenerator/__about__.py): `swugenerator/__about__.py`

### Package creation

- [Template processor](https://github.com/sbabic/swugenerator/blob/main/swugenerator/generator.py): `swugenerator/generator.py`
- [Artifact processing](https://github.com/sbabic/swugenerator/blob/main/swugenerator/artifact.py): `swugenerator/artifact.py`

### Archive handling

- [SWU archive writer](https://github.com/sbabic/swugenerator/blob/main/swugenerator/swu_file.py): `swugenerator/swu_file.py`

### Signing

- [Existing SWU signer](https://github.com/sbabic/swugenerator/blob/main/swugenerator/signer.py): `swugenerator/signer.py`
- [Signing methods](https://github.com/sbabic/swugenerator/blob/main/swugenerator/swu_sign.py): `swugenerator/swu_sign.py`

### Other components

- **Operator**
- **OpenSSL**
- **PKCS#11 tool**
- **Custom signer**
- **SWU package**

## Connections

- Operator → CLI commands: runs command (evidence: `README.rst`)
- CLI commands → Package metadata: reads version (evidence: `swugenerator/main.py`)
- CLI commands → Template processor: creates package (evidence: `swugenerator/main.py`)
- CLI commands → Existing SWU signer: signs archive (evidence: `swugenerator/main.py`)
- Template processor → Artifact processing: processes files (evidence: `swugenerator/generator.py`)
- Template processor → SWU archive writer: adds artifacts (evidence: `swugenerator/generator.py`)
- Template processor → Signing methods: signs description (evidence: `swugenerator/generator.py`)
- Artifact processing → OpenSSL: encrypts files (evidence: `swugenerator/artifact.py`)
- Existing SWU signer → SWU archive writer: extracts and repacks (evidence: `swugenerator/signer.py`)
- Existing SWU signer → Signing methods: signs description (evidence: `swugenerator/signer.py`)
- Signing methods → OpenSSL: runs OpenSSL (evidence: `swugenerator/swu_sign.py`)
- Signing methods → PKCS#11 tool: runs tool (evidence: `swugenerator/swu_sign.py`)
- Signing methods → Custom signer: runs command (evidence: `swugenerator/swu_sign.py`)
- SWU archive writer → SWU package: writes archive
- Existing SWU signer → SWU package: writes archive (evidence: `swugenerator/signer.py`)
