|
1 | 1 | # Security Policy |
2 | 2 |
|
3 | | -**Commit Check** takes the security of our software seriously. This policy outlines our approach to vulnerability management, supported versions, and how to report security issues. |
4 | | - |
5 | | -## Supported Versions |
6 | | - |
7 | | -The following versions of Commit Check projects are currently receiving security updates: |
8 | | - |
9 | | -| Project / Component | Status | Supported Versions | |
10 | | -|---------------------|--------|--------------------| |
11 | | -| [commit-check](https://github.com/commit-check/commit-check) (CLI) | 🟢 Active | Latest minor (semver) | |
12 | | -| [commit-check-action](https://github.com/commit-check/commit-check-action) (GitHub Action) | 🟢 Active | Latest major version | |
13 | | -| commit-check-mcp (MCP Server) | 🔧 Experimental | See project README | |
14 | | - |
15 | | -> **Note:** Only the **latest** minor/patch release of each project receives security patches. |
16 | | -> Users are strongly encouraged to keep their dependencies up to date. |
17 | | -
|
18 | | -### End-of-Life Components |
19 | | - |
20 | | -No components are currently end-of-life. EOL status will be documented here when applicable. |
21 | | - |
22 | | -## SLSA & Supply Chain Security |
23 | | - |
24 | | -Commit Check is working toward **SLSA Level 3** compliance across our build and release pipeline. |
25 | | - |
26 | | -| Requirement | Status | Details | |
27 | | -|-------------|--------|---------| |
28 | | -| Build provenance | ✅ | Verifiable attestations via GitHub Actions | |
29 | | -| Source integrity | ✅ | Signed tags and commits where possible | |
30 | | -| Isolated builds | ✅ | Ephemeral CI environments | |
31 | | -| Reproducible builds | 🔄 | In progress | |
32 | | -| SLSA badge | 🏗️ | Pending Level 3 verification | |
33 | | - |
34 | | -Security-related SLSA metadata is published with each release. See individual project repositories for the latest SLSA badge and attestation details. |
| 3 | +If you find a security vulnerability in any Commit Check project, please report it privately. |
35 | 4 |
|
36 | 5 | ## Reporting a Vulnerability |
37 | 6 |
|
38 | | -We encourage responsible disclosure. **Please do not report security vulnerabilities via public GitHub issues.** |
39 | | - |
40 | | -### Private Disclosure (Recommended) |
41 | | - |
42 | | -1. **Email** — Send details to **[xianpeng.shen@gmail.com](mailto:xianpeng.shen@gmail.com)** |
43 | | -2. **Encryption** — If the issue is sensitive, please encrypt your report using our PGP key (see below). |
44 | | -3. **Response** — You will receive an acknowledgment within **48 hours**, followed by a detailed assessment and remediation timeline. |
45 | | - |
46 | | -### GitHub Security Advisories |
| 7 | +**Do not open a public GitHub issue.** Instead, send an email to: |
47 | 8 |
|
48 | | -For projects that have the feature enabled, you may also report via **GitHub Security Advisories** under the "Security" tab of the affected repository. This method provides a private channel and optionally allows you to participate in the fix. |
| 9 | +**[xianpeng.shen@gmail.com](mailto:xianpeng.shen@gmail.com)** |
49 | 10 |
|
50 | | -### What to Include |
| 11 | +Please include: |
51 | 12 |
|
52 | | -To help us triage and fix the issue quickly, please provide: |
| 13 | +- Which project and version is affected |
| 14 | +- A description of the issue and its impact |
| 15 | +- Steps to reproduce (or a proof of concept) |
53 | 16 |
|
54 | | -- **Project and version** affected |
55 | | -- **Description** of the vulnerability (type, impact) |
56 | | -- **Steps to reproduce** — minimal, self-contained example preferred |
57 | | -- **Proof of concept** (if available) |
58 | | -- **Suggested fix** (optional but appreciated) |
| 17 | +You will receive an acknowledgment within 48 hours, followed by a plan for resolution. |
59 | 18 |
|
60 | | -### What to Expect |
61 | | - |
62 | | -| Timeframe | Action | |
63 | | -|-----------|--------| |
64 | | -| ≤ 48 hours | Acknowledgment of receipt | |
65 | | -| 5–10 days | Initial triage and severity assessment | |
66 | | -| ≤ 30 days | Fix released (critical/high severity) | |
67 | | -| ≤ 90 days | Fix released (moderate/low severity) | |
68 | | - |
69 | | -We will keep the reporter informed throughout the process and will credit you in the security advisory (unless you prefer to remain anonymous). |
70 | | - |
71 | | -## PGP Key |
72 | | - |
73 | | -For encrypted communication: |
74 | | - |
75 | | -``` |
76 | | -Key ID: [TBD] |
77 | | -Fingerprint: [TBD] |
78 | | -``` |
79 | | - |
80 | | -> **Note:** A dedicated security PGP key is being provisioned. In the interim, |
81 | | -> plain-text email to [xianpeng.shen@gmail.com](mailto:xianpeng.shen@gmail.com) is preferred. |
82 | | -
|
83 | | -## Security Practices |
84 | | - |
85 | | -### For Maintainers |
86 | | - |
87 | | -- All code changes go through **pull request review** with at least one approval. |
88 | | -- **Signed commits** are required for all repositories. |
89 | | -- **Branch protection** is enforced on `main` for all active repos. |
90 | | -- Secrets are managed via GitHub Actions secrets — never hard-coded. |
91 | | -- Dependency updates are reviewed via automated Dependabot / Renovate PRs. |
92 | | - |
93 | | -### For Contributors |
94 | | - |
95 | | -- Follow our [CONTRIBUTING.md](CONTRIBUTING.md) guidelines. |
96 | | -- Do not include credentials, tokens, or secrets in code, commits, or issues. |
97 | | -- If you discover a potential vulnerability, follow the reporting process above. |
98 | | - |
99 | | -## Related Resources |
| 19 | +## Supported Versions |
100 | 20 |
|
101 | | -- [SLSA Framework](https://slsa.dev) |
102 | | -- [GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories) |
103 | | -- [OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org) |
104 | | -- [commit-check documentation](https://commit-check.github.io) |
| 21 | +Only the latest release of each project receives security patches. Please keep your dependencies up to date. |
0 commit comments