aria2-protocol 0.3.7

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
use bytes::BytesMut;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpStream;
use tracing::{debug, info};

use super::state::PeerState;
use crate::bittorrent::extension::mse_crypto::MseCryptoState;
use crate::bittorrent::message::handshake::Handshake;
use crate::bittorrent::message::types::{BtMessage, PieceBlockRequest};

#[derive(Debug, Clone, PartialEq)]
pub struct PeerAddr {
    pub ip: String,
    pub port: u16,
}

impl PeerAddr {
    pub fn new(ip: &str, port: u16) -> Self {
        Self {
            ip: ip.to_string(),
            port,
        }
    }

    /// Compact peer format sizes for IPv4 and IPv6.
    pub const COMPACT_SIZE_V4: usize = 6;
    pub const COMPACT_SIZE_V6: usize = 18;

    /// Decode from IPv4 compact format (4-byte IP + 2-byte port = 6 bytes).
    pub fn from_compact(data: &[u8]) -> Option<Self> {
        if data.len() < Self::COMPACT_SIZE_V4 {
            return None;
        }
        let ip = format!("{}.{}.{}.{}", data[0], data[1], data[2], data[3]);
        let port = u16::from_be_bytes([data[4], data[5]]);
        Some(Self { ip, port })
    }

    /// Decode from IPv6 compact format (16-byte IP + 2-byte port = 18 bytes).
    pub fn from_compact_v6(data: &[u8]) -> Option<Self> {
        if data.len() < Self::COMPACT_SIZE_V6 {
            return None;
        }
        let ip_bytes: [u8; 16] = data[..16].try_into().ok()?;
        let ipv6 = std::net::Ipv6Addr::from(ip_bytes);
        let port = u16::from_be_bytes([data[16], data[17]]);
        Some(Self {
            ip: ipv6.to_string(),
            port,
        })
    }

    pub fn to_socket_addr(&self) -> Result<std::net::SocketAddr, std::net::AddrParseError> {
        self.ip
            .parse()
            .map(|ip| std::net::SocketAddr::new(ip, self.port))
    }

    /// Encode to IPv4 compact format (4-byte IP + 2-byte port = 6 bytes).
    pub fn to_compact(&self) -> [u8; 6] {
        let mut buf = [0u8; 6];
        if let Ok(addr) = self.ip.parse::<std::net::Ipv4Addr>() {
            buf[..4].copy_from_slice(&addr.octets());
            buf[4..6].copy_from_slice(&self.port.to_be_bytes());
        }
        buf
    }

    /// Encode to IPv6 compact format (16-byte IP + 2-byte port = 18 bytes).
    pub fn to_compact_v6(&self) -> Option<[u8; 18]> {
        let addr = self.ip.parse::<std::net::Ipv6Addr>().ok()?;
        let mut buf = [0u8; 18];
        buf[..16].copy_from_slice(&addr.octets());
        buf[16..18].copy_from_slice(&self.port.to_be_bytes());
        Some(buf)
    }
}

pub struct PeerConnection {
    stream: TcpStream,
    write_timeout: Option<std::time::Duration>,
    write_failed: bool,
    remote_addr: Option<std::net::SocketAddr>,
    state: PeerState,
    remote_peer_id: Option<[u8; 20]>,
    /// Whether the remote BitTorrent handshake advertised BEP 5 DHT support.
    remote_supports_dht: bool,
    /// Whether the remote BitTorrent handshake advertised BEP 6 support.
    remote_supports_fast_extension: bool,
    /// Whether the remote BitTorrent handshake advertised BEP 10 support.
    remote_supports_extended_messaging: bool,
    /// MSE is negotiated at connection setup; `None` means plaintext TCP.
    crypto: Option<MseCryptoState>,
    /// Encrypted bytes read past the MSE handshake, awaiting message decoding.
    read_ahead: Vec<u8>,
    // Keep partially received frames across cancellation of read_message.
    read_buffer: BytesMut,
}

