We release patches for security vulnerabilities for the following versions:
| Version | Supported |
|---|---|
| 1.0.x | ✅ |
| < 1.0 | ❌ |
We take the security of Eigen Geometric Control seriously. If you discover a security vulnerability, please follow these steps:
-
Email us privately at mcreynolds.jon@gmail.com with:
- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact
- Any suggested fixes (if you have them)
-
Give us time to fix it - We aim to respond within 48 hours and will work with you to:
- Confirm the vulnerability
- Develop and test a fix
- Release a security patch
- Publicly credit you (if desired)
-
Keep it confidential until we've released a fix
- ❌ Open a public GitHub issue about the vulnerability
- ❌ Disclose the vulnerability publicly before we've had a chance to fix it
- ❌ Exploit the vulnerability in production systems
When using this library:
- Keep dependencies updated - Run
pip install --upgrade eigen-geometric-controlregularly - Review configuration files - Ensure your
config.yamldoesn't contain sensitive data - Validate inputs - Always validate robot control inputs before passing to the control system
- Monitor system behavior - Watch for unexpected robot movements or behaviors
Our codebase includes:
- ✅ Automated security scanning with Bandit in CI/CD
- ✅ Dependency vulnerability scanning via Dependabot
- ✅ Input validation on control parameters
- ✅ Safe numerical operations to prevent overflow/underflow
- ✅ Configuration validation with schema checking
When we release a security patch:
- We'll publish a GitHub Security Advisory
- Update the CHANGELOG with security fix details
- Credit the reporter (if they wish to be credited)
- Notify users via GitHub releases
For security issues: mcreynolds.jon@gmail.com
For general questions: Open a GitHub Issue
Thank you for helping keep Eigen Geometric Control and our users safe!