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
// Copyright 2023 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use chrono::{DateTime, Utc};
use serde::Serialize;
use ulid::Ulid;
use url::Url;

use super::CompatSession;
use crate::InvalidTransitionError;

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize)]
pub enum CompatSsoLoginState {
    #[default]
    Pending,
    Fulfilled {
        fulfilled_at: DateTime<Utc>,
        session_id: Ulid,
    },
    Exchanged {
        fulfilled_at: DateTime<Utc>,
        exchanged_at: DateTime<Utc>,
        session_id: Ulid,
    },
}

impl CompatSsoLoginState {
    /// Returns `true` if the compat SSO login state is [`Pending`].
    ///
    /// [`Pending`]: CompatSsoLoginState::Pending
    #[must_use]
    pub fn is_pending(&self) -> bool {
        matches!(self, Self::Pending)
    }

    /// Returns `true` if the compat SSO login state is [`Fulfilled`].
    ///
    /// [`Fulfilled`]: CompatSsoLoginState::Fulfilled
    #[must_use]
    pub fn is_fulfilled(&self) -> bool {
        matches!(self, Self::Fulfilled { .. })
    }

    /// Returns `true` if the compat SSO login state is [`Exchanged`].
    ///
    /// [`Exchanged`]: CompatSsoLoginState::Exchanged
    #[must_use]
    pub fn is_exchanged(&self) -> bool {
        matches!(self, Self::Exchanged { .. })
    }

    /// Get the time at which the login was fulfilled.
    ///
    /// Returns `None` if the compat SSO login state is [`Pending`].
    ///
    /// [`Pending`]: CompatSsoLoginState::Pending
    #[must_use]
    pub fn fulfilled_at(&self) -> Option<DateTime<Utc>> {
        match self {
            Self::Pending => None,
            Self::Fulfilled { fulfilled_at, .. } | Self::Exchanged { fulfilled_at, .. } => {
                Some(*fulfilled_at)
            }
        }
    }

    /// Get the time at which the login was exchanged.
    ///
    /// Returns `None` if the compat SSO login state is not [`Exchanged`].
    ///
    /// [`Exchanged`]: CompatSsoLoginState::Exchanged
    #[must_use]
    pub fn exchanged_at(&self) -> Option<DateTime<Utc>> {
        match self {
            Self::Pending | Self::Fulfilled { .. } => None,
            Self::Exchanged { exchanged_at, .. } => Some(*exchanged_at),
        }
    }

    /// Get the session ID associated with the login.
    ///
    /// Returns `None` if the compat SSO login state is [`Pending`].
    ///
    /// [`Pending`]: CompatSsoLoginState::Pending
    #[must_use]
    pub fn session_id(&self) -> Option<Ulid> {
        match self {
            Self::Pending => None,
            Self::Fulfilled { session_id, .. } | Self::Exchanged { session_id, .. } => {
                Some(*session_id)
            }
        }
    }

    /// Transition the compat SSO login state from [`Pending`] to [`Fulfilled`].
    ///
    /// # Errors
    ///
    /// Returns an error if the compat SSO login state is not [`Pending`].
    ///
    /// [`Pending`]: CompatSsoLoginState::Pending
    /// [`Fulfilled`]: CompatSsoLoginState::Fulfilled
    pub fn fulfill(
        self,
        fulfilled_at: DateTime<Utc>,
        session: &CompatSession,
    ) -> Result<Self, InvalidTransitionError> {
        match self {
            Self::Pending => Ok(Self::Fulfilled {
                fulfilled_at,
                session_id: session.id,
            }),
            Self::Fulfilled { .. } | Self::Exchanged { .. } => Err(InvalidTransitionError),
        }
    }

    /// Transition the compat SSO login state from [`Fulfilled`] to
    /// [`Exchanged`].
    ///
    /// # Errors
    ///
    /// Returns an error if the compat SSO login state is not [`Fulfilled`].
    ///
    /// [`Fulfilled`]: CompatSsoLoginState::Fulfilled
    /// [`Exchanged`]: CompatSsoLoginState::Exchanged
    pub fn exchange(self, exchanged_at: DateTime<Utc>) -> Result<Self, InvalidTransitionError> {
        match self {
            Self::Fulfilled {
                fulfilled_at,
                session_id,
            } => Ok(Self::Exchanged {
                fulfilled_at,
                exchanged_at,
                session_id,
            }),
            Self::Pending { .. } | Self::Exchanged { .. } => Err(InvalidTransitionError),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct CompatSsoLogin {
    pub id: Ulid,
    pub redirect_uri: Url,
    pub login_token: String,
    pub created_at: DateTime<Utc>,
    pub state: CompatSsoLoginState,
}

impl std::ops::Deref for CompatSsoLogin {
    type Target = CompatSsoLoginState;

    fn deref(&self) -> &Self::Target {
        &self.state
    }
}

impl CompatSsoLogin {
    /// Transition the compat SSO login from a [`Pending`] state to
    /// [`Fulfilled`].
    ///
    /// # Errors
    ///
    /// Returns an error if the compat SSO login state is not [`Pending`].
    ///
    /// [`Pending`]: CompatSsoLoginState::Pending
    /// [`Fulfilled`]: CompatSsoLoginState::Fulfilled
    pub fn fulfill(
        mut self,
        fulfilled_at: DateTime<Utc>,
        session: &CompatSession,
    ) -> Result<Self, InvalidTransitionError> {
        self.state = self.state.fulfill(fulfilled_at, session)?;
        Ok(self)
    }

    /// Transition the compat SSO login from a [`Fulfilled`] state to
    /// [`Exchanged`].
    ///
    /// # Errors
    ///
    /// Returns an error if the compat SSO login state is not [`Fulfilled`].
    ///
    /// [`Fulfilled`]: CompatSsoLoginState::Fulfilled
    /// [`Exchanged`]: CompatSsoLoginState::Exchanged
    pub fn exchange(mut self, exchanged_at: DateTime<Utc>) -> Result<Self, InvalidTransitionError> {
        self.state = self.state.exchange(exchanged_at)?;
        Ok(self)
    }
}