keyhog 0.5.73

GPU-accelerated secret scanner for code, Git history, cloud, containers, browser assets, and live credential verification
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

//! Completion-summary and progress-ticker renderers, relocated out of the
//! `orchestrator::reporting` source module (the `*_no_inline_tests` folder
//! gates forbid inline `#[cfg(test)]`). The pure formatting functions are
//! reached through the `crate::testing` facade (`CliTestApi`).

use keyhog::testing::{CliTestApi as _, API};

fn finding(verification: keyhog_core::VerificationResult) -> keyhog_core::VerifiedFinding {
    use std::borrow::Cow;
    use std::sync::Arc;
    keyhog_core::VerifiedFinding {
        detector_id: Arc::from("aws-access-key"),
        detector_name: Arc::from("AWS Key"),
        service: Arc::from("aws"),
        severity: keyhog_core::Severity::High,
        credential_redacted: Cow::Borrowed("AKIA..."),
        credential_hash: [0u8; 32].into(),
        companions_redacted: std::collections::HashMap::new(),
        location: keyhog_core::MatchLocation {
            source: Arc::from("filesystem"),
            file_path: Some(Arc::from("a.txt")),
            line: Some(1),
            offset: 0,
            commit: None,
            author: None,
            date: None,
        },
        verification,
        metadata: std::collections::HashMap::new(),
        additional_locations: vec![],
        entropy: None,
        confidence: Some(0.9),
    }
}

fn finding_with(
    severity: keyhog_core::Severity,
    verification: keyhog_core::VerificationResult,
) -> keyhog_core::VerifiedFinding {
    let mut finding = finding(verification);
    finding.severity = severity;
    finding
}

#[test]
fn breakdown_tallies_each_verification_state() {
    use keyhog_core::VerificationResult as V;
    let findings = vec![
        finding(V::Live),
        finding(V::Live),
        finding(V::Revoked),
        finding(V::Dead),
        finding(V::Skipped),
        finding(V::Unverifiable),
        finding(V::RateLimited),
        finding(V::Error("boom".to_string())),
    ];
    let tally = API.verification_tally(&findings);
    assert_eq!(tally.live, 2);
    assert_eq!(tally.inactive, 2, "revoked + dead");
    assert_eq!(tally.skipped, 1);
    assert_eq!(tally.unverifiable, 1);
    assert_eq!(tally.incomplete, 2, "ratelimited + error");
}

#[test]
fn all_skipped_says_verification_did_not_run() {
    use keyhog_core::VerificationResult as V;
    let findings = vec![
        finding(V::Skipped),
        finding(V::Skipped),
        finding(V::Skipped),
    ];
    let line = API
        .render_verification_summary(&findings, false)
        .expect("line for >0 findings");
    assert!(
        line.contains("liveness check did not run"),
        "honest 'we did not try': {line}"
    );
    assert!(
        line.contains("not checked"),
        "posture should be explicit: {line}"
    );
    assert!(line.contains("--verify"), "points at the flag: {line}");
    // The all-skipped branch emits the prose message, never a count breakdown
    // so it cannot read as "1 live", and carries no `·` separator.
    assert!(
        !line.contains('·'),
        "all-skipped uses the prose message, not a breakdown: {line}"
    );
}

#[test]
fn mixed_states_render_breakdown_omitting_zeros() {
    use keyhog_core::VerificationResult as V;
    let findings = vec![finding(V::Live), finding(V::Revoked), finding(V::Skipped)];
    let line = API.render_verification_summary(&findings, false).unwrap();
    assert!(line.contains("1 live"), "{line}");
    assert!(line.contains("1 revoked/dead"), "{line}");
    assert!(line.contains("1 not checked"), "{line}");
    assert!(line.contains("verification:"), "{line}");
    assert!(
        !line.contains("no verifier"),
        "zero category omitted: {line}"
    );
    assert!(
        !line.contains("inconclusive"),
        "zero category omitted: {line}"
    );
}

