|
1 | 1 | { |
2 | | - "_comment": "OpenSSF Best Practices answers for the 'passing' tier. The bestpractices.dev BadgeApp reads this file from the repo root (per docs/bestpractices-json.md upstream) when the project is registered there, and uses each <criterion>_status / <criterion>_justification pair as the proposed answer. To trigger re-ingestion after edits, the maintainer opens the project's edit page on bestpractices.dev and clicks 'Save (and continue) 🤖'. Status '?' means 'unknown' and is ignored — safe placeholder. .github/workflows/bestpractices.yml lints this file on every push to main so it stays parseable and on-schema.", |
| 2 | + "_comment": "OpenSSF Best Practices answers for the 'passing' tier. The bestpractices.dev BadgeApp reads this file from the repo root (per docs/bestpractices-json.md upstream) when the project is registered there, and uses each <criterion>_status / <criterion>_justification pair as the proposed answer. To trigger re-ingestion after edits, the maintainer opens the project's edit page on bestpractices.dev and clicks 'Save (and continue) 🤖'. Status '?' means 'unknown' and is ignored — safe placeholder. .github/workflows/bestpractices.yml lints this file on every push to main so it stays parseable and on-schema. Per the upstream criteria, only the eight criteria with met_url_required=true (contribution, contribution_requirements, license_location, release_notes, report_process, report_archive, vulnerability_report_process, vulnerability_report_private) carry a bare URL in their justification; every other justification is prose only.", |
3 | 3 |
|
4 | 4 | "name": "ctm", |
5 | 5 | "description": "Claude Tmux Manager — survive SSH drops, reattach from your phone.", |
|
11 | 11 | "description_good_justification": "README opens with: 'Claude Tmux Manager — survive SSH drops, reattach from your phone.'", |
12 | 12 |
|
13 | 13 | "interact_status": "Met", |
14 | | - "interact_justification": "https://github.com/RandomCodeSpace/ctm/issues — GitHub Issues + Pull Requests are enabled.", |
| 14 | + "interact_justification": "GitHub Issues + Pull Requests are enabled.", |
15 | 15 |
|
16 | | - "contribution_status": "Unmet", |
17 | | - "contribution_justification": "CONTRIBUTING.md not yet authored. Tracked as follow-up; PRs are accepted via the standard GitHub flow in the meantime.", |
| 16 | + "contribution_status": "Met", |
| 17 | + "contribution_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/CONTRIBUTING.md", |
18 | 18 |
|
19 | | - "contribution_requirements_status": "Unmet", |
20 | | - "contribution_requirements_justification": "Will be documented in CONTRIBUTING.md once added.", |
| 19 | + "contribution_requirements_status": "Met", |
| 20 | + "contribution_requirements_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/CONTRIBUTING.md#coding-standards", |
21 | 21 |
|
22 | 22 | "floss_license_status": "Met", |
23 | | - "floss_license_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/LICENSE — MIT License.", |
| 23 | + "floss_license_justification": "MIT License.", |
24 | 24 |
|
25 | 25 | "floss_license_osi_status": "Met", |
26 | | - "floss_license_osi_justification": "MIT is OSI-approved (https://opensource.org/license/mit).", |
| 26 | + "floss_license_osi_justification": "MIT is OSI-approved.", |
27 | 27 |
|
28 | 28 | "license_location_status": "Met", |
29 | | - "license_location_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/LICENSE — LICENSE file at repository root.", |
| 29 | + "license_location_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/LICENSE", |
30 | 30 |
|
31 | 31 | "documentation_basics_status": "Met", |
32 | | - "documentation_basics_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/README.md documents installation, configuration, and primary commands.", |
| 32 | + "documentation_basics_justification": "README documents installation, configuration, and primary commands.", |
33 | 33 |
|
34 | 34 | "documentation_interface_status": "Met", |
35 | 35 | "documentation_interface_justification": "README has a Commands section listing every external interface (yolo, safe, attach, kill, list, ctm serve, etc.).", |
|
38 | 38 | "sites_https_justification": "All project URLs are GitHub-hosted and use HTTPS.", |
39 | 39 |
|
40 | 40 | "discussion_status": "Met", |
41 | | - "discussion_justification": "https://github.com/RandomCodeSpace/ctm/issues — GitHub Issues serve as the discussion forum.", |
| 41 | + "discussion_justification": "GitHub Issues serve as the discussion forum.", |
42 | 42 |
|
43 | 43 | "english_status": "Met", |
44 | 44 | "english_justification": "All documentation and source comments are in English.", |
|
59 | 59 | "repo_distributed_justification": "git is a distributed VCS.", |
60 | 60 |
|
61 | 61 | "version_unique_status": "Met", |
62 | | - "version_unique_justification": "https://github.com/RandomCodeSpace/ctm/tags — each release is tagged with a unique semver tag.", |
| 62 | + "version_unique_justification": "Each release is tagged with a unique semver tag.", |
63 | 63 |
|
64 | 64 | "version_semver_status": "Met", |
65 | 65 | "version_semver_justification": "Tags follow vMAJOR.MINOR.PATCH.", |
66 | 66 |
|
67 | 67 | "version_tags_status": "Met", |
68 | | - "version_tags_justification": "https://github.com/RandomCodeSpace/ctm/releases — releases are git-tagged.", |
| 68 | + "version_tags_justification": "Releases are git-tagged.", |
69 | 69 |
|
70 | 70 | "release_notes_status": "Met", |
71 | | - "release_notes_justification": "Each GitHub Release includes auto-generated notes summarising changes since the previous tag.", |
| 71 | + "release_notes_justification": "https://github.com/RandomCodeSpace/ctm/releases", |
72 | 72 |
|
73 | 73 | "release_notes_vulns_status": "N/A", |
74 | 74 | "release_notes_vulns_justification": "No publicly disclosed vulnerabilities to date.", |
75 | 75 |
|
76 | 76 | "report_process_status": "Met", |
77 | | - "report_process_justification": "Bug reports go through GitHub Issues; the README links to the Issues tab.", |
| 77 | + "report_process_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/CONTRIBUTING.md#reporting-bugs-or-asking-questions", |
78 | 78 |
|
79 | 79 | "report_tracker_status": "Met", |
80 | | - "report_tracker_justification": "https://github.com/RandomCodeSpace/ctm/issues — GitHub Issues.", |
| 80 | + "report_tracker_justification": "GitHub Issues.", |
81 | 81 |
|
82 | 82 | "report_responses_status": "Met", |
83 | 83 | "report_responses_justification": "Issues are triaged by the maintainer on a best-effort basis.", |
|
86 | 86 | "enhancement_responses_justification": "Feature requests via Issues receive a response (accept / defer / decline) on a best-effort basis.", |
87 | 87 |
|
88 | 88 | "report_archive_status": "Met", |
89 | | - "report_archive_justification": "GitHub Issues retains a full archive of reports and responses.", |
| 89 | + "report_archive_justification": "https://github.com/RandomCodeSpace/ctm/issues?q=is%3Aissue", |
90 | 90 |
|
91 | | - "vulnerability_report_process_status": "Unmet", |
92 | | - "vulnerability_report_process_justification": "SECURITY.md not yet authored. Tracked as follow-up; for now, security reports can be filed as a private security advisory on GitHub.", |
| 91 | + "vulnerability_report_process_status": "Met", |
| 92 | + "vulnerability_report_process_justification": "https://github.com/RandomCodeSpace/ctm/blob/main/SECURITY.md", |
93 | 93 |
|
94 | 94 | "vulnerability_report_private_status": "Met", |
95 | | - "vulnerability_report_private_justification": "https://github.com/RandomCodeSpace/ctm/security/advisories/new — GitHub's private security advisories are enabled.", |
| 95 | + "vulnerability_report_private_justification": "https://github.com/RandomCodeSpace/ctm/security/advisories/new", |
96 | 96 |
|
97 | 97 | "vulnerability_report_response_status": "Met", |
98 | | - "vulnerability_report_response_justification": "Maintainer commits to acknowledging vulnerability reports within 14 days; window will be formalised in SECURITY.md.", |
| 98 | + "vulnerability_report_response_justification": "Formal response targets in SECURITY.md: acknowledge within 14 days, initial assessment within 30 days, fix High/Critical within 60 days, default 90-day disclosure window.", |
99 | 99 |
|
100 | 100 | "build_status": "Met", |
101 | 101 | "build_justification": "Standard `go build -tags sqlite_fts5` builds the binary; `pnpm build` builds the embedded UI.", |
|
113 | 113 | "test_invocation_justification": "README documents `go test -tags sqlite_fts5 ./...` and `pnpm exec vitest run`.", |
114 | 114 |
|
115 | 115 | "test_most_status": "Met", |
116 | | - "test_most_justification": "https://sonarcloud.io/summary/overall?id=RandomCodeSpace_ctm — 85.2% line coverage.", |
| 116 | + "test_most_justification": "85.2% line coverage measured by SonarCloud across Go + TypeScript.", |
117 | 117 |
|
118 | 118 | "test_continuous_integration_status": "Met", |
119 | | - "test_continuous_integration_justification": "https://github.com/RandomCodeSpace/ctm/actions — GitHub Actions runs Go build/test, UI typecheck/test, SonarCloud, CodeQL, and Scorecard on every push and PR.", |
| 119 | + "test_continuous_integration_justification": "GitHub Actions runs Go build/test, UI typecheck/test, SonarCloud, CodeQL, and Scorecard on every push and PR.", |
120 | 120 |
|
121 | 121 | "test_policy_status": "Met", |
122 | 122 | "test_policy_justification": "New features must ship with tests; SonarCloud's new-code coverage gate fails PRs that drop coverage below threshold.", |
|
125 | 125 | "tests_are_added_justification": "PRs adding functionality include unit and/or integration tests; enforced by the new-code coverage gate.", |
126 | 126 |
|
127 | 127 | "tests_documented_added_status": "Met", |
128 | | - "tests_documented_added_justification": "test_policy is enforced in PR review and by the coverage gate; recent PRs (#11–#14) demonstrate the practice.", |
| 128 | + "tests_documented_added_justification": "test_policy is enforced in PR review and by the coverage gate.", |
129 | 129 |
|
130 | 130 | "warnings_status": "Met", |
131 | 131 | "warnings_justification": "go vet, gopls language-server checks, ESLint with strict TypeScript rules, and SonarCloud all run on every push.", |
|
161 | 161 | "crypto_weaknesses_justification": "No use of MD5, SHA1 (for integrity), DES, RC4, or ECB mode anywhere in the codebase.", |
162 | 162 |
|
163 | 163 | "crypto_pfs_status": "N/A", |
164 | | - "crypto_pfs_justification": "ctm binds 127.0.0.1 only; TLS termination is the operator's reverse-proxy responsibility (the README documents the dev.randomcodespace.dev fronting setup).", |
| 164 | + "crypto_pfs_justification": "ctm binds 127.0.0.1 only; TLS termination is the operator's reverse-proxy responsibility.", |
165 | 165 |
|
166 | 166 | "crypto_password_storage_status": "Met", |
167 | 167 | "crypto_password_storage_justification": "Passwords stored as argon2id hashes (V27 single-user auth); never logged or persisted in plaintext.", |
|
173 | 173 | "delivery_mitm_justification": "Releases delivered via HTTPS (GitHub Releases) with TLS-protected git fetch.", |
174 | 174 |
|
175 | 175 | "delivery_unsigned_status": "Met", |
176 | | - "delivery_unsigned_justification": "https://github.com/RandomCodeSpace/ctm/releases — release artifacts include SHA256 checksums via the release.yml workflow.", |
| 176 | + "delivery_unsigned_justification": "Release artifacts include SHA256 checksums via the release.yml workflow.", |
177 | 177 |
|
178 | 178 | "vulnerabilities_fixed_60_days_status": "Met", |
179 | 179 | "vulnerabilities_fixed_60_days_justification": "No publicly disclosed vulnerabilities to date; commitment is to address any future critical reports within 60 days.", |
|
185 | 185 | "no_leaked_credentials_justification": "SonarCloud's secret-detection rules + GitHub's secret scanning run on every push; no credentials in commit history.", |
186 | 186 |
|
187 | 187 | "static_analysis_status": "Met", |
188 | | - "static_analysis_justification": "https://sonarcloud.io/summary/overall?id=RandomCodeSpace_ctm — SonarCloud (Go + TypeScript) and CodeQL (security) run on every push and PR.", |
| 188 | + "static_analysis_justification": "SonarCloud (Go + TypeScript) and CodeQL (security) run on every push and PR.", |
189 | 189 |
|
190 | 190 | "static_analysis_common_vulnerabilities_status": "Met", |
191 | 191 | "static_analysis_common_vulnerabilities_justification": "CodeQL covers OWASP Top-10 vulnerability families; SonarCloud's security profile covers CWE Top-25.", |
192 | 192 |
|
193 | 193 | "static_analysis_fixed_status": "Met", |
194 | | - "static_analysis_fixed_justification": "Findings are either fixed in code or explicitly Accepted with a documented justification (see .github/workflows/sonar-bulk-accept.yml).", |
| 194 | + "static_analysis_fixed_justification": "Findings are either fixed in code or explicitly Accepted with a documented justification.", |
195 | 195 |
|
196 | 196 | "static_analysis_often_status": "Met", |
197 | 197 | "static_analysis_often_justification": "Static analysis runs on every push and PR — well exceeding the 'before each release' bar.", |
198 | 198 |
|
199 | | - "dynamic_analysis_status": "N/A", |
200 | | - "dynamic_analysis_justification": "ctm is a CLI / HTTP daemon; integration tests exercise the live HTTP surface, which is the realistic dynamic-analysis bar for this class of software.", |
| 199 | + "dynamic_analysis_status": "Met", |
| 200 | + "dynamic_analysis_justification": "`go test -race ./...` runs Go's runtime data-race detector on every PR and on every release. The race detector instruments memory accesses across goroutines and panics on a detected race; for a goroutine-heavy HTTP+tmux daemon this is the realistic dynamic-analysis tool.", |
201 | 201 |
|
202 | 202 | "dynamic_analysis_unsafe_status": "N/A", |
203 | | - "dynamic_analysis_unsafe_justification": "Go is memory-safe (no manual memory management, bounds-checked slices). The few unsafe.Pointer uses are inside the vendored sqlite3 driver.", |
| 203 | + "dynamic_analysis_unsafe_justification": "Go is memory-safe (no manual memory management; bounds-checked slices; nil-checked pointer dereferences). Race-detector coverage above provides the meaningful dynamic-safety check.", |
204 | 204 |
|
205 | | - "dynamic_analysis_enable_assertions_status": "N/A", |
206 | | - "dynamic_analysis_enable_assertions_justification": "Go has no compile-time assertion mechanism; runtime panics are used for invariant violations.", |
| 205 | + "dynamic_analysis_enable_assertions_status": "Met", |
| 206 | + "dynamic_analysis_enable_assertions_justification": "Go's runtime always enables bounds checking, nil-pointer panics, and `go test -race` adds happens-before assertions across goroutines. Test builds run with the race detector enabled; production builds inherit the language-level checks but omit the race detector.", |
207 | 207 |
|
208 | | - "dynamic_analysis_fixed_status": "N/A", |
209 | | - "dynamic_analysis_fixed_justification": "Same as dynamic_analysis." |
| 208 | + "dynamic_analysis_fixed_status": "Met", |
| 209 | + "dynamic_analysis_fixed_justification": "Any race-detector finding fails CI and must be fixed before merge." |
210 | 210 | } |
0 commit comments