Struct Socks5Acceptor

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

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>

§

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

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. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

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. Read more
§

impl Default for Socks5Acceptor

§

fn default() -> Socks5Acceptor

Returns the “default value” for a type. Read more
§

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

§

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.

Auto Trait Implementations§

§

impl<C, B, U, A> Freeze for Socks5Acceptor<C, B, U, A>
where C: Freeze, B: Freeze, U: Freeze, A: Freeze,

§

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

§

impl<C, B, U, A> Send for Socks5Acceptor<C, B, U, A>
where C: Send, B: Send, U: Send, A: Send,

§

impl<C, B, U, A> Sync for Socks5Acceptor<C, B, U, A>
where C: Sync, B: Sync, U: Sync, A: Sync,

§

impl<C, B, U, A> Unpin for Socks5Acceptor<C, B, U, A>
where C: Unpin, B: Unpin, U: Unpin, A: Unpin,

§

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

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaInto<U> for T
where U: RamaFrom<T>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

type Error = <U as RamaTryFrom<T>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U> RamaTryInto<U> for T
where U: RamaTryFrom<T>,

§

type Error = <U as RamaTryFrom<T>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,