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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
//! Offline release lifecycle coverage through the library-only endpoint seam.
//!
//! Production `update` and `repair` have no endpoint override. These tests
//! inject an HTTP server directly into release resolution and the shared
//! signature, checksum, download, and atomic install path.

use std::process::Command;

use httpmock::prelude::*;
use keyhog::testing::{CliTestApi as _, ResolvedRelease, API};

use crate::reliability::harness::binary;

const FIXTURE_DATA: &[u8] = b"keyhog-signature-test-v1\n";
const FIXTURE_SIG: &str = "untrusted comment: signature from rsign secret key\n\
RUTPnJ/p6xVJ3REkJ9dhxwKQpEisq7Y2A4uIZlUzPRM0zDjWidV3sIXjHB8d558++9M0KpCpz6T8efYlVFl/RZhrKIznrUZSGww=\n\
trusted comment: timestamp:1780025193\tfile:/tmp/claude-1000/tmp.JTQWgRt5FO/fixture.bin\tprehashed\n\
L/wvGiwIhpaBlkEUaQ364Q8ph9ksqIxJyIMy1RQbs/QS4+q8biUaJGt+0weV4E0IV/pPHywDFtZhvUD03un2CA==\n";
const FIXTURE_SHA256: &str = "79792c6a6ce7cccb7d14cadf57006754b70a3e90a944cdaaf111ae97f03fbee8";

fn release_value(tag: &str, base: &str) -> serde_json::Value {
    let mut assets = Vec::new();
    for binary in [
        "keyhog-linux-x86_64",
        "keyhog-macos-aarch64",
        "keyhog-macos-x86_64",
        "keyhog-windows-x86_64.exe",
    ] {
        for suffix in [
            "",
            ".sha256",
            ".minisig",
            ".gpu-literals.tar.gz",
            ".gpu-literals.tar.gz.sha256",
            ".gpu-literals.tar.gz.minisig",
        ] {
            let name = format!("{binary}{suffix}");
            assets.push(serde_json::json!({
                "name": name,
                "browser_download_url": format!("{base}/download/{binary}{suffix}"),
            }));
        }
    }
    for suffix in ["", ".sha256", ".minisig"] {
        assets.push(serde_json::json!({
            "name": format!("fixture.bin{suffix}"),
            "browser_download_url": format!("{base}/download/fixture.bin{suffix}"),
        }));
    }
    serde_json::json!({
        "tag_name": tag,
        "draft": false,
        "prerelease": false,
        "assets": assets,
    })
}

fn releases_body(tag: &str, base: &str) -> String {
    serde_json::json!([release_value(tag, base)]).to_string()
}

fn releases_mock(server: &MockServer, status: u16, body: &str) {
    server.mock(|when, then| {
        when.method(GET).path("/repos/santhreal/keyhog/releases");
        then.status(status)
            .header("content-type", "application/json")
            .body(body);
    });
}

async fn resolve(base: &str, version: Option<&str>) -> anyhow::Result<ResolvedRelease> {
    let client = API.http_client()?;
    API.resolve_release_at(&client, version, base).await
}

fn private_install_directory() -> tempfile::TempDir {
    let directory = tempfile::tempdir().expect("installer target directory");
    #[cfg(unix)]
    {
        use std::os::unix::fs::PermissionsExt as _;
        std::fs::set_permissions(directory.path(), std::fs::Permissions::from_mode(0o700))
            .expect("make installer target private");
    }
    directory
}

#[test]
fn shipped_update_and_repair_reject_release_api_base() {
    for command in ["update", "repair"] {
        let output = Command::new(binary())
            .args([command, "--release-api-base", "http://127.0.0.1:9"])
            .output()
            .unwrap_or_else(|error| panic!("run keyhog {command}: {error}"));
        assert_eq!(
            output.status.code(),
            Some(2),
            "{command} must reject the removed flag"
        );
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(
            stderr.contains("unexpected argument") && stderr.contains("--release-api-base"),
            "{command} must reject the test-only flag before any network access: {stderr}"
        );
    }
}

