We actively support the following versions with security updates:
| Version | Supported |
|---|---|
| 7.x.x | ✅ |
| 6.x.x | ❌ |
| < 6.0 | ❌ |
We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly.
- Do NOT create a public GitHub issue for security vulnerabilities
- Email the maintainer directly or use GitHub's private vulnerability reporting feature
- Include as much detail as possible:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)
- Acknowledgment: We will acknowledge receipt within 48 hours
- Assessment: We will assess the vulnerability within 7 days
- Resolution: Critical vulnerabilities will be addressed within 30 days
- Disclosure: We will coordinate disclosure timing with you
-
API Key Security
- Never commit your
.envfile to version control - Use environment variables in CI/CD instead of hardcoded values
- Rotate API keys periodically
- Never commit your
-
File Permissions
- The application creates files with
0600permissions (owner read/write only) - Ensure your config directory has appropriate permissions
- The application creates files with
-
Remote Domains
- When using
DOMAINS_URL, consider enabling hash verification withDOMAINS_HASH_URL - Only use trusted HTTPS URLs
- When using
-
Docker
- The Docker image runs as non-root user
- Don't mount sensitive host directories
This project includes several security features:
- Secure file permissions: All sensitive files are created with
0600mode - Input validation: Domain names, URLs, and configuration values are validated
- Rate limiting: Built-in rate limiter prevents API abuse
- Audit logging: All actions are logged for accountability
- Hash verification: Optional SHA256 verification for remote domains
- No shell injection: Uses
shlex.quote()for shell command construction
We regularly scan dependencies for vulnerabilities using:
safety- Python dependency vulnerability scannerbandit- Python security linter- Dependabot - Automated dependency updates
We appreciate responsible disclosure from security researchers. Contributors who report valid security issues will be acknowledged here (with permission).