Struct SessionConfig 

#[non_exhaustive]
pub struct SessionConfig {
    pub session_ttl_secs: u64,
    pub cookie_name: String,
    pub validate_fingerprint: bool,
    pub touch_interval_secs: u64,
    pub max_sessions_per_user: usize,
}

Configuration for the session middleware.

Deserialised from the session key in the application YAML config. All fields have defaults, so an empty session: block is valid.

YAML example

session:
  session_ttl_secs: 2592000   # 30 days
  cookie_name: "_session"
  validate_fingerprint: true
  touch_interval_secs: 300    # 5 minutes
  max_sessions_per_user: 10

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_ttl_secs: u64

Session lifetime in seconds. Defaults to 2_592_000 (30 days).

cookie_name: String

Name of the session cookie. Defaults to "_session".

validate_fingerprint: bool

When true, the middleware rejects requests whose browser fingerprint does not match the one recorded at login. Defaults to true.

touch_interval_secs: u64

Minimum interval between last_active_at updates, in seconds. A session is only touched when at least this many seconds have elapsed since the last touch. Defaults to 300 (5 minutes).

max_sessions_per_user: usize

Maximum number of concurrent active sessions per user. When exceeded, the least-recently-used session is evicted. Must be greater than zero. Defaults to 10.

Trait Implementations

impl Clone for SessionConfig

fn clone(&self) -> SessionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfig

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

Formats the value using the given formatter.

impl Default for SessionConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionConfig

where SessionConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.