#[tokio::test]
async fn newer_release_resolves_through_library_injection() {
    let server = MockServer::start();
    releases_mock(&server, 200, &releases_body("v99.0.0", &server.base_url()));
    let release = resolve(&server.base_url(), None)
        .await
        .expect("resolve release");
    assert_eq!(release.tag_name, "v99.0.0");
    assert!(release.asset_name.starts_with("keyhog-"));
}

#[tokio::test]
async fn empty_injected_base_does_not_fall_back_to_github() {
    let error = resolve(" / ", None).await.unwrap_err();
    assert!(format!("{error:#}").contains("injected release API base is empty"));
}

#[tokio::test]
async fn assetless_release_is_not_installable() {
    let server = MockServer::start();
    releases_mock(
        &server,
        200,
        r#"[{"tag_name":"v99.0.0","draft":false,"prerelease":false,"assets":[]}]"#,
    );
    let error = resolve(&server.base_url(), None).await.unwrap_err();
    assert!(format!("{error:#}").contains("complete signed asset bundle"));
}

#[tokio::test]
async fn incomplete_newer_release_is_skipped_for_complete_stable_bundle() {
    let server = MockServer::start();
    let body = serde_json::json!([
        {
            "tag_name": "v100.0.0",
            "assets": [{"name": "keyhog-linux-x86_64", "browser_download_url": "http://example.invalid/partial"}]
        },
        release_value("v99.0.0", &server.base_url())
    ]);
    releases_mock(&server, 200, &body.to_string());
    let release = resolve(&server.base_url(), None)
        .await
        .expect("resolve complete release");
    assert_eq!(release.tag_name, "v99.0.0");
}

#[tokio::test]
async fn prerelease_is_not_selected_as_implicit_latest() {
    let server = MockServer::start();
    let mut prerelease = release_value("v100.0.0-rc.1", &server.base_url());
    prerelease["prerelease"] = serde_json::Value::Bool(true);
    let body = serde_json::json!([prerelease, release_value("v99.0.0", &server.base_url())]);
    releases_mock(&server, 200, &body.to_string());
    let release = resolve(&server.base_url(), None)
        .await
        .expect("resolve stable release");
    assert_eq!(release.tag_name, "v99.0.0");
}

#[tokio::test]
async fn hostile_release_metadata_fails_closed() {
    for (name, status, body) in [
        (
            "malformed JSON",
            200,
            "{ this is not valid json at all ][".to_string(),
        ),
        (
            "truncated JSON",
            200,
            "[{\"tag_name\":\"v9.9.9\",\"assets\":[".to_string(),
        ),
        (
            "HTML body",
            200,
            "<!DOCTYPE html><html>502</html>".to_string(),
        ),
        ("server error", 500, "internal server error".to_string()),
        (
            "rate limit",
            403,
            r#"{"message":"API rate limit exceeded"}"#.to_string(),
        ),
        ("empty list", 200, "[]".to_string()),
        ("oversized metadata", 200, "x".repeat(8 * 1024 * 1024 + 1)),
    ] {
        let server = MockServer::start();
        releases_mock(&server, status, &body);
        let error = resolve(&server.base_url(), None).await.unwrap_err();
        let message = format!("{error:#}");
        assert!(!message.is_empty(), "{name} must return a contextual error");
        if name == "oversized metadata" {
            assert!(message.contains("download limit"), "{message}");
        }
    }
}

#[tokio::test]
async fn pinned_missing_tag_fails_closed() {
    let server = MockServer::start();
    server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v1.2.3");
        then.status(404).body(r#"{"message":"Not Found"}"#);
    });
    let error = resolve(&server.base_url(), Some("v1.2.3"))
        .await
        .unwrap_err();
    assert!(format!("{error:#}").contains("HTTP status"));
}

#[tokio::test]
async fn exact_bare_version_is_normalized_once_before_request() {
    // Why: accepting bare SemVer is useful only if the resolver binds it to the
    // repository's one canonical v-prefixed tag instead of interpolating it.
    let server = MockServer::start();
    let requested = server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v1.2.3");
        then.status(200)
            .header("content-type", "application/json")
            .body(release_value("v1.2.3", &server.base_url()).to_string());
    });
    let release = resolve(&server.base_url(), Some("1.2.3"))
        .await
        .expect("resolve normalized exact release");
    assert_eq!(release.tag_name, "v1.2.3");
    assert_eq!(
        requested.calls(),
        1,
        "only the canonical tag may be requested"
    );
}

