keyhog-core 0.5.44

keyhog-core: shared data model and detector specifications for the KeyHog secret scanner
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

use super::report_common::sample_finding;
use crate::support::reporters::HtmlReporter;
use keyhog_core::{write_report, HtmlScanMetadata, ReportFormat};

fn render(finding: &keyhog_core::VerifiedFinding) -> String {
    let mut buf: Vec<u8> = Vec::new();
    {
        let mut reporter = HtmlReporter::new(&mut buf);
        reporter.report(finding).expect("report finding");
        reporter.finish().expect("finish");
    }
    String::from_utf8(buf).expect("utf8 html output")
}

fn raw_findings_json(out: &str) -> &str {
    let line = out
        .lines()
        .find(|l| l.trim_start().starts_with("const rawFindings = "))
        .expect("rawFindings assignment present");
    let start = line.find('[').expect("array opens");
    let end = line.rfind(']').expect("array closes");
    &line[start..=end]
}

fn render_with_metadata(metadata: HtmlScanMetadata) -> String {
    let mut buf: Vec<u8> = Vec::new();
    write_report(
        &mut buf,
        ReportFormat::Html {
            skip_summary: Vec::new(),
            metadata: Some(metadata),
        },
        &[],
    )
    .expect("finish html report");
    String::from_utf8(buf).expect("utf8 html output")
}

#[test]
fn html_emits_doctype_and_embeds_raw_findings() {
    let out = render(&sample_finding());

    assert!(out.starts_with("<!DOCTYPE html>\n"), "missing DOCTYPE");
    assert!(out.contains("<html lang=\"en\" data-theme=\"keyhog\">"));
    assert!(out.contains("<title>KeyHog Secret Scan Report</title>"));
    assert!(out.contains("const rawFindings = "));
    assert!(out.trim_end().ends_with("</html>"));

    let json = raw_findings_json(&out);
    let parsed: Vec<keyhog_core::VerifiedFinding> =
        serde_json::from_str(json).expect("embedded rawFindings is valid JSON array");
    assert_eq!(parsed.len(), 1);
    let finding = &parsed[0];
    assert_eq!(finding.detector_id.as_ref(), "aws-access-key");
    assert_eq!(finding.severity, keyhog_core::Severity::High);
    assert_eq!(finding.credential_redacted.as_ref(), "AKIA...7XYA");
    assert_eq!(finding.verification, keyhog_core::VerificationResult::Live);
    assert_eq!(finding.confidence, Some(0.875));
}

#[test]
fn html_json_escapes_quotes_in_detector_name() {
    let out = render(&sample_finding());
    let json = raw_findings_json(&out);
    // Quotes stay JSON-escaped, AND `<`/`>` are now `\uXXXX`-escaped before the
    // JSON is inlined into the <script> raw-text block so an attacker-controlled
    // field can never emit a literal `</script>` (stored-XSS fix, C3/C6/C7). The
    // value still JSON.parses back to the exact original string in the browser.
    assert!(json.contains("AWS Key, \\\"prod\\\" \\u003ca&b\\u003e"));
    // The raw, unescaped angle brackets must NOT appear in the inlined script.
    assert!(!json.contains("<a&b>"));
    assert!(json.contains("\"severity\":\"high\""));
}

#[test]
fn html_report_has_accessibility_affordances() {
    let out = render(&sample_finding());

    assert!(out.contains("aria-label=\"Report theme\""));
    assert!(out.contains("aria-label=\"Use KeyHog theme\""));
    assert!(out.contains("aria-pressed=\"true\""));
    assert!(out.contains("aria-live=\"polite\""));
    assert!(out.contains("aria-atomic=\"true\""));
    assert!(out.contains("role=\"tablist\""));
    assert!(out.contains("role=\"tab\" aria-selected=\"true\""));
    assert!(out.contains("<th scope=\"col\">Detector</th>"));
    assert!(out.contains("<th scope=\"col\">Verification</th>"));
    assert!(out.contains("button:focus-visible"));
    assert!(out.contains("tbody tr:focus-visible"));
    assert!(out.contains("btn.setAttribute('aria-pressed', 'true')"));
    assert!(out.contains("tab.setAttribute('aria-selected', 'true')"));
    assert!(out.contains("resultCount.innerText = `Showing ${count} of ${total} findings.`"));
    assert!(out.contains("tr.tabIndex = 0"));
    assert!(out.contains("tr.setAttribute('role', 'button')"));
    assert!(out.contains("toggleDetailsFromKeyboard"));
}

