Struct Auth 

pub struct Auth { /* private fields */ }

Login, registration, password reset and email verification pages, and the users, password_reset_tokens and personal_access_tokens tables.

Routes: login, register (unless without_registration), logout, password.request, password.email, password.reset, password.update, password.confirm, verification.notice, verification.verify and verification.send. Auth::account adds account.show, account.profile, account.password, account.logout_others and account.destroy; Auth::notifications adds the notifications.* routes. docs/authorization.md lists each one’s method and address. The pages live in renox/auth/*.html, inside renox/auth/layout.html; create a file with the same name under your views to replace one.

Failed logins lock out 5 tries per email and IP a minute, 20 per email in 15 minutes from any IP, and 50 per IP in 15 minutes for any email (set TRUSTED_PROXIES behind a proxy). Logging out ends this device’s session only; a new password or a password reset ends the other sessions.

Implementations

impl Auth

pub fn new() -> Self

Registration on, account pages and email verification off, the default Password policy.

pub fn notifications(self) -> Self

Turns on the in-app notification list for the UI kit’s notification_bell: the notifications.* routes (a page that is also the bell’s panel, mark read or unread, delete, and a stream of Server-Sent Events for new ones), and unread_notifications (the logged-in user’s unread count) in every view.

App::new().module(Auth::new().notifications())

pub fn registration_rules( self, rules: impl Fn(&Registration, &mut Validator) + Send + Sync + 'static, ) -> Self

Validates fields the app adds to the registration form, with the built-in ones. Their errors show next to the inputs like any other.

Auth::new()
    .registration_rules(|form, v| {
        v.field("phone", &form.get("phone")).required().max(20);
    })
    .on_registered(|mut user, form, state| async move {
        // `phone` and `role` are columns the app added to `users`.
        user.set(&state.db, "phone", form.get("phone")).await?;
        let first = User::query().count(&state.db).await? == 1;
        user.set(&state.db, "role", if first { "admin" } else { "member" }).await
    })

pub fn on_registered<F, Fut>(self, hook: F) -> Self

where F: Fn(User, Registration, AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result> + Send + 'static,

Runs after a new user is saved and before they’re logged in, e.g. to save the app’s own fields or give a role. If it fails, the user is deleted again and the visitor gets the error, so they can try again.

pub fn verify_email(self) -> Self

Emails new users a verification link. Guard routes that need a verified address with Routes::require_verified().

pub fn password_rules(self, policy: Password) -> Self

What passwords must contain on the register, reset and account forms; Password::min(8) by default.

use renox::validation::Password;
Auth::new().password_rules(Password::min(12).mixed_case().numbers())

pub fn account(self) -> Self

Adds the account page (/account, route account.show): change name and email (a new email must be verified again with verify_email), change the password, log out other devices, delete the account. The last two ask for the password. Override the page at resources/views/renox/auth/account.html.

pub fn without_registration(self) -> Self

Hides /register, e.g. for back-office apps where an admin adds users.

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

Where to go after logging in or registering when no page asked for the login. Defaults to the home route, or /.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Auth

fn default() -> Self

Returns the “default value” for a type.

impl Module for Auth

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

The module’s name, shown by route:list.

fn migrations(&self) -> &'static [Migration]

Migrations this module owns, e.g. renox::migrations!("src/app/products/migrations").

fn register(&self, app: &mut Registry)

Registers the module’s jobs, event listeners and scheduled tasks.

fn routes(&self) -> Routes

The module’s routes; none by default.