mtorrent-core 0.5.0

Fundamentals for building asynchronous BitTorrent clients
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
use super::{Decryptor, Encryptor};
use bytes::{Buf, BufMut, BytesMut};
use mtorrent_utils::split_stream::SplitStream;
use pin_project_lite::pin_project;
use std::pin::Pin;
use std::task::{Context, Poll, ready};
use std::{cmp, io};
use tokio::io::{AsyncBufRead, AsyncRead, AsyncReadExt, AsyncWrite, Chain, ReadBuf};

pin_project! {
    /// A wrapper around an [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) that decrypts the data read from it using a [`Decryptor`].
    #[derive(Debug)]
    pub struct DecryptingReader<R: AsyncRead> {
        #[pin]
        inner: R,
        crypto: Decryptor,
    }
}

impl<R: AsyncRead> DecryptingReader<R> {
    /// Creates a new `DecryptingReader` that wraps the given [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) and [`Decryptor`].
    pub fn new(inner: R, crypto: Decryptor) -> Self {
        Self { inner, crypto }
    }

    /// Consumes the `DecryptingReader`, returning the wrapped [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) and [`Decryptor`].
    pub fn into_parts(self) -> (R, Decryptor) {
        (self.inner, self.crypto)
    }
}

impl<R: AsyncRead> AsyncRead for DecryptingReader<R> {
    fn poll_read(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        let this = self.project();

        let old_len = buf.filled().len();
        ready!(this.inner.poll_read(cx, buf))?;
        let new_len = buf.filled().len();

        if new_len > old_len {
            this.crypto.decrypt(&mut buf.filled_mut()[old_len..new_len]);
        }
        Poll::Ready(Ok(()))
    }
}

const BUFFER_SIZE: usize = 33 * 1024;

pin_project! {
    /// A buffering reader that wraps an [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) and decrypts the data read from it using a [`Decryptor`].
    ///
    /// Implementation of `DecryptingBufReader` is similar to [`tokio::io::BufReader`](https://docs.rs/tokio/latest/tokio/io/struct.BufReader.html), slightly
    /// simplified thanks to [`BytesMut`](https://docs.rs/bytes/latest/bytes/struct.BytesMut.html), and with added calls to `Decryptor::decrypt()`.
    #[derive(Debug)]
    pub struct DecryptingBufReader<R: AsyncRead> {
        #[pin]
        inner: R,
        crypto: Decryptor,
        buffer: BytesMut,
    }
}

impl<R: AsyncRead> DecryptingBufReader<R> {
    /// Creates a new `DecryptingBufReader` that wraps the given [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) and [`Decryptor`].
    pub fn new(inner: R, crypto: Decryptor) -> Self {
        Self {
            inner,
            crypto,
            buffer: BytesMut::with_capacity(BUFFER_SIZE),
        }
    }

    /// Consumes the `DecryptingBufReader`, returning the wrapped [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) and [`Decryptor`].
    pub fn into_parts(self) -> (R, Decryptor) {
        (self.inner, self.crypto)
    }
}

impl<R: AsyncRead> AsyncRead for DecryptingBufReader<R> {
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        let data = ready!(self.as_mut().poll_fill_buf(cx))?;
        let bytes_to_copy = cmp::min(data.len(), buf.remaining());
        buf.put_slice(&data[..bytes_to_copy]);
        self.consume(bytes_to_copy);
        Poll::Ready(Ok(()))
    }
}

impl<R: AsyncRead> AsyncBufRead for DecryptingBufReader<R> {
    fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>> {
        let this = self.project();

        if this.buffer.is_empty() {
            assert!(this.buffer.try_reclaim(BUFFER_SIZE));
            let mut rd = ReadBuf::uninit(this.buffer.spare_capacity_mut());
            ready!(this.inner.poll_read(cx, &mut rd))?;

            this.crypto.decrypt(rd.filled_mut());

            let bytes_read = rd.filled().len();
            unsafe { this.buffer.advance_mut(bytes_read) }
        }
        Poll::Ready(Ok(this.buffer))
    }

    fn consume(self: Pin<&mut Self>, amt: usize) {
        let this = self.project();
        let amt = cmp::min(amt, this.buffer.remaining());
        this.buffer.advance(amt);
    }
}

pin_project! {
    /// A buffering writer that wraps an [`AsyncWrite`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncWrite.html) and encrypts the data written to it using an [`Encryptor`].
    ///
    /// Implementation of `EncryptingWriter` is similar to [`tokio::io::BufWriter`](https://docs.rs/tokio/latest/tokio/io/struct.BufWriter.html), slightly
    /// simplified thanks to [`BytesMut`](https://docs.rs/bytes/latest/bytes/struct.BytesMut.html), and with added calls to `Encryptor::encrypt()`.
    #[derive(Debug)]
    pub struct EncryptingWriter<W: AsyncWrite> {
        #[pin]
        inner: W,
        crypto: Encryptor,
        buffer: BytesMut,
    }
}

