socks5-impl 0.2.4

Fundamental abstractions and async read / write functions for SOCKS5 protocol and Relatively low-level asynchronized SOCKS5 server implementation based on tokio
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

#![cfg(feature = "tokio")]

use std::{io::Result, net::SocketAddr, sync::Arc};
use tokio::net::TcpListener;

pub mod auth;
pub mod connection;

pub use crate::{
    server::auth::Auth,
    server::connection::{
        associate::{Associate, AssociatedUdpSocket},
        bind::Bind,
        connect::Connect,
        Connection, IncomingConnection,
    },
};

/// The socks5 server itself.
///
/// The server can be constructed on a given socket address, or be created on an existing TcpListener.
///
/// The authentication method can be configured with the [`Auth`](https://docs.rs/socks5-impl/latest/socks5_impl/server/auth/trait.Auth.html) trait.
pub struct Server {
    listener: TcpListener,
    auth: Arc<dyn Auth + Send + Sync>,
}

impl Server {
    /// Create a new socks5 server with the given TCP listener and authentication method.
    #[inline]
    pub fn new(listener: TcpListener, auth: Arc<dyn Auth + Send + Sync>) -> Self {
        Self { listener, auth }
    }

    /// Create a new socks5 server on the given socket address and authentication method.
    #[inline]
    pub async fn bind(addr: SocketAddr, auth: Arc<dyn Auth + Send + Sync>) -> Result<Self> {
        let socket = if addr.is_ipv4() {
            tokio::net::TcpSocket::new_v4()?
        } else {
            tokio::net::TcpSocket::new_v6()?
        };
        socket.set_reuseaddr(true)?;
        socket.bind(addr)?;
        let listener = socket.listen(1024)?;
        Ok(Self::new(listener, auth))
    }

    /// Accept an [`IncomingConnection`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html). The connection may not be a valid socks5 connection. You need to call [`IncomingConnection::handshake()`](https://docs.rs/socks5-impl/latest/server/connection/struct.IncomingConnection.html#method.handshake) to hand-shake it into a proper socks5 connection.
    #[inline]
    pub async fn accept(&self) -> Result<(IncomingConnection, SocketAddr)> {
        let (stream, addr) = self.listener.accept().await?;
        Ok((IncomingConnection::new(stream, self.auth.clone()), addr))
    }

    /// Get the the local socket address binded to this server
    #[inline]
    pub fn local_addr(&self) -> Result<SocketAddr> {
        self.listener.local_addr()
    }
}