Merge pull request #47 from TheMaxMur/develop

Release v0.4.0

Author: TheMaxMur

.cargo/config.toml

@@ -9,4 +9,6 @@ rustflags = [
   "-C", "link-arg=--nmagic",
   "-C", "link-arg=-Tlink.x",
   "-C", "target-cpu=cortex-m33",
+  "--cfg", "bp256_backend=\"bigint\"",
+  "--cfg", "bp384_backend=\"bigint\"",
 ]

.github/workflows/ci.yml

@@ -100,6 +100,21 @@ jobs:
           - name: display
             args: "--features display"
             env: "LED_KIND=none FLASH_SIZE=16M"
+          # Flash-geometry siblings of the default image (default features, RS-Key
+          # identity). 2mb shrinks KVMAIN so the image still fits ≥1 MiB of code;
+          # smoke-building it here catches a link/fit regression in PR CI rather
+          # than at tag time.
+          - name: 2mb
+            args: ""
+            env: "FLASH_SIZE=2M KVMAIN=896K"
+          - name: 16mb
+            args: ""
+            env: "FLASH_SIZE=16M"
+          # The strict admin-write posture (historical default). The permissive
+          # default is what every other row builds; smoke-build this so the
+          # strict-gated code keeps compiling.
+          - name: strict-config
+            args: "--features strict-config"
     runs-on: ubuntu-latest
     timeout-minutes: 60
     steps:

.github/workflows/deep-checks.yml

@@ -8,6 +8,9 @@
 #   fuzz — a timed libFuzzer pass over every cargo-fuzz target. The corpus
 #          is carried between runs via the actions cache, so its coverage
 #          accumulates day over day; crash artifacts are uploaded.
+#   fuzz-coverage — per-target libFuzzer region/line coverage over that
+#          accumulated corpus (scripts/fuzz-coverage.sh): a summary table on the
+#          step page and the per-target HTML uploaded. Advisory, not a gate.
 #   kani — the #[kani::proof] bounded model-checking harnesses (docs/
 #          testing.md). Kani is not in nixpkgs and its setup downloads a
 #          prebuilt CBMC bundle, so this one job is rustup-based, not nix.
@@ -26,6 +29,7 @@
 # and self-tests on any push that edits this file. Local equivalents:
 #   nix develop .#fuzz -c cargo miri test --manifest-path fuzz/Cargo.toml
 #   nix develop .#fuzz -c cargo fuzz run <target> -- -max_total_time=120
+#   nix develop .#fuzz -c ./scripts/fuzz-coverage.sh
 #   cargo kani -p rsk-sdk -p rsk-fs -p rsk-rsa-asm -p rsk-crypto -p rsk-mldsa -p rsk-rescue -p rsk-openpgp -p rsk-otp -p rsk-piv -p rsk-oath -p rsk-usb  (cargo install kani-verifier)
 #   nix develop -c cargo llvm-cov --summary-only --fail-under-lines 80 --target <host> -p rsk-sdk … -p rsk-slip39
 #   nix develop -c ./scripts/complexity_gate.sh
@@ -43,7 +47,12 @@ on:
   push:
     branches: [main]
     paths:
-      [".github/workflows/deep-checks.yml", "nix/devshells.nix", "nix/firmware.nix"]
+      [
+        ".github/workflows/deep-checks.yml",
+        "nix/devshells.nix",
+        "nix/firmware.nix",
+        "scripts/fuzz-coverage.sh",
+      ]
 
 permissions:
   contents: read
@@ -146,6 +155,51 @@ jobs:
           path: fuzz/corpus
           key: fuzz-corpus-${{ github.run_id }}
 