/// Lock in the Santh-house-style premium surface so a future edit cannot
/// silently strip the redesign, the interactive affordances, or the
/// accessibility guard rails that ship with them.
#[test]
fn html_report_ships_premium_santh_surface() {
    let out = render(&sample_finding());

    // Santh house style: keyhog-yellow accent token + sharp/grid canvas.
    assert!(
        out.contains("--accent-primary: #ffd60a"),
        "keyhog yellow token"
    );
    assert!(
        out.contains("[data-theme=\"light\"]") && out.contains("[data-theme=\"matrix\"]"),
        "KEYHOG/LIGHT/MATRIX theme set"
    );

    // Risk-posture hero.
    assert!(
        out.contains("id=\"risk-verdict\"") && out.contains("renderRiskHero"),
        "risk-posture hero present and populated"
    );

    // Click-to-sort columns (progressive enhancement; markup stays static).
    assert!(
        out.contains("wireSortableHeaders") && out.contains("COLUMN_SORTERS"),
        "sortable columns wired"
    );

    // Custom motion, gated for accessibility, plus the debounced search and
    // copy-to-clipboard affordance.
    assert!(
        out.contains("@keyframes kh-rise") && out.contains("kh-scanline"),
        "custom entrance + scanline animations"
    );
    assert!(
        out.contains("prefers-reduced-motion: no-preference"),
        "motion gated behind reduced-motion"
    );
    assert!(
        out.contains("applyFiltersDebounced"),
        "search input is debounced"
    );
    assert!(
        out.contains("function copyFrom"),
        "copy-to-clipboard affordance"
    );
    assert!(
        out.contains("function animateCount"),
        "count-up stat animation"
    );
    assert!(
        out.contains("SEVERITY_BADGE_CLASSES") && out.contains("function verificationDotClass"),
        "scan-derived badge/dot classes must be closed maps"
    );
}

#[test]
fn html_report_does_not_interpolate_scan_data_into_class_names() {
    let out = render(&sample_finding());

    assert!(
        !out.contains("badge-${"),
        "severity classes must be selected from a closed map, not interpolated"
    );
    assert!(
        out.contains("const severityClass = severityBadgeClass(finding.severity);"),
        "severity class map is wired"
    );
    assert!(
        out.contains("let statusClass = verificationDotClass(finding.verification);"),
        "verification dot class map is wired"
    );
}

#[test]
fn html_report_summary_surfaces_not_checked_findings() {
    let out = render(&sample_finding());

    assert!(
        out.contains("id=\"cnt-not-checked\"") && out.contains(">Not checked<"),
        "summary metrics must include an explicit not-checked count"
    );
    assert!(
        out.contains("const notChecked = allFindings.filter(f => verificationIsUnattempted(f.verification)).length;"),
        "summary not-checked count must reuse the canonical verification predicate"
    );
    assert!(
        out.contains("activeStatusTab === 'unverifiable' && !verificationIsUnattempted(status)"),
        "not-checked filter tab must include skipped and unverifiable findings consistently"
    );
    assert!(
        out.contains("setStat('cnt-not-checked', notChecked, isInitial);"),
        "summary not-checked count must be wired into renderMetrics"
    );
}