impl<W: AsyncWrite> EncryptingWriter<W> {
    /// Creates a new `EncryptingWriter` that wraps the given [`AsyncWrite`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncWrite.html) and [`Encryptor`].
    pub fn new(inner: W, crypto: Encryptor) -> Self {
        Self {
            inner,
            crypto,
            buffer: BytesMut::with_capacity(BUFFER_SIZE),
        }
    }

    /// Consumes the `EncryptingWriter`, returning the wrapped [`AsyncWrite`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncWrite.html) and [`Encryptor`].
    pub fn into_parts(self) -> (W, Encryptor) {
        (self.inner, self.crypto)
    }

    fn flush_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        let mut this = self.project();

        while !this.buffer.is_empty() {
            let written = ready!(this.inner.as_mut().poll_write(cx, this.buffer))?;
            if written == 0 {
                return Poll::Ready(Err(io::Error::new(
                    io::ErrorKind::WriteZero,
                    "failed to write the buffered data",
                )));
            }
            this.buffer.advance(written);
        }
        Poll::Ready(Ok(()))
    }

    fn fill_buf(self: Pin<&mut Self>, data: &[u8]) -> io::Result<usize> {
        let this = self.project();
        assert!(this.buffer.capacity() <= BUFFER_SIZE);

        let filled_len = this.buffer.len();
        let available_cap = {
            let curr_available = this.buffer.capacity() - filled_len;
            if data.len() > curr_available {
                let max_available = BUFFER_SIZE - filled_len;
                assert!(this.buffer.try_reclaim(max_available));
                max_available
            } else {
                curr_available
            }
        };

        let bytes_to_write = cmp::min(data.len(), available_cap);

        if bytes_to_write == 0 {
            return Err(io::Error::new(io::ErrorKind::WriteZero, "can't write data to buffer"));
        }

        this.buffer.extend_from_slice(&data[..bytes_to_write]);
        this.crypto.encrypt(&mut this.buffer[filled_len..]);

        Ok(bytes_to_write)
    }
}

impl<W: AsyncWrite> AsyncWrite for EncryptingWriter<W> {
    fn poll_write(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        ready!(self.as_mut().flush_buf(cx))?;
        Poll::Ready(self.fill_buf(buf))
    }

    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        ready!(self.as_mut().flush_buf(cx))?;
        self.project().inner.poll_flush(cx)
    }

    fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        ready!(self.as_mut().flush_buf(cx))?;
        self.project().inner.poll_shutdown(cx)
    }
}

pin_project! {
    /// A wrapper around an [`AsyncRead`](https://docs.rs/tokio/latest/tokio/io/trait.AsyncRead.html) that first returns the bytes from an initial buffer `T`, and then
    /// delegates to the wrapped stream `S`. Similar to [`Chain`](https://docs.rs/tokio/latest/tokio/io/struct.Chain.html), but also implements `AsyncWrite` and `SplitStream`
    /// if `S` does.
    pub struct PrefixedStream<T: Buf, S> {
        prefix: T,
        #[pin]
        stream: S,
    }
}

impl<T: Buf, S> PrefixedStream<T, S> {
    /// Creates a new `PrefixedStream` that wraps the given initial buffer and stream.
    pub fn new(prefix: T, stream: S) -> Self {
        Self { prefix, stream }
    }

    /// Consumes the `PrefixedStream`, returning the prefix buffer and the wrapped stream.
    pub fn into_parts(self) -> (T, S) {
        (self.prefix, self.stream)
    }
}

impl<T: Buf, S: AsyncRead> AsyncRead for PrefixedStream<T, S> {
    fn poll_read(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        if self.prefix.has_remaining() {
            let bytes_to_copy = cmp::min(buf.remaining(), self.prefix.chunk().len());
            buf.put_slice(&self.prefix.chunk()[..bytes_to_copy]);
            self.project().prefix.advance(bytes_to_copy);
            Poll::Ready(Ok(()))
        } else {
            self.project().stream.poll_read(cx, buf)
        }
    }
}

impl<T: Buf, S: AsyncWrite> AsyncWrite for PrefixedStream<T, S> {
    fn poll_write(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        self.project().stream.poll_write(cx, buf)
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        self.project().stream.poll_flush(cx)
    }

    fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        self.project().stream.poll_shutdown(cx)
    }

    fn poll_write_vectored(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        bufs: &[io::IoSlice<'_>],
    ) -> Poll<io::Result<usize>> {
        self.project().stream.poll_write_vectored(cx, bufs)
    }

    fn is_write_vectored(&self) -> bool {
        self.stream.is_write_vectored()
    }
}

