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
use crate::{
    error::*,
    message::{BodyType, MessageType},
    serialization::{Decode, Encode},
};
use std::io::{Cursor, Read, Write};

const HEADER_VIRTUAL_CHANNEL_FLAG: u8 = 0x01;

#[allow(clippy::len_without_is_empty)] // it doesn't make sense in our case
pub trait AbstractNowHeader {
    fn len(&self) -> usize;
    fn is_short(&self) -> bool;
    fn flags(&self) -> u8;
    fn body_type(&self) -> BodyType;
    fn body_len(&self) -> usize;
    fn packet_len(&self) -> usize;
}

#[derive(Debug, Clone)]
pub enum NowHeader {
    Short(NowShortHeader),
    Long(NowLongHeader),
}

impl Decode<'_> for NowHeader {
    fn decode_from(cursor: &mut Cursor<&[u8]>) -> Result<Self> {
        Self::read_from(cursor)
    }
}

impl Encode for NowHeader {
    fn encoded_len(&self) -> usize {
        match self {
            NowHeader::Short(_) => NowShortHeader::SIZE,
            NowHeader::Long(_) => NowLongHeader::SIZE,
        }
    }

    fn encode_into<W: Write>(&self, writer: &mut W) -> Result<()> {
        match self {
            NowHeader::Short(header) => header.encode_into(writer),
            NowHeader::Long(header) => header.encode_into(writer),
        }
    }
}

impl NowHeader {
    pub fn new(body_type: BodyType, body_len: u32) -> Self {
        if body_len > u32::from(u16::max_value()) {
            Self::Long(NowLongHeader::new(body_type, body_len))
        } else {
            Self::Short(NowShortHeader::new(body_type, body_len as u16))
        }
    }

    pub fn new_with_msg_type(msg_type: MessageType, body_len: u32) -> Self {
        Self::new(BodyType::Message(msg_type), body_len)
    }

    pub fn new_with_virt_channel(channel_id: u8, body_len: u32) -> Self {
        Self::new(BodyType::VirtualChannel(channel_id), body_len)
    }

    pub fn read_from<R: Read>(reader: &mut R) -> Result<Self> {
        let (bytes, short_bit) = {
            let mut buffer = vec![0u8; 4];
            reader
                .read_exact(&mut buffer)
                .map_err(ProtoError::from)
                .chain(ProtoErrorKind::Decoding(stringify!(NowHeader)))
                .or_desc("couldn't read short bit (no enough bytes provided")?;

            let is_short = buffer[3] > 7;

            if !is_short {
                buffer.append(&mut vec![0u8; 2]);
                reader
                    .read_exact(&mut buffer[4..6])
                    .map_err(ProtoError::from)
                    .chain(ProtoErrorKind::Decoding(stringify!(NowHeader)))
                    .or_desc("not enough bytes provided to parse long header")?;
            };

            (buffer, is_short)
        };

        let mut cursor = Cursor::new(&bytes[..]);
        if short_bit {
            Ok(NowHeader::Short(NowShortHeader::decode_from(&mut cursor)?))
        } else {
            Ok(NowHeader::Long(NowLongHeader::decode_from(&mut cursor)?))
        }
    }

    pub fn borrow_short(&self) -> Option<&NowShortHeader> {
        match self {
            NowHeader::Short(header) => Some(header),
            NowHeader::Long(_) => None,
        }
    }

    pub fn into_short(self) -> Option<NowShortHeader> {
        match self {
            NowHeader::Short(header) => Some(header),
            NowHeader::Long(_) => None,
        }
    }

    pub fn borrow_long(&self) -> Option<&NowLongHeader> {
        match self {
            NowHeader::Short(_) => None,
            NowHeader::Long(header) => Some(header),
        }
    }

    pub fn into_long(self) -> Option<NowLongHeader> {
        match self {
            NowHeader::Short(_) => None,
            NowHeader::Long(header) => Some(header),
        }
    }

    pub fn borrow_abstract(&self) -> &dyn AbstractNowHeader {
        match self {
            NowHeader::Short(header) => header,
            NowHeader::Long(header) => header,
        }
    }

    pub fn into_abstract(self) -> Box<dyn AbstractNowHeader> {
        match self {
            NowHeader::Short(header) => Box::new(header),
            NowHeader::Long(header) => Box::new(header),
        }
    }
}