#[tokio::test]
async fn normalized_equivalent_response_spelling_is_still_rejected() {
    // Why: semantic equivalence is insufficient for identity binding; GitHub
    // must return the exact canonical tag that the resolver requested.
    let server = MockServer::start();
    server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v1.2.3");
        then.status(200)
            .body(release_value("1.2.3", &server.base_url()).to_string());
    });
    let error = resolve(&server.base_url(), Some("1.2.3"))
        .await
        .unwrap_err();
    let message = format!("{error:#}");
    assert!(
        message.contains("v1.2.3")
            && message.contains("`1.2.3`")
            && message.contains("refusing release substitution"),
        "response spelling mismatch must be rejected exactly: {message}"
    );
}

#[tokio::test]
async fn valid_exact_prerelease_is_installable() {
    // Why: strict validation must reject malformed prereleases without
    // accidentally removing the documented exact-prerelease escape hatch.
    let server = MockServer::start();
    let requested = server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v1.2.3-rc.1");
        then.status(200)
            .body(release_value("v1.2.3-rc.1", &server.base_url()).to_string());
    });
    let release = resolve(&server.base_url(), Some("v1.2.3-rc.1"))
        .await
        .expect("resolve canonical prerelease");
    assert_eq!(release.tag_name, "v1.2.3-rc.1");
    assert_eq!(requested.calls(), 1);
}

#[tokio::test]
async fn validated_exact_downgrade_resolves() {
    // Why: an older exact version is an intentional downgrade; the security
    // boundary is exact validated identity, not comparison with the CLI build.
    let server = MockServer::start();
    let requested = server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v0.1.0");
        then.status(200)
            .body(release_value("v0.1.0", &server.base_url()).to_string());
    });
    let release = resolve(&server.base_url(), Some("v0.1.0"))
        .await
        .expect("resolve validated downgrade");
    assert_eq!(release.tag_name, "v0.1.0");
    assert_eq!(requested.calls(), 1);
}

#[tokio::test]
async fn invalid_exact_versions_never_send_a_request() {
    // Why: rejecting after URL construction would still permit path/query
    // injection and leak an attacker-controlled request to the release API.
    for invalid in [
        "v1.2.3?per_page=100",
        "v1.2.3/../../latest",
        "v1.2.3\nlatest",
        "v1.2.3-rc..1",
        " v1.2.3",
    ] {
        let server = MockServer::start();
        let any_request = server.mock(|when, then| {
            when.method(GET);
            then.status(500);
        });
        let error = resolve(&server.base_url(), Some(invalid))
            .await
            .unwrap_err();
        let message = format!("{error:#}");
        assert!(
            message.contains(invalid) && message.contains("--version v1.2.3"),
            "invalid input and remediation must be actionable: {message}"
        );
        assert_eq!(
            any_request.calls(),
            0,
            "invalid version `{invalid}` must be rejected before HTTP"
        );
    }
}

#[tokio::test]
async fn mismatched_exact_response_prevents_every_asset_download() {
    // Why: a signed but different release is still a substitution, including
    // when the requested version was intended as a downgrade.
    let server = MockServer::start();
    let release_request = server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v1.2.3");
        then.status(200)
            .body(release_value("v1.2.4", &server.base_url()).to_string());
    });
    let asset_download = server.mock(|when, then| {
        when.method(GET).path("/download/fixture.bin");
        then.status(200).body(FIXTURE_DATA);
    });
    let client = API.http_client().expect("build release client");
    let directory = private_install_directory();
    let target = directory.path().join("keyhog-fixture");
    let error = API
        .install_verified_release_payload_at(
            &client,
            Some("v1.2.3"),
            &server.base_url(),
            "fixture.bin",
            &target,
        )
        .await
        .unwrap_err();
    let message = format!("{error:#}");
    assert!(
        message.contains("v1.2.3")
            && message.contains("v1.2.4")
            && message.contains("refusing release substitution")
            && message.contains("retry"),
        "mismatch must name both tags and remediation: {message}"
    );
    assert_eq!(release_request.calls(), 1);
    assert_eq!(
        asset_download.calls(),
        0,
        "identity rejection must precede all asset downloads"
    );
}

