keyhog-sources 0.5.42

//! LANE 5 (sources-safety) Law-10 regression: an unreadable binary must be
//! COUNTED (and surfaced loudly), never silently dropped from the scan.
//!
//! Before the fix `BinarySource::strings_chunks` logged the read failure at
//! `tracing::debug!` (invisible at default verbosity) and returned an empty
//! `Vec`, so a permission-denied / vanished binary read as a clean file. The
//! fix bumps `BINARY_UNREADABLE`, prints a loud stderr warning, and emits a
//! `SourceError` row at the drop site; this test pins the visible source
//! behaviour and counter behaviour.
//!
//! Own test binary: `binary_unreadable()` reads a process-global atomic.

#![cfg(all(unix, feature = "binary"))]

mod support;

use keyhog_core::Source;
use keyhog_sources::testing::{SourceTestApi, TestApi};
use keyhog_sources::{binary_unreadable, reset_binary_counters, skip_counts, SourceLimits};
use std::sync::Mutex;
use support::split_chunk_results;

/// Serialises process-global binary-counter assertions in this test binary.
static COUNTER_LOCK: Mutex<()> = Mutex::new(());

#[test]
fn unreadable_binary_is_counted_not_silently_dropped() {
    let _guard = COUNTER_LOCK.lock().unwrap();
    reset_binary_counters();
    TestApi.reset_skip_counters();

    // A path that does not exist: `read_binary_capped` -> `File::open` fails.
    let dir = tempfile::tempdir().unwrap();
    let missing = dir.path().join("does-not-exist.bin");

    let rows: Vec<_> = TestApi
        .binary_strings_only(missing.clone())
        .chunks()
        .collect();
    assert_eq!(
        rows.len(),
        1,
        "an unreadable binary must yield one visible source error"
    );
    let err = rows[0]
        .as_ref()
        .expect_err("an unreadable binary must be an error row");
    assert!(
        err.to_string().contains("cannot read file")
            && err.to_string().contains("not scanned for secrets"),
        "error should name the unreadable binary coverage gap, got {err}"
    );
    assert_eq!(
        binary_unreadable(),
        1,
        "an unreadable binary must be counted as dropped-from-scan (Law 10), so a \
         'no secrets' result is not mistaken for full coverage of that file"
    );
    assert_eq!(
        skip_counts().unreadable,
        1,
        "binary unreadable drops must also flow through the shared skip snapshot \
         so JSON/SARIF/operator summaries see the same coverage gap"
    );
}

#[test]
fn readable_binary_is_not_counted_as_unreadable() {
    let _guard = COUNTER_LOCK.lock().unwrap();
    reset_binary_counters();
    TestApi.reset_skip_counters();

    let dir = tempfile::tempdir().unwrap();
    let bin = dir.path().join("app.bin");
    // A blob with a real-shape AWS key embedded among printable runs so strings
    // extraction yields at least one chunk.
    let mut bytes = vec![0u8; 32];
    bytes.extend_from_slice(b"junk_prefix_AKIAQYLPMN5HFIQR7XYA_suffix_padding"); // keyhog:ignore detector=aws-access-key (synthetic test fixture)
    bytes.extend_from_slice(&[0u8; 16]);
    std::fs::write(&bin, &bytes).unwrap();

    let bodies: Vec<String> = TestApi
        .binary_strings_only(bin.clone())
        .chunks()
        .collect::<Result<Vec<_>, _>>()
        .unwrap()
        .into_iter()
        .map(|c| c.data.as_str().to_owned())
        .collect();
    assert!(
        bodies.iter().any(|b| b.contains("AKIAQYLPMN5HFIQR7XYA")), // keyhog:ignore detector=aws-access-key (synthetic test fixture)
        "a readable binary's embedded string must be extracted; got {bodies:?}"
    );
    assert_eq!(
        binary_unreadable(),
        0,
        "a readable binary must NOT be counted as unreadable"
    );
    assert_eq!(
        skip_counts().unreadable,
        0,
        "a readable binary must not increment the shared unreadable skip counter"
    );
}

#[test]
fn capped_binary_read_surfaces_truncation_error_and_scans_prefix() {
    let _guard = COUNTER_LOCK.lock().unwrap();
    reset_binary_counters();
    TestApi.reset_skip_counters();

    let dir = tempfile::tempdir().unwrap();
    let bin = dir.path().join("truncated.bin");
    let mut bytes = b"prefix_KEYHOG_BINARY_TRUNCATED_PREFIX_SECRET_1234567890_suffix".to_vec();
    bytes.extend_from_slice(&[0u8; 256]);
    std::fs::write(&bin, &bytes).unwrap();

    let mut limits = SourceLimits::default();
    limits.binary_read_bytes = 64;
    let rows: Vec<_> = TestApi
        .binary_strings_only(bin.clone())
        .with_limits(limits)
        .chunks()
        .collect();
    let (chunks, errors) = split_chunk_results(&rows);

    assert_eq!(
        errors.len(),
        1,
        "a capped binary prefix scan must emit one truncation error row"
    );
    let err = errors[0].to_string();
    assert!(
        err.contains("strings-read cap") && err.contains("remaining binary bytes were not scanned"),
        "error should describe the partial binary scan, got {err}"
    );
    assert!(
        chunks.iter().any(|chunk| {
            chunk.metadata.source_type.as_ref() == "binary:strings"
                && chunk
                    .data
                    .contains("KEYHOG_BINARY_TRUNCATED_PREFIX_SECRET_1234567890")
        }),
        "binary prefix strings must still be scanned after the truncation row; chunks={chunks:?}"
    );
    assert_eq!(
        skip_counts().source_truncated,
        1,
        "binary read-cap truncation must bump SOURCE_TRUNCATED exactly once"
    );
    assert_eq!(
        binary_unreadable(),
        0,
        "a capped but readable binary must not be counted as unreadable"
    );
}

#[test]
fn readable_binary_without_printable_strings_is_counted_as_binary_gap() {
    let _guard = COUNTER_LOCK.lock().unwrap();
    reset_binary_counters();
    TestApi.reset_skip_counters();
    let before = skip_counts();

    let dir = tempfile::tempdir().unwrap();
    let bin = dir.path().join("zeros.bin");
    std::fs::write(&bin, vec![0u8; 4096]).unwrap();

    let rows: Vec<_> = TestApi.binary_strings_only(bin.clone()).chunks().collect();
    assert_eq!(
        rows.len(),
        1,
        "a readable binary with no printable strings must yield one visible source error"
    );
    let err = rows[0]
        .as_ref()
        .expect_err("a readable no-strings binary must be an error row");
    assert!(
        err.to_string()
            .contains("yielded no scannable sections or printable strings")
            && err.to_string().contains("no binary bytes were scanned"),
        "error should name the unscanned binary condition, got {err}"
    );

    let after = skip_counts();
    assert_eq!(
        binary_unreadable(),
        0,
        "a readable no-strings binary must not be misclassified as unreadable"
    );
    assert_eq!(
        after.binary - before.binary,
        1,
        "a readable no-strings binary MUST bump SKIPPED_BINARY so the empty stream is not reported as full coverage"
    );
}