openiwan 0.3.0

An iWAN client and protocol library
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
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
//! Traditional and segment-routing iWAN fragment codecs.

use crate::{Error, Result};
use std::collections::HashMap;
use std::time::{Duration, Instant};

pub const FRAGMENT_PREFIX_LEN: usize = 8;
pub const MAX_FRAGMENT_OFFSET: u16 = 0x1fff;
pub const MAX_FRAGMENT_LENGTH: u16 = 0x07ff;
pub const MAX_REASSEMBLED_PACKET: usize = 8192;

const TRADITIONAL_TIMEOUT: Duration = Duration::from_millis(100);
const TRADITIONAL_MAX_GROUPS: usize = 256;
const SR_TIMEOUT: Duration = Duration::from_secs(2);
const SR_MAX_GROUPS: usize = 16;
const SR_MAX_BUFFERED_BYTES: usize = 262_144;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Fragment {
    pub id: u32,
    pub end_of_packet: bool,
    pub from_in: bool,
    pub offset: u16,
    pub data: Vec<u8>,
}

impl Fragment {
    pub fn parse_traditional(input: &[u8]) -> Result<Self> {
        Self::parse(input, FragmentIdEndian::Big)
    }

    pub fn parse_sr(input: &[u8]) -> Result<Self> {
        Self::parse(input, FragmentIdEndian::Little)
    }

    fn parse(input: &[u8], id_endian: FragmentIdEndian) -> Result<Self> {
        if input.len() < FRAGMENT_PREFIX_LEN {
            return Err(Error::InvalidFragment("fewer than eight prefix bytes"));
        }
        let id_bytes = input[0..4].try_into().expect("length checked");
        let id = match id_endian {
            FragmentIdEndian::Big => u32::from_be_bytes(id_bytes),
            FragmentIdEndian::Little => u32::from_le_bytes(id_bytes),
        };
        let packed = u32::from_le_bytes(input[4..8].try_into().expect("length checked"));
        if packed & 0xfc00_0000 != 0 {
            return Err(Error::InvalidFragment("reserved bits are non-zero"));
        }
        let end_of_packet = packed & 1 != 0;
        let from_in = packed & 2 != 0;
        let offset = ((packed >> 2) & u32::from(MAX_FRAGMENT_OFFSET)) as u16;
        let length = ((packed >> 15) & u32::from(MAX_FRAGMENT_LENGTH)) as usize;
        if length == 0 {
            return Err(Error::InvalidFragment("zero payload length"));
        }
        if input.len() - FRAGMENT_PREFIX_LEN < length {
            return Err(Error::InvalidFragment(
                "declared payload length exceeds datagram",
            ));
        }
        let fragment = Self {
            id,
            end_of_packet,
            from_in,
            offset,
            data: input[FRAGMENT_PREFIX_LEN..FRAGMENT_PREFIX_LEN + length].to_vec(),
        };
        if fragment.end_offset()? > MAX_REASSEMBLED_PACKET {
            return Err(Error::FragmentTooLarge);
        }
        Ok(fragment)
    }

    pub fn encode_traditional(&self) -> Result<Vec<u8>> {
        self.encode(FragmentIdEndian::Big)
    }

    pub fn encode_sr(&self) -> Result<Vec<u8>> {
        self.encode(FragmentIdEndian::Little)
    }

    fn encode(&self, id_endian: FragmentIdEndian) -> Result<Vec<u8>> {
        if self.offset > MAX_FRAGMENT_OFFSET {
            return Err(Error::InvalidFragment("offset exceeds 13-bit field"));
        }
        let length = u16::try_from(self.data.len())
            .map_err(|_| Error::InvalidFragment("payload exceeds 11-bit length field"))?;
        if length == 0 || length > MAX_FRAGMENT_LENGTH {
            return Err(Error::InvalidFragment("payload length is outside 1..=2047"));
        }
        if self.end_offset()? > MAX_REASSEMBLED_PACKET {
            return Err(Error::FragmentTooLarge);
        }
        let mut packed = u32::from(self.offset) << 2;
        packed |= u32::from(length) << 15;
        packed |= u32::from(self.end_of_packet);
        packed |= u32::from(self.from_in) << 1;

        let mut output = Vec::with_capacity(FRAGMENT_PREFIX_LEN + self.data.len());
        let id_bytes = match id_endian {
            FragmentIdEndian::Big => self.id.to_be_bytes(),
            FragmentIdEndian::Little => self.id.to_le_bytes(),
        };
        output.extend_from_slice(&id_bytes);
        output.extend_from_slice(&packed.to_le_bytes());
        output.extend_from_slice(&self.data);
        Ok(output)
    }

