racoon 0.1.9

Racoon is a fast, fully customizable web framework for Rust focusing on simplicity.
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
use std::future::Future;
use std::io::ErrorKind;
use std::net::{Shutdown, SocketAddr};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;

use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::io::{ReadHalf, WriteHalf};
use tokio::net::{TcpStream, UnixStream};
use tokio::sync::Mutex;

use tokio_rustls::server::TlsStream;
use tokio_rustls::TlsAcceptor;

use crate::{racoon_debug, racoon_error};

pub type StreamResult<'a, T> = Box<dyn Future<Output = T> + Sync + Send + Unpin + 'a>;
pub type Stream = Box<dyn AbstractStream>;

pub trait AbstractStream: Sync + Send {
    fn buffer_size(&self) -> StreamResult<usize>;
    fn peer_addr(&self) -> StreamResult<Option<SocketAddr>>;
    fn restore_payload<'a>(&'a self, bytes: &[u8]) -> StreamResult<std::io::Result<()>>;
    fn restored_len(&self) -> StreamResult<usize>;
    fn read_chunk(&self) -> StreamResult<std::io::Result<Vec<u8>>>;
    fn write_chunk<'a>(&'a self, bytes: &'a [u8]) -> StreamResult<std::io::Result<()>>;
    fn shutdown(&self) -> StreamResult<std::io::Result<()>>;
}

#[derive(Debug)]
pub struct TcpStreamWrapper {
    stream: Arc<Mutex<TcpStream>>,
    reader: Arc<Mutex<ReadHalf<TcpStream>>>,
    writer: Arc<Mutex<WriteHalf<TcpStream>>>,
    buffer_size: usize,
    restored_payload: Arc<Mutex<Option<Vec<u8>>>>,
}

impl TcpStreamWrapper {
    pub fn from(tcp_stream: TcpStream, buffer_size: usize) -> std::io::Result<Self> {
        // May return "Too many open files error" if all file descriptors are used.
        let std_tcp_stream = tcp_stream.into_std()?;

        let async_tcp_stream_rw = match std_tcp_stream.try_clone() {
            Ok(std_stream) => TcpStream::from_std(std_stream)?,
            Err(err) => {
                racoon_error!("Failed to clone std TcpStream to tokio TcpStream. Try increasing file descriptor limit.");
                racoon_debug!("Shutting down std stream.");
                let shutdown_result = std_tcp_stream.shutdown(std::net::Shutdown::Both);
                racoon_debug!("Shutdown result: {:?}", shutdown_result);
                return Err(err);
            }
        };

        // Stream for shutting down later
        let (reader, writer) = tokio::io::split(async_tcp_stream_rw);
        let async_tcp_stream = TcpStream::from_std(std_tcp_stream)?;

        Ok(Self {
            stream: Arc::new(Mutex::new(async_tcp_stream)),
            reader: Arc::new(Mutex::new(reader)),
            writer: Arc::new(Mutex::new(writer)),
            buffer_size,
            restored_payload: Arc::new(Mutex::new(None)),
        })
    }
}

impl AbstractStream for TcpStreamWrapper {
    fn buffer_size(&self) -> StreamResult<usize> {
        let buffer_size = self.buffer_size.clone();
        Box::new(Box::pin(async move { buffer_size }))
    }

    fn peer_addr(&self) -> StreamResult<Option<SocketAddr>> {
        let stream_ref = self.stream.clone();

        Box::new(Box::pin(async move {
            let stream = stream_ref.lock().await;

            return match stream.peer_addr() {
                Ok(addr) => Some(addr),
                Err(error) => {
                    racoon_debug!("Failed to get peer addr. Error: {}", error);
                    None
                }
            };
        }))
    }

