Skip to main content

sova_auth/
lib.rs

1//! Fortify-style authentication for Sova (register, verify, reset, 2FA, RBAC).
2//!
3//! Builds on [`sova_passport`] (session login) + [`sova_db`]. Enable feature `mail`
4//! (and install [`sova_mail::Mail`]) for email verification / password reset.
5//!
6//! ```ignore
7//! use sova_auth::{AuthMigrator, Feature, Fortify};
8//! // Facade re-exports the same enum as `AuthFeature`.
9//! // Fortify::new() enables Registration only; add mail-backed features explicitly.
10//!
11//! app.install(Db::from_env().migrations::<AuthMigrator>());
12//! app.install(memory_sessions());
13//! app.install(Mail::from_env()); // required for ResetPasswords / EmailVerification
14//! app.install(
15//!   Fortify::new()
16//!     .features([Feature::Registration, Feature::ResetPasswords, /* … */])
17//!     .api_mount("/api/auth")
18//!     .login_redirect("/login")
19//!     .home("/cabinet"),
20//! );
21//! cabinet.use_middleware(Fortify::guard());
22//!
23//! // Programmatic login (impersonation / seed / admin switch):
24//! let cu = load_current_user(db, id).await?.unwrap();
25//! req.login_user(cu);   // regenerates session + passport:user
26//! req.logout_user();
27//! ```
28
29mod actions;
30mod feature;
31mod forms;
32mod guard;
33#[cfg(feature = "mail")]
34mod mail;
35mod migration;
36mod paths;
37mod plugin;
38mod policy;
39mod events;
40mod state;
41mod store;
42mod token;
43mod two_factor;
44
45#[cfg(feature = "activity")]
46mod activity_log;
47
48pub mod entity;
49
50#[cfg(feature = "testing")]
51pub mod testing;
52
53#[cfg(feature = "mail")]
54pub use mail::{send_reset, send_verify, ResetPasswordMail, VerifyEmailMail};
55pub use feature::Feature;
56pub use guard::AuthExt;
57pub use events::{UserLoggedIn, UserRegistered};
58pub use migration::AuthMigrator;
59pub use paths::FortifyPaths;
60pub use plugin::Fortify;
61pub use policy::{Ability, Policy};
62pub use store::{
63    assign_role, create_permission, create_role, delete_permission, delete_role, find_user_by_email,
64    find_user_by_id, list_permissions, list_roles, load_current_user, mark_email_verified,
65    register_user, revoke_role, set_avatar, set_user_roles, sync_role_permissions, update_permission,
66    update_role, user_ids_with_permission, user_ids_with_role, CurrentUser,
67};
68pub use token::{make_verify_token, parse_verify_token};
69
70#[cfg(feature = "vld")]
71pub use forms::{
72    ConfirmPasswordForm, DisableTwoFactorForm, ForgotForm, LoginForm, PasswordForm, ProfileForm,
73    RegisterForm, ResetForm, TwoFactorCodeForm,
74};