|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Supported Versions |
| 4 | + |
| 5 | +The project maintainers provide security updates for the following versions: |
| 6 | + |
| 7 | +| Version | Supported | |
| 8 | +| ------------------- | --------- | |
| 9 | +| `main` branch | ✔️ | |
| 10 | +| Latest PyPI release | ✔️ | |
| 11 | +| Older releases | ❌ | |
| 12 | + |
| 13 | +If your issue affects a version that is not supported, we still encourage reporting it so we can assess the impact. |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## Reporting a Vulnerability |
| 18 | + |
| 19 | +If you discover a security vulnerability, **please do not open a public issue**. |
| 20 | + |
| 21 | +Instead, contact us privately: |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +We will acknowledge receipt within **48–72 hours**, and provide a more detailed response — including a proposed remediation timeline — within **7 days**. |
| 26 | + |
| 27 | +When reporting, please include: |
| 28 | + |
| 29 | +* A description of the vulnerability |
| 30 | +* Steps to reproduce (proof-of-concept if possible) |
| 31 | +* The potential impact |
| 32 | +* Any suggested fixes |
| 33 | + |
| 34 | +We greatly appreciate responsible disclosure. |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## Security Expectations for Contributors |
| 39 | + |
| 40 | +When contributing code, please: |
| 41 | + |
| 42 | +* Avoid introducing dependencies with known security issues |
| 43 | +* Do not commit secrets, passwords, tokens, or private keys |
| 44 | +* Follow secure coding practices (input validation, safe deserialization, etc.) |
| 45 | +* Use HTTPS endpoints for all network communication |
| 46 | +* Prefer well-maintained libraries and avoid deprecated APIs |
| 47 | + |
| 48 | +Submissions failing basic security checks may be rejected. |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## Dependency & Build Security |
| 53 | + |
| 54 | +This project uses the following to maintain supply-chain security: |
| 55 | + |
| 56 | +* **Pinned dependencies** (`pyproject.toml`) |
| 57 | +* Regular checks with tools such as |
| 58 | + |
| 59 | + * GitHub Dependabot |
0 commit comments