    fn restore_payload<'a>(&'a self, bytes: &[u8]) -> StreamResult<std::io::Result<()>> {
        let restored_payload_ref = self.restored_payload.clone();
        let bytes = bytes.to_vec();

        Box::new(Box::pin(async move {
            let mut restored_payload = restored_payload_ref.lock().await;
            *restored_payload = Some(bytes);
            Ok(())
        }))
    }

    fn restored_len(&self) -> StreamResult<usize> {
        let restored_payload_ref = self.restored_payload.clone();

        Box::new(Box::pin(async move {
            let restored_payload = restored_payload_ref.lock().await;

            if let Some(restored) = restored_payload.as_ref() {
                return restored.len();
            }

            0
        }))
    }

    fn read_chunk(&self) -> StreamResult<std::io::Result<Vec<u8>>> {
        let restored_payload_ref = self.restored_payload.clone();
        let reader_ref = self.reader.clone();
        let buffer_size = self.buffer_size.clone();

        Box::new(Box::pin(async move {
            // If payload of some bytes is restored after reading the chunk, returns the same bytes
            // back to the reader again.
            // Reading from stream wrapper is skipped because there may not be any bytes to read.
            let mut restored_payload = restored_payload_ref.lock().await;

            if let Some(payload) = restored_payload.take() {
                // Leaves None
                return Ok(payload);
            }

            let mut buffer = vec![0u8; buffer_size];
            let mut reader = reader_ref.lock().await;

            return match reader.read(&mut buffer).await {
                Ok(read_size) => {
                    if read_size == 0 {
                        return Err(std::io::Error::new(
                            ErrorKind::BrokenPipe,
                            "Read size is 0. Probably connection broken.",
                        ));
                    }

                    let chunk: Vec<u8> = buffer.drain(0..read_size).collect();
                    Ok(chunk)
                }
                Err(error) => Err(std::io::Error::other(error)),
            };
        }))
    }

    fn write_chunk<'a>(&'a self, data: &'a [u8]) -> StreamResult<std::io::Result<()>> {
        let writer_ref = self.writer.clone();

        Box::new(Box::pin(async move {
            let mut writer = writer_ref.lock().await;
            writer.write_all(&data).await?;
            Ok(())
        }))
    }

    fn shutdown(&self) -> StreamResult<std::io::Result<()>> {
        let stream_ref = self.stream.clone();

        Box::new(Box::pin(async move {
            let mut stream = stream_ref.lock().await;
            let _ = stream.shutdown().await;
            Ok(())
        }))
    }
}

#[derive(Debug)]
pub struct UnixStreamWrapper {
    stream: Arc<Mutex<UnixStream>>,
    reader: Arc<Mutex<ReadHalf<UnixStream>>>,
    writer: Arc<Mutex<WriteHalf<UnixStream>>>,
    buffer_size: usize,
    restored_payload: Arc<Mutex<Option<Vec<u8>>>>,
}

impl UnixStreamWrapper {
    pub fn from(unix_stream: UnixStream, buffer_size: usize) -> std::io::Result<Self> {
        let std_unix_stream = unix_stream.into_std()?;

        let async_unix_stream = match std_unix_stream.try_clone() {
            Ok(unix_stream) => UnixStream::from_std(unix_stream)?,
            Err(error) => {
                racoon_error!("Failed to clone std unix stream.");
                let shutdown_result = std_unix_stream.shutdown(Shutdown::Both);
                racoon_debug!("Shutdown result: {:?}", shutdown_result);
                return Err(error);
            }
        };

        let async_writer_rw = UnixStream::from_std(std_unix_stream)?;
        let (reader, writer) = tokio::io::split(async_writer_rw);

        Ok(Self {
            stream: Arc::new(Mutex::new(async_unix_stream)),
            reader: Arc::new(Mutex::new(reader)),
            writer: Arc::new(Mutex::new(writer)),
            buffer_size,
            restored_payload: Arc::new(Mutex::new(None)),
        })
    }
}

impl AbstractStream for UnixStreamWrapper {
    fn buffer_size(&self) -> StreamResult<usize> {
        let buffer_size = self.buffer_size.clone();
        Box::new(Box::pin(async move { buffer_size }))
    }

    fn peer_addr(&self) -> StreamResult<Option<SocketAddr>> {
        Box::new(Box::pin(async move {
            return None;
        }))
    }

    fn restore_payload(&self, bytes: &[u8]) -> StreamResult<std::io::Result<()>> {
        let restored_payload = self.restored_payload.clone();
        let bytes = bytes.to_vec();

        Box::new(Box::pin(async move {
            let restored_payload_ref = restored_payload.clone();
            let mut restored_payload = restored_payload_ref.lock().await;
            *restored_payload = Some(bytes);
            Ok(())
        }))
    }

    fn restored_len(&self) -> StreamResult<usize> {
        let restored_payload = self.restored_payload.clone();

        Box::new(Box::pin(async move {
            let restored_payload_ref = restored_payload.clone();
            let restored_payload = restored_payload_ref.lock().await;

            if let Some(restored) = restored_payload.as_ref() {
                return restored.len();
            }

            0
        }))
    }

