aria2-protocol 0.3.10

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
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
//! JSON and compact-peer wire formats for WebSocket tracker announces.

use std::net::{IpAddr, SocketAddr};
use std::time::Duration;

use base64::Engine;
use futures::{SinkExt, StreamExt};
use serde_json::Value;
use tokio::io::{AsyncRead, AsyncWrite};
use tokio_tungstenite::{
    Connector,
    tungstenite::{Message, client::IntoClientRequest},
};
use url::Url;

use crate::crypto::ensure_ring_provider;

/// Inputs encoded into a WebTorrent-compatible announce JSON message.
pub struct WebSocketAnnounceRequest<'a> {
    /// Torrent v1 info hash sent in the announce.
    pub info_hash: &'a [u8; 20],
    /// Local BitTorrent peer ID.
    pub peer_id: &'a [u8; 20],
    /// Bytes downloaded so far.
    pub downloaded: u64,
    /// Bytes remaining to complete the torrent.
    pub left: u64,
    /// Bytes uploaded so far.
    pub uploaded: u64,
    /// Requested peer count.
    pub numwant: u32,
    /// Local TCP peer port.
    pub port: u16,
    /// Optional tracker event such as `started` or `completed`.
    pub event: Option<&'a str>,
}

/// Parsed WebSocket tracker announce response.
///
/// WebRTC signaling fields such as `peer_id`, `offer`, `offer_id`, and
/// `answer` are intentionally not exposed; this response contains only
/// tracker statistics and peers with TCP socket addresses.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WebSocketAnnounceResponse {
    /// TCP-compatible peers decoded from `peers` and `peers6`.
    pub peers: Vec<SocketAddr>,
    /// Suggested announce interval in seconds.
    pub interval: Option<u64>,
    /// Minimum announce interval in seconds.
    pub min_interval: Option<u64>,
    /// Tracker-reported seed count.
    pub seeders: Option<i64>,
    /// Tracker-reported leecher count.
    pub leechers: Option<i64>,
}

/// Failure while decoding a WebSocket tracker response.
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum WebSocketAnnounceResponseError {
    /// The response was not valid JSON.
    #[error("malformed WebSocket tracker response: {0}")]
    Malformed(String),
    /// The tracker rejected the announce with its `failure reason`.
    #[error("WebSocket tracker rejected announce: {0}")]
    Rejected(String),
}

