Repository navigation
📝 docs(security): add a threat model and align the policy - #36
Merged
Merged
Conversation
gaborbernat
added
documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
github-workflows had no threat model, so whether a report is a vulnerability or a bug was decided case by case at triage. 🛡️ This adds a threat model and rewrites the security policy around it, so a reporter and a maintainer reach the same verdict from the same page.
The threat model lists what github-workflows trusts, the untrusted inputs with the guarantee github-workflows makes for each, the STRIDE threats and their controls, the release chain, severity ratings, accepted risks, and a table of example reports with their verdicts. The boundary follows comparable tools in other ecosystems: slsa-github-generator (GitHub Actions), GitHub Actions hardening guide (Actions), GoReleaser (Go). The shared rule is the one the Node.js threat model states: a report that first needs a trusted element compromised is a bug, not a vulnerability.
.github/SECURITY.mdis new: private vulnerability reporting, response targets, the supported-versions rule and the in-scope and out-of-scope lists. Every repository in this rollout except pipx, virtualenv and build gets the same layout in its own draft PR.