#[test]
fn html_report_service_bars_and_badges_are_contrast_guarded() {
    let out = render(&sample_finding());

    assert!(
        out.contains("const SERVICE_BAR_COLORS = [")
            && out.contains("function serviceBarColor(rank)")
            && out
                .contains("item.style.setProperty('--service-bar-color', serviceBarColor(rank));"),
        "Top Services bars must use a closed palette instead of one flat accent or scan-derived CSS"
    );
    assert!(
        out.contains(".chart-bar-fill { height: 100%; background: var(--service-bar-color, var(--accent-primary)); }"),
        "service bar fill must consume the closed palette custom property"
    );
    assert!(
        !out.contains("background-color: var(--accent-primary);"),
        "Top Services bars must not regress to one flat accent color"
    );
    assert!(
        out.contains("--badge-critical-ink:")
            && out.contains("--badge-high-ink:")
            && out.contains("--badge-medium-ink:"),
        "filled heat badges need explicit per-theme ink tokens"
    );
    assert!(
        out.contains(".badge-critical    { color: var(--badge-critical-ink); background: var(--color-critical); border-color: var(--color-critical); }")
            && out.contains(".badge-high        { color: var(--badge-high-ink);     background: var(--color-high);     border-color: var(--color-high); }")
            && out.contains(".badge-medium      { color: var(--badge-medium-ink);   background: var(--color-medium);   border-color: var(--color-medium); }"),
        "critical/high/medium badges must be filled heat badges with explicit contrast text"
    );
}

#[test]
fn html_report_embeds_scan_metadata_panel() {
    let out = render_with_metadata(HtmlScanMetadata {
        scan_id: "scan-test-id".to_string(),
        scan_status: keyhog_core::ScanCompletionStatus::Success,
        backend_recoveries: Vec::new(),
        keyhog_version: "1.2.3".to_string(),
        git_hash: "test-git".to_string(),
        detector_digest: "test-detectors".to_string(),
        config_digest: None,
        resolved_scan: None,
        generated_at: "2026-06-23T12:00:01".to_string(),
        scan_started_at: "2026-06-23T12:00:00".to_string(),
        scan_finished_at: "2026-06-23T12:00:01".to_string(),
        duration_ms: 1234,
        targets: vec!["path:/tmp/repo".to_string()],
        source_chunks_scanned: 37,
        source_bytes_scanned: 2368,
        detector_count: 899,
    });

    assert!(out.contains("id=\"scan-metadata\""));
    assert!(out.contains("const scanMetadata = "));
    assert!(out.contains("\"scan_id\":\"scan-test-id\""));
    assert!(out.contains("\"scan_status\":\"success\""));
    assert!(out.contains("\"keyhog_version\":\"1.2.3\""));
    assert!(out.contains("\"targets\":[\"path:\\u002ftmp\\u002frepo\"]"));
    assert!(out.contains("\"source_chunks_scanned\":37"));
    assert!(out.contains("\"source_bytes_scanned\":2368"));
    assert!(out.contains("\"detector_count\":899"));
    assert!(out.contains("renderScanMetadata"));
    assert!(out.contains("meta-source-chunks"));
    assert!(out.contains("meta-source-bytes"));
    assert!(out.contains("meta-scan-id"));
    assert!(out.contains("meta-scan-status"));
    assert!(out.contains("@media print"));
}

#[test]
fn html_report_does_not_embed_plaintext_unmask_controls() {
    let out = render(&sample_finding());

    assert!(
        !out.contains("toggleMask"),
        "HTML report must not ship a dead or plaintext-revealing credential toggle"
    );
    assert!(
        !out.contains("data-plaintext"),
        "HTML report must not embed a plaintext credential copy"
    );
    assert!(
        !out.contains("Show secret"),
        "HTML report must not promise a plaintext reveal path"
    );
    assert!(
        out.contains("<span id=\"cred-text-${idx}\">${credRedacted}</span>"),
        "report script should render the redacted credential as static text"
    );
}