impl AbstractNowHeader for NowHeader {
    fn len(&self) -> usize {
        match self {
            NowHeader::Short(hdr) => hdr.len(),
            NowHeader::Long(hdr) => hdr.len(),
        }
    }

    fn is_short(&self) -> bool {
        match self {
            NowHeader::Short(hdr) => hdr.is_short(),
            NowHeader::Long(hdr) => hdr.is_short(),
        }
    }

    fn flags(&self) -> u8 {
        match self {
            NowHeader::Short(hdr) => hdr.flags(),
            NowHeader::Long(hdr) => hdr.flags(),
        }
    }

    fn body_type(&self) -> BodyType {
        match self {
            NowHeader::Short(hdr) => hdr.body_type(),
            NowHeader::Long(hdr) => hdr.body_type(),
        }
    }

    fn body_len(&self) -> usize {
        match self {
            NowHeader::Short(hdr) => hdr.body_len(),
            NowHeader::Long(hdr) => hdr.body_len(),
        }
    }

    fn packet_len(&self) -> usize {
        match self {
            NowHeader::Short(hdr) => hdr.packet_len(),
            NowHeader::Long(hdr) => hdr.packet_len(),
        }
    }
}

#[derive(Encode, Debug, PartialEq, Clone)]
pub struct NowShortHeader {
    body_len: u16,
    body_type: BodyType,
    flags: u8,
}

impl Decode<'_> for NowShortHeader {
    fn decode_from(cursor: &mut Cursor<&[u8]>) -> Result<Self> {
        let body_len = u16::decode_from(cursor)?;
        let body_type_raw = u8::decode_from(cursor)?;
        let flags = u8::decode_from(cursor)?;
        let body_type = if flags & HEADER_VIRTUAL_CHANNEL_FLAG != 0 {
            BodyType::VirtualChannel(body_type_raw)
        } else {
            BodyType::Message(MessageType::decode(&[body_type_raw])?)
        };

        Ok(Self {
            body_len,
            body_type,
            flags,
        })
    }
}

impl NowShortHeader {
    pub const SIZE: usize = 4;

    pub fn new(body_type: BodyType, body_len: u16) -> Self {
        let flags = 0x80 // short bit flag
            | if let BodyType::VirtualChannel { .. } = body_type { HEADER_VIRTUAL_CHANNEL_FLAG } else { 0x00 };

        Self {
            flags,
            body_type,
            body_len,
        }
    }

    pub fn new_with_msg_type(message_type: MessageType, body_len: u16) -> Self {
        Self::new(BodyType::Message(message_type), body_len)
    }

    pub fn new_with_virt_channel(virtual_channel_id: u8, body_len: u16) -> Self {
        Self::new(BodyType::VirtualChannel(virtual_channel_id), body_len)
    }
}

impl AbstractNowHeader for NowShortHeader {
    fn len(&self) -> usize {
        NowShortHeader::SIZE
    }

    fn is_short(&self) -> bool {
        true
    }

    fn flags(&self) -> u8 {
        self.flags & 0b0111_1111 // unset the short bit flag
    }

    fn body_type(&self) -> BodyType {
        self.body_type
    }

    fn body_len(&self) -> usize {
        self.body_len as usize
    }

    fn packet_len(&self) -> usize {
        self.body_len as usize + Self::SIZE
    }
}

#[derive(Debug, Encode, PartialEq, Clone)]
pub struct NowLongHeader {
    body_len: u32,
    flags: u8,
    body_type: BodyType,
}

impl Decode<'_> for NowLongHeader {
    fn decode_from(cursor: &mut Cursor<&[u8]>) -> Result<Self> {
        let body_len = u32::decode_from(cursor)?;
        let flags = u8::decode_from(cursor)?;

        let body_type = if flags & HEADER_VIRTUAL_CHANNEL_FLAG != 0 {
            BodyType::VirtualChannel(u8::decode_from(cursor)?)
        } else {
            BodyType::Message(MessageType::decode_from(cursor)?)
        };

        Ok(Self {
            body_len,
            flags,
            body_type,
        })
    }
}

impl NowLongHeader {
    pub const SIZE: usize = 6;

