chore: add SECURITY.md (private vulnerability reporting policy) - #129
Open
eddieran wants to merge 1 commit into
Open
chore: add SECURITY.md (private vulnerability reporting policy)#129eddieran wants to merge 1 commit into
eddieran wants to merge 1 commit into
Conversation
mayfly-go currently has no security policy on file. GitHub's "Suggest a security policy" workflow flags this and offers researchers a friction-free way to send a draft PR. This is that draft. It documents: - The preferred private channel: GitHub Private Vulnerability Reporting (https://github.com/dromara/mayfly-go/security/advisories/new) once enabled in *Settings → Code security → Private vulnerability reporting*. - A fallback email channel — placeholder for the maintainer to fill in. - What a good report should include. - Scope and supported versions. - Triage / coordinated-disclosure expectations. Maintainers should feel free to edit any section. The important thing is that a private reporting channel exists so researchers can submit findings responsibly without having to choose between "stay silent" and "post to a public issue." Refs dromara#128.
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.
Why
mayfly-go currently has no
SECURITY.md. GitHub's Security and quality tab shows the "Suggest a security policy" prompt for exactly this case (https://github.com/dromara/mayfly-go/security/policy). This PR is that suggestion.What
Adds a draft
SECURITY.mdat the repo root, modelled on the dromara org's other projects + the standard GitHub template.The most important part is documenting a private reporting channel so security researchers can responsibly disclose findings without having to choose between staying silent and posting to a public issue. The draft points at GitHub's Private Vulnerability Reporting (PVR) feature as the preferred channel, with an email fallback that maintainers can fill in.
Suggested action by maintainers after merge:
SECURITY.mdto point at the maintainer's preferred address.Sections in the draft:
Maintainers should feel free to edit any section — the important thing is that a private channel exists.
Why I'm sending this
I have a coordinated security disclosure ready for mayfly-go and would like to file via PVR once it's enabled. See companion issue #128 for context. As soon as this PR lands and PVR is on, I'll file the report through the structured channel — the finding has a concrete PoC and suggested patch, just waiting on the channel.
For broader context, this is part of a wider coordinated-disclosure campaign that has filed 20 GHSAs across 9 maintainer orgs over the past two weeks; all are in
triage, none have been published or weaponized.Thanks for considering!