    pub fn end_offset(&self) -> Result<usize> {
        usize::from(self.offset)
            .checked_add(self.data.len())
            .ok_or(Error::FragmentTooLarge)
    }
}

#[derive(Debug, Clone, Copy)]
enum FragmentIdEndian {
    Big,
    Little,
}

#[derive(Debug)]
struct TraditionalPending {
    created: Instant,
    fragment: Fragment,
}

/// Traditional two-fragment reassembly, ordered by EOP, with a 100 ms
/// matching window.
#[derive(Debug, Default)]
pub struct TraditionalFragmentReassembler {
    groups: HashMap<(u8, u32), TraditionalPending>,
}

impl TraditionalFragmentReassembler {
    pub fn clear(&mut self) {
        self.groups.clear();
    }

    pub fn pending_groups(&self) -> usize {
        self.groups.len()
    }

    pub fn purge_expired(&mut self, now: Instant) {
        self.groups.retain(|_, pending| {
            now.checked_duration_since(pending.created)
                .is_none_or(|age| age <= TRADITIONAL_TIMEOUT)
        });
    }

    pub fn insert(&mut self, fragment: Fragment, now: Instant) -> Result<Option<Vec<u8>>> {
        self.insert_in_context(0, fragment, now)
    }

    pub(crate) fn insert_in_context(
        &mut self,
        context: u8,
        fragment: Fragment,
        now: Instant,
    ) -> Result<Option<Vec<u8>>> {
        self.purge_expired(now);
        if fragment.data.len() > MAX_REASSEMBLED_PACKET {
            return Err(Error::FragmentTooLarge);
        }

        let key = (context, fragment.id);
        if let Some(first) = self.groups.remove(&key) {
            if first.fragment.end_of_packet == fragment.end_of_packet {
                self.groups.insert(
                    key,
                    TraditionalPending {
                        created: now,
                        fragment,
                    },
                );
                return Ok(None);
            }
            let (prefix, suffix) = if first.fragment.end_of_packet {
                (&fragment, &first.fragment)
            } else {
                (&first.fragment, &fragment)
            };
            let total = prefix
                .data
                .len()
                .checked_add(suffix.data.len())
                .ok_or(Error::FragmentTooLarge)?;
            if total > MAX_REASSEMBLED_PACKET {
                return Err(Error::FragmentTooLarge);
            }
            let mut packet = Vec::with_capacity(total);
            packet.extend_from_slice(&prefix.data);
            packet.extend_from_slice(&suffix.data);
            return Ok(Some(packet));
        }

        if self.groups.len() >= TRADITIONAL_MAX_GROUPS
            && let Some(oldest) = self
                .groups
                .iter()
                .min_by_key(|(_, pending)| pending.created)
                .map(|(key, _)| *key)
        {
            self.groups.remove(&oldest);
        }
        self.groups.insert(
            key,
            TraditionalPending {
                created: now,
                fragment,
            },
        );
        Ok(None)
    }
}

#[derive(Debug)]
struct SrFragmentGroup {
    created: Instant,
    parts: Vec<Fragment>,
    buffered_bytes: usize,
}

/// Offset-aware bounded SR fragment reassembler.
#[derive(Debug, Default)]
pub struct SrFragmentReassembler {
    groups: HashMap<u32, SrFragmentGroup>,
    buffered_bytes: usize,
}

impl SrFragmentReassembler {
    pub fn clear(&mut self) {
        self.groups.clear();
        self.buffered_bytes = 0;
    }

    pub fn pending_groups(&self) -> usize {
        self.groups.len()
    }

    pub fn buffered_bytes(&self) -> usize {
        self.buffered_bytes
    }

    pub fn purge_expired(&mut self, now: Instant) {
        let expired: Vec<u32> = self
            .groups
            .iter()
            .filter_map(|(id, group)| {
                now.checked_duration_since(group.created)
                    .is_some_and(|age| age > SR_TIMEOUT)
                    .then_some(*id)
            })
            .collect();
        for id in expired {
            self.remove_group(id);
        }
    }

