Skip to main content

WssLimits

Struct WssLimits 

pub struct WssLimits {
    pub max_pending_handshakes: usize,
    pub handshake_timeout: Duration,
    pub max_sessions: usize,
    pub max_sessions_per_client: usize,
    pub incomplete_message_timeout: Duration,
}
Expand description

Bounds on the WSS listener’s pre-authentication and session state.

The remote WSS plane is the daemon’s mandatory mTLS surface and its default bind is 0.0.0.0, so every state an unauthenticated peer can reach has to be bounded in both time and count. Without these, each accepted TCP socket spawned a task that awaited the TLS handshake and the WebSocket upgrade with no deadline and no cap, so a peer that merely connected - and never proved anything - could accumulate sockets, tasks and TLS parser state without limit. Mirrors the bounds the relay applies to its own admission path.

Fields§

§max_pending_handshakes: usize

Ceiling on sockets past accept() that have not finished the TLS handshake and WebSocket upgrade. When the pool is exhausted new sockets are dropped at accept rather than queued, so a slowloris spread across many source addresses sheds instead of accumulating.

§handshake_timeout: Duration

One absolute deadline covering TLS accept AND the WebSocket upgrade, measured from accept. It is a single budget for the whole setup sequence, not a fresh window per phase: the heartbeat only starts once a session is established, so without this a peer could stall in either handshake forever.

§max_sessions: usize

Ceiling on concurrently established WSS sessions. Bounds the steady state that survives authentication, so an authorized-but-abusive peer cannot grow dispatcher and transport state without limit.

§max_sessions_per_client: usize

Ceiling on concurrent sessions presenting ONE client certificate, keyed by that certificate’s SHA-256 fingerprint.

max_sessions alone is an arithmetic ceiling, not a host-memory budget: every session may declare a message up to the parser envelope (rpc_ws_config), so the session ceiling is a memory ceiling, and one admitted-but-hostile credential (or a stolen one, before it is detected and revoked) can occupy all of it. This bounds the parser bytes ONE credential can reserve at max_sessions_per_client x envelope.

§incomplete_message_timeout: Duration

How long a partially-received data message may be held by the parser.

The heartbeat proves liveness, not progress: tungstenite yields interleaved control frames while a fragmented message is still incomplete, so a peer can Ping forever while the parser retains the partial buffer. This bounds that hold time.

The deadline is armed by the peer’s own DECLARATION, not by bytes received. tungstenite reserves a frame’s declared length the moment it parses that frame’s header, before any payload arrives, so bytes read is not a proxy for bytes reserved: a 14-byte header can reserve the whole parser envelope. A frame scanner under the parser (FrameScanner) reads the same plaintext byte stream and starts this clock at the FIRST byte of a data frame’s header, so every partial-message reservation is bounded from the moment it exists. Control frames are inert to it by construction, and with no data message in progress there is no deadline at all - an idle connection is the heartbeat’s business.

It is a lifetime bound, not a stall detector - a peer that trickles bytes is exactly the case a stall detector would miss - so it also bounds the slowest legitimate upload: a full-size request (crate::rpc::attachments::MAX_REQUEST_BYTES, 20 MiB) must arrive within this window (at the 60s default that is a ~341 KiB/s floor; operators on slower links should raise the window, not disable it).

Trait Implementations§

Source§

impl Clone for WssLimits

Source§

fn clone(&self) -> WssLimits

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · §

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WssLimits

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WssLimits

Source§

fn default() -> Self

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

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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