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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
// Copyright 2022 Kévin Commaille
//
// 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 std::{collections::HashSet, num::NonZeroU32};
use language_tags::LanguageTag;
use mas_oidc_client::{
requests::authorization_code::{build_authorization_url, AuthorizationRequestData},
types::{
requests::{Display, Prompt},
scope::Scope,
},
};
use ruma::UserId;
use tracing::{error, info, instrument};
use url::Url;
use super::{Oidc, OidcError};
use crate::Result;
/// Builder type used to configure optional settings for authorization with an
/// OpenID Connect Provider via the Authorization Code flow.
///
/// Created with [`Oidc::authorize_scope()`] or [`Oidc::login()`]. Finalized
/// with [`Self::build()`].
#[allow(missing_debug_implementations)]
pub struct OidcAuthCodeUrlBuilder {
oidc: Oidc,
scope: Scope,
redirect_uri: Url,
display: Option<Display>,
prompt: Option<Vec<Prompt>>,
max_age: Option<NonZeroU32>,
ui_locales: Option<Vec<LanguageTag>>,
login_hint: Option<String>,
acr_values: Option<HashSet<String>>,
}
impl OidcAuthCodeUrlBuilder {
pub(super) fn new(oidc: Oidc, scope: Scope, redirect_uri: Url) -> Self {
Self {
oidc,
scope,
redirect_uri,
display: None,
prompt: None,
max_age: None,
ui_locales: None,
login_hint: None,
acr_values: None,
}
}
/// Set how the Authorization Server should display the authentication and
/// consent user interface pages to the End-User.
pub fn display(mut self, display: Display) -> Self {
self.display = Some(display);
self
}
/// Set the [`Prompt`] of the authorization URL.
///
/// [`Prompt::Create`] can be used to signify that the user wants to
/// register a new account. If [`Prompt::None`] is used, it must be the only
/// value.
pub fn prompt(mut self, prompt: Vec<Prompt>) -> Self {
self.prompt = Some(prompt);
self
}
/// Set the allowable elapsed time in seconds since the last time the
/// End-User was actively authenticated by the OpenID Provider.
pub fn max_age(mut self, max_age: NonZeroU32) -> Self {
self.max_age = Some(max_age);
self
}
/// Set the preferred locales of the user.
///
/// Must be ordered from the preferred locale to the least preferred locale.
pub fn ui_locales(mut self, ui_locales: Vec<LanguageTag>) -> Self {
self.ui_locales = Some(ui_locales);
self
}
/// Set the hint to the Authorization Server about the login identifier the
/// End-User might use to log in.
///
/// To set a Matrix user ID as a login hint, use [`Self::user_id_hint()`].
///
/// Erases any value set with [`Self::user_id_hint()`].
pub fn login_hint(mut self, login_hint: String) -> Self {
self.login_hint = Some(login_hint);
self
}
/// Set the hint to the Authorization Server about the Matrix user ID the
/// End-User might use to log in.
///
/// To set another type of identifier as a login hint, use
/// [`Self::login_hint()`].
///
/// Erases any value set with [`Self::login_hint()`].
pub fn user_id_hint(mut self, user_id: &UserId) -> Self {
self.login_hint = Some(format!("mxid:{user_id}"));
self
}
/// Set the requested Authentication Context Class Reference values.
///
/// This is only necessary with specific providers.
pub fn acr_values(mut self, acr_values: HashSet<String>) -> Self {
self.acr_values = Some(acr_values);
self
}
/// Get the URL that should be presented to login via the Authorization Code
/// flow.
///
/// This URL should be presented to the user and once they are redirected to
/// the `redirect_uri`, the authorization can be completed by calling
/// [`Oidc::finish_authorization()`].
///
/// Returns an error if the client registration was not restored, or if a
/// request fails.
#[instrument(target = "matrix_sdk::client", skip_all)]
pub async fn build(self) -> Result<OidcAuthorizationData, OidcError> {
let Self {
oidc,
scope,
redirect_uri,
display,
prompt,
max_age,
ui_locales,
login_hint,
acr_values,
} = self;
let data = oidc.data().ok_or(OidcError::NotAuthenticated)?;
info!(
issuer = data.issuer,
%scope, "Authorizing scope via the OpenID Connect Authorization Code flow"
);
let provider_metadata = oidc.provider_metadata().await?;
let mut authorization_data = AuthorizationRequestData::new(
data.credentials.client_id().to_owned(),
scope,
redirect_uri,
);
authorization_data.code_challenge_methods_supported =
provider_metadata.code_challenge_methods_supported.clone();
authorization_data.display = display;
authorization_data.prompt = prompt;
authorization_data.max_age = max_age;
authorization_data.ui_locales = ui_locales;
authorization_data.login_hint = login_hint;
authorization_data.acr_values = acr_values;
if let Some(id_token) = oidc.latest_id_token() {
authorization_data.id_token_hint = Some(id_token.into_string());
}
let authorization_endpoint = provider_metadata.authorization_endpoint();
let mut rng = super::rng()?;
// Try a pushed authorization request if the provider supports it.
let (url, validation_data) = if let Some(par_endpoint) =
&provider_metadata.pushed_authorization_request_endpoint
{
let client_credentials =
oidc.client_credentials().ok_or(OidcError::NotAuthenticated)?;
let res = oidc
.backend
.build_par_authorization_url(
client_credentials.clone(),
par_endpoint,
authorization_endpoint.clone(),
authorization_data.clone(),
)
.await;
match res {
Ok(res) => res,
Err(error) => {
// Keycloak doesn't allow public clients to use the PAR endpoint, so we
// should try a regular authorization URL instead.
// See: <https://github.com/keycloak/keycloak/issues/8939>
let client_metadata =
oidc.client_metadata().ok_or(OidcError::NotAuthenticated)?;
// If the client said that PAR should be enforced, we should not try without
// it, so just return the error.
if client_metadata.require_pushed_authorization_requests.unwrap_or(false) {
return Err(error);
}
error!(
?error,
"Error making a request to the Pushed Authorization Request endpoint. \
Falling back to a regular authorization URL"
);
build_authorization_url(
authorization_endpoint.clone(),
authorization_data,
&mut rng,
)?
}
}
} else {
build_authorization_url(authorization_endpoint.clone(), authorization_data, &mut rng)?
};
let state = validation_data.state.clone();
data.authorization_data.lock().await.insert(state.clone(), validation_data);
Ok(OidcAuthorizationData { url, state })
}
}
/// The data needed to perform authorization using OpenID Connect.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "uniffi", derive(uniffi::Object))]
pub struct OidcAuthorizationData {
/// The URL that should be presented.
pub url: Url,
/// A unique identifier for the request, used to ensure the response
/// originated from the authentication issuer.
pub state: String,
}
#[cfg(feature = "uniffi")]
#[matrix_sdk_ffi_macros::export]
impl OidcAuthorizationData {
/// The login URL to use for authorization.
pub fn login_url(&self) -> String {
self.url.to_string()
}
}