Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions src/api/client/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ pub(super) mod media_legacy;
pub(super) mod membership;
pub(super) mod message;
pub(super) mod openid;
pub(super) mod oidc;
pub(super) mod presence;
pub(super) mod profile;
pub(super) mod push;
Expand Down Expand Up @@ -63,6 +64,7 @@ pub(super) use media_legacy::*;
pub(super) use membership::*;
pub(super) use message::*;
pub(super) use openid::*;
pub(super) use oidc::*;
pub(super) use presence::*;
pub(super) use profile::*;
pub(super) use push::*;
Expand Down
222 changes: 222 additions & 0 deletions src/api/client/oidc.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
use std::time::SystemTime;

use axum::{Json, extract::State, response::{IntoResponse, Redirect}};
use axum_extra::{TypedHeader, headers::{Authorization, authorization::Bearer}};
use http::StatusCode;
use ruma::OwnedDeviceId;
use serde::{Deserialize, Serialize};
use tuwunel_core::{Err, Result, err, info, utils};
use tuwunel_service::{oauth::oidc_server::{DcrRequest, IdTokenClaims, OidcAuthRequest, OidcServer, ProviderMetadata}, users::device::generate_refresh_token};

const OIDC_REQ_ID_LENGTH: usize = 32;

#[derive(Serialize)]
struct AuthIssuerResponse { issuer: String }

pub(crate) async fn auth_issuer_route(State(services): State<crate::State>) -> Result<impl IntoResponse> {
let issuer = oidc_issuer_url(&services)?;
Ok(Json(AuthIssuerResponse { issuer }))
}

pub(crate) async fn openid_configuration_route(State(services): State<crate::State>) -> Result<impl IntoResponse> {
Ok(Json(oidc_metadata(&services)?))
}

fn oidc_metadata(services: &tuwunel_service::Services) -> Result<ProviderMetadata> {
let issuer = oidc_issuer_url(services)?;
let base = issuer.trim_end_matches('/').to_owned();

Ok(ProviderMetadata {
issuer,
authorization_endpoint: format!("{base}/_tuwunel/oidc/authorize"),
token_endpoint: format!("{base}/_tuwunel/oidc/token"),
registration_endpoint: Some(format!("{base}/_tuwunel/oidc/registration")),
revocation_endpoint: Some(format!("{base}/_tuwunel/oidc/revoke")),
jwks_uri: format!("{base}/_tuwunel/oidc/jwks"),
userinfo_endpoint: Some(format!("{base}/_tuwunel/oidc/userinfo")),
account_management_uri: Some(format!("{base}/_tuwunel/oidc/account")),
account_management_actions_supported: Some(vec!["org.matrix.profile".to_owned(), "org.matrix.sessions_list".to_owned(), "org.matrix.session_view".to_owned(), "org.matrix.session_end".to_owned(), "org.matrix.cross_signing_reset".to_owned()]),
response_types_supported: vec!["code".to_owned()],
response_modes_supported: Some(vec!["query".to_owned(), "fragment".to_owned()]),
grant_types_supported: Some(vec!["authorization_code".to_owned(), "refresh_token".to_owned()]),
code_challenge_methods_supported: Some(vec!["S256".to_owned()]),
token_endpoint_auth_methods_supported: Some(vec!["none".to_owned(), "client_secret_basic".to_owned(), "client_secret_post".to_owned()]),
scopes_supported: Some(vec!["openid".to_owned(), "urn:matrix:org.matrix.msc2967.client:api:*".to_owned(), "urn:matrix:org.matrix.msc2967.client:device:*".to_owned()]),
subject_types_supported: Some(vec!["public".to_owned()]),
id_token_signing_alg_values_supported: Some(vec!["ES256".to_owned()]),
prompt_values_supported: Some(vec!["create".to_owned()]),
claim_types_supported: Some(vec!["normal".to_owned()]),
claims_supported: Some(vec!["iss".to_owned(), "sub".to_owned(), "aud".to_owned(), "exp".to_owned(), "iat".to_owned(), "nonce".to_owned()]),
})
}

