cribra 0.3.0

Privacy-first Rust core for detecting, querying, and safely transforming secrets and sensitive data
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

//! Minimal end-to-end scan using custom rules.
//!
//! Run with:
//!
//! ```text
//! cargo run --example scan_basic
//! ```

use cribra::{Remediation, Rule, Scanner, Severity};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let scanner = Scanner::builder()
        .rule(
            Rule::prefix("acme.api-key", "acme_live_", Severity::Critical)
                .with_remediation(Remediation::RotateCredential),
        )
        .rule(
            Rule::literal("internal.marker", "PRIVATE_VALUE", Severity::High)
                .with_remediation(Remediation::RemoveSensitiveValue),
        )
        .build()?;

    let sources = [
        (
            "config.env",
            "ACME_API_KEY=acme_live_7f3a91\nMODE=production\n",
        ),
        (
            "settings.toml",
            "marker = \"PRIVATE_VALUE\"\nlog_level = \"info\"\n",
        ),
        ("clean.txt", "Nothing sensitive here.\n"),
    ];

    let results = scanner.scan(sources);

    println!("{}", results.summary());

    for (source, finding) in results.findings() {
        println!(
            "{source}:{}:{} [{} / {}] {}",
            finding.location().line(),
            finding.location().column(),
            finding.severity(),
            finding.confidence(),
            finding.rule_id(),
        );

        if let Some(remediation) = finding.remediation() {
            println!("  remediation: {}", remediation.message());
        }
    }

    Ok(())
}