mas_router/
endpoints.rs

1// Copyright 2024, 2025 New Vector Ltd.
2// Copyright 2022-2024 The Matrix.org Foundation C.I.C.
3//
4// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
5// Please see LICENSE files in the repository root for full details.
6
7use serde::{Deserialize, Serialize};
8use ulid::Ulid;
9
10use crate::UrlBuilder;
11pub use crate::traits::*;
12
13#[derive(Deserialize, Serialize, Clone, Debug)]
14#[serde(rename_all = "snake_case", tag = "kind")]
15pub enum PostAuthAction {
16    ContinueAuthorizationGrant {
17        id: Ulid,
18    },
19    ContinueDeviceCodeGrant {
20        id: Ulid,
21    },
22    ContinueCompatSsoLogin {
23        id: Ulid,
24    },
25    ChangePassword,
26    LinkUpstream {
27        id: Ulid,
28    },
29    ManageAccount {
30        #[serde(flatten)]
31        action: Option<AccountAction>,
32    },
33}
34
35impl PostAuthAction {
36    #[must_use]
37    pub const fn continue_grant(id: Ulid) -> Self {
38        PostAuthAction::ContinueAuthorizationGrant { id }
39    }
40
41    #[must_use]
42    pub const fn continue_device_code_grant(id: Ulid) -> Self {
43        PostAuthAction::ContinueDeviceCodeGrant { id }
44    }
45
46    #[must_use]
47    pub const fn continue_compat_sso_login(id: Ulid) -> Self {
48        PostAuthAction::ContinueCompatSsoLogin { id }
49    }
50
51    #[must_use]
52    pub const fn link_upstream(id: Ulid) -> Self {
53        PostAuthAction::LinkUpstream { id }
54    }
55
56    #[must_use]
57    pub const fn manage_account(action: Option<AccountAction>) -> Self {
58        PostAuthAction::ManageAccount { action }
59    }
60
61    pub fn go_next(&self, url_builder: &UrlBuilder) -> axum::response::Redirect {
62        match self {
63            Self::ContinueAuthorizationGrant { id } => url_builder.redirect(&Consent(*id)),
64            Self::ContinueDeviceCodeGrant { id } => {
65                url_builder.redirect(&DeviceCodeConsent::new(*id))
66            }
67            Self::ContinueCompatSsoLogin { id } => {
68                url_builder.redirect(&CompatLoginSsoComplete::new(*id, None))
69            }
70            Self::ChangePassword => url_builder.redirect(&AccountPasswordChange),
71            Self::LinkUpstream { id } => url_builder.redirect(&UpstreamOAuth2Link::new(*id)),
72            Self::ManageAccount { action } => url_builder.redirect(&Account {
73                action: action.clone(),
74            }),
75        }
76    }
77}
78
79/// `GET /.well-known/openid-configuration`
80#[derive(Default, Debug, Clone)]
81pub struct OidcConfiguration;
82
83impl SimpleRoute for OidcConfiguration {
84    const PATH: &'static str = "/.well-known/openid-configuration";
85}
86
87/// `GET /.well-known/webfinger`
88#[derive(Default, Debug, Clone)]
89pub struct Webfinger;
90
91impl SimpleRoute for Webfinger {
92    const PATH: &'static str = "/.well-known/webfinger";
93}
94
95/// `GET /.well-known/change-password`
96pub struct ChangePasswordDiscovery;
97
98impl SimpleRoute for ChangePasswordDiscovery {
99    const PATH: &'static str = "/.well-known/change-password";
100}
101
102/// `GET /oauth2/keys.json`
103#[derive(Default, Debug, Clone)]
104pub struct OAuth2Keys;
105
106impl SimpleRoute for OAuth2Keys {
107    const PATH: &'static str = "/oauth2/keys.json";
108}
109
110/// `GET /oauth2/userinfo`
111#[derive(Default, Debug, Clone)]
112pub struct OidcUserinfo;
113
114impl SimpleRoute for OidcUserinfo {
115    const PATH: &'static str = "/oauth2/userinfo";
116}
117
118/// `POST /oauth2/introspect`
119#[derive(Default, Debug, Clone)]
120pub struct OAuth2Introspection;
121
122impl SimpleRoute for OAuth2Introspection {
123    const PATH: &'static str = "/oauth2/introspect";
124}
125
126/// `POST /oauth2/revoke`
127#[derive(Default, Debug, Clone)]
128pub struct OAuth2Revocation;
129
130impl SimpleRoute for OAuth2Revocation {
131    const PATH: &'static str = "/oauth2/revoke";
132}
133
134/// `POST /oauth2/token`
135#[derive(Default, Debug, Clone)]
136pub struct OAuth2TokenEndpoint;
137
138impl SimpleRoute for OAuth2TokenEndpoint {
139    const PATH: &'static str = "/oauth2/token";
140}
141
142/// `POST /oauth2/registration`
143#[derive(Default, Debug, Clone)]
144pub struct OAuth2RegistrationEndpoint;
145
146impl SimpleRoute for OAuth2RegistrationEndpoint {
147    const PATH: &'static str = "/oauth2/registration";
148}
149
150/// `GET /authorize`
151#[derive(Default, Debug, Clone)]
152pub struct OAuth2AuthorizationEndpoint;
153
154impl SimpleRoute for OAuth2AuthorizationEndpoint {
155    const PATH: &'static str = "/authorize";
156}
157
158/// `GET /`
159#[derive(Default, Debug, Clone)]
160pub struct Index;
161
162impl SimpleRoute for Index {
163    const PATH: &'static str = "/";
164}
165
166/// `GET /health`
167#[derive(Default, Debug, Clone)]
168pub struct Healthcheck;
169
170impl SimpleRoute for Healthcheck {
171    const PATH: &'static str = "/health";
172}
173
174/// `GET|POST /login`
175#[derive(Default, Debug, Clone)]
176pub struct Login {
177    post_auth_action: Option<PostAuthAction>,
178}
179
180impl Route for Login {
181    type Query = PostAuthAction;
182
183    fn route() -> &'static str {
184        "/login"
185    }
186
187    fn query(&self) -> Option<&Self::Query> {
188        self.post_auth_action.as_ref()
189    }
190}
191
192impl Login {
193    #[must_use]
194    pub const fn and_then(action: PostAuthAction) -> Self {
195        Self {
196            post_auth_action: Some(action),
197        }
198    }
199
200    #[must_use]
201    pub const fn and_continue_grant(id: Ulid) -> Self {
202        Self {
203            post_auth_action: Some(PostAuthAction::continue_grant(id)),
204        }
205    }
206
207    #[must_use]
208    pub const fn and_continue_device_code_grant(id: Ulid) -> Self {
209        Self {
210            post_auth_action: Some(PostAuthAction::continue_device_code_grant(id)),
211        }
212    }
213
214    #[must_use]
215    pub const fn and_continue_compat_sso_login(id: Ulid) -> Self {
216        Self {
217            post_auth_action: Some(PostAuthAction::continue_compat_sso_login(id)),
218        }
219    }
220
221    #[must_use]
222    pub const fn and_link_upstream(id: Ulid) -> Self {
223        Self {
224            post_auth_action: Some(PostAuthAction::link_upstream(id)),
225        }
226    }
227
228    /// Get a reference to the login's post auth action.
229    #[must_use]
230    pub fn post_auth_action(&self) -> Option<&PostAuthAction> {
231        self.post_auth_action.as_ref()
232    }
233
234    pub fn go_next(&self, url_builder: &UrlBuilder) -> axum::response::Redirect {
235        match &self.post_auth_action {
236            Some(action) => action.go_next(url_builder),
237            None => url_builder.redirect(&Index),
238        }
239    }
240}
241
242impl From<Option<PostAuthAction>> for Login {
243    fn from(post_auth_action: Option<PostAuthAction>) -> Self {
244        Self { post_auth_action }
245    }
246}
247
248/// `POST /logout`
249#[derive(Default, Debug, Clone)]
250pub struct Logout;
251
252impl SimpleRoute for Logout {
253    const PATH: &'static str = "/logout";
254}
255
256/// `POST /register`
257#[derive(Default, Debug, Clone)]
258pub struct Register {
259    post_auth_action: Option<PostAuthAction>,
260}
261
262impl Register {
263    #[must_use]
264    pub fn and_then(action: PostAuthAction) -> Self {
265        Self {
266            post_auth_action: Some(action),
267        }
268    }
269
270    #[must_use]
271    pub fn and_continue_grant(data: Ulid) -> Self {
272        Self {
273            post_auth_action: Some(PostAuthAction::continue_grant(data)),
274        }
275    }
276
277    #[must_use]
278    pub fn and_continue_compat_sso_login(data: Ulid) -> Self {
279        Self {
280            post_auth_action: Some(PostAuthAction::continue_compat_sso_login(data)),
281        }
282    }
283
284    /// Get a reference to the reauth's post auth action.
285    #[must_use]
286    pub fn post_auth_action(&self) -> Option<&PostAuthAction> {
287        self.post_auth_action.as_ref()
288    }
289
290    pub fn go_next(&self, url_builder: &UrlBuilder) -> axum::response::Redirect {
291        match &self.post_auth_action {
292            Some(action) => action.go_next(url_builder),
293            None => url_builder.redirect(&Index),
294        }
295    }
296}
297
298impl Route for Register {
299    type Query = PostAuthAction;
300
301    fn route() -> &'static str {
302        "/register"
303    }
304
305    fn query(&self) -> Option<&Self::Query> {
306        self.post_auth_action.as_ref()
307    }
308}
309
310impl From<Option<PostAuthAction>> for Register {
311    fn from(post_auth_action: Option<PostAuthAction>) -> Self {
312        Self { post_auth_action }
313    }
314}
315
316/// `GET|POST /register/password`
317#[derive(Default, Debug, Clone, Serialize, Deserialize)]
318pub struct PasswordRegister {
319    username: Option<String>,
320
321    #[serde(flatten)]
322    post_auth_action: Option<PostAuthAction>,
323}
324
325impl PasswordRegister {
326    #[must_use]
327    pub fn and_then(mut self, action: PostAuthAction) -> Self {
328        self.post_auth_action = Some(action);
329        self
330    }
331
332    #[must_use]
333    pub fn and_continue_grant(mut self, data: Ulid) -> Self {
334        self.post_auth_action = Some(PostAuthAction::continue_grant(data));
335        self
336    }
337
338    #[must_use]
339    pub fn and_continue_compat_sso_login(mut self, data: Ulid) -> Self {
340        self.post_auth_action = Some(PostAuthAction::continue_compat_sso_login(data));
341        self
342    }
343
344    /// Get a reference to the post auth action.
345    #[must_use]
346    pub fn post_auth_action(&self) -> Option<&PostAuthAction> {
347        self.post_auth_action.as_ref()
348    }
349
350    /// Get a reference to the username chosen by the user.
351    #[must_use]
352    pub fn username(&self) -> Option<&str> {
353        self.username.as_deref()
354    }
355
356    pub fn go_next(&self, url_builder: &UrlBuilder) -> axum::response::Redirect {
357        match &self.post_auth_action {
358            Some(action) => action.go_next(url_builder),
359            None => url_builder.redirect(&Index),
360        }
361    }
362}
363
364impl Route for PasswordRegister {
365    type Query = Self;
366
367    fn route() -> &'static str {
368        "/register/password"
369    }
370
371    fn query(&self) -> Option<&Self::Query> {
372        Some(self)
373    }
374}
375
376impl From<Option<PostAuthAction>> for PasswordRegister {
377    fn from(post_auth_action: Option<PostAuthAction>) -> Self {
378        Self {
379            username: None,
380            post_auth_action,
381        }
382    }
383}
384
385/// `GET|POST /register/steps/{id}/token`
386#[derive(Debug, Clone)]
387pub struct RegisterToken {
388    id: Ulid,
389}
390
391impl RegisterToken {
392    #[must_use]
393    pub fn new(id: Ulid) -> Self {
394        Self { id }
395    }
396}
397
398impl Route for RegisterToken {
399    type Query = ();
400    fn route() -> &'static str {
401        "/register/steps/{id}/token"
402    }
403
404    fn path(&self) -> std::borrow::Cow<'static, str> {
405        format!("/register/steps/{}/token", self.id).into()
406    }
407}
408
409/// `GET|POST /register/steps/{id}/display-name`
410#[derive(Debug, Clone)]
411pub struct RegisterDisplayName {
412    id: Ulid,
413}
414
415impl RegisterDisplayName {
416    #[must_use]
417    pub fn new(id: Ulid) -> Self {
418        Self { id }
419    }
420}
421
422impl Route for RegisterDisplayName {
423    type Query = ();
424    fn route() -> &'static str {
425        "/register/steps/{id}/display-name"
426    }
427
428    fn path(&self) -> std::borrow::Cow<'static, str> {
429        format!("/register/steps/{}/display-name", self.id).into()
430    }
431}
432
433/// `GET|POST /register/steps/{id}/verify-email`
434#[derive(Debug, Clone)]
435pub struct RegisterVerifyEmail {
436    id: Ulid,
437}
438
439impl RegisterVerifyEmail {
440    #[must_use]
441    pub fn new(id: Ulid) -> Self {
442        Self { id }
443    }
444}
445
446impl Route for RegisterVerifyEmail {
447    type Query = ();
448    fn route() -> &'static str {
449        "/register/steps/{id}/verify-email"
450    }
451
452    fn path(&self) -> std::borrow::Cow<'static, str> {
453        format!("/register/steps/{}/verify-email", self.id).into()
454    }
455}
456
457/// `GET /register/steps/{id}/finish`
458#[derive(Debug, Clone)]
459pub struct RegisterFinish {
460    id: Ulid,
461}
462
463impl RegisterFinish {
464    #[must_use]
465    pub const fn new(id: Ulid) -> Self {
466        Self { id }
467    }
468}
469
470impl Route for RegisterFinish {
471    type Query = ();
472    fn route() -> &'static str {
473        "/register/steps/{id}/finish"
474    }
475
476    fn path(&self) -> std::borrow::Cow<'static, str> {
477        format!("/register/steps/{}/finish", self.id).into()
478    }
479}
480
481/// Actions parameters as defined by MSC2965
482#[derive(Debug, Clone, Serialize, Deserialize)]
483#[serde(tag = "action")]
484pub enum AccountAction {
485    #[serde(rename = "org.matrix.profile")]
486    OrgMatrixProfile,
487    #[serde(rename = "profile")]
488    Profile,
489
490    #[serde(rename = "org.matrix.sessions_list")]
491    OrgMatrixSessionsList,
492    #[serde(rename = "sessions_list")]
493    SessionsList,
494
495    #[serde(rename = "org.matrix.session_view")]
496    OrgMatrixSessionView { device_id: String },
497    #[serde(rename = "session_view")]
498    SessionView { device_id: String },
499
500    #[serde(rename = "org.matrix.session_end")]
501    OrgMatrixSessionEnd { device_id: String },
502    #[serde(rename = "session_end")]
503    SessionEnd { device_id: String },
504
505    #[serde(rename = "org.matrix.cross_signing_reset")]
506    OrgMatrixCrossSigningReset,
507}
508
509/// `GET /account/`
510#[derive(Default, Debug, Clone)]
511pub struct Account {
512    action: Option<AccountAction>,
513}
514
515impl Route for Account {
516    type Query = AccountAction;
517
518    fn route() -> &'static str {
519        "/account/"
520    }
521
522    fn query(&self) -> Option<&Self::Query> {
523        self.action.as_ref()
524    }
525}
526
527/// `GET /account/*`
528#[derive(Default, Debug, Clone)]
529pub struct AccountWildcard;
530
531impl SimpleRoute for AccountWildcard {
532    const PATH: &'static str = "/account/{*rest}";
533}
534
535/// `GET /account/password/change`
536///
537/// Handled by the React frontend; this struct definition is purely for
538/// redirects.
539#[derive(Default, Debug, Clone)]
540pub struct AccountPasswordChange;
541
542impl SimpleRoute for AccountPasswordChange {
543    const PATH: &'static str = "/account/password/change";
544}
545
546/// `GET /consent/{grant_id}`
547#[derive(Debug, Clone)]
548pub struct Consent(pub Ulid);
549
550impl Route for Consent {
551    type Query = ();
552    fn route() -> &'static str {
553        "/consent/{grant_id}"
554    }
555
556    fn path(&self) -> std::borrow::Cow<'static, str> {
557        format!("/consent/{}", self.0).into()
558    }
559}
560
561/// `GET|POST /_matrix/client/v3/login`
562pub struct CompatLogin;
563
564impl SimpleRoute for CompatLogin {
565    const PATH: &'static str = "/_matrix/client/{version}/login";
566}
567
568/// `POST /_matrix/client/v3/logout`
569pub struct CompatLogout;
570
571impl SimpleRoute for CompatLogout {
572    const PATH: &'static str = "/_matrix/client/{version}/logout";
573}
574
575/// `POST /_matrix/client/v3/logout/all`
576pub struct CompatLogoutAll;
577
578impl SimpleRoute for CompatLogoutAll {
579    const PATH: &'static str = "/_matrix/client/{version}/logout/all";
580}
581
582/// `POST /_matrix/client/v3/refresh`
583pub struct CompatRefresh;
584
585impl SimpleRoute for CompatRefresh {
586    const PATH: &'static str = "/_matrix/client/{version}/refresh";
587}
588
589/// `GET /_matrix/client/v3/login/sso/redirect`
590pub struct CompatLoginSsoRedirect;
591
592impl SimpleRoute for CompatLoginSsoRedirect {
593    const PATH: &'static str = "/_matrix/client/{version}/login/sso/redirect";
594}
595
596/// `GET /_matrix/client/v3/login/sso/redirect/`
597///
598/// This is a workaround for the fact some clients (Element iOS) sends a
599/// trailing slash, even though it's not in the spec.
600pub struct CompatLoginSsoRedirectSlash;
601
602impl SimpleRoute for CompatLoginSsoRedirectSlash {
603    const PATH: &'static str = "/_matrix/client/{version}/login/sso/redirect/";
604}
605
606/// `GET /_matrix/client/v3/login/sso/redirect/{idp}`
607pub struct CompatLoginSsoRedirectIdp;
608
609impl SimpleRoute for CompatLoginSsoRedirectIdp {
610    const PATH: &'static str = "/_matrix/client/{version}/login/sso/redirect/{idp}";
611}
612
613#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
614#[serde(rename_all = "lowercase")]
615pub enum CompatLoginSsoAction {
616    Login,
617    Register,
618}
619
620#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
621pub struct CompatLoginSsoActionParams {
622    action: CompatLoginSsoAction,
623    /// DEPRECATED: Use `action` instead. We will remove this once enough
624    /// clients support the stable name.
625    #[serde(rename = "org.matrix.msc3824.action")]
626    unstable_action: CompatLoginSsoAction,
627}
628
629/// `GET|POST /complete-compat-sso/{id}`
630pub struct CompatLoginSsoComplete {
631    id: Ulid,
632    query: Option<CompatLoginSsoActionParams>,
633}
634
635impl CompatLoginSsoComplete {
636    #[must_use]
637    pub fn new(id: Ulid, action: Option<CompatLoginSsoAction>) -> Self {
638        Self {
639            id,
640            query: action.map(|action| CompatLoginSsoActionParams {
641                action,
642                unstable_action: action,
643            }),
644        }
645    }
646}
647
648impl Route for CompatLoginSsoComplete {
649    type Query = CompatLoginSsoActionParams;
650
651    fn query(&self) -> Option<&Self::Query> {
652        self.query.as_ref()
653    }
654
655    fn route() -> &'static str {
656        "/complete-compat-sso/{grant_id}"
657    }
658
659    fn path(&self) -> std::borrow::Cow<'static, str> {
660        format!("/complete-compat-sso/{}", self.id).into()
661    }
662}
663
664/// `GET /upstream/authorize/{id}`
665pub struct UpstreamOAuth2Authorize {
666    id: Ulid,
667    post_auth_action: Option<PostAuthAction>,
668}
669
670impl UpstreamOAuth2Authorize {
671    #[must_use]
672    pub const fn new(id: Ulid) -> Self {
673        Self {
674            id,
675            post_auth_action: None,
676        }
677    }
678
679    #[must_use]
680    pub fn and_then(mut self, action: PostAuthAction) -> Self {
681        self.post_auth_action = Some(action);
682        self
683    }
684}
685
686impl Route for UpstreamOAuth2Authorize {
687    type Query = PostAuthAction;
688    fn route() -> &'static str {
689        "/upstream/authorize/{provider_id}"
690    }
691
692    fn path(&self) -> std::borrow::Cow<'static, str> {
693        format!("/upstream/authorize/{}", self.id).into()
694    }
695
696    fn query(&self) -> Option<&Self::Query> {
697        self.post_auth_action.as_ref()
698    }
699}
700
701/// `GET /upstream/callback/{id}`
702pub struct UpstreamOAuth2Callback {
703    id: Ulid,
704}
705
706impl UpstreamOAuth2Callback {
707    #[must_use]
708    pub const fn new(id: Ulid) -> Self {
709        Self { id }
710    }
711}
712
713impl Route for UpstreamOAuth2Callback {
714    type Query = ();
715    fn route() -> &'static str {
716        "/upstream/callback/{provider_id}"
717    }
718
719    fn path(&self) -> std::borrow::Cow<'static, str> {
720        format!("/upstream/callback/{}", self.id).into()
721    }
722}
723
724/// `GET /upstream/link/{id}`
725pub struct UpstreamOAuth2Link {
726    id: Ulid,
727}
728
729impl UpstreamOAuth2Link {
730    #[must_use]
731    pub const fn new(id: Ulid) -> Self {
732        Self { id }
733    }
734}
735
736impl Route for UpstreamOAuth2Link {
737    type Query = ();
738    fn route() -> &'static str {
739        "/upstream/link/{link_id}"
740    }
741
742    fn path(&self) -> std::borrow::Cow<'static, str> {
743        format!("/upstream/link/{}", self.id).into()
744    }
745}
746
747/// `POST /upstream/backchannel-logout/{id}`
748pub struct UpstreamOAuth2BackchannelLogout {
749    id: Ulid,
750}
751
752impl UpstreamOAuth2BackchannelLogout {
753    #[must_use]
754    pub const fn new(id: Ulid) -> Self {
755        Self { id }
756    }
757}
758
759impl Route for UpstreamOAuth2BackchannelLogout {
760    type Query = ();
761    fn route() -> &'static str {
762        "/upstream/backchannel-logout/{provider_id}"
763    }
764
765    fn path(&self) -> std::borrow::Cow<'static, str> {
766        format!("/upstream/backchannel-logout/{}", self.id).into()
767    }
768}
769
770/// `GET|POST /link`
771#[derive(Default, Serialize, Deserialize, Debug, Clone)]
772pub struct DeviceCodeLink {
773    code: Option<String>,
774}
775
776impl DeviceCodeLink {
777    #[must_use]
778    pub fn with_code(code: String) -> Self {
779        Self { code: Some(code) }
780    }
781}
782
783impl Route for DeviceCodeLink {
784    type Query = DeviceCodeLink;
785    fn route() -> &'static str {
786        "/link"
787    }
788
789    fn query(&self) -> Option<&Self::Query> {
790        Some(self)
791    }
792}
793
794/// `GET|POST /device/{device_code_id}`
795#[derive(Default, Serialize, Deserialize, Debug, Clone)]
796pub struct DeviceCodeConsent {
797    id: Ulid,
798}
799
800impl Route for DeviceCodeConsent {
801    type Query = ();
802    fn route() -> &'static str {
803        "/device/{device_code_id}"
804    }
805
806    fn path(&self) -> std::borrow::Cow<'static, str> {
807        format!("/device/{}", self.id).into()
808    }
809}
810
811impl DeviceCodeConsent {
812    #[must_use]
813    pub fn new(id: Ulid) -> Self {
814        Self { id }
815    }
816}
817
818/// `POST /oauth2/device`
819#[derive(Default, Serialize, Deserialize, Debug, Clone)]
820pub struct OAuth2DeviceAuthorizationEndpoint;
821
822impl SimpleRoute for OAuth2DeviceAuthorizationEndpoint {
823    const PATH: &'static str = "/oauth2/device";
824}
825
826/// `GET|POST /recover`
827#[derive(Default, Serialize, Deserialize, Debug, Clone)]
828pub struct AccountRecoveryStart;
829
830impl SimpleRoute for AccountRecoveryStart {
831    const PATH: &'static str = "/recover";
832}
833
834/// `GET|POST /recover/progress/{session_id}`
835#[derive(Default, Serialize, Deserialize, Debug, Clone)]
836pub struct AccountRecoveryProgress {
837    session_id: Ulid,
838}
839
840impl AccountRecoveryProgress {
841    #[must_use]
842    pub fn new(session_id: Ulid) -> Self {
843        Self { session_id }
844    }
845}
846
847impl Route for AccountRecoveryProgress {
848    type Query = ();
849    fn route() -> &'static str {
850        "/recover/progress/{session_id}"
851    }
852
853    fn path(&self) -> std::borrow::Cow<'static, str> {
854        format!("/recover/progress/{}", self.session_id).into()
855    }
856}
857
858/// `GET /account/password/recovery?ticket=:ticket`
859/// Rendered by the React frontend
860#[derive(Default, Serialize, Deserialize, Debug, Clone)]
861pub struct AccountRecoveryFinish {
862    ticket: String,
863}
864
865impl AccountRecoveryFinish {
866    #[must_use]
867    pub fn new(ticket: String) -> Self {
868        Self { ticket }
869    }
870}
871
872impl Route for AccountRecoveryFinish {
873    type Query = AccountRecoveryFinish;
874
875    fn route() -> &'static str {
876        "/account/password/recovery"
877    }
878
879    fn query(&self) -> Option<&Self::Query> {
880        Some(self)
881    }
882}
883
884/// `GET /assets`
885pub struct StaticAsset {
886    path: String,
887}
888
889impl StaticAsset {
890    #[must_use]
891    pub fn new(path: String) -> Self {
892        Self { path }
893    }
894}
895
896impl Route for StaticAsset {
897    type Query = ();
898    fn route() -> &'static str {
899        "/assets/"
900    }
901
902    fn path(&self) -> std::borrow::Cow<'static, str> {
903        format!("/assets/{}", self.path).into()
904    }
905}
906
907/// `GET|POST /graphql`
908pub struct GraphQL;
909
910impl SimpleRoute for GraphQL {
911    const PATH: &'static str = "/graphql";
912}
913
914/// `GET /graphql/playground`
915pub struct GraphQLPlayground;
916
917impl SimpleRoute for GraphQLPlayground {
918    const PATH: &'static str = "/graphql/playground";
919}
920
921/// `GET /api/spec.json`
922pub struct ApiSpec;
923
924impl SimpleRoute for ApiSpec {
925    const PATH: &'static str = "/api/spec.json";
926}
927
928/// `GET /api/doc/`
929pub struct ApiDoc;
930
931impl SimpleRoute for ApiDoc {
932    const PATH: &'static str = "/api/doc/";
933}
934
935/// `GET /api/doc/oauth2-callback`
936pub struct ApiDocCallback;
937
938impl SimpleRoute for ApiDocCallback {
939    const PATH: &'static str = "/api/doc/oauth2-callback";
940}
mas_router/endpoints.rs

mas_router/
endpoints.rs
