scour-secrets 0.20.0

Deterministic one-way data sanitization engine
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

//! Implementing a custom replacement strategy.
//!
//! Run with: `cargo run --example custom_strategy`

use scour_secrets::category::Category;
use scour_secrets::store::MappingStore;
use scour_secrets::strategy::{EntropyMode, Strategy, StrategyGenerator};
use std::sync::Arc;

/// A simple strategy that replaces every character with `X`.
struct Redact;

impl Strategy for Redact {
    fn name(&self) -> &'static str {
        "redact"
    }

    fn replace(
        &self,
        _category: &scour_secrets::Category,
        original: &str,
        _entropy: &[u8; 32],
    ) -> String {
        "X".repeat(original.len())
    }
}

fn main() {
    // Wrap the custom strategy in a StrategyGenerator.
    let strategy = Redact;
    let mode = EntropyMode::deterministic([42u8; 32]);
    let generator = Arc::new(StrategyGenerator::new(Box::new(strategy), mode));

    // Use it with MappingStore as usual.
    let store = MappingStore::new(generator, None);

    let pairs = [
        (Category::Email, "alice@corp.com"),
        (Category::IpV4, "10.0.0.1"),
        (Category::Name, "Secret Agent"),
    ];

    for (category, original) in &pairs {
        let sanitized = store
            .get_or_insert(category, original)
            .expect("replacement should succeed");
        println!("{original:<20} → {sanitized}");
    }
}