pipenet 0.2.4

Non blocking tcp stream wrapper using channels
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
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

#[cfg(feature = "encryption")]
mod encryption;

#[cfg(feature = "compression")]
mod compression;

/// A list of encapsulatins for the protocol.
/// Their order is executed while writing, while the reverse while reading.
///
/// The wrappers can be build in order with the builder methods for example:
///
/// ```ignore
/// use pipenet::Packs;
///
/// let key = &[0u8; 32];
/// let _wrappers = Packs::default()
///     .compress()
///     .encrypt(key);
/// ```
#[derive(Default)]
pub struct Packs {
    items: Vec<Pack>,
}

impl Packs {
    pub fn is_empty(&self) -> bool {
        self.items.is_empty()
    }

    #[cfg(feature = "compression")]
    pub fn compress(mut self) -> Self {
        self.items
            .push(Pack::Compression(compression::Compression::Lz4));
        self
    }

    #[cfg(feature = "encryption")]
    pub fn encrypt(mut self, key: &[u8]) -> Self {
        use chacha20poly1305::{ChaCha20Poly1305, KeyInit};

        let c = ChaCha20Poly1305::new(key.into());
        self.items
            .push(Pack::Encryption(encryption::Encryption::Ccp(c)));
        self
    }
}

// Generic packer/unpacker functions.
#[allow(unused)]
pub(crate) trait PackUnpack {
    fn pack(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        Ok(data.to_vec())
    }

    fn unpack(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        Ok(data.to_vec())
    }
}

impl PackUnpack for Packs {
    fn pack(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        if data.is_empty() {
            return Ok(Vec::new());
        }
        // packing executes them in order
        let mut res = data.to_vec();
        for p in self.items.iter() {
            res = p.pack(&res)?
        }
        Ok(res)
    }

    fn unpack(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        if data.is_empty() {
            return Ok(Vec::new());
        }
        // unpacking executes them in reverse
        let mut res = data.to_vec();
        for p in self.items.iter().rev() {
            res = p.unpack(&res)?
        }
        Ok(res)
    }
}

// The type of encapsulation for the message body.
// This allows to unpack the message body in different situations.
// A stream can have multiple encapsulations and they will be applied in order
// when sending, but in reverse when receiving.
enum Pack {
    #[cfg(feature = "compression")]
    Compression(compression::Compression),
    #[cfg(feature = "encryption")]
    #[allow(unused)]
    Encryption(encryption::Encryption),
}

impl PackUnpack for Pack {
    #[cfg(any(feature = "encryption", feature = "compression"))]
    fn pack(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        match self {
            #[cfg(feature = "compression")]
            Pack::Compression(c) => c.pack(data),
            #[cfg(feature = "encryption")]
            Pack::Encryption(e) => e.pack(data),
        }
    }

    #[cfg(any(feature = "encryption", feature = "compression"))]
    fn unpack(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        match self {
            #[cfg(feature = "compression")]
            Pack::Compression(c) => c.unpack(data),
            #[cfg(feature = "encryption")]
            Pack::Encryption(e) => e.unpack(data),
        }
    }
}