feat(magiclink) prepare magic link support (login via email)
imortant on security side: magic link will be enabled only for users who don't have password nor OIDC
This commit is contained in:
@@ -0,0 +1,281 @@
|
||||
//! Magic-link authentication tokens.
|
||||
//!
|
||||
//! Two distinct flows mint these tokens:
|
||||
//!
|
||||
//! - **Invitation** (PR 9). An internal user shares a resource with an email
|
||||
//! address. If the recipient has no account yet, an external user is
|
||||
//! lazily provisioned and a token is minted pointing at the resource.
|
||||
//! Mail with `/magic/v1/{token}` is delivered; clicking the link
|
||||
//! authenticates the recipient and 302s them to the resource.
|
||||
//!
|
||||
//! - **Login-via-email** (PR 10). A user without any other credential (an
|
||||
//! already-existing external user who hasn't set a password) requests a
|
||||
//! login link from `/login`. Token has NO resource target; redemption
|
||||
//! lands on `/shared-with-me`.
|
||||
//!
|
||||
//! The two flows share the same redemption endpoint — the deep-link
|
||||
//! decision is made by inspecting whether `resource_type/resource_id` are
|
||||
//! present on the token row.
|
||||
//!
|
||||
//! Single-use is enforced by the `status` enum transitioning from
|
||||
//! `Pending` → `Used` exactly once. The redemption endpoint runs the
|
||||
//! transition inside a SQL transaction (`UPDATE ... WHERE status='pending'`
|
||||
//! returning the row) so concurrent redemption attempts can't both
|
||||
//! succeed.
|
||||
|
||||
use base64::Engine as _;
|
||||
use base64::engine::general_purpose::URL_SAFE_NO_PAD;
|
||||
use chrono::{DateTime, Duration, Utc};
|
||||
use rand_core::{OsRng, RngCore};
|
||||
use uuid::Uuid;
|
||||
|
||||
/// Resource targeted by an invitation token. Mirrors
|
||||
/// `domain::services::authorization::ResourceKind` but is duplicated here
|
||||
/// to keep the entity self-contained (no auth-domain dependency).
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum MagicLinkResourceKind {
|
||||
File,
|
||||
Folder,
|
||||
}
|
||||
|
||||
impl MagicLinkResourceKind {
|
||||
pub fn as_str(&self) -> &'static str {
|
||||
match self {
|
||||
Self::File => "file",
|
||||
Self::Folder => "folder",
|
||||
}
|
||||
}
|
||||
|
||||
pub fn parse(s: &str) -> Option<Self> {
|
||||
match s {
|
||||
"file" => Some(Self::File),
|
||||
"folder" => Some(Self::Folder),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Lifecycle state of a magic-link token. Strict one-way transitions:
|
||||
/// `Pending → Used` (successful redemption) or `Pending → Expired`
|
||||
/// (background sweep after `expires_at`).
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum MagicLinkStatus {
|
||||
Pending,
|
||||
Used,
|
||||
Expired,
|
||||
}
|
||||
|
||||
impl MagicLinkStatus {
|
||||
pub fn as_str(&self) -> &'static str {
|
||||
match self {
|
||||
Self::Pending => "pending",
|
||||
Self::Used => "used",
|
||||
Self::Expired => "expired",
|
||||
}
|
||||
}
|
||||
|
||||
pub fn parse(s: &str) -> Option<Self> {
|
||||
match s {
|
||||
"pending" => Some(Self::Pending),
|
||||
"used" => Some(Self::Used),
|
||||
"expired" => Some(Self::Expired),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl std::fmt::Display for MagicLinkStatus {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "{}", self.as_str())
|
||||
}
|
||||
}
|
||||
|
||||
/// Domain entity for a magic-link token row.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct MagicLinkToken {
|
||||
id: Uuid,
|
||||
/// 32 bytes of CSPRNG output, URL-safe base64 (no padding), ≈43 chars.
|
||||
token: String,
|
||||
user_id: Uuid,
|
||||
status: MagicLinkStatus,
|
||||
issued_at: DateTime<Utc>,
|
||||
expires_at: DateTime<Utc>,
|
||||
used_at: Option<DateTime<Utc>>,
|
||||
/// Optional deep-link target. Both `Some` together → invitation flow;
|
||||
/// both `None` together → login-via-email flow. Mismatched is a
|
||||
/// schema-level error guarded by the DB CHECK `magic_link_tokens_resource_pair`.
|
||||
resource_kind: Option<MagicLinkResourceKind>,
|
||||
resource_id: Option<Uuid>,
|
||||
}
|
||||
|
||||
impl MagicLinkToken {
|
||||
/// Mint a fresh pending token. Generates 32 CSPRNG bytes, encodes them
|
||||
/// URL-safe base64 (no padding), and stamps `issued_at = now`,
|
||||
/// `expires_at = now + ttl_hours`.
|
||||
///
|
||||
/// `resource` is `Some((kind, id))` for invitations (deep-link to a
|
||||
/// specific file/folder) or `None` for login-via-email (lands on
|
||||
/// `/shared-with-me`). The XOR-on-NULL DB CHECK enforces this
|
||||
/// invariant; the entity exposes it as a single `Option` for
|
||||
/// clarity.
|
||||
pub fn new(
|
||||
user_id: Uuid,
|
||||
ttl_hours: u64,
|
||||
resource: Option<(MagicLinkResourceKind, Uuid)>,
|
||||
) -> Self {
|
||||
let mut bytes = [0u8; 32];
|
||||
OsRng.fill_bytes(&mut bytes);
|
||||
let token = URL_SAFE_NO_PAD.encode(bytes);
|
||||
|
||||
let now = Utc::now();
|
||||
let (resource_kind, resource_id) = match resource {
|
||||
Some((k, id)) => (Some(k), Some(id)),
|
||||
None => (None, None),
|
||||
};
|
||||
|
||||
Self {
|
||||
id: Uuid::new_v4(),
|
||||
token,
|
||||
user_id,
|
||||
status: MagicLinkStatus::Pending,
|
||||
issued_at: now,
|
||||
expires_at: now + Duration::hours(ttl_hours as i64),
|
||||
used_at: None,
|
||||
resource_kind,
|
||||
resource_id,
|
||||
}
|
||||
}
|
||||
|
||||
/// Reconstruct from a database row.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn from_raw(
|
||||
id: Uuid,
|
||||
token: String,
|
||||
user_id: Uuid,
|
||||
status: MagicLinkStatus,
|
||||
issued_at: DateTime<Utc>,
|
||||
expires_at: DateTime<Utc>,
|
||||
used_at: Option<DateTime<Utc>>,
|
||||
resource_kind: Option<MagicLinkResourceKind>,
|
||||
resource_id: Option<Uuid>,
|
||||
) -> Self {
|
||||
Self {
|
||||
id,
|
||||
token,
|
||||
user_id,
|
||||
status,
|
||||
issued_at,
|
||||
expires_at,
|
||||
used_at,
|
||||
resource_kind,
|
||||
resource_id,
|
||||
}
|
||||
}
|
||||
|
||||
// ── Getters ──────────────────────────────────────────────────
|
||||
|
||||
pub fn id(&self) -> Uuid {
|
||||
self.id
|
||||
}
|
||||
|
||||
pub fn token(&self) -> &str {
|
||||
&self.token
|
||||
}
|
||||
|
||||
pub fn user_id(&self) -> Uuid {
|
||||
self.user_id
|
||||
}
|
||||
|
||||
pub fn status(&self) -> MagicLinkStatus {
|
||||
self.status
|
||||
}
|
||||
|
||||
pub fn issued_at(&self) -> DateTime<Utc> {
|
||||
self.issued_at
|
||||
}
|
||||
|
||||
pub fn expires_at(&self) -> DateTime<Utc> {
|
||||
self.expires_at
|
||||
}
|
||||
|
||||
pub fn used_at(&self) -> Option<DateTime<Utc>> {
|
||||
self.used_at
|
||||
}
|
||||
|
||||
pub fn resource_kind(&self) -> Option<MagicLinkResourceKind> {
|
||||
self.resource_kind
|
||||
}
|
||||
|
||||
pub fn resource_id(&self) -> Option<Uuid> {
|
||||
self.resource_id
|
||||
}
|
||||
|
||||
// ── Business logic ───────────────────────────────────────────
|
||||
|
||||
/// `true` once `expires_at < now`. The status column may still be
|
||||
/// `Pending` if the background sweep hasn't run yet; treat this
|
||||
/// method as authoritative at redemption time.
|
||||
pub fn is_expired(&self) -> bool {
|
||||
Utc::now() > self.expires_at
|
||||
}
|
||||
|
||||
/// `true` iff the token is in a state where it can be redeemed
|
||||
/// (pending + not yet past TTL). The redemption endpoint should
|
||||
/// check this; the DB-level `UPDATE WHERE status='pending'` is the
|
||||
/// definitive single-use guard.
|
||||
pub fn is_redeemable(&self) -> bool {
|
||||
self.status == MagicLinkStatus::Pending && !self.is_expired()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn new_token_is_pending_and_within_ttl() {
|
||||
let user_id = Uuid::new_v4();
|
||||
let token = MagicLinkToken::new(user_id, 24, None);
|
||||
assert_eq!(token.status(), MagicLinkStatus::Pending);
|
||||
assert_eq!(token.user_id(), user_id);
|
||||
assert!(token.resource_kind().is_none());
|
||||
assert!(token.resource_id().is_none());
|
||||
assert!(token.is_redeemable());
|
||||
assert!(!token.is_expired());
|
||||
// 32 bytes → 43 chars URL-safe base64 (no padding).
|
||||
assert_eq!(token.token().len(), 43);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn new_token_with_resource_carries_both_fields() {
|
||||
let user_id = Uuid::new_v4();
|
||||
let folder_id = Uuid::new_v4();
|
||||
let token = MagicLinkToken::new(
|
||||
user_id,
|
||||
24,
|
||||
Some((MagicLinkResourceKind::Folder, folder_id)),
|
||||
);
|
||||
assert_eq!(token.resource_kind(), Some(MagicLinkResourceKind::Folder));
|
||||
assert_eq!(token.resource_id(), Some(folder_id));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn each_token_is_unique() {
|
||||
let user_id = Uuid::new_v4();
|
||||
let a = MagicLinkToken::new(user_id, 24, None);
|
||||
let b = MagicLinkToken::new(user_id, 24, None);
|
||||
assert_ne!(a.token(), b.token());
|
||||
assert_ne!(a.id(), b.id());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn status_round_trip() {
|
||||
for s in [
|
||||
MagicLinkStatus::Pending,
|
||||
MagicLinkStatus::Used,
|
||||
MagicLinkStatus::Expired,
|
||||
] {
|
||||
assert_eq!(MagicLinkStatus::parse(s.as_str()), Some(s));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@ pub mod device_code;
|
||||
pub mod entity_errors;
|
||||
pub mod file;
|
||||
pub mod folder;
|
||||
pub mod magic_link_token;
|
||||
pub mod playlist;
|
||||
pub mod session;
|
||||
pub mod share;
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
//! Storage port for [`MagicLinkToken`].
|
||||
//!
|
||||
//! Minimal CRUD surface — magic-link tokens have only three lifecycle
|
||||
//! states (`Pending`, `Used`, `Expired`) and three callers (mint at invite
|
||||
//! time, redeem at click time, sweep at maintenance time). New methods
|
||||
//! should be resisted until a concrete consumer needs them.
|
||||
|
||||
use async_trait::async_trait;
|
||||
use uuid::Uuid;
|
||||
|
||||
use crate::common::errors::DomainError;
|
||||
use crate::domain::entities::magic_link_token::MagicLinkToken;
|
||||
|
||||
#[async_trait]
|
||||
pub trait MagicLinkTokenRepository: Send + Sync + 'static {
|
||||
/// Persist a freshly-minted pending token.
|
||||
async fn create(&self, token: &MagicLinkToken) -> Result<(), DomainError>;
|
||||
|
||||
/// Look up a token by its opaque value. Returns `Ok(None)` when no row
|
||||
/// matches (use this for "unknown token" rather than treating it as an
|
||||
/// error). The caller is responsible for checking `is_redeemable()`
|
||||
/// before honouring the token.
|
||||
async fn find_by_token(&self, token: &str) -> Result<Option<MagicLinkToken>, DomainError>;
|
||||
|
||||
/// Atomically transition a token from `Pending` → `Used`. Returns
|
||||
/// `Ok(true)` exactly when this call performed the transition; a
|
||||
/// concurrent redemption attempt receives `Ok(false)` and must reject
|
||||
/// the request. Implementations MUST do this in a single SQL
|
||||
/// statement (`UPDATE … WHERE status='pending' …`) — the row-level
|
||||
/// lock provided by Postgres' MVCC is what makes single-use
|
||||
/// enforcement race-free.
|
||||
async fn mark_used(&self, id: Uuid) -> Result<bool, DomainError>;
|
||||
|
||||
/// Delete every token that has expired (status pending, expires_at
|
||||
/// in the past). Returns the number of rows removed; called from a
|
||||
/// background sweeper that runs on a slow cadence (≤ once per hour).
|
||||
async fn delete_expired(&self) -> Result<u64, DomainError>;
|
||||
|
||||
/// Hard-delete every still-outstanding token for a user. Called by
|
||||
/// the user-lifecycle `on_user_deleted` hook so an admin's delete
|
||||
/// can't leave dangling tokens behind. Operates inside the caller's
|
||||
/// transaction so the cleanup commits atomically with the user
|
||||
/// DELETE.
|
||||
async fn delete_all_for_user_tx(
|
||||
&self,
|
||||
user_id: Uuid,
|
||||
tx: &mut sqlx::Transaction<'_, sqlx::Postgres>,
|
||||
) -> Result<u64, DomainError>;
|
||||
}
|
||||
@@ -4,6 +4,7 @@ pub mod calendar_repository;
|
||||
pub mod contact_repository;
|
||||
pub mod file_repository;
|
||||
pub mod folder_repository;
|
||||
pub mod magic_link_token_repository;
|
||||
pub mod playlist_repository;
|
||||
pub mod session_repository;
|
||||
pub mod settings_repository;
|
||||
|
||||
Reference in New Issue
Block a user