Skip to main content

GuardConfig

Struct GuardConfig 

Source
pub struct GuardConfig { /* private fields */ }
Expand description

Validated guard configuration. Build with GuardConfig::builder or take the Default.

Implementations§

Source§

impl GuardConfig

Source

pub fn builder() -> GuardConfigBuilder

Starts from the defaults.

Source

pub fn cookie(&self) -> &CookieConfig

Cookie attributes.

Source

pub fn session_lifetime(&self) -> Duration

Absolute session lifetime.

Source

pub fn idle_timeout(&self) -> Duration

Inactivity after which a session expires.

Source

pub fn trusted_proxies(&self) -> &[IpNet]

Proxies whose X-Forwarded-For is honoured.

Source

pub fn tls_fingerprint_header(&self) -> Option<&str>

Request header carrying a TLS fingerprint (e.g. JA4) set by the proxy, lowercase.

Source

pub fn rotation(&self) -> RotationConfig

Rotation settings.

Source

pub fn checks(&self) -> &Checks

Default checks (routes can override).

Source

pub fn thresholds(&self) -> Thresholds

Score thresholds.

Source

pub fn mode(&self) -> Mode

Enforcement mode.

Source

pub fn step_up_policy(&self) -> StepUpPolicy

What a step-up decision does.

Source

pub fn ping_pong_window(&self) -> Duration

Window in which returning to the previous network counts as ping-pong.

Source

pub fn last_seen_write_interval(&self) -> Duration

How stale last_seen may get before an otherwise unchanged request writes it.

Source

pub fn event_retention(&self) -> Duration

How long events are kept before Guard::purge_expired deletes them.

Source

pub fn minimize_stored_events(&self) -> bool

Whether the store gets a reduced copy of each event; see GuardConfigBuilder::minimize_stored_events.

Source

pub fn keep_origin_client(&self) -> bool

Whether a session’s origin keeps the full IP, User-Agent and city; see GuardConfigBuilder::keep_origin_client.

Source

pub fn shadow_dedup_window(&self) -> Duration

Window in which repeated shadow events for the same session and kind are dropped.

Source

pub fn alert_dedup_window(&self) -> Duration

Window in which repeated security alerts for the same subject and kind skip the hook. Zero means off.

Source

pub fn max_header_len(&self) -> usize

Maximum length of a header value considered for fingerprinting.

Source

pub fn token_prefix(&self) -> Option<&str>

Prefix of issued tokens, if any.

Source

pub fn orphan_reissue_window(&self) -> Option<Duration>

How long after being superseded an orphaned token is still reissued, if limited.

Trait Implementations§

Source§

impl Clone for GuardConfig

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 GuardConfig

Source§

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

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

impl Default for GuardConfig

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

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoApi for T

Source§

fn into_api<A>(self) -> UseApi<T, A>
where T: Sized,

into UseApi
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
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<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