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
use std::convert::TryFrom;
use std::mem::size_of_val;

use num_enum::{IntoPrimitive, TryFromPrimitive};

use cjdns_bytes::{ExpectedSize, ParseError, Reader, SerializeError, Writer};
use netchecksum;

use crate::{ErrorData, PingData};

/// Serialized control message
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CtrlMessage {
    pub msg_type: CtrlMessageType,
    pub msg_data: CtrlMessageData,
}

/// Control message type, which is considered as message header
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[repr(u16)]
pub enum CtrlMessageType {
    Error = 2,
    Ping = 3,
    Pong = 4,
    KeyPing = 5,
    KeyPong = 6,
    GetSuperNodeQuery = 7,
    GetSuperNodeResponse = 8,
}

/// Control message serialized body data
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CtrlMessageData {
    PingData(PingData),
    ErrorData(ErrorData),
    SuperNodeQueryData(), // Not implemented
}

impl CtrlMessage {
    /// Control message header size, which is considered as minimum size message bytes to parsed.
    /// Actually, message size should be greater than is stated in this constant, but this is checked further
    /// in `CtrlMessage` "sub-parsers".
    pub const HEADER_SIZE: usize = 4;

    /// Parses raw bytes into `CtrlMessage`.
    ///
    /// Result in error in several situations:
    /// * input bytes length is less then `CtrlMessage::HEADER_SIZE`
    /// * input data got invalid checksum
    /// * unrecognized control message type code was parsed
    /// * control message body parsing methods failed. For more information about this read documentation for corresponding message data structs (i.e. `PingData`, `ErrorData`)
    pub fn parse(bytes: &[u8]) -> Result<Self, ParseError> {
        let mut reader = Reader::new(bytes);
        let (received_checksum, data, type_code, raw_data) = reader
            .read(ExpectedSize::NotLessThan(Self::HEADER_SIZE), |r| {
                let received_checksum = r.read_u16_be()?;
                let after_checksum_data = r.peek_remainder();
                let type_code = r.read_u16_be()?;
                let raw_data = r.read_remainder();
                Ok((received_checksum, after_checksum_data, type_code, raw_data))
            })
            .map_err(|_| ParseError::InvalidPacketSize)?;
        // Validating message checksum
        {
            let computed_checksum = netchecksum::cksum_raw(data);
            let inverted_checksum = (computed_checksum << 8) | (computed_checksum >> 8);
            if received_checksum != computed_checksum && received_checksum != inverted_checksum {
                return Err(ParseError::InvalidChecksum(received_checksum, computed_checksum));
            }
        }
        let msg_type = CtrlMessageType::from_u16(type_code).map_err(|_| ParseError::InvalidData("unknown ctrl packet"))?;
        let msg_data = match msg_type {
            CtrlMessageType::Error => CtrlMessageData::ErrorData(ErrorData::parse(raw_data)?),
            CtrlMessageType::GetSuperNodeQuery | CtrlMessageType::GetSuperNodeResponse => CtrlMessageData::SuperNodeQueryData(),
            CtrlMessageType::Ping | CtrlMessageType::Pong | CtrlMessageType::KeyPing | CtrlMessageType::KeyPong => {
                CtrlMessageData::PingData(PingData::parse(raw_data, msg_type)?)
            }
        };
        Ok(CtrlMessage { msg_type, msg_data })
    }

    /// Serializes `CtrlMessage` instance.
    ///
    /// `CtrlMessage` type can be instantiated directly, without using `parse` method.
    /// That's why serialization can result in errors in several situations:
    /// * instantiated message with different header and body types. For example, message with error type stated in header and ping data will fail serialization
    /// * error/ping data serialization failed
    pub fn serialize(&self) -> Result<Vec<u8>, SerializeError> {
        let raw_data = match self.msg_type {
            CtrlMessageType::Error => {
                let error_data = self
                    .get_error_data()
                    .ok_or(SerializeError::InvalidInvariant("message with error header, but ping data body"))?;
                error_data.serialize()?
            }
            CtrlMessageType::GetSuperNodeQuery | CtrlMessageType::GetSuperNodeResponse => {
                return Err(SerializeError::InvalidData("can't serialize GetsNode messages"))
            }
            // Ping | Pong | KeyPing | KeyPong
            ping_type => {
                let ping_data = self
                    .get_ping_data()
                    .ok_or(SerializeError::InvalidInvariant("message with ping header, but error data body"))?;
                ping_data.serialize(ping_type)?
            }
        };
        let checksum_data = {
            let msg_type_bytes = self.msg_type.to_u16();
            // encoded msg type and msg raw data
            let mut data = Vec::with_capacity(size_of_val(&msg_type_bytes) + raw_data.len());
            data.extend_from_slice(&msg_type_bytes.to_be_bytes());
            data.extend_from_slice(&raw_data);
            data
        };
        let checksum = netchecksum::cksum_raw(&checksum_data);

        let mut writer = Writer::with_capacity(size_of_val(&checksum) + checksum_data.len());
        writer.write_u16_be(checksum);
        writer.write_slice(&checksum_data);

        Ok(writer.into_vec())
    }