impl<T: Buf, S: SplitStream> SplitStream for PrefixedStream<T, S> {
    type Ingress<'i>
        = Chain<&'i [u8], <S as SplitStream>::Ingress<'i>>
    where
        Self: 'i;

    type Egress<'e>
        = S::Egress<'e>
    where
        Self: 'e;

    fn split(&mut self) -> (Self::Ingress<'_>, Self::Egress<'_>) {
        let (ingress, egress) = self.stream.split();
        let ingress = AsyncReadExt::chain(self.prefix.chunk(), ingress);
        (ingress, egress)
    }
}

#[cfg(test)]
mod tests {
    use super::super::cipher::crypto_pair;
    use super::*;
    use local_async_utils::prelude::*;
    use tokio::io::{AsyncReadExt, AsyncWriteExt};
    use tokio::join;

    #[tokio::test]
    async fn test_pipe_big_data_over_encrypted_stream() {
        let (enc, dec) = crypto_pair(&rand::random());

        let (reader, writer) = local_pipe::Pipe::new(1024).into_split();
        let mut reader = DecryptingReader::new(reader, dec);
        let mut writer = EncryptingWriter::new(writer, enc);

        for _ in 0..3 {
            let src_data: [u8; BUFFER_SIZE * 2] = rand::random();
            let mut dest_data = [0u8; BUFFER_SIZE * 2];

            let write_fut = async {
                writer.write_all(&src_data).await.unwrap();
                writer.flush().await.unwrap();
            };
            let read_fut = async {
                reader.read_exact(&mut dest_data).await.unwrap();
            };
            join!(write_fut, read_fut);

            assert_eq!(src_data, dest_data);
        }
    }

    #[tokio::test]
    async fn test_pipe_small_data_over_encrypted_stream() {
        let (enc, dec) = crypto_pair(&rand::random());

        let (reader, writer) = local_pipe::Pipe::new(1024).into_split();
        let mut reader = DecryptingReader::new(reader, dec);
        let mut writer = EncryptingWriter::new(writer, enc);

        for _ in 0..3 {
            let src_data: [u8; BUFFER_SIZE / 2] = rand::random();
            let mut dest_data = [0u8; BUFFER_SIZE / 2];

            let write_fut = async {
                writer.write_all(&src_data).await.unwrap();
                writer.flush().await.unwrap();
            };
            let read_fut = async {
                reader.read_exact(&mut dest_data).await.unwrap();
            };
            join!(write_fut, read_fut);

            assert_eq!(src_data, dest_data);
        }
    }

    #[tokio::test]
    async fn test_pipe_big_data_over_encrypted_buffered_stream() {
        let (enc, dec) = crypto_pair(&rand::random());

        let (reader, writer) = local_pipe::Pipe::new(1024).into_split();
        let mut reader = DecryptingBufReader::new(reader, dec);
        let mut writer = EncryptingWriter::new(writer, enc);

        for _ in 0..3 {
            let src_data: [u8; BUFFER_SIZE * 2] = rand::random();
            let mut dest_data = [0u8; BUFFER_SIZE * 2];

            let write_fut = async {
                writer.write_all(&src_data).await.unwrap();
                writer.flush().await.unwrap();
            };
            let read_fut = async {
                reader.read_exact(&mut dest_data).await.unwrap();
            };
            join!(write_fut, read_fut);

            assert_eq!(src_data, dest_data);
        }
    }

    #[tokio::test]
    async fn test_pipe_small_data_over_encrypted_buffered_stream() {
        let (enc, dec) = crypto_pair(&rand::random());

        let (reader, writer) = local_pipe::Pipe::new(1024).into_split();
        let mut reader = DecryptingBufReader::new(reader, dec);
        let mut writer = EncryptingWriter::new(writer, enc);

        for _ in 0..3 {
            let src_data: [u8; BUFFER_SIZE / 2] = rand::random();
            let mut dest_data = [0u8; BUFFER_SIZE / 2];

            let write_fut = async {
                writer.write_all(&src_data).await.unwrap();
                writer.flush().await.unwrap();
            };
            let read_fut = async {
                reader.read_exact(&mut dest_data).await.unwrap();
            };
            join!(write_fut, read_fut);

            assert_eq!(src_data, dest_data);
        }
    }

    #[tokio::test]
    async fn test_prefixed_stream() {
        let prefix: [u8; 10] = rand::random();
        let data: [u8; 20] = rand::random();
        let mut stream = PrefixedStream::new(BytesMut::from(&prefix[..]), &data[..]);

        let mut buf = Vec::new();
        stream.read_to_end(&mut buf).await.unwrap();

        assert_eq!(&buf[..10], &prefix);
        assert_eq!(&buf[10..], &data);
    }
}