/// Failure while running a WebSocket tracker announce over an established stream.
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum WebSocketAnnounceError {
    /// The WebSocket URL could not be used to create a handshake request.
    #[error("invalid WebSocket tracker request: {0}")]
    InvalidRequest(String),
    /// A WebSocket operation exceeded its timeout.
    #[error("WebSocket tracker timed out during {0}")]
    Timeout(&'static str),
    /// The tracker rejected the HTTP upgrade with this status.
    #[error("WebSocket tracker rejected handshake with HTTP {0}")]
    HandshakeRejected(u16),
    /// The WebSocket protocol exchange failed.
    #[error("WebSocket tracker protocol error: {0}")]
    Protocol(String),
    /// The WebSocket transport failed.
    #[error("WebSocket tracker transport error: {0}")]
    Transport(String),
    /// The tracker closed the socket before returning an announce response.
    #[error("WebSocket tracker closed without an announce response")]
    Closed,
    /// The announce response was invalid or belonged to another torrent.
    #[error(transparent)]
    Response(#[from] WebSocketAnnounceResponseError),
}

#[derive(Clone, Copy)]
enum CompactPeerFamily {
    V4,
    V6,
}

/// Parse and validate a WebSocket tracker URL before the caller establishes
/// its policy-controlled socket.
///
/// The protocol layer owns the accepted URL schemes and required authority
/// fields. Callers retain DNS, proxy, socket, and outbound-address policy.
pub fn parse_tracker_url(tracker_url: &str) -> Result<Url, WebSocketAnnounceError> {
    let url = Url::parse(tracker_url)
        .map_err(|error| WebSocketAnnounceError::InvalidRequest(error.to_string()))?;
    if !matches!(url.scheme(), "ws" | "wss") {
        return Err(WebSocketAnnounceError::InvalidRequest(format!(
            "unsupported WebSocket tracker scheme '{}'",
            url.scheme()
        )));
    }
    if url.host_str().is_none() {
        return Err(WebSocketAnnounceError::InvalidRequest(
            "WebSocket tracker URL has no host".to_owned(),
        ));
    }
    if url.port_or_known_default().is_none() {
        return Err(WebSocketAnnounceError::InvalidRequest(
            "WebSocket tracker URL has no port".to_owned(),
        ));
    }
    Ok(url)
}

/// Perform a WebSocket tracker announce over a stream established by the caller.
///
/// The caller owns DNS, socket selection, proxying, and outbound-address policy;
/// this function owns the WebSocket handshake, framing, announce exchange, and
/// response validation.
pub async fn announce_over_stream<S>(
    stream: S,
    tracker_url: &str,
    request: &WebSocketAnnounceRequest<'_>,
    timeout: Duration,
) -> Result<WebSocketAnnounceResponse, WebSocketAnnounceError>
where
    S: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    announce_over_stream_with_connector(stream, tracker_url, request, timeout, None).await
}

/// Perform an announce using a caller-supplied TLS connector when the URL is
/// secure. This lets the engine apply its task TLS identity and trust policy
/// while this module retains ownership of WebSocket framing and validation.
pub async fn announce_over_stream_with_connector<S>(
    stream: S,
    tracker_url: &str,
    request: &WebSocketAnnounceRequest<'_>,
    timeout: Duration,
    connector: Option<Connector>,
) -> Result<WebSocketAnnounceResponse, WebSocketAnnounceError>
where
    S: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    ensure_ring_provider();
    let tracker_url = parse_tracker_url(tracker_url)?;
    let ws_request = tracker_url
        .as_str()
        .into_client_request()
        .map_err(|error| WebSocketAnnounceError::InvalidRequest(error.to_string()))?;
    let (mut websocket, _) = tokio::time::timeout(
        timeout,
        tokio_tungstenite::client_async_tls_with_config(ws_request, stream, None, connector),
    )
    .await
    .map_err(|_| WebSocketAnnounceError::Timeout("handshake"))?
    .map_err(classify_websocket_error)?;

    let message = encode_announce_request(request);
    tokio::time::timeout(timeout, websocket.send(Message::Text(message.into())))
        .await
        .map_err(|_| WebSocketAnnounceError::Timeout("sending"))?
        .map_err(classify_websocket_error)?;

    let response = tokio::time::timeout(timeout, async {
        while let Some(message) = websocket.next().await {
            match message {
                Ok(Message::Text(text)) => return Ok(Some(text.to_string())),
                Ok(Message::Binary(bytes)) => {
                    if let Ok(text) = String::from_utf8(bytes.to_vec()) {
                        return Ok(Some(text));
                    }
                }
                Ok(Message::Ping(payload)) => websocket
                    .send(Message::Pong(payload))
                    .await
                    .map_err(classify_websocket_error)?,
                Ok(Message::Close(_)) => return Ok(None),
                Ok(_) => {}
                Err(error) => return Err(classify_websocket_error(error)),
            }
        }
        Ok(None)
    })
    .await
    .map_err(|_| WebSocketAnnounceError::Timeout("receiving"))??
    .ok_or(WebSocketAnnounceError::Closed)?;

    decode_announce_response_for_request(&response, request.info_hash)
        .map_err(WebSocketAnnounceError::Response)
}

fn classify_websocket_error(
    error: tokio_tungstenite::tungstenite::Error,
) -> WebSocketAnnounceError {
    use tokio_tungstenite::tungstenite::Error;

    match error {
        Error::Http(response) => {
            WebSocketAnnounceError::HandshakeRejected(response.status().as_u16())
        }
        Error::Protocol(error) => WebSocketAnnounceError::Protocol(error.to_string()),
        error => WebSocketAnnounceError::Transport(error.to_string()),
    }
}

/// Encode a WebTorrent-compatible JSON announce request.
pub fn encode_announce_request(request: &WebSocketAnnounceRequest<'_>) -> String {
    let mut message = serde_json::json!({
        "action": "announce",
        "info_hash": binary_string(request.info_hash),
        "peer_id": binary_string(request.peer_id),
        "uploaded": request.uploaded,
        "downloaded": request.downloaded,
        "left": request.left,
        "numwant": request.numwant,
        "port": request.port,
        "compact": 1,
    });
    if let Some(event) = request.event.filter(|event| !event.is_empty()) {
        message["event"] = Value::String(event.to_owned());
    }
    message.to_string()
}

