- set_version.sh: three of its four patterns only matched digits and dots, so FW_VERSION and index.js stayed at v4.0.0.beta and index.html at ?v=3.0.14d. They now match any version, and the script fails when a file doesn't end up with the new one. test/scripts/test_set_version.sh covers it and runs with the native tests. - Release job: each build's files are collected from its own folder, with 4 files each and no name in two builds, before they're signed. The version bump is made on the release's branch as it is now, not the tag, so a merge during the builds doesn't reject the push. - Scorecard reports to code scanning only: publishing from a fork isn't supported, so no badge. - New workflows renamed to .yaml like build.yaml. SECURITY.md: the routes open in Secured mode, and which jobs can write what. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.2 KiB
Security
Reporting a vulnerability
Please don't open a public issue. Report it privately through GitHub's vulnerability reporting and give the firmware version, the board, and the steps to reproduce it.
Fixes go into the latest release only, so check that the problem is still there in it.
The Home Assistant integration has its own repo and its own reporting page.
What the device protects against
The device is meant for a local network. In the Secured mode the socket and every HTTP route need a login, except the few the login page itself needs (the web UI's files, /loginContext, /login, /upnp.xml). The threat model, what is in scope and what isn't, is in docs/SECURITY_PLAN.md and ADR 0006. Don't expose the device to the internet.
Checking a download
Each release file (.bin, .zip) comes with a signed attestation that this repo's build workflow built it from the release's commit. Check one with the GitHub CLI:
gh attestation verify SomfyController.ino.esp32.bin --repo cjkas/ESPSomfy-RTS
Or compare the checksums with the release's SHA256SUMS file:
sha256sum --check --ignore-missing SHA256SUMS
Releases up to 4.0.1 have neither.
How the build is kept clean
- Every action in the workflows is pinned to a commit, the firmware's libraries and the build's Python tools to exact versions. Dependabot proposes action updates after a week's cooldown.
- The workflows can only read the repo's contents. Only the release job can change them (the release's files, the version bump), and it runs no build tools. The scanning jobs can also report to the Security tab, and the coverage job publishes to GitHub Pages.
- CodeQL scans the C++, the web UI, the Python scripts and the workflows on every PR. zizmor lints the workflows, and OpenSSF Scorecard rates the repo's practices. Findings are on the repo's Security tab.