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
56

//! Borrowed source context used by contextual validators.

use std::ops::Range;

/// Borrowed UTF-8 source context for validating one candidate span.
#[derive(Debug, Clone)]
pub(crate) struct ValidationContext<'a> {
    source: &'a str,
    candidate: Range<usize>,
}

impl<'a> ValidationContext<'a> {
    /// Creates context for `candidate` inside `source`.
    pub(crate) fn new(source: &'a str, candidate: Range<usize>) -> Self {
        debug_assert!(candidate.start <= candidate.end);
        debug_assert!(candidate.end <= source.len());
        debug_assert!(source.is_char_boundary(candidate.start));
        debug_assert!(source.is_char_boundary(candidate.end));

        Self { source, candidate }
    }

    /// Returns the candidate text.
    pub(crate) fn candidate(&self) -> &'a str {
        &self.source[self.candidate.clone()]
    }

    /// Returns at most `maximum_bytes` immediately preceding bytes while
    /// preserving UTF-8 boundaries.
    pub(crate) fn before_window(&self, maximum_bytes: usize) -> &'a str {
        let mut start = self.candidate.start.saturating_sub(maximum_bytes);

        while start < self.candidate.start && !self.source.is_char_boundary(start) {
            start += 1;
        }

        &self.source[start..self.candidate.start]
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn exposes_candidate_and_utf8_safe_preceding_window() {
        let source = "αβγ password=secret";
        let start = source
            .find("secret")
            .expect("fixture must contain candidate");
        let context = ValidationContext::new(source, start..start + "secret".len());

        assert_eq!(context.candidate(), "secret");
        assert!(context.before_window(7).is_char_boundary(0));
    }
}