mas_storage_pg/user/
password.rs

1// Copyright 2025, 2026 Element Creations Ltd.
2// Copyright 2024, 2025 New Vector Ltd.
3// Copyright 2022-2024 The Matrix.org Foundation C.I.C.
4//
5// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
6// Please see LICENSE files in the repository root for full details.
7
8use async_trait::async_trait;
9use chrono::{DateTime, Utc};
10use mas_data_model::{Clock, Password, UlidExt as _, User};
11use mas_storage::user::UserPasswordRepository;
12use rand::Rng;
13use sqlx::PgConnection;
14use ulid::Ulid;
15use uuid::Uuid;
16
17use crate::{DatabaseError, DatabaseInconsistencyError, tracing::ExecuteExt};
18
19/// An implementation of [`UserPasswordRepository`] for a PostgreSQL connection
20pub struct PgUserPasswordRepository<'c> {
21    conn: &'c mut PgConnection,
22}
23
24impl<'c> PgUserPasswordRepository<'c> {
25    /// Create a new [`PgUserPasswordRepository`] from an active PostgreSQL
26    /// connection
27    pub fn new(conn: &'c mut PgConnection) -> Self {
28        Self { conn }
29    }
30}
31
32struct UserPasswordLookup {
33    user_password_id: Uuid,
34    hashed_password: String,
35    version: i32,
36    upgraded_from_id: Option<Uuid>,
37    created_at: DateTime<Utc>,
38}
39
40#[async_trait]
41impl UserPasswordRepository for PgUserPasswordRepository<'_> {
42    type Error = DatabaseError;
43
44    #[tracing::instrument(
45        name = "db.user_password.active",
46        skip_all,
47        fields(
48            db.query.text,
49            %user.id,
50            %user.username,
51        ),
52        err,
53    )]
54    async fn active(&mut self, user: &User) -> Result<Option<Password>, Self::Error> {
55        let res = sqlx::query_as!(
56            UserPasswordLookup,
57            r#"
58                SELECT up.user_password_id
59                     , up.hashed_password
60                     , up.version
61                     , up.upgraded_from_id
62                     , up.created_at
63                FROM user_passwords up
64                WHERE up.user_id = $1
65                ORDER BY up.created_at DESC
66                LIMIT 1
67            "#,
68            Uuid::from(user.id),
69        )
70        .traced()
71        .fetch_optional(&mut *self.conn)
72        .await?;
73
74        let Some(res) = res else { return Ok(None) };
75
76        let id = Ulid::from(res.user_password_id);
77
78        let version = res.version.try_into().map_err(|e| {
79            DatabaseInconsistencyError::on("user_passwords")
80                .column("version")
81                .row(id)
82                .source(e)
83        })?;
84
85        let upgraded_from_id = res.upgraded_from_id.map(Ulid::from);
86        let created_at = res.created_at;
87        let hashed_password = res.hashed_password;
88
89        Ok(Some(Password {
90            id,
91            hashed_password,
92            version,
93            upgraded_from_id,
94            created_at,
95        }))
96    }
97
98    #[tracing::instrument(
99        name = "db.user_password.add",
100        skip_all,
101        fields(
102            db.query.text,
103            %user.id,
104            %user.username,
105            user_password.id,
106            user_password.version = version,
107        ),
108        err,
109    )]
110    async fn add(
111        &mut self,
112        rng: &mut (dyn Rng + Send),
113        clock: &dyn Clock,
114        user: &User,
115        version: u16,
116        hashed_password: String,
117        upgraded_from: Option<&Password>,
118    ) -> Result<Password, Self::Error> {
119        let created_at = clock.now();
120        let id = Ulid::from_datetime_with_rng(created_at, rng);
121        tracing::Span::current().record("user_password.id", tracing::field::display(id));
122
123        let upgraded_from_id = upgraded_from.map(|p| p.id);
124
125        sqlx::query!(
126            r#"
127                INSERT INTO user_passwords
128                    (user_password_id, user_id, hashed_password, version, upgraded_from_id, created_at)
129                VALUES ($1, $2, $3, $4, $5, $6)
130            "#,
131            Uuid::from(id),
132            Uuid::from(user.id),
133            hashed_password,
134            i32::from(version),
135            upgraded_from_id.map(Uuid::from),
136            created_at,
137        )
138        .traced()
139        .execute(&mut *self.conn)
140        .await?;
141
142        Ok(Password {
143            id,
144            hashed_password,
145            version,
146            upgraded_from_id,
147            created_at,
148        })
149    }
150}
mas_storage_pg/user/password.rs

mas_storage_pg/user/
password.rs
