We actively support the following versions with security updates:
| Version | Supported |
|---|---|
| 1.0.x | ✅ |
| < 1.0 | ❌ |
We take security vulnerabilities seriously. If you discover a security issue, please follow these steps:
DO NOT create a public GitHub issue for security vulnerabilities.
Instead, please:
- Email: Send details to the maintainer at the email address listed in the repository
- Include:
- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Any suggested fixes (if available)
- Initial Response: Within 48 hours of receiving your report
- Status Updates: Weekly updates on investigation progress
- Resolution: We aim to resolve critical security issues within 7 days
- Acknowledgment: We'll confirm receipt of your vulnerability report
- Investigation: Our team will investigate and validate the issue
- Fix Development: We'll develop and test a fix
- Coordinated Disclosure: We'll work with you on disclosure timing
- Credit: We'll provide appropriate credit for your responsible disclosure (if desired)
- API Keys: Store API keys in
secrets.yaml(never commit to version control) - File Permissions: Ensure
secrets.yamlhas 600 permissions (chmod 600 secrets.yaml) - Path Security: Configure
security.path_blacklistto restrict file access to sensitive directories
- Docker: Run containers as non-root user (default in our Docker images)
- Network: Use appropriate network isolation and firewalls
- Logs: Monitor logs for suspicious activity; secrets are automatically redacted
- Dependencies: Regularly update dependencies to get security patches
- Testing: Use isolated test environments with mock credentials
- Pre-commit: Use the provided pre-commit hooks to catch common issues
This project includes several security features:
- Secret Redaction: All logs automatically redact API keys and sensitive information
- Path Restrictions: Configurable filesystem access controls
- Secure Defaults: Configuration defaults prioritize security
- Input Validation: All inputs are validated using Pydantic models
- Dependency Scanning: Regular dependency security audits
- Authentication and authorization bypasses
- Information disclosure vulnerabilities
- Code injection vulnerabilities
- Path traversal attacks
- Denial of service attacks
- Dependency vulnerabilities with exploitable impact
- Issues requiring physical access to the host system
- Social engineering attacks
- Brute force attacks on properly configured rate-limited endpoints
- Issues in third-party dependencies without proof of exploitability
We believe in responsible disclosure and will acknowledge security researchers who help improve our security posture. If you'd like to be credited for your contribution, please let us know how you'd like to be acknowledged when you submit your report.