#[test]
fn no_findings_yields_no_verification_line() {
    assert_eq!(API.render_verification_summary(&[], false), None);
}

#[test]
fn severity_summary_is_heat_ordered_and_color_gated() {
    use keyhog_core::Severity as S;
    use keyhog_core::VerificationResult as V;
    let findings = vec![
        finding_with(S::Low, V::Skipped),
        finding_with(S::Critical, V::Skipped),
        finding_with(S::High, V::Skipped),
        finding_with(S::ClientSafe, V::Skipped),
        finding_with(S::High, V::Skipped),
    ];
    let plain = API.render_severity_summary(&findings, false).unwrap();
    assert_eq!(
        plain,
        "↳ severity: 1 critical · 2 high · 1 low · 1 client-safe"
    );
    assert!(!plain.contains('\x1b'), "plain severity line: {plain:?}");
    let colored = API.render_severity_summary(&findings, true).unwrap();
    assert!(
        colored.contains('\x1b'),
        "colored severity line should use heat SGR codes: {colored:?}"
    );
    assert!(colored.contains("1 critical"), "{colored}");
    assert!(colored.contains("2 high"), "{colored}");
    assert_eq!(API.render_severity_summary(&[], true), None);
}

#[test]
fn verification_summary_colours_posture_without_plain_ansi() {
    use keyhog_core::VerificationResult as V;
    let findings = vec![
        finding(V::Live),
        finding(V::Skipped),
        finding(V::Error("e".into())),
    ];
    let plain = API.render_verification_summary(&findings, false).unwrap();
    assert_eq!(
        plain,
        "↳ verification: 1 live · 1 not checked · 1 inconclusive"
    );
    assert!(
        !plain.contains('\x1b'),
        "plain verification line: {plain:?}"
    );
    let colored = API.render_verification_summary(&findings, true).unwrap();
    assert!(
        colored.contains('\x1b'),
        "colored verification line should use posture SGR codes: {colored:?}"
    );
    assert!(colored.contains("1 live"), "{colored}");
    assert!(colored.contains("1 not checked"), "{colored}");
}

#[test]
fn verification_line_is_color_gated() {
    use keyhog_core::VerificationResult as V;
    let findings = vec![finding(V::Live)];
    assert!(
        !API.render_verification_summary(&findings, false)
            .unwrap()
            .contains('\x1b'),
        "plain mode is ansi-free"
    );
    assert!(
        API.render_verification_summary(&findings, true)
            .unwrap()
            .contains('\x1b'),
        "color mode carries SGR codes"
    );
}

#[test]
fn progress_bar_endpoints_and_width() {
    // Empty: all rail, no full blocks; correct cell count.
    let empty = API.render_progress_bar(0.0, 22, false);
    assert_eq!(empty.chars().count(), 22, "bar must be exactly width cells");
    assert_eq!(empty.chars().filter(|&c| c == 'â–ˆ').count(), 0);
    assert!(empty.chars().all(|c| c == 'â–‘'));
    // Full: all full blocks.
    let full = API.render_progress_bar(1.0, 22, false);
    assert_eq!(full.chars().filter(|&c| c == 'â–ˆ').count(), 22);
    assert!(!full.contains('â–‘'));
    // Half: ~11 full blocks (1/8-cell resolution rounds 0.5*22=11.0).
    let half = API.render_progress_bar(0.5, 22, false);
    assert_eq!(half.chars().filter(|&c| c == 'â–ˆ').count(), 11);
    // Clamp: out-of-range fractions never panic or overflow the width.
    assert_eq!(
        API.render_progress_bar(2.0, 22, false)
            .chars()
            .filter(|&c| c == 'â–ˆ')
            .count(),
        22
    );
    assert_eq!(API.render_progress_bar(-1.0, 22, false).chars().count(), 22);
}