pub(crate) async fn registration_route(State(services): State<crate::State>, Json(body): Json<DcrRequest>) -> Result<impl IntoResponse> {
let Ok(oidc) = get_oidc_server(&services) else { return Err!(Request(NotFound("OIDC server not configured"))); };

if body.redirect_uris.is_empty() { return Err!(Request(InvalidParam("redirect_uris must not be empty"))); }

let reg = oidc.register_client(body)?;
info!("OIDC client registered: {} ({})", reg.client_id, reg.client_name.as_deref().unwrap_or("unnamed"));

Ok((StatusCode::CREATED, Json(serde_json::json!({"client_id": reg.client_id, "client_id_issued_at": reg.registered_at, "redirect_uris": reg.redirect_uris, "client_name": reg.client_name, "client_uri": reg.client_uri, "logo_uri": reg.logo_uri, "contacts": reg.contacts, "token_endpoint_auth_method": reg.token_endpoint_auth_method, "grant_types": reg.grant_types, "response_types": reg.response_types, "application_type": reg.application_type, "policy_uri": reg.policy_uri, "tos_uri": reg.tos_uri, "software_id": reg.software_id, "software_version": reg.software_version}))))
}

#[derive(Debug, Deserialize)]
pub(crate) struct AuthorizeParams {
client_id: String, redirect_uri: String, response_type: String, scope: String,
state: Option<String>, nonce: Option<String>, code_challenge: Option<String>,
code_challenge_method: Option<String>, #[serde(default, rename = "prompt")] _prompt: Option<String>,
}

pub(crate) async fn authorize_route(State(services): State<crate::State>, request: axum::extract::Request) -> Result<impl IntoResponse> {
let params: AuthorizeParams = serde_html_form::from_str(request.uri().query().unwrap_or_default())?;
let Ok(oidc) = get_oidc_server(&services) else { return Err!(Request(NotFound("OIDC server not configured"))); };

if params.response_type != "code" { return Err!(Request(InvalidParam("Only response_type=code is supported"))); }

oidc.validate_redirect_uri(&params.client_id, &params.redirect_uri).await?;

if !scope_contains_token(&params.scope, "openid") { return Err!(Request(InvalidParam("openid scope is required"))); }

let req_id = utils::random_string(OIDC_REQ_ID_LENGTH);
let now = SystemTime::now();

oidc.store_auth_request(&req_id, &OidcAuthRequest {
client_id: params.client_id, redirect_uri: params.redirect_uri, scope: params.scope,
state: params.state, nonce: params.nonce, code_challenge: params.code_challenge,
code_challenge_method: params.code_challenge_method, created_at: now,
expires_at: now.checked_add(OidcServer::auth_request_lifetime()).unwrap_or(now),
});

let default_idp = services.config.identity_provider.values().find(|idp| idp.default).or_else(|| services.config.identity_provider.values().next()).ok_or_else(|| err!(Config("identity_provider", "No identity provider configured")))?;
let idp_id = default_idp.id();

let base = oidc_issuer_url(&services)?;
let base = base.trim_end_matches('/');

let mut complete_url = url::Url::parse(&format!("{base}/_tuwunel/oidc/_complete")).map_err(|_| err!(error!("Failed to build complete URL")))?;
complete_url.query_pairs_mut().append_pair("oidc_req_id", &req_id);

let mut sso_url = url::Url::parse(&format!("{base}/_matrix/client/v3/login/sso/redirect/{idp_id}")).map_err(|_| err!(error!("Failed to build SSO URL")))?;
sso_url.query_pairs_mut().append_pair("redirectUrl", complete_url.as_str());

Ok(Redirect::temporary(sso_url.as_str()))
}

