docs: add a security policy - #1207
Open
itzzdev09 wants to merge 1 commit into
Open
Conversation
There is no SECURITY.md in any of the three locations GitHub reads, so the repository has no Security policy link and no documented private channel. A reporter is left choosing between a public issue, Discord, or the general hi@usestrix.com inbox. Add a SECURITY.md pointing at GitHub private vulnerability reporting and the public org address, with what to include, scope, and disclosure expectations. Scope is written around the boundary that matters for this project: Strix runs untrusted target content through an agent and writes artifacts a human later opens, so sandbox escape, credential and CA-key exposure, injection reached through the generated reports, and prompt injection escalating outside the sandbox are called out explicitly. It also states that findings Strix reports about a user's own target are not vulnerabilities in Strix.
Contributor
Greptile SummaryAdds a repository security policy that documents private reporting channels, requested report details, project-specific vulnerability scope, supported-version expectations, and coordinated disclosure guidance.
Confidence Score: 5/5The PR appears safe to merge as a documentation-only addition with no actionable defects. The policy provides a private email fallback even while GitHub private vulnerability reporting depends on a separately acknowledged repository setting. Important Files Changed
Reviews (1): Last reviewed commit: "docs: add a security policy" | Re-trigger Greptile |
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.
Addresses the second half of #1051.
Why
There's no
SECURITY.mdin any of the three locations GitHub reads (/,.github/,docs/), so the repo has no Security policy link and no documented private channel. As #1051 puts it, a reporter is left choosing between a public issue, Discord, or the general inbox — an awkward gap for a security tool.What's here
A
SECURITY.mdpointing at GitHub private vulnerability reporting (primary) andhi@usestrix.com(fallback), plus what to include, scope, and disclosure expectations.Two parts are written for this project specifically rather than boilerplate:
Scope is framed around the boundary that actually matters here. Strix runs untrusted target content through an agent and writes artifacts a human later opens, so it calls out sandbox escape, exposure of LLM keys / proxy-captured credentials / the MITM CA key, injection reached through the generated reports (CSV, Markdown, PDF, SARIF, JSON), and prompt injection escalating outside the sandbox.
It states the non-scope explicitly — findings Strix reports about a user's own scan target aren't vulnerabilities in Strix, and neither is scanning a host you're not authorised to test. For a pentesting tool that distinction seems worth writing down, or the inbox fills with scan output.
It also asks reporters to redact scan artifacts before sending, since a run directory can carry target hostnames and captured credentials.
Two things for you to decide
Response timelines. I deliberately did not write any — an acknowledgement window or fix SLA is a commitment only maintainers can make, and inventing numbers seemed worse than omitting them. Happy to add whatever you want to promise.
Supported versions. I wrote that fixes land on the latest release rather than being backported, which matches the current cadence (v1.4.1 → v1.5.3 inside a month). Correct that if the intent differs.
The other half of #1051 — enabling private vulnerability reporting under Settings → Code security — is a repo setting a PR can't touch. The policy links to the Security tab on the assumption it'll be enabled; if you'd rather not, say so and I'll drop that channel and leave email only.
Verified
Every factual claim was checked rather than assumed:
hi@usestrix.comis the public org email, the Security tab URL returns 200,--versionis a real flag incli_args.py, and the components named all exist (report/sarif.py,interface/viewer/report_pdf.py,containers/).Disclosure: drafted with AI assistance (Claude Code).