|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Table of Contents |
| 4 | +1. [Supported Versions](#supported-versions) |
| 5 | +2. [Reporting a Vulnerability](#reporting-a-vulnerability) |
| 6 | +3. [Disclosure Policy](#disclosure-policy) |
| 7 | +4. [Acknowledgments](#acknowledgments) |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## Supported Versions |
| 12 | + |
| 13 | +This section outlines the versions of our project that are currently receiving security updates and support. |
| 14 | + |
| 15 | +| Version | Supported | End of Support | |
| 16 | +| ------- | ------------------ | -------------- | |
| 17 | +| 5.1.x | :white_check_mark: | N/A | |
| 18 | +| 5.0.x | :x: | 2023-01-01 | |
| 19 | +| 4.0.x | :white_check_mark: | 2024-01-01 | |
| 20 | +| < 4.0 | :x: | 2022-01-01 | |
| 21 | + |
| 22 | +**Note:** Only actively supported versions receive critical security patches. Users are strongly encouraged to upgrade to the latest stable version to ensure the highest level of security. |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## Reporting a Vulnerability |
| 27 | + |
| 28 | +We take security seriously and appreciate your efforts in identifying potential vulnerabilities. If you discover any security issues, please follow these guidelines: |
| 29 | + |
| 30 | +### How to Report: |
| 31 | +1. **Submit a Report via Email:** Send a detailed report to [123kevin@duck.com](mailto:123kevin@duck.com). |
| 32 | +2. **Include the Following Information:** |
| 33 | + - A clear description of the vulnerability. |
| 34 | + - Steps to reproduce the issue. |
| 35 | + - The affected version(s) of the software. |
| 36 | + - Any tools or configurations used during testing. |
| 37 | + - Potential impact of the vulnerability. |
| 38 | + |
| 39 | +### What to Expect: |
| 40 | +- **Initial Response:** We aim to acknowledge your report within **48 hours**. |
| 41 | +- **Investigation:** Our team will investigate the issue and provide periodic updates on the progress. |
| 42 | +- **Resolution:** Once the vulnerability is confirmed, we will work diligently to patch it and release an update. |
| 43 | +- **Communication:** You will be informed about the status of the fix and the expected timeline for deployment. |
| 44 | + |
| 45 | +### Acceptance Criteria: |
| 46 | +- Reports must include sufficient information to reproduce the issue. |
| 47 | +- Vulnerabilities must affect a supported version of the software. |
| 48 | + |
| 49 | +### Declined Reports: |
| 50 | +If your report does not meet the acceptance criteria or is deemed invalid, we will notify you with an explanation. |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +## Disclosure Policy |
| 55 | + |
| 56 | +Our goal is to balance transparency with responsible disclosure to protect our users. Here’s how we handle public disclosure: |
| 57 | + |
| 58 | +1. **Internal Review:** Upon receiving a valid report, we conduct an internal review to assess the severity and impact of the vulnerability. |
| 59 | +2. **Patch Development:** We develop and test a fix for the issue. |
| 60 | +3. **Coordinated Release:** Once the fix is ready, we coordinate its release with the reporter (if applicable) to ensure proper communication. |
| 61 | +4. **Public Announcement:** After the fix is deployed, we may publish a security advisory detailing the issue, its resolution, and credits to the reporter (with their permission). |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +## Acknowledgments |
| 66 | + |
| 67 | +We value the contributions of security researchers who help us improve the security of our project. Below is a list of individuals and organizations whose efforts have been instrumental in identifying and resolving vulnerabilities: |
| 68 | + |
| 69 | +- **[Researcher Name]** - Reported a critical vulnerability in version 5.1.2. |
| 70 | +- **[Organization Name]** - Conducted a comprehensive security audit in 2023. |
| 71 | + |
| 72 | +If you would like to be acknowledged for your contribution, please let us know when submitting your report. |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +This policy is subject to change as we continuously improve our processes. For further questions or clarifications, feel free to reach out to our security team at [123kevin@duck.com](mailto:123kevin@duck.com). Thank you for helping us maintain the security of our project! |
0 commit comments