Sign and Verify RPI PICO UF2 Firmware Binaries¶
picosign is a Python boot tool for signing and verifying Raspberry Pi Pico UF2 firmware binaries.
Developed in python code.
The README is used to introduce the tool and provide instructions on how to install the tool, any machine dependencies it may have and any other information that should be provided before the tool is installed.
🚀 Installation¶
Navigate to release page download and extract release archive.
To install picosign type the following
tar xvzf picosign-x.y.z.tar.gz
cd picosign-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/picosign-*-py3-none-any.whl
rm -f get-pip.py
You can use pip to install directly:
# python3
pip3 install picosign
📦 Dependencies¶
picosign requires next modules and libraries:
📁 Tool structure¶
picosign is based on OOP and Hexagonal Architecture (Ports & Adapters).
Tool structure:
picosign/
├── core/
│ ├── __init__.py
│ ├── model/
│ │ ├── __init__.py
│ │ └── signature_data.py
│ └── service/
│ ├── engine.py
│ ├── __init__.py
│ ├── iservice.py
│ └── isubprocessor.py
├── engine.py
├── infrastructure/
│ ├── cli/
│ │ ├── engine.py
│ │ ├── icli.py
│ │ ├── __init__.py
│ │ └── setup/
│ │ ├── bundle.py
│ │ ├── dep_validator.py
│ │ ├── dependencies.py
│ │ ├── factory.py
│ │ ├── __init__.py
│ │ ├── keys.py
│ │ ├── opt_validator.py
│ │ ├── options.py
│ │ ├── registry.py
│ │ └── validator.py
│ ├── command/
│ │ ├── command.py
│ │ ├── icommand_definition.py
│ │ ├── icommand_executor.py
│ │ ├── __init__.py
│ │ ├── read_command_definition.py
│ │ ├── read_command_executor.py
│ │ ├── sign_command_definition.py
│ │ └── sign_command_executor.py
│ ├── config/
│ │ ├── picosign.cfg
│ │ └── picosign.logo
│ ├── __init__.py
│ └── subprocessor.py
├── __init__.py
├── py.typed
└── setup/
├── bundle.py
├── dep_validator.py
├── dependencies.py
├── factory.py
├── __init__.py
├── keys.py
├── opt_validator.py
├── options.py
├── registry.py
└── validator.py
10 directories, 45 files
✨ Features¶
Adds and reads textual signatures from 220-byte padding in the first 512-byte block of UF2 binaries.
Validates UF2 block boundaries and magic header constants.
Provides a modular and extensible architecture based on OOP and SOLID principles.
Includes command line interface (CLI) support via a command/executor structure.
Robust validation of project bundles, dependencies, and options.
High code quality with full type checking and 100% unit test coverage.
📊 Code coverage¶
Name |
Stmts |
Miss |
Cover |
|---|---|---|---|
picosign/__init__.py |
9 |
0 |
100% |
picosign/core/__init__.py |
9 |
0 |
100% |
picosign/core/model/__init__.py |
9 |
0 |
100% |
picosign/core/model/signature_data.py |
15 |
0 |
100% |
picosign/core/service/__init__.py |
9 |
0 |
100% |
picosign/core/service/engine.py |
29 |
0 |
100% |
picosign/core/service/iservice.py |
14 |
0 |
100% |
picosign/core/service/isubprocessor.py |
14 |
0 |
100% |
picosign/engine.py |
57 |
0 |
100% |
picosign/infrastructure/__init__.py |
9 |
0 |
100% |
picosign/infrastructure/cli/__init__.py |
9 |
0 |
100% |
picosign/infrastructure/cli/engine.py |
43 |
0 |
100% |
picosign/infrastructure/cli/icli.py |
15 |
0 |
100% |
picosign/infrastructure/cli/setup/__init__.py |
9 |
0 |
100% |
picosign/infrastructure/cli/setup/bundle.py |
22 |
0 |
100% |
picosign/infrastructure/cli/setup/dep_validator.py |
36 |
0 |
100% |
picosign/infrastructure/cli/setup/dependencies.py |
18 |
0 |
100% |
picosign/infrastructure/cli/setup/factory.py |
40 |
0 |
100% |
picosign/infrastructure/cli/setup/keys.py |
26 |
0 |
100% |
picosign/infrastructure/cli/setup/opt_validator.py |
34 |
0 |
100% |
picosign/infrastructure/cli/setup/options.py |
15 |
0 |
100% |
picosign/infrastructure/cli/setup/registry.py |
31 |
0 |
100% |
picosign/infrastructure/cli/setup/validator.py |
43 |
0 |
100% |
picosign/infrastructure/command/__init__.py |
9 |
0 |
100% |
picosign/infrastructure/command/command.py |
16 |
0 |
100% |
picosign/infrastructure/command/icommand_definition.py |
14 |
0 |
100% |
picosign/infrastructure/command/icommand_executor.py |
14 |
0 |
100% |
picosign/infrastructure/command/read_command_definition.py |
26 |
0 |
100% |
picosign/infrastructure/command/read_command_executor.py |
29 |
0 |
100% |
picosign/infrastructure/command/sign_command_definition.py |
26 |
0 |
100% |
picosign/infrastructure/command/sign_command_executor.py |
29 |
0 |
100% |
picosign/infrastructure/subprocessor.py |
101 |
0 |
100% |
picosign/setup/__init__.py |
9 |
0 |
100% |
picosign/setup/bundle.py |
23 |
0 |
100% |
picosign/setup/dep_validator.py |
36 |
0 |
100% |
picosign/setup/dependencies.py |
19 |
0 |
100% |
picosign/setup/factory.py |
43 |
0 |
100% |
picosign/setup/keys.py |
27 |
0 |
100% |
picosign/setup/opt_validator.py |
34 |
0 |
100% |
picosign/setup/options.py |
12 |
0 |
100% |
picosign/setup/registry.py |
32 |
0 |
100% |
picosign/setup/validator.py |
48 |
0 |
100% |
Total |
1062 |
0 |
100% |
🛠 Usage¶
Install package
pip3 install picosign
Embed signature into a UF2 firmware binary:
python3 main.py sign --file firmware.uf2 --signature "AUTHOR: Vladimir Roncevic | VERSION: 1.0.0"
Read signature from a UF2 firmware binary:
python3 main.py read --file firmware.uf2
📚 Docs¶
More documentation and info at:
👥 Contributing¶
📄 Copyright and licence¶
Copyright (C) 2026 by vroncevic.github.io/picosign
picosign is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 3.x or, at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
