mas_handlers/upstream_oauth2/
cache.rs

1// Copyright 2024, 2025 New Vector Ltd.
2// Copyright 2023, 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 std::{collections::HashMap, sync::Arc};
8
9use mas_context::LogContext;
10use mas_data_model::{
11    UpstreamOAuthProvider, UpstreamOAuthProviderDiscoveryMode, UpstreamOAuthProviderPkceMode,
12};
13use mas_iana::oauth::PkceCodeChallengeMethod;
14use mas_oidc_client::error::DiscoveryError;
15use mas_storage::{RepositoryAccess, upstream_oauth2::UpstreamOAuthProviderRepository};
16use oauth2_types::oidc::VerifiedProviderMetadata;
17use tokio::sync::RwLock;
18use url::Url;
19
20/// A high-level layer over metadata cache and provider configuration, which
21/// resolves endpoint overrides and discovery modes.
22pub struct LazyProviderInfos<'a> {
23    cache: &'a MetadataCache,
24    provider: &'a UpstreamOAuthProvider,
25    client: &'a reqwest::Client,
26    loaded_metadata: Option<Arc<VerifiedProviderMetadata>>,
27}
28
29impl<'a> LazyProviderInfos<'a> {
30    pub fn new(
31        cache: &'a MetadataCache,
32        provider: &'a UpstreamOAuthProvider,
33        client: &'a reqwest::Client,
34    ) -> Self {
35        Self {
36            cache,
37            provider,
38            client,
39            loaded_metadata: None,
40        }
41    }
42
43    /// Trigger the discovery process and return the metadata if discovery is
44    /// enabled.
45    pub async fn maybe_discover(
46        &mut self,
47    ) -> Result<Option<&VerifiedProviderMetadata>, DiscoveryError> {
48        match self.load().await {
49            Ok(metadata) => Ok(Some(metadata)),
50            Err(DiscoveryError::Disabled) => Ok(None),
51            Err(e) => Err(e),
52        }
53    }
54
55    async fn load(&mut self) -> Result<&VerifiedProviderMetadata, DiscoveryError> {
56        if self.loaded_metadata.is_none() {
57            let verify = match self.provider.discovery_mode {
58                UpstreamOAuthProviderDiscoveryMode::Oidc => true,
59                UpstreamOAuthProviderDiscoveryMode::Insecure => false,
60                UpstreamOAuthProviderDiscoveryMode::Disabled => {
61                    return Err(DiscoveryError::Disabled);
62                }
63            };
64
65            let Some(issuer) = &self.provider.issuer else {
66                return Err(DiscoveryError::MissingIssuer);
67            };
68
69            let metadata = self.cache.get(self.client, issuer, verify).await?;
70
71            self.loaded_metadata = Some(metadata);
72        }
73
74        Ok(self.loaded_metadata.as_ref().unwrap())
75    }
76
77    /// Get the JWKS URI for the provider.
78    ///
79    /// Uses [`UpstreamOAuthProvider.jwks_uri_override`] if set, otherwise uses
80    /// the one from discovery.
81    pub async fn jwks_uri(&mut self) -> Result<&Url, DiscoveryError> {
82        if let Some(jwks_uri) = &self.provider.jwks_uri_override {
83            return Ok(jwks_uri);
84        }
85
86        Ok(self.load().await?.jwks_uri())
87    }
88
89    /// Get the authorization endpoint for the provider.
90    ///
91    /// Uses [`UpstreamOAuthProvider.authorization_endpoint_override`] if set,
92    /// otherwise uses the one from discovery.
93    pub async fn authorization_endpoint(&mut self) -> Result<&Url, DiscoveryError> {
94        if let Some(authorization_endpoint) = &self.provider.authorization_endpoint_override {
95            return Ok(authorization_endpoint);
96        }
97
98        Ok(self.load().await?.authorization_endpoint())
99    }
100
101    /// Get the token endpoint for the provider.
102    ///
103    /// Uses [`UpstreamOAuthProvider.token_endpoint_override`] if set, otherwise
104    /// uses the one from discovery.
105    pub async fn token_endpoint(&mut self) -> Result<&Url, DiscoveryError> {
106        if let Some(token_endpoint) = &self.provider.token_endpoint_override {
107            return Ok(token_endpoint);
108        }
109
110        Ok(self.load().await?.token_endpoint())
111    }
112
113    /// Get the userinfo endpoint for the provider.
114    ///
115    /// Uses [`UpstreamOAuthProvider.userinfo_endpoint_override`] if set,
116    /// otherwise uses the one from discovery.
117    pub async fn userinfo_endpoint(&mut self) -> Result<&Url, DiscoveryError> {
118        if let Some(userinfo_endpoint) = &self.provider.userinfo_endpoint_override {
119            return Ok(userinfo_endpoint);
120        }
121
122        Ok(self.load().await?.userinfo_endpoint())
123    }
124
125    /// Get the PKCE methods supported by the provider.
126    ///
127    /// If the mode is set to auto, it will use the ones from discovery,
128    /// defaulting to none if discovery is disabled.
129    pub async fn pkce_methods(
130        &mut self,
131    ) -> Result<Option<Vec<PkceCodeChallengeMethod>>, DiscoveryError> {
132        let methods = match self.provider.pkce_mode {
133            UpstreamOAuthProviderPkceMode::Auto => self
134                .maybe_discover()
135                .await?
136                .and_then(|metadata| metadata.code_challenge_methods_supported.clone()),
137            UpstreamOAuthProviderPkceMode::S256 => Some(vec![PkceCodeChallengeMethod::S256]),
138            UpstreamOAuthProviderPkceMode::Disabled => None,
139        };
140
141        Ok(methods)
142    }
143}
144
145/// A simple OIDC metadata cache
146///
147/// It never evicts entries, does not cache failures and has no locking.
148/// It can also be refreshed in the background, and warmed up on startup.
149/// It is good enough for our use case.
150#[allow(clippy::module_name_repetitions)]
151#[derive(Debug, Clone, Default)]
152pub struct MetadataCache {
153    cache: Arc<RwLock<HashMap<String, Arc<VerifiedProviderMetadata>>>>,
154    insecure_cache: Arc<RwLock<HashMap<String, Arc<VerifiedProviderMetadata>>>>,
155}
156
157impl MetadataCache {
158    #[must_use]
159    pub fn new() -> Self {
160        Self::default()
161    }
162
163    /// Warm up the cache by fetching all the known providers from the database
164    /// and inserting them into the cache.
165    ///
166    /// This spawns a background task that will refresh the cache at the given
167    /// interval.
168    #[tracing::instrument(name = "metadata_cache.warm_up_and_run", skip_all)]
169    pub async fn warm_up_and_run<R: RepositoryAccess>(
170        &self,
171        client: &reqwest::Client,
172        interval: std::time::Duration,
173        repository: &mut R,
174    ) -> Result<tokio::task::JoinHandle<()>, R::Error> {
175        let providers = repository.upstream_oauth_provider().all_enabled().await?;
176
177        for provider in providers {
178            let verify = match provider.discovery_mode {
179                UpstreamOAuthProviderDiscoveryMode::Oidc => true,
180                UpstreamOAuthProviderDiscoveryMode::Insecure => false,
181                UpstreamOAuthProviderDiscoveryMode::Disabled => continue,
182            };
183
184            let Some(issuer) = &provider.issuer else {
185                tracing::error!(%provider.id, "Provider doesn't have an issuer set, but discovery is enabled!");
186                continue;
187            };
188
189            if let Err(e) = self.fetch(client, issuer, verify).await {
190                tracing::error!(%issuer, error = &e as &dyn std::error::Error, "Failed to fetch provider metadata");
191            }
192        }
193
194        // Spawn a background task to refresh the cache regularly
195        let cache = self.clone();
196        let client = client.clone();
197        Ok(tokio::spawn(async move {
198            loop {
199                // Re-fetch the known metadata at the given interval
200                tokio::time::sleep(interval).await;
201                LogContext::new("metadata-cache-refresh")
202                    .run(|| cache.refresh_all(&client))
203                    .await;
204            }
205        }))
206    }
207
208    #[tracing::instrument(name = "metadata_cache.fetch", fields(%issuer), skip_all)]
209    async fn fetch(
210        &self,
211        client: &reqwest::Client,
212        issuer: &str,
213        verify: bool,
214    ) -> Result<Arc<VerifiedProviderMetadata>, DiscoveryError> {
215        if verify {
216            let metadata = mas_oidc_client::requests::discovery::discover(client, issuer).await?;
217            let metadata = Arc::new(metadata);
218
219            self.cache
220                .write()
221                .await
222                .insert(issuer.to_owned(), metadata.clone());
223
224            Ok(metadata)
225        } else {
226            let metadata =
227                mas_oidc_client::requests::discovery::insecure_discover(client, issuer).await?;
228            let metadata = Arc::new(metadata);
229
230            self.insecure_cache
231                .write()
232                .await
233                .insert(issuer.to_owned(), metadata.clone());
234
235            Ok(metadata)
236        }
237    }
238
239    /// Get the metadata for the given issuer.
240    #[tracing::instrument(name = "metadata_cache.get", fields(%issuer), skip_all)]
241    pub async fn get(
242        &self,
243        client: &reqwest::Client,
244        issuer: &str,
245        verify: bool,
246    ) -> Result<Arc<VerifiedProviderMetadata>, DiscoveryError> {
247        let cache = if verify {
248            self.cache.read().await
249        } else {
250            self.insecure_cache.read().await
251        };
252
253        if let Some(metadata) = cache.get(issuer) {
254            return Ok(Arc::clone(metadata));
255        }
256        // Drop the cache guard so that we don't deadlock when we try to fetch
257        drop(cache);
258
259        let metadata = self.fetch(client, issuer, verify).await?;
260        Ok(metadata)
261    }
262
263    #[tracing::instrument(name = "metadata_cache.refresh_all", skip_all)]
264    async fn refresh_all(&self, client: &reqwest::Client) {
265        // Grab all the keys first to avoid locking the cache for too long
266        let keys: Vec<String> = {
267            let cache = self.cache.read().await;
268            cache.keys().cloned().collect()
269        };
270
271        for issuer in keys {
272            if let Err(e) = self.fetch(client, &issuer, true).await {
273                tracing::error!(issuer = %issuer, error = &e as &dyn std::error::Error, "Failed to refresh provider metadata");
274            }
275        }
276
277        // Do the same for the insecure cache
278        let keys: Vec<String> = {
279            let cache = self.insecure_cache.read().await;
280            cache.keys().cloned().collect()
281        };
282
283        for issuer in keys {
284            if let Err(e) = self.fetch(client, &issuer, false).await {
285                tracing::error!(issuer = %issuer, error = &e as &dyn std::error::Error, "Failed to refresh provider metadata");
286            }
287        }
288    }
289}
290
291#[cfg(test)]
292mod tests {
293    #![allow(clippy::too_many_lines)]
294
295    // XXX: sadly, we can't test HTTPS requests with wiremock, so we can only test
296    // 'insecure' discovery
297
298    use mas_data_model::{
299        UpstreamOAuthProviderClaimsImports, UpstreamOAuthProviderOnBackchannelLogout,
300        UpstreamOAuthProviderTokenAuthMethod,
301    };
302    use mas_iana::jose::JsonWebSignatureAlg;
303    use mas_storage::{Clock, clock::MockClock};
304    use oauth2_types::scope::{OPENID, Scope};
305    use ulid::Ulid;
306    use wiremock::{
307        Mock, MockServer, ResponseTemplate,
308        matchers::{method, path},
309    };
310
311    use super::*;
312    use crate::test_utils::setup;
313
314    #[tokio::test]
315    async fn test_metadata_cache() {
316        setup();
317        let mock_server = MockServer::start().await;
318        let http_client = mas_http::reqwest_client();
319
320        let cache = MetadataCache::new();
321
322        // An inexistant issuer should fail
323        cache
324            .get(&http_client, &mock_server.uri(), false)
325            .await
326            .unwrap_err();
327
328        let expected_calls = 3;
329        let mut calls = 0;
330        let _mock_guard = Mock::given(method("GET"))
331            .and(path("/.well-known/openid-configuration"))
332            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
333                "issuer": mock_server.uri(),
334                "authorization_endpoint": "https://example.com/authorize",
335                "token_endpoint": "https://example.com/token",
336                "jwks_uri": "https://example.com/jwks",
337                "userinfo_endpoint": "https://example.com/userinfo",
338                "scopes_supported": ["openid"],
339                "response_types_supported": ["code"],
340                "response_modes_supported": ["query", "fragment"],
341                "grant_types_supported": ["authorization_code"],
342                "subject_types_supported": ["public"],
343                "id_token_signing_alg_values_supported": ["RS256"],
344            })))
345            .expect(expected_calls)
346            .mount(&mock_server)
347            .await;
348
349        // A valid issuer should succeed
350        cache
351            .get(&http_client, &mock_server.uri(), false)
352            .await
353            .unwrap();
354        calls += 1;
355
356        // Calling again should not trigger a new fetch
357        cache
358            .get(&http_client, &mock_server.uri(), false)
359            .await
360            .unwrap();
361        calls += 0;
362
363        // A secure discovery should call but fail because the issuer is insecure
364        cache
365            .get(&http_client, &mock_server.uri(), true)
366            .await
367            .unwrap_err();
368        calls += 1;
369
370        // Calling refresh should refresh all the known issuers
371        cache.refresh_all(&http_client).await;
372        calls += 1;
373
374        assert_eq!(calls, expected_calls);
375    }
376
377    #[tokio::test]
378    async fn test_lazy_provider_infos() {
379        setup();
380
381        let mock_server = MockServer::start().await;
382        let http_client = mas_http::reqwest_client();
383
384        let expected_calls = 2;
385        let mut calls = 0;
386        let _mock_guard = Mock::given(method("GET"))
387            .and(path("/.well-known/openid-configuration"))
388            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
389                "issuer": mock_server.uri(),
390                "authorization_endpoint": "https://example.com/authorize",
391                "token_endpoint": "https://example.com/token",
392                "jwks_uri": "https://example.com/jwks",
393                "userinfo_endpoint": "https://example.com/userinfo",
394                "scopes_supported": ["openid"],
395                "response_types_supported": ["code"],
396                "response_modes_supported": ["query", "fragment"],
397                "grant_types_supported": ["authorization_code"],
398                "subject_types_supported": ["public"],
399                "id_token_signing_alg_values_supported": ["RS256"],
400            })))
401            .expect(expected_calls)
402            .mount(&mock_server)
403            .await;
404
405        let clock = MockClock::default();
406        let provider = UpstreamOAuthProvider {
407            id: Ulid::nil(),
408            issuer: Some(mock_server.uri()),
409            human_name: Some("Example Ltd.".to_owned()),
410            brand_name: None,
411            discovery_mode: UpstreamOAuthProviderDiscoveryMode::Insecure,
412            pkce_mode: UpstreamOAuthProviderPkceMode::Auto,
413            fetch_userinfo: false,
414            userinfo_signed_response_alg: None,
415            jwks_uri_override: None,
416            authorization_endpoint_override: None,
417            scope: Scope::from_iter([OPENID]),
418            userinfo_endpoint_override: None,
419            token_endpoint_override: None,
420            client_id: "client_id".to_owned(),
421            encrypted_client_secret: None,
422            token_endpoint_signing_alg: None,
423            token_endpoint_auth_method: UpstreamOAuthProviderTokenAuthMethod::None,
424            id_token_signed_response_alg: JsonWebSignatureAlg::Rs256,
425            response_mode: None,
426            created_at: clock.now(),
427            disabled_at: None,
428            claims_imports: UpstreamOAuthProviderClaimsImports::default(),
429            additional_authorization_parameters: Vec::new(),
430            forward_login_hint: false,
431            on_backchannel_logout: UpstreamOAuthProviderOnBackchannelLogout::DoNothing,
432        };
433
434        // Without any override, it should just use discovery
435        {
436            let cache = MetadataCache::new();
437            let mut lazy_metadata = LazyProviderInfos::new(&cache, &provider, &http_client);
438            lazy_metadata.maybe_discover().await.unwrap();
439            assert_eq!(
440                lazy_metadata
441                    .authorization_endpoint()
442                    .await
443                    .unwrap()
444                    .as_str(),
445                "https://example.com/authorize"
446            );
447            calls += 1;
448        }
449
450        // Test overriding endpoints
451        {
452            let provider = UpstreamOAuthProvider {
453                jwks_uri_override: Some("https://example.com/jwks_override".parse().unwrap()),
454                authorization_endpoint_override: Some(
455                    "https://example.com/authorize_override".parse().unwrap(),
456                ),
457                token_endpoint_override: Some(
458                    "https://example.com/token_override".parse().unwrap(),
459                ),
460                ..provider.clone()
461            };
462            let cache = MetadataCache::new();
463            let mut lazy_metadata = LazyProviderInfos::new(&cache, &provider, &http_client);
464            assert_eq!(
465                lazy_metadata.jwks_uri().await.unwrap().as_str(),
466                "https://example.com/jwks_override"
467            );
468            assert_eq!(
469                lazy_metadata
470                    .authorization_endpoint()
471                    .await
472                    .unwrap()
473                    .as_str(),
474                "https://example.com/authorize_override"
475            );
476            assert_eq!(
477                lazy_metadata.token_endpoint().await.unwrap().as_str(),
478                "https://example.com/token_override"
479            );
480            // This shouldn't trigger a new fetch as the endpoint is overriden
481            calls += 0;
482        }
483
484        // Loading an insecure provider with secure discovery should fail
485        {
486            let provider = UpstreamOAuthProvider {
487                discovery_mode: UpstreamOAuthProviderDiscoveryMode::Oidc,
488                ..provider.clone()
489            };
490            let cache = MetadataCache::new();
491            let mut lazy_metadata = LazyProviderInfos::new(&cache, &provider, &http_client);
492            lazy_metadata.authorization_endpoint().await.unwrap_err();
493            // This triggered a fetch, even though it failed
494            calls += 1;
495        }
496
497        // Getting endpoints when discovery is disabled only works for overriden ones
498        {
499            let provider = UpstreamOAuthProvider {
500                discovery_mode: UpstreamOAuthProviderDiscoveryMode::Disabled,
501                authorization_endpoint_override: Some(
502                    Url::parse("https://example.com/authorize_override").unwrap(),
503                ),
504                token_endpoint_override: None,
505                ..provider.clone()
506            };
507            let cache = MetadataCache::new();
508            let mut lazy_metadata = LazyProviderInfos::new(&cache, &provider, &http_client);
509            // This should not fail, but also does nothing
510            assert!(lazy_metadata.maybe_discover().await.unwrap().is_none());
511            assert_eq!(
512                lazy_metadata
513                    .authorization_endpoint()
514                    .await
515                    .unwrap()
516                    .as_str(),
517                "https://example.com/authorize_override"
518            );
519            assert!(matches!(
520                lazy_metadata.token_endpoint().await,
521                Err(DiscoveryError::Disabled),
522            ));
523            // This did not trigger a fetch
524            calls += 0;
525        }
526
527        assert_eq!(calls, expected_calls);
528    }
529}
mas_handlers/upstream_oauth2/cache.rs

mas_handlers/upstream_oauth2/
cache.rs
