mas_data_model/oauth2/
session.rs

1// Copyright 2024 New Vector Ltd.
2// Copyright 2021-2024 The Matrix.org Foundation C.I.C.
3//
4// SPDX-License-Identifier: AGPL-3.0-only
5// Please see LICENSE in the repository root for full details.
6
7use std::net::IpAddr;
8
9use chrono::{DateTime, Utc};
10use oauth2_types::scope::Scope;
11use serde::Serialize;
12use ulid::Ulid;
13
14use crate::InvalidTransitionError;
15
16#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize)]
17pub enum SessionState {
18    #[default]
19    Valid,
20    Finished {
21        finished_at: DateTime<Utc>,
22    },
23}
24
25impl SessionState {
26    /// Returns `true` if the session state is [`Valid`].
27    ///
28    /// [`Valid`]: SessionState::Valid
29    #[must_use]
30    pub fn is_valid(&self) -> bool {
31        matches!(self, Self::Valid)
32    }
33
34    /// Returns `true` if the session state is [`Finished`].
35    ///
36    /// [`Finished`]: SessionState::Finished
37    #[must_use]
38    pub fn is_finished(&self) -> bool {
39        matches!(self, Self::Finished { .. })
40    }
41
42    /// Transitions the session state to [`Finished`].
43    ///
44    /// # Parameters
45    ///
46    /// * `finished_at` - The time at which the session was finished.
47    ///
48    /// # Errors
49    ///
50    /// Returns an error if the session state is already [`Finished`].
51    ///
52    /// [`Finished`]: SessionState::Finished
53    pub fn finish(self, finished_at: DateTime<Utc>) -> Result<Self, InvalidTransitionError> {
54        match self {
55            Self::Valid => Ok(Self::Finished { finished_at }),
56            Self::Finished { .. } => Err(InvalidTransitionError),
57        }
58    }
59
60    /// Returns the time the session was finished, if any
61    ///
62    /// Returns `None` if the session is still [`Valid`].
63    ///
64    /// [`Valid`]: SessionState::Valid
65    #[must_use]
66    pub fn finished_at(&self) -> Option<DateTime<Utc>> {
67        match self {
68            Self::Valid => None,
69            Self::Finished { finished_at } => Some(*finished_at),
70        }
71    }
72}
73
74#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
75pub struct Session {
76    pub id: Ulid,
77    pub state: SessionState,
78    pub created_at: DateTime<Utc>,
79    pub user_id: Option<Ulid>,
80    pub user_session_id: Option<Ulid>,
81    pub client_id: Ulid,
82    pub scope: Scope,
83    pub user_agent: Option<String>,
84    pub last_active_at: Option<DateTime<Utc>>,
85    pub last_active_ip: Option<IpAddr>,
86    pub human_name: Option<String>,
87}
88
89impl std::ops::Deref for Session {
90    type Target = SessionState;
91
92    fn deref(&self) -> &Self::Target {
93        &self.state
94    }
95}
96
97impl Session {
98    /// Marks the session as finished.
99    ///
100    /// # Parameters
101    ///
102    /// * `finished_at` - The time at which the session was finished.
103    ///
104    /// # Errors
105    ///
106    /// Returns an error if the session is already finished.
107    pub fn finish(mut self, finished_at: DateTime<Utc>) -> Result<Self, InvalidTransitionError> {
108        self.state = self.state.finish(finished_at)?;
109        Ok(self)
110    }
111}
mas_data_model/oauth2/session.rs

mas_data_model/oauth2/
session.rs
