mls-spec 3.0.0-pre.2

This crate is a repository of MLS / RFC9420-related data structures.
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

use std::borrow::Cow;

/// Container that ser/deserializes to TLS Variable-Length bytes
/// and implements zeroizing & constant-time equality checks
#[derive(Clone, Default, Ord, PartialOrd, Hash, thalassa::TlsplAll)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(transparent)]
pub struct SensitiveBytes<'a>(Cow<'a, [u8]>);

impl SensitiveBytes<'_> {
    #[inline]
    pub fn to_vec(&self) -> Vec<u8> {
        self.0.to_vec()
    }

    #[inline]
    pub fn as_slice(&self) -> &[u8] {
        &self.0
    }

    pub fn ct_eq_slice(&self, slice: impl AsRef<[u8]>) -> bool {
        use subtle::ConstantTimeEq as _;
        self.0.ct_eq(slice.as_ref()).into()
    }

    pub fn clear(&mut self) {
        use zeroize::Zeroize as _;
        // Upgrade to an owned container first
        let _ = self.0.to_mut();
        // Zeroize memory
        self.zeroize();
        let owned_ref = self.0.to_mut();
        // Clear & shrink the vec
        owned_ref.clear();
        owned_ref.shrink_to_fit();
    }
}

impl zeroize::Zeroize for SensitiveBytes<'_> {
    fn zeroize(&mut self) {
        match &mut self.0 {
            Cow::Borrowed(_) => {} // Borrowed, not up to us to zeroize
            Cow::Owned(vec) => vec.zeroize(),
        }
    }
}

impl Drop for SensitiveBytes<'_> {
    fn drop(&mut self) {
        use zeroize::Zeroize as _;
        self.zeroize();
    }
}

#[cfg(not(feature = "hazmat"))]
impl std::fmt::Debug for SensitiveBytes<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "[REDACTED]")
    }
}

#[cfg(not(feature = "hazmat"))]
impl std::fmt::Display for SensitiveBytes<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "[REDACTED]")
    }
}

#[cfg(feature = "hazmat")]
impl std::fmt::Debug for SensitiveBytes<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", &self.0)
    }
}

#[cfg(feature = "hazmat")]
impl std::fmt::Display for SensitiveBytes<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", &hex::encode(&*self.0))
    }
}

impl From<Vec<u8>> for SensitiveBytes<'_> {
    #[inline]
    fn from(value: Vec<u8>) -> Self {
        Self(Cow::Owned(value))
    }
}

impl PartialEq for SensitiveBytes<'_> {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        use subtle::ConstantTimeEq as _;
        self.0.ct_eq(&other.0).into()
    }
}

impl Eq for SensitiveBytes<'_> {}

impl<'a> std::ops::Deref for SensitiveBytes<'a> {
    type Target = [u8];
    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl std::ops::DerefMut for SensitiveBytes<'_> {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.0.to_mut()
    }
}