aria2-protocol 0.3.2

Multi-protocol networking stack for aria2-rust: HTTP/HTTPS client, FTP/SFTP, full BitTorrent (DHT/PEX/MSE), and Metalink V3/V4 parser
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
//! BEP 11 `ut_pex` extension message types for BitTorrent.
//!
//! Implements the wire-format encoding/decoding for `ut_pex` (peer exchange),
//! which lets peers inform each other about other connected peers in compact
//! format, for both IPv4 and IPv6 address families.
//!
//! This type operates on the *payload* portion of a `BtMessage::Extended`,
//! i.e. the bytes **after** the 1-byte `ext_id` field. The compact-peer decode
//! helpers live in the parent `extension` module.

use std::collections::BTreeMap;

use crate::bittorrent::bencode::codec::BencodeValue;

use super::{COMPACT_PEER_V4_SIZE, COMPACT_PEER_V6_SIZE, decode_compact_v4, decode_compact_v6};

/// Compact IPv4 peer representation: 4 bytes IP + 2 bytes port = 6 bytes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CompactPeerV4(pub [u8; 6]);

impl CompactPeerV4 {
    /// Get the IPv4 address bytes.
    pub fn ip(&self) -> &[u8; 4] {
        self.0[..4].try_into().unwrap()
    }

    /// Get the port in host byte order.
    pub fn port(&self) -> u16 {
        u16::from_be_bytes([self.0[4], self.0[5]])
    }
}

/// Compact IPv6 peer representation: 16 bytes IP + 2 bytes port = 18 bytes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CompactPeerV6(pub [u8; 18]);

impl CompactPeerV6 {
    /// Get the IPv6 address bytes.
    pub fn ip(&self) -> &[u8; 16] {
        self.0[..16].try_into().unwrap()
    }

    /// Get the port in host byte order.
    pub fn port(&self) -> u16 {
        u16::from_be_bytes([self.0[16], self.0[17]])
    }
}

/// BEP 11 ut_pex extension message.
///
/// Wire format (bencoded dict):
/// ```text
/// d
///   5:added    <compact IPv4 peer bytes>
///   7:added.f  <IPv4 flag bytes>
///   7:added6   <compact IPv6 peer bytes>
///   9:added6.f <IPv6 flag bytes>
///   7:dropped  <compact IPv4 dropped peer bytes>
///   9:dropped6 <compact IPv6 dropped peer bytes>
/// e
/// ```
///
/// Flag byte bits (BEP 11):
/// - bit 0: peer uses encryption
/// - bit 1: peer is a seeder
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct UtPexMessage {
    /// Newly connected IPv4 peers in compact format (6 bytes each).
    pub added: Vec<CompactPeerV4>,
    /// Flags for each IPv4 added peer (1 byte per peer).
    pub added_f: Vec<u8>,
    /// Newly connected IPv6 peers in compact format (18 bytes each).
    pub added6: Vec<CompactPeerV6>,
    /// Flags for each IPv6 added peer (1 byte per peer).
    pub added6_f: Vec<u8>,
    /// Disconnected IPv4 peers in compact format (6 bytes each).
    pub dropped: Vec<CompactPeerV4>,
    /// Disconnected IPv6 peers in compact format (18 bytes each).
    pub dropped6: Vec<CompactPeerV6>,
}

impl UtPexMessage {
    /// Create an empty PEX message.
    pub fn new() -> Self {
        Self {
            added: Vec::new(),
            added_f: Vec::new(),
            added6: Vec::new(),
            added6_f: Vec::new(),
            dropped: Vec::new(),
            dropped6: Vec::new(),
        }
    }

