apollo-redaction 0.2.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use crate::RedactionStrategy;
use std::fmt;
use std::fmt::Debug;
use std::fmt::Display;

mod card;
mod email;
mod first4;
mod fixed;
mod full;
mod ip;
mod last4;
mod password;
mod url;

pub use card::CardRedactor;
pub use email::EmailRedactor;
pub use first4::First4Redactor;
pub use fixed::FixedRedactor;
pub use full::FullRedactor;
pub use ip::IpRedactor;
pub use last4::Last4Redactor;
pub use password::PasswordRedactor;
pub use url::UrlHostRedactor;
pub use url::UrlPasswordRedactor;

/// A redactor that does not redact. The value to be redacted must implement both [`Display`] and
/// [`Debug`].
#[derive(Default, Clone)]
pub struct NoRedactor;

impl<T: Debug + Display> RedactionStrategy<T> for NoRedactor {
    fn debug(&self, value: &T, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Debug::fmt(value, f)
    }
    fn display(&self, value: &T, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Display::fmt(value, f)
    }
}

/// A redactor that just writes "\[REDACTED]". This strategy can redact values of any type.
#[derive(Default, Clone)]
pub struct SimpleRedactor;

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

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

    #[test]
    fn display() {
        let my_secret = "topsecret";
        let redacted = crate::Redacted::<_, SimpleRedactor>::new(my_secret);

        assert_eq!(redacted.to_string(), "[REDACTED]");
        assert_eq!(
            format!("Ha! the secret is: {redacted}!"),
            "Ha! the secret is: [REDACTED]!"
        );
    }

    #[test]
    fn debug() {
        let my_secret = "topsecret, even for debug";
        let redacted = crate::Redacted::<_, SimpleRedactor>::new(my_secret);

        assert_eq!(
            format!("Ha! the secret is: {redacted:?}!"),
            "Ha! the secret is: [REDACTED]!"
        );
    }
}