Skip to content

Commit fad0a3a

Browse files
docs(security): document CodeQL and Scorecard automated analysis
Record the repository's automated security analysis in SECURITY.md: CodeQL SAST (manual Go build, runs per-PR/push/weekly, new-alert-on-diff, intended as a required pre-merge check, dismiss-with-reason for false positives) and OpenSSF Scorecard (supply-chain posture, published to the scorecard.dev badge, intentionally not uploaded to code scanning). Mirrors the workflow changes in this PR so the security posture is documented, not just encoded in YAML. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> Signed-off-by: Myasnikov Daniil <[email protected]>
1 parent b600323 commit fad0a3a

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

‎SECURITY.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,21 @@ Public disclosure will typically happen through one or more of the following:
7474
Security is part of the normal Cozystack development and release process. Current project practices include:
7575

7676
- maintainer-owned review through pull requests and `CODEOWNERS`
77-
- automated pull request checks, including pre-commit validation, unit tests, builds, and end-to-end testing
77+
- automated pull request checks, including pre-commit validation, unit tests, builds, end-to-end testing, and static application security testing (CodeQL)
7878
- release automation with patch releases, release branches, and backport workflows
7979
- ongoing maintenance of packaged dependencies and platform integrations across supported release lines
8080

8181
Because Cozystack is an integration-heavy platform, some vulnerabilities may require coordination across multiple repositories or with upstream maintainers before a public fix can be released.
8282

83+
### Automated security analysis
84+
85+
Two scanners run continuously against this repository:
86+
87+
- **CodeQL** (static analysis). Runs on every pull request to `main`, on push to `main`, and on a weekly schedule. The Go database is built with CodeQL's `manual` build mode — each first-party module is compiled explicitly, so the analysis does not depend on the project `Makefile` (which fetches upstream tags) and stays reproducible. On a pull request CodeQL reports only alerts that are *new relative to `main`* and annotates them on the changed lines. New findings are expected to be resolved before merge — either by fixing the code, or, for a false positive or accepted risk, by dismissing the alert in the **Security → Code scanning** tab with a recorded reason (`False positive`, `Won't fix`, or `Used in tests`).
88+
- **OpenSSF Scorecard** (supply-chain posture). Runs weekly and on branch-protection changes, and publishes results to the public Scorecard API at <https://scorecard.dev/viewer/?uri=github.com/cozystack/cozystack>. Scorecard results are intentionally **not** uploaded to GitHub code scanning: it posts one alert per check, which would bury CodeQL's first-party findings. The scorecard.dev badge is the canonical view.
89+
90+
CodeQL is intended to run as a required pull-request check, so that a newly introduced alert at error severity blocks merge until it is fixed or dismissed.
91+
8392
## Security Fixes and Announcements
8493

8594
Security fixes are published in normal release artifacts whenever possible. Users should monitor:

0 commit comments

Comments
 (0)