chore: add SECURITY.md (private vulnerability reporting policy)#267
Open
eddieran wants to merge 1 commit into
Open
chore: add SECURITY.md (private vulnerability reporting policy)#267eddieran wants to merge 1 commit into
eddieran wants to merge 1 commit into
Conversation
Adds a draft security policy modeled on GitHub's 'Suggest a security policy' workflow. The most important part is documenting a private reporting channel so researchers can responsibly disclose findings. Maintainers should feel free to edit any section.
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.
Why
MaxKey currently has no
SECURITY.md. GitHub's Security tab shows the "Suggest a security policy" prompt for exactly this case. This PR is that suggestion.For an IAM/SSO product specifically, having a structured private-disclosure channel is especially important — protocol-level issues (SAML/OAuth2/OIDC/CAS) come up regularly in IAM products and shouldn't be posted publicly before a fix lands.
What
Adds a draft
SECURITY.mdat the repo root, modelled on GitHub's standard template with sections tailored for an IAM/SSO project (the in-scope list highlights SAML/OAuth2/OIDC/CAS protocol flaws, JWT issues, password-reset/MFA bypass, SSRF in IdP metadata fetching, etc.).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.
Companion issue
See #266 for the request to enable PVR. This PR is the
SECURITY.mdhalf; merging this and enabling PVR together unblocks structured private disclosure.Thanks for considering!