README.md

suit-generator

Implementation of SUIT envelope generator based on input yaml or json string.

Installation

git clone https://github.com/NordicSemiconductor/suit-generator.git
cd suit-generator
pip install .

Testing

pip install -r tests/requirements-test.txt
cd suit-generator/tests
pytest

Basic usage

suit-generator --help

Envelope creation

cd examples/input_files
dd if=/dev/zero of=file.bin bs=1024 count=1
suit-generator create --input-file example/input_files/envelope_1.json --output-file envelope.suit

Key generation

suit-generator keys --output-file key

Key conversion

suit-generator convert --input-file key_private.pem --output-file key_public.c

Adding signature

suit-generator sign --input-file envelope.suit --output-file envelope_signed.suit --private-key key_private.pem

Package build and release

python setup.py --version
git tag vX.Y.Z
python -m build

Documentation build

pip install ./
pip install -r doc/requirements-doc.txt
sphinx-build -b html doc/source/ doc/build/html