Struct Socks5Acceptor

pub struct Socks5Acceptor<C = Connector<TcpConnector, StreamForwardService>, B = (), U = (), A = ()> { /* private fields */ }

Socks5 server implementation of RFC 1928

An instance constructed with Socks5Acceptor::new is one that accepts none of the available Commands, until you embed one or more of: connector, binder and udp associator.

Default

The Default implementation of the Socks5Acceptor only supports the Command::Connect method using the DefaultConnector, but custom connectors as well as binders and udp associators are optionally possible.

Implementations

impl Socks5Acceptor<()>

pub fn new() -> Socks5Acceptor<()>

Create a new Socks5Acceptor which supports none of the valid Commands.

Use Socks5Acceptor::default instead if you wish to create a default Socks5Acceptor which can be used as a simple and honest byte-byte proxy.

impl<C, B, U> Socks5Acceptor<C, B, U>

pub fn with_authorizer<A>(self, authorizer: A) -> Socks5Acceptor<C, B, U, A>

pub fn with_auth_optional(self, optional: bool) -> Socks5Acceptor<C, B, U>

Define whether or not the authentication (if supported by this Socks5Acceptor) is optional, by default it is no optional.

Making authentication optional, despite supporting authentication on server side, can be useful in case you wish to support so called Guest users.

pub fn set_auth_optional( &mut self, optional: bool, ) -> &mut Socks5Acceptor<C, B, U>

Define whether or not the authentication (if supported by this Socks5Acceptor) is optional, by default it is no optional.

Making authentication optional, despite supporting authentication on server side, can be useful in case you wish to support so called Guest users.

impl<B, U, A> Socks5Acceptor<(), B, U, A>

pub fn with_connector<C>(self, connector: C) -> Socks5Acceptor<C, B, U, A>

Attach a Socks5Connector to this Socks5Acceptor, used to accept incoming Command::Connect client::Requests.

Use Socks5Acceptor::with_default_connector in case the DefaultConnector serves your needs just fine.

pub fn with_default_connector( self, ) -> Socks5Acceptor<Connector<TcpConnector, StreamForwardService>, B, U, A>

Attach the DefaultConnector to this Socks5Acceptor, used to accept incoming Command::Connect client::Requests.

Use Socks5Acceptor::with_connector in case you want to use a custom Socks5Connector or customised Connector.

impl<C, U, A> Socks5Acceptor<C, (), U, A>

pub fn with_binder<B>(self, binder: B) -> Socks5Acceptor<C, B, U, A>

Attach a Socks5Binder to this Socks5Acceptor, used to accept incoming Command::Bind client::Requests.

Use Socks5Acceptor::with_default_binder in case the DefaultConnector serves your needs just fine.

pub fn with_default_binder( self, ) -> Socks5Acceptor<C, Binder<Timeout<DefaultAcceptorFactory, LayerErrorStatic<Elapsed>>, StreamForwardService>, U, A>

Attach the DefaultBinder to this Socks5Acceptor, used to accept incoming Command::Bind client::Requests.

Use Socks5Acceptor::with_binder in case you want to use a custom Socks5Binder or customised Binder.

impl<C, B, A> Socks5Acceptor<C, B, (), A>

pub fn with_udp_associator<U>( self, udp_associator: U, ) -> Socks5Acceptor<C, B, U, A>

Attach a Socks5UdpAssociator to this Socks5Acceptor, used to accept incoming Command::UdpAssociate client::Requests.

Use Socks5Acceptor::with_default_udp_associator in case the DefaultUdpRelay serves your needs just fine.

pub fn with_default_udp_associator( self, ) -> Socks5Acceptor<C, B, UdpRelay<Timeout<DefaultUdpBinder, LayerErrorStatic<Elapsed>>, DirectUdpRelay>, A>

Attach the DefaultUdpRelay to this Socks5Acceptor, used to accept incoming Command::UdpAssociate client::Requests.

Use Socks5Acceptor::with_udp_associator in case you want to use a custom Socks5UdpAssociator or customised udp::UdpRelay.

impl<C, B, U, A> Socks5Acceptor<C, B, U, A>

pub async fn accept<S>(&self, ctx: Context, stream: S) -> Result<(), Error>

where C: Socks5Connector<S>, U: Socks5UdpAssociator<S>, A: Authorizer<Basic>, <A as Authorizer<Basic>>::Error: Debug, B: Socks5Binder<S>, S: Stream + Unpin,

impl<C, B, U, A> Socks5Acceptor<C, B, U, A>

where C: Socks5Connector<TcpStream>, U: Socks5UdpAssociator<TcpStream>, A: Authorizer<Basic>, <A as Authorizer<Basic>>::Error: Debug, B: Socks5Binder<TcpStream>,

pub async fn listen<I>( self, interface: I, ) -> Result<(), Box<dyn Error + Sync + Send>>

where I: TryInto<Interface>, <I as TryInto<Interface>>::Error: Into<Box<dyn Error + Sync + Send>>,

Listen for connections on the given Interface, serving Socks5(h) connections.

It’s a shortcut in case you don’t need to operate on the transport layer directly.

Trait Implementations

impl<C, B, U, A> Clone for Socks5Acceptor<C, B, U, A>

where C: Clone, B: Clone, U: Clone, A: Clone,

fn clone(&self) -> Socks5Acceptor<C, B, U, A>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C, B, U, A> Debug for Socks5Acceptor<C, B, U, A>

where C: Debug, B: Debug, U: Debug, A: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Socks5Acceptor

fn default() -> Socks5Acceptor

Returns the “default value” for a type.

impl<C, B, U, A, S> Service<S> for Socks5Acceptor<C, B, U, A>

where C: Socks5Connector<S>, U: Socks5UdpAssociator<S>, A: Authorizer<Basic>, <A as Authorizer<Basic>>::Error: Debug, B: Socks5Binder<S>, S: Stream + Unpin,

type Response = ()

The type of response returned by the service.

type Error = Error

The type of error returned by the service.

fn serve( &self, ctx: Context, stream: S, ) -> impl Future<Output = Result<<Socks5Acceptor<C, B, U, A> as Service<S>>::Response, <Socks5Acceptor<C, B, U, A> as Service<S>>::Error>> + Send

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.