Skip to content

docs(security): add reporter guidance — what to include in a vulnerability report - #1556

Open
TimeToBuildBob wants to merge 1 commit into
ActivityWatch:masterfrom
TimeToBuildBob:fix/security-md-reporter-guidance
Open

TimeToBuildBob wants to merge 1 commit into
ActivityWatch:masterfrom
TimeToBuildBob:fix/security-md-reporter-guidance

Conversation

@TimeToBuildBob

Copy link
Copy Markdown
Contributor

Summary

The current SECURITY.md only says "email Erik". This adds guidance for reporters on what a helpful report includes, based on what actually worked in past AW advisories:

  • Working reproduction (CVE-2021-32692 had one; CVE-2022-31149 did not)
  • Affected version
  • Minimal trigger

Also adds the GitHub private security advisory link as an alternative to email.

Changes

  • Removes the placeholder <!-- --> comments from the template
  • Adds "What to include" with the three criteria
  • Adds "What to expect" to set reporter expectations
  • Adds link to GitHub private advisory flow

Test plan

  • Rendered correctly on GitHub (markdown only)
  • No sensitive information added

…ility report

Adds 3 criteria for a good report (reproduction, version, minimal trigger)
and explains what to expect. Based on historical AW advisories (CVE-2021-32692
had all three; CVE-2022-31149 had two). Adds GitHub private advisory link as
an alternative reporting path.

Git-Session-Id: aa2ff661-53ea-4192-868f-98535b0a9869
@greptile-apps

greptile-apps Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation changes appear safe to merge.

Summary

Updates SECURITY.md with guidance for vulnerability reporters.

  • The security policy guides reporters through sending a vulnerability report.

No actionable issues found.

Reviews (1) · Last reviewed commit: "docs(security): add reporter guidance — ..." · Reviewed by Greptile

@TimeToBuildBob

TimeToBuildBob commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor Author

🤖 AI code review

Rewrites SECURITY.md: removes the commented-out template placeholders (Supported Versions and reporting instructions), keeps the PGP email instruction under 'Reporting a Vulnerability', and adds a GitHub private security advisory link. Adds a 'What to include' section listing three report criteria and a 'What to expect' section about acknowledgement, fixes and past advisories.

Safe to merge — no P0/P1 findings

Confidence 5/5

✅ No thread-worthy findings. Advisory notes follow; they are retained without opening review threads.

2 advisory findings (summary-only, not scored)

These P2 guard, heuristic, trade-off, or documentation claims are retained for judgment without opening review threads.

⚠️ P2 medium · 🔒 security — SECURITY.md:17

The 'What to include' list asks for a 'working reproduction' and a 'minimal trigger' as separate items, and the text then says a report without a reproduction will be lower priority. For vulnerabilities reported by people who can see a flaw by code inspection (e.g. a missing auth check in aw-server), or where a PoC would be harmful to run against others, this deprioritises valid reports. Items 1 and 3 also overlap: a 'working reproduction' that is a 'minimal reproducer' is the same thing, which makes the guidance confusing to reporters. Reporters may be discouraged from submitting real findings, or may submit incomplete ones while unsure what separates the two items.

How this was verified: Read the full file; items 1 and 3 on lines 13 and 15 both describe a concrete reproducer, and no alternative is offered for reports without a PoC.

⚠️ P2 medium · 🔒 security — SECURITY.md:22

The 'What to expect' section promises 'Fix or mitigation in the next release, with credit to the reporter' unconditionally. It gives no handling for reports that are declined, not reproducible, or whose fix needs more than one release cycle, and it does not mention coordinated disclosure timing or opting out of credit. The removed template explicitly asked for what to expect if a report is accepted or declined. Reporters may treat this as a commitment, and maintainers are held to a fix timeline the project may not be able to meet.

How this was verified: Checked the whole file after the change: no mention of declined reports, disclosure timelines, or credit opt-out exists anywhere.

Files changed (1) — the diff as I read it
  • SECURITY.md — Deletes the HTML-comment template blocks, adds a GitHub private advisory link, a 'What to include' list of three items, and a 'What to expect' list of response commitments.

Reviewed 0f148d3f33ac · panel: claude-code:sonnet · subscription engine · 17s · about this reviewer

Maintainer commands

@TimeToBuildBob review (own line) — fresh review · @TimeToBuildBob fix — a worker acts on the findings. Once per comment; 👀 = received.

Outage coverage: 1-pass, not merge evidence. Subscription review supplied findings while full consensus capacity was unavailable. The consensus merge gate remains unsatisfied.

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.

1 participant