Skip to main content

UdpRelay

rama::proxy::socks5::server::udp

Struct UdpRelay

pub struct UdpRelay<B, I> { /* private fields */ }

Expand description

Only “useful” public Socks5UdpAssociator implementation, which actually is able to accept udp-relay requests and process them.

The Default implementation opens a new (udp) socket for accepting 1 incoming connection. Once received it will relay incoming packets to the target udp socket and relay received packets from the latter back to the socks5 server cient. Prefixing these upd packets using UdpHeader.

You can customise the UdpRelay fully by creating it using UdpRelay::new or overwrite any of the default components using UdpRelay::with_binder, UdpRelay::with_sync_inspector and UdpRelay::with_async_inspector.

Implementations§

impl<B> UdpRelay<B, DirectUdpRelay>

pub fn new(binder: B) -> UdpRelay<B, DirectUdpRelay>

Create a new UdpRelay.

pub fn with_sync_inspector<T>( self, inspector: T, ) -> UdpRelay<B, SyncUdpInspector<T>>

Overwrite the UdpRelay’s SyncUdpInspector UdpInspector that can be used to inspect / modify a udp packet to be relayed synchronously.

pub fn with_async_inspector<T>( self, inspector: T, ) -> UdpRelay<B, AsyncUdpInspector<T>>

Overwrite the UdpRelay’s AsyncUdpInspector Service that can be used to inspect / modify a udp packet to be relayed asynchronously.

impl<B, I> UdpRelay<B, I>

pub fn with_binder<T>(self, binder: T) -> UdpRelay<T, I>

Overwrite the UdpRelay’s bind `SocketService, used to open a socket, return the address and wait for an incoming connection which it will return.

pub fn with_bind_interface( self, interface: impl Into<Interface>, ) -> UdpRelay<B, I>

Define the (network) Interface to bind to, for both north and south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn set_bind_interface( &mut self, interface: impl Into<Interface>, ) -> &mut UdpRelay<B, I>

Define the (network) Interface to bind to, for both north and south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn with_bind_north_interface( self, interface: impl Into<Interface>, ) -> UdpRelay<B, I>

Define the (network) Interface to bind to, for the north direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn set_bind_north_interface( &mut self, interface: impl Into<Interface>, ) -> &mut UdpRelay<B, I>

Define the (network) Interface to bind to, for the north direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn with_bind_south_interface( self, interface: impl Into<Interface>, ) -> UdpRelay<B, I>

Define the (network) Interface to bind to, for the south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn set_bind_south_interface( &mut self, interface: impl Into<Interface>, ) -> &mut UdpRelay<B, I>

Define the (network) Interface to bind to, for the south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn with_buffer_size_south(self, n: usize) -> UdpRelay<B, I>

Set the size of the buffer used to read south traffic.

pub fn set_buffer_size_south(&mut self, n: usize) -> &mut UdpRelay<B, I>

Set the size of the buffer used to read south traffic.

pub fn with_buffer_size_north(self, n: usize) -> UdpRelay<B, I>

Set the size of the buffer used to read north traffic.

pub fn set_buffer_size_north(&mut self, n: usize) -> &mut UdpRelay<B, I>

Set the size of the buffer used to read north traffic.

pub fn with_buffer_size(self, n: usize) -> UdpRelay<B, I>

Set the size of the buffer used to read both north and south traffic.

pub fn set_buffer_size(&mut self, n: usize) -> &mut UdpRelay<B, I>

Set the size of the buffer used to read both north and south traffic.

pub fn maybe_with_relay_timeout( self, timeout: Option<Duration>, ) -> UdpRelay<B, I>

Define the relay timeout for this socks5 UDP server.

pub fn maybe_set_relay_timeout( &mut self, timeout: Option<Duration>, ) -> &mut UdpRelay<B, I>

Define the relay timeout for this socks5 UDP server.

pub fn with_relay_timeout(self, timeout: Duration) -> UdpRelay<B, I>

Define the relay timeout for this socks5 UDP server.

pub fn set_relay_timeout(&mut self, timeout: Duration) -> &mut UdpRelay<B, I>

Define the relay timeout for this socks5 UDP server.

pub fn without_relay_timeout(self) -> UdpRelay<B, I>

Define the relay timeout for this socks5 UDP server.

pub fn unset_relay_timeout(&mut self) -> &mut UdpRelay<B, I>

Define the relay timeout for this socks5 UDP server.

impl<B, I> UdpRelay<B, I>

pub fn with_default_dns_resolver(self) -> UdpRelay<B, I>

Attach a the Default DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

pub fn set_default_dns_resolver(&mut self) -> &mut UdpRelay<B, I>

Attach a the Default DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

pub fn with_dns_resolver( self, resolver: impl DnsResolver<Error = OpaqueError>, ) -> UdpRelay<B, I>

Attach a DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

pub fn set_dns_resolver( &mut self, resolver: impl DnsResolver<Error = OpaqueError>, ) -> &mut UdpRelay<B, I>

Attach a DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

Trait Implementations§

impl<B, I> Clone for UdpRelay<B, I>
where B: Clone, I: Clone,

fn clone(&self) -> UdpRelay<B, I>

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<B, I> Debug for UdpRelay<B, I>
where B: Debug, I: Debug,

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

Formats the value using the given formatter. Read more

impl Default for UdpRelay<Timeout<DefaultUdpBinder, LayerErrorStatic<Elapsed>>, DirectUdpRelay>

fn default() -> UdpRelay<Timeout<DefaultUdpBinder, LayerErrorStatic<Elapsed>>, DirectUdpRelay>

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

impl<B, I, S> Socks5UdpAssociatorSeal<S> for UdpRelay<B, I>
where B: SocketService<Socket = UdpSocket>, I: UdpPacketProxy, S: Stream + Unpin + ExtensionsMut,

async fn accept_udp_associate( &self, stream: S, destination: HostWithPort, ) -> Result<(), Error>

Auto Trait Implementations§

impl<B, I> Freeze for UdpRelay<B, I>
where B: Freeze, I: Freeze,

impl<B, I> !RefUnwindSafe for UdpRelay<B, I>

impl<B, I> Send for UdpRelay<B, I>
where B: Send, I: Send,

impl<B, I> Sync for UdpRelay<B, I>
where B: Sync, I: Sync,

impl<B, I> Unpin for UdpRelay<B, I>
where B: Unpin, I: Unpin,

impl<B, I> !UnwindSafe for UdpRelay<B, I>

Blanket Implementations§

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

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>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

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

fn rama_into(self) -> U

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

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

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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> Extension for T
where T: Any + Send + Sync + Debug + 'static,

impl<S, C> Socks5UdpAssociator<S> for C
where C: Socks5UdpAssociatorSeal<S>,