Struct GuardConfigBuilder 

pub struct GuardConfigBuilder { /* private fields */ }

Builder for GuardConfig.

Implementations

impl GuardConfigBuilder

pub fn cookie(self, cookie: CookieConfig) -> Self

Cookie attributes. See CookieConfig.

pub fn cookie_name(self, name: impl Into<String>) -> Self

Shorthand for changing only the cookie name.

pub fn session_lifetime(self, lifetime: Duration) -> Self

Absolute session lifetime, counted from login. Activity, rotation and step-up never extend it; the subject must log in again. Default 30 days.

pub fn idle_timeout(self, timeout: Duration) -> Self

Inactivity timeout. Default 7 days.

pub fn trusted_proxies<I, T>(self, proxies: I) -> Result<Self, ConfigError>

where I: IntoIterator<Item = T>, T: AsRef<str>,

Reverse proxies (IP addresses or CIDR ranges) whose X-Forwarded-For is honoured. Without any, the TCP peer address is the client address.

Errors

ConfigError::InvalidProxy for an entry that is not an IP or CIDR range.

pub fn tls_fingerprint_header(self, header: impl Into<String>) -> Self

Header with a TLS fingerprint (e.g. JA4) set by your proxy. Enables Check::TlsChanged. Only use a header your proxy overwrites on every request.

pub fn rotation(self, rotation: RotationConfig) -> Self

Token rotation settings.

pub fn checks(self, checks: Checks) -> Self

Checks and weights. Default: all checks at default weights.

pub fn thresholds(self, thresholds: Thresholds) -> Self

Score thresholds. Default: step-up at 40, revoke at 80.

pub fn mode(self, mode: Mode) -> Self

Enforce or shadow mode. Default enforce.

pub fn step_up_policy(self, policy: StepUpPolicy) -> Self

What a step-up decision does. Default StepUpPolicy::Require.

pub fn orphan_reissue_window(self, window: Duration) -> Self

How long after being superseded an orphaned token (its successor never presented) is still reissued. Past it the token is rejected as unknown and the session is left to whoever holds the successor. Default off: orphans are reissued until rotation.reuse_detection prunes them.

Zero never reissues: a client that loses a single rotation response is signed out.

pub fn ping_pong_window(self, window: Duration) -> Self

Ping-pong window. Default 5 minutes. Zero disables ping-pong detection.

pub fn last_seen_write_interval(self, interval: Duration) -> Self

How stale last_seen may get before an unchanged request writes it. Default 60 seconds. Zero writes on every request.

pub fn event_retention(self, retention: Duration) -> Self

Event retention. Default 90 days.

pub fn minimize_stored_events(self, minimize: bool) -> Self

Write a reduced copy of each event to the store: the IP’s /24 (IPv4) or /48 (IPv6) network instead of the address, no raw User-Agent (the browser and OS families stay in ClientSummary) and no city. Default on. The on_event hook always gets the full event.

pub fn keep_origin_client(self, keep: bool) -> Self

Keep the full IP, raw User-Agent and city in each session’s SessionOrigin. Default off: the origin holds only the IP’s /24 (IPv4) or /48 (IPv6) network and the ClientSummary without city, which is enough for a “your devices” page.

pub fn shadow_dedup_window(self, window: Duration) -> Self

Shadow event dedup window. Default 10 minutes. Zero records every shadow event.

pub fn alert_dedup_window(self, window: Duration) -> Self

Per-subject alert dedup window. Default zero (off).

When set, the hook sees at most one enforced security-relevant event per subject and kind per window, across processes through SessionStore::claim_event with ClaimScope::Subject. Use it so an attacker hammering many sessions of one subject pages its owner once instead of once per session. Every event is still logged and stored; login, logout and step-up completion always reach the hook.

pub fn max_header_len(self, len: usize) -> Self

Maximum header value length considered. Longer values are truncated. Default 512.

pub fn token_prefix(self, prefix: impl Into<String>) -> Self

Prefix for issued tokens, such as "sess_". Default none.

The cookie value becomes the prefix followed by the usual 43 characters, and any presented token without the prefix is rejected before the store is consulted. Use it to tell browser sessions apart from other credentials at a glance (for example pat_ and svc_ API keys handled elsewhere), and to let secret scanners recognise leaked tokens. The prefix is not secret and is not part of the stored hash.

pub fn build(self) -> Result<GuardConfig, ConfigError>

Validates and builds.

Errors

ConfigError for invalid cookie attributes, zero or oversized durations, a grace not shorter than the rotation interval, invalid thresholds, header names or token prefix.

Trait Implementations

impl Clone for GuardConfigBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuardConfigBuilder

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

Formats the value using the given formatter.

impl Default for GuardConfigBuilder

fn default() -> Self

Returns the “default value” for a type.