    pub fn insert(&mut self, fragment: Fragment, now: Instant) -> Result<Option<Vec<u8>>> {
        self.purge_expired(now);
        if fragment.end_offset()? > MAX_REASSEMBLED_PACKET {
            return Err(Error::FragmentTooLarge);
        }
        if let Some(group) = self.groups.get(&fragment.id)
            && group
                .parts
                .iter()
                .any(|part| part.offset == fragment.offset)
        {
            return Ok(None);
        }

        if !self.groups.contains_key(&fragment.id) && self.groups.len() >= SR_MAX_GROUPS {
            return Err(Error::FragmentTooLarge);
        }
        if self.buffered_bytes + fragment.data.len() > SR_MAX_BUFFERED_BYTES {
            return Err(Error::FragmentTooLarge);
        }

        let id = fragment.id;
        let new_start = usize::from(fragment.offset);
        let new_end = fragment.end_offset()?;
        let group = self.groups.entry(id).or_insert_with(|| SrFragmentGroup {
            created: now,
            parts: Vec::new(),
            buffered_bytes: 0,
        });
        if group.parts.iter().any(|part| {
            let start = usize::from(part.offset);
            let end = start + part.data.len();
            new_start < end && start < new_end
        }) {
            self.remove_group(id);
            return Err(Error::InvalidFragment("overlapping fragment offsets"));
        }

        self.buffered_bytes += fragment.data.len();
        group.buffered_bytes += fragment.data.len();
        group.parts.push(fragment);
        group.parts.sort_unstable_by_key(|part| part.offset);

        let mut expected_offset = 0_usize;
        let mut total_length = None;
        for part in &group.parts {
            if usize::from(part.offset) != expected_offset {
                return Ok(None);
            }
            expected_offset = part.end_offset()?;
            if part.end_of_packet {
                total_length = Some(expected_offset);
                break;
            }
        }
        let Some(total_length) = total_length else {
            return Ok(None);
        };
        if group
            .parts
            .iter()
            .any(|part| usize::from(part.offset) >= total_length)
        {
            self.remove_group(id);
            return Err(Error::InvalidFragment("data follows the EOP fragment"));
        }

        let group = self.groups.remove(&id).expect("group exists");
        self.buffered_bytes -= group.buffered_bytes;
        let mut packet = Vec::with_capacity(total_length);
        for part in group.parts {
            if packet.len() == total_length {
                break;
            }
            packet.extend_from_slice(&part.data);
        }
        if packet.len() != total_length {
            return Err(Error::InvalidFragment("fragment coverage changed"));
        }
        Ok(Some(packet))
    }

    fn remove_group(&mut self, id: u32) {
        if let Some(group) = self.groups.remove(&id) {
            self.buffered_bytes -= group.buffered_bytes;
        }
    }
}

/// Split an SR payload into the protocol-defined pair of fragments.
pub fn fragment_sr_packet(packet: &[u8], payload_mtu: usize, id: u32) -> Result<[Fragment; 2]> {
    if payload_mtu == 0
        || payload_mtu > usize::from(MAX_FRAGMENT_LENGTH)
        || packet.len() <= payload_mtu
        || packet.len() > payload_mtu.saturating_mul(2)
        || packet.len() > MAX_REASSEMBLED_PACKET
    {
        return Err(Error::FragmentTooLarge);
    }
    let second_offset = u16::try_from(payload_mtu).map_err(|_| Error::FragmentTooLarge)?;
    Ok([
        Fragment {
            id,
            end_of_packet: false,
            from_in: false,
            offset: 0,
            data: packet[..payload_mtu].to_vec(),
        },
        Fragment {
            id,
            end_of_packet: true,
            from_in: false,
            offset: second_offset,
            data: packet[payload_mtu..].to_vec(),
        },
    ])
}

