We actively support the following versions of the OpenGrep Action:
| Version | Supported |
|---|---|
| 1.x.x | ✅ |
| < 1.0 | ❌ |
We take security vulnerabilities seriously. If you discover a security vulnerability in the OpenGrep Action, please follow responsible disclosure practices.
Please do NOT report security vulnerabilities through public GitHub issues.
Instead, please report security vulnerabilities by:
- Email: Send details to [security@platformsecurity.dev]
- GitHub Security Advisories: Use the private vulnerability reporting feature on GitHub
When reporting a security vulnerability, please include:
- A clear description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Any suggested fixes (if applicable)
- Your contact information for follow-up
- Initial Response: Within 48 hours
- Status Update: Within 7 days
- Fix Timeline: Varies based on severity and complexity
This GitHub Action implements several security hardening measures:
- All user inputs are validated and sanitized
- File paths are restricted to prevent directory traversal attacks
- Pattern inputs are validated to prevent code injection
- Runs with minimal privileges
- Uses official base images with security updates
- Implements proper secret handling
- Sanitizes output to prevent log injection
- Securely handles sensitive data in scan results
- Implements proper error handling without information disclosure
When using this action, follow these security best practices:
- Limit action permissions using
permissionsin workflow files - Review action permissions regularly
permissions:
contents: read
security-events: write
pull-requests: write- Pin action references to full commit SHAs instead of version tags, branches, or latest aliases
# Good - full commit SHA
uses: platform-sec/opengrep-action@52ffd7b1acae92f0bf27d40187f3bbd9ab382b31
# Bad - moving target references such as branches or mutable tags-
Path Traversal Prevention
- Always use relative paths within the repository
- Validate target directories exist and are within expected bounds
-
Resource Limits
- Set appropriate timeouts to prevent resource exhaustion
- Use
max-target-bytesto limit file size processing
-
Output Handling
- Be cautious when processing scan results
- Sanitize output before displaying in logs or comments
This action relies on:
- OpenGrep/Semgrep security scanner
- Official GitHub Actions toolkit
- Node.js runtime environment
- Dependencies are regularly updated for security patches
- We use dependabot for automated dependency updates
- All dependencies are scanned for known vulnerabilities
- Detection: Security issues are identified through various channels
- Assessment: Severity and impact are evaluated
- Response: Immediate containment and fix development
- Communication: Transparent communication with users
- Recovery: Deploy fixes and verify resolution
- Learning: Post-incident review and process improvement
- Critical: Immediate threat to user security or data
- High: Significant security vulnerability with potential for exploitation
- Medium: Security vulnerability with limited impact or difficult exploitation
- Low: Minor security issues or hardening opportunities
Stay informed about security updates through:
- GitHub Security Advisories
- Release notes for security patches
- Watch this repository for security-related announcements
- Security fixes are prioritized and fast-tracked
- Patches are thoroughly tested before release
- Users are notified through multiple channels
- Clear upgrade instructions are provided
For security-related questions or concerns:
- Security Team: security@platformsecurity.dev
- General Issues: Use GitHub Issues for non-security bugs
- Documentation: Refer to README.md for usage questions