Skip to content

Commit 3155144

Browse files
committed
docs: add security policy
Directs vulnerability reports to a private GitHub Security Advisory instead of public issues, and documents scope, expected report contents, and response timelines.
1 parent aba70a8 commit 3155144

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
Please do not report security issues through public GitHub issues, pull requests, or social media.
6+
7+
Instead, open a private report through GitHub Security Advisories:
8+
9+
[Report a vulnerability](https://github.com/adrgs/requestrepo/security/advisories/new)
10+
11+
This creates a private thread visible only to you and the maintainers, and it lets us
12+
coordinate a fix and a CVE before any details become public.
13+
14+
## What to Include
15+
16+
A good report makes triage much faster. Where possible, please provide:
17+
18+
- The affected component (HTTP server, DNS server, SMTP server, frontend, Docker setup)
19+
- The version, commit hash, or `ghcr.io/adrgs/requestrepo` image tag you tested against
20+
- Steps to reproduce, ideally with a minimal proof of concept
21+
- The impact you believe the issue has, and any preconditions required to trigger it
22+
- Any suggested remediation, if you have one in mind
23+
24+
## Scope
25+
26+
In scope:
27+
28+
- The code in this repository, including the Rust backend, the React frontend, and the
29+
Docker build
30+
- The hosted instance at `requestrepo.com`
31+
32+
Out of scope:
33+
34+
- Findings that depend on a misconfigured self-hosted deployment, such as a weak
35+
`JWT_SECRET` or an exposed admin token
36+
- Reports generated solely by automated scanners with no demonstrated impact
37+
- Denial of service through raw traffic volume
38+
- Missing hardening headers or similar issues without a concrete attack path
39+
40+
Note that RequestRepo is designed to receive arbitrary requests from anyone and to reflect
41+
attacker-controlled content back to the session owner. Behaviour that is part of that design
42+
is not by itself a vulnerability. If you believe a case crosses the line into an actual
43+
security boundary being broken, please explain why in the report.
44+
45+
## Response Process
46+
47+
- We aim to acknowledge new reports within 72 hours
48+
- We will confirm the issue and share an assessment of severity and a rough timeline
49+
- We will keep you updated as the fix progresses, and let you know when it ships
50+
- Once a fix is released, we publish the advisory and credit you, unless you prefer to stay
51+
anonymous
52+
53+
Researchers who have reported issues in the past are credited in the Security
54+
Acknowledgments section of the [README](README.md).
55+
56+
## Supported Versions
57+
58+
Security fixes are applied to the `main` branch and published in the `latest` container
59+
image. Older releases are not backported. Please make sure you are running current code
60+
before reporting.

0 commit comments

Comments
 (0)