/// Decode a WebTorrent-compatible JSON announce response.
///
/// Malformed peer entries are ignored, matching the established tracker
/// behavior. A tracker `failure reason` is returned as `Rejected`.
pub fn decode_announce_response(
    encoded: &str,
) -> Result<WebSocketAnnounceResponse, WebSocketAnnounceResponseError> {
    decode_announce_response_inner(encoded, None)
}

/// Decode an announce response and verify that it belongs to the requested torrent.
pub fn decode_announce_response_for_request(
    encoded: &str,
    expected_info_hash: &[u8; 20],
) -> Result<WebSocketAnnounceResponse, WebSocketAnnounceResponseError> {
    decode_announce_response_inner(encoded, Some(expected_info_hash))
}

fn decode_announce_response_inner(
    encoded: &str,
    expected_info_hash: Option<&[u8; 20]>,
) -> Result<WebSocketAnnounceResponse, WebSocketAnnounceResponseError> {
    let response: Value = serde_json::from_str(encoded)
        .map_err(|error| WebSocketAnnounceResponseError::Malformed(error.to_string()))?;
    let response = response.as_object().ok_or_else(|| {
        WebSocketAnnounceResponseError::Malformed("response must be a JSON object".to_owned())
    })?;
    if response.get("action").and_then(Value::as_str) != Some("announce") {
        return Err(WebSocketAnnounceResponseError::Malformed(
            "response action must be `announce`".to_owned(),
        ));
    }
    if let Some(expected_info_hash) = expected_info_hash {
        let actual_info_hash = response
            .get("info_hash")
            .and_then(Value::as_str)
            .and_then(parse_binary_info_hash)
            .ok_or_else(|| {
                WebSocketAnnounceResponseError::Malformed(
                    "response must contain a 20-byte binary info_hash".to_owned(),
                )
            })?;
        if &actual_info_hash != expected_info_hash {
            return Err(WebSocketAnnounceResponseError::Malformed(
                "response info_hash does not match the announce request".to_owned(),
            ));
        }
    }
    if let Some(reason) = response.get("failure reason").and_then(Value::as_str) {
        return Err(WebSocketAnnounceResponseError::Rejected(reason.to_owned()));
    }

    let mut peers = response
        .get("peers")
        .map(|peers| parse_peers(peers, CompactPeerFamily::V4))
        .unwrap_or_default();
    if let Some(peers6) = response.get("peers6").and_then(Value::as_str) {
        peers.extend(parse_compact_peers(peers6, CompactPeerFamily::V6));
    }
    peers.sort_unstable();
    peers.dedup();

    Ok(WebSocketAnnounceResponse {
        peers,
        interval: response
            .get("interval")
            .and_then(Value::as_u64)
            .filter(|seconds| *seconds > 0),
        min_interval: response
            .get("min interval")
            .and_then(Value::as_u64)
            .filter(|seconds| *seconds > 0),
        seeders: response
            .get("complete")
            .and_then(Value::as_i64)
            .filter(|count| *count >= 0),
        leechers: response
            .get("incomplete")
            .and_then(Value::as_i64)
            .filter(|count| *count >= 0),
    })
}

fn parse_binary_info_hash(value: &str) -> Option<[u8; 20]> {
    let mut bytes = [0; 20];
    let mut chars = value.chars();
    for byte in &mut bytes {
        *byte = u8::try_from(u32::from(chars.next()?)).ok()?;
    }
    chars.next().is_none().then_some(bytes)
}

fn parse_peers(value: &Value, family: CompactPeerFamily) -> Vec<SocketAddr> {
    match value {
        Value::Array(peers) => peers
            .iter()
            .flat_map(|peer| parse_peer(peer, family))
            .collect(),
        Value::String(peers) => parse_peer_string(peers, family),
        _ => Vec::new(),
    }
}

fn parse_peer(value: &Value, family: CompactPeerFamily) -> Vec<SocketAddr> {
    match value {
        Value::Object(peer) => {
            let Some(ip) = peer.get("ip").and_then(Value::as_str) else {
                return Vec::new();
            };
            let Some(port) = peer
                .get("port")
                .and_then(Value::as_u64)
                .and_then(|port| u16::try_from(port).ok())
                .filter(|port| *port > 0)
            else {
                return Vec::new();
            };
            tracker_peer_socket_addr(ip, port).into_iter().collect()
        }
        Value::String(peer) => parse_peer_string(peer, family),
        _ => Vec::new(),
    }
}

