aria2-protocol 0.2.9

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
use tracing::debug;

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum TrackerEvent {
    Started,
    Completed,
    Stopped,
}

impl TrackerEvent {
    pub fn as_str(&self) -> &'static str {
        match self {
            TrackerEvent::Started => "started",
            TrackerEvent::Completed => "completed",
            TrackerEvent::Stopped => "stopped",
        }
    }
}

#[derive(Debug, Clone)]
pub struct TrackerResponse {
    pub interval: u32,
    pub min_interval: Option<u32>,
    pub seeders: u32,
    pub leechers: u32,
    /// Peers from the "peers" key (compact or dictionary format, typically IPv4).
    pub peers: Vec<PeerInfo>,
    /// IPv6 peers from the "peers6" key (compact format, 18 bytes per peer).
    ///
    /// Matches the C++ `BtAnnounce::PEERS6` key and `extractPeer(peer6Data,
    /// AF_INET6, ...)` call in `DefaultBtAnnounce::processAnnounceResponse`.
    /// The compact format uses 16 bytes for the IPv6 address and 2 bytes for
    /// the port (big-endian), per BEP 7.
    pub peers6: Vec<PeerInfo>,
    /// Tracker ID from the tracker response ("tracker id" key in bencode).
    /// The client must echo this back as the `trackerid` parameter in
    /// subsequent announce requests, per the BitTorrent tracker protocol.
    pub tracker_id: Option<String>,
    pub warning_message: Option<String>,
    pub failure_reason: Option<String>,
}

#[derive(Debug, Clone)]
pub struct PeerInfo {
    pub ip: String,
    pub port: u16,
    pub peer_id: Option<[u8; 20]>,
}

impl TrackerResponse {
    pub fn parse(data: &[u8]) -> Result<Self, String> {
        use crate::bittorrent::bencode::codec::BencodeValue;
        let (root, _) = BencodeValue::decode(data)?;

        let failure_reason = root.dict_get_str("failure reason").map(|s| s.to_string());

        if failure_reason.is_some() && root.dict_get(b"interval").is_none() {
            return Ok(Self {
                interval: 300,
                min_interval: None,
                seeders: 0,
                leechers: 0,
                peers: vec![],
                peers6: vec![],
                tracker_id: None,
                warning_message: None,
                failure_reason,
            });
        }

        let interval = root.dict_get_int("interval").unwrap_or(1800) as u32;
        let min_interval = root.dict_get_int("min interval").map(|n| n as u32);
        let seeders = root.dict_get_int("complete").unwrap_or(0) as u32;
        let leechers = root.dict_get_int("incomplete").unwrap_or(0) as u32;
        let warning_message = root.dict_get_str("warning message").map(|s| s.to_string());
        let tracker_id = root.dict_get_str("tracker id").map(|s| s.to_string());

        let peers = Self::parse_peers(&root)?;

        // Parse IPv6 compact peers ("peers6" key) per BitTorrent tracker
        // protocol extension. The C++ aria2 references this as
        // BtAnnounce::PEERS6 in DefaultBtAnnounce::processAnnounceResponse.
        let peers6 = Self::parse_peers6(&root)?;

        debug!(
            "Tracker response: interval={}s, seeders={}, leechers={}, peers={}, peers6={}, tracker_id={:?}",
            interval,
            seeders,
            leechers,
            peers.len(),
            peers6.len(),
            tracker_id,
        );

        Ok(Self {
            interval,
            min_interval,
            seeders,
            leechers,
            peers,
            peers6,
            tracker_id,
            warning_message,
            failure_reason: None,
        })
    }

    fn parse_peers(
        root: &crate::bittorrent::bencode::codec::BencodeValue,
    ) -> Result<Vec<PeerInfo>, String> {
        match root.dict_get(b"peers") {
            Some(crate::bittorrent::bencode::codec::BencodeValue::Bytes(data)) => {
                Self::parse_compact_peers(data)
            }
            Some(crate::bittorrent::bencode::codec::BencodeValue::List(list)) => {
                Self::parse_normal_peers(list)
            }
            _ => Ok(Vec::new()),
        }
    }

