|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Reporting a Vulnerability |
| 4 | + |
| 5 | +We appreciate and encourage responsible vulnerability disclosure from our users and the security research community. To ensure vulnerabilities are handled securely and efficiently, we request that all vulnerabilities be reported through GitHub's secure vulnerability reporting feature. |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +### How to Report a Vulnerability |
| 10 | + |
| 11 | +1. Visit the **Security** tab on the GitHub repository. |
| 12 | +2. Click **Report a vulnerability**. |
| 13 | +3. Provide detailed information including: |
| 14 | + - A clear description of the vulnerability |
| 15 | + - Steps to reproduce |
| 16 | + - Potential impact assessment |
| 17 | + - Any recommendations for mitigation |
| 18 | + |
| 19 | +### Handling Your Report |
| 20 | + |
| 21 | +Once your vulnerability report is submitted, we will: |
| 22 | + |
| 23 | +- Acknowledge receipt within **2 business days**. |
| 24 | +- Investigate and validate the reported vulnerability. |
| 25 | +- Provide regular updates approximately every **7 business days** until resolution. |
| 26 | + |
| 27 | +### Vulnerability Acceptance |
| 28 | + |
| 29 | +- If the vulnerability is **accepted**, we will: |
| 30 | + - Coordinate privately to develop and test a fix. |
| 31 | + - Aim to resolve critical vulnerabilities within **14 days** and lower severity issues within **30 days**. |
| 32 | + - Publicly disclose the vulnerability after a fix is available, providing credit to the reporter (unless anonymity is requested). |
| 33 | + |
| 34 | +- If the vulnerability is **declined**, we will: |
| 35 | + - Clearly explain our reasoning. |
| 36 | + - Suggest alternative actions if applicable. |
| 37 | + |
| 38 | +### PyPI Package Management |
| 39 | + |
| 40 | +We follow best practices for managing packages published on PyPI, including the "yanking" of vulnerable package versions. Yanked versions remain available for users to download, but are hidden from new installations by default, preventing further propagation of vulnerabilities. |
| 41 | + |
| 42 | +Thank you for helping us keep our packages secure! |
0 commit comments