docs: add SECURITY.md with private vulnerability reporting policy#1675
Merged
Conversation
Document the supported channel for security reports: GitHub's private vulnerability reporting feature (/security/advisories/new). The policy also names scope and out-of-scope cases, so reports about "a malicious LAN peer can send packets" don't get filed as embargoed advisories. Cross-reference from CLAUDE.md so an LLM acting on a user- reported vulnerability points the user at the private route instead of opening a public issue, PR, or commit naming the affected code path.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1675 +/- ##
=======================================
Coverage 99.76% 99.76%
=======================================
Files 33 33
Lines 3401 3401
Branches 461 461
=======================================
Hits 3393 3393
Misses 5 5
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Merged
3 tasks
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
1 participant
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
Add a
SECURITY.mdthat directs vulnerability reports through GitHub's private vulnerability reporting, so reporters have a documented private channel and aren't tempted to open a public issue or PR. Cross-reference the policy fromCLAUDE.mdso future LLM-assisted contributions route reports the same way.Details
SECURITY.md— top-level file (where GitHub's Security tab looks for it). Names the supported channel, supported versions (latest0.x), and an in-scope / out-of-scope list grounded in the project's actual attack surface: crafted mDNS / DNS-SD packets throughDNSIncoming, cache, registry, listener callbacks; logic bugs that cross interface boundaries or hijack a name; build/packaging pipeline (build_ext.py, wheel contents, signed-release flow). Out of scope: things that are expected behaviour per RFC 6762 §21 (mDNS is unauthenticated by design).CLAUDE.md— new## Reporting security issuessection between the build conventions and the entry-points table. Tells the LLM contributor not to open a public issue, PR, or commit naming the bug class and the affected code path when a user describes a suspected vulnerability; instead, point them atSECURITY.md/ the private-reporting URL.Test plan
SECURITY.mdis discoverable via GitHub's Security tab after merge (/security/policyresolves)./security/advisories/new.lintandcommitlintjobs are green.