add error when email is not allowed (#8)

Author: odelcroi

Cargo.lock

@@ -37,9 +37,12 @@ use mas_templates::{
 use minijinja::Environment;
 use opentelemetry::{Key, KeyValue, metrics::Counter};
 use serde::{Deserialize, Serialize};
+//:tchap:
+use tchap::{self, EmailAllowedResult};
 use thiserror::Error;
 use ulid::Ulid;
 
+//:tchap: end
 use super::{
     UpstreamSessionsCookie,
     template::{AttributeMappingContext, environment},
@@ -445,6 +448,45 @@ pub(crate) async fn get(
                     provider.claims_imports.email.is_required(),
                 )? {
                     Some(value) => {
+                        //:tchap:
+                        let server_name = homeserver.homeserver();
+                        let email_result = check_email_allowed(&value, server_name).await;
+
+                        match email_result {
+                            EmailAllowedResult::Allowed => {
+                                // Email is allowed, continue
+                            }
+                            EmailAllowedResult::WrongServer => {
+                                // Email is mapped to a different server
+                                let ctx = ErrorContext::new()
+                                    .with_code("wrong_server")
+                                    .with_description(format!("Votre adresse mail {value} est associée à un autre serveur."))
+                                    .with_details("Veuillez-vous contacter le support de Tchap [email protected]".to_owned())
+                                    .with_language(&locale);
+
+                                //return error template
+                                return Ok((
+                                    cookie_jar,
+                                    Html(templates.render_error(&ctx)?).into_response(),
+                                ));
+                            }
+                            EmailAllowedResult::InvitationMissing => {
+                                // Server requires an invitation that is not present
+                                let ctx = ErrorContext::new()
+                                    .with_code("invitation_missing")
+                                    .with_description("Vous avez besoin d'une invitation pour accéder à Tchap.".to_owned())
+                                    .with_details("Les partenaires externes peuvent accéder à Tchap uniquement avec une invitation d'un agent public.".to_owned())
+                                    .with_language(&locale);
+
+                                //return error template
+                                return Ok((
+                                    cookie_jar,
+                                    Html(templates.render_error(&ctx)?).into_response(),
+                                ));
+                            }
+                        }
+                        //:tchap: end
+
                         ctx.with_email(value, provider.claims_imports.email.is_forced_or_required())
                     }
                     None => ctx,
@@ -1007,6 +1049,19 @@ pub(crate) async fn post(
     Ok((cookie_jar, post_auth_action.go_next(&url_builder)).into_response())
 }
 
+//:tchap:
+///real function used when not testing
+#[cfg(not(test))]
+async fn check_email_allowed(email: &str, server_name: &str) -> EmailAllowedResult {
+    tchap::is_email_allowed(email, server_name).await
+}
+///mock function used when testing
+#[cfg(test)]
+async fn check_email_allowed(_email: &str, _server_name: &str) -> EmailAllowedResult {
+    EmailAllowedResult::Allowed
+}
+//:tchap:end
+
 #[cfg(test)]
 mod tests {
     use hyper::{Request, StatusCode, header::CONTENT_TYPE};

crates/handlers/src/upstream_oauth2/link.rs

@@ -3,5 +3,13 @@ name = "tchap"
 version = "0.1.0"
 description = "Tchap-specific functionality for Matrix Authentication Service"
 license = "MIT"
+edition = "2024"
 
-[dependencies]
+
+[dependencies]
+reqwest.workspace = true
+serde_json.workspace = true
+tracing.workspace = true
+tokio.workspace = true
+url.workspace = true
+serde.workspace = true

crates/tchap/Cargo.toml

@@ -0,0 +1,77 @@
+//! This module provides utilities for interacting with the Matrix identity
+//! server API.
+
+use std::time::Duration;
+
+use tracing::info;
+use url::Url;
+
+fn default_identity_server_url() -> Url {
+    // Try to read the TCHAP_IDENTITY_SERVER_URL environment variable
+    match std::env::var("TCHAP_IDENTITY_SERVER_URL") {
+        Ok(url_str) => {
+            // Attempt to parse the URL from the environment variable
+            match Url::parse(&url_str) {
+                Ok(url) => {
+                    // Success: use the URL from the environment variable
+                    return url;
+                }
+                Err(err) => {
+                    // Parsing error: log a warning and use the default value
+                    tracing::warn!(
+                        "The TCHAP_IDENTITY_SERVER_URL environment variable contains an invalid URL: {}. Using default value.",
+                        err
+                    );
+                }
+            }
+        }
+        Err(std::env::VarError::NotPresent) => {
+            // Variable not defined: use the default value without warning
+        }
+        Err(std::env::VarError::NotUnicode(_)) => {
+            // Variable contains non-Unicode characters: log a warning
+            tracing::warn!(
+                "The TCHAP_IDENTITY_SERVER_URL environment variable contains non-Unicode characters. Using default value."
+            );
+        }
+    }
+
+    // Default value if the environment variable is not defined or invalid
+    Url::parse("http://localhost:8090").unwrap()
+}
+
+/// Queries the identity server for information about an email address
+///
+/// # Parameters
+///
+/// * `email`: The email address to check///
+/// # Returns
+///
+/// A Result containing either the JSON response or an error
+pub async fn query_identity_server(email: &str) -> Result<serde_json::Value, reqwest::Error> {
+    let identity_server_url = default_identity_server_url();
+
+    // Construct the URL with the email address
+    let url = format!(
+        "{}_matrix/identity/api/v1/internal-info?medium=email&address={}",
+        identity_server_url, email
+    );
+
+    info!("Making request to identity server: {}", url);
+
+    // Create a client with a timeout
+    let client = reqwest::Client::builder()
+        .timeout(Duration::from_secs(5))
+        .build()
+        .unwrap_or_default();
+
+    // Make the HTTP request asynchronously
+    // should use mas-http instead like SynapseConnection
+    #[allow(clippy::disallowed_methods)]
+    let response = client.get(&url).send().await?;
+
+    // Parse the JSON response
+    let json = response.json::<serde_json::Value>().await?;
+
+    Ok(json)
+}

crates/tchap/src/identity_client.rs

@@ -5,6 +5,11 @@
 
 //! Tchap-specific functionality for Matrix Authentication Service
 
+extern crate tracing;
+use tracing::info;
+
+mod identity_client;
+
 /// Capitalise parts of a name containing different words, including those
 /// separated by hyphens.
 ///
@@ -25,8 +30,7 @@ pub fn cap(name: &str) -> String {
 
     // Split the name by whitespace then hyphens, capitalizing each part then
     // joining it back together.
-    let capitalized_name = name
-        .split_whitespace()
+    name.split_whitespace()
         .map(|space_part| {
             space_part
                 .split('-')
@@ -45,9 +49,7 @@ pub fn cap(name: &str) -> String {
                 .join("-")
         })
         .collect::<Vec<String>>()
-        .join(" ");
-
-    capitalized_name
+        .join(" ")
 }
 
 /// Generate a Matrix ID localpart from an email address.
@@ -135,6 +137,76 @@ pub fn email_to_display_name(address: &str) -> String {
     format!("{} [{}]", cap(&username), cap(org))
 }
 
+/// Result of checking if an email is allowed on a server
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub enum EmailAllowedResult {
+    /// Email is allowed on this server
+    Allowed,
+    /// Email is mapped to a different server
+    WrongServer,
+    /// Server requires an invitation that is not present
+    InvitationMissing,
+}
+
+/// Checks if an email address is allowed to be associated in the current server
+///
+/// This function makes an asynchronous GET request to the Matrix identity
+/// server API to retrieve information about the home server associated with an
+/// email address, then applies logic to determine if the email is allowed.
+///
+/// # Parameters
+///
+/// * `email`: The email address to check
+/// * `server_name`: The name of the server to check against
+///
+/// # Returns
+///
+/// An `EmailAllowedResult` indicating whether the email is allowed and if not,
+/// why
+#[must_use]
+pub async fn is_email_allowed(email: &str, server_name: &str) -> EmailAllowedResult {
+    // Query the identity server
+    match identity_client::query_identity_server(email).await {
+        Ok(json) => {
+            let hs = json.get("hs");
+
+            // Check if "hs" is in the response or if hs different from server_name
+            if hs.is_none() || hs.unwrap() != server_name {
+                // Email is mapped to a different server or no server at all
+                return EmailAllowedResult::WrongServer;
+            }
+
+            info!("hs: {} ", hs.unwrap());
+
+            // Check if requires_invite is true and invited is false
+            let requires_invite = json
+                .get("requires_invite")
+                .and_then(|v| v.as_bool())
+                .unwrap_or(false);
+
+            let invited = json
+                .get("invited")
+                .and_then(|v| v.as_bool())
+                .unwrap_or(false);
+
+            info!("requires_invite: {} invited: {}", requires_invite, invited);
+
+            if requires_invite && !invited {
+                // Requires an invite but hasn't been invited
+                return EmailAllowedResult::InvitationMissing;
+            }
+
+            // All checks passed
+            EmailAllowedResult::Allowed
+        }
+        Err(err) => {
+            // Log the error and return WrongServer as a default error
+            eprintln!("HTTP request failed: {}", err);
+            EmailAllowedResult::WrongServer
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;