We actively maintain security updates for the following versions:
Version | Supported | End of Life |
---|---|---|
1.x.x | ✅ | TBD |
0.x.x | ❌ | 2024-12-31 |
This project follows these security best practices:
- Dependency Scanning: Automatic OWASP dependency checks
- Code Analysis: CodeQL security analysis on all commits
- Secret Scanning: Automated detection of exposed secrets
- Signed Commits: All commits must be cryptographically signed
- Branch Protection: Main branch requires reviews and status checks
We take security vulnerabilities seriously. Please follow responsible disclosure:
- Use GitHub's Security Advisories
- Click "Report a vulnerability"
- Provide detailed information about the vulnerability
If you prefer email, contact: [email protected]
- Use PGP encryption if possible
- Include "SECURITY" in the subject line
- Do not open public issues for security vulnerabilities
- Do not disclose vulnerabilities on social media
- Do not attempt to exploit vulnerabilities on production systems
When reporting a vulnerability, please include:
- Description: Clear explanation of the vulnerability
- Impact: Potential security impact and affected components
- Reproduction: Step-by-step instructions to reproduce
- Environment: Affected versions, configurations, dependencies
- Fix Suggestions: Any ideas for remediation (optional)
- Acknowledgment: We'll acknowledge receipt within 24 hours
- Investigation: Initial assessment within 72 hours
- Updates: Regular progress updates every 7 days
- Resolution: Security patch and advisory publication
- Recognition: Credit to reporter (if desired)
- Security fixes are prioritized and released as soon as possible
- Critical vulnerabilities may trigger emergency releases
- Security advisories are published for all confirmed vulnerabilities
- Users are notified through GitHub releases and security advisories
- Spring Bulk Layered Cache library code
- Build and deployment configurations
- Documentation that could lead to insecure usage
- Third-party dependencies (report to upstream projects)
- Issues in example applications or demos
- General configuration issues not related to security
Currently, we do not offer a formal bug bounty program, but we recognize and credit security researchers who help improve our project's security.
To speed up OWASP dependency vulnerability scanning, you can optionally configure a free NVD API key:
- Security scans still work perfectly
- Database updates are just much slower (5-10 minutes vs 30 seconds)
- You'll see the warning: "An NVD API Key was not provided"
- No functionality is lost - just slower performance
✅ With Free API Key:
- Much faster vulnerability database updates
- Same functionality, better performance
- No cost involved
How to get your FREE API key:
- Visit: NVD API Key Request (FREE)
- Provide: Just your email address
- Receive: API key sent instantly to your email
- Add to GitHub Secrets: Go to repository Settings → Secrets and variables → Actions
- Add secret:
NVD_API_KEY
with your API key value
Cost: $0.00 - Completely free service from NIST
The security scanning workflow uses OWASP Dependency Check to identify vulnerable dependencies:
- Automatic Updates: Downloads latest vulnerability database
- Fail Threshold: Builds fail on High/Critical vulnerabilities (CVSS ≥ 7.0)
- Suppressions: Use
owasp-suppressions.xml
to suppress false positives - Reports: Generates HTML and JSON reports for analysis
Commands:
# Run security scan
./gradlew dependencyCheckAggregate
# View report
open build/reports/dependency-check-report.html
- Automatic Detection: Weekly scans create GitHub issues for new vulnerabilities
- Dependency Updates: Automated PRs update vulnerable dependencies
- Build Protection: High/Critical vulnerabilities block PR merges
- Suppression: Use suppressions for false positives or accepted risks
Thank you for helping keep Spring Bulk Layered Cache secure! 🔒