Struct Socks5Server 

pub struct Socks5Server {
    pub listen_addr: String,
    pub auth_config: Option<Arc<UserPass>>,
}

Socks5Server represents a SOCKS5 server and houses related configuration data

Fields

listen_addr: String

auth_config: Option<Arc<UserPass>>

Implementations

impl Socks5Server

Socks5Server implementation block

pub fn new(listen_addr: impl Into<String>) -> Self

new is a constructor for the Socks5Server type

Examples found in repository

examples/basic_server.rs (line 9)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    tracing_subscriber::fmt::init();

    let server = Socks5Server::new("127.0.0.1:1080");
    println!("Starting SOCKS5 server on 127.0.0.1:1080");

    server.run().await?;
    Ok(())
}

examples/with_auth.rs (line 14)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    tracing_subscriber::fmt::init();

    let auth = UserPass {
        username: "<user>".to_string(),
        password: "<pass>".to_string(),
    };

    let server = Socks5Server::new("127.0.0.1:1080").with_auth(Some(auth));

    server.run().await?;
    Ok(())
}

pub fn with_auth(self, auth: Option<UserPass>) -> Self

with_auth applies the desired authentication

Examples found in repository

examples/with_auth.rs (line 14)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    tracing_subscriber::fmt::init();

    let auth = UserPass {
        username: "<user>".to_string(),
        password: "<pass>".to_string(),
    };

    let server = Socks5Server::new("127.0.0.1:1080").with_auth(Some(auth));

    server.run().await?;
    Ok(())
}

pub async fn run(&self) -> Result<()>

run handles server spinup and listens for incoming connections

Examples found in repository

examples/basic_server.rs (line 12)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    tracing_subscriber::fmt::init();

    let server = Socks5Server::new("127.0.0.1:1080");
    println!("Starting SOCKS5 server on 127.0.0.1:1080");

    server.run().await?;
    Ok(())
}

examples/with_auth.rs (line 16)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    tracing_subscriber::fmt::init();

    let auth = UserPass {
        username: "<user>".to_string(),
        password: "<pass>".to_string(),
    };

    let server = Socks5Server::new("127.0.0.1:1080").with_auth(Some(auth));

    server.run().await?;
    Ok(())
}