serde-secrecy 0.2.6

Serde support for secrecy types
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

//! Serde support for [`secrecy`] types.

#![cfg_attr(docsrs, feature(doc_auto_cfg))]

use secrecy::{ExposeSecret as _, SecretString};
use serde_core::Serializer;

/// Enables serialization of [`secrecy::SecretString`] fields by exposing the inner string.
///
/// # Examples
///
/// ```
/// # use serde::Serialize;
/// # use secrecy::SecretString;
/// #[derive(Debug, Serialize)]
/// struct Login {
///     #[serde(serialize_with = "serde_secrecy::expose_secret_string")]
///     password: SecretString,
/// }
///
/// let req = Login {
///     password: SecretString::from("hunter2"),
/// };
///
/// let json = serde_json::to_string(&req).unwrap();
/// assert!(json.contains("hunter2"));
/// ```
pub fn expose_secret_string<S: Serializer>(
    secret: &SecretString,
    ser: S,
) -> Result<S::Ok, S::Error> {
    ser.serialize_str(secret.expose_secret())
}

#[cfg(test)]
mod tests {
    use serde::Serialize;

    use super::*;

    #[test]
    fn serialize_secret_string() {
        #[derive(Debug, Serialize)]
        struct Login {
            email: String,
            #[serde(serialize_with = "expose_secret_string")]
            password: SecretString,
        }

        let req = Login {
            email: "foo@example.com".to_owned(),
            password: SecretString::from("hunter2"),
        };

        let debug = format!("{req:?}");
        let json = serde_json::to_string(&req).unwrap();

        assert!(debug.contains("example.com"));
        assert!(json.contains("example.com"));

        assert!(!debug.contains("hunter2"));
        assert!(json.contains("hunter2"));
    }
}