Skip to content

docs(security): direct vulnerability reports to GitHub private reporting - #5152

Open
sagikazarmark wants to merge 1 commit into
masterfrom
update-security
Open

sagikazarmark wants to merge 1 commit into
masterfrom
update-security

Conversation

@sagikazarmark

Copy link
Copy Markdown
Member

Overview

Update .github/SECURITY.md so vulnerability reports go through GitHub's private vulnerability reporting.

What this PR does / why we need it

  • Points reporters to https://github.com/dexidp/dex/security/advisories/new and removes the email reporting address.
  • States that reports sent by email are no longer accepted.
  • Adds a "What to include in a report" section that asks for a description and impact, step-by-step reproduction instructions, and code that demonstrates the issue (PoC script, failing test, or minimal program).
  • Simplifies the review process: each GitHub report creates a private draft advisory that maintainers and reporters use to discuss the issue.

Special notes for your reviewer

Private vulnerability reporting must be enabled in the repository settings (Settings → Code security) for the link to work.

Replace the email reporting channel with GitHub's private vulnerability
reporting, state that email reports are no longer accepted, and ask
reporters to include reproduction steps and code.

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
@sagikazarmark sagikazarmark added the release-note/ignore Ignore this change when generating release notes label Nov 11, 2026

@nabokihms nabokihms left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! Two small things inline.

Comment thread .github/SECURITY.md

The reporter(s) can expect a response within 48 hours acknowledging the issue
was received. If a response is not received within 48 hours, please reach out
to any maintainer directly to confirm receipt of the issue.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the email gone, a reporter who hears nothing in 48 hours has no way to reach us here. Could you link MAINTAINERS.md, or say which channel to use (CNCF Slack #dex)?

Comment thread .github/SECURITY.md
Comment on lines +39 to +41
the maintainers and the reporter(s). If the reporter(s) does not wish to
participate directly in the discussion, then the reporter(s) can request to be
updated regularly through the advisory.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: a private report already makes the reporter a collaborator on the draft advisory, so they get its updates anyway. I'd drop this sentence.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-note/ignore Ignore this change when generating release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants