We prioritize security for the latest release of the project. Critical security updates may be backported to previous versions at our discretion.
| Version | Supported |
|---|---|
| 1.x.x | ✅ |
| < 1.0 | ❌ |
Please do not report security vulnerabilities through public GitHub issues.
- Email security concerns to [MAINTAINER_EMAIL] (or open a private security advisory on GitHub)
- Include:
- Description of the vulnerability
- Steps to reproduce
- Impact analysis
- Suggested mitigation (if known)
- We will respond within 3 business days
- Do not disclose publicly until we've addressed the issue
- Authentication token handling
- Data validation/sanitization
- Dependency chain vulnerabilities
- Configuration security
-
Token Security:
- Never commit
.envfiles or hardcode tokens - Use tokens with minimal permissions (only
reposcope required) - Rotate tokens regularly
- Never commit
-
Environment Configuration:
# .env example (keep this file private) GITHUB_TOKEN=ghp_yourtokenhere GITHUB_REPO_OWNER=your-org GITHUB_REPO_NAME=your-repo
-
Dependency Security:
# Regularly check for vulnerabilities pip list --outdated safety check # Requires `safety` package
-
Secure Coding:
- Validate all user input
- Use Python's built-in security libraries (e.g.,
secretsfor tokens) - Avoid shell injection risks with subprocess calls
-
Regular Security Checks:
- Monitor Python vulnerabilities via PyPA Security
- Use GitHub Dependabot for dependency scanning
# Example .github/dependabot.yml version: 2 updates: - package-ecosystem: "pip" directory: "/" schedule: interval: "weekly"
-
Response Protocol:
- Acknowledge report within 3 days
- Patch development within 14 days
- Public disclosure after patch release
We recommend these for development:
bandit: Static code analysispip install bandit bandit -r .safety: Dependency scanningpip install safety safety check