The following versions of CleanBook are currently supported with security updates:
| Version | Supported |
|---|---|
| 2.0.x | ✅ |
| 1.x.x | ❌ |
If you discover a security vulnerability within CleanBook, please send an email to the repository owner. All security vulnerabilities will be promptly addressed.
Please do not open public issues for security vulnerabilities.
- Email: Send details to the repository maintainer via GitHub
- Response Time: You will receive an acknowledgment within 48 hours
- Updates: We will keep you informed about our progress on the fix
- Disclosure: Once the vulnerability is fixed, we will coordinate disclosure with you
When reporting a vulnerability, please include:
- A description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Suggested fix (if any)
- Your disclosure preferences
This project implements the following security practices:
- Dependency Scanning: Regular automated scans for vulnerable dependencies
- Code Review: All changes require code review before merging
- Branch Protection: Protected branches prevent direct pushes to main/master
- Security Testing: Bandit and safety checks in CI pipeline
- CleanBook supports optional LLM features that require API keys
- Never commit API keys to the repository
- Use environment variables or
.envfiles (ignored by git) - See
.env.examplefor the required environment variables
- CleanBook is designed as an offline-first tool
- Bookmark data is processed locally and never sent to external services
- LLM features only send data to your configured provider (OpenAI, etc.)
- Keep your Python dependencies updated
- Review configuration files before running
- Use virtual environments to isolate dependencies
- Report any suspicious behavior immediately