pub mod console; mod create; mod grant; use std::{future::Future, pin::Pin, sync::Arc}; use conduit::{utils::mutex_map, Error, Result}; pub use create::create_admin_room; pub use grant::make_user_admin; use ruma::{ events::{ room::message::{Relation, RoomMessageEventContent}, TimelineEventType, }, EventId, OwnedRoomId, RoomId, UserId, }; use serde_json::value::to_raw_value; use tokio::{sync::Mutex, task::JoinHandle}; use tracing::error; use crate::{pdu::PduBuilder, services, PduEvent}; pub type HandlerResult = Pin> + Send>>; pub type Handler = fn(AdminEvent) -> HandlerResult; pub struct Service { sender: loole::Sender, receiver: Mutex>, handler_join: Mutex>>, pub handle: Mutex>, #[cfg(feature = "console")] pub console: Arc, } #[derive(Debug)] pub enum AdminEvent { Command(String, Option>), Reply(Option), Notice(RoomMessageEventContent), } impl Service { #[must_use] pub fn build() -> Arc { let (sender, receiver) = loole::unbounded(); Arc::new(Self { sender, receiver: Mutex::new(receiver), handler_join: Mutex::new(None), handle: Mutex::new(None), #[cfg(feature = "console")] console: console::Console::new(), }) } pub fn interrupt(&self) { #[cfg(feature = "console")] self.console.interrupt(); if !self.sender.is_closed() { self.sender.close(); } } pub async fn close(&self) { self.interrupt(); #[cfg(feature = "console")] self.console.close().await; if let Some(handler_join) = self.handler_join.lock().await.take() { if let Err(e) = handler_join.await { error!("Failed to shutdown: {e:?}"); } } } pub async fn start_handler(self: &Arc) { let self_ = Arc::clone(self); let handle = services().server.runtime().spawn(async move { self_ .handler() .await .expect("Failed to initialize admin room handler"); }); _ = self.handler_join.lock().await.insert(handle); } async fn handler(self: &Arc) -> Result<()> { let receiver = self.receiver.lock().await; let mut signals = services().server.signal.subscribe(); loop { debug_assert!(!receiver.is_closed(), "channel closed"); tokio::select! { event = receiver.recv_async() => match event { Ok(event) => self.receive(event).await, Err(_) => return Ok(()), }, sig = signals.recv() => match sig { Ok(sig) => self.handle_signal(sig).await, Err(_) => continue, }, } } } pub async fn send_text(&self, body: &str) { self.send_message(RoomMessageEventContent::text_plain(body)) .await; } pub async fn send_message(&self, message_content: RoomMessageEventContent) { self.send(AdminEvent::Notice(message_content)).await; } pub async fn command(&self, command: String, event_id: Option>) { self.send(AdminEvent::Command(command, event_id)).await; } pub async fn command_in_place( &self, command: String, event_id: Option>, ) -> Result> { match self.handle(AdminEvent::Command(command, event_id)).await? { AdminEvent::Reply(content) => Ok(content), _ => Ok(None), } } async fn send(&self, message: AdminEvent) { debug_assert!(!self.sender.is_full(), "channel full"); debug_assert!(!self.sender.is_closed(), "channel closed"); self.sender.send(message).expect("message sent"); } async fn receive(&self, event: AdminEvent) { if let Ok(AdminEvent::Reply(content)) = self.handle(event).await { handle_response(content).await; } } async fn handle(&self, event: AdminEvent) -> Result { if let Some(handle) = self.handle.lock().await.as_ref() { handle(event).await } else { Err(Error::Err("Admin module is not loaded.".into())) } } async fn handle_signal(&self, #[allow(unused_variables)] sig: &'static str) { #[cfg(feature = "console")] if sig == "SIGINT" && services().server.running() { self.console.start().await; } } /// Checks whether a given user is an admin of this server pub async fn user_is_admin(&self, user_id: &UserId) -> Result { if let Ok(Some(admin_room)) = Self::get_admin_room() { services().rooms.state_cache.is_joined(user_id, &admin_room) } else { Ok(false) } } /// Gets the room ID of the admin room /// /// Errors are propagated from the database, and will have None if there is /// no admin room pub fn get_admin_room() -> Result> { if let Some(room_id) = services() .rooms .alias .resolve_local_alias(&services().globals.admin_alias)? { if services() .rooms .state_cache .is_joined(&services().globals.server_user, &room_id)? { return Ok(Some(room_id)); } } Ok(None) } } async fn handle_response(content: Option) { if let Some(content) = content.as_ref() { if let Some(Relation::Reply { in_reply_to, }) = content.relates_to.as_ref() { if let Ok(Some(pdu)) = services().rooms.timeline.get_pdu(&in_reply_to.event_id) { let response_sender = if is_admin_room(&pdu.room_id) { &services().globals.server_user } else { &pdu.sender }; respond_to_room(content, &pdu.room_id, response_sender).await; } } } } async fn respond_to_room(content: &RoomMessageEventContent, room_id: &RoomId, user_id: &UserId) { assert!( services() .admin .user_is_admin(user_id) .await .expect("checked user is admin"), "sender is not admin" ); let state_lock = services().globals.roomid_mutex_state.lock(room_id).await; let response_pdu = PduBuilder { event_type: TimelineEventType::RoomMessage, content: to_raw_value(content).expect("event is valid, we just created it"), unsigned: None, state_key: None, redacts: None, }; if let Err(e) = services() .rooms .timeline .build_and_append_pdu(response_pdu, user_id, room_id, &state_lock) .await { if let Err(e) = handle_response_error(&e, room_id, user_id, &state_lock).await { error!("{e}"); } } } async fn handle_response_error( e: &Error, room_id: &RoomId, user_id: &UserId, state_lock: &mutex_map::Guard<()>, ) -> Result<()> { error!("Failed to build and append admin room response PDU: \"{e}\""); let error_room_message = RoomMessageEventContent::text_plain(format!( "Failed to build and append admin room PDU: \"{e}\"\n\nThe original admin command may have finished \ successfully, but we could not return the output." )); let response_pdu = PduBuilder { event_type: TimelineEventType::RoomMessage, content: to_raw_value(&error_room_message).expect("event is valid, we just created it"), unsigned: None, state_key: None, redacts: None, }; services() .rooms .timeline .build_and_append_pdu(response_pdu, user_id, room_id, state_lock) .await?; Ok(()) } pub async fn is_admin_command(pdu: &PduEvent, body: &str) -> bool { // Server-side command-escape with public echo let is_escape = body.starts_with('\\'); let is_public_escape = is_escape && body.trim_start_matches('\\').starts_with("!admin"); // Admin command with public echo (in admin room) let server_user = &services().globals.server_user; let is_public_prefix = body.starts_with("!admin") || body.starts_with(server_user.as_str()); // Expected backward branch if !is_public_escape && !is_public_prefix { return false; } // Check if server-side command-escape is disabled by configuration if is_public_escape && !services().globals.config.admin_escape_commands { return false; } // Prevent unescaped !admin from being used outside of the admin room if is_public_prefix && !is_admin_room(&pdu.room_id) { return false; } // Only senders who are admin can proceed if !services() .admin .user_is_admin(&pdu.sender) .await .unwrap_or(false) { return false; } // This will evaluate to false if the emergency password is set up so that // the administrator can execute commands as conduit let emergency_password_set = services().globals.emergency_password().is_some(); let from_server = pdu.sender == *server_user && !emergency_password_set; if from_server && is_admin_room(&pdu.room_id) { return false; } // Authentic admin command true } #[must_use] pub fn is_admin_room(room_id: &RoomId) -> bool { if let Ok(Some(admin_room_id)) = Service::get_admin_room() { admin_room_id == room_id } else { false } }