|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Supported Versions |
| 4 | + |
| 5 | +This section outlines the versions of our project that are currently supported with security updates. |
| 6 | + |
| 7 | +| Version | Supported | Release Date | |
| 8 | +|---------|-----------|--------------| |
| 9 | +| 1.0.x | ✅ | Apr 7, 2025 | |
| 10 | + |
| 11 | + |
| 12 | +### Key: |
| 13 | + |
| 14 | +| Key | Desc | |
| 15 | +|-----|-----------------------------------------------------| |
| 16 | +| ✅ | Supported for all security updates | |
| 17 | +| ⚠️ | Supported, but will leave support next major update | |
| 18 | +| ✖️ | Only for major security issues (CVSS 8.0+) | |
| 19 | +| ❌ | No longer supported for any security updates | |
| 20 | + |
| 21 | +## Reporting a Vulnerability |
| 22 | + |
| 23 | +If you believe you have found a security vulnerability in our project, we encourage you to report it to us. Your report |
| 24 | +will help us improve the security of our project and ensure the trust of our users. |
| 25 | + |
| 26 | +### How to Report a Vulnerability |
| 27 | + |
| 28 | +1. **Identify the Vulnerability**: Clearly describe the vulnerability, including how it can be exploited and any |
| 29 | + potential impact. |
| 30 | +2. **Provide Detailed Information**: Include as much detail as possible, such as the version of the project affected, |
| 31 | + steps to reproduce the vulnerability, and any relevant code snippets or screenshots. |
| 32 | +3. **Contact Us **: Send your report to my [email ](mailto:[email protected]). Please include "Security Vulnerability |
| 33 | + Report" in the subject line. |
| 34 | + |
| 35 | +### What to Expect |
| 36 | + |
| 37 | +- **Acknowledgment**: Upon receiving your report, we will acknowledge receipt within 2�5 business days. |
| 38 | +- **Investigation**: Our security team will investigate the vulnerability and determine its validity. |
| 39 | +- **Update**: If the vulnerability is accepted, we will work on a fix and provide an update on the timeline for a |
| 40 | + security update. |
| 41 | +- **Communication**: We will communicate with you regarding the status of the vulnerability and any necessary actions. |
| 42 | + |
| 43 | +### Vulnerability Acceptance Criteria |
| 44 | + |
| 45 | +- The vulnerability must be reproducible. |
| 46 | +- The vulnerability must be exploitable. |
| 47 | +- The vulnerability must not be a false positive. |
| 48 | + |
| 49 | +### Vulnerability Decline Criteria |
| 50 | + |
| 51 | +- The vulnerability is outside the scope of our project. |
| 52 | + |
| 53 | +Thank you for helping us maintain the security of our project. Your contribution is invaluable in keeping our users |
| 54 | +safe. |
| 55 | + |
| 56 | +--- |
0 commit comments