refactor(oauth): Remove OAuthRegistrationStore

MSC2966 was updated, clients should re-register for every log in, so we
don't need to store the client IDs between logins.

Signed-off-by: Kévin Commaille <[email protected]>

Author: zecakeh

bindings/matrix-sdk-ffi/src/authentication.rs

@@ -1,15 +1,14 @@
 use std::{
     collections::HashMap,
     fmt::{self, Debug},
-    path::PathBuf,
     sync::Arc,
 };
 
 use matrix_sdk::{
     authentication::oauth::{
-        error::{OAuthAuthorizationCodeError, OAuthRegistrationStoreError},
+        error::OAuthAuthorizationCodeError,
         registration::{ApplicationType, ClientMetadata, Localized, OAuthGrantType},
-        ClientId, OAuthError as SdkOAuthError, OAuthRegistrationStore,
+        ClientId, ClientRegistrationData, OAuthError as SdkOAuthError,
     },
     Error,
 };
@@ -123,14 +122,12 @@ pub struct OidcConfiguration {
     /// An array of e-mail addresses of people responsible for this client.
     pub contacts: Option<Vec<String>>,
 
-    /// Pre-configured registrations for use with issuers that don't support
+    /// Pre-configured registrations for use with homeservers that don't support
     /// dynamic client registration.
-    pub static_registrations: HashMap<String, String>,
-
-    /// A file path where any dynamic registrations should be stored.
     ///
-    /// Suggested value: `{base_path}/oidc/registrations.json`
-    pub dynamic_registrations_file: String,
+    /// The keys of the map should be the URLs of the homeservers, but keys
+    /// using `issuer` URLs are also supported.
+    pub static_registrations: HashMap<String, String>,
 }
 
 impl OidcConfiguration {
@@ -165,12 +162,10 @@ impl OidcConfiguration {
         Raw::new(&metadata).map_err(|_| OidcError::MetadataInvalid)
     }
 
-    pub async fn registrations(&self) -> Result<OAuthRegistrationStore, OidcError> {
+    pub(crate) fn registration_data(&self) -> Result<ClientRegistrationData, OidcError> {
         let client_metadata = self.client_metadata()?;
 
-        let registrations_file = PathBuf::from(&self.dynamic_registrations_file);
-        let mut registrations =
-            OAuthRegistrationStore::new(registrations_file, client_metadata).await?;
+        let mut registration_data = ClientRegistrationData::new(client_metadata);
 
         if !self.static_registrations.is_empty() {
             let static_registrations = self
@@ -185,10 +180,10 @@ impl OidcConfiguration {
                 })
                 .collect();
 
-            registrations = registrations.with_static_registrations(static_registrations);
+            registration_data.static_registrations = Some(static_registrations);
         }
 
-        Ok(registrations)
+        Ok(registration_data)
     }
 }
 
@@ -201,8 +196,6 @@ pub enum OidcError {
     NotSupported,
     #[error("Unable to use OIDC as the supplied client metadata is invalid.")]
     MetadataInvalid,
-    #[error("Failed to use the supplied registrations file path.")]
-    RegistrationsPathInvalid,
     #[error("The supplied callback URL used to complete OIDC is invalid.")]
     CallbackUrlInvalid,
     #[error("The OIDC login was cancelled by the user.")]
@@ -228,17 +221,6 @@ impl From<SdkOAuthError> for OidcError {
     }
 }
 
