Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
    pub auth_token_ttl: Duration,
    pub refresh_token_ttl: Duration,
    pub proactive_renewal_window: Duration,
    pub renewal_lease_ttl: LeaseTtl,
    pub clock_skew_tolerance: Duration,
}
Expand description

Configuration for session issuance and renewal behavior.

This type intentionally stays free of HTTP-specific concerns such as cookie names, headers, or response mutation. Adapter crates should translate these values into transport-specific behavior at the system edge.

§Examples

use std::time::Duration;
use webgates_sessions::config::SessionConfig;
use webgates_sessions::lease::LeaseTtl;

// Use defaults for a typical production setup.
let config = SessionConfig::default();
assert!(config.is_valid());

// Or supply explicit values.
let config = SessionConfig::new(
    Duration::from_secs(15 * 60),     // auth token TTL: 15 min
    Duration::from_secs(30 * 24 * 3600), // refresh token TTL: 30 days
    Duration::from_secs(2 * 60),      // proactive renewal window: 2 min
    LeaseTtl::new(Duration::from_secs(30)),
    Duration::from_secs(5),           // clock-skew tolerance: 5 s
)
.validate()
.unwrap();

assert!(config.is_valid());

Fields§

§auth_token_ttl: Duration

Lifetime of the short-lived authentication token.

§refresh_token_ttl: Duration

Lifetime of the long-lived refresh token.

§proactive_renewal_window: Duration

Window before auth-token expiry during which proactive renewal is allowed.

§renewal_lease_ttl: LeaseTtl

Typed duration for which a renewal lease remains valid once acquired.

§clock_skew_tolerance: Duration

Maximum amount of clock skew tolerated by renewal decision logic.

Implementations§

Source§

impl SessionConfig

Source

pub const fn new( auth_token_ttl: Duration, refresh_token_ttl: Duration, proactive_renewal_window: Duration, renewal_lease_ttl: LeaseTtl, clock_skew_tolerance: Duration, ) -> Self

Creates a configuration with explicit values.

Source

pub fn renewal_lease_duration(&self) -> Duration

Returns the configured lease TTL as a raw duration.

Source

pub fn validate(self) -> ConfigResult<Self>

Validates the configuration and returns the typed value when it is internally consistent.

§Errors

Returns a configuration error when one of the required durations is zero or when the proactive renewal window exceeds the auth-token lifetime.

Source

pub fn is_valid(&self) -> bool

Returns true when the configuration is internally consistent.

Trait Implementations§

Source§

impl Clone for SessionConfig

Source§

fn clone(&self) -> SessionConfig

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 SessionConfig

Source§

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

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

impl Default for SessionConfig

Source§

fn default() -> Self

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

impl PartialEq for SessionConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for SessionConfig

Source§

impl StructuralPartialEq for SessionConfig

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

Source§

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

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