    /// Encode this message to the payload bytes (after the ext_id byte).
    ///
    /// Mirrors C++ `UTPexExtensionMessage::getPayload()` which separates
    /// IPv4 and IPv6 peers into distinct keys per BEP 11.
    pub fn to_payload(&self) -> Vec<u8> {
        let mut dict = BTreeMap::new();

        // IPv4 added peers + flags
        if !self.added.is_empty() {
            let mut compact = Vec::with_capacity(self.added.len() * COMPACT_PEER_V4_SIZE);
            for peer in &self.added {
                compact.extend_from_slice(&peer.0);
            }
            dict.insert(b"added".to_vec(), BencodeValue::Bytes(compact));

            if !self.added_f.is_empty() {
                dict.insert(
                    b"added.f".to_vec(),
                    BencodeValue::Bytes(self.added_f.clone()),
                );
            }
        }

        // IPv6 added peers + flags
        if !self.added6.is_empty() {
            let mut compact = Vec::with_capacity(self.added6.len() * COMPACT_PEER_V6_SIZE);
            for peer in &self.added6 {
                compact.extend_from_slice(&peer.0);
            }
            dict.insert(b"added6".to_vec(), BencodeValue::Bytes(compact));

            if !self.added6_f.is_empty() {
                dict.insert(
                    b"added6.f".to_vec(),
                    BencodeValue::Bytes(self.added6_f.clone()),
                );
            }
        }

        // IPv4 dropped peers
        if !self.dropped.is_empty() {
            let mut compact = Vec::with_capacity(self.dropped.len() * COMPACT_PEER_V4_SIZE);
            for peer in &self.dropped {
                compact.extend_from_slice(&peer.0);
            }
            dict.insert(b"dropped".to_vec(), BencodeValue::Bytes(compact));
        }

        // IPv6 dropped peers
        if !self.dropped6.is_empty() {
            let mut compact = Vec::with_capacity(self.dropped6.len() * COMPACT_PEER_V6_SIZE);
            for peer in &self.dropped6 {
                compact.extend_from_slice(&peer.0);
            }
            dict.insert(b"dropped6".to_vec(), BencodeValue::Bytes(compact));
        }

        BencodeValue::Dict(dict).encode()
    }

    /// Parse a ut_pex payload (the bytes after the ext_id byte).
    ///
    /// Mirrors C++ `UTPexExtensionMessage::create()` which extracts
    /// added/dropped for both IPv4 and IPv6 address families.
    pub fn from_payload(payload: &[u8]) -> Result<Self, String> {
        let (val, _) = BencodeValue::decode(payload)
            .map_err(|e| format!("Failed to decode ut_pex payload: {}", e))?;

        let dict = val
            .as_dict()
            .ok_or("ut_pex payload is not a bencoded dict")?;

        let added = if let Some(bytes) = dict.get(b"added".as_slice()).and_then(|v| v.as_bytes()) {
            decode_compact_v4(bytes)?
        } else {
            Vec::new()
        };

        let added_f = dict
            .get(b"added.f".as_slice())
            .and_then(|v| v.as_bytes())
            .map(|b| b.to_vec())
            .unwrap_or_default();

        let added6 = if let Some(bytes) = dict.get(b"added6".as_slice()).and_then(|v| v.as_bytes())
        {
            decode_compact_v6(bytes)?
        } else {
            Vec::new()
        };

        let added6_f = dict
            .get(b"added6.f".as_slice())
            .and_then(|v| v.as_bytes())
            .map(|b| b.to_vec())
            .unwrap_or_default();

        let dropped =
            if let Some(bytes) = dict.get(b"dropped".as_slice()).and_then(|v| v.as_bytes()) {
                decode_compact_v4(bytes)?
            } else {
                Vec::new()
            };

        let dropped6 =
            if let Some(bytes) = dict.get(b"dropped6".as_slice()).and_then(|v| v.as_bytes()) {
                decode_compact_v6(bytes)?
            } else {
                Vec::new()
            };

        Ok(Self {
            added,
            added_f,
            added6,
            added6_f,
            dropped,
            dropped6,
        })
    }
}

