Skip to content

Commit 892b8bb

Browse files
chore(security): add SECURITY.md for vulnerability reporting
Added a SECURITY.md file to provide guidelines for reporting security vulnerabilities. It includes contact information, the process for handling reports, and security best practices.
1 parent d2cd135 commit 892b8bb

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

SECURITY.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Security
2+
3+
This document provides guidelines on how to report security vulnerabilities in the project.
4+
5+
## Reporting Vulnerabilities
6+
7+
If you discover a security vulnerability, please follow the guidelines below to report it securely and responsibly:
8+
9+
1. **Do not open public issues**: Please do not submit public issues or pull requests containing details of the vulnerability. This could allow others to exploit the issue before it's fixed.
10+
11+
2. **Contact**: Send an email to **[email protected]** or open a private ticket in the repository to report the issue. Please provide as many details as possible, including:
12+
- Description of the vulnerability
13+
- Steps to reproduce it
14+
- Potential impact
15+
- Any code or examples of how the vulnerability can be exploited
16+
17+
3. **Acknowledgment**: All security reports will be handled with the utmost seriousness, and you will be publicly credited if the issue is resolved.
18+
19+
## Handling Reports
20+
21+
When we receive a security report, we follow this process:
22+
23+
1. We confirm receipt of the report within 48 hours.
24+
2. We analyze and prioritize the vulnerability.
25+
3. We work on fixing the issue promptly.
26+
4. We inform the reporter when a fix is ready.
27+
28+
## References
29+
30+
- [GitHub Security Guidelines](https://docs.github.com/en/github/managing-security-vulnerabilities/creating-a-security-policy)
31+
- [OWASP Top Ten](https://owasp.org/www-project-top-ten/)
32+
33+
Thank you for helping keep this project secure!

0 commit comments

Comments
 (0)