impl PeerConnection {
    /// Complete a peer connection over a TCP stream selected by the caller.
    pub async fn connect_with_stream(
        mut stream: TcpStream,
        socket_addr: std::net::SocketAddr,
        info_hash_v1: &[u8; 20],
        info_hash_v2: Option<&[u8; 32]>,
        local_peer_id: &[u8; 20],
        timeout: std::time::Duration,
        dht_enabled: bool,
    ) -> Result<Self, String> {
        debug!("Connecting to peer over selected stream: {}", socket_addr);

        let mut handshake = Handshake::new(info_hash_v1, local_peer_id).with_dht(dht_enabled);
        handshake.set_bep52_enabled(info_hash_v2.is_some());
        stream
            .write_all(&handshake.to_bytes())
            .await
            .map_err(|e| format!("Failed to send handshake: {}", e))?;

        let remote_hs = match info_hash_v2 {
            Some(info_hash_v2) => {
                Self::read_remote_handshake_hybrid(&mut stream, info_hash_v1, info_hash_v2, timeout)
                    .await?
            }
            None => Self::read_remote_handshake(&mut stream, info_hash_v1, timeout).await?,
        };
        Self::finish_handshake(stream, remote_hs)
    }

    async fn read_remote_handshake(
        stream: &mut tokio::net::TcpStream,
        info_hash: &[u8; 20],
        timeout: std::time::Duration,
    ) -> Result<Handshake, String> {
        let mut response = [0u8; 68];
        match tokio::time::timeout(timeout, stream.read_exact(&mut response)).await {
            Ok(Ok(_)) => {}
            Ok(Err(e)) => return Err(format!("Failed to read handshake response: {}", e)),
            Err(_) => return Err("Handshake response timeout".to_string()),
        }

        let remote_hs = Handshake::parse(&response)?;
        if remote_hs.info_hash != *info_hash {
            return Err("info_hash mismatch".to_string());
        }
        Ok(remote_hs)
    }

    async fn read_remote_handshake_hybrid(
        stream: &mut tokio::net::TcpStream,
        info_hash_v1: &[u8; 20],
        info_hash_v2: &[u8; 32],
        timeout: std::time::Duration,
    ) -> Result<Handshake, String> {
        let mut response = [0u8; 68];
        tokio::time::timeout(timeout, stream.read_exact(&mut response))
            .await
            .map_err(|_| "Handshake response timeout".to_string())?
            .map_err(|e| format!("Failed to read handshake response: {}", e))?;

        let remote_hs = Handshake::parse(&response)?;
        let v2_truncated: [u8; 20] = info_hash_v2[..20]
            .try_into()
            .expect("SHA-256 hash is 32 bytes");
        if remote_hs.info_hash == *info_hash_v1 {
            return Ok(remote_hs);
        }
        if remote_hs.info_hash == v2_truncated && remote_hs.supports_bep52() {
            return Ok(remote_hs);
        }
        Err("hybrid handshake info_hash mismatch or missing BEP 52 capability".to_string())
    }

    fn finish_handshake(
        stream: tokio::net::TcpStream,
        remote_hs: Handshake,
    ) -> Result<Self, String> {
        info!(
            "Peer handshake successful: peer_id={}",
            remote_hs.peer_id_str()
        );
        let remote_addr = stream.peer_addr().ok();
        Ok(Self {
            stream,
            write_timeout: None,
            write_failed: false,
            remote_addr,
            state: PeerState::new(),
            remote_peer_id: Some(remote_hs.peer_id),
            remote_supports_dht: remote_hs.supports_dht(),
            remote_supports_fast_extension: remote_hs.supports_fast_extension(),
            remote_supports_extended_messaging: remote_hs.supports_extended_messaging(),
            crypto: None,
            read_ahead: Vec::new(),
            read_buffer: BytesMut::new(),
        })
    }

    /// Wrap a stream after an external handshake has already captured the
    /// remote BEP 5 capability.
    pub fn from_stream_with_peer(
        stream: tokio::net::TcpStream,
        peer_id: [u8; 20],
        remote_supports_dht: bool,
        remote_supports_fast_extension: bool,
    ) -> Self {
        Self::from_stream_with_peer_capabilities(
            stream,
            peer_id,
            remote_supports_dht,
            remote_supports_fast_extension,
            false,
        )
    }

