Security is very important for pyrattler-recipe-autogen and its community. 🔒
We currently support the following versions with security updates:
| Version | Supported |
|---|---|
| 0.1.x | ✅ |
| < 0.1 | ❌ |
We encourage you to:
- Write tests for your usage of pyrattler-recipe-autogen
- Update to the latest version frequently after ensuring your tests pass
- Review the CHANGELOG for security-related updates
Please do not report security vulnerabilities through public GitHub issues.
If you believe you have found a security vulnerability in pyrattler-recipe-autogen, please report it privately using one of the following methods:
Use GitHub Security Advisories to report vulnerabilities privately. This allows us to:
- Discuss the vulnerability privately
- Work on a fix before public disclosure
- Coordinate disclosure timing
- Issue security advisories when appropriate
Send an email to: [email protected]
- Use "SECURITY: pyrattler-recipe-autogen vulnerability" in the subject line
- Include as much detail as possible (see details below)
Please try to be as explicit as possible, describing:
- Vulnerability Type: What kind of security issue is this?
- Impact: What could an attacker potentially do?
- Attack Vector: How would someone exploit this?
- Affected Components: Which parts of pyrattler-recipe-autogen are affected?
- Reproduction Steps: Step-by-step instructions to reproduce the issue
- Environment: OS, Python version, pyrattler-recipe-autogen version
- Proof of Concept: Sample code or commands (without working exploits)
- Suggested Fix: If you have ideas for how to address the issue
pyrattler-recipe-autogen processes pyproject.toml files and generates recipe.yaml files. Key security considerations:
- TOML Parsing: We use Python's built-in
tomllibfor parsing TOML files - File System Access: The tool reads from and writes to the file system based on user input
- Subprocess Execution: Limited subprocess usage for version detection (git, poetry, etc.)
- Path Handling: User-provided file paths are processed
Areas where security vulnerabilities might occur:
- Path Traversal: File path handling and validation
- Code Injection: TOML content processing and YAML generation
- Command Injection: Subprocess execution for tool detection
- Denial of Service: Resource consumption during file processing
- Information Disclosure: Error messages and debug output
When a security vulnerability is reported:
- Acknowledgment: We'll acknowledge receipt within 48 hours
- Assessment: We'll assess the vulnerability and determine severity
- Fix Development: We'll work on a fix while maintaining confidentiality
- Testing: We'll test the fix thoroughly
- Disclosure: We'll coordinate disclosure timing with the reporter
- Release: We'll release a security update and publish an advisory
- Initial Response: Within 48 hours
- Assessment Complete: Within 1 week
- Fix Available: Depends on complexity, typically 1-4 weeks
- Public Disclosure: After fix is released and users have time to update
Please do not publicly discuss potential security vulnerabilities until:
- A fix has been developed and released
- Sufficient time has passed for users to update
- We've coordinated the disclosure timing
This helps limit the potential impact and protects users who haven't yet updated.
When using pyrattler-recipe-autogen:
- Keep Updated: Use the latest version when possible
- Validate Inputs: Be cautious with
pyproject.tomlfiles from untrusted sources - Review Outputs: Check generated recipe.yaml files before use
- Sandbox Usage: Consider running in isolated environments for untrusted inputs
- Report Issues: Report any suspicious behavior or potential security issues
We appreciate security researchers and users who responsibly disclose vulnerabilities. Contributors who report valid security issues will be:
- Credited in the security advisory (unless they prefer to remain anonymous)
- Mentioned in release notes
- Added to our security acknowledgments
If you have questions about this security policy or need clarification on reporting procedures, please open a GitHub Discussion or email [email protected].
Thank you for helping keep pyrattler-recipe-autogen and our community safe! 🙏