#[tokio::test]
async fn malformed_exact_response_is_actionable() {
    // Why: malformed server metadata is not equivalent to "no update"; it
    // invalidates the identity proof for the exact requested release.
    let server = MockServer::start();
    server.mock(|when, then| {
        when.method(GET)
            .path("/repos/santhreal/keyhog/releases/tags/v1.2.3");
        then.status(200)
            .body(release_value("release/latest", &server.base_url()).to_string());
    });
    let error = resolve(&server.base_url(), Some("v1.2.3"))
        .await
        .unwrap_err();
    let message = format!("{error:#}");
    assert!(
        message.contains("v1.2.3")
            && message.contains("release/latest")
            && message.contains("before asset download")
            && message.contains("retry"),
        "malformed response must name both identities and remediation: {message}"
    );
}

#[tokio::test]
async fn malformed_latest_tag_is_a_loud_resolution_error() {
    // Why: update --check must not turn malformed release metadata into either
    // "already current" or a trusted update-available result.
    let server = MockServer::start();
    releases_mock(
        &server,
        200,
        &releases_body("release/latest", &server.base_url()),
    );
    let error = resolve(&server.base_url(), None).await.unwrap_err();
    let message = format!("{error:#}");
    assert!(
        message.contains("release/latest")
            && message.contains("no update was selected")
            && message.contains("--version v1.2.3"),
        "latest-tag failure must be actionable: {message}"
    );
}

#[tokio::test]
async fn signed_payload_runs_shared_download_and_atomic_install_path() {
    let server = MockServer::start();
    let tag = "v99.0.0";
    let release = release_value(tag, &server.base_url()).to_string();
    server.mock(|when, then| {
        when.method(GET)
            .path(format!("/repos/santhreal/keyhog/releases/tags/{tag}"));
        then.status(200)
            .header("content-type", "application/json")
            .body(release);
    });
    server.mock(|when, then| {
        when.method(GET).path("/download/fixture.bin");
        then.status(200).body(FIXTURE_DATA);
    });
    server.mock(|when, then| {
        when.method(GET).path("/download/fixture.bin.minisig");
        then.status(200).body(FIXTURE_SIG);
    });
    server.mock(|when, then| {
        when.method(GET).path("/download/fixture.bin.sha256");
        then.status(200)
            .body(format!("{FIXTURE_SHA256}  fixture.bin\n"));
    });

    let directory = private_install_directory();
    let target = directory.path().join("keyhog-fixture");
    std::fs::write(&target, b"working-old-binary").expect("write old target");
    let client = API.http_client().expect("build release client");
    API.install_verified_release_payload_at(
        &client,
        Some(tag),
        &server.base_url(),
        "fixture.bin",
        &target,
    )
    .await
    .expect("verify and install signed payload");
    assert_eq!(
        std::fs::read(&target).expect("read installed target"),
        FIXTURE_DATA
    );
}

#[tokio::test]
async fn invalid_signature_preserves_existing_install() {
    let server = MockServer::start();
    let tag = "v99.0.0";
    let release = release_value(tag, &server.base_url()).to_string();
    server.mock(|when, then| {
        when.method(GET)
            .path(format!("/repos/santhreal/keyhog/releases/tags/{tag}"));
        then.status(200).body(release);
    });
    server.mock(|when, then| {
        when.method(GET).path("/download/fixture.bin");
        then.status(200).body(b"tampered payload");
    });
    server.mock(|when, then| {
        when.method(GET).path("/download/fixture.bin.minisig");
        then.status(200).body(FIXTURE_SIG);
    });

    let directory = private_install_directory();
    let target = directory.path().join("keyhog-fixture");
    std::fs::write(&target, b"working-old-binary").expect("write old target");
    let client = API.http_client().expect("build release client");
    let error = API
        .install_verified_release_payload_at(
            &client,
            Some(tag),
            &server.base_url(),
            "fixture.bin",
            &target,
        )
        .await
        .unwrap_err();
    assert!(format!("{error:#}").contains("signature verification"));
    assert_eq!(
        std::fs::read(&target).expect("read preserved target"),
        b"working-old-binary"
    );
}