    fn parse_compact_peers(data: &[u8]) -> Result<Vec<PeerInfo>, String> {
        if !data.len().is_multiple_of(6) {
            return Err(format!(
                "Compact peers data length ({}) is not a multiple of 6",
                data.len()
            ));
        }

        let mut peers = Vec::new();
        // Use as_chunks (stable since Rust 1.88) instead of chunks_exact with a
        // constant to satisfy clippy::chunks_exact_with_constant. The length is
        // already verified to be a multiple of 6 above, so the remainder is empty.
        let (chunks, _remainder) = data.as_chunks::<6>();
        for chunk in chunks {
            let ip = format!("{}.{}.{}.{}", chunk[0], chunk[1], chunk[2], chunk[3]);
            let port = u16::from_be_bytes([chunk[4], chunk[5]]);
            peers.push(PeerInfo {
                ip,
                port,
                peer_id: None,
            });
        }
        Ok(peers)
    }

    fn parse_normal_peers(
        list: &[crate::bittorrent::bencode::codec::BencodeValue],
    ) -> Result<Vec<PeerInfo>, String> {
        let mut peers = Vec::new();
        for item in list {
            let dict = item.as_dict().ok_or("Peer entry is not a dictionary")?;
            let ip = dict
                .get(&b"ip"[..])
                .and_then(|v| v.as_str())
                .map(|s| s.to_string())
                .unwrap_or_default();
            let port = dict
                .get(&b"port"[..])
                .and_then(|v| v.as_int())
                .map(|n| n as u16)
                .unwrap_or(0);
            let peer_id = dict
                .get(&b"peer id"[..])
                .and_then(|v| v.as_bytes())
                .filter(|b| b.len() == 20)
                .map(|b| {
                    let mut id = [0u8; 20];
                    id.copy_from_slice(b);
                    id
                });

            if !ip.is_empty() && port > 0 {
                peers.push(PeerInfo { ip, port, peer_id });
            }
        }
        Ok(peers)
    }

    /// Parse the "peers6" key from tracker response (IPv6 compact format).
    /// The compact format is 18 bytes per peer: 16-byte IPv6 address + 2-byte port.
    fn parse_peers6(
        root: &crate::bittorrent::bencode::codec::BencodeValue,
    ) -> Result<Vec<PeerInfo>, String> {
        match root.dict_get(b"peers6") {
            Some(crate::bittorrent::bencode::codec::BencodeValue::Bytes(data)) => {
                Self::parse_compact_peers_v6(data)
            }
            // The "peers6" key only supports compact format per the protocol
            // extension; dictionary/list format is not defined for IPv6.
            _ => Ok(Vec::new()),
        }
    }

    /// Decode compact IPv6 peer data (18 bytes per peer: 16-byte IP + 2-byte port).
    fn parse_compact_peers_v6(data: &[u8]) -> Result<Vec<PeerInfo>, String> {
        use crate::bittorrent::peer::connection::PeerAddr;

        if data.is_empty() {
            return Ok(Vec::new());
        }
        if !data.len().is_multiple_of(PeerAddr::COMPACT_SIZE_V6) {
            return Err(format!(
                "Compact peers6 data length ({}) is not a multiple of {}",
                data.len(),
                PeerAddr::COMPACT_SIZE_V6
            ));
        }

        let count = data.len() / PeerAddr::COMPACT_SIZE_V6;
        let mut peers = Vec::with_capacity(count);
        for i in 0..count {
            let start = i * PeerAddr::COMPACT_SIZE_V6;
            let end = start + PeerAddr::COMPACT_SIZE_V6;
            let addr = PeerAddr::from_compact_v6(&data[start..end])
                .ok_or_else(|| format!("Failed to parse IPv6 peer at index {}", i))?;
            peers.push(PeerInfo {
                ip: addr.ip,
                port: addr.port,
                peer_id: None,
            });
        }
        Ok(peers)
    }

