We release patches for security vulnerabilities in the following versions:
| Version | Supported |
|---|---|
| 1.1.x | ✅ |
| 1.0.x | ✅ |
| < 1.0 | ❌ |
We take the security of WinstonAI seriously. If you discover a security vulnerability, please follow these steps:
- Open a public GitHub issue about the vulnerability
- Share the vulnerability publicly before it has been addressed
-
Report privately via GitHub Security Advisory (preferred):
- Go to the Security tab
- Click "Report a vulnerability"
- Fill out the form with details
-
Or email us directly (if GitHub advisory is not available):
- Email: [INSERT SECURITY EMAIL]
- Subject: [SECURITY] Brief description
- Include:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Any suggested fixes (optional)
- Acknowledgment: We'll acknowledge receipt within 48 hours
- Assessment: We'll assess the vulnerability and determine severity
- Timeline: We'll provide an expected timeline for a fix
- Updates: We'll keep you informed of progress
- Credit: We'll credit you in the security advisory (unless you prefer to remain anonymous)
- Critical vulnerabilities: Patch within 7 days
- High severity: Patch within 14 days
- Medium/Low severity: Patch in next release cycle
When using WinstonAI, please follow these security practices:
- Never commit API keys to version control
- Use environment variables or secure configuration files
- Keep your
.envfiles out of version control (they're in.gitignore) - Rotate API keys regularly
- Start with demo accounts before live trading
- Use proper risk management settings
- Set appropriate loss limits
- Never use more capital than you can afford to lose
- Regularly monitor bot performance
- Keep Python and all dependencies up to date
- Use virtual environments to isolate dependencies
- Run security scans on dependencies (
pip install safety && safety check) - Use firewalls and secure network configurations
- Encrypt sensitive data at rest
- Use secure connections (HTTPS/WSS) for API communication
- Don't log sensitive information (API keys, account balances)
- Regularly backup important data
- Review code changes before deployment
- Use code scanning tools (Bandit, etc.)
- Follow the principle of least privilege
- Keep production and development environments separate
- This software involves real money trading
- Always test thoroughly before live deployment
- Use proper risk management
- Monitor bot behavior regularly
- API credentials provide access to trading accounts
- Protect credentials as you would passwords
- Use API key restrictions when available
- Revoke unused or compromised keys immediately
- Trained models (.pth files) contain your trading strategy
- Protect model files from unauthorized access
- Don't share models publicly if they're proprietary
- Validate model files before loading
- Trading data may be sensitive
- Historical data may contain proprietary patterns
- Ensure compliance with data protection regulations
- Be mindful of what you share in issues/discussions
We regularly update dependencies and apply security patches. To stay secure:
- Watch releases for security updates
- Update regularly:
pip install --upgrade winston-ai - Check CHANGELOG.md for security-related changes
- Subscribe to security advisories on GitHub
WinstonAI relies on several third-party libraries. We:
- Monitor dependencies for vulnerabilities
- Update dependencies regularly
- Use tools like
safetyanddependabot - Pin major versions to avoid breaking changes
When using WinstonAI:
- Ensure compliance with financial regulations in your jurisdiction
- Follow KYC/AML requirements of your trading platform
- Respect API rate limits and terms of service
- Don't use for market manipulation or illegal activities
If you have questions about security but don't have a vulnerability to report:
- Open a discussion on GitHub
- Check existing security-related issues
- Review our documentation
Thank you for helping keep WinstonAI and its users safe!