impl Default for UtPexMessage {
    fn default() -> Self {
        Self::new()
    }
}

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

    // ======================== UtPexMessage tests ========================

    #[test]
    fn test_pex_empty_message() {
        let msg = UtPexMessage::new();
        assert!(msg.added.is_empty());
        assert!(msg.added6.is_empty());
        assert!(msg.added_f.is_empty());
        assert!(msg.added6_f.is_empty());
        assert!(msg.dropped.is_empty());
        assert!(msg.dropped6.is_empty());

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert!(parsed.added.is_empty());
        assert!(parsed.added6.is_empty());
        assert!(parsed.dropped.is_empty());
        assert!(parsed.dropped6.is_empty());
    }

    #[test]
    fn test_pex_v4_peers_roundtrip() {
        let mut msg = UtPexMessage::new();
        // 192.168.1.1:6881
        let mut peer1 = [0u8; 6];
        peer1[..4].copy_from_slice(&[192, 168, 1, 1]);
        peer1[4..6].copy_from_slice(&6881u16.to_be_bytes());
        msg.added.push(CompactPeerV4(peer1));

        // 10.0.0.1:6882
        let mut peer2 = [0u8; 6];
        peer2[..4].copy_from_slice(&[10, 0, 0, 1]);
        peer2[4..6].copy_from_slice(&6882u16.to_be_bytes());
        msg.added.push(CompactPeerV4(peer2));

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert_eq!(parsed.added.len(), 2);
        assert_eq!(parsed.added[0], CompactPeerV4(peer1));
        assert_eq!(parsed.added[1], CompactPeerV4(peer2));
    }

    #[test]
    fn test_pex_v6_peers_roundtrip() {
        let mut msg = UtPexMessage::new();
        // ::1 port 6881
        let mut peer1 = [0u8; 18];
        peer1[15] = 1; // ::1
        peer1[16..18].copy_from_slice(&6881u16.to_be_bytes());
        msg.added6.push(CompactPeerV6(peer1));

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert_eq!(parsed.added6.len(), 1);
        assert_eq!(parsed.added6[0], CompactPeerV6(peer1));
    }

    #[test]
    fn test_pex_mixed_v4_v6_roundtrip() {
        let mut msg = UtPexMessage::new();

        // v4 peer
        let mut v4 = [0u8; 6];
        v4[..4].copy_from_slice(&[172, 16, 0, 1]);
        v4[4..6].copy_from_slice(&6883u16.to_be_bytes());
        msg.added.push(CompactPeerV4(v4));

        // v6 peer
        let mut v6 = [0u8; 18];
        v6[..16].copy_from_slice(&[0x20, 0x01, 0x0d, 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]);
        v6[16..18].copy_from_slice(&6884u16.to_be_bytes());
        msg.added6.push(CompactPeerV6(v6));

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert_eq!(parsed.added.len(), 1);
        assert_eq!(parsed.added6.len(), 1);
        assert_eq!(parsed.added[0].port(), 6883);
        assert_eq!(parsed.added6[0].port(), 6884);
    }

    #[test]
    fn test_pex_invalid_v4_data_length() {
        // 5 bytes is not a multiple of 6
        let mut dict = BTreeMap::new();
        dict.insert(b"added".to_vec(), BencodeValue::Bytes(vec![1, 2, 3, 4, 5]));
        let payload = BencodeValue::Dict(dict).encode();
        let result = UtPexMessage::from_payload(&payload);
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("IPv4"));
    }

    #[test]
    fn test_pex_invalid_v6_data_length() {
        // 17 bytes is not a multiple of 18
        let mut dict = BTreeMap::new();
        dict.insert(b"added6".to_vec(), BencodeValue::Bytes(vec![0u8; 17]));
        let payload = BencodeValue::Dict(dict).encode();
        let result = UtPexMessage::from_payload(&payload);
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("IPv6"));
    }

    #[test]
    fn test_pex_not_a_dict() {
        // List instead of dict
        let payload = BencodeValue::List(vec![]).encode();
        let result = UtPexMessage::from_payload(&payload);
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("not a bencoded dict"));
    }

    #[test]
    fn test_compact_peer_v4_accessors() {
        let mut bytes = [0u8; 6];
        bytes[..4].copy_from_slice(&[127, 0, 0, 1]);
        bytes[4..6].copy_from_slice(&8080u16.to_be_bytes());
        let peer = CompactPeerV4(bytes);
        assert_eq!(peer.ip(), &[127, 0, 0, 1]);
        assert_eq!(peer.port(), 8080);
    }

    #[test]
    fn test_compact_peer_v6_accessors() {
        let mut bytes = [0u8; 18];
        bytes[15] = 1; // ::1
        bytes[16..18].copy_from_slice(&9999u16.to_be_bytes());
        let peer = CompactPeerV6(bytes);
        assert_eq!(peer.port(), 9999);
        assert_eq!(peer.ip()[15], 1);
    }

    #[test]
    fn test_pex_dropped_v4_roundtrip() {
        let mut msg = UtPexMessage::new();
        let mut peer = [0u8; 6];
        peer[..4].copy_from_slice(&[192, 168, 1, 1]);
        peer[4..6].copy_from_slice(&6881u16.to_be_bytes());
        msg.dropped.push(CompactPeerV4(peer));

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert!(parsed.added.is_empty());
        assert!(parsed.added6.is_empty());
        assert_eq!(parsed.dropped.len(), 1);
        assert_eq!(parsed.dropped[0].port(), 6881);
    }

    #[test]
    fn test_pex_dropped_v6_roundtrip() {
        let mut msg = UtPexMessage::new();
        let mut peer = [0u8; 18];
        peer[15] = 1; // ::1
        peer[16..18].copy_from_slice(&6881u16.to_be_bytes());
        msg.dropped6.push(CompactPeerV6(peer));

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert!(parsed.added.is_empty());
        assert!(parsed.added6.is_empty());
        assert_eq!(parsed.dropped6.len(), 1);
        assert_eq!(parsed.dropped6[0].port(), 6881);
    }

    #[test]
    fn test_pex_added_f_roundtrip() {
        let mut msg = UtPexMessage::new();
        let mut peer1 = [0u8; 6];
        peer1[..4].copy_from_slice(&[10, 0, 0, 1]);
        peer1[4..6].copy_from_slice(&6881u16.to_be_bytes());
        msg.added.push(CompactPeerV4(peer1));

        let mut peer2 = [0u8; 6];
        peer2[..4].copy_from_slice(&[10, 0, 0, 2]);
        peer2[4..6].copy_from_slice(&6882u16.to_be_bytes());
        msg.added.push(CompactPeerV4(peer2));

        // bit 0 = encryption, bit 1 = seeder
        msg.added_f = vec![0x01, 0x03];

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert_eq!(parsed.added_f.len(), 2);
        assert_eq!(parsed.added_f[0], 0x01);
        assert_eq!(parsed.added_f[1], 0x03);
    }

    #[test]
    fn test_pex_added6_f_roundtrip() {
        let mut msg = UtPexMessage::new();
        let mut peer = [0u8; 18];
        peer[..16].copy_from_slice(&[0x20, 0x01, 0x0d, 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]);
        peer[16..18].copy_from_slice(&6881u16.to_be_bytes());
        msg.added6.push(CompactPeerV6(peer));

        msg.added6_f = vec![0x02]; // seeder

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();
        assert_eq!(parsed.added6_f.len(), 1);
        assert_eq!(parsed.added6_f[0], 0x02);
    }

    #[test]
    fn test_pex_full_bep11_roundtrip() {
        let mut msg = UtPexMessage::new();

        // IPv4 added
        let mut v4_added = [0u8; 6];
        v4_added[..4].copy_from_slice(&[192, 168, 1, 1]);
        v4_added[4..6].copy_from_slice(&6881u16.to_be_bytes());
        msg.added.push(CompactPeerV4(v4_added));
        msg.added_f.push(0x02);

        // IPv6 added
        let mut v6_added = [0u8; 18];
        v6_added[15] = 1;
        v6_added[16..18].copy_from_slice(&6882u16.to_be_bytes());
        msg.added6.push(CompactPeerV6(v6_added));
        msg.added6_f.push(0x01);

        // IPv4 dropped
        let mut v4_dropped = [0u8; 6];
        v4_dropped[..4].copy_from_slice(&[10, 0, 0, 1]);
        v4_dropped[4..6].copy_from_slice(&6883u16.to_be_bytes());
        msg.dropped.push(CompactPeerV4(v4_dropped));

        // IPv6 dropped
        let mut v6_dropped = [0u8; 18];
        v6_dropped[15] = 2;
        v6_dropped[16..18].copy_from_slice(&6884u16.to_be_bytes());
        msg.dropped6.push(CompactPeerV6(v6_dropped));

        let payload = msg.to_payload();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();

        assert_eq!(parsed.added.len(), 1);
        assert_eq!(parsed.added_f.len(), 1);
        assert_eq!(parsed.added_f[0], 0x02);
        assert_eq!(parsed.added6.len(), 1);
        assert_eq!(parsed.added6_f.len(), 1);
        assert_eq!(parsed.added6_f[0], 0x01);
        assert_eq!(parsed.dropped.len(), 1);
        assert_eq!(parsed.dropped[0].port(), 6883);
        assert_eq!(parsed.dropped6.len(), 1);
        assert_eq!(parsed.dropped6[0].port(), 6884);
    }

    #[test]
    fn test_pex_parse_dropped6_without_added6() {
        let mut dict = BTreeMap::new();
        let mut v6_dropped = [0u8; 18];
        v6_dropped[15] = 1;
        v6_dropped[16..18].copy_from_slice(&6881u16.to_be_bytes());
        dict.insert(
            b"dropped6".to_vec(),
            BencodeValue::Bytes(v6_dropped.to_vec()),
        );

        let payload = BencodeValue::Dict(dict).encode();
        let parsed = UtPexMessage::from_payload(&payload).unwrap();

        assert!(parsed.added.is_empty());
        assert!(parsed.added6.is_empty());
        assert!(parsed.dropped.is_empty());
        assert_eq!(parsed.dropped6.len(), 1);
    }
}