    pub fn is_failure(&self) -> bool {
        self.failure_reason.is_some()
    }

    pub fn peer_count(&self) -> usize {
        self.peers.len() + self.peers6.len()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::bittorrent::bencode::codec::BencodeValue;
    use std::collections::BTreeMap;

    #[test]
    fn test_parse_simple_response() {
        let mut peers_data = vec![0u8; 12];
        peers_data[0..4].copy_from_slice(&[127, 0, 0, 1]);
        peers_data[4..6].copy_from_slice(&6881u16.to_be_bytes());
        peers_data[6..10].copy_from_slice(&[192, 168, 1, 1]);
        peers_data[10..12].copy_from_slice(&6882u16.to_be_bytes());

        let mut resp_dict = BTreeMap::new();
        resp_dict.insert(b"interval".to_vec(), BencodeValue::Int(900));
        resp_dict.insert(b"peers".to_vec(), BencodeValue::Bytes(peers_data));

        let root = BencodeValue::Dict(resp_dict);
        let encoded = root.encode();
        let parsed = TrackerResponse::parse(&encoded).unwrap();

        assert_eq!(parsed.interval, 900);
        assert_eq!(parsed.peers.len(), 2);
        assert_eq!(parsed.peers[0].ip, "127.0.0.1");
        assert_eq!(parsed.peers[0].port, 6881);
    }

    #[test]
    fn test_parse_failure_response() {
        let mut d = BTreeMap::new();
        d.insert(
            b"failure reason".to_vec(),
            BencodeValue::Bytes(b"tracker offline".to_vec()),
        );
        let root = BencodeValue::Dict(d);
        let resp = TrackerResponse::parse(&root.encode()).unwrap();
        assert!(resp.is_failure());
        assert_eq!(resp.failure_reason.as_deref(), Some("tracker offline"));
    }

    #[test]
    fn test_event_as_str() {
        assert_eq!(TrackerEvent::Started.as_str(), "started");
        assert_eq!(TrackerEvent::Completed.as_str(), "completed");
        assert_eq!(TrackerEvent::Stopped.as_str(), "stopped");
    }

    #[test]
    fn test_parse_tracker_id() {
        let mut peers_data = vec![0u8; 6];
        peers_data[0..4].copy_from_slice(&[127, 0, 0, 1]);
        peers_data[4..6].copy_from_slice(&6881u16.to_be_bytes());

        let mut resp_dict = BTreeMap::new();
        resp_dict.insert(b"interval".to_vec(), BencodeValue::Int(300));
        resp_dict.insert(b"peers".to_vec(), BencodeValue::Bytes(peers_data));
        resp_dict.insert(
            b"tracker id".to_vec(),
            BencodeValue::Bytes(b"my-tracker-42".to_vec()),
        );

        let root = BencodeValue::Dict(resp_dict);
        let encoded = root.encode();
        let parsed = TrackerResponse::parse(&encoded).unwrap();

        assert_eq!(parsed.tracker_id.as_deref(), Some("my-tracker-42"));
    }

    #[test]
    fn test_parse_no_tracker_id() {
        let mut peers_data = vec![0u8; 6];
        peers_data[0..4].copy_from_slice(&[127, 0, 0, 1]);
        peers_data[4..6].copy_from_slice(&6881u16.to_be_bytes());

        let mut resp_dict = BTreeMap::new();
        resp_dict.insert(b"interval".to_vec(), BencodeValue::Int(300));
        resp_dict.insert(b"peers".to_vec(), BencodeValue::Bytes(peers_data));

        let root = BencodeValue::Dict(resp_dict);
        let encoded = root.encode();
        let parsed = TrackerResponse::parse(&encoded).unwrap();

        assert!(parsed.tracker_id.is_none());
    }

    #[test]
    fn test_parse_peers6_compact() {
        // Build a tracker response with both "peers" (1 IPv4 peer) and "peers6"
        // (2 IPv6 peers in compact format, 18 bytes each).
        let mut peers_data = vec![0u8; 6];
        peers_data[0..4].copy_from_slice(&[127, 0, 0, 1]);
        peers_data[4..6].copy_from_slice(&6881u16.to_be_bytes());

        // IPv6 peer 1: 2001:db8::1 port 6881
        let mut peers6_data = Vec::with_capacity(36);
        let ipv6_1 = "2001:db8::1".parse::<std::net::Ipv6Addr>().unwrap();
        peers6_data.extend_from_slice(&ipv6_1.octets());
        peers6_data.extend_from_slice(&6881u16.to_be_bytes());

        // IPv6 peer 2: ::1 port 6882
        let ipv6_2 = "::1".parse::<std::net::Ipv6Addr>().unwrap();
        peers6_data.extend_from_slice(&ipv6_2.octets());
        peers6_data.extend_from_slice(&6882u16.to_be_bytes());

        let mut resp_dict = BTreeMap::new();
        resp_dict.insert(b"interval".to_vec(), BencodeValue::Int(300));
        resp_dict.insert(b"peers".to_vec(), BencodeValue::Bytes(peers_data));
        resp_dict.insert(b"peers6".to_vec(), BencodeValue::Bytes(peers6_data));

        let root = BencodeValue::Dict(resp_dict);
        let encoded = root.encode();
        let parsed = TrackerResponse::parse(&encoded).unwrap();

        assert_eq!(parsed.peers.len(), 1);
        assert_eq!(parsed.peers[0].ip, "127.0.0.1");
        assert_eq!(parsed.peers[0].port, 6881);

        assert_eq!(parsed.peers6.len(), 2);
        assert_eq!(parsed.peers6[0].ip, "2001:db8::1");
        assert_eq!(parsed.peers6[0].port, 6881);
        assert_eq!(parsed.peers6[1].ip, "::1");
        assert_eq!(parsed.peers6[1].port, 6882);

        assert_eq!(parsed.peer_count(), 3);
    }

    #[test]
    fn test_parse_peers6_invalid_length() {
        // 17 bytes is not a multiple of 18 -> error
        let peers6_data = vec![0u8; 17];

        let mut resp_dict = BTreeMap::new();
        resp_dict.insert(b"interval".to_vec(), BencodeValue::Int(300));
        resp_dict.insert(b"peers".to_vec(), BencodeValue::Bytes(vec![0u8; 6]));
        resp_dict.insert(b"peers6".to_vec(), BencodeValue::Bytes(peers6_data));

        let root = BencodeValue::Dict(resp_dict);
        let encoded = root.encode();
        let result = TrackerResponse::parse(&encoded);
        assert!(result.is_err());
        assert!(
            result.unwrap_err().contains("not a multiple of 18"),
            "Expected error about peers6 length not being a multiple of 18"
        );
    }

    #[test]
    fn test_parse_peers6_empty() {
        let mut resp_dict = BTreeMap::new();
        resp_dict.insert(b"interval".to_vec(), BencodeValue::Int(300));
        resp_dict.insert(b"peers".to_vec(), BencodeValue::Bytes(vec![0u8; 6]));

        let root = BencodeValue::Dict(resp_dict);
        let encoded = root.encode();
        let parsed = TrackerResponse::parse(&encoded).unwrap();

        assert!(parsed.peers6.is_empty());
        assert_eq!(parsed.peer_count(), 1);
    }

    #[test]
    fn test_parse_failure_response_has_empty_peers6() {
        let mut d = BTreeMap::new();
        d.insert(
            b"failure reason".to_vec(),
            BencodeValue::Bytes(b"tracker offline".to_vec()),
        );
        let root = BencodeValue::Dict(d);
        let resp = TrackerResponse::parse(&root.encode()).unwrap();
        assert!(resp.peers.is_empty());
        assert!(resp.peers6.is_empty());
    }
}