#[derive(Debug, Deserialize)]
pub(crate) struct CompleteParams { oidc_req_id: String, #[serde(rename = "loginToken")] login_token: String }

pub(crate) async fn complete_route(State(services): State<crate::State>, request: axum::extract::Request) -> Result<impl IntoResponse> {
let params: CompleteParams = serde_html_form::from_str(request.uri().query().unwrap_or_default())?;
let Ok(oidc) = get_oidc_server(&services) else { return Err!(Request(NotFound("OIDC server not configured"))); };

let user_id = services.users.find_from_login_token(&params.login_token).await.map_err(|_| err!(Request(Forbidden("Invalid or expired login token"))))?;
let auth_req = oidc.take_auth_request(&params.oidc_req_id).await?;
let code = oidc.create_auth_code(&auth_req, user_id);

let mut redirect_url = url::Url::parse(&auth_req.redirect_uri).map_err(|_| err!(Request(InvalidParam("Invalid redirect_uri"))))?;
redirect_url.query_pairs_mut().append_pair("code", &code);
if let Some(state) = &auth_req.state { redirect_url.query_pairs_mut().append_pair("state", state); }

Ok(Redirect::temporary(redirect_url.as_str()))
}

#[derive(Debug, Deserialize)]
pub(crate) struct TokenRequest {
grant_type: String, code: Option<String>, redirect_uri: Option<String>, client_id: Option<String>,
code_verifier: Option<String>, refresh_token: Option<String>, #[serde(rename = "scope")] _scope: Option<String>,
}

pub(crate) async fn token_route(State(services): State<crate::State>, axum::extract::Form(body): axum::extract::Form<TokenRequest>) -> impl IntoResponse {
match body.grant_type.as_str() {
| "authorization_code" => token_authorization_code(&services, &body).await.unwrap_or_else(|e| oauth_error(StatusCode::INTERNAL_SERVER_ERROR, "server_error", &e.to_string())),
| "refresh_token" => token_refresh(&services, &body).await.unwrap_or_else(|e| oauth_error(StatusCode::INTERNAL_SERVER_ERROR, "server_error", &e.to_string())),
| _ => oauth_error(StatusCode::BAD_REQUEST, "unsupported_grant_type", "Unsupported grant_type"),
}
}

async fn token_authorization_code(services: &tuwunel_service::Services, body: &TokenRequest) -> Result<http::Response<axum::body::Body>> {
let code = body.code.as_deref().ok_or_else(|| err!(Request(InvalidParam("code is required"))))?;
let redirect_uri = body.redirect_uri.as_deref().ok_or_else(|| err!(Request(InvalidParam("redirect_uri is required"))))?;
let client_id = body.client_id.as_deref().ok_or_else(|| err!(Request(InvalidParam("client_id is required"))))?;

let oidc = get_oidc_server(services)?;
let session = oidc.exchange_auth_code(code, client_id, redirect_uri, body.code_verifier.as_deref()).await?;

let user_id = &session.user_id;
let (access_token, expires_in) = services.users.generate_access_token(true);
let refresh_token = generate_refresh_token();

let device_id: Option<OwnedDeviceId> = extract_device_id(&session.scope).map(OwnedDeviceId::from);
let device_id = services.users.create_device(user_id, device_id.as_deref(), (Some(&access_token), expires_in), Some(&refresh_token), Some("OIDC Client"), None).await?;

info!("{user_id} logged in via OIDC (device {device_id})");

let id_token = if session.scope.contains("openid") {
let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap_or_default().as_secs();
let issuer = oidc_issuer_url(services)?;
let claims = IdTokenClaims { iss: issuer, sub: user_id.to_string(), aud: client_id.to_owned(), exp: now.saturating_add(3600), iat: now, nonce: session.nonce, at_hash: Some(OidcServer::at_hash(&access_token)) };
Some(oidc.sign_id_token(&claims)?)
} else { None };

let mut response = serde_json::json!({"access_token": access_token, "token_type": "Bearer", "scope": session.scope, "refresh_token": refresh_token});
if let Some(expires_in) = expires_in { response["expires_in"] = serde_json::json!(expires_in.as_secs()); }
if let Some(id_token) = id_token { response["id_token"] = serde_json::json!(id_token); }

Ok(Json(response).into_response())
}

async fn token_refresh(services: &tuwunel_service::Services, body: &TokenRequest) -> Result<http::Response<axum::body::Body>> {
let refresh_token = body.refresh_token.as_deref().ok_or_else(|| err!(Request(InvalidParam("refresh_token is required"))))?;
let (user_id, device_id, _) = services.users.find_from_token(refresh_token).await.map_err(|_| err!(Request(Forbidden("Invalid refresh token"))))?;

let (new_access_token, expires_in) = services.users.generate_access_token(true);
let new_refresh_token = generate_refresh_token();
services.users.set_access_token(&user_id, &device_id, &new_access_token, expires_in, Some(&new_refresh_token)).await?;

let mut response = serde_json::json!({"access_token": new_access_token, "token_type": "Bearer", "refresh_token": new_refresh_token});
if let Some(expires_in) = expires_in { response["expires_in"] = serde_json::json!(expires_in.as_secs()); }

Ok(Json(response).into_response())
}

#[derive(Debug, Deserialize)]
pub(crate) struct RevokeRequest { token: String, #[serde(default, rename = "token_type_hint")] _token_type_hint: Option<String> }

pub(crate) async fn revoke_route(State(services): State<crate::State>, axum::extract::Form(body): axum::extract::Form<RevokeRequest>) -> Result<impl IntoResponse> {
if let Ok((user_id, device_id, _)) = services.users.find_from_token(&body.token).await { services.users.remove_device(&user_id, &device_id).await; }
Ok(Json(serde_json::json!({})))
}

pub(crate) async fn jwks_route(State(services): State<crate::State>) -> Result<impl IntoResponse> {
let oidc = get_oidc_server(&services)?;
Ok(Json(oidc.jwks()))
}

pub(crate) async fn userinfo_route(State(services): State<crate::State>, TypedHeader(Authorization(bearer)): TypedHeader<Authorization<Bearer>>) -> Result<impl IntoResponse> {
let token = bearer.token();
let Ok((user_id, _device_id, _expires)) = services.users.find_from_token(token).await else { return Err!(Request(Unauthorized("Invalid access token"))); };
let displayname = services.users.displayname(&user_id).await.ok();
let avatar_url = services.users.avatar_url(&user_id).await.ok();
Ok(Json(serde_json::json!({"sub": user_id.to_string(), "name": displayname, "picture": avatar_url})))
}

pub(crate) async fn account_route() -> impl IntoResponse {
axum::response::Html("<html><body><h1>Account Management</h1><p>Account management is not yet implemented. Please use your identity provider to manage your account.</p></body></html>")
}

fn oauth_error(status: StatusCode, error: &str, description: &str) -> http::Response<axum::body::Body> {
(status, Json(serde_json::json!({"error": error, "error_description": description}))).into_response()
}

fn scope_contains_token(scope: &str, token: &str) -> bool { scope.split_whitespace().any(|t| t == token) }

fn get_oidc_server(services: &tuwunel_service::Services) -> Result<&OidcServer> {
services.oauth.oidc_server.as_deref().ok_or_else(|| err!(Request(NotFound("OIDC server not configured"))))
}

fn oidc_issuer_url(services: &tuwunel_service::Services) -> Result<String> {
services.config.well_known.client.as_ref().map(|url| { let s = url.to_string(); if s.ends_with('/') { s } else { s + "/" } }).ok_or_else(|| err!(Config("well_known.client", "well_known.client must be set for OIDC server")))
}

fn extract_device_id(scope: &str) -> Option<String> { scope.split_whitespace().find_map(|s| s.strip_prefix("urn:matrix:org.matrix.msc2967.client:device:")).map(ToOwned::to_owned) }
10 changes: 9 additions & 1 deletion src/api/client/versions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ static VERSIONS: [&str; 17] = [
"v1.15", /* custom profile fields */
];

static UNSTABLE_FEATURES: [&str; 18] = [
static UNSTABLE_FEATURES: [&str; 22] = [
"org.matrix.e2e_cross_signing",
// private read receipts (https://github.com/matrix-org/matrix-spec-proposals/pull/2285)
"org.matrix.msc2285.stable",
Expand Down Expand Up @@ -86,4 +86,12 @@ static UNSTABLE_FEATURES: [&str; 18] = [
"org.matrix.simplified_msc3575",
// Allow room moderators to view redacted event content (https://github.com/matrix-org/matrix-spec-proposals/pull/2815)
"fi.mau.msc2815",
// OIDC-native auth: authorization code grant (https://github.com/matrix-org/matrix-spec-proposals/pull/2964)
"org.matrix.msc2964",
// OIDC-native auth: auth issuer discovery (https://github.com/matrix-org/matrix-spec-proposals/pull/2965)
"org.matrix.msc2965",
// OIDC-native auth: dynamic client registration (https://github.com/matrix-org/matrix-spec-proposals/pull/2966)
"org.matrix.msc2966",
// OIDC-native auth: API scopes (https://github.com/matrix-org/matrix-spec-proposals/pull/2967)
"org.matrix.msc2967",
];
14 changes: 14 additions & 0 deletions src/api/router.rs
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,20 @@ pub fn build(router: Router<State>, server: &Server) -> Router<State> {
.ruma_route(&client::well_known_support)
.ruma_route(&client::well_known_client)
.route("/_tuwunel/server_version", get(client::tuwunel_server_version))
// OIDC server endpoints (next-gen auth, MSC2965/2964/2966/2967)
.route("/_matrix/client/unstable/org.matrix.msc2965/auth_issuer", get(client::auth_issuer_route))
.route("/_matrix/client/v1/auth_issuer", get(client::auth_issuer_route))
.route("/_matrix/client/unstable/org.matrix.msc2965/auth_metadata", get(client::openid_configuration_route))
.route("/_matrix/client/v1/auth_metadata", get(client::openid_configuration_route))
.route("/.well-known/openid-configuration", get(client::openid_configuration_route))
.route("/_tuwunel/oidc/registration", post(client::registration_route))
.route("/_tuwunel/oidc/authorize", get(client::authorize_route))
.route("/_tuwunel/oidc/_complete", get(client::complete_route))
.route("/_tuwunel/oidc/token", post(client::token_route))
.route("/_tuwunel/oidc/revoke", post(client::revoke_route))
.route("/_tuwunel/oidc/jwks", get(client::jwks_route))
.route("/_tuwunel/oidc/userinfo", get(client::userinfo_route))
.route("/_tuwunel/oidc/account", get(client::account_route))
.ruma_route(&client::room_initial_sync_route)
.route("/client/server.json", get(client::syncv3_client_server_json));

Expand Down
16 changes: 16 additions & 0 deletions src/database/maps.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,22 @@ pub(super) static MAPS: &[Descriptor] = &[
name: "oauthuniqid_oauthid",
..descriptor::RANDOM_SMALL
},
Descriptor {
name: "oidc_signingkey",
..descriptor::RANDOM_SMALL
},
Descriptor {
name: "oidcclientid_registration",
..descriptor::RANDOM_SMALL
},
Descriptor {
name: "oidccode_authsession",
..descriptor::RANDOM_SMALL
},
Descriptor {
name: "oidcreqid_authrequest",
..descriptor::RANDOM_SMALL
},
Descriptor {
name: "onetimekeyid_onetimekeys",
..descriptor::RANDOM_SMALL
Expand Down
1 change: 1 addition & 0 deletions src/service/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ lru-cache.workspace = true
rand.workspace = true
regex.workspace = true
reqwest.workspace = true
ring.workspace = true
ruma.workspace = true
rustls.workspace = true
rustyline-async.workspace = true
Expand Down
23 changes: 21 additions & 2 deletions src/service/oauth/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
pub mod oidc_server;
pub mod providers;
pub mod sessions;
pub mod user_info;
Expand All @@ -14,13 +15,14 @@ use ruma::UserId;
use serde::Serialize;
use serde_json::Value as JsonValue;
use tuwunel_core::{
Err, Result, err, implement,
Err, Result, err, implement, info, warn,
utils::{hash::sha256, result::LogErr, stream::ReadyExt},
};
use url::Url;

use self::{providers::Providers, sessions::Sessions};
use self::{oidc_server::OidcServer, providers::Providers, sessions::Sessions};
pub use self::{
oidc_server::ProviderMetadata,
providers::{Provider, ProviderId},
sessions::{CODE_VERIFIER_LENGTH, SESSION_ID_LENGTH, Session, SessionId},
user_info::UserInfo,
Expand All @@ -31,16 +33,33 @@ pub struct Service {
services: SelfServices,
pub providers: Arc<Providers>,
pub sessions: Arc<Sessions>,
/// OIDC server (authorization server) for next-gen Matrix auth.
/// Only initialized when identity providers are configured.
pub oidc_server: Option<Arc<OidcServer>>,
}

impl crate::Service for Service {
fn build(args: &crate::Args<'_>) -> Result<Arc<Self>> {
let providers = Arc::new(Providers::build(args));
let sessions = Arc::new(Sessions::build(args, providers.clone()));

let oidc_server = if !args.server.config.identity_provider.is_empty()
|| args.server.config.well_known.client.is_some()
{
if args.server.config.identity_provider.is_empty() {
warn!("OIDC server enabled (well_known.client is set) but no identity_provider configured; authorization flow will not work");
}
info!("Initializing OIDC server for next-gen auth (MSC2965)");
Some(Arc::new(OidcServer::build(args)?))
} else {
None
};

Ok(Arc::new(Self {
services: args.services.clone(),
sessions,
providers,
oidc_server,
}))
}

Expand Down
Loading