|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Supported Versions |
| 4 | + |
| 5 | +We actively maintain and provide security updates for the following versions: |
| 6 | + |
| 7 | +| Version | Supported | |
| 8 | +| ------- | ------------------ | |
| 9 | +| 1.x.x | :white_check_mark: | |
| 10 | + |
| 11 | +## Reporting a Vulnerability |
| 12 | + |
| 13 | +We take security vulnerabilities seriously. If you discover a security vulnerability in this GitHub Action, please report it responsibly. |
| 14 | + |
| 15 | +### How to Report |
| 16 | + |
| 17 | +1. **Do not** create a public GitHub issue for security vulnerabilities |
| 18 | +2. Email security details to: [security@quantcdn.com](mailto:security@quantcdn.com) |
| 19 | +3. Include the following information: |
| 20 | + - Description of the vulnerability |
| 21 | + - Steps to reproduce the issue |
| 22 | + - Potential impact assessment |
| 23 | + - Any suggested fixes or mitigations |
| 24 | + |
| 25 | +### What to Expect |
| 26 | + |
| 27 | +- We will acknowledge receipt of your report within 48 hours |
| 28 | +- We will provide regular updates on our progress |
| 29 | +- We will work with you to understand and resolve the issue |
| 30 | +- We will coordinate the disclosure timeline with you |
| 31 | +- We will credit you in our security advisories (unless you prefer to remain anonymous) |
| 32 | + |
| 33 | +### Response Timeline |
| 34 | + |
| 35 | +- **Initial Response**: Within 48 hours |
| 36 | +- **Status Update**: Within 7 days |
| 37 | +- **Resolution**: Depends on severity and complexity |
| 38 | + |
| 39 | +## Security Best Practices |
| 40 | + |
| 41 | +### For Users of This Action |
| 42 | + |
| 43 | +- Always use the latest version of this action |
| 44 | +- Regularly review and update your dependencies |
| 45 | +- Use environment variables for sensitive data (API keys, tokens) |
| 46 | +- Never commit secrets to your repository |
| 47 | +- Review action permissions and use least-privilege access |
| 48 | +- Monitor action runs for unexpected behaviour |
| 49 | + |
| 50 | +### For Contributors |
| 51 | + |
| 52 | +- Follow secure coding practices |
| 53 | +- Validate all inputs thoroughly |
| 54 | +- Use parameterised queries and avoid string concatenation |
| 55 | +- Implement proper error handling without exposing sensitive information |
| 56 | +- Keep dependencies up to date |
| 57 | +- Review all pull requests for security implications |
| 58 | + |
| 59 | +## Dependencies |
| 60 | + |
| 61 | +This action uses the following key dependencies: |
| 62 | + |
| 63 | +- `@actions/core`: GitHub's core action utilities |
| 64 | +- `@actions/exec`: GitHub's execution utilities |
| 65 | +- `quant-ts-client`: Quant Cloud TypeScript client |
| 66 | + |
| 67 | +We monitor these dependencies for security vulnerabilities and update them regularly. |
| 68 | + |
| 69 | +## Security Updates |
| 70 | + |
| 71 | +Security updates will be: |
| 72 | +- Released as patch versions (e.g., 1.0.1, 1.0.2) |
| 73 | +- Documented in release notes |
| 74 | +- Communicated through GitHub releases |
| 75 | +- Backported to supported versions when possible |
| 76 | + |
| 77 | +## Contact |
| 78 | + |
| 79 | +For security-related questions or concerns: |
| 80 | +- Email: [security@quantcdn.com](mailto:security@quantcdn.com) |
| 81 | +- GitHub Security Advisories: [View advisories](https://github.com/quantcdn/quant-cloud-init-action/security/advisories) |
| 82 | + |
| 83 | +## Acknowledgments |
| 84 | + |
| 85 | +We appreciate the security research community and responsible disclosure practices. Thank you for helping keep our software secure. |
0 commit comments