    /// Wrap a stream after an external handshake while preserving the remote
    /// peer's advertised protocol capabilities.
    pub fn from_stream_with_peer_capabilities(
        stream: tokio::net::TcpStream,
        peer_id: [u8; 20],
        remote_supports_dht: bool,
        remote_supports_fast_extension: bool,
        remote_supports_extended_messaging: bool,
    ) -> Self {
        let remote_addr = stream.peer_addr().ok();
        Self {
            stream,
            write_timeout: None,
            write_failed: false,
            remote_addr,
            state: PeerState::new(),
            remote_peer_id: Some(peer_id),
            remote_supports_dht,
            remote_supports_fast_extension,
            remote_supports_extended_messaging,
            crypto: None,
            read_ahead: Vec::new(),
            read_buffer: BytesMut::new(),
        }
    }

    pub(crate) fn from_stream_with_mse(
        stream: TcpStream,
        crypto: MseCryptoState,
        read_ahead: Vec<u8>,
        peer_id: [u8; 20],
        remote_supports_dht: bool,
        remote_supports_fast_extension: bool,
        remote_supports_extended_messaging: bool,
    ) -> Self {
        let mut connection = Self::from_stream_with_peer_capabilities(
            stream,
            peer_id,
            remote_supports_dht,
            remote_supports_fast_extension,
            remote_supports_extended_messaging,
        );
        connection.crypto = Some(crypto);
        connection.read_ahead = read_ahead;
        connection
    }

    pub async fn send_message(&mut self, message: &BtMessage) -> Result<(), String> {
        use crate::bittorrent::message::serializer::serialize;
        let data = serialize(message);

        self.send_serialized(&data).await?;
        debug!("Sent message: {:?}", message.message_id());
        Ok(())
    }

    /// Send an already-framed BitTorrent message without serializing it again.
    ///
    /// Small control frames such as HAVE are broadcast to many peers. Keeping
    /// the frame at the caller avoids rebuilding the same nine bytes once per
    /// connection while preserving the connection's write/flush boundary.
    pub async fn send_serialized(&mut self, data: &[u8]) -> Result<(), String> {
        if self.write_failed {
            return Err("Peer socket is unusable after a failed write".to_owned());
        }
        let result = if let Some(crypto) = &mut self.crypto {
            let mut encrypted = data.to_vec();
            crypto.encrypt(&mut encrypted);
            self.write_with_progress_timeout(&encrypted).await
        } else {
            self.write_with_progress_timeout(data).await
        };
        if result.is_err() {
            // A failed write may have emitted only a prefix of a wire frame;
            // never append another frame to that potentially corrupt stream.
            self.write_failed = true;
        }
        result
    }

    /// Bound a period with no socket write progress. Each successful partial
    /// write starts a fresh interval, so slow but advancing peers are not
    /// penalized for the total size of a queued upload.
    async fn write_with_progress_timeout(&mut self, data: &[u8]) -> Result<(), String> {
        let Some(write_timeout) = self.write_timeout else {
            self.stream
                .write_all(data)
                .await
                .map_err(|error| format!("Failed to send message: {error}"))?;
            return self
                .stream
                .flush()
                .await
                .map_err(|error| format!("Failed to flush buffer: {error}"));
        };
        let mut written = 0;
        while written < data.len() {
            let count = tokio::time::timeout(write_timeout, self.stream.write(&data[written..]))
                .await
                .map_err(|_| "Timed out waiting for peer socket write progress".to_owned())?
                .map_err(|error| format!("Failed to send message: {error}"))?;
            if count == 0 {
                return Err("Failed to send message: peer socket closed".to_owned());
            }
            written += count;
        }
        tokio::time::timeout(write_timeout, self.stream.flush())
            .await
            .map_err(|_| "Timed out flushing peer socket".to_owned())?
            .map_err(|error| format!("Failed to flush buffer: {error}"))
    }

    /// Configure the maximum time a peer socket write may make no progress.
    pub fn set_write_timeout(&mut self, timeout: std::time::Duration) {
        self.write_timeout = Some(timeout);
    }

