keyhog-core 0.5.4

keyhog-core — shared data model and detector specifications for the KeyHog secret scanner
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

use keyhog_core::allowlist::Allowlist;
use keyhog_core::{
    load_detectors_with_gate, redact, validate_detector, DetectorSpec, PatternSpec, Severity,
};
use std::path::Path;

fn main() {
    let detector = DetectorSpec {
        id: "demo-token".into(),
        name: "Demo Token".into(),
        service: "demo".into(),
        severity: Severity::High,
        patterns: vec![PatternSpec {
            regex: "demo_[A-Z0-9]{8}".into(),
            description: Some("Simple standalone example".into()),
            group: None,
        }],
        companions: Vec::new(),
        verify: None,
        keywords: vec!["demo_".into()],
    };

    let issues = validate_detector(&detector);
    let allowlist = Allowlist::parse("path:**/*.md\n");
    let maybe_detectors = load_detectors_with_gate(Path::new("detectors"), true).ok();

    println!("detector={} issues={}", detector.id, issues.len());
    println!("redacted={}", redact("demo_ABC12345"));
    println!(
        "ignores_docs={}",
        allowlist.is_path_ignored("docs/README.md")
    );
    println!(
        "workspace_detectors_loaded={}",
        maybe_detectors.as_ref().map_or(0, Vec::len)
    );
}