c51af68432
Benchmark-gated (benches/ROUND10.md; every change carries a BEFORE/AFTER harness with equivalence/safety gates — two designs were rejected or rewritten by their own benches before adoption): - Auth hot path: TokenClaims/CurrentUser display fields to Arc<str>, role to inline SmolStr end-to-end (Bearer, cookie, Basic-auth cache) — 4→1 allocs per authenticated request, 3→0 per warm DAV request; JWT Encoding/Decoding/Validation built once. - Cold shared-album herd: leader-inline parent batching in PgAclEngine (+ cascade try_get_with single-flight) — 100→2 parent queries per 100-thumb cold herd, herd wall 1.9x, sequential + warm paths unchanged, all ROUND8/9 safety gates plus new herd-equivalence gates. - Query-shape pack: share download double-fetch 2→1 (2.18x), contact-group COUNT(*) 14.9x, save_faces UNNEST 3.9x, playlist reorder UNNEST 63.7x (now atomic), search files∥folders join! 1.45x, move drive-lookup join! 2.14x, trash partial (drive_id, trashed_at) indexes, CalDAV event-gate narrow read, favorites/recents binary-decode port, dead count_files removed. - NC surface: preview + avatar honour If-None-Match (e2e: 5 KB and 197 KB → 0 bytes per revalidation), avatar WebP→PNG transcode memoised, PROPFIND/trashbin integer+date emits on stack formatters, folder-header enrichment join!, chunk-PUT retry stat folded into create_new open. - common::fmt integer rendering rewritten on the std 2-digit LUT after the round's own bench caught the div-loop losing to to_string (16.1 ns vs 22.5; speeds every prior-round call site). - Micro-pack: WebDAV scope probe borrow-only, ShareService base_url snapshot, cookie_secure OnceLock, Arc'd AES-GCM cipher, stack request-id, tantivy analyzer clone dropped. - SPA: search stale-guard + AbortController (10→1 completed round-trips, stale-clobber gone), getFolder in-flight dedup, gridColumns matchMedia hoist (10k→0 style reads). Backend: cargo fmt + clippy -D warnings clean, 524 tests green. Frontend: npm run check clean, 301 vitest green. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018DdM7V7M3QPW7HEHg3gLov
872 lines
34 KiB
Rust
872 lines
34 KiB
Rust
use chrono::{DateTime, Utc};
|
|
use uuid::Uuid;
|
|
|
|
// Re-export entity errors from the centralized module
|
|
pub use super::entity_errors::{UserError, UserResult};
|
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
// We'll handle conversion manually for now until the type is properly set up in the database
|
|
pub enum UserRole {
|
|
Admin,
|
|
User,
|
|
}
|
|
|
|
impl UserRole {
|
|
/// Canonical wire/DB spelling — the single source the `Display` impl
|
|
/// and every hot-path role render go through (no format machinery).
|
|
pub fn as_str(self) -> &'static str {
|
|
match self {
|
|
UserRole::Admin => "admin",
|
|
UserRole::User => "user",
|
|
}
|
|
}
|
|
}
|
|
|
|
impl std::fmt::Display for UserRole {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
|
|
f.write_str(self.as_str())
|
|
}
|
|
}
|
|
|
|
/// Authorization-relevant account flags, fetched without the heavyweight
|
|
/// profile columns. The full user row drags `image` along — a data URI of
|
|
/// up to 512 KiB — which per-request guards (`require_internal_user`,
|
|
/// `require_admin_user`, the NC Basic Auth external check) must never pay
|
|
/// for just to read a boolean or a role.
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
pub struct UserFlags {
|
|
pub role: UserRole,
|
|
pub is_external: bool,
|
|
pub active: bool,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct User {
|
|
id: Uuid,
|
|
/// Optional handle (2-64 chars, no `@`). NULL for users created via
|
|
/// email-invitation (`is_external = true`) and for users who have
|
|
/// not yet claimed a handle (PR-18 email-only signups). When set, it
|
|
/// must satisfy `validate_username` and must NOT contain `@` —
|
|
/// keeping the username and email namespaces provably disjoint.
|
|
username: Option<String>,
|
|
email: String,
|
|
/// Optional Argon2 password hash. NULL when the user has no password
|
|
/// (externals, OIDC-only users, email-only signups awaiting their
|
|
/// welcome magic-link). After PR 16 this column carries no sentinel
|
|
/// strings — `is_some()` means "real argon2 hash"; `None` means "no
|
|
/// password configured".
|
|
password_hash: Option<String>,
|
|
role: UserRole,
|
|
storage_quota_bytes: i64,
|
|
storage_used_bytes: i64,
|
|
created_at: DateTime<Utc>,
|
|
updated_at: DateTime<Utc>,
|
|
last_login_at: Option<DateTime<Utc>>,
|
|
active: bool,
|
|
oidc_provider: Option<String>,
|
|
oidc_subject: Option<String>,
|
|
image: Option<String>,
|
|
/// TRUE = grant-only external recipient (magic-link, OIDC-only, OCM
|
|
/// federated). FALSE = storage-owning internal user. Hooks that
|
|
/// provision per-user resources (home folder, default calendar, …)
|
|
/// must short-circuit when `is_external` is TRUE — see tip #2 in
|
|
/// `application/ports/user_lifecycle.rs`. The DB CHECK constraint
|
|
/// `users_external_no_storage` is the schema-level safety net.
|
|
is_external: bool,
|
|
/// Optional human-readable first/given name. Populated from OIDC
|
|
/// standard claim `given_name` at JIT provisioning, or via the
|
|
/// profile-edit endpoint. External users start with `None`.
|
|
given_name: Option<String>,
|
|
/// Optional human-readable last/family name. Populated from OIDC
|
|
/// standard claim `family_name` at JIT provisioning, or via the
|
|
/// profile-edit endpoint. External users start with `None`.
|
|
family_name: Option<String>,
|
|
/// When the user demonstrated control of their email address (PR 23).
|
|
/// `None` = unverified. `Some(ts)` = timestamp of the first proof,
|
|
/// preserved across subsequent verifications.
|
|
///
|
|
/// Set on successful magic-link redemption (invitation OR
|
|
/// login-via-email — clicking the link proves the inbox is theirs)
|
|
/// or on OIDC JIT with `email_verified=true` claim. Classic password
|
|
/// signups stay `None` until the user goes through a magic-link
|
|
/// flow. PR 23 ships the signal only — future policy PRs gate
|
|
/// features (uploads, shares, etc.) on this column.
|
|
email_verified_at: Option<DateTime<Utc>>,
|
|
/// User-chosen locale for server-rendered surfaces (transactional
|
|
/// emails, future authenticated HTML pages). `None` = no preference,
|
|
/// resolves to `OXICLOUD_DEFAULT_LOCALE` at use time. Set by:
|
|
/// - the frontend language switcher (PATCH /api/auth/me/profile),
|
|
/// - the OIDC JIT path at provisioning **only**, never re-applied
|
|
/// on subsequent logins (a UI choice always wins over the IdP),
|
|
/// - the magic-link invitation flow, which copies the inviter's
|
|
/// value into the new external user's row.
|
|
///
|
|
/// Schema-level CHECK enforces a textual BCP-47 shape; the
|
|
/// application layer is the authoritative gatekeeper against the
|
|
/// `LocaleRegistry`.
|
|
preferred_locale: Option<String>,
|
|
/// Per-user opt-out for share-notification emails (PR N1). TRUE =
|
|
/// receive a mail when someone grants access to a resource (default);
|
|
/// FALSE = grant still recorded but `RecipientNotificationService`
|
|
/// returns `NotApplicable { recipient_opted_out }` and no mail is
|
|
/// sent. Bypassed for magic-link first-invitations to external users
|
|
/// — the link is their only way to claim the share, so suppressing
|
|
/// it would lock them out. Once an external becomes a real account
|
|
/// and opts out, subsequent shares from other granters honor the
|
|
/// flag.
|
|
notify_on_share: bool,
|
|
/// Opaque UI preferences bag (PR — this session). Stored as JSONB
|
|
/// on `auth.users.ui_preferences`; the server NEVER inspects the
|
|
/// contents. This is the SPA's cross-device backing store for pure
|
|
/// UI toggles (hide-dotfiles, view mode, sidebar collapse, …).
|
|
///
|
|
/// Merge semantics live in the repo layer: `PATCH /me/profile` does
|
|
/// a SHALLOW merge via `ui_preferences || $1::jsonb`, so partial
|
|
/// writes from one device don't clobber keys set on another.
|
|
///
|
|
/// Load-bearing rule: if a preference EVER becomes something the
|
|
/// server reads (like `preferred_locale` did), promote it out of
|
|
/// this bag into a typed column. Keep this field for UI-only
|
|
/// toggles.
|
|
///
|
|
/// Invariant: always a JSON object (enforced by the schema CHECK
|
|
/// `users_ui_preferences_is_object`). Empty bag is `{}`, never
|
|
/// `null` or missing.
|
|
ui_preferences: serde_json::Value,
|
|
}
|
|
|
|
impl User {
|
|
/// Create a new user.
|
|
///
|
|
/// One unified constructor for every kind of user (internal, OIDC-linked,
|
|
/// external). The credential slots and the `is_external` marker are all
|
|
/// caller-controlled — what makes a user "OIDC" is `oidc_subject =
|
|
/// Some(_)`, what makes them "external" is `is_external = true`. There
|
|
/// are no hidden sentinel values; an absent credential is `None`.
|
|
///
|
|
/// # Arguments
|
|
/// * `email` — required, must satisfy `validate_email`
|
|
/// * `username` — optional handle (2-64 chars, no `@`)
|
|
/// * `password_hash` — pre-hashed via PasswordHasherPort, or `None` if
|
|
/// the user has no password yet (magic-link or OIDC bootstrap)
|
|
/// * `oidc_provider`, `oidc_subject` — both `Some` when the user is
|
|
/// linked to an external IdP, both `None` otherwise
|
|
/// * `role` — `Admin` is rejected when `is_external = true` (mirrors the
|
|
/// `users_external_not_admin` DB CHECK constraint)
|
|
/// * `storage_quota_bytes` — caller-set; external callers should pass 0
|
|
/// to satisfy the `users_external_no_storage` invariant
|
|
/// * `is_external` — TRUE for grant-only recipients (magic-link, OCM)
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub fn new(
|
|
email: String,
|
|
username: Option<String>,
|
|
password_hash: Option<String>,
|
|
oidc_provider: Option<String>,
|
|
oidc_subject: Option<String>,
|
|
role: UserRole,
|
|
storage_quota_bytes: i64,
|
|
is_external: bool,
|
|
) -> UserResult<Self> {
|
|
Self::validate_email(&email)?;
|
|
if let Some(ref u) = username {
|
|
Self::validate_username(u)?;
|
|
}
|
|
if let Some(ref h) = password_hash
|
|
&& h.is_empty()
|
|
{
|
|
return Err(UserError::InvalidPassword(
|
|
"Password hash cannot be empty".to_string(),
|
|
));
|
|
}
|
|
// Schema-level CHECKs are mirrored at the entity layer so callers
|
|
// get a typed error instead of an opaque DB rejection.
|
|
if is_external && matches!(role, UserRole::Admin) {
|
|
return Err(UserError::ValidationError(
|
|
"External users cannot hold the admin role".to_string(),
|
|
));
|
|
}
|
|
if is_external && storage_quota_bytes != 0 {
|
|
return Err(UserError::ValidationError(
|
|
"External users must have storage_quota_bytes = 0".to_string(),
|
|
));
|
|
}
|
|
// OIDC linkage is all-or-nothing: both provider and subject set,
|
|
// or neither. The DB has a UNIQUE index on (provider, subject)
|
|
// WHERE both non-NULL; partial state would corrupt that.
|
|
if oidc_provider.is_some() != oidc_subject.is_some() {
|
|
return Err(UserError::ValidationError(
|
|
"oidc_provider and oidc_subject must both be set or both be None".to_string(),
|
|
));
|
|
}
|
|
|
|
let now = Utc::now();
|
|
Ok(Self {
|
|
id: Uuid::new_v4(),
|
|
username,
|
|
email,
|
|
password_hash,
|
|
role,
|
|
storage_quota_bytes,
|
|
storage_used_bytes: 0,
|
|
created_at: now,
|
|
updated_at: now,
|
|
last_login_at: None,
|
|
active: true,
|
|
oidc_provider,
|
|
oidc_subject,
|
|
image: None,
|
|
is_external,
|
|
given_name: None,
|
|
family_name: None,
|
|
// PR 23: unverified at creation. Stamped on the first
|
|
// magic-link redemption or OIDC JIT (where the IdP has
|
|
// already confirmed the email).
|
|
email_verified_at: None,
|
|
// PR C: no locale preference at creation. OIDC JIT, the
|
|
// language switcher, or invitation-time inheritance fill
|
|
// this in later. NULL resolves to OXICLOUD_DEFAULT_LOCALE.
|
|
preferred_locale: None,
|
|
// PR N1: default to opted-in. The profile checkbox is the
|
|
// user-facing toggle; the column default in
|
|
// `users_notify_on_share` mirrors this for rows reconstructed
|
|
// from disk without going through `new`.
|
|
notify_on_share: true,
|
|
// Empty bag on creation. The SPA writes into it via
|
|
// `PATCH /me/profile { ui_preferences: {...} }` after
|
|
// login. Never NULL — the DB CHECK enforces JSON object
|
|
// shape.
|
|
ui_preferences: serde_json::json!({}),
|
|
})
|
|
}
|
|
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub fn from_data(
|
|
id: Uuid,
|
|
username: Option<String>,
|
|
email: String,
|
|
password_hash: Option<String>,
|
|
role: UserRole,
|
|
storage_quota_bytes: i64,
|
|
storage_used_bytes: i64,
|
|
created_at: DateTime<Utc>,
|
|
updated_at: DateTime<Utc>,
|
|
last_login_at: Option<DateTime<Utc>>,
|
|
active: bool,
|
|
) -> Self {
|
|
Self {
|
|
id,
|
|
username,
|
|
email,
|
|
password_hash,
|
|
role,
|
|
storage_quota_bytes,
|
|
storage_used_bytes,
|
|
created_at,
|
|
updated_at,
|
|
last_login_at,
|
|
active,
|
|
oidc_provider: None,
|
|
oidc_subject: None,
|
|
image: None,
|
|
// `from_data` is the minimal-args reconstruction path used by
|
|
// tests and JWT-claim-based principal hydration (which doesn't
|
|
// carry `is_external`). Default to FALSE — JWT-validated
|
|
// principals are existing internal users; magic-link external
|
|
// sessions take a different path that hydrates from DB via
|
|
// `from_data_full`.
|
|
is_external: false,
|
|
given_name: None,
|
|
family_name: None,
|
|
email_verified_at: None,
|
|
preferred_locale: None,
|
|
notify_on_share: true,
|
|
ui_preferences: serde_json::json!({}),
|
|
}
|
|
}
|
|
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub fn from_data_full(
|
|
id: Uuid,
|
|
username: Option<String>,
|
|
email: String,
|
|
password_hash: Option<String>,
|
|
role: UserRole,
|
|
storage_quota_bytes: i64,
|
|
storage_used_bytes: i64,
|
|
created_at: DateTime<Utc>,
|
|
updated_at: DateTime<Utc>,
|
|
last_login_at: Option<DateTime<Utc>>,
|
|
active: bool,
|
|
oidc_provider: Option<String>,
|
|
oidc_subject: Option<String>,
|
|
image: Option<String>,
|
|
is_external: bool,
|
|
given_name: Option<String>,
|
|
family_name: Option<String>,
|
|
email_verified_at: Option<DateTime<Utc>>,
|
|
preferred_locale: Option<String>,
|
|
notify_on_share: bool,
|
|
// Opaque UI-preferences bag. Callers reading from the DB pass
|
|
// `row.get("ui_preferences")`; tests that don't care can pass
|
|
// `serde_json::json!({})`.
|
|
ui_preferences: serde_json::Value,
|
|
) -> Self {
|
|
Self {
|
|
id,
|
|
username,
|
|
email,
|
|
password_hash,
|
|
role,
|
|
storage_quota_bytes,
|
|
storage_used_bytes,
|
|
created_at,
|
|
updated_at,
|
|
last_login_at,
|
|
active,
|
|
oidc_provider,
|
|
oidc_subject,
|
|
image,
|
|
is_external,
|
|
given_name,
|
|
family_name,
|
|
email_verified_at,
|
|
preferred_locale,
|
|
notify_on_share,
|
|
ui_preferences,
|
|
}
|
|
}
|
|
|
|
// Getters
|
|
pub fn id(&self) -> Uuid {
|
|
self.id
|
|
}
|
|
|
|
/// The user's chosen handle. `None` for users who have not claimed
|
|
/// one (externals, fresh email-only signups). Display callers should
|
|
/// fall back through `given_name`/`family_name` to `email` when this
|
|
/// is `None`.
|
|
pub fn username(&self) -> Option<&str> {
|
|
self.username.as_deref()
|
|
}
|
|
|
|
pub fn email(&self) -> &str {
|
|
&self.email
|
|
}
|
|
|
|
pub fn role(&self) -> UserRole {
|
|
self.role
|
|
}
|
|
|
|
pub fn storage_quota_bytes(&self) -> i64 {
|
|
self.storage_quota_bytes
|
|
}
|
|
|
|
pub fn storage_used_bytes(&self) -> i64 {
|
|
self.storage_used_bytes
|
|
}
|
|
|
|
pub fn created_at(&self) -> DateTime<Utc> {
|
|
self.created_at
|
|
}
|
|
|
|
pub fn updated_at(&self) -> DateTime<Utc> {
|
|
self.updated_at
|
|
}
|
|
|
|
pub fn last_login_at(&self) -> Option<DateTime<Utc>> {
|
|
self.last_login_at
|
|
}
|
|
|
|
pub fn is_active(&self) -> bool {
|
|
self.active
|
|
}
|
|
|
|
/// The Argon2 password hash, or `None` when the user has no password
|
|
/// configured (externals, OIDC-only users, post-PR-18 email-only
|
|
/// signups). `verify_password` callers must short-circuit to
|
|
/// "invalid credentials" when this is `None`.
|
|
pub fn password_hash(&self) -> Option<&str> {
|
|
self.password_hash.as_deref()
|
|
}
|
|
|
|
/// Convenience: does the user have a real password configured?
|
|
pub fn has_password(&self) -> bool {
|
|
self.password_hash.is_some()
|
|
}
|
|
|
|
/// Best-effort label for audit-log interpolation. Returns the
|
|
/// username when set; falls back to the user_id otherwise. Always
|
|
/// implements `Display` (returns `String`) so audit lines can stay
|
|
/// `username = %user.display_for_audit()` regardless of whether the
|
|
/// user has claimed a handle. Reserve this for `target: "audit"`
|
|
/// lines — user-facing display callers should walk the
|
|
/// `username → given/family → email` fallback chain themselves.
|
|
pub fn display_for_audit(&self) -> String {
|
|
match &self.username {
|
|
Some(u) => u.clone(),
|
|
None => self.id.to_string(),
|
|
}
|
|
}
|
|
|
|
/// Rich, user-facing display label for notification surfaces
|
|
/// (transactional emails, share invitations, "Alice <a@x.com>
|
|
/// shared X with you" — anywhere a human is reading the line).
|
|
///
|
|
/// `with_email` controls whether the address is appended as
|
|
/// `" <email>"` after the name part:
|
|
/// - `true` — best for the email **body** ("Alice Smith
|
|
/// <alice@example.com> shared a folder with you"), where the
|
|
/// extra identifier is helpful at a glance.
|
|
/// - `false` — best for the **subject line** and other compact
|
|
/// contexts where dragging the email into a 80-char inbox row
|
|
/// would be noise ("Alice Smith shared a folder with you").
|
|
///
|
|
/// Priority order (mirrors RFC 5322 display-name conventions). The
|
|
/// `<email>` decoration in cases 1 and 3 is omitted when
|
|
/// `with_email` is false:
|
|
///
|
|
/// 1. `"Given Family"` (+ ` <email>`) — full name; the most
|
|
/// informative form.
|
|
/// 2. `"username"` (+ ` <email>`) — handle; the typical case
|
|
/// for password / OIDC users without first/last claims.
|
|
/// 3. `email` — last-resort fallback. The
|
|
/// raw email address is always present for non-OCM users and is
|
|
/// the unambiguous identifier. Returned regardless of
|
|
/// `with_email` since it IS the label here.
|
|
/// 4. shortened UUID — failure mode (no email,
|
|
/// no username, no given/family — shouldn't happen with current
|
|
/// schema invariants but kept defensive for OCM-federated rows).
|
|
///
|
|
/// External users provisioned via magic-link typically have only an
|
|
/// email and fall through to branch 3. Internal users with OIDC
|
|
/// JIT often have given/family from the IdP claims → branch 1.
|
|
/// Sister of [`Self::display_for_audit`], which deliberately
|
|
/// returns a *less* identifying label for log lines.
|
|
pub fn display_full(&self, with_email: bool) -> String {
|
|
let g = self.given_name.as_deref();
|
|
let f = self.family_name.as_deref();
|
|
let u = self.username.as_deref();
|
|
let has_email = !self.email.is_empty();
|
|
|
|
if let (Some(g), Some(f)) = (g, f) {
|
|
if with_email && has_email {
|
|
return format!("{} {} <{}>", g, f, self.email);
|
|
}
|
|
return format!("{} {}", g, f);
|
|
}
|
|
if let Some(u) = u {
|
|
if with_email && has_email {
|
|
return format!("{} <{}>", u, self.email);
|
|
}
|
|
return u.to_string();
|
|
}
|
|
if has_email {
|
|
return self.email.clone();
|
|
}
|
|
format!("{}…", &self.id.to_string()[..8])
|
|
}
|
|
|
|
pub fn oidc_provider(&self) -> Option<&str> {
|
|
self.oidc_provider.as_deref()
|
|
}
|
|
|
|
pub fn oidc_subject(&self) -> Option<&str> {
|
|
self.oidc_subject.as_deref()
|
|
}
|
|
|
|
pub fn image(&self) -> Option<&str> {
|
|
self.image.as_deref()
|
|
}
|
|
|
|
/// `TRUE` for grant-only external recipients (magic-link, OIDC-only,
|
|
/// OCM federated). Hooks provisioning per-user resources must
|
|
/// short-circuit when this returns `true` — see tip #2 in
|
|
/// `application/ports/user_lifecycle.rs`.
|
|
pub fn is_external(&self) -> bool {
|
|
self.is_external
|
|
}
|
|
|
|
pub fn given_name(&self) -> Option<&str> {
|
|
self.given_name.as_deref()
|
|
}
|
|
|
|
pub fn family_name(&self) -> Option<&str> {
|
|
self.family_name.as_deref()
|
|
}
|
|
|
|
/// When the user first demonstrated control of their email (PR 23).
|
|
/// `None` = unverified. See `mark_email_verified` for the trigger
|
|
/// points (magic-link redemption, OIDC JIT with verified claim).
|
|
pub fn email_verified_at(&self) -> Option<DateTime<Utc>> {
|
|
self.email_verified_at
|
|
}
|
|
|
|
/// `true` iff the user has demonstrated control of their email.
|
|
/// Convenience wrapper over `email_verified_at().is_some()`.
|
|
pub fn is_email_verified(&self) -> bool {
|
|
self.email_verified_at.is_some()
|
|
}
|
|
|
|
/// Stamp the first proof-of-email-control timestamp. **Idempotent**:
|
|
/// if `email_verified_at` is already `Some`, this is a no-op so
|
|
/// re-verifications preserve the original time. Call from the
|
|
/// magic-link redemption path and from OIDC JIT when the IdP
|
|
/// confirms the email.
|
|
pub fn mark_email_verified(&mut self) {
|
|
if self.email_verified_at.is_none() {
|
|
let now = Utc::now();
|
|
self.email_verified_at = Some(now);
|
|
self.updated_at = now;
|
|
}
|
|
}
|
|
|
|
/// Promote a currently-external user to an internal account.
|
|
/// Atomically flips the invariant-linked fields:
|
|
/// * `is_external` → false
|
|
/// * `password_hash` → provided (Some) or preserved (None)
|
|
/// * `storage_quota_bytes` → quota (external users had 0; DB CHECK
|
|
/// `users_external_no_storage` enforces the pair before this call
|
|
/// and would refuse a non-zero quota on an external row — the
|
|
/// write MUST flip `is_external` first, which happens
|
|
/// transactionally at persist time via the sqlx UPDATE).
|
|
///
|
|
/// Password is `Option<String>` because the service allows password-
|
|
/// less upgrades when magic-link login is available on the
|
|
/// deployment. When `None`, `password_hash` stays as it was (either
|
|
/// NULL, or a hash left over from an admin-created invitation —
|
|
/// externals don't authenticate with it either way).
|
|
///
|
|
/// Refuses if the caller is already internal — the upgrade path
|
|
/// only makes sense on `is_external = true` users. Service pre-
|
|
/// checks `user.is_external()` before calling; this guard is
|
|
/// belt-and-braces against a race.
|
|
///
|
|
/// Admin combo is impossible by construction: external + admin was
|
|
/// refused at creation (see `User::new`), so a promoted external
|
|
/// user always retains their `UserRole::User` — role isn't changed.
|
|
pub fn promote_to_internal(
|
|
&mut self,
|
|
password_hash: Option<String>,
|
|
storage_quota_bytes: i64,
|
|
) -> UserResult<()> {
|
|
if !self.is_external {
|
|
return Err(UserError::AlreadyInternal);
|
|
}
|
|
self.is_external = false;
|
|
if let Some(hash) = password_hash {
|
|
self.password_hash = Some(hash);
|
|
}
|
|
self.storage_quota_bytes = storage_quota_bytes;
|
|
self.updated_at = Utc::now();
|
|
Ok(())
|
|
}
|
|
|
|
pub fn set_image(&mut self, image: Option<String>) {
|
|
self.image = image;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
pub fn set_given_name(&mut self, given_name: Option<String>) {
|
|
self.given_name = given_name;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
pub fn set_family_name(&mut self, family_name: Option<String>) {
|
|
self.family_name = family_name;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
/// Borrow the user's stored locale code (e.g. `"fr"`, `"zh-TW"`),
|
|
/// if any. The application layer is expected to feed this through
|
|
/// `LocaleRegistry::parse_or_default` before rendering, so an
|
|
/// orphaned code from a since-removed locale falls back gracefully
|
|
/// instead of triggering a translation error.
|
|
pub fn preferred_locale(&self) -> Option<&str> {
|
|
self.preferred_locale.as_deref()
|
|
}
|
|
|
|
/// Set or clear the user's preferred locale. The caller is
|
|
/// responsible for having already validated the code against the
|
|
/// `LocaleRegistry` — at the entity layer we treat the field as
|
|
/// opaque text, the way we do for `given_name` / `family_name`.
|
|
/// Passing `None` clears the preference (subsequent renders fall
|
|
/// back to the server default).
|
|
pub fn set_preferred_locale(&mut self, locale: Option<String>) {
|
|
self.preferred_locale = locale;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
/// Whether this user wants to receive an email when someone grants
|
|
/// them access to a resource. `RecipientNotificationService` checks
|
|
/// this on the plain-notification arm; magic-link first-invitations
|
|
/// to external users bypass it (otherwise the recipient could never
|
|
/// claim the share). Defaults TRUE for both the entity constructor
|
|
/// and the schema column.
|
|
pub fn notify_on_share(&self) -> bool {
|
|
self.notify_on_share
|
|
}
|
|
|
|
/// Flip the share-notification preference. The caller is expected
|
|
/// to have already validated input shape (the field is a boolean,
|
|
/// so there is no work beyond storage). Bumps `updated_at`.
|
|
pub fn set_notify_on_share(&mut self, notify: bool) {
|
|
self.notify_on_share = notify;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
/// Opaque UI preferences bag. Read-only accessor for the DTO
|
|
/// conversion; mutation goes through the repo's shallow-merge SQL
|
|
/// (`UserPgRepository::update_ui_preferences`) rather than a
|
|
/// setter here — the DB is authoritative on the merged state
|
|
/// because two devices can PATCH concurrently and the merge has
|
|
/// to happen at write time, not at read time.
|
|
pub fn ui_preferences(&self) -> &serde_json::Value {
|
|
&self.ui_preferences
|
|
}
|
|
|
|
/// Claim or change the username. Runs the same validation as the
|
|
/// constructor — callers must still ensure uniqueness at the repo
|
|
/// level. Bumps `updated_at`. Used by the post-create profile-edit
|
|
/// endpoint so a user who started with `None` can claim a handle
|
|
/// later, or change to a different one. The home folder name is NOT
|
|
/// renamed: it was display text at creation; the folder is owned
|
|
/// by `user_id`.
|
|
pub fn set_username(&mut self, new_username: String) -> UserResult<()> {
|
|
Self::validate_username(&new_username)?;
|
|
self.username = Some(new_username);
|
|
self.updated_at = Utc::now();
|
|
Ok(())
|
|
}
|
|
|
|
/// Unset the username (return to `None`). Use sparingly — most
|
|
/// users keep their handle once claimed. Mainly here so admin
|
|
/// tooling can clear a problematic handle without deleting the
|
|
/// account.
|
|
pub fn clear_username(&mut self) {
|
|
self.username = None;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
/// Returns true if this is an OIDC-only user (no password)
|
|
pub fn is_oidc_user(&self) -> bool {
|
|
self.oidc_provider.is_some()
|
|
}
|
|
|
|
/// Returns true iff this user has any non-magic-link authentication
|
|
/// method available — either a real password hash, or a linked OIDC
|
|
/// subject. Magic-link eligibility for "no other credential" mode is
|
|
/// the negation of this; the `OXICLOUD_MAGIC_LINK_OPEN_TO_PASSWORD_USERS`
|
|
/// flag widens the policy at the service layer (`magic_link_eligibility`).
|
|
pub fn has_login_credential(&self) -> bool {
|
|
self.password_hash.is_some() || self.oidc_subject.is_some()
|
|
}
|
|
|
|
/// Set the password hash. The new password must be hashed externally
|
|
/// via `PasswordHasherPort` before calling this. Passing `None`
|
|
/// clears the password (e.g. when a user opts back into magic-link-only
|
|
/// auth).
|
|
pub fn update_password_hash(&mut self, new_hash: Option<String>) {
|
|
self.password_hash = new_hash;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
// Update storage usage
|
|
pub fn update_storage_used(&mut self, storage_used_bytes: i64) {
|
|
self.storage_used_bytes = storage_used_bytes;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
// Register login
|
|
pub fn register_login(&mut self) {
|
|
let now = Utc::now();
|
|
self.last_login_at = Some(now);
|
|
self.updated_at = now;
|
|
}
|
|
|
|
// Deactivate user
|
|
pub fn deactivate(&mut self) {
|
|
self.active = false;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
// Activate user
|
|
pub fn activate(&mut self) {
|
|
self.active = true;
|
|
self.updated_at = Utc::now();
|
|
}
|
|
|
|
// ── Shared validation helpers ──────────────────────────────────────
|
|
|
|
/// Usernames are 2-64 chars of `[A-Za-z0-9._-]`. The `@` character is
|
|
/// explicitly forbidden — keeping the username and email namespaces
|
|
/// provably disjoint is what closes the cross-collision attack class
|
|
/// described in the auth-simplification plan (a user can never claim
|
|
/// a handle that shadows another user's email). No leading/trailing
|
|
/// dot or hyphen. The character set also prevents XSS payloads from
|
|
/// being stored as usernames.
|
|
fn validate_username(username: &str) -> UserResult<()> {
|
|
let len = username.chars().count();
|
|
if !(2..=64).contains(&len) {
|
|
return Err(UserError::InvalidUsername(
|
|
"Username must be between 2 and 64 characters".to_string(),
|
|
));
|
|
}
|
|
if username.contains('@') {
|
|
return Err(UserError::InvalidUsername(
|
|
"Username must not contain '@' — use the email field for email addresses"
|
|
.to_string(),
|
|
));
|
|
}
|
|
if !username
|
|
.chars()
|
|
.all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '_' || c == '.')
|
|
{
|
|
return Err(UserError::InvalidUsername(
|
|
"Username may only contain letters, digits, hyphens, underscores, and dots"
|
|
.to_string(),
|
|
));
|
|
}
|
|
if username.starts_with('.')
|
|
|| username.starts_with('-')
|
|
|| username.ends_with('.')
|
|
|| username.ends_with('-')
|
|
{
|
|
return Err(UserError::InvalidUsername(
|
|
"Username must not start or end with a dot or hyphen".to_string(),
|
|
));
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// Basic but meaningful email validation:
|
|
/// - Must contain exactly one `@`
|
|
/// - Local part and domain must be non-empty
|
|
/// - Domain must contain at least one dot
|
|
/// - No angle brackets, spaces, or other characters used in XSS payloads
|
|
fn validate_email(email: &str) -> UserResult<()> {
|
|
let parts: Vec<&str> = email.splitn(2, '@').collect();
|
|
if parts.len() != 2 {
|
|
return Err(UserError::ValidationError(
|
|
"Invalid email: missing @".to_string(),
|
|
));
|
|
}
|
|
let (local, domain) = (parts[0], parts[1]);
|
|
if local.is_empty() || domain.is_empty() {
|
|
return Err(UserError::ValidationError(
|
|
"Invalid email: empty local part or domain".to_string(),
|
|
));
|
|
}
|
|
if !domain.contains('.') {
|
|
return Err(UserError::ValidationError(
|
|
"Invalid email: domain must contain a dot".to_string(),
|
|
));
|
|
}
|
|
// Reject characters commonly used in XSS / header injection
|
|
let forbidden = [
|
|
'<', '>', '"', '\'', '\\', ' ', '\t', '\n', '\r', '(', ')', ',', ';',
|
|
];
|
|
if email.chars().any(|c| forbidden.contains(&c)) {
|
|
return Err(UserError::ValidationError(
|
|
"Invalid email: contains forbidden characters".to_string(),
|
|
));
|
|
}
|
|
if email.len() > 254 {
|
|
return Err(UserError::ValidationError(
|
|
"Invalid email: too long (max 254 characters)".to_string(),
|
|
));
|
|
}
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
fn build_user(
|
|
username: Option<&str>,
|
|
given: Option<&str>,
|
|
family: Option<&str>,
|
|
email: &str,
|
|
) -> User {
|
|
User::from_data_full(
|
|
Uuid::new_v4(),
|
|
username.map(str::to_string),
|
|
email.to_string(),
|
|
None,
|
|
UserRole::User,
|
|
0,
|
|
0,
|
|
Utc::now(),
|
|
Utc::now(),
|
|
None,
|
|
true,
|
|
None,
|
|
None,
|
|
None,
|
|
false,
|
|
given.map(str::to_string),
|
|
family.map(str::to_string),
|
|
None,
|
|
None,
|
|
true,
|
|
serde_json::json!({}),
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn display_full_given_family_with_email() {
|
|
let u = build_user(Some("alice"), Some("Alice"), Some("Smith"), "alice@x.com");
|
|
assert_eq!(u.display_full(true), "Alice Smith <alice@x.com>");
|
|
assert_eq!(u.display_full(false), "Alice Smith");
|
|
}
|
|
|
|
#[test]
|
|
fn display_full_given_family_takes_priority_over_username() {
|
|
// Even when the username is set, the full name is more informative
|
|
// and wins. The username surfaces only as part of the address.
|
|
let u = build_user(Some("admin"), Some("Bob"), Some("Jones"), "bob@x.com");
|
|
assert_eq!(u.display_full(true), "Bob Jones <bob@x.com>");
|
|
assert_eq!(u.display_full(false), "Bob Jones");
|
|
}
|
|
|
|
#[test]
|
|
fn display_full_username_only() {
|
|
// The "admin" case the user observed: no given/family on the
|
|
// bootstrap admin user. With email → "admin <admin@x.com>";
|
|
// without → just "admin" (compact form for subject lines).
|
|
let u = build_user(Some("admin"), None, None, "admin@x.com");
|
|
assert_eq!(u.display_full(true), "admin <admin@x.com>");
|
|
assert_eq!(u.display_full(false), "admin");
|
|
}
|
|
|
|
#[test]
|
|
fn display_full_partial_name_falls_through_to_username() {
|
|
// Given without family (or vice versa) is NOT "rich enough" to
|
|
// use; we walk to the next priority instead of producing a
|
|
// "First <email>" half-name.
|
|
let u = build_user(Some("carol"), Some("Carol"), None, "carol@x.com");
|
|
assert_eq!(u.display_full(true), "carol <carol@x.com>");
|
|
assert_eq!(u.display_full(false), "carol");
|
|
}
|
|
|
|
#[test]
|
|
fn display_full_email_only() {
|
|
// External users provisioned via magic-link typically have no
|
|
// username and no given/family — only the email is present.
|
|
// `with_email` is moot here: the email IS the label.
|
|
let u = build_user(None, None, None, "external@x.com");
|
|
assert_eq!(u.display_full(true), "external@x.com");
|
|
assert_eq!(u.display_full(false), "external@x.com");
|
|
}
|
|
|
|
#[test]
|
|
fn display_full_partial_name_no_username_falls_to_email() {
|
|
// Lone given_name without family AND without username → falls
|
|
// all the way through to the raw email.
|
|
let u = build_user(None, Some("Solo"), None, "solo@x.com");
|
|
assert_eq!(u.display_full(true), "solo@x.com");
|
|
assert_eq!(u.display_full(false), "solo@x.com");
|
|
}
|
|
}
|