mas_storage/user/
password.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
// Copyright 2024 New Vector Ltd.
// Copyright 2022-2024 The Matrix.org Foundation C.I.C.
//
// SPDX-License-Identifier: AGPL-3.0-only
// Please see LICENSE in the repository root for full details.

use async_trait::async_trait;
use mas_data_model::{Password, User};
use rand_core::RngCore;

use crate::{repository_impl, Clock};

/// A [`UserPasswordRepository`] helps interacting with [`Password`] saved in
/// the storage backend
#[async_trait]
pub trait UserPasswordRepository: Send + Sync {
    /// The error type returned by the repository
    type Error;

    /// Get the active password for a user
    ///
    /// Returns `None` if the user has no password set
    ///
    /// # Parameters
    ///
    /// * `user`: The user to get the password for
    ///
    /// # Errors
    ///
    /// Returns [`Self::Error`] if underlying repository fails
    async fn active(&mut self, user: &User) -> Result<Option<Password>, Self::Error>;

    /// Set a new password for a user
    ///
    /// Returns the newly created [`Password`]
    ///
    /// # Parameters
    ///
    /// * `rng`: The random number generator to use
    /// * `clock`: The clock used to generate timestamps
    /// * `user`: The user to set the password for
    /// * `version`: The version of the hashing scheme used
    /// * `hashed_password`: The hashed password
    /// * `upgraded_from`: The password this password was upgraded from, if any
    ///
    /// # Errors
    ///
    /// Returns [`Self::Error`] if underlying repository fails
    async fn add(
        &mut self,
        rng: &mut (dyn RngCore + Send),
        clock: &dyn Clock,
        user: &User,
        version: u16,
        hashed_password: String,
        upgraded_from: Option<&Password>,
    ) -> Result<Password, Self::Error>;
}

repository_impl!(UserPasswordRepository:
    async fn active(&mut self, user: &User) -> Result<Option<Password>, Self::Error>;
    async fn add(
        &mut self,
        rng: &mut (dyn RngCore + Send),
        clock: &dyn Clock,
        user: &User,
        version: u16,
        hashed_password: String,
        upgraded_from: Option<&Password>,
    ) -> Result<Password, Self::Error>;
);