-impl From<OAuthRegistrationStoreError> for OidcError {
-    fn from(e: OAuthRegistrationStoreError) -> OidcError {
-        match e {
-            OAuthRegistrationStoreError::NotAFilePath | OAuthRegistrationStoreError::File(_) => {
-                OidcError::RegistrationsPathInvalid
-            }
-            _ => OidcError::Generic { message: e.to_string() },
-        }
-    }
-}
-
 impl From<Error> for OidcError {
     fn from(e: Error) -> OidcError {
         match e {

bindings/matrix-sdk-ffi/src/client.rs

@@ -408,10 +408,10 @@ impl Client {
         oidc_configuration: &OidcConfiguration,
         prompt: Option<OidcPrompt>,
     ) -> Result<Arc<OAuthAuthorizationData>, OidcError> {
-        let registrations = oidc_configuration.registrations().await?;
+        let registration_data = oidc_configuration.registration_data()?;
         let redirect_uri = oidc_configuration.redirect_uri()?;
 
-        let mut url_builder = self.inner.oauth().login(registrations.into(), redirect_uri, None);
+        let mut url_builder = self.inner.oauth().login(redirect_uri, None, Some(registration_data));
 
         if let Some(prompt) = prompt {
             url_builder = url_builder.prompt(vec![prompt.into()]);

bindings/matrix-sdk-ffi/src/client_builder.rs

@@ -755,13 +755,12 @@ impl ClientBuilder {
             }
         })?;
 
-        let registrations = oidc_configuration
-            .registrations()
-            .await
+        let registration_data = oidc_configuration
+            .registration_data()
             .map_err(|_| HumanQrLoginError::OidcMetadataInvalid)?;
 
         let oauth = client.inner.oauth();
-        let login = oauth.login_with_qr_code(&qr_code_data.inner, registrations.into());
+        let login = oauth.login_with_qr_code(&qr_code_data.inner, Some(&registration_data));
 
         let mut progress = login.subscribe_to_progress();
 

crates/matrix-sdk/src/authentication/oauth/auth_code_builder.rs

@@ -24,7 +24,7 @@ use ruma::{
 use tracing::{info, instrument};
 use url::Url;
 
-use super::{ClientRegistrationMethod, OAuth, OAuthError};
+use super::{ClientRegistrationData, OAuth, OAuthError};
 use crate::{authentication::oauth::AuthorizationValidationData, Result};
 
 /// Builder type used to configure optional settings for authorization with an
@@ -34,7 +34,7 @@ use crate::{authentication::oauth::AuthorizationValidationData, Result};
 #[allow(missing_debug_implementations)]
 pub struct OAuthAuthCodeUrlBuilder {
     oauth: OAuth,
-    registration_method: ClientRegistrationMethod,
+    registration_data: Option<ClientRegistrationData>,
     scopes: Vec<Scope>,
     device_id: OwnedDeviceId,
     redirect_uri: Url,
@@ -45,14 +45,14 @@ pub struct OAuthAuthCodeUrlBuilder {
 impl OAuthAuthCodeUrlBuilder {
     pub(super) fn new(
         oauth: OAuth,
-        registration_method: ClientRegistrationMethod,
         scopes: Vec<Scope>,
         device_id: OwnedDeviceId,
         redirect_uri: Url,
+        registration_data: Option<ClientRegistrationData>,
     ) -> Self {
         Self {
             oauth,
-            registration_method,
+            registration_data,
             scopes,
             device_id,
             redirect_uri,
@@ -93,19 +93,12 @@ impl OAuthAuthCodeUrlBuilder {
     /// request fails.
     #[instrument(target = "matrix_sdk::client", skip_all)]
     pub async fn build(self) -> Result<OAuthAuthorizationData, OAuthError> {
-        let Self {
-            oauth,
-            registration_method,
-            scopes,
-            device_id,
-            redirect_uri,
-            prompt,
-            login_hint,
-        } = self;
+        let Self { oauth, registration_data, scopes, device_id, redirect_uri, prompt, login_hint } =
+            self;
 
         let server_metadata = oauth.server_metadata().await?;
 
-        oauth.use_registration_method(&server_metadata, &registration_method).await?;
+        oauth.use_registration_data(&server_metadata, registration_data.as_ref()).await?;
 
         let data = oauth.data().expect("OAuth 2.0 data should be set after registration");
         info!(

crates/matrix-sdk/src/authentication/oauth/error.rs

@@ -31,8 +31,6 @@ use ruma::{
 
 #[cfg(feature = "e2e-encryption")]
 pub use super::cross_process::CrossProcessRefreshLockError;
-#[cfg(not(target_arch = "wasm32"))]
-pub use super::registration_store::OAuthRegistrationStoreError;
 
 /// An error when interacting with the OAuth 2.0 authorization server.
 pub type OAuthRequestError<T> =
@@ -258,11 +256,6 @@ pub enum OAuthClientRegistrationError {
     /// Deserialization of the registration response failed.
     #[error("failed to deserialize registration response: {0}")]
     FromJson(serde_json::Error),
-
-    /// Failed to access or store the registration in the store.
-    #[cfg(not(target_arch = "wasm32"))]
-    #[error("failed to use registration store: {0}")]
-    Store(#[from] OAuthRegistrationStoreError),
 }
 
 /// Error response returned by server after requesting an authorization code.