addressed review comments #57
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Wolfboot keytools test workflow | |
| on: | |
| push: | |
| branches: [ 'master', 'main', 'release/**' ] | |
| pull_request: | |
| branches: [ '*' ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: true | |
| # ECC | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Build wolfboot | |
| run: | | |
| make SIGN=ECC256 HASH=SHA256 | |
| - name: Remove default keystore | |
| run: | | |
| rm -f src/keystore.c | |
| - name: Generate external key | |
| run: | | |
| openssl ecparam -name prime256v1 -genkey -noout -outform DER -out private-key.der | |
| - name: Export external public key | |
| run: | | |
| openssl ec -in private-key.der -inform DER -pubout -out public-key.der -outform DER | |
| - name: Import external public key | |
| run: | | |
| ./tools/keytools/keygen --ecc256 -i public-key.der | |
| - name: Hash the image elf | |
| run: | | |
| ./tools/keytools/sign --ecc256 --sha-only --sha256 test-app/image.elf public-key.der 1 | |
| - name: Sign the digest with the external key | |
| run: | | |
| openssl pkeyutl -sign -keyform der -inkey private-key.der -in test-app/image_v1_digest.bin > test-app/image_v1.sig | |
| - name: Generate final signed binary | |
| run: | | |
| ./tools/keytools/sign --ecc256 --sha256 --manual-sign test-app/image.elf public-key.der 1 test-app/image_v1.sig | |
| # ED25519 | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Build wolfboot | |
| run: | | |
| make SIGN=ED25519 HASH=SHA256 | |
| - name: Remove default keystore | |
| run: | | |
| rm -f src/keystore.c | |
| - name: Generate external key | |
| run: | | |
| openssl genpkey -algorithm ed25519 -out private-key.der -outform DER | |
| - name: Export external public key | |
| run: | | |
| openssl pkey -in private-key.der -inform DER -pubout -out public-key.der -outform DER | |
| - name: Import external public key | |
| run: | | |
| ./tools/keytools/keygen --ed25519 -i public-key.der | |
| - name: Hash the image elf | |
| run: | | |
| ./tools/keytools/sign --ed25519 --sha-only --sha256 test-app/image.elf public-key.der 1 | |
| - name: Sign the digest with the external key | |
| run: | | |
| openssl pkeyutl -sign -keyform der -inkey private-key.der -rawin -in test-app/image_v1_digest.bin > test-app/image_v1.sig | |
| - name: Generate final signed binary | |
| run: | | |
| ./tools/keytools/sign --ed25519 --sha256 --manual-sign test-app/image.elf public-key.der 1 test-app/image_v1.sig | |
| # RSA | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Build wolfboot | |
| run: | | |
| make SIGN=RSA2048 HASH=SHA256 | |
| - name: Remove default keystore | |
| run: | | |
| rm -f src/keystore.c | |
| - name: Generate external key | |
| run: | | |
| openssl genrsa -out private-key.pem 2048 | |
| - name: Convert to DER | |
| run: | | |
| openssl rsa -in private-key.pem -inform PEM -out private-key.der -outform DER | |
| - name: Export external public key | |
| run: | | |
| openssl rsa -inform DER -outform DER -in private-key.der -out public-key.der -pubout | |
| - name: Import external public key | |
| run: | | |
| ./tools/keytools/keygen --rsa2048 -i public-key.der | |
| - name: Hash the image elf | |
| run: | | |
| ./tools/keytools/sign --rsa2048 --sha-only --sha256 test-app/image.elf public-key.der 1 | |
| - name: Sign the digest with the external key | |
| run: | | |
| openssl pkeyutl -sign -keyform der -inkey private-key.der -in test-app/image_v1_digest.bin > test-app/image_v1.sig | |
| - name: Generate final signed binary | |
| run: | | |
| ./tools/keytools/sign --rsa2048 --sha256 --manual-sign test-app/image.elf public-key.der 1 test-app/image_v1.sig | |
| # SIGN tool options | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Build wolfboot | |
| run: | | |
| make SIGN=ECC256 HASH=SHA256 | |
| - name: Sign without timestamp | |
| run: | | |
| ./tools/keytools/sign --ecc256 --sha256 --no-ts test-app/image.elf wolfboot_signing_private_key.der 2 | |
| # TODO: requires hexdump | |
| #- name: Check that timestamp is not included in the signed image | |
| # run: | | |
| # ! (hexdump -C -n 256 test-app/image_v3_signed.bin |grep "02 00 08 00") | |
| # Universal keystore | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Generate external RSA2048 key | |
| run: | | |
| openssl genrsa -out private-key.pem 2048 | |
| - name: Convert to DER | |
| run: | | |
| openssl rsa -in private-key.pem -inform PEM -out private-key.der -outform DER | |
| - name: Export external public key | |
| run: | | |
| openssl rsa -inform DER -outform DER -in private-key.der -out public-rsa2048-key.der -pubout | |
| - name: Add different keys to the keystore (two generated ECC with different curves, one imported RSA) | |
| run: | | |
| ./tools/keytools/keygen --rsa2048 -i public-rsa2048-key.der --ecc256 -g wolfboot_signing_private_key.der --ecc384 -g ecc384-priv-key.der | |
| - name: Build wolfboot with universal keystore | |
| run: | | |
| make SIGN=ECC256 HASH=SHA256 WOLFBOOT_UNIVERSAL_KEYSTORE=1 | |
| # keygen option: masks | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Run keygen with no specific mask | |
| run: | | |
| ./tools/keytools/keygen --ecc256 -g wolfboot_signing_private_key.der | grep "mask" | grep "ffffffff" | |
| - name: Delete generated key | |
| run: | | |
| rm -f wolfboot_signing_private_key.der | |
| - name: Remove generated keystore | |
| run: | | |
| rm -f src/keystore.c | |
| - name: Run keygen with --id 0 | |
| run: | | |
| ./tools/keytools/keygen --id 0 --ecc256 -g wolfboot_signing_private_key.der | grep "mask" | grep "00000001" | |
| - name: Delete generated key | |
| run: | | |
| rm -f wolfboot_signing_private_key.der | |
| - name: Remove generated keystore | |
| run: | | |
| rm -f src/keystore.c | |
| - name: Run keygen with test id set | |
| run: | | |
| ./tools/keytools/keygen --id 1,3,5,10,11,13,14 --ecc256 -g wolfboot_signing_private_key.der | grep "mask" | grep "00006c2a" | |
| # Custom TLVs | |
| - name: make clean | |
| run: | | |
| make distclean | |
| - name: Select config | |
| run: | | |
| cp config/examples/sim.config .config && make include/target.h | |
| - name: Build tools | |
| run: | | |
| make -C tools/keytools && make -C tools/bin-assemble | |
| - name: Build wolfboot with ECC256/SHA256 | |
| run: | | |
| make SIGN=ECC256 HASH=SHA256 | |
| - name: Sign app with custom numeric TLV included | |
| run: | | |
| ./tools/keytools/sign --ecc256 --sha256 --custom-tlv 0x45 4 0x6f616943 test-app/image.elf wolfboot_signing_private_key.der 2 | |
| grep "Ciao" test-app/image_v2_signed.bin | |
| - name: Sign app with custom buffer TLV included | |
| run: | | |
| ./tools/keytools/sign --ecc256 --sha256 --custom-tlv-buffer 0x46 48656C6C6F20776F726C64 test-app/image.elf wolfboot_signing_private_key.der 3 | |
| grep "Hello world" test-app/image_v3_signed.bin | |
| - name: Sign app with custom string TLV included | |
| run: | | |
| ./tools/keytools/sign --ecc256 --sha256 --custom-tlv-string 0x46 "Hello world" test-app/image.elf wolfboot_signing_private_key.der 3 | |
| grep "Hello world" test-app/image_v3_signed.bin | |