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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
use std::fmt::{Debug, Display, Formatter};
use std::future::Future;
use std::str::Utf8Error;
use zeroize::*;

#[derive(Zeroize, ZeroizeOnDrop, Eq, PartialEq, Default)]
pub struct SecretValue(Vec<u8>);

impl SecretValue {
    pub fn new(src: Vec<u8>) -> Self {
        Self(src)
    }

    pub fn ref_sensitive_value(&self) -> &Vec<u8> {
        &self.0
    }

    pub fn ref_sensitive_value_mut(&mut self) -> &mut Vec<u8> {
        &mut self.0
    }

    pub fn sensitive_value_to_str(&self) -> Result<&str, Utf8Error> {
        std::str::from_utf8(&self.0)
    }

    pub fn secure_clear(&mut self) {
        self.0.zeroize();
        self.0.clear();
    }

    pub fn as_sensitive_str(&self) -> &str {
        self.sensitive_value_to_str().unwrap()
    }

    pub fn as_sensitive_bytes(&self) -> &[u8] {
        self.ref_sensitive_value()
    }

    pub fn exposed_in_as_str<T, Z: Zeroize, FN>(&self, f: FN) -> T
    where
        FN: Fn(String) -> (T, Z),
    {
        let decoded_as_string = self.sensitive_value_to_str().unwrap().to_string();
        let (result, mut zeroizable) = f(decoded_as_string);
        zeroizable.zeroize();
        result
    }

    pub fn exposed_in_as_zstr<T, FN>(&self, f: FN) -> T
    where
        FN: Fn(Zeroizing<String>) -> T,
    {
        let decoded_as_string = Zeroizing::new(self.sensitive_value_to_str().unwrap().to_string());
        f(decoded_as_string)
    }

    pub fn exposed_in_as_vec<T, Z: Zeroize, FN>(&self, f: FN) -> T
    where
        FN: Fn(Vec<u8>) -> (T, Z),
    {
        let (result, mut zeroizable) = f(self.0.clone());
        zeroizable.zeroize();
        result
    }

    pub fn exposed_in_as_zvec<T, FN>(&self, f: FN) -> T
    where
        FN: Fn(Zeroizing<Vec<u8>>) -> T,
    {
        f(Zeroizing::new(self.0.clone()))
    }

    pub async fn exposed_in_as_str_async<T, Z: Zeroize, FN, FI>(&self, f: FN) -> T
    where
        FN: Fn(String) -> FI,
        FI: Future<Output = (T, Z)>,
    {
        let decoded_as_string = self.sensitive_value_to_str().unwrap().to_string();
        let (result, mut zeroizable) = f(decoded_as_string).await;
        zeroizable.zeroize();
        result
    }

    pub async fn exposed_in_as_zstr_async<T, FN, FI>(&self, f: FN) -> T
    where
        FN: Fn(Zeroizing<String>) -> FI,
        FI: Future<Output = T>,
    {
        let decoded_as_string = Zeroizing::new(self.sensitive_value_to_str().unwrap().to_string());
        f(decoded_as_string).await
    }

    pub async fn exposed_in_as_vec_async<T, Z: Zeroize, FN, FI>(&self, f: FN) -> T
    where
        FN: Fn(Vec<u8>) -> FI,
        FI: Future<Output = (T, Z)>,
    {
        let (result, mut zeroizable) = f(self.0.clone()).await;
        zeroizable.zeroize();
        result
    }

    pub async fn exposed_in_as_zvec_async<T, FN, FI>(&self, f: FN) -> T
    where
        FN: Fn(Zeroizing<Vec<u8>>) -> FI,
        FI: Future<Output = T>,
    {
        f(Zeroizing::new(self.0.clone())).await
    }
}

impl From<String> for SecretValue {
    fn from(mut str: String) -> Self {
        let result = Self(str.as_bytes().to_vec());
        str.zeroize();
        result
    }
}

impl From<&mut String> for SecretValue {
    fn from(str: &mut String) -> Self {
        let result = Self(str.as_bytes().to_vec());
        str.zeroize();
        result
    }
}

impl From<&Zeroizing<String>> for SecretValue {
    fn from(str: &Zeroizing<String>) -> Self {
        Self(str.as_bytes().to_vec())
    }
}

impl From<Vec<u8>> for SecretValue {
    fn from(vec: Vec<u8>) -> Self {
        Self(vec)
    }
}

impl From<&mut Vec<u8>> for SecretValue {
    fn from(vec: &mut Vec<u8>) -> Self {
        let result = Self(vec.clone());
        vec.zeroize();
        vec.clear();
        result
    }
}

impl From<&Zeroizing<Vec<u8>>> for SecretValue {
    fn from(vec: &Zeroizing<Vec<u8>>) -> Self {
        Self(vec.to_vec())
    }
}

impl From<&str> for SecretValue {
    fn from(str: &str) -> Self {
        Self(str.as_bytes().to_vec())
    }
}

impl Clone for SecretValue {
    fn clone(&self) -> Self {
        SecretValue::new(self.ref_sensitive_value().clone())
    }
}

impl Display for SecretValue {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "***")
    }
}

