Skip to main content

rustio_admin/auth/
mod.rs

1//! Authentication & authorization.
2//!
3//! Three pieces:
4//! - `users.rs`       — user records, password hashing, login
5//! - `sessions.rs`    — DB-backed sessions with expiry cleanup
6//! - `permissions.rs` — granular permissions + groups
7//!
8//! A user belongs to zero or more groups. Permissions come from two
9//! sources: (a) direct assignments on the user, (b) inherited from
10//! the user's groups. The permission string is
11//! `<app>.<action>_<model>` — e.g. `posts.change_post`.
12
13pub mod guards;
14mod permissions;
15pub(crate) mod recovery;
16pub(crate) mod recovery_admin;
17mod role;
18mod sessions;
19mod users;
20
21pub(crate) use permissions::invalidate_user_cache;
22pub use permissions::{
23    add_user_to_group, check_permission, create_group, grant_to_group, grant_to_user,
24    init_permission_tables, permissions_for_user, register_model_permissions,
25    remove_user_from_group, Permission, PermissionError, Superuser,
26};
27pub use recovery::{
28    DefaultPasswordPolicy, DefaultRecoveryPolicy, LoginThrottle, PasswordPolicy,
29    PasswordPolicyError, RecoveryPolicy, SharedPasswordPolicy, SharedRecoveryPolicy,
30};
31// `issue_reset_token` / `consume_reset_token` and the `IssueOutcome` /
32// `ConsumeOutcome` / `MailerEmailStatus` types live in `recovery`
33// (`pub(crate) mod recovery`) so the admin handlers in commit #8+
34// reach them as `crate::auth::recovery::*`. They are intentionally
35// NOT re-exported here — the framework owns the handler shape, and
36// projects compose recovery via the trait surfaces re-exported above.
37// `purge_expired_reset_tokens` (R1 commit #12) is reached the same
38// way from `background::spawn_session_sweeper`.
39pub use role::{protected_roles, Role};
40pub use sessions::{
41    create_session, current_session_id, delete_session, identity_from_session, init_session_tables,
42    invalidate_sessions, list_active_for_user, logout_session, purge_expired_sessions,
43    session_token_from_cookie, InvalidationOutcome, Session, SessionInvalidationReason,
44    SessionTarget, SessionTrust, SESSION_COOKIE,
45};
46#[allow(deprecated)]
47pub use users::would_orphan_developers;
48pub use users::{
49    create_user, find_user_by_email, hash_password, init_user_tables, load_user_profile, login,
50    migrate_user_schema, set_password, update_user_role, verdict_for_orphan_role, verify_password,
51    would_orphan_protected, would_orphan_role, Identity, StoredUser, UserProfile,
52};
53
54use crate::error::Result;
55use crate::orm::Db;
56
57/// Initialise every auth-related table. Safe to call on every boot.
58pub async fn init_tables(db: &Db) -> Result<()> {
59    init_user_tables(db).await?;
60    migrate_user_schema(db).await?;
61    init_session_tables(db).await?;
62    sessions::migrate_session_schema(db).await?;
63    sessions::migrate_session_lifecycle(db).await?;
64    init_permission_tables(db).await?;
65    // R1 (0.5.0) — self password recovery schema. See
66    // DESIGN_RECOVERY.md §9 for the contract.
67    recovery::migrate_user_recovery_schema(db).await?;
68    recovery::init_recovery_tables(db).await?;
69    // R2 (0.6.0) — organisational recovery schema (lockout columns +
70    // partial index). See DESIGN_R2_ORGANISATIONAL.md §4 for the
71    // contract. Schema is additive and orthogonal to R1's recovery
72    // tables; the runtime that reads these columns lands in later
73    // R2 commits.
74    recovery_admin::migrate_user_lockout_schema(db).await?;
75    // R2 (0.6.0) — surfaced by the testcontainers integration suite:
76    // `rustio_admin_actions` was previously created lazily on first
77    // dashboard hit (`handlers::ensure_audit_ready`), so any audit-
78    // emitting path that ran BEFORE someone visited `/admin` would
79    // fail. The R2 audit-heavy paths (auto-throttle, admin reset,
80    // admin lock/unlock/revoke, forced rotation) made this latent
81    // issue routinely reachable. Creating the table eagerly during
82    // boot closes the gap; `ensure_table` is already idempotent so
83    // this is safe to call alongside the lazy path that still
84    // exists in the dashboard handler.
85    crate::admin::audit::ensure_table(db).await?;
86    Ok(())
87}