    fn read_chunk(&self) -> StreamResult<std::io::Result<Vec<u8>>> {
        // If payload of some bytes is restored after reading the chunk, returns the same bytes
        // back to the reader again.
        // Reading from stream wrapper is skipped because there may not be any bytes to read.
        let restored_payload_ref = self.restored_payload.clone();
        let buffer_size = self.buffer_size.clone();

        let reader = self.reader.clone();

        Box::new(Box::pin(async move {
            let mut restored_payload = restored_payload_ref.lock().await;

            if let Some(payload) = restored_payload.as_ref() {
                let buffer = payload.to_owned();
                *restored_payload = None;
                return Ok(buffer);
            }

            let mut buffer = vec![0u8; buffer_size];

            let reader_ref = reader.clone();
            let mut reader = reader_ref.lock().await;

            return match reader.read(&mut buffer).await {
                Ok(read_size) => {
                    if read_size == 0 {
                        return Err(std::io::Error::new(
                            ErrorKind::BrokenPipe,
                            "Read size is 0. Probably connection broken.",
                        ));
                    }

                    let chunk = &buffer[0..read_size];
                    Ok(chunk.to_vec())
                }
                Err(error) => Err(std::io::Error::other(error)),
            };
        }))
    }

    fn write_chunk(&self, data: &[u8]) -> StreamResult<std::io::Result<()>> {
        let writer_ref = self.writer.clone();
        let data = data.to_vec();

        Box::new(Box::pin(async move {
            let mut writer = writer_ref.lock().await;
            writer.write_all(&data).await?;
            Ok(())
        }))
    }

    fn shutdown(&self) -> StreamResult<std::io::Result<()>> {
        let stream_ref = self.stream.clone();

        Box::new(Box::pin(async move {
            let mut stream = stream_ref.lock().await;
            let _ = stream.shutdown().await;
            Ok(())
        }))
    }
}

#[derive(Debug)]
pub struct TlsTcpStreamWrapper {
    peer_addr: SocketAddr,
    stream: Arc<Mutex<TcpStream>>,
    reader: Arc<Mutex<ReadHalf<TlsStream<TcpStream>>>>,
    writer: Arc<Mutex<WriteHalf<TlsStream<TcpStream>>>>,
    buffer_size: usize,
    restored_payload: Arc<Mutex<Option<Vec<u8>>>>,
}

impl TlsTcpStreamWrapper {
    pub async fn from(
        tcp_stream: TcpStream,
        tls_acceptor: &TlsAcceptor,
        buffer_size: usize,
    ) -> std::io::Result<Self> {
        let peer_addr = tcp_stream.peer_addr()?;
        let std_tcp_stream = tcp_stream.into_std()?;

        // Stream for shutting down reader/writer later
        let stream = TcpStream::from_std(std_tcp_stream.try_clone()?)?;
        let async_reader = TcpStream::from_std(std_tcp_stream)?;

        let tls_async_stream = tls_acceptor.accept(async_reader).await?;
        let (reader, writer) = tokio::io::split(tls_async_stream);

        Ok(Self {
            peer_addr,
            stream: Arc::new(Mutex::new(stream)),
            reader: Arc::new(Mutex::new(reader)),
            writer: Arc::new(Mutex::new(writer)),
            buffer_size,
            restored_payload: Arc::new(Mutex::new(None)),
        })
    }
}

impl AbstractStream for TlsTcpStreamWrapper {
    fn buffer_size(&self) -> StreamResult<usize> {
        let buffer_size = self.buffer_size.clone();
        Box::new(Box::pin(async move { buffer_size }))
    }

    fn peer_addr(&self) -> StreamResult<Option<SocketAddr>> {
        let peer_addr = self.peer_addr.clone();

        Box::new(Box::pin(async move { Some(peer_addr) }))
    }

    fn restore_payload(&self, bytes: &[u8]) -> StreamResult<std::io::Result<()>> {
        let restored_payload_ref = self.restored_payload.clone();

        let bytes = bytes.to_vec();

        Box::new(Box::pin(async move {
            let mut restored_payload = restored_payload_ref.lock().await;
            *restored_payload = Some(bytes);
            Ok(())
        }))
    }

    fn restored_len(&self) -> StreamResult<usize> {
        let restored_payload_ref = self.restored_payload.clone();

        Box::new(Box::pin(async move {
            let restored_payload = restored_payload_ref.lock().await;

            if let Some(restored) = restored_payload.as_ref() {
                return restored.len();
            }

            0
        }))
    }