/// Remove AES zero padding by trusting the inner IP length field.
pub fn trim_ip_packet(packet: &[u8]) -> Result<&[u8]> {
    let Some(version) = packet.first().map(|byte| byte >> 4) else {
        return Err(Error::InvalidFragment("empty inner IP packet"));
    };
    let expected = match version {
        4 => {
            if packet.len() < 20 {
                return Err(Error::InvalidFragment("truncated IPv4 header"));
            }
            let header_length = usize::from(packet[0] & 0x0f) * 4;
            if header_length < 20 {
                return Err(Error::InvalidFragment("invalid IPv4 header length"));
            }
            let total_length = usize::from(u16::from_be_bytes([packet[2], packet[3]]));
            if total_length < header_length {
                return Err(Error::InvalidFragment(
                    "IPv4 total length is shorter than its header",
                ));
            }
            total_length
        }
        6 => {
            if packet.len() < 40 {
                return Err(Error::InvalidFragment("truncated IPv6 header"));
            }
            40 + usize::from(u16::from_be_bytes([packet[4], packet[5]]))
        }
        _ => return Err(Error::InvalidFragment("unknown inner IP version")),
    };
    if expected == 0 || expected > packet.len() {
        return Err(Error::InvalidFragment(
            "inner IP length exceeds decrypted payload",
        ));
    }
    Ok(&packet[..expected])
}

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

    fn fragment(id: u32, offset: u16, end: bool, data: &[u8]) -> Fragment {
        Fragment {
            id,
            end_of_packet: end,
            from_in: false,
            offset,
            data: data.to_vec(),
        }
    }

    #[test]
    fn fragment_words_match_specification_vectors() {
        let first = fragment(1, 0, false, &vec![0_u8; 1400]);
        assert_eq!(&first.encode_sr().unwrap()[4..8], &[0x00, 0x00, 0xbc, 0x02]);
        let second = fragment(1, 1400, true, &vec![0_u8; 600]);
        assert_eq!(
            &second.encode_sr().unwrap()[4..8],
            &[0xe1, 0x15, 0x2c, 0x01]
        );
    }

    #[test]
    fn traditional_and_sr_fragment_ids_have_different_endianness() {
        let value = fragment(0x0102_0304, 0, true, b"x");
        assert_eq!(&value.encode_traditional().unwrap()[..4], &[1, 2, 3, 4]);
        assert_eq!(&value.encode_sr().unwrap()[..4], &[4, 3, 2, 1]);
    }

    #[test]
    fn from_in_is_parsed_not_rejected() {
        let mut encoded = fragment(1, 0, true, b"x").encode_traditional().unwrap();
        encoded[4] |= 2;
        assert!(Fragment::parse_traditional(&encoded).unwrap().from_in);
    }

    #[test]
    fn traditional_reassembly_ignores_offsets_and_uses_eop_order() {
        let now = Instant::now();
        let mut queue = TraditionalFragmentReassembler::default();
        assert!(
            queue
                .insert(fragment(1, 999, true, b"tail"), now)
                .unwrap()
                .is_none()
        );
        assert_eq!(
            queue
                .insert(fragment(1, 444, false, b"head"), now)
                .unwrap()
                .unwrap(),
            b"headtail"
        );
    }

    #[test]
    fn traditional_group_limit_is_shared_across_contexts() {
        let now = Instant::now();
        let mut queue = TraditionalFragmentReassembler::default();
        for id in 0..TRADITIONAL_MAX_GROUPS as u32 {
            queue
                .insert_in_context((id % 2) as u8, fragment(id, 0, false, b"x"), now)
                .unwrap();
        }
        queue
            .insert_in_context(2, fragment(u32::MAX, 0, false, b"x"), now)
            .unwrap();
        assert_eq!(queue.pending_groups(), TRADITIONAL_MAX_GROUPS);
    }

    #[test]
    fn sr_reassembly_is_offset_aware_and_out_of_order() {
        let now = Instant::now();
        let mut queue = SrFragmentReassembler::default();
        queue.insert(fragment(1, 5, true, b" world"), now).unwrap();
        assert_eq!(
            queue
                .insert(fragment(1, 0, false, b"hello"), now)
                .unwrap()
                .unwrap(),
            b"hello world"
        );
        assert_eq!(queue.buffered_bytes(), 0);
    }

    #[test]
    fn sr_fragmenter_emits_exactly_two_parts() {
        let packet = vec![7_u8; 2000];
        let fragments = fragment_sr_packet(&packet, 1400, 9).unwrap();
        assert_eq!(fragments[0].data.len(), 1400);
        assert_eq!(fragments[1].offset, 1400);
        assert_eq!(fragments[1].data.len(), 600);
        assert!(fragments[1].end_of_packet);
    }

    #[test]
    fn trim_ip_packet_rejects_short_ipv4_total_length_and_ihl() {
        let mut packet = vec![0_u8; 20];
        packet[0] = 0x45;
        packet[2..4].copy_from_slice(&1_u16.to_be_bytes());
        assert!(matches!(
            trim_ip_packet(&packet),
            Err(Error::InvalidFragment(
                "IPv4 total length is shorter than its header"
            ))
        ));

        packet[0] = 0x44;
        packet[2..4].copy_from_slice(&20_u16.to_be_bytes());
        assert!(matches!(
            trim_ip_packet(&packet),
            Err(Error::InvalidFragment("invalid IPv4 header length"))
        ));
    }
}