    pub async fn read_message(&mut self) -> Result<Option<BtMessage>, String> {
        if !self.read_ahead.is_empty() {
            let mut pending = std::mem::take(&mut self.read_ahead);
            if let Some(crypto) = &mut self.crypto {
                crypto.decrypt(&mut pending);
            }
            self.read_buffer.extend_from_slice(&pending);
        }

        loop {
            if self.read_buffer.len() >= 4 {
                let msg_len =
                    u32::from_be_bytes(self.read_buffer[..4].try_into().unwrap()) as usize;
                if msg_len > crate::bittorrent::message::MAX_BT_MESSAGE_LENGTH {
                    return Err(format!(
                        "BitTorrent message length {} exceeds maximum {}",
                        msg_len,
                        crate::bittorrent::message::MAX_BT_MESSAGE_LENGTH
                    ));
                }
                let frame_len = 4 + msg_len;
                if self.read_buffer.len() >= frame_len {
                    let frame = self.read_buffer.split_to(frame_len).freeze();
                    if msg_len == 0 {
                        self.state.mark_message_received();
                        return Ok(Some(BtMessage::KeepAlive));
                    }
                    if let Some(message) =
                        crate::bittorrent::message::factory::parse_message_bytes(frame)?
                    {
                        self.state.mark_message_received();
                        return Ok(Some(message));
                    }
                    continue;
                }
            }

            let mut chunk = [0u8; 16 * 1024];
            let bytes_read = self
                .stream
                .read(&mut chunk)
                .await
                .map_err(|e| format!("Failed to read message: {}", e))?;
            if bytes_read == 0 {
                return if self.read_buffer.is_empty() {
                    Ok(None)
                } else {
                    Err("Failed to read message: unexpected eof".to_string())
                };
            }
            if let Some(crypto) = &mut self.crypto {
                crypto.decrypt(&mut chunk[..bytes_read]);
            }
            self.read_buffer.extend_from_slice(&chunk[..bytes_read]);
        }
    }

    pub async fn send_choke(&mut self) -> Result<(), String> {
        self.state.set_am_choking(true);
        self.send_message(&BtMessage::Choke).await
    }

    pub async fn send_unchoke(&mut self) -> Result<(), String> {
        self.state.set_am_choking(false);
        self.send_message(&BtMessage::Unchoke).await
    }

    pub async fn send_interested(&mut self) -> Result<(), String> {
        self.state.set_am_interested(true);
        self.send_message(&BtMessage::Interested).await
    }

    pub async fn send_not_interested(&mut self) -> Result<(), String> {
        self.state.set_am_interested(false);
        self.send_message(&BtMessage::NotInterested).await
    }

    pub async fn send_have(&mut self, piece_index: u32) -> Result<(), String> {
        self.send_message(&BtMessage::Have { piece_index }).await
    }

    pub async fn send_request(&mut self, req: PieceBlockRequest) -> Result<(), String> {
        self.state.add_request(req.clone());
        self.send_message(&BtMessage::Request { request: req })
            .await
    }

    pub async fn send_cancel(&mut self, req: &PieceBlockRequest) -> Result<(), String> {
        self.state.remove_request(req);
        self.send_message(&BtMessage::Cancel {
            request: req.clone(),
        })
        .await
    }

    pub async fn send_bitfield(&mut self, bitfield: Vec<u8>) -> Result<(), String> {
        self.send_message(&BtMessage::Bitfield { data: bitfield })
            .await
    }

    pub fn is_connected(&self) -> bool {
        self.remote_peer_id.is_some()
    }

    pub fn state(&self) -> &PeerState {
        &self.state
    }

    pub fn remote_peer_id(&self) -> Option<&[u8; 20]> {
        self.remote_peer_id.as_ref()
    }

    pub fn remote_addr(&self) -> Option<std::net::SocketAddr> {
        self.remote_addr
    }

    /// Whether the remote handshake advertised BEP 5 DHT support.
    pub fn remote_supports_dht(&self) -> bool {
        self.remote_supports_dht
    }

    /// Whether the remote BitTorrent handshake advertised BEP 6 support.
    pub fn remote_supports_fast_extension(&self) -> bool {
        self.remote_supports_fast_extension
    }

    /// Whether the remote BitTorrent handshake advertised BEP 10 support.
    pub fn remote_supports_extended_messaging(&self) -> bool {
        self.remote_supports_extended_messaging
    }

    pub fn is_mse_negotiated(&self) -> bool {
        self.crypto.is_some()
    }

    pub fn is_encrypted(&self) -> bool {
        self.crypto
            .as_ref()
            .is_some_and(MseCryptoState::is_encrypted)
    }
}

#[cfg(test)]
mod tests;