    pub fn new(body_type: BodyType, body_size: u32) -> Self {
        Self {
            body_len: body_size & 0b0111_1111_1111_1111u32, // unset short bit flag
            flags: if let BodyType::VirtualChannel { .. } = body_type {
                HEADER_VIRTUAL_CHANNEL_FLAG
            } else {
                0x00
            },
            body_type,
        }
    }

    pub fn new_with_msg_type(message_type: MessageType, body_len: u32) -> Self {
        Self::new(BodyType::Message(message_type), body_len)
    }

    pub fn new_with_virt_channel(virtual_channel_id: u8, body_len: u32) -> Self {
        Self::new(BodyType::VirtualChannel(virtual_channel_id), body_len)
    }
}

impl AbstractNowHeader for NowLongHeader {
    fn len(&self) -> usize {
        NowLongHeader::SIZE
    }

    fn is_short(&self) -> bool {
        false
    }

    fn flags(&self) -> u8 {
        self.flags
    }

    fn body_type(&self) -> BodyType {
        self.body_type
    }

    fn body_len(&self) -> usize {
        self.body_len as usize
    }

    fn packet_len(&self) -> usize {
        self.body_len as usize + Self::SIZE
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::serialization::{Decode, Encode};

    #[rustfmt::skip]
    const SHORT_HEADER_MSG: [u8; 4] = [
        // vheader
        0x28, 0x00, // msg size
        0x01, // msg type
        0x80, // msg flags
    ];

    #[test]
    fn short_header_decoding() {
        let header = NowHeader::decode(&SHORT_HEADER_MSG).unwrap().into_short().unwrap();
        assert!(header.is_short());
        assert_eq!(header.flags(), 0x00);
        assert_eq!(header.flags, 0x80); // raw flags, test the short bit
        assert_eq!(header.body_type(), BodyType::Message(MessageType::Handshake));
        assert_eq!(header.body_len(), 40);
    }

    #[test]
    fn short_header_decoding_error() {
        let header = NowHeader::decode(&SHORT_HEADER_MSG).unwrap().into_long();
        assert_eq!(header, None); // wasn't a long header
    }

    #[test]
    fn short_header_encoding() {
        let header = NowShortHeader::new_with_msg_type(MessageType::Handshake, 40);
        assert_eq!([0x28, 0x00, 0x01, 0x80], header.encode().unwrap()[0..]);
    }

    #[rustfmt::skip]
    const LONG_HEADER_MSG: [u8; 6] = [
        // header
        0x1d, 0x03, 0x00, 0x00, // msg size
        0x00, // msg flags
        0x42, // msg type
    ];

    #[test]
    fn long_header_decoding() {
        let header = NowHeader::decode(&LONG_HEADER_MSG).unwrap().into_abstract();
        assert!(!header.is_short());
        assert_eq!(header.flags(), 0x00);
        assert_eq!(header.body_type(), BodyType::Message(MessageType::Update));
        assert_eq!(header.body_len(), 797);
    }

    #[test]
    fn long_header_encoding() {
        let header = NowLongHeader::new_with_msg_type(MessageType::Update, 797);
        assert_eq!([0x1d, 0x03, 0x00, 0x00, 0x00, 0x42], header.encode().unwrap()[..]);
    }

    #[rustfmt::skip]
    const VIRTUAL_CHANNEL_HEADER: [u8; 20] = [
        // vheader
        0x10, 0x00, // msg size
        0x01, // channel id
        0x81, // flags

        // file transfer channel message
        0x00, // subtype
        0x00, // flags
        0x00, 0x00, // session id
        0x00, 0x00, 0x00, 0x00, // capabilities
        0x00, 0x20, 0x00, 0x00, // chunk size
        0x00, 0x00, 0x00, 0x00, // flags
    ];

    #[test]
    fn channel_header_decoding() {
        let header = NowHeader::decode(&VIRTUAL_CHANNEL_HEADER).unwrap();
        assert!(header.is_short());
        assert_eq!(header.flags(), HEADER_VIRTUAL_CHANNEL_FLAG);
        assert_eq!(header.body_type(), BodyType::VirtualChannel(0x01));
        assert_eq!(header.body_len(), 16);
    }

    #[test]
    fn channel_header_encoding() {
        let header = NowHeader::new_with_virt_channel(0x01, 16);
        assert_eq!([0x10, 0x00, 0x01, 0x81], header.encode().unwrap()[..]);
    }
}