    pub fn get_error_data(&self) -> Option<&ErrorData> {
        self.msg_data.extract_error_data()
    }

    pub fn get_ping_data(&self) -> Option<&PingData> {
        self.msg_data.extract_ping_data()
    }
}

impl CtrlMessageType {
    fn from_u16(code: u16) -> Result<CtrlMessageType, ()> {
        CtrlMessageType::try_from(code).map_err(|_| ())
    }

    fn to_u16(self) -> u16 {
        self.into()
    }
}

impl CtrlMessageData {
    fn extract_error_data(&self) -> Option<&ErrorData> {
        match self {
            Self::ErrorData(data) => Some(data),
            _ => None,
        }
    }

    fn extract_ping_data(&self) -> Option<&PingData> {
        match self {
            Self::PingData(data) => Some(data),
            _ => None,
        }
    }
}

#[cfg(test)]
mod tests {
    use cjdns_core::RoutingLabel;
    use cjdns_hdr::SwitchHeader;
    use cjdns_keys::CJDNSPublicKey;

    use crate::ErrorMessageType;

    use super::*;

    fn decode_hex(hex: &str) -> Vec<u8> {
        hex::decode(hex).expect("invalid hex string")
    }

    #[test]
    fn test_ping() {
        let test_bytes = decode_hex("a2e5000309f91102000000124d160b1eee2929e12e19a3b1");
        let parsed_msg = CtrlMessage::parse(&test_bytes).expect("invalid message data");
        let serialized_msg = parsed_msg.serialize().expect("invalid message data");
        assert_eq!(
            parsed_msg,
            CtrlMessage {
                msg_type: CtrlMessageType::Ping,
                msg_data: CtrlMessageData::PingData(PingData {
                    version: 18,
                    key: None,
                    content: decode_hex("4d160b1eee2929e12e19a3b1")
                }),
            }
        );
        assert_eq!(serialized_msg, test_bytes);
    }

    #[test]
    fn test_pong() {
        let test_bytes = decode_hex("497400049d74e35b0000001280534c66df69e44b496d5bc8");
        let parsed_msg = CtrlMessage::parse(&test_bytes).expect("invalid message data");
        let serialized_msg = parsed_msg.serialize().expect("invalid message data");
        assert_eq!(
            parsed_msg,
            CtrlMessage {
                msg_type: CtrlMessageType::Pong,
                msg_data: CtrlMessageData::PingData(PingData {
                    version: 18,
                    key: None,
                    content: decode_hex("80534c66df69e44b496d5bc8")
                }),
            }
        );
        assert_eq!(serialized_msg, test_bytes);
    }

    #[test]
    fn test_key_ping() {
        let test_bytes = decode_hex("994b00050123456700000012a331ebbed8d92ac03b10efed3e389cd0c6ec7331a72dbde198476c5eb4d14a1f02e29842b42aedb6bce2ead3");
        let parsed_msg = CtrlMessage::parse(&test_bytes).expect("invalid message data");
        let serialized_msg = parsed_msg.serialize().expect("invalid message data");
        assert_eq!(
            parsed_msg,
            CtrlMessage {
                msg_type: CtrlMessageType::KeyPing,
                msg_data: CtrlMessageData::PingData(PingData {
                    version: 18,
                    key: CJDNSPublicKey::try_from("3fdqgz2vtqb0wx02hhvx3wjmjqktyt567fcuvj3m72vw5u6ubu70.k").ok(),
                    content: decode_hex("02e29842b42aedb6bce2ead3")
                }),
            }
        );
        assert_eq!(serialized_msg, test_bytes);
    }

    #[test]
    fn test_key_pong() {
        let test_bytes = decode_hex("3b96000689abcdef000000126bd2e8e50faca3d987623d6a043c17c0d9e9004e145f8dd90615d34edbb36d6a02e29842b42aedb6bce2ead3");
        let parsed_msg = CtrlMessage::parse(&test_bytes).expect("invalid message data");
        let serialized_msg = parsed_msg.serialize().expect("invalid message data");
        assert_eq!(
            parsed_msg,
            CtrlMessage {
                msg_type: CtrlMessageType::KeyPong,
                msg_data: CtrlMessageData::PingData(PingData {
                    version: 18,
                    key: CJDNSPublicKey::try_from("cmnkylz1dx8mx3bdxku80yw20gqmg0s9nsrusdv0psnxnfhqfmu0.k").ok(),
                    content: decode_hex("02e29842b42aedb6bce2ead3")
                }),
            }
        );
        assert_eq!(serialized_msg, test_bytes);
    }

