Repository navigation
docs: add private vulnerability reporting policy - #258
Conversation
| @@ -0,0 +1,16 @@ | |||
| # Security policy | |||
|
|
|||
| ## Report a vulnerability | |||
There was a problem hiding this comment.
⚪ SECURITY.md lacks a supported-versions/scope section.
🤖 Fix with your agent
Fix this code review finding (aictrl-dev/cli PR #258, SECURITY.md:3):
Problem: SECURITY.md lacks a supported-versions/scope section
Detail: The policy tells reporters what to include but not which CLI versions are currently supported, so reporters cannot tell whether an unsupported release is in scope. GitHub's standard SECURITY.md template pairs the reporting channel with a Supported Versions table. Everything security-relevant in the file (private-channel URL, org/repo links, sanitization guidance) is correct.
Suggested fix: Add a short "## Supported versions" section (e.g. a | Version | Supported | table listing the latest release as supported and older releases as best-effort, or the actual support window) so reporters know which versions are in scope.
Implement the fix on the PR head branch and add a regression test that fails before the fix and passes after.
Why this matters
The policy tells reporters what to include but not which CLI versions are currently supported, so reporters cannot tell whether an unsupported release is in scope. GitHub's standard SECURITY.md template pairs the reporting channel with a Supported Versions table. Everything security-relevant in the file (private-channel URL, org/repo links, sanitization guidance) is correct.
# Security policy
## Report a vulnerability
Report suspected vulnerabilities in aictrl CLI through [GitHub private vulnerability reporting](https://github.com/aictrl-dev/cli/security/advisories/new). You can also open this repository's Security and quality tab and choose **Report a vulnerability**.
Please include:
Code reviewVerdict: Looks good — only minor / nit comments below. · 🔴 0 · 🟠 0 · 🟡 0 · ⚪ 1 · 0/1 resolved
🤖 Fix all 1 open findings with your agent📋 Out-of-diff findings (1)
Reviewed 1 files · 0 inline · view all 1 findings ↗ · AI-generated — verify findings before acting · AI guidance and feedback aictrl · AI code review for fast-moving teams · aictrl.dev |
Review response — PR #258Reviewed the reporting-only policy at Issues addressed (pushed to this PR)None; no source change is needed for this documentation nit. Review claims verified false (no change needed)None. Not addressed here
The parser normalizes this security-policy wording to SECURITY; the platform's recorded severity is NIT. The exact recorded finding is uniquely identified by its location, full claim and normalized severity; no comment-ID match is asserted because its recorded githubCommentId is null. |
No linked issue. This documentation change contributes to the disclosure-policy item in #245; that broader adoption issue remains open.
Intent
Give people who find a suspected aictrl CLI vulnerability a private reporting route. GitHub private vulnerability reporting is already enabled, but the repository has no security policy describing it.
Expected Impact on Users
People who discover a suspected CLI vulnerability can find the existing private GitHub reporting form and the reproduction details maintainers need, reducing the chance of exploit details or credentials being posted in public issues. Ordinary bugs continue to use the public tracker. This documentation adds no runtime protection, response-time commitment or bounty promise.
Expected Outcomes
Implementation
Add root
SECURITY.mdwith the reporting route and minimal report guidance.Scope Caveat
This is reporting documentation only. It does not resolve the other items in #245, change runtime permissions or isolation, or introduce support-version, response-time or bounty promises.
Test Plan
Verification
enabled: true; no disclosure form was submitted.Automated Review
The ready-for-review event triggered aictrl-bot on this exact head. Its check completed successfully with one documentation NIT: a supported-version table is absent. The reporting route is correct and accepts reports without a version exclusion; the reviewed repository establishes no maintenance window to put in a table. The observation was recorded as TRUE / IGNORE, with no code changes or new support commitments. Verified response and verdict sidecar; exact recorded verdict was persisted and read back. This is review triage, not approval to merge or release.