Use this section to tell people about which versions of your project are currently being supported with security updates.
| SDK | Version | Supported |
|---|---|---|
| JVM | 0.x.x | ✅ |
We take security vulnerabilities seriously and appreciate your efforts to responsibly disclose them.
Please do not report security vulnerabilities through public GitHub issues.
Instead, please use one of the following methods:
-
GitHub Security Advisories (preferred): Go to the Security tab of our repository and click "Report a vulnerability"
-
Email: Send an email to security@typeflows.io with:
- A clear description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Any suggested fixes (if available)
- Acknowledgement: We will acknowledge receipt of your report within 48 hours
- Initial Assessment: We will provide an initial assessment within 5 business days
- Updates: You can expect regular updates on our progress at least every 7 days
- Resolution: We aim to resolve critical vulnerabilities within 30 days
- Accepted vulnerabilities: We will work with you to coordinate disclosure after a fix is available
- Declined reports: We will explain our reasoning and may suggest alternative reporting channels if appropriate
- Public disclosure: Security advisories will be published after fixes are deployed
This security policy applies to:
- The core TypeFlows SDK and libraries for all languages published through organisational accounts:
- JVM: Maven Central group:
io.typeflows - Python: PyPI organisation:
typeflows - Typescript: NPM organisation:
typeflows
- JVM: Maven Central group:
- Official TypeFlows CLI tools
- The documentation website ([https://typeflows.io])
We believe in recognising security researchers who help make TypeFlows more secure:
- Researchers who report valid vulnerabilities will be credited in our security advisories (with their permission)
- We maintain a Hall of Fame for contributors
Currently, we do not offer a paid bug bounty programme. However, we deeply appreciate responsible disclosure and will acknowledge your contribution publicly.
When using TypeFlows:
- Keep Updated: Always use the latest version of TypeFlows
- Review Generated Code: Inspect generated workflows and repository contents before merging into main repository branches
- Secrets Management: Use GitHub secrets appropriately - never hardcode sensitive values
- Permissions: Follow the principle of least privilege for workflow permissions
- Dependencies: Regularly audit and update your dependencies
If you have questions about this security policy, please contact us at security@typeflows.io.