    #[test]
    fn test_error() {
        let error_hex = "bce300020000000a62c1d23a648114010379000000012d7c000006c378e071c46aefad3aa\
            295fff396371d10678e9833807de083a4a40da39bf0f68f15c4380afbe92405196242a74bb3\
            04a8285088579f94fb01867be2171aa8d2c7b54198a89bbdb80c668e9c05";
        let test_bytes = decode_hex(error_hex);
        let parsed_msg = CtrlMessage::parse(&test_bytes).expect("invalid message data");
        let parsed_additional = vec![
            0u8, 1, 45, 124, 0, 0, 6, 195, 120, 224, 113, 196, 106, 239, 173, 58, 162, 149, 255, 243, 150, 55, 29, 16, 103, 142, 152, 51, 128, 125, 224, 131,
            164, 164, 13, 163, 155, 240, 246, 143, 21, 196, 56, 10, 251, 233, 36, 5, 25, 98, 66, 167, 75, 179, 4, 168, 40, 80, 136, 87, 159, 148, 251, 1, 134,
            123, 226, 23, 26, 168, 210, 199, 181, 65, 152, 168, 155, 189, 184, 12, 102, 142, 156, 5,
        ];
        let serialized_msg = parsed_msg.serialize().expect("invalid message data");
        assert_eq!(
            parsed_msg,
            CtrlMessage {
                msg_type: CtrlMessageType::Error,
                msg_data: CtrlMessageData::ErrorData(ErrorData {
                    err_type: ErrorMessageType::ReturnPathInvalid,
                    switch_header: SwitchHeader {
                        label: RoutingLabel::<u64>::try_from("62c1.d23a.6481.1401").expect("invalid routing label string"),
                        congestion: 1,
                        suppress_errors: true,
                        version: 1,
                        label_shift: 57,
                        penalty: 0
                    },
                    additional: parsed_additional
                }),
            }
        );
        assert_eq!(serialized_msg, test_bytes);
    }

    #[test]
    fn test_parse_invalid() {
        let invalid_data = [
            // invalid length
            "aabb",
            // invalid checksum
            "000011111111aaaaaaaa",
            // unrecognized message type
            "a2de000a09f91102000000124d160b1eee2929e12e19a3b1",
        ];
        for data in invalid_data.iter() {
            let test_bytes = decode_hex(data);
            assert!(CtrlMessage::parse(&test_bytes).is_err());
        }
    }

    #[test]
    fn test_serialize_invalid() {
        let invalid_instances = [
            // type doesn't confirm to data
            CtrlMessage {
                msg_type: CtrlMessageType::Error,
                msg_data: CtrlMessageData::PingData(PingData {
                    version: 18,
                    key: None,
                    content: decode_hex("80534c66df69e44b496d5bc8"),
                }),
            },
            CtrlMessage {
                msg_type: CtrlMessageType::Ping,
                msg_data: CtrlMessageData::ErrorData(ErrorData {
                    err_type: ErrorMessageType::ReturnPathInvalid,
                    switch_header: SwitchHeader {
                        label: RoutingLabel::<u64>::try_from("62c1.d23a.6481.1401").expect("invalid routing label string"),
                        congestion: 1,
                        suppress_errors: true,
                        version: 1,
                        label_shift: 57,
                        penalty: 0,
                    },
                    additional: vec![],
                }),
            },
        ];
        for ctrl_data in invalid_instances.iter() {
            assert!(ctrl_data.serialize().is_err());
        }
    }

    #[test]
    fn test_get_snode_msg() {
        // GetSuperNodeQuery message
        let test_bytes = decode_hex("a2e1000709f91102000000124d160b1eee2929e12e19a3b1");
        let message = CtrlMessage::parse(&test_bytes);
        assert!(message.is_ok());
        let message = message.unwrap();
        assert_eq!(message.msg_type, CtrlMessageType::GetSuperNodeQuery);
        assert_eq!(message.msg_data, CtrlMessageData::SuperNodeQueryData());

        let test_instance = CtrlMessage {
            msg_type: CtrlMessageType::GetSuperNodeResponse,
            msg_data: CtrlMessageData::SuperNodeQueryData(),
        };
        assert!(test_instance.serialize().is_err()); // Not implemented
    }
}