Struct AuthFlows 

pub struct AuthFlows { /* private fields */ }

Available on crate feature crypto and crate feature mailer and crate feature serde and non-WebAssembly only.

The auth flows. A middleware: app.wrap(auth), after (inside) FlashLayer and CsrfLayer, which must see the pages it draws. See the module docs.

Implementations

impl AuthFlows

pub fn new( secret: &[u8], base_url: &str, store: impl UserStore + 'static, mailer: impl Deliver + 'static, ) -> Self

secret signs sessions and links: at least 32 random bytes, the same on every replica, kept out of the code. base_url (https://example.com) starts the links in emails — never taken from the request’s Host.

Panics

When secret is shorter than 32 bytes.

pub fn with_arcs( secret: &[u8], base_url: &str, store: Arc<dyn UserStore>, mailer: Arc<dyn Deliver>, ) -> Self

new with shared store and mailer.

pub fn prefix(self, prefix: &str) -> Self

Where the flows live (default /auth).

pub fn app_name(self, name: &str) -> Self

The app’s name in emails (default “the app”).

pub fn require_confirmation(self, require: bool) -> Self

Refuse to sign in an account until its email is confirmed (default: sign in at once; the confirmation email is sent either way).

pub fn min_password_length(self, n: usize) -> Self

The shortest password accepted (default 8).

pub fn session_ttl(self, ttl: Duration) -> Self

How long a session lasts (default 30 days).

pub fn cookie_name(self, name: &str) -> Self

The session cookie’s name (default rws_auth).

pub fn secure_cookie(self, secure: bool) -> Self

Mark the session cookie Secure (default: when the base URL is https).

pub fn after_login(self, path: &str) -> Self

Where a form sign-in, sign-up or reset lands (default /).

pub fn after_logout(self, path: &str) -> Self

Where a form sign-out lands (default /).

pub fn rate_limit(self, max: u32, window_secs: u64) -> Self

At most max sign-ins, sign-ups and email requests per client IP per window_secs (default 10 a minute); max = 0 turns the limit off.

pub fn on_signup(self, hook: impl Fn(&AuthUser) + Send + Sync + 'static) -> Self

Call hook with each new account, after it’s created (a welcome email, a default workspace). Runs on the request’s thread: enqueue anything slow.

pub fn templates(self, engine: Arc<TeraEngine>) -> Self

Available on crate feature tera only.

Render the pages from engine’s auth/login.html, auth/signup.html, auth/forgot.html, auth/reset.html and the emails from auth/mail/confirm.{txt,html}, auth/mail/reset.{txt,html} — each that exists; the built-in ones otherwise (tera feature).

pub fn session_cookie(&self, user: &AuthUser) -> String

A session cookie for user (Set-Cookie value): sign someone in from your own handler.

pub fn session_user(&self, request: &Request) -> Option<AuthUser>

The account request’s session cookie belongs to — valid signature, not expired, password unchanged since.

Trait Implementations

impl Clone for AuthFlows

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Middleware for AuthFlows

fn is_passthrough( &self, request: &Request, _connection: &ConnectionInfo, ) -> bool

Nothing to check or strip: no cookie of ours, no identity headers, not a flow path. Async handlers then stay async.

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn layer_name(&self) -> &'static str

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer never reads request.body, so the inner application may receive it as a stream (Application::streams_body). A layer that inspects the body (CSRF tokens in a form, request signatures, rewriting) must keep the default false: it would see an empty body.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.