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
13// public:
14pub mod emergency;
15// public:
16pub mod guards;
17pub(crate) mod mfa;
18mod permissions;
19pub(crate) mod recovery;
20pub(crate) mod recovery_admin;
21mod role;
22// `sessions` is `pub(crate)` so the `__integration` test door at
23// `crate::__integration` can re-export individual `pub(crate)`
24// helpers (specifically `hash_token_for_storage`, used by the R4
25// emergency-access integration suite to verify token-hash format
26// parity with R1's consume path). Public re-exports still flow
27// through `pub use sessions::{...}` below — this visibility bump
28// does not change the external API surface.
29pub(crate) mod sessions;
30mod users;
31
32// public:
33pub use mfa::MfaPolicy;
34pub(crate) use permissions::invalidate_user_cache;
35// public:
36pub use permissions::{
37    add_user_to_group, check_permission, create_group, grant_to_group, grant_to_user,
38    init_permission_tables, permissions_for_user, register_model_permissions,
39    remove_user_from_group, Permission, PermissionError, Superuser,
40};
41// public:
42pub use recovery::{
43    DefaultPasswordPolicy, DefaultRecoveryPolicy, LoginThrottle, PasswordPolicy,
44    PasswordPolicyError, RecoveryPolicy, SharedPasswordPolicy, SharedRecoveryPolicy,
45};
46// `issue_reset_token` / `consume_reset_token` and the `IssueOutcome` /
47// `ConsumeOutcome` / `MailerEmailStatus` types live in `recovery`
48// (`pub(crate) mod recovery`) so the admin handlers in commit #8+
49// reach them as `crate::auth::recovery::*`. They are intentionally
50// NOT re-exported here — the framework owns the handler shape, and
51// projects compose recovery via the trait surfaces re-exported above.
52// `purge_expired_reset_tokens` (R1 commit #12) is reached the same
53// way from `background::spawn_session_sweeper`.
54// public:
55pub use role::{protected_roles, Role};
56// public:
57pub use sessions::{
58    create_session, current_session_id, delete_session, identity_from_session, init_session_tables,
59    invalidate_sessions, list_active_for_user, logout_session, purge_expired_sessions,
60    session_token_from_cookie, InvalidationOutcome, Session, SessionInvalidationReason,
61    SessionTarget, SessionTrust, SESSION_COOKIE,
62};
63// public:
64#[allow(deprecated)]
65pub use users::would_orphan_developers;
66// public:
67pub use users::{
68    create_user, find_user_by_email, hash_password, init_user_tables, load_user_profile, login,
69    migrate_user_schema, set_password, update_user_role, verdict_for_orphan_role, verify_password,
70    would_orphan_protected, would_orphan_role, Identity, StoredUser, UserProfile,
71};
72
73use crate::error::Result;
74use crate::orm::Db;
75
76// public:
77/// Initialise every auth-related table. Safe to call on every boot.
78pub async fn init_tables(db: &Db) -> Result<()> {
79    init_user_tables(db).await?;
80    migrate_user_schema(db).await?;
81    init_session_tables(db).await?;
82    sessions::migrate_session_schema(db).await?;
83    sessions::migrate_session_lifecycle(db).await?;
84    init_permission_tables(db).await?;
85    // R1 (0.5.0) — self password recovery schema. See
86    // DESIGN_RECOVERY.md §9 for the contract.
87    recovery::migrate_user_recovery_schema(db).await?;
88    recovery::init_recovery_tables(db).await?;
89    // R2 (0.6.0) — organisational recovery schema (lockout columns +
90    // partial index). See DESIGN_R2_ORGANISATIONAL.md §4 for the
91    // contract. Schema is additive and orthogonal to R1's recovery
92    // tables; the runtime that reads these columns lands in later
93    // R2 commits.
94    recovery_admin::migrate_user_lockout_schema(db).await?;
95    // R3 (0.7.0) — TOTP MFA schema (4 additive columns on
96    // rustio_users + new rustio_mfa_backup_codes table + partial
97    // index). See DESIGN_R3_MFA.md §7 for the contract. Schema
98    // is additive and orthogonal to R1 / R2; the encryption
99    // helpers, TOTP RFC 6238 implementation, enrolment /
100    // verification / disable runtime, and login-flow integration
101    // land in later R3 commits.
102    mfa::migrate_user_mfa_schema(db).await?;
103    // R2 (0.6.0) — surfaced by the testcontainers integration suite:
104    // `rustio_admin_actions` was previously created lazily on first
105    // dashboard hit (`handlers::ensure_audit_ready`), so any audit-
106    // emitting path that ran BEFORE someone visited `/admin` would
107    // fail. The R2 audit-heavy paths (auto-throttle, admin reset,
108    // admin lock/unlock/revoke, forced rotation) made this latent
109    // issue routinely reachable. Creating the table eagerly during
110    // boot closes the gap; `ensure_table` is already idempotent so
111    // this is safe to call alongside the lazy path that still
112    // exists in the dashboard handler.
113    crate::admin::audit::ensure_table(db).await?;
114    Ok(())
115}
rustio_admin/auth/mod.rs

rustio_admin/auth/
mod.rs
