We release patches for security vulnerabilities. Which versions are eligible for receiving such patches depends on the CVSS v3.0 Rating:
| Version | Supported |
|---|---|
| 0.3.x | ✅ |
| < 0.3 | ❌ |
If you discover a security vulnerability within this project, please send an email to the maintainers at [INSERT SECURITY EMAIL]. All security vulnerabilities will be promptly addressed.
Please do not report security vulnerabilities through public GitHub issues.
When reporting a vulnerability, please include:
- Type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit it
- Initial Response: Within 48 hours of receiving your report
- Assessment: Within 7 days, we will provide an assessment of the vulnerability
- Resolution: Security patches will be released as soon as possible, depending on complexity
- Public Disclosure: After a patch is released, we will publish a security advisory
When using this tool:
- API Keys: Never commit API keys or secrets to the repository. Use environment variables or configuration files (excluded from git).
- Dependencies: Regularly update dependencies to patch known vulnerabilities.
- Input Validation: Be cautious when analyzing untrusted codebases.
- Output Sanitization: Review generated documentation before publishing, especially if analyzing proprietary code.
This project includes:
- No External Data Transmission: All analysis is performed locally unless explicitly configured otherwise
- Sandboxed Execution: Code analysis does not execute the analyzed code
- Token Budget Limits: Built-in safeguards to prevent excessive API usage
- Configurable LLM Providers: Support for self-hosted LLM endpoints for sensitive projects
We follow responsible disclosure practices:
- Security issues are fixed privately
- A patch is released
- Security advisory is published with credit to reporter (if desired)
- CVE is requested if applicable
For security-related questions or concerns, please contact:
- Email: [INSERT SECURITY EMAIL]
- PGP Key: [INSERT PGP KEY FINGERPRINT IF AVAILABLE]
Thank you for helping keep this project and its users safe!