    fn read_chunk(&self) -> StreamResult<std::io::Result<Vec<u8>>> {
        // If payload of some bytes is restored after reading the chunk, returns the same bytes
        // back to the reader again.
        // Reading from stream wrapper is skipped because there may not be any bytes to read.
        let restored_payload_ref = self.restored_payload.clone();
        let buffer_size = self.buffer_size.clone();
        let reader = self.reader.clone();

        Box::new(Box::pin(async move {
            let mut restored_payload = restored_payload_ref.lock().await;

            if let Some(payload) = restored_payload.as_ref() {
                let buffer = payload.to_owned();
                *restored_payload = None;
                return Ok(buffer);
            }

            let mut buffer = vec![0u8; buffer_size];
            let mut reader = reader.lock().await;

            return match reader.read(&mut buffer).await {
                Ok(read_size) => {
                    if read_size == 0 {
                        return Err(std::io::Error::new(
                            ErrorKind::BrokenPipe,
                            "Read size is 0. Probably connection broken.",
                        ));
                    }

                    let chunk = &buffer[0..read_size];
                    Ok(chunk.to_vec())
                }
                Err(error) => Err(std::io::Error::other(error)),
            };
        }))
    }

    fn write_chunk(&self, data: &[u8]) -> StreamResult<std::io::Result<()>> {
        let writer_ref = self.writer.clone();
        let data = data.to_vec();

        Box::new(Box::pin(async move {
            let mut writer = writer_ref.lock().await;
            writer.write_all(&data).await?;
            Ok(())
        }))
    }

    fn shutdown(&self) -> StreamResult<std::io::Result<()>> {
        let stream_ref = self.stream.clone();

        Box::new(Box::pin(async move {
            let mut stream = stream_ref.lock().await;
            stream.shutdown().await?;
            Ok(())
        }))
    }
}

pub struct TestStreamWrapper {
    test_data: Arc<Mutex<Vec<u8>>>,
    buffer_size: usize,
    is_shutdown: Arc<AtomicBool>,
    restored_payload: Arc<Mutex<Option<Vec<u8>>>>,
}

impl TestStreamWrapper {
    pub fn new(test_data: Vec<u8>, buffer_size: usize) -> Self {
        Self {
            test_data: Arc::new(Mutex::new(test_data)),
            buffer_size,
            is_shutdown: Arc::new(AtomicBool::new(false)),
            restored_payload: Arc::new(Mutex::new(None)),
        }
    }
}

impl AbstractStream for TestStreamWrapper {
    fn buffer_size(&self) -> StreamResult<usize> {
        Box::new(Box::pin(async move { self.buffer_size.clone() }))
    }

    fn peer_addr(&self) -> StreamResult<Option<SocketAddr>> {
        Box::new(Box::pin(async move { None }))
    }

    fn shutdown(&self) -> StreamResult<std::io::Result<()>> {
        self.is_shutdown.store(true, Ordering::Relaxed);
        Box::new(Box::pin(async move { Ok(()) }))
    }

    fn write_chunk(&self, _: &[u8]) -> StreamResult<std::io::Result<()>> {
        Box::new(Box::pin(async move {
            if self.is_shutdown.load(Ordering::Relaxed) {
                return Err(std::io::Error::other(
                    "Test Stream is already shutdown. Failed to write chunk.",
                ));
            }
            Ok(())
        }))
    }

    fn read_chunk(&self) -> StreamResult<std::io::Result<Vec<u8>>> {
        Box::new(Box::pin(async move {
            let restored_payload_ref = self.restored_payload.clone();
            let mut restored_payload = restored_payload_ref.lock().await;

            // Reads bytes from restored payload if any.
            if let Some(restored_bytes) = restored_payload.take() {
                if restored_bytes.len() > 0 {
                    return Ok(restored_bytes);
                }
            };

            if self.is_shutdown.load(Ordering::Relaxed) {
                return Err(std::io::Error::other(
                    "Test Stream is already shutdown. Failed to read chunk.",
                ));
            }

            let test_data_ref = self.test_data.clone();
            let mut test_data = test_data_ref.lock().await;

            // Reads bytes from test data
            let read_size = std::cmp::min(self.buffer_size, test_data.len());
            if read_size == 0 {
                return Err(std::io::Error::other("No bytes left to read."));
            }

            let removed_bytes = test_data.drain(0..read_size).collect();
            Ok(removed_bytes)
        }))
    }

    fn restored_len(&self) -> StreamResult<usize> {
        Box::new(Box::pin(async move {
            let restored_payload_ref = self.restored_payload.clone();
            let restored_payload = restored_payload_ref.lock().await;

            if let Some(restored_payload) = restored_payload.as_ref() {
                return restored_payload.len();
            }

            0
        }))
    }

    fn restore_payload(&self, bytes: &[u8]) -> StreamResult<std::io::Result<()>> {
        let bytes = bytes.to_vec();

        Box::new(Box::pin(async move {
            let restored_payload_ref = self.restored_payload.clone();
            let mut restored_payload = restored_payload_ref.lock().await;
            *restored_payload = Some(bytes);
            Ok(())
        }))
    }
}