fn parse_peer_string(peer: &str, family: CompactPeerFamily) -> Vec<SocketAddr> {
    if let Ok(address) = peer.parse::<SocketAddr>() {
        return (address.port() > 0)
            .then_some(address)
            .into_iter()
            .collect();
    }
    parse_compact_peers(peer, family)
}

fn parse_compact_peers(encoded: &str, family: CompactPeerFamily) -> Vec<SocketAddr> {
    let Ok(bytes) = base64::engine::general_purpose::STANDARD.decode(encoded) else {
        return Vec::new();
    };
    let peers = match family {
        CompactPeerFamily::V4 => crate::bittorrent::peer::address::decode_compact_v4_peers(&bytes),
        CompactPeerFamily::V6 => crate::bittorrent::peer::address::decode_compact_v6_peers(&bytes),
    };
    peers
        .unwrap_or_default()
        .into_iter()
        .filter(|peer| peer.port() > 0)
        .collect()
}

fn tracker_peer_socket_addr(ip: &str, port: u16) -> Option<SocketAddr> {
    ip.parse::<IpAddr>()
        .ok()
        .map(|ip| SocketAddr::new(ip, port))
}

fn binary_string(bytes: &[u8]) -> String {
    bytes.iter().map(|byte| char::from(*byte)).collect()
}

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

    #[test]
    fn parses_only_websocket_tracker_urls_with_an_authority() {
        let url = parse_tracker_url("wss://tracker.example/announce").unwrap();
        assert_eq!(url.scheme(), "wss");
        assert_eq!(url.host_str(), Some("tracker.example"));
        assert_eq!(url.port_or_known_default(), Some(443));

        assert!(parse_tracker_url("https://tracker.example/announce").is_err());
        assert!(parse_tracker_url("ws://").is_err());
    }

    #[test]
    fn encodes_announce_fields_and_omits_empty_event() {
        let encoded = encode_announce_request(&WebSocketAnnounceRequest {
            info_hash: &[0x11; 20],
            peer_id: &[0x22; 20],
            downloaded: 12,
            left: 34,
            uploaded: 56,
            numwant: 7,
            port: 6881,
            event: Some(""),
        });
        let message: Value = serde_json::from_str(&encoded).unwrap();

        assert_eq!(message["action"], "announce");
        assert_eq!(message["downloaded"], 12);
        assert_eq!(message["left"], 34);
        assert_eq!(message["uploaded"], 56);
        assert_eq!(message["numwant"], 7);
        assert_eq!(message["port"], 6881);
        assert!(message.get("event").is_none());
        assert_eq!(message["info_hash"], binary_string(&[0x11; 20]));
        assert_eq!(message["peer_id"], binary_string(&[0x22; 20]));
    }

    #[test]
    fn decodes_ipv4_and_ipv6_compact_peers_by_response_field() {
        let peers_v4 = base64::engine::general_purpose::STANDARD.encode([192, 0, 2, 1, 0x1a, 0xe1]);
        let mut peers_v6 = [0u8; 18];
        peers_v6[..16].copy_from_slice(
            &"2001:db8::1"
                .parse::<std::net::Ipv6Addr>()
                .unwrap()
                .octets(),
        );
        peers_v6[16..].copy_from_slice(&6882u16.to_be_bytes());
        let peers_v6 = base64::engine::general_purpose::STANDARD.encode(peers_v6);
        let encoded = serde_json::json!({
            "action": "announce",
            "peers": peers_v4,
            "peers6": peers_v6
        })
        .to_string();

        let response = decode_announce_response(&encoded).unwrap();
        assert_eq!(response.peers.len(), 2);
        assert!(response.peers.contains(&"192.0.2.1:6881".parse().unwrap()));
        assert!(
            response
                .peers
                .contains(&"[2001:db8::1]:6882".parse().unwrap())
        );
    }

    #[test]
    fn decodes_mixed_object_and_compact_peer_entries() {
        let compact = base64::engine::general_purpose::STANDARD.encode([192, 0, 2, 1, 0x1a, 0xe1]);
        let encoded = serde_json::json!({
            "action": "announce",
            "peers": [
                {"ip": "192.0.2.2", "port": 6882},
                compact,
            ],
            "interval": 120,
            "min interval": 60,
            "complete": 3,
            "incomplete": 4,
        })
        .to_string();

        let response = decode_announce_response(&encoded).unwrap();
        assert_eq!(response.peers.len(), 2);
        assert_eq!(response.interval, Some(120));
        assert_eq!(response.min_interval, Some(60));
        assert_eq!(response.seeders, Some(3));
        assert_eq!(response.leechers, Some(4));
    }

    #[test]
    fn ignores_webrtc_signaling_fields_without_treating_them_as_tcp_peers() {
        let encoded = serde_json::json!({
            "action": "announce",
            "interval": 120,
            "peer_id": binary_string(&[0x22; 20]),
            "offer": {"type": "offer", "sdp": "opaque signaling data"},
            "offer_id": "offer-1",
            "answer": {"type": "answer", "sdp": "opaque signaling data"},
        })
        .to_string();

        let response = decode_announce_response(&encoded).unwrap();

        assert!(response.peers.is_empty());
        assert_eq!(response.interval, Some(120));
    }

    #[test]
    fn ignores_compact_peer_data_with_invalid_lengths() {
        let peers_v4 = base64::engine::general_purpose::STANDARD.encode([1, 2, 3, 4, 5]);
        let peers_v6 = base64::engine::general_purpose::STANDARD.encode([0; 17]);
        let encoded = serde_json::json!({
            "action": "announce",
            "peers": peers_v4,
            "peers6": peers_v6
        })
        .to_string();

        assert!(decode_announce_response(&encoded).unwrap().peers.is_empty());
    }

    #[test]
    fn validates_response_info_hash_against_announce_request() {
        let expected_info_hash = [0x31; 20];
        let encoded = serde_json::json!({
            "action": "announce",
            "info_hash": binary_string(&expected_info_hash),
        })
        .to_string();

        assert!(decode_announce_response_for_request(&encoded, &expected_info_hash).is_ok());
        assert!(matches!(
            decode_announce_response_for_request(&encoded, &[0x32; 20]),
            Err(WebSocketAnnounceResponseError::Malformed(_))
        ));

        let missing_hash = r#"{"action":"announce"}"#;
        assert!(matches!(
            decode_announce_response_for_request(missing_hash, &expected_info_hash),
            Err(WebSocketAnnounceResponseError::Malformed(_))
        ));
    }

    #[test]
    fn reports_malformed_and_rejected_responses() {
        assert!(matches!(
            decode_announce_response("{"),
            Err(WebSocketAnnounceResponseError::Malformed(_))
        ));
        assert!(matches!(
            decode_announce_response("[]"),
            Err(WebSocketAnnounceResponseError::Malformed(_))
        ));
        assert!(matches!(
            decode_announce_response(r#"{"action":"scrape"}"#),
            Err(WebSocketAnnounceResponseError::Malformed(_))
        ));
        let error = decode_announce_response(r#"{"action":"announce","failure reason":"denied"}"#)
            .unwrap_err();
        assert_eq!(
            error,
            WebSocketAnnounceResponseError::Rejected("denied".to_owned())
        );
    }

    #[test]
    fn ignores_zero_ports_and_invalid_tracker_statistics() {
        let compact_v4 = base64::engine::general_purpose::STANDARD
            .encode([192, 0, 2, 1, 0, 0, 192, 0, 2, 2, 0x1a, 0xe1]);
        let encoded = serde_json::json!({
            "action": "announce",
            "peers": [
                {"ip": "192.0.2.3", "port": 0},
                {"ip": "192.0.2.4", "port": 65536},
                "192.0.2.5:0",
                compact_v4,
            ],
            "interval": 0,
            "min interval": 0,
            "complete": -1,
            "incomplete": -2,
        })
        .to_string();

        let response = decode_announce_response(&encoded).unwrap();

        assert_eq!(response.peers, vec!["192.0.2.2:6881".parse().unwrap()]);
        assert_eq!(response.interval, None);
        assert_eq!(response.min_interval, None);
        assert_eq!(response.seeders, None);
        assert_eq!(response.leechers, None);
    }
}