pub use truman_core::*;
pub use truman_detectors::default_registry;
use std::path::PathBuf;
pub type ScanCallback<'a> = &'a mut dyn FnMut(ScanEvent) -> bool;
pub fn default_config() -> ScanConfig {
ScanConfig::default()
}
pub fn default_registry_with_config() -> (DetectorRegistry, ScanConfig) {
(truman_detectors::default_registry(), ScanConfig::default())
}
pub fn scan_paths_streaming(
paths: &[PathBuf],
config: &ScanConfig,
registry: &DetectorRegistry,
callback: ScanCallback,
) -> bool {
let scanner = Scanner::new(registry.clone(), config.clone());
let mut fwd = |ev: ScanEvent| -> bool { callback(ev) };
scanner.scan_paths_streaming(paths, &mut fwd)
}
pub fn scan_paths_collect(
paths: &[PathBuf],
config: &ScanConfig,
registry: &DetectorRegistry,
) -> Vec<Finding> {
let scanner = Scanner::new(registry.clone(), config.clone());
scanner.scan_paths(paths)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn facade_collect_stripe_exact_span() {
let dir = std::env::temp_dir();
let path = dir.join(format!("truman-facade-{}.txt", std::process::id()));
let secret = "sk_live_aaaaaaaaaaaaaaaaaaaaaaaa";
let line = format!("key = \"{secret}\"");
std::fs::write(&path, format!("{line}\n")).unwrap();
let (registry, config) = default_registry_with_config();
let paths = vec![path.clone()];
let findings = scan_paths_collect(&paths, &config, ®istry);
std::fs::remove_file(&path).ok();
assert_eq!(
findings.len(),
1,
"expected one Stripe finding: {findings:?}"
);
let f = &findings[0];
assert_eq!(f.detector, "StripeDetector");
assert_eq!(f.location.file, path);
assert_eq!(f.location.span.line, 1);
let start = line.find(secret).unwrap();
assert_eq!(f.location.span.col_start, start);
assert_eq!(f.location.span.col_end, start + secret.len());
assert_eq!(f.location.span.snippet(), Some(secret));
assert_eq!(f.secret, secret);
assert_eq!(f.hashed_secret, hash_secret(secret));
assert_eq!(f.hashed_secret.len(), 40);
}
#[test]
fn facade_streaming_callback_sees_finding_immediately() {
let dir = std::env::temp_dir();
let path = dir.join(format!("truman-facade-stream-{}.txt", std::process::id()));
let secret = "sk_live_aaaaaaaaaaaaaaaaaaaaaaaa";
std::fs::write(&path, format!("key = \"{secret}\"\n")).unwrap();
let (registry, config) = default_registry_with_config();
let paths = vec![path.clone()];
let mut seen = 0usize;
let mut saw_filedone = false;
let completed = scan_paths_streaming(&paths, &config, ®istry, &mut |ev: ScanEvent| {
match ev {
ScanEvent::Finding(_) => {
seen += 1;
}
ScanEvent::FileDone(_) => {
saw_filedone = true;
}
_ => {}
}
true
});
std::fs::remove_file(&path).ok();
assert!(completed);
assert_eq!(seen, 1);
assert!(saw_filedone);
}
}