Skip to main content

RateLimitingSecurityConfig

Struct RateLimitingSecurityConfig 

Source
pub struct RateLimitingSecurityConfig {
Show 18 fields pub enabled: bool, pub requests_per_second: u32, pub burst_size: u32, pub auth_start_max_requests: u32, pub auth_start_window_secs: u64, pub auth_callback_max_requests: u32, pub auth_callback_window_secs: u64, pub auth_refresh_max_requests: u32, pub auth_refresh_window_secs: u64, pub auth_logout_max_requests: u32, pub auth_logout_window_secs: u64, pub failed_login_max_attempts: u32, pub failed_login_lockout_secs: u64, pub requests_per_second_per_user: Option<u32>, pub redis_url: Option<String>, pub trust_proxy_headers: bool, pub trusted_proxy_cidrs: Option<Vec<String>>, pub max_buckets: usize,
}
Expand description

Per-endpoint and global rate limiting configuration for [security.rate_limiting].

The single shape for this section: the CLI authors it from TOML and the server consumes it from the compiled schema, so the two cannot drift (before #977 each side kept its own copy — with different defaults).

Fields§

§enabled: bool

Enable rate limiting.

§requests_per_second: u32

Global request rate cap (requests per second, per IP).

§burst_size: u32

Burst allowance above the steady-state rate.

§auth_start_max_requests: u32

Auth initiation endpoint — max requests per window.

§auth_start_window_secs: u64

Auth initiation window in seconds.

§auth_callback_max_requests: u32

OAuth callback endpoint — max requests per window.

§auth_callback_window_secs: u64

OAuth callback window in seconds.

§auth_refresh_max_requests: u32

Token refresh endpoint — max requests per window.

§auth_refresh_window_secs: u64

Token refresh window in seconds.

§auth_logout_max_requests: u32

Logout endpoint — max requests per window (#893).

§auth_logout_window_secs: u64

Logout window in seconds.

§failed_login_max_attempts: u32

Maximum failed first-factor login attempts before lockout.

The off-the-shelf binary performs no first-factor login of its own, so it cannot enforce this; a value tuned away from the default is rejected at startup in production (#356) — see the server’s failed_login_lockout_check.

§failed_login_lockout_secs: u64

Lockout window in seconds after failed_login_max_attempts is exceeded.

§requests_per_second_per_user: Option<u32>

Per-authenticated-user request rate in requests/second. Defaults to 10× requests_per_second if not set.

§redis_url: Option<String>

Redis URL for distributed rate limiting.

Optional: when unset, budgets are tracked in-memory, per process. When set, an unreachable Redis is a boot error in production (#770/#777 class) — the server does not silently downgrade to per-process limits.

§trust_proxy_headers: bool

Trust X-Real-IP / X-Forwarded-For headers for client IP extraction.

Set to true only when FraiseQL is deployed behind a trusted reverse proxy that sets these headers. Enabling without a trusted proxy allows clients to spoof their IP address.

§trusted_proxy_cidrs: Option<Vec<String>>

CIDR ranges trusted as proxy IPs (e.g. ["10.0.0.0/8"]).

When set and trust_proxy_headers = true, X-Forwarded-For is only honoured when the direct connection IP falls within one of these ranges. When omitted with trust_proxy_headers = true, all proxy IPs are trusted (less secure — the server emits a startup warning).

§max_buckets: usize

Maximum tracked buckets per map — a memory ceiling, not a security control.

The limiter keeps one token bucket per key in each of its maps (per-IP, per-user, per-path-and-IP, per-tenant). This caps how many it holds at once, at roughly 200 bytes each: the default 100 000 is about 20 MiB per map.

Reaching the cap evicts the least-recently-used of a sample rather than refusing the newcomer (#1080/#1143), so setting it low degrades accuracy — a client whose bucket was evicted starts again with a full one — and never availability. It is a knob to size to the host, not to tune for protection.

Trait Implementations§

Source§

impl Clone for RateLimitingSecurityConfig

Source§

fn clone(&self) -> Self

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLimitingSecurityConfig

Source§

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

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

impl Default for RateLimitingSecurityConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RateLimitingSecurityConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for RateLimitingSecurityConfig

Source§

impl PartialEq for RateLimitingSecurityConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for RateLimitingSecurityConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RateLimitingSecurityConfig

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
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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
Source§

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
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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