+  fuzz-coverage:
+    runs-on: ubuntu-latest
+    timeout-minutes: 120
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+      - uses: DeterminateSystems/nix-installer-action@ef8a148080ab6020fd15196c2084a2eea5ff2d25 # v22
+
+      - uses: nix-community/cache-nix-action@7df957e333c1e5da7721f60227dbba6d06080569 # v7.0.2
+        with:
+          primary-key: nix-fuzz-${{ runner.os }}-${{ hashFiles('flake.lock') }}
+          restore-prefixes-first-match: |
+            nix-fuzz-${{ runner.os }}-
+            nix-${{ runner.os }}-
+
+      # The instrumented coverage build lives in fuzz/coverage/.build (a distinct
+      # target-dir from the fuzzing build), so cache it under its own key.
+      - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            fuzz/coverage/.build
+          key: fuzz-cov-${{ runner.os }}-${{ hashFiles('fuzz/Cargo.lock', 'flake.lock') }}
+          restore-keys: fuzz-cov-${{ runner.os }}-
+
+      # Read (never write) the corpus the `fuzz` job accumulated on the previous
+      # run: coverage measures those saved inputs, not a fresh fuzzing pass.
+      - uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+        with:
+          path: fuzz/corpus
+          key: fuzz-corpus-${{ github.run_id }}
+          restore-keys: fuzz-corpus-
+
+      - name: per-target libFuzzer coverage over the accumulated corpus
+        run: nix develop .#fuzz -c ./scripts/fuzz-coverage.sh
+
+      - name: upload the per-target HTML reports
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: fuzz-coverage-${{ github.run_id }}
+          path: fuzz/coverage/*/html
+          if-no-files-found: ignore
+
   kani:
     runs-on: ubuntu-latest
     timeout-minutes: 120
@@ -230,8 +284,8 @@ jobs:
           nix develop -c cargo llvm-cov --summary-only --fail-under-lines 80 \
             --target x86_64-unknown-linux-gnu \
             -p rsk-sdk -p rsk-fs -p rsk-usb -p rsk-crypto -p rsk-fido -p rsk-openpgp \
-            -p rsk-rsa-asm -p rsk-mgmt -p rsk-oath -p rsk-otp -p rsk-piv -p rsk-rescue \
-            -p rsk-led -p rsk-ui -p rsk-bip39 -p rsk-slip39
+            -p rsk-rsa-asm -p rsk-sha512 -p rsk-ec -p rsk-mldsa -p rsk-mgmt -p rsk-oath -p rsk-otp -p rsk-piv \
+            -p rsk-rescue -p rsk-led -p rsk-ui -p rsk-bip39 -p rsk-slip39 -p rsk-bench
 
   complexity:
     runs-on: ubuntu-latest

.github/workflows/release-build.yml

@@ -12,8 +12,8 @@
 # an inline `attest-build-provenance` step can prove, i.e. Build L2).
 # See https://docs.github.com/actions/security-guides/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3
 #
-# This job: builds the 11 shipped firmware flavors reproducibly via `nix build`,
-# GATES on a bit-identical rebuild of all eleven (a non-reproducible image fails the
+# This job: builds the 14 shipped firmware flavors reproducibly via `nix build`,
+# GATES on a bit-identical rebuild of all fourteen (a non-reproducible image fails the
 # job before anything is published), generates a CycloneDX SBOM, hashes everything
 # into SHA256SUMS, attests GitHub build provenance for every .uf2, signs the
 # checksums with keyless cosign (sigstore/Fulcio via OIDC — no private key), and
@@ -84,20 +84,23 @@ jobs:
           echo "tag=$tag" >> "$GITHUB_OUTPUT"
           echo "version=${tag#v}" >> "$GITHUB_OUTPUT"
 
-      - name: build the 11 reproducible firmware flavors
+      - name: build the 14 reproducible firmware flavors
         run: |
           tag="${{ steps.tag.outputs.tag }}"
           mkdir -p dist
           # The ten touch-required flavors (default/pqc, fips/fips-pqc, the
           # strong-pin PIN-hardening pair, and the always-uv / strict-up behavior
           # pairs) plus the trusted-display flavor (its on-screen Approve/Deny is
-          # the physical-consent gate). `strict-up` ships with a caveat: it is not
-          # spec-conformant for the up:false pre-flight (docs/releases.md). The
-          # `no-touch` flavors auto-confirm user presence (test-only; see
-          # firmware/Cargo.toml "Never ship a no-touch build") and MUST NOT be
-          # published — a signed no-touch asset would remove the physical-consent
-          # gate from an end-user build.
-          for pkg in firmware firmware-pqc firmware-fips firmware-fips-pqc firmware-strong-pin firmware-strong-pin-pqc firmware-always-uv firmware-always-uv-pqc firmware-strict-up firmware-strict-up-pqc firmware-display; do
+          # the physical-consent gate) and the two flash-geometry siblings of the
+          # default image (2mb / 16mb — same features + RS-Key identity, only the
+          # flash map differs, for boards whose chip is not the 4 MB default).
+          # `strict-up` ships with a caveat: it is not spec-conformant for the
+          # up:false pre-flight (docs/releases.md). The `no-touch` flavors
+          # auto-confirm user presence (test-only; see firmware/Cargo.toml
+          # "Never ship a no-touch build") and MUST NOT be published — a signed
+          # no-touch asset would remove the physical-consent gate from an
+          # end-user build.
+          for pkg in firmware firmware-pqc firmware-fips firmware-fips-pqc firmware-strong-pin firmware-strong-pin-pqc firmware-always-uv firmware-always-uv-pqc firmware-strict-up firmware-strict-up-pqc firmware-display firmware-2mb firmware-16mb firmware-strict-config; do
             echo "::group::nix build .#$pkg"
             out="$(nix build ".#$pkg" --no-link --print-out-paths)"
             label="${pkg#firmware}"; label="${label#-}"
@@ -107,17 +110,17 @@ jobs:
           done
           ls -l dist
 
-      - name: reproducibility gate — rebuild all 5, require bit-identical
+      - name: reproducibility gate — rebuild all 14, require bit-identical
         run: |
           # `nix build --rebuild` recompiles the derivation already in the store
           # and fails with a hash mismatch if the output is not bit-identical.
           # A non-reproducible flavor fails here, before the release is created.
-          for pkg in firmware firmware-pqc firmware-fips firmware-fips-pqc firmware-strong-pin firmware-strong-pin-pqc firmware-always-uv firmware-always-uv-pqc firmware-strict-up firmware-strict-up-pqc firmware-display; do
+          for pkg in firmware firmware-pqc firmware-fips firmware-fips-pqc firmware-strong-pin firmware-strong-pin-pqc firmware-always-uv firmware-always-uv-pqc firmware-strict-up firmware-strict-up-pqc firmware-display firmware-2mb firmware-16mb firmware-strict-config; do
             echo "::group::nix build .#$pkg --rebuild"
             nix build ".#$pkg" --rebuild --no-link
             echo "::endgroup::"
           done
-          echo "all 11 flavors rebuilt bit-identical"
+          echo "all 14 flavors rebuilt bit-identical"
 
       - name: generate the CycloneDX SBOM
         run: |