#[test]
fn scanning_line_carries_pct_counts_findings_and_stage() {
    let line = API.render_scanning_ticker(50, 100, 3, 2.0, 0, false);
    assert!(line.contains("50%"), "percent: {line}");
    assert!(line.contains("50/100"), "scanned/total: {line}");
    assert!(line.contains("3 findings"), "lit findings: {line}");
    assert!(line.contains("scanning"), "stage label: {line}");
    // At 100% scanned the stage flips to finalizing and drops the ETA.
    let done = API.render_scanning_ticker(100, 100, 3, 2.0, 0, false);
    assert!(done.contains("finalizing"), "finalizing at full: {done}");
    assert!(!done.contains("eta"), "no eta once scanned==total: {done}");
}

#[test]
fn preparing_line_used_before_first_chunk() {
    let line = API.render_scanning_ticker(0, 0, 0, 0.4, 0, false);
    assert!(line.contains("preparing"), "pre-dispatch label: {line}");
    assert!(line.contains("0 findings"));
    assert!(
        !line.contains('%'),
        "no percent before total is known: {line}"
    );
}

#[test]
fn verification_line_carries_stage_and_candidate_count() {
    let line = API.render_verification_ticker(3, 1.2, 0, false);
    assert!(line.contains("verifying"), "stage label: {line}");
    assert!(
        line.contains("checking 3 secrets"),
        "candidate count: {line}"
    );
    assert!(
        !line.contains('%'),
        "verification is indeterminate until verifier results return: {line}"
    );
    let one = API.render_verification_ticker(1, 1.2, 0, false);
    assert!(one.contains("checking 1 secret"), "singular noun: {one}");
}

#[test]
fn reporting_line_carries_stage_and_finding_count() {
    let line = API.render_reporting_ticker(3, 1.2, 0, false);
    assert!(line.contains("reporting"), "stage label: {line}");
    assert!(line.contains("writing 3 findings"), "finding count: {line}");
    assert!(
        !line.contains('%'),
        "reporting is indeterminate while serialization/fsync runs: {line}"
    );
    let one = API.render_reporting_ticker(1, 1.2, 0, false);
    assert!(one.contains("writing 1 finding"), "singular noun: {one}");
}

#[test]
fn ticker_guard_stop_signals_and_joins_worker() {
    assert!(
        API.ticker_guard_spawns_and_joins(),
        "ticker guard must signal done and join its worker promptly"
    );
}

#[test]
fn plain_mode_emits_no_ansi_color_mode_does() {
    let plain = API.render_scanning_ticker(50, 100, 3, 2.0, 0, false);
    assert!(
        !plain.contains('\x1b'),
        "NO_COLOR line must be ansi-free: {plain:?}"
    );
    let verify_plain = API.render_verification_ticker(3, 1.2, 0, false);
    assert!(
        !verify_plain.contains('\x1b'),
        "plain verification line must be ansi-free: {verify_plain:?}"
    );
    let colored = API.render_scanning_ticker(50, 100, 3, 2.0, 0, true);
    assert!(colored.contains('\x1b'), "color line must carry SGR codes");
    let verify_colored = API.render_verification_ticker(3, 1.2, 0, true);
    assert!(
        verify_colored.contains('\x1b'),
        "color verification line must carry SGR codes"
    );
    let report_plain = API.render_reporting_ticker(3, 1.2, 0, false);
    assert!(
        !report_plain.contains('\x1b'),
        "plain reporting line must be ansi-free: {report_plain:?}"
    );
    let report_colored = API.render_reporting_ticker(3, 1.2, 0, true);
    assert!(
        report_colored.contains('\x1b'),
        "color reporting line must carry SGR codes"
    );
}

#[test]
fn fmt_secs_switches_to_minutes_past_a_minute() {
    assert_eq!(API.fmt_secs(8.25), "8.2s");
    assert_eq!(API.fmt_secs(59.94), "59.9s");
    assert_eq!(API.fmt_secs(59.95), "1m00s");
    assert_eq!(API.fmt_secs(59.96), "1m00s");
    assert_eq!(API.fmt_secs(64.0), "1m04s");
    assert_eq!(API.fmt_secs(119.6), "2m00s");
}