impl Debug for SecretValue {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "***")
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use proptest::prelude::*;
    use proptest::test_runner::TestRunner;
    use std::ops::Deref;

    fn generate_secret_value() -> BoxedStrategy<SecretValue> {
        ("[a-zA-Z0-9]*")
            .prop_map(|(mock_secret_str)| SecretValue::new(mock_secret_str.as_bytes().to_vec()))
            .boxed()
    }

    proptest! {
        #[test]
        fn secret_is_not_leaking_in_fmt(mock_secret_value in generate_secret_value()) {
            assert_eq!(format!("{}",mock_secret_value), "***");
            assert_eq!(format!("{:?}",mock_secret_value), "***");
            assert_eq!(format!("{:#?}",mock_secret_value), "***");
        }

        #[test]
        fn secret_follows_partial_eq(mock_secret_str in "[a-zA-Z0-9]*") {
            let mock_secret1 = SecretValue::new(mock_secret_str.as_bytes().to_vec());
            let mock_secret2 = SecretValue::new(mock_secret_str.as_bytes().to_vec());
            assert_eq!(mock_secret1, mock_secret2);
        }

        #[test]
        fn exposed_function_str(mock_secret_value in generate_secret_value())  {
            let insecure_copy_str =
            mock_secret_value.exposed_in_as_str(|str| {
                (str.clone(), str)
            });
            assert_eq!(insecure_copy_str.as_str(), mock_secret_value.sensitive_value_to_str().unwrap());
        }

        #[test]
        fn exposed_function_zstr(mock_secret_value in generate_secret_value())  {
            let insecure_copy_str =
            mock_secret_value.exposed_in_as_zstr(|str| {
                str.clone()
            });
            assert_eq!(insecure_copy_str.as_str(), mock_secret_value.sensitive_value_to_str().unwrap());
        }

        #[test]
        fn exposed_function_vec(mock_secret_value in generate_secret_value())  {
            let insecure_copy_vec =
                mock_secret_value.exposed_in_as_vec(|vec| {
                    (vec.clone(), vec)
                });
            assert_eq!(&insecure_copy_vec, mock_secret_value.ref_sensitive_value());
        }


        #[test]
        fn exposed_function_zvec(mock_secret_value in generate_secret_value())  {
            let insecure_copy_vec =
                mock_secret_value.exposed_in_as_zvec(|vec| {
                    vec.clone()
                });
            assert_eq!(insecure_copy_vec.deref(), mock_secret_value.ref_sensitive_value());
        }
    }

    #[tokio::test]
    async fn exposed_function_str_async() {
        let mut runner = TestRunner::default();
        let mock_secret = generate_secret_value()
            .new_tree(&mut runner)
            .unwrap()
            .current();

        let insecure_copy_str = mock_secret
            .exposed_in_as_str_async(|str| async { (str.clone(), str) })
            .await;
        assert_eq!(
            insecure_copy_str.as_str(),
            mock_secret.sensitive_value_to_str().unwrap()
        );

        let insecure_copy_str = mock_secret
            .exposed_in_as_zstr_async(|str| async move { str.clone() })
            .await;
        assert_eq!(
            insecure_copy_str.as_str(),
            mock_secret.sensitive_value_to_str().unwrap()
        );
    }

    #[tokio::test]
    async fn exposed_function_str_async_closure() {
        let mut runner = TestRunner::default();
        let mock_secret = generate_secret_value()
            .new_tree(&mut runner)
            .unwrap()
            .current();

        let test_var_to_capture: String = "test-captured".to_string();

        let insecure_copy_str = mock_secret
            .exposed_in_as_str_async(|str| async {
                (format!("{}{}", test_var_to_capture, str), str)
            })
            .await;

        assert_eq!(
            insecure_copy_str.as_str(),
            format!(
                "{}{}",
                test_var_to_capture,
                mock_secret.sensitive_value_to_str().unwrap()
            )
        );
    }

    #[tokio::test]
    async fn exposed_function_vec_async() {
        let mut runner = TestRunner::default();
        let mock_secret = generate_secret_value()
            .new_tree(&mut runner)
            .unwrap()
            .current();

        let insecure_copy_vec = mock_secret
            .exposed_in_as_vec_async(|vec| async { (vec.clone(), vec) })
            .await;
        assert_eq!(&insecure_copy_vec, mock_secret.ref_sensitive_value());

        let insecure_copy_vec = mock_secret
            .exposed_in_as_zvec_async(|vec| async move { vec.clone() })
            .await;
        assert_eq!(insecure_copy_vec.deref(), mock_secret.ref_sensitive_value());
    }

    #[tokio::test]
    async fn exposed_function_vec_async_closure() {
        let mut runner = TestRunner::default();
        let mock_secret = generate_secret_value()
            .new_tree(&mut runner)
            .unwrap()
            .current();

        let test_var_to_capture: Vec<u8> = "test-captured".to_string().as_bytes().to_vec();

        let insecure_copy_vec = mock_secret
            .exposed_in_as_vec_async(|vec| async {
                ([test_var_to_capture.clone(), vec.clone()].concat(), vec)
            })
            .await;

        assert_eq!(
            insecure_copy_vec,
            [
                test_var_to_capture.clone(),
                mock_secret.ref_sensitive_value().to_vec()
            ]
            .concat()
        );
    }
}