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
use super::{
    super::{Bicrypter, CryptError, Decrypter, Encrypter},
    AssociatedData,
};
use lru::LruCache;
use std::sync::{Arc, RwLock};

#[derive(Clone)]
pub struct NonceCacheBicrypter<T: Bicrypter> {
    bicrypter: T,
    cache: Option<Arc<RwLock<LruCache<Vec<u8>, ()>>>>,
}

impl<T: Bicrypter> NonceCacheBicrypter<T> {
    pub fn new(bicrypter: T, nonce_cache_size: usize) -> Self {
        // LruCache does not handle zero capacity itself, so we make it an
        // option where we won't do anything if it's zero
        let cache = if nonce_cache_size > 0 {
            Some(Arc::new(RwLock::new(LruCache::new(nonce_cache_size))))
        } else {
            None
        };

        Self { bicrypter, cache }
    }

    pub fn with_no_nonce_cache(bicrypter: T) -> Self {
        Self::new(bicrypter, 0)
    }

    fn register_nonce<'a>(
        &self,
        nonce: &'a [u8],
    ) -> Result<&'a [u8], CryptError> {
        if let Some(cache) = &self.cache {
            let nonce_vec = nonce.to_vec();
            if cache.read().unwrap().contains(&nonce_vec) {
                return Err(CryptError::NonceAlreadyUsed { nonce: nonce_vec });
            }

            // Mark that we have used the nonce
            cache.write().unwrap().put(nonce_vec, ());
        }

        Ok(nonce)
    }
}

impl<T: Bicrypter> Bicrypter for NonceCacheBicrypter<T> {}

impl<T: Bicrypter> Encrypter for NonceCacheBicrypter<T> {
    fn encrypt(
        &self,
        buffer: &[u8],
        associated_data: &AssociatedData,
    ) -> Result<Vec<u8>, CryptError> {
        // Register the nonce if provided, and then pass on to the underlying
        // encrypter
        if let Some(nonce) = associated_data.nonce_slice() {
            self.register_nonce(nonce)?;
        }
        self.bicrypter.encrypt(buffer, associated_data)
    }

    /// Returns underlying bicrypter's associated data
    fn new_encrypt_associated_data(&self) -> AssociatedData {
        self.bicrypter.new_encrypt_associated_data()
    }
}

impl<T: Bicrypter> Decrypter for NonceCacheBicrypter<T> {
    fn decrypt(
        &self,
        buffer: &[u8],
        associated_data: &AssociatedData,
    ) -> Result<Vec<u8>, CryptError> {
        // Register the nonce if provided, and then pass on to the underlying
        // decrypter
        if let Some(nonce) = associated_data.nonce_slice() {
            self.register_nonce(nonce)?;
        }
        self.bicrypter.decrypt(buffer, associated_data)
    }
}

#[cfg(test)]
mod tests {
    use super::super::super::nonce::{self, Nonce};
    use super::*;

    #[derive(Clone)]
    struct StubBicrypter(
        fn(&[u8], &AssociatedData) -> Result<Vec<u8>, CryptError>,
    );
    impl Bicrypter for StubBicrypter {}
    impl Encrypter for StubBicrypter {
        fn encrypt(
            &self,
            buffer: &[u8],
            associated_data: &AssociatedData,
        ) -> Result<Vec<u8>, CryptError> {
            (self.0)(buffer, associated_data)
        }

        fn new_encrypt_associated_data(&self) -> AssociatedData {
            AssociatedData::None
        }
    }
    impl Decrypter for StubBicrypter {
        fn decrypt(
            &self,
            buffer: &[u8],
            associated_data: &AssociatedData,
        ) -> Result<Vec<u8>, CryptError> {
            (self.0)(buffer, associated_data)
        }
    }

    #[test]
    fn encrypt_should_fail_if_caching_nonce_and_nonce_already_used() {
        let bicrypter =
            NonceCacheBicrypter::new(StubBicrypter(|_, _| Ok(vec![])), 1);
        let buffer = vec![1, 2, 3];
        let nonce = nonce::new_96bit_nonce();

        let result = bicrypter.encrypt(
            &buffer,
            &AssociatedData::Nonce(Nonce::Nonce96Bits(nonce)),
        );
        assert!(
            result.is_ok(),
            "First encrypt unexpectedly failed: {:?}",
            result
        );

        let result = bicrypter.encrypt(
            &buffer,
            &AssociatedData::Nonce(Nonce::Nonce96Bits(nonce)),
        );
        match result {
            Err(CryptError::NonceAlreadyUsed { nonce: _ }) => (),
            x => panic!("Unexpected result: {:?}", x),
        }
    }

