Skip to content

Commit 142c549

Browse files
Docs :- Improved SECURITY.md ( AynOps#151 )
Improved security.md
2 parents d3ab31f + a70d437 commit 142c549

1 file changed

Lines changed: 48 additions & 26 deletions

File tree

SECURITY.md

Lines changed: 48 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,72 @@
33
## Supported Versions
44

55
| Version | Supported |
6-
|---|---|
7-
| Latest (main branch) | ✅ Yes |
8-
| Older commits | ❌ No |
6+
| --- | --- |
7+
| Latest (`main` branch) | ✅ Yes |
8+
| Older releases/commits | ❌ No |
99

1010
---
1111

12-
## Reporting a Vulnerability
12+
## Reporting Security Issues
1313

14-
**Please do not report security vulnerabilities through public GitHub issues.**
14+
Security contributions are always welcome.
1515

16-
If you discover a security vulnerability in this project, please report it responsibly by contacting me directly:
16+
### Public GitHub Issues
1717

18-
- **LinkedIn:** [Gaohar Imran](https://www.linkedin.com/in/gaohar-imran-5a4063379/)
19-
- **GitHub:** Open a [private security advisory](https://github.com/AynOps/AynOps/security/advisories/new)
20-
- **Email:** gaoharimran29@gmail.com
18+
Feel free to open a GitHub Issue or Pull Request for:
2119

22-
Please include:
23-
- A description of the vulnerability
24-
- Steps to reproduce it
20+
- Security improvements or hardening suggestions
21+
- Dependency security updates
22+
- Documentation improvements related to security
23+
- Potential security concerns that are not immediately exploitable
24+
- Questions about the project's security
25+
26+
### Private Disclosure
27+
28+
If you believe you've discovered a vulnerability that could put users at risk (for example, arbitrary code execution, command injection, credential exposure, or another exploitable security issue), please report it privately instead of creating a public issue.
29+
30+
You can report privately through:
31+
32+
- GitHub: Open a [private security advisory](https://github.com/AynOps/AynOps/security/advisories/new)
33+
- Email: gaoharimran29@gmail.com
34+
35+
When reporting, please include:
36+
37+
- Description of the issue
38+
- Steps to reproduce
2539
- Potential impact
26-
- Any suggested fix if you have one
40+
- Suggested fix (if available)
2741

28-
I will respond within **72 hours** and work with you to address the issue before any public disclosure.
42+
I aim to acknowledge reports within **72 hours** and will work toward a fix before public disclosure whenever possible.
2943

3044
---
3145

3246
## Scope
3347

34-
This is a **local MCP server** — it runs on the user's own machine and does not expose any network services by default.
48+
This project is a local MCP server that runs on the user's own machine and does not expose network services by default.
49+
50+
### In Scope
3551

36-
### In scope
37-
- Vulnerabilities in the tool logic that could lead to unintended code execution
38-
- Input validation bypasses that could harm the user's system
39-
- Dependency vulnerabilities with direct exploitability
52+
- Command injection or arbitrary code execution
53+
- Path traversal or unsafe file access
54+
- Input validation issues
55+
- Dependency vulnerabilities with practical exploitability
56+
- Security issues within the project's codebase and bundled MCP tools
4057

41-
### Out of scope
42-
- Issues with third-party APIs (NVD, AbuseIPDB, WHOIS servers)
43-
- Rate limiting or availability of external services
44-
- Security of the user's own Claude Desktop installation
58+
### Out of Scope
59+
60+
- Security issues in third-party services or APIs
61+
- Availability or rate-limiting of external services
62+
- User-specific operating system or environment configuration
63+
- Security of third-party applications used alongside this project
64+
- Social engineering attacks
4565

4666
---
4767

48-
## Ethical Usage
68+
## Responsible Use
69+
70+
This project is intended for authorized security research and defensive purposes only.
4971

50-
This tool is intended for **authorized security research and defensive purposes only.**
72+
Always ensure you have permission before scanning or testing systems you do not own or administer.
5173

52-
Users are responsible for ensuring they have permission to scan any target domain or IP address. The maintainers are not responsible for misuse of this software.
74+
Thank you for helping make the project safer for everyone.

0 commit comments

Comments
 (0)