If you discover a security vulnerability in ship-safe, please report it responsibly.
Do NOT open a public issue. Instead:
- Email the maintainers directly (check the npm package for contact info)
- Or use GitHub's private security advisory feature:
- Go to the repository's Security tab
- Click "Report a vulnerability"
Include:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)
We will acknowledge receipt within 48 hours and provide a timeline for resolution.
If you find that ship-safe is incorrectly flagging something as a secret:
- Open a regular GitHub issue
- Include the pattern that's causing false positives
- Explain why it's not actually a secret
If you know of a secret format that ship-safe should detect but doesn't:
- Open a GitHub issue or PR
- Include the pattern format
- Explain the risk if this secret is exposed
This security policy covers:
- The ship-safe npm package
- The ship-safe CLI tool
- Detection patterns and their accuracy
- Any code in this repository
Remember: ship-safe is a helper tool, not a guarantee. Always:
- Use multiple tools - Combine with gitleaks, trufflehog, or detect-secrets
- Enable pre-commit hooks - Catch secrets before they're committed
- Rotate exposed secrets immediately - Even if you delete them from git
- Use environment variables - Never hardcode secrets
- Regular audits - Run security scans as part of CI/CD
| Version | Supported |
|---|---|
| 4.x.x | ✅ |
| 3.x.x | ❌ |
| 2.x.x | ❌ |
| 1.x.x | ❌ |
We support the latest major version with security updates.