Struct AuthConfig

pub struct AuthConfig<'a> {
    pub cookie_name: &'a str,
    pub persistent_secret: Key,
    pub token_config: Option<TokenConfig>,
    pub cookie_expires: Option<Duration>,
}

Configuration for AuthLayer and AuthMiddleware.

Fields

cookie_name: &'a str

The cookie name

This is the name of the cookie stored in the clients’ browsers.

persistent_secret: Key

A long lived secret used to sign cookies set to the users.

The secret is not shared with users.

All issued session keys are valid as long as the persistent secret is unchanged. There is no mechanism to invalidate individual sessions.

token_config: Option<TokenConfig>

The authentication token value and its configuration.

Set to None if the entire connection is trusted (e.g. it is on a loopback interface). In this case, token checking is disabled but still SessionKey is still provided by AuthMiddleware.

cookie_expires: Option<Duration>

If set, the newly set cookie has an Expires field which corresponds the value set in expires. If not set, the cookie does not have an “Expires” (or “Max-Age”) field and consequently is typically stored as a “session cookie” and thus saved only until the browser quits.

Note that this does not limit the validity duration of the session key. All issued session keys are valid as long as the persistent secret is unchanged. There is no mechanism to invalidate individual sessions.

Implementations

impl AuthConfig<'_>

pub fn into_layer(self) -> AuthLayer

Convert Self to an AuthLayer.

Trait Implementations

impl<'a> Clone for AuthConfig<'a>

fn clone(&self) -> AuthConfig<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AuthConfig<'a>

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

Formats the value using the given formatter.

impl Default for AuthConfig<'_>

fn default() -> Self

Returns the “default value” for a type.