dd-sensitive-data-scanner 0.0.0

Core Sensitive Data Scanner library for detecting and redacting sensitive information.
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
56
57
58
59
60
61
62

/// Specifies how indices are calculated for rule matches
pub trait Encoding: Sized + 'static {
    type Index: Sized + 'static;
    type IndexShift: Sized;

    fn zero_index() -> Self::Index;
    fn zero_shift() -> Self::IndexShift;

    fn get_index(value: &Self::Index, utf8_index: usize) -> usize;
    fn get_shift(value: &Self::IndexShift, utf8_shift: isize) -> isize;

    /// A iterator of indices. You are given the UTF-8 indices, and need to calculate the "custom" indices.
    /// The UTF-8 indices are guaranteed to be sorted in ascending order by the start index.
    fn calculate_indices<'a>(
        content: &str,
        match_visitor: impl Iterator<Item = EncodeIndices<'a, Self>>,
    );

    /// Calculates the change of an index from replacing `before` with `after`
    fn adjust_shift(shift: &mut Self::IndexShift, before: &str, after: &str);
}

pub struct Utf8Encoding;

impl Encoding for Utf8Encoding {
    type Index = ();
    type IndexShift = ();

    fn zero_index() -> Self::Index { /* do nothing */
    }
    fn zero_shift() -> Self::IndexShift { /* do nothing */
    }

    fn get_index(_value: &Self::Index, utf8_index: usize) -> usize {
        utf8_index
    }

    fn get_shift(_value: &Self::IndexShift, utf8_shift: isize) -> isize {
        utf8_shift
    }

    fn calculate_indices<'a>(
        _content: &str,
        _match_visitor: impl Iterator<Item = EncodeIndices<'a, Self>>,
    ) {
        // do nothing, indices are already correct
    }

    fn adjust_shift(_shift: &mut Self::IndexShift, _before: &str, _after: &str) {
        // do nothing
    }
}

pub struct EncodeIndices<'a, E: Encoding> {
    // Input
    pub utf8_start: usize,
    pub utf8_end: usize,

    // Output
    pub custom_start: &'a mut E::Index,
    pub custom_end: &'a mut E::Index,
}