secret-vault-value 0.3.6

Library provides a simple implementation of a secure and serializable type to store and control secret/sensitive values
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

use crate::SecretValue;
use zeroize::{Zeroize, Zeroizing};

impl SecretValue {
    pub fn as_sensitive_hex_str(&self) -> Zeroizing<String> {
        hex::encode(self.as_sensitive_bytes()).into()
    }

    pub fn to_hex_str(&self) -> Self {
        Self::from(&self.as_sensitive_hex_str())
    }

    pub fn from_hex_str(mut hex_string: String) -> Result<Self, hex::FromHexError> {
        let result = Self::new(hex::decode(&hex_string)?);
        hex_string.zeroize();
        Ok(result)
    }
}

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

    fn generate_secret_value() -> BoxedStrategy<SecretValue> {
        ".*".prop_map(|(mock_bytes)| SecretValue::new(mock_bytes.into()))
            .boxed()
    }

    proptest! {
        #[test]
        fn test_hex_encode(secret_value in generate_secret_value()) {
            let hex_str = secret_value.as_sensitive_hex_str();
            assert_eq!(secret_value.as_sensitive_bytes(), hex::decode(hex_str).unwrap());

            let hex_value = secret_value.to_hex_str();
            assert_eq!(secret_value.as_sensitive_bytes(), hex::decode(hex_value.as_sensitive_str()).unwrap());
        }

        #[test]
        fn test_hex_decode(mock_str in ".*") {
            let hex_str = hex::encode(mock_str.as_bytes());
            let secret_value = SecretValue::from_hex_str(hex_str).unwrap();
            assert_eq!(secret_value.as_sensitive_bytes(), mock_str.as_bytes());
        }
    }
}