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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/*!
The Chunk is the lowest level of abstraction in an asuran repository.

Chunks are raw binary blobs, optionally compressed and encrypted, and keyed by
an HMAC of their plain text contents, and tagged with an HMAC of their encrypted
contents (different keys are used for both HMACs).

They can contain any arbitrary sequence of bytes.
*/
use super::{Compression, Encryption, Key, HMAC};

use serde::{Deserialize, Serialize};
use thiserror::Error;

use std::cmp;

/// Error for all the various things that can go wrong with handling chunks
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum ChunkError {
    #[error("Compression Error")]
    CompressionError(#[from] super::CompressionError),
    #[error("Encryption Error")]
    EncryptionError(#[from] super::EncryptionError),
    #[error("Key Error")]
    KeyError(#[from] super::KeyError),
    #[error("HMAC Vailidation Failed")]
    HMACValidationFailed,
}

type Result<T> = std::result::Result<T, ChunkError>;

/// Key used for indexing a `Chunk` in a repository
///
/// These are usually derived via an HMAC of the chunks plain text, and are used for
/// reduplication. If two chunks have the same `ChunkID`, it is assumed that they
/// are identical.
#[derive(PartialEq, Eq, Copy, Clone, Serialize, Deserialize, Hash, Debug)]
pub struct ChunkID {
    /// Keys are a bytestring of length 32
    ///
    /// This lines up well with SHA256 and other 256 bit hashes. Longer hashes will be
    /// truncated and shorter ones (not reccomended) will be padded with zeros at the
    /// end.
    id: [u8; 32],
}

impl ChunkID {
    /// Will create a new key from a slice.
    ///
    /// Keys longer than 32 bytes will be truncated.
    /// Keys shorter than 32 bytes will be padded at the end with zeros.
    pub fn new(input_id: &[u8]) -> ChunkID {
        let mut id: [u8; 32] = [0; 32];
        id[..cmp::min(32, input_id.len())]
            .clone_from_slice(&input_id[..cmp::min(32, input_id.len())]);
        ChunkID { id }
    }

    /// Provides a reference to a key's raw bytes
    #[cfg(not(tarpaulin_include))]
    pub fn get_id(&self) -> &[u8] {
        &self.id
    }

    /// Verifies equaliy of this key with the first 32 bytes of a slice
    pub fn verify(&self, slice: &[u8]) -> bool {
        if slice.len() < self.id.len() {
            false
        } else {
            let mut equal = true;
            for (i, val) in self.id.iter().enumerate() {
                if *val != slice[i] {
                    equal = false;
                }
            }
            equal
        }
    }

    /// Returns the special all-zero key used for the manifest
    pub fn manifest_id() -> ChunkID {
        ChunkID { id: [0_u8; 32] }
    }

    /// Returns a random id, used for testing
    pub fn random_id() -> ChunkID {
        let id = rand::random();
        ChunkID { id }
    }
}

/// Encapsulates the Encryption, Compression, and HMAC tags for a chunk
#[derive(Serialize, Deserialize, Clone, Debug, Copy, PartialEq, Eq)]
pub struct ChunkSettings {
    pub compression: Compression,
    pub encryption: Encryption,
    pub hmac: HMAC,
}

impl ChunkSettings {
    /// Returns a `ChunkSettings` with `Encryption::NoEncryption`,
    /// `Compression::NoCompression`, and `HMAC::Blake2b`.
    ///
    /// These settings are, very nearly, the least computationally intensive that asuran
    /// supports.
    pub fn lightweight() -> ChunkSettings {
        ChunkSettings {
            compression: Compression::NoCompression,
            encryption: Encryption::NoEncryption,
            hmac: HMAC::Blake2b,
        }
    }
}

/// A split representation of a `Chunk`'s 'header' or metadata.
/// Used for on disk storage
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct ChunkHeader {
    compression: Compression,
    encryption: Encryption,
    hmac: HMAC,
    mac: Vec<u8>,
    id: ChunkID,
}

/// A split representation of a `Chunk`'s body, or contained data
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct ChunkBody(pub Vec<u8>);

/// A binary blob, ready to be commited to storage
///
/// A `Chunk` is an arbitrary sequence of bytes, along with its associated `ChunkID`
/// key.
///
/// Data in a `Chunk` has already undergone any selected compression and encryption,
/// and has an associated HMAC tag used for verifying the integrity of the data.
/// This HMAC tag is unrelated to the `ChunkID` key, and uses a separate HMAC key.
///
/// Chunks are additionally tagged with the encryption and compression modes used
/// for them.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Chunk {
    /// The data of the chunk, stored as a vec of raw bytes
    #[serde(with = "serde_bytes")]
    data: Vec<u8>,
    /// Compression algorithim used
    compression: Compression,
    /// Encryption Algorithim used, also stores IV
    encryption: Encryption,
    /// HMAC algorithim used
    hmac: HMAC,
    /// HMAC tag of the cyphertext bytes of this chunk
    #[serde(with = "serde_bytes")]
    mac: Vec<u8>,
    /// `ChunkID`, used for indexing in the repository and deduplication
    id: ChunkID,
}

impl Chunk {
    /// Produces a `Chunk` from the given data, using the specified
    /// encryption, and hmac algorithms, as well as the supplied key material.
    ///
    /// # Panics
    ///
    /// Will panic if any of the compression, encryption, or `HMAC` operations fail.
    /// This would represent a massive programming oversight which the user of the
    /// library has little hope of recovering from safely without compromising
    /// cryptographic integrity.
    pub fn pack(
        data: Vec<u8>,
        compression: Compression,
        encryption: Encryption,
        hmac: HMAC,
        key: &Key,
    ) -> Chunk {
        let id_mac = hmac.id(&data, key);
        let id = ChunkID::new(&id_mac);
        Chunk::pack_with_id(data, compression, encryption, hmac, key, id)
    }

    /// Constructs a `Chunk` from its raw parts.
    ///
    /// This has potentially dangerous consequences if done incorrectly, and should be
    /// avoided if another method is available.
    pub fn from_parts(
        data: Vec<u8>,
        compression: Compression,
        encryption: Encryption,
        hmac: HMAC,
        mac: Vec<u8>,
        id: ChunkID,
    ) -> Chunk {
        Chunk {
            data,
            compression,
            encryption,
            hmac,
            mac,
            id,
        }
    }

    /// Produces a `Chunk` using the provided settings, but overriding the `ChunkID`
    /// key.
    ///
    /// This has the potential to do serious damage to a repository if used incorrectly,
    /// and should be avoided if another method is available.
    pub fn pack_with_id(
        data: Vec<u8>,
        compression: Compression,
        mut encryption: Encryption,
        hmac: HMAC,
        key: &Key,
        id: ChunkID,
    ) -> Chunk {
        let compressed_data = compression.compress(data);
        let data = encryption.encrypt(&compressed_data, key);
        let mac = hmac.mac(&data, key);
        Chunk {
            data,
            compression,
            encryption,
            hmac,
            mac,
            id,
        }
    }

    /// Validates, decrypts, and decompresses the data in a `Chunk`.
    ///
    /// # Errors
    ///
    /// Will return `Err(HMACVailidationFailed)` if the chunk fails validation.
    ///
    /// Will return `Err(EncryptionError)` if decryption fails.
    ///
    /// Will return `Err(CompressionError)` if decompression fails.
    ///
    /// All of these error values indicate that the `Chunk` is corrupted or otherwise
    /// malformed.
    pub fn unpack(&self, key: &Key) -> Result<Vec<u8>> {
        if self.hmac.verify_hmac(&self.mac, &self.data, key) {
            let decrypted_data = self.encryption.decrypt(&self.data, key)?;
            let decompressed_data = self.compression.decompress(decrypted_data)?;

            Ok(decompressed_data)
        } else {
            Err(ChunkError::HMACValidationFailed)
        }
    }

    #[cfg(not(tarpaulin_include))]
    /// Returns the length of the data in the `Chunk`
    pub fn len(&self) -> usize {
        self.data.len()
    }

    #[cfg(not(tarpaulin_include))]
    /// Determine if this chunk is empty
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    #[cfg(not(tarpaulin_include))]
    /// Returns a reference to the raw bytes of this chunk
    pub fn get_bytes(&self) -> &[u8] {
        &self.data
    }

    /// Returns the `ChunkID` key assocaited with the data in this chunk.
    pub fn get_id(&self) -> ChunkID {
        self.id
    }

    /// Returns the `mac` value of this chunk
    pub fn mac(&self) -> Vec<u8> {
        self.mac.clone()
    }

    /// Splits a `Chunk` into its header and body components
    pub fn split(self) -> (ChunkHeader, ChunkBody) {
        let header = ChunkHeader {
            compression: self.compression,
            encryption: self.encryption,
            hmac: self.hmac,
            mac: self.mac,
            id: self.id,
        };
        let body = ChunkBody(self.data);

        (header, body)
    }

    /// Combines a header and a body into a `Chunk`
    pub fn unsplit(header: ChunkHeader, body: ChunkBody) -> Chunk {
        Chunk {
            data: body.0,
            compression: header.compression,
            encryption: header.encryption,
            hmac: header.hmac,
            mac: header.mac,
            id: header.id,
        }
    }

    /// Returns a copy of the encryption method/iv used for the chunk
    pub fn encryption(&self) -> Encryption {
        self.encryption
    }

    #[cfg(test)]
    #[cfg(not(tarpaulin_include))]
    /// Testing only function used to corrupt the data
    pub fn break_data(&mut self, index: usize) {
        let val = self.data[index];
        if val == 0 {
            self.data[index] = 1;
        } else {
            self.data[index] = 0;
        }
    }
}

impl PartialEq for Chunk {
    fn eq(&self, other: &Self) -> bool {
        self.id == other.id && self.data == other.data
    }
}

impl Eq for Chunk {}

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

    fn chunk_with_settings(compression: Compression, encryption: Encryption, hmac: HMAC) {
        let data_string =
            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";

        let data_bytes = data_string.as_bytes().to_vec();
        println!("Data: \n:{:X?}", data_bytes);
        println!("{:?} {:?} {:?}", compression, hmac, encryption);

        let key = Key::random(32);
        let packed = Chunk::pack(data_bytes, compression, encryption, hmac, &key);

        let output_bytes = packed.unpack(&key).expect("Failed to unpack output bytes");

        assert_eq!(data_string.as_bytes().to_vec(), output_bytes);
    }

    #[test]
    fn all_combos() {
        let compressions = [
            Compression::NoCompression,
            Compression::ZStd { level: 1 },
            Compression::LZ4 { level: 1 },
            Compression::LZMA { level: 1 },
        ];
        let encryptions = [
            Encryption::NoEncryption,
            Encryption::new_aes256ctr(),
            Encryption::new_chacha20(),
        ];
        let hmacs = [
            HMAC::SHA256,
            HMAC::Blake2b,
            HMAC::Blake2bp,
            HMAC::Blake3,
            HMAC::SHA3,
        ];
        for c in compressions.iter() {
            for e in encryptions.iter() {
                for h in hmacs.iter() {
                    chunk_with_settings(*c, *e, *h);
                }
            }
        }
    }

    #[test]
    fn detect_bad_data() {
        let data_string = "I am but a humble test string";
        let data_bytes = data_string.as_bytes().to_vec();
        let compression = Compression::NoCompression;
        let encryption = Encryption::NoEncryption;
        let hmac = HMAC::SHA256;

        let key = Key::random(32);

        let mut packed = Chunk::pack(data_bytes, compression, encryption, hmac, &key);
        packed.break_data(5);

        let result = packed.unpack(&key);

        assert!(result.is_err());
    }

    #[test]
    fn chunk_id_equality() {
        let data1 = [1_u8; 64];
        let data2 = [2_u8; 64];
        let id = ChunkID::new(&data1);
        assert!(id.verify(&data1));
        assert!(!id.verify(&data2));
    }

    #[test]
    fn split_unsplit() {
        let data_string = "I am but a humble test string";
        let data_bytes = data_string.as_bytes().to_vec();
        let compression = Compression::LZ4 { level: 1 };
        let encryption = Encryption::new_aes256ctr();
        let hmac = HMAC::SHA256;

        let key = Key::random(32);

        let packed = Chunk::pack(data_bytes, compression, encryption, hmac, &key);
        let (header, body) = packed.split();
        let packed = Chunk::unsplit(header, body);

        let result = packed.unpack(&key);

        assert!(result.is_ok());
    }
}