    #[test]
    fn encrypt_should_fail_if_underlying_encrypt_fails() {
        let bicrypter = NonceCacheBicrypter::new(
            StubBicrypter(|_, _| {
                Err(CryptError::EncryptFailed(From::from("Some error")))
            }),
            1,
        );
        let buffer = vec![1, 2, 3];

        let nonce =
            AssociatedData::Nonce(Nonce::Nonce96Bits(nonce::new_96bit_nonce()));
        let result = bicrypter.encrypt(&buffer, &nonce);
        match result {
            Err(CryptError::EncryptFailed(_)) => (),
            x => panic!("Unexpected result: {:?}", x),
        }
    }

    #[test]
    fn encrypt_should_succeed_if_can_encrypt_buffer() {
        let bicrypter =
            NonceCacheBicrypter::new(StubBicrypter(|_, _| Ok(vec![])), 1);
        let buffer = vec![1, 2, 3];

        let nonce =
            AssociatedData::Nonce(Nonce::Nonce96Bits(nonce::new_96bit_nonce()));
        let result = bicrypter.encrypt(&buffer, &nonce);
        assert!(
            result.is_ok(),
            "First encrypt unexpectedly failed: {:?}",
            result
        );

        let nonce =
            AssociatedData::Nonce(Nonce::Nonce96Bits(nonce::new_96bit_nonce()));
        let result = bicrypter.encrypt(&buffer, &nonce);
        assert!(
            result.is_ok(),
            "Second encrypt unexpectedly failed: {:?}",
            result
        );
    }

    #[test]
    fn decrypt_should_fail_if_caching_nonce_and_nonce_already_used() {
        let bicrypter =
            NonceCacheBicrypter::new(StubBicrypter(|_, _| Ok(vec![])), 1);
        let buffer = vec![1, 2, 3];
        let nonce = nonce::new_96bit_nonce();

        let result = bicrypter.decrypt(
            &buffer,
            &AssociatedData::Nonce(Nonce::Nonce96Bits(nonce)),
        );
        assert!(
            result.is_ok(),
            "First encrypt unexpectedly failed: {:?}",
            result
        );

        let result = bicrypter.decrypt(
            &buffer,
            &AssociatedData::Nonce(Nonce::Nonce96Bits(nonce)),
        );
        match result {
            Err(CryptError::NonceAlreadyUsed { nonce: _ }) => (),
            x => panic!("Unexpected result: {:?}", x),
        }
    }

    #[test]
    fn decrypt_should_fail_if_underlying_decrypt_fails() {
        let bicrypter = NonceCacheBicrypter::new(
            StubBicrypter(|_, _| {
                Err(CryptError::DecryptFailed(From::from("Some error")))
            }),
            1,
        );
        let buffer = vec![1, 2, 3];

        let nonce =
            AssociatedData::Nonce(Nonce::Nonce96Bits(nonce::new_96bit_nonce()));
        let result = bicrypter.decrypt(&buffer, &nonce);
        match result {
            Err(CryptError::DecryptFailed(_)) => (),
            x => panic!("Unexpected result: {:?}", x),
        }
    }

    #[test]
    fn decrypt_should_succeed_if_can_decrypt_buffer() {
        let bicrypter =
            NonceCacheBicrypter::new(StubBicrypter(|_, _| Ok(vec![])), 1);
        let buffer = vec![1, 2, 3];

        let nonce =
            AssociatedData::Nonce(Nonce::Nonce96Bits(nonce::new_96bit_nonce()));
        let result = bicrypter.decrypt(&buffer, &nonce);
        assert!(
            result.is_ok(),
            "First encrypt unexpectedly failed: {:?}",
            result
        );

        let nonce =
            AssociatedData::Nonce(Nonce::Nonce96Bits(nonce::new_96bit_nonce()));
        let result = bicrypter.decrypt(&buffer, &nonce);
        assert!(
            result.is_ok(),
            "Second encrypt unexpectedly failed: {:?}",
            result
        );
    }
}