Something went wrong. Try again.
A lexicon-driven AppView for ATProto. forked from gamesgamesgamesgames.games/happyview
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434use arc_swap::ArcSwap;use dashmap::DashMap;use std::sync::Arc;
use atrium_identity::did::{CommonDidResolver, CommonDidResolverConfig};use atrium_identity::handle::{AtprotoHandleResolver, AtprotoHandleResolverConfig};use atrium_oauth::{ AtprotoClientMetadata, AtprotoLocalhostClientMetadata, AuthMethod, DefaultHttpClient, GrantType, OAuthClientConfig, OAuthResolverConfig,};
use crate::HappyViewOAuthClient;use crate::auth::oauth_store::{DbSessionStore, DbStateStore};use crate::db::{DatabaseBackend, adapt_sql};use crate::dns::NativeDnsResolver;
fn is_loopback_url(url: &str) -> bool { url.contains("127.0.0.1") || url.contains("[::1]") || url.contains("localhost")}
/// Parameters needed to build an OAuth client for an API client registration.pub struct ApiClientOAuthParams { pub plc_url: String, pub state_store: DbStateStore, pub session_store_pool: sqlx::AnyPool, pub db_backend: DatabaseBackend,}
/// Registry of OAuth clients, keyed by `client_id_url`.////// Each API client gets its own `OAuthClient` instance so the PDS auth screen/// shows the correct domain. The default client is HappyView's own identity,/// used for dashboard auth.pub struct OAuthClientRegistry { primary_client: ArcSwap<HappyViewOAuthClient>, domain_clients: DashMap<String, Arc<HappyViewOAuthClient>>, clients: DashMap<String, Arc<HappyViewOAuthClient>>,}
impl OAuthClientRegistry { pub fn new(primary_client: Arc<HappyViewOAuthClient>) -> Self { Self { primary_client: ArcSwap::new(primary_client), domain_clients: DashMap::new(), clients: DashMap::new(), } }
/// Register an API client's OAuth client, keyed by its `client_id_url`. pub fn register(&self, client_id_url: String, client: Arc<HappyViewOAuthClient>) { self.clients.insert(client_id_url, client); }
/// Remove an API client's OAuth client. pub fn remove(&self, client_id_url: &str) { self.clients.remove(client_id_url); }
/// Look up a client by `client_id_url`. pub fn get(&self, client_id_url: &str) -> Option<Arc<HappyViewOAuthClient>> { self.clients.get(client_id_url).map(|r| r.value().clone()) }
/// Get the resolved OAuth `client_id` for a registered client. /// /// For loopback clients this returns `http://localhost?scope=...` (the format /// auth servers expect), not the original `client_id_url` key. pub fn get_resolved_client_id(&self, client_id_url: &str) -> Option<String> { self.clients .get(client_id_url) .map(|r| r.value().client_metadata.client_id.clone()) }
/// Look up a client by `client_id_url`, falling back to the primary client. pub fn get_or_default(&self, client_id_url: Option<&str>) -> Arc<HappyViewOAuthClient> { if let Some(url) = client_id_url { self.clients .get(url) .map(|r| r.value().clone()) .unwrap_or_else(|| self.primary_client.load_full()) } else { self.primary_client.load_full() } }
/// Get the primary (HappyView dashboard) client. pub fn primary_client(&self) -> Arc<HappyViewOAuthClient> { self.primary_client.load_full() }
/// Register a domain-specific OAuth client. /// Inserts into both `domain_clients` (keyed by domain URL, for `get_for_domain`) /// and `clients` (keyed by client_id_url, for `get_or_default`). /// /// `client_id_url` must be the base-path-aware client ID /// (e.g. `{domain_url}{base_path}/oauth-client-metadata.json`). pub fn register_domain_client( &self, domain_url: String, client_id_url: String, client: Arc<HappyViewOAuthClient>, ) { self.domain_clients.insert(domain_url, Arc::clone(&client)); self.clients.insert(client_id_url, client); }
/// Remove a domain-specific OAuth client from both maps. /// /// `client_id_url` must be the same base-path-aware client ID that was /// passed to `register_domain_client`. pub fn remove_domain_client(&self, domain_url: &str, client_id_url: &str) { self.domain_clients.remove(domain_url); self.clients.remove(client_id_url); }
/// Look up a domain-specific OAuth client. pub fn get_domain_client(&self, domain_url: &str) -> Option<Arc<HappyViewOAuthClient>> { self.domain_clients .get(domain_url) .map(|r| r.value().clone()) }
/// Get the OAuth client for a domain, falling back to the primary client. pub fn get_for_domain(&self, domain_url: &str) -> Arc<HappyViewOAuthClient> { self.domain_clients .get(domain_url) .map(|r| r.value().clone()) .unwrap_or_else(|| self.primary_client.load_full()) }
/// Replace the primary OAuth client (e.g. when admin changes the primary domain). pub fn set_primary_client(&self, client: Arc<HappyViewOAuthClient>) { self.primary_client.store(client); }
/// Returns true if the given `client_id_url` is already claimed by a domain /// client. Checks by comparing against the actual client instances stored by /// domain registrations, so it works correctly regardless of `BASE_PATH`. pub fn is_domain_client_id(&self, client_id_url: &str) -> bool { // A client_id_url belongs to a domain client if any domain_clients entry // has the same Arc as the one stored in `clients` under that key. if let Some(candidate) = self.clients.get(client_id_url) { self.domain_clients .iter() .any(|entry| Arc::ptr_eq(entry.value(), candidate.value())) } else { false } }
/// Build and register a single OAuth client from API client metadata. /// Used when creating or updating an API client via the admin UI. pub fn register_api_client( &self, client_id_url: &str, client_uri: &str, redirect_uris: Vec<String>, scopes_str: &str, params: &ApiClientOAuthParams, ) -> Result<(), String> { if self.is_domain_client_id(client_id_url) { return Err(format!( "client_id_url '{}' conflicts with a registered domain's OAuth client", client_id_url )); } let ApiClientOAuthParams { plc_url, state_store, session_store_pool, db_backend, } = params; let scopes = crate::auth::parse_scope_string(scopes_str); let scopes = if scopes.is_empty() { vec![atrium_oauth::Scope::Known( atrium_oauth::KnownScope::Atproto, )] } else { scopes };
let http = Arc::new(DefaultHttpClient::default()); let resolver = OAuthResolverConfig { did_resolver: CommonDidResolver::new(CommonDidResolverConfig { plc_directory_url: plc_url.to_string(), http_client: Arc::clone(&http), }), handle_resolver: AtprotoHandleResolver::new(AtprotoHandleResolverConfig { dns_txt_resolver: NativeDnsResolver::new(), http_client: Arc::clone(&http), }), authorization_server_metadata: Default::default(), protected_resource_metadata: Default::default(), };
let client = if is_loopback_url(client_id_url) { atrium_oauth::OAuthClient::new(OAuthClientConfig { client_metadata: AtprotoLocalhostClientMetadata { redirect_uris: None, scopes: Some(scopes), }, keys: None, state_store: state_store.clone(), session_store: DbSessionStore::new(session_store_pool.clone(), *db_backend), resolver, }) } else { atrium_oauth::OAuthClient::new(OAuthClientConfig { client_metadata: AtprotoClientMetadata { client_id: client_id_url.to_string(), client_uri: Some(client_uri.to_string()), redirect_uris, token_endpoint_auth_method: AuthMethod::None, grant_types: vec![GrantType::AuthorizationCode, GrantType::RefreshToken], scopes, jwks_uri: None, token_endpoint_auth_signing_alg: None, }, keys: None, state_store: state_store.clone(), session_store: DbSessionStore::new(session_store_pool.clone(), *db_backend), resolver, }) };
match client { Ok(client) => { self.register(client_id_url.to_string(), Arc::new(client)); Ok(()) } Err(e) => Err(format!("failed to create OAuth client: {e}")), } }
/// Load all active API clients from the database and register OAuth clients for each. pub async fn load_from_db( &self, db: &sqlx::AnyPool, db_backend: DatabaseBackend, plc_url: &str, state_store: DbStateStore, session_store_pool: sqlx::AnyPool, ) { let sql = adapt_sql( "SELECT client_id_url, client_uri, redirect_uris, scopes FROM api_clients WHERE is_active = 1", db_backend, );
let rows: Vec<(String, String, String, String)> = match sqlx::query_as(&sql).fetch_all(db).await { Ok(r) => r, Err(e) => { tracing::error!("Failed to load API clients from database: {e}"); return; } };
for (client_id_url, client_uri, redirect_uris_json, scopes_str) in rows { if self.is_domain_client_id(&client_id_url) { tracing::warn!( client_id = %client_id_url, "Skipping API client that conflicts with a domain OAuth client" ); continue; }
let redirect_uris: Vec<String> = serde_json::from_str(&redirect_uris_json).unwrap_or_default();
let scopes = crate::auth::parse_scope_string(&scopes_str); let scopes = if scopes.is_empty() { vec![atrium_oauth::Scope::Known( atrium_oauth::KnownScope::Atproto, )] } else { scopes };
// Each OAuthClient needs its own resolver instances (they're not Clone) let http = Arc::new(DefaultHttpClient::default()); let resolver = OAuthResolverConfig { did_resolver: CommonDidResolver::new(CommonDidResolverConfig { plc_directory_url: plc_url.to_string(), http_client: Arc::clone(&http), }), handle_resolver: AtprotoHandleResolver::new(AtprotoHandleResolverConfig { dns_txt_resolver: NativeDnsResolver::new(), http_client: Arc::clone(&http), }), authorization_server_metadata: Default::default(), protected_resource_metadata: Default::default(), };
let client = if is_loopback_url(&client_id_url) { atrium_oauth::OAuthClient::new(OAuthClientConfig { client_metadata: AtprotoLocalhostClientMetadata { redirect_uris: None, scopes: Some(scopes), }, keys: None, state_store: state_store.clone(), session_store: DbSessionStore::new(session_store_pool.clone(), db_backend), resolver, }) } else { atrium_oauth::OAuthClient::new(OAuthClientConfig { client_metadata: AtprotoClientMetadata { client_id: client_id_url.clone(), client_uri: Some(client_uri), redirect_uris, token_endpoint_auth_method: AuthMethod::None, grant_types: vec![GrantType::AuthorizationCode, GrantType::RefreshToken], scopes, jwks_uri: None, token_endpoint_auth_signing_alg: None, }, keys: None, state_store: state_store.clone(), session_store: DbSessionStore::new(session_store_pool.clone(), db_backend), resolver, }) };
match client { Ok(client) => { tracing::info!(client_id = %client_id_url, "Registered API client OAuth identity"); self.register(client_id_url, Arc::new(client)); } Err(e) => { tracing::error!(client_id = %client_id_url, error = %e, "Failed to create OAuth client for API client"); } } } }}
#[cfg(test)]mod tests { use super::*;
// Note: we can't easily construct real OAuthClient instances in unit tests // because they require resolvers, stores, etc. The registry logic is simple // enough that we test it via integration tests that stand up the full stack. // These tests verify the DashMap-based lookup logic using a mock approach.
#[test] fn test_registry_stores_and_retrieves() { // We can at least verify the DashMap operations work correctly let map: DashMap<String, String> = DashMap::new(); map.insert("key1".to_string(), "val1".to_string());
assert!(map.get("key1").is_some()); assert!(map.get("key2").is_none());
map.remove("key1"); assert!(map.get("key1").is_none()); }
#[test] fn test_registry_overwrite() { let map: DashMap<String, String> = DashMap::new(); map.insert("key1".to_string(), "val1".to_string()); map.insert("key1".to_string(), "val2".to_string());
assert_eq!(map.get("key1").unwrap().value(), "val2"); }
#[test] fn test_domain_client_id_collision_detection() { // Simulate the is_domain_client_id logic using raw DashMaps and Arc pointer equality, // mirroring the real OAuthClientRegistry implementation. let domain_clients: DashMap<String, Arc<String>> = DashMap::new(); let clients: DashMap<String, Arc<String>> = DashMap::new();
// Register domain "https://example.com" with base-path-aware client_id_url let client_a = Arc::new("client_a".to_string()); domain_clients.insert("https://example.com".to_string(), Arc::clone(&client_a)); clients.insert( "https://example.com/hv/oauth-client-metadata.json".to_string(), client_a, );
// Register domain "https://other.example.com" without base path let client_b = Arc::new("client_b".to_string()); domain_clients.insert( "https://other.example.com".to_string(), Arc::clone(&client_b), ); clients.insert( "https://other.example.com/oauth-client-metadata.json".to_string(), client_b, );
// Also register a non-domain API client let api_client = Arc::new("api_client".to_string()); clients.insert( "https://api.example.com/oauth-client-metadata.json".to_string(), api_client, );
let is_domain_client_id = |client_id_url: &str| -> bool { if let Some(candidate) = clients.get(client_id_url) { domain_clients .iter() .any(|entry| Arc::ptr_eq(entry.value(), candidate.value())) } else { false } };
// Base-path-aware key is detected as a domain client assert!(is_domain_client_id( "https://example.com/hv/oauth-client-metadata.json" )); // Non-base-path key is also detected assert!(is_domain_client_id( "https://other.example.com/oauth-client-metadata.json" )); // Unrelated URLs are not detected assert!(!is_domain_client_id( "https://unrelated.com/oauth-client-metadata.json" )); assert!(!is_domain_client_id("https://example.com/other-path.json")); // The old (wrong) key without base path is not detected assert!(!is_domain_client_id( "https://example.com/oauth-client-metadata.json" )); // API client is not detected as a domain client assert!(!is_domain_client_id( "https://api.example.com/oauth-client-metadata.json" )); }}