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
//! `GET /_matrix/client/*/login/sso/redirect`
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3loginssoredirect
use http::header::{LOCATION, SET_COOKIE};
use ruma_common::{
api::{auth_scheme::NoAuthentication, request, response},
metadata,
};
#[cfg(feature = "unstable-msc3824")]
use crate::session::SsoRedirectOidcAction;
metadata! {
method: GET,
rate_limited: false,
authentication: NoAuthentication,
history: {
1.0 => "/_matrix/client/r0/login/sso/redirect",
1.1 => "/_matrix/client/v3/login/sso/redirect",
}
}
/// Request type for the `sso_login` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// URL to which the homeserver should return the user after completing
/// authentication with the SSO identity provider.
#[ruma_api(query)]
#[serde(rename = "redirectUrl")]
pub redirect_url: String,
/// The purpose for using the SSO redirect URL for OIDC-aware compatibility.
///
/// This field uses the unstable prefix defined in [MSC3824].
///
/// [MSC3824]: https://github.com/matrix-org/matrix-spec-proposals/pull/3824
#[cfg(feature = "unstable-msc3824")]
#[ruma_api(query)]
#[serde(skip_serializing_if = "Option::is_none", rename = "org.matrix.msc3824.action")]
pub action: Option<SsoRedirectOidcAction>,
}
/// Response type for the `sso_login` endpoint.
#[response(error = crate::Error, status = FOUND)]
pub struct Response {
/// Redirect URL to the SSO identity provider.
#[ruma_api(header = LOCATION)]
pub location: String,
/// Cookie storing state to secure the SSO process.
#[ruma_api(header = SET_COOKIE)]
pub cookie: Option<String>,
}
impl Request {
/// Creates a new `Request` with the given redirect URL.
pub fn new(redirect_url: String) -> Self {
Self {
redirect_url,
#[cfg(feature = "unstable-msc3824")]
action: None,
}
}
}
impl Response {
/// Creates a new `Response` with the given SSO URL.
pub fn new(location: String) -> Self {
Self { location, cookie: None }
}
}
#[cfg(all(test, feature = "client"))]
mod tests {
use std::borrow::Cow;
use ruma_common::api::{
MatrixVersion, OutgoingRequest, SupportedVersions, auth_scheme::SendAccessToken,
};
use super::Request;
#[test]
fn serialize_sso_login_request_uri() {
let supported = SupportedVersions {
versions: [MatrixVersion::V1_1].into(),
features: Default::default(),
};
let req: http::Request<Vec<u8>> = Request::new("https://example.com/sso".to_owned())
.try_into_http_request(
"https://homeserver.tld",
SendAccessToken::None,
Cow::Owned(supported),
)
.unwrap();
assert_eq!(
req.uri().to_string(),
"https://homeserver.tld/_matrix/client/v3/login/sso/redirect?redirectUrl=https%3A%2F%2Fexample.com%2Fsso"
);
}
}
}