securefmt 0.1.5

Drop-in replacement for the Debug derive macro that hides fields marked as sensitive.
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

use log::Level;
use securefmt::Debug;

#[derive(Debug)]
enum TestEnum {
    Unit,
    Unnamed(u8, #[sensitive] u8),
    Named {
        a: u8,
        #[sensitive]
        b: u8,
    },
}

#[cfg(not(feature = "debug_mode"))]
fn main() {
    use assertx::assert_logs_contain_none;

    let logs = assertx::setup_logging_test();

    assert_eq!(format!("{:?}", TestEnum::Unit), "TestEnum::Unit");
    assert_eq!(
        format!("{:?}", TestEnum::Unnamed(1, 2)),
        "TestEnum::Unnamed { 0: 1, 1: <redacted> }"
    );
    assert_eq!(
        format!("{:?}", TestEnum::Named { a: 3, b: 4 }),
        "TestEnum::Named { a: 3, b: <redacted> }"
    );
    assert_logs_contain_none!(
        logs,
        Level::Warn => "WARNING: securefmt debug_mode feature is active. Sensitive data may be leaked. It is strongly recommended to disable debug_mode in production releases."
    );
}

#[cfg(feature = "debug_mode")]
fn main() {
    use assertx::assert_logs_contain_in_order;

    let logs = assertx::setup_logging_test();

    assert_eq!(format!("{:?}", TestEnum::Unit), "TestEnum::Unit");
    assert_eq!(
        format!("{:?}", TestEnum::Unnamed(1, 2)),
        "TestEnum::Unnamed { 0: 1, 1: 2 }"
    );
    assert_eq!(
        format!("{:?}", TestEnum::Named { a: 3, b: 4 }),
        "TestEnum::Named { a: 3, b: 4 }"
    );
    assert_logs_contain_in_order!(
        logs,
        Level::Warn => "WARNING: securefmt debug_mode feature is active. Sensitive data may be leaked. It is strongly recommended to disable debug_mode in production releases."
    );
}