keyhog 0.5.40

keyhog: detects leaked credentials in source trees, git history, and cloud storage
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

use keyhog::baseline::Baseline;
use keyhog_core::{MatchLocation, Severity, VerificationResult, VerifiedFinding};
use std::collections::HashMap;
use std::sync::Arc;

fn make_finding(
    detector_id: &str,
    credential_hash: &str,
    file_path: Option<&str>,
) -> VerifiedFinding {
    VerifiedFinding {
        detector_id: Arc::from(detector_id),
        detector_name: Arc::from("Test Detector"),
        service: Arc::from("test"),
        severity: Severity::High,
        credential_redacted: "***".into(),
        credential_hash: test_hash(credential_hash),
        location: MatchLocation {
            source: Arc::from("filesystem"),
            file_path: file_path.map(Arc::from),
            line: Some(42),
            offset: 0,
            commit: None,
            author: None,
            date: None,
        },
        verification: VerificationResult::Skipped,
        metadata: HashMap::new(),
        additional_locations: Vec::new(),
        confidence: None,
    }
}

fn test_hash(seed: &str) -> [u8; 32] {
    let mut out = [0u8; 32];
    for (idx, byte) in seed.as_bytes().iter().copied().take(32).enumerate() {
        out[idx] = byte;
    }
    out
}

fn baseline_hash(seed: &str) -> String {
    format!("sha256:{}", keyhog_core::hex_encode(&test_hash(seed)))
}

#[test]
fn baseline_creation_produces_expected_entries() {
    let findings = vec![
        make_finding("github-pat", "abc123", Some("src/config.py")),
        make_finding("aws-key", "def456", Some("src/aws.py")),
    ];

    let baseline = Baseline::from_findings(&findings);
    assert_eq!(baseline.version, 1);
    assert_eq!(baseline.entries.len(), 2);
    assert_eq!(baseline.entries[0].detector_id, "aws-key");
    assert_eq!(baseline.entries[0].credential_hash, baseline_hash("def456"));
    assert_eq!(
        baseline.entries[0].file_path,
        Some("src/aws.py".to_string())
    );
    assert_eq!(baseline.entries[0].line, Some(42));
    assert_eq!(baseline.entries[0].status, "acknowledged");
}

#[test]
fn baseline_creation_dedupes_duplicate_credentials() {
    let findings = vec![
        make_finding("github-pat", "abc123", Some("src/config.py")),
        make_finding("github-pat", "abc123", Some("src/other.py")),
    ];

    let baseline = Baseline::from_findings(&findings);
    assert_eq!(baseline.entries.len(), 1);
    assert_eq!(baseline.entries[0].detector_id, "github-pat");
}

#[test]
fn baseline_suppresses_known_findings() {
    let findings = vec![
        make_finding("github-pat", "abc123", Some("src/config.py")),
        make_finding("aws-key", "def456", Some("src/aws.py")),
    ];

    let baseline = Baseline::from_findings(&findings);
    let suppressed = baseline.filter_new(&findings);
    assert!(suppressed.is_empty());
}

#[test]
fn baseline_does_not_suppress_new_findings() {
    let baseline =
        Baseline::from_findings(&[make_finding("github-pat", "abc123", Some("src/config.py"))]);
    let new_findings = vec![
        make_finding("github-pat", "abc123", Some("src/config.py")),
        make_finding("github-pat", "newhash", Some("src/new.py")),
    ];

    let filtered = baseline.filter_new(&new_findings);
    assert_eq!(filtered.len(), 1);
    assert_eq!(filtered[0].credential_hash, test_hash("newhash"));
}

#[test]
fn baseline_update_adds_new_findings() {
    let mut baseline =
        Baseline::from_findings(&[make_finding("github-pat", "abc123", Some("src/config.py"))]);
    let new_findings = vec![
        make_finding("github-pat", "abc123", Some("src/config.py")),
        make_finding("aws-key", "def456", Some("src/aws.py")),
    ];

    baseline.merge(&new_findings);
    assert_eq!(baseline.entries.len(), 2);
    let ids: Vec<_> = baseline
        .entries
        .iter()
        .map(|e| e.detector_id.as_str())
        .collect();
    assert!(ids.contains(&"github-pat"));
    assert!(ids.contains(&"aws-key"));
}

#[test]
fn baseline_save_and_load_roundtrip() {
    let tmp = tempfile::tempdir().unwrap();
    let path = tmp.path().join("baseline.json");
    let findings = vec![make_finding("github-pat", "abc123", Some("src/config.py"))];
    let baseline = Baseline::from_findings(&findings);

    baseline.save(&path).unwrap();
    let loaded = Baseline::load(&path).unwrap();

    assert_eq!(loaded, baseline);
}

#[test]
fn baseline_matching_ignores_file_path_and_line() {
    let findings = vec![make_finding("github-pat", "abc123", Some("src/config.py"))];
    let baseline = Baseline::from_findings(&findings);
    let moved_finding = make_finding("github-pat", "abc123", Some("src/moved.py"));

    assert!(baseline.contains(&moved_finding));
}

// ── Moved from src/baseline.rs (#[cfg(test)]) per the no_inline_tests_in_src
//    gate. findings-report-vs-baseline detection + actionable load error.
use keyhog::baseline::{looks_like_findings_report, BASELINE_VERSION};
use std::io::Write;

#[test]
fn findings_report_array_is_recognized() {
    // `scan --format json` emits a top-level ARRAY of findings.
    assert!(looks_like_findings_report(
        r#"[{"detector_id":"hot-github_pat","line":1}]"#
    ));
}

#[test]
fn findings_report_object_without_baseline_keys_is_recognized() {
    // An object lacking version+entries is not a baseline.
    assert!(looks_like_findings_report(r#"{"results":[],"summary":{}}"#));
}

#[test]
fn real_baseline_is_not_flagged_as_findings_report() {
    assert!(!looks_like_findings_report(
        r#"{"version":1,"created":"now","entries":[]}"#
    ));
}

#[test]
fn load_of_scan_report_gives_actionable_error_not_serde_noise() {
    // Regression: feeding a `scan --format json` report to `diff` used to
    // surface "invalid type: map, expected u32", which reads like file
    // corruption. It must instead name the right command.
    let mut tmp = tempfile::NamedTempFile::new().unwrap();
    write!(tmp, r#"[{{"detector_id":"hot-github_pat","line":1}}]"#).unwrap();
    let err = Baseline::load(tmp.path()).expect_err("a findings array is not a baseline");
    let msg = format!("{err:#}");
    assert!(
        msg.contains("--create-baseline"),
        "error must point at `--create-baseline`, got: {msg}"
    );
    assert!(
        !msg.contains("expected u32"),
        "raw serde noise must be suppressed, got: {msg}"
    );
}

#[test]
fn load_of_valid_baseline_roundtrips() {
    let b = Baseline::empty();
    let mut tmp = tempfile::NamedTempFile::new().unwrap();
    write!(tmp, "{}", serde_json::to_string(&b).unwrap()).unwrap();
    let loaded = Baseline::load(tmp.path()).expect("valid baseline loads");
    assert_eq!(loaded.version, BASELINE_VERSION);
}