Add SECURITY.md with private vulnerability reporting path#9202
Open
CryptoJones wants to merge 1 commit into
Open
Add SECURITY.md with private vulnerability reporting path#9202CryptoJones wants to merge 1 commit into
CryptoJones wants to merge 1 commit into
Conversation
Documents the private GitHub Security Advisory reporting channel, the scope (what counts as a security issue and what doesn't), and the expected response and disclosure flow. Aligns with the existing 'Security Advisories' link already present in README.md and gives reporters a discoverable starting point at the root of the repo. No code changes. The repo's GitHub Security Advisories page already exists; this file makes the reporting path findable from the root.
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.
Summary
Adds a root-level
SECURITY.mddocumenting:Why
Ghidra parses adversary-controlled binaries and ships a network-reachable server, but the repo currently has no
SECURITY.md. The "Security Advisories" link in the README points to the right place, but there is no discoverable file at the root telling a researcher how to file a private report.GitHub's "Security policy" surface (the badge that appears on a repo's main page and on every issue page) is wired off
SECURITY.md. Adding one improves discoverability for reporters who arrive cold and may otherwise file a public issue.Comparable projects already publish one:
Scope of this PR
Documentation only. No code, build, CI, or workflow changes.
The repo's existing GitHub Security Advisories page is unchanged; this PR just makes the reporting path findable.
Test plan
SECURITY.md.Notes for review
I'm happy to amend wording to match existing project voice or to update the email / contact path if there is a maintainer-preferred channel beyond the GHSA report. The current text intentionally avoids putting an email address inline — the GHSA path is the simplest and most auditable.