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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
// Copyright 2024 New Vector Ltd.
// Copyright 2023, 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::{CompatSession, CompatSsoLogin, User};
use rand_core::RngCore;
use ulid::Ulid;
use url::Url;
use crate::{pagination::Page, repository_impl, Clock, Pagination};
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum CompatSsoLoginState {
Pending,
Fulfilled,
Exchanged,
}
impl CompatSsoLoginState {
/// Returns [`true`] if we're looking for pending SSO logins
#[must_use]
pub fn is_pending(self) -> bool {
matches!(self, Self::Pending)
}
/// Returns [`true`] if we're looking for fulfilled SSO logins
#[must_use]
pub fn is_fulfilled(self) -> bool {
matches!(self, Self::Fulfilled)
}
/// Returns [`true`] if we're looking for exchanged SSO logins
#[must_use]
pub fn is_exchanged(self) -> bool {
matches!(self, Self::Exchanged)
}
}
/// Filter parameters for listing compat SSO logins
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub struct CompatSsoLoginFilter<'a> {
user: Option<&'a User>,
state: Option<CompatSsoLoginState>,
}
impl<'a> CompatSsoLoginFilter<'a> {
/// Create a new empty filter
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Set the user who owns the SSO logins sessions
#[must_use]
pub fn for_user(mut self, user: &'a User) -> Self {
self.user = Some(user);
self
}
/// Get the user filter
#[must_use]
pub fn user(&self) -> Option<&User> {
self.user
}
/// Only return pending SSO logins
#[must_use]
pub fn pending_only(mut self) -> Self {
self.state = Some(CompatSsoLoginState::Pending);
self
}
/// Only return fulfilled SSO logins
#[must_use]
pub fn fulfilled_only(mut self) -> Self {
self.state = Some(CompatSsoLoginState::Fulfilled);
self
}
/// Only return exchanged SSO logins
#[must_use]
pub fn exchanged_only(mut self) -> Self {
self.state = Some(CompatSsoLoginState::Exchanged);
self
}
/// Get the state filter
#[must_use]
pub fn state(&self) -> Option<CompatSsoLoginState> {
self.state
}
}
/// A [`CompatSsoLoginRepository`] helps interacting with
/// [`CompatSsoLoginRepository`] saved in the storage backend
#[async_trait]
pub trait CompatSsoLoginRepository: Send + Sync {
/// The error type returned by the repository
type Error;
/// Lookup a compat SSO login by its ID
///
/// Returns the compat SSO login if it exists, `None` otherwise
///
/// # Parameters
///
/// * `id`: The ID of the compat SSO login to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn lookup(&mut self, id: Ulid) -> Result<Option<CompatSsoLogin>, Self::Error>;
/// Find a compat SSO login by its session
///
/// Returns the compat SSO login if it exists, `None` otherwise
///
/// # Parameters
///
/// * `session`: The session of the compat SSO login to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn find_for_session(
&mut self,
session: &CompatSession,
) -> Result<Option<CompatSsoLogin>, Self::Error>;
/// Find a compat SSO login by its login token
///
/// Returns the compat SSO login if found, `None` otherwise
///
/// # Parameters
///
/// * `login_token`: The login token of the compat SSO login to lookup
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn find_by_token(
&mut self,
login_token: &str,
) -> Result<Option<CompatSsoLogin>, Self::Error>;
/// Start a new compat SSO login token
///
/// Returns the newly created compat SSO login
///
/// # Parameters
///
/// * `rng`: The random number generator to use
/// * `clock`: The clock used to generate the timestamps
/// * `login_token`: The login token given to the client
/// * `redirect_uri`: The redirect URI given by the client
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn add(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
login_token: String,
redirect_uri: Url,
) -> Result<CompatSsoLogin, Self::Error>;
/// Fulfill a compat SSO login by providing a compat session
///
/// Returns the fulfilled compat SSO login
///
/// # Parameters
///
/// * `clock`: The clock used to generate the timestamps
/// * `compat_sso_login`: The compat SSO login to fulfill
/// * `compat_session`: The compat session to associate with the compat SSO
/// login
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn fulfill(
&mut self,
clock: &dyn Clock,
compat_sso_login: CompatSsoLogin,
compat_session: &CompatSession,
) -> Result<CompatSsoLogin, Self::Error>;
/// Mark a compat SSO login as exchanged
///
/// Returns the exchanged compat SSO login
///
/// # Parameters
///
/// * `clock`: The clock used to generate the timestamps
/// * `compat_sso_login`: The compat SSO login to mark as exchanged
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn exchange(
&mut self,
clock: &dyn Clock,
compat_sso_login: CompatSsoLogin,
) -> Result<CompatSsoLogin, Self::Error>;
/// List [`CompatSsoLogin`] with the given filter and pagination
///
/// Returns a page of compat SSO logins
///
/// # Parameters
///
/// * `filter`: The filter to apply
/// * `pagination`: The pagination parameters
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn list(
&mut self,
filter: CompatSsoLoginFilter<'_>,
pagination: Pagination,
) -> Result<Page<CompatSsoLogin>, Self::Error>;
/// Count the number of [`CompatSsoLogin`] with the given filter
///
/// # Parameters
///
/// * `filter`: The filter to apply
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn count(&mut self, filter: CompatSsoLoginFilter<'_>) -> Result<usize, Self::Error>;
}
repository_impl!(CompatSsoLoginRepository:
async fn lookup(&mut self, id: Ulid) -> Result<Option<CompatSsoLogin>, Self::Error>;
async fn find_for_session(
&mut self,
session: &CompatSession,
) -> Result<Option<CompatSsoLogin>, Self::Error>;
async fn find_by_token(
&mut self,
login_token: &str,
) -> Result<Option<CompatSsoLogin>, Self::Error>;
async fn add(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
login_token: String,
redirect_uri: Url,
) -> Result<CompatSsoLogin, Self::Error>;
async fn fulfill(
&mut self,
clock: &dyn Clock,
compat_sso_login: CompatSsoLogin,
compat_session: &CompatSession,
) -> Result<CompatSsoLogin, Self::Error>;
async fn exchange(
&mut self,
clock: &dyn Clock,
compat_sso_login: CompatSsoLogin,
) -> Result<CompatSsoLogin, Self::Error>;
async fn list(
&mut self,
filter: CompatSsoLoginFilter<'_>,
pagination: Pagination,
) -> Result<Page<CompatSsoLogin>, Self::Error>;
async fn count(&mut self, filter: CompatSsoLoginFilter<'_>) -> Result<usize, Self::Error>;
);