apollo-redaction 0.1.0

Redaction utility for sensitive data in error messages, debug logs, etc.
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

use crate::RedactionStrategy;
use std::fmt;

/// Redact passwords with a fixed-length output.
///
/// Always outputs `********` regardless of the actual password length.
/// This prevents leaking information about password length.
///
/// ```rust
/// use apollo_redaction::Redacted;
/// use apollo_redaction::strategy::PasswordRedactor;
///
/// fn password(input: &str) -> String {
///     Redacted::<_, PasswordRedactor>::new(input).to_string()
/// }
///
/// assert_eq!(password("short"), "********");
/// assert_eq!(password("a_very_long_password_123!"), "********");
/// assert_eq!(password("x"), "********");
/// ```
#[derive(Default, Clone)]
pub struct PasswordRedactor;

impl<T> RedactionStrategy<T> for PasswordRedactor {
    fn display(&self, _value: &T, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "********")
    }
}

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

    fn password(input: &str) -> String {
        Redacted::<_, PasswordRedactor>::new(input).to_string()
    }

    #[test]
    fn test_fixed_length() {
        assert_eq!(password("short"), "********");
        assert_eq!(password("a_very_long_password_123!"), "********");
        assert_eq!(password("x"), "********");
        assert_eq!(password(""), "********");
    }
}