Skip to content

Commit 86965b6

Browse files
committed
docs: expand SECURITY.md for GitHub security policy
1 parent 164751e commit 86965b6

1 file changed

Lines changed: 37 additions & 10 deletions

File tree

SECURITY.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,48 @@
22

33
## Supported Versions
44

5-
| Version | Supported |
6-
| ------- | --------- |
7-
| 0.1.x | Yes |
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| 0.1.x | :white_check_mark: |
8+
| < 0.1 | :x: |
89

910
## Reporting a Vulnerability
1011

11-
Please **do not** open a public GitHub issue for security vulnerabilities.
12+
**Do not** open a public GitHub issue for security vulnerabilities.
1213

13-
Report them privately by opening a [GitHub Security Advisory](https://github.com/false200/Tooltrim/security/advisories/new) or emailing the maintainer via their GitHub profile contact.
14+
Report privately using one of these:
1415

15-
Include:
16+
1. [GitHub Security Advisories](https://github.com/false200/Tooltrim/security/advisories/new) (preferred)
17+
2. Contact the maintainer through their [GitHub profile](https://github.com/false200)
1618

17-
- A description of the issue
19+
## What to Include
20+
21+
- Description of the vulnerability
1822
- Steps to reproduce
19-
- Potential impact
20-
- Suggested fix (if any)
23+
- Affected versions
24+
- Potential impact (e.g. credential leak, arbitrary code execution)
25+
- Suggested fix or mitigation, if you have one
26+
27+
## Response Timeline
28+
29+
| Step | Target |
30+
| ----------------- | ------------- |
31+
| Acknowledgement | 72 hours |
32+
| Status update | 7 days |
33+
| Fix or mitigation | Best effort |
34+
35+
## Scope
36+
37+
In scope:
38+
39+
- The `tooltrim` npm package and CLI
40+
- This repository's source code
41+
- Default configuration and documented deployment patterns
42+
43+
Out of scope:
44+
45+
- Vulnerabilities in upstream MCP servers you connect via config
46+
- Misconfiguration of secrets in user-owned `tooltrim.config.yaml` files
47+
- Issues in third-party dependencies (report those to the upstream project; we will bump deps when fixes are available)
2148

22-
We aim to acknowledge reports within 72 hours.
49+
Thank you for helping keep Tooltrim and its users safe.

0 commit comments

Comments
 (0)