Skip to content

Add a security policy: report privately via GHSA, not the issue tracker - #2

Merged
jeremy merged 2 commits into
mainfrom
security-md
Aug 10, 2026
Merged

Add a security policy: report privately via GHSA, not the issue tracker#2
jeremy merged 2 commits into
mainfrom
security-md

Conversation

@jeremy

@jeremy jeremy commented Aug 8, 2026

Copy link
Copy Markdown
Member

Surfguard is an SSRF guard, so classification bugs are vulnerabilities — the kind of report this repo should route privately, and today nothing tells a researcher how.

This adds a SECURITY.md:

  • Reporting: GitHub private vulnerability reporting (already enabled on this repo), with a direct link to the advisory form. HackerOne (https://hackerone.com/basecamp) accepted as an alternative for researchers who want the report on their H1 record — no bounty, per the 37signals response policy.
  • What qualifies: a blocked-range address classified as public, a resolution path that lets a blocked address through, or a validate-vs-connect discrepancy under the documented pinning contract. Non-security bugs → issue tracker.
  • Supported versions: latest release only.
  • Expectations: acknowledgment, GHSA-coordinated fix and disclosure, reporter credit.

The README gains a short "Security" section linking the policy by absolute URL, so it works from GitHub and from the packaged gem (which ships README.md but not SECURITY.md). Gemspec untouched — SECURITY.md is a repo artifact, not gem payload.

Pairs with basecamp/.github#17, which adds the org-wide default; this repo-specific policy takes precedence for surfguard.

Copilot AI balanced review requested due to automatic review settings August 8, 2026 23:20

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3bb7a96477

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds private vulnerability-reporting guidance for Surfguard and links it from the README.

Changes:

  • Defines qualifying vulnerabilities, supported versions, and disclosure expectations.
  • Directs reports to GitHub Security Advisories or HackerOne.

Tip

If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
SECURITY.md Adds the repository security policy.
README.md Links readers to the security policy.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Copilot AI review requested due to automatic review settings August 8, 2026 23:43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@jeremy
jeremy merged commit 910be91 into main Aug 10, 2026
10 checks passed
@jeremy
jeremy deleted the security-md branch August 10, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants