]> Untitled Git - lemmy.git/blobdiff - crates/apub/src/lib.rs
Remove federation settings, rely on sensible defaults instead (#2574)
[lemmy.git] / crates / apub / src / lib.rs
index 7a66e8aa28740ef5d7e33891a00b33fbda8ec719..f5d8d3565d84d74a8d1bd2dc005bebbb130467d7 100644 (file)
@@ -1,23 +1,86 @@
 use crate::fetcher::post_or_comment::PostOrComment;
-use anyhow::{anyhow, Context};
-use lemmy_api_common::blocking;
-use lemmy_db_schema::{newtypes::DbUrl, source::activity::Activity, DbPool};
-use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
-use serde::{Deserialize, Deserializer};
-use std::net::IpAddr;
+use activitypub_federation::{
+  core::signatures::PublicKey,
+  traits::{Actor, ApubObject},
+  InstanceSettings,
+  LocalInstance,
+  UrlVerifier,
+};
+use anyhow::Context;
+use async_trait::async_trait;
+use lemmy_db_schema::{
+  newtypes::DbUrl,
+  source::{activity::Activity, instance::Instance, local_site::LocalSite},
+  utils::DbPool,
+};
+use lemmy_utils::{error::LemmyError, location_info, settings::structs::Settings};
+use lemmy_websocket::LemmyContext;
+use once_cell::sync::Lazy;
+use tokio::sync::OnceCell;
 use url::{ParseError, Url};
 
 pub mod activities;
 pub(crate) mod activity_lists;
 pub(crate) mod collections;
-mod context;
 pub mod fetcher;
 pub mod http;
 pub(crate) mod mentions;
-pub mod migrations;
 pub mod objects;
 pub mod protocol;
 
+const FEDERATION_HTTP_FETCH_LIMIT: i32 = 25;
+
+static CONTEXT: Lazy<Vec<serde_json::Value>> = Lazy::new(|| {
+  serde_json::from_str(include_str!("../assets/lemmy/context.json")).expect("parse context")
+});
+
+// TODO: store this in context? but its only used in this crate, no need to expose it elsewhere
+// TODO this singleton needs to be redone to account for live data.
+async fn local_instance(context: &LemmyContext) -> &'static LocalInstance {
+  static LOCAL_INSTANCE: OnceCell<LocalInstance> = OnceCell::const_new();
+  LOCAL_INSTANCE
+    .get_or_init(|| async {
+      // Local site may be missing
+      let local_site = &LocalSite::read(context.pool()).await;
+      let worker_count = local_site
+        .as_ref()
+        .map(|l| l.federation_worker_count)
+        .unwrap_or(64) as u64;
+      let federation_debug = local_site
+        .as_ref()
+        .map(|l| l.federation_debug)
+        .unwrap_or(true);
+
+      let settings = InstanceSettings::builder()
+        .http_fetch_retry_limit(FEDERATION_HTTP_FETCH_LIMIT)
+        .worker_count(worker_count)
+        .debug(federation_debug)
+        .http_signature_compat(true)
+        .url_verifier(Box::new(VerifyUrlData(context.clone())))
+        .build()
+        .expect("configure federation");
+      LocalInstance::new(
+        context.settings().hostname.clone(),
+        context.client().clone(),
+        settings,
+      )
+    })
+    .await
+}
+
+#[derive(Clone)]
+struct VerifyUrlData(LemmyContext);
+
+#[async_trait]
+impl UrlVerifier for VerifyUrlData {
+  async fn verify(&self, url: &Url) -> Result<(), &'static str> {
+    let local_site_data = fetch_local_site_data(self.0.pool())
+      .await
+      .expect("read local site data");
+    check_apub_id_valid(url, &local_site_data, self.0.settings())
+  }
+}
+
 /// Checks if the ID is allowed for sending or receiving.
 ///
 /// In particular, it checks for:
@@ -28,106 +91,106 @@ pub mod protocol;
 ///
 /// `use_strict_allowlist` should be true only when parsing a remote community, or when parsing a
 /// post/comment in a local community.
-#[tracing::instrument(skip(settings))]
-pub(crate) fn check_is_apub_id_valid(
+#[tracing::instrument(skip(settings, local_site_data))]
+fn check_apub_id_valid(
   apub_id: &Url,
-  use_strict_allowlist: bool,
+  local_site_data: &LocalSiteData,
   settings: &Settings,
-) -> Result<(), LemmyError> {
-  let domain = apub_id.domain().context(location_info!())?.to_string();
-  let local_instance = settings.get_hostname_without_port()?;
-
-  if !settings.federation.enabled {
-    return if domain == local_instance {
-      Ok(())
-    } else {
-      let err = anyhow!(
-        "Trying to connect with {}, but federation is disabled",
-        domain
-      );
-      Err(LemmyError::from_error_message(err, "federation_disabled"))
-    };
+) -> Result<(), &'static str> {
+  let domain = apub_id.domain().expect("apud id has domain").to_string();
+  let local_instance = settings
+    .get_hostname_without_port()
+    .expect("local hostname is valid");
+  if domain == local_instance {
+    return Ok(());
   }
 
-  let host = apub_id.host_str().context(location_info!())?;
-  let host_as_ip = host.parse::<IpAddr>();
-  if host == "localhost" || host_as_ip.is_ok() {
-    let err = anyhow!("invalid hostname {}: {}", host, apub_id);
-    return Err(LemmyError::from_error_message(err, "invalid_hostname"));
+  if !local_site_data
+    .local_site
+    .as_ref()
+    .map(|l| l.federation_enabled)
+    .unwrap_or(true)
+  {
+    return Err("Federation disabled");
   }
 
   if apub_id.scheme() != settings.get_protocol_string() {
-    let err = anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id);
-    return Err(LemmyError::from_error_message(err, "invalid_scheme"));
+    return Err("Invalid protocol scheme");
   }
 
-  // TODO: might be good to put the part above in one method, and below in another
-  //       (which only gets called in apub::objects)
-  //        -> no that doesnt make sense, we still need the code below for blocklist and strict allowlist
-  if let Some(blocked) = settings.to_owned().federation.blocked_instances {
+  if let Some(blocked) = local_site_data.blocked_instances.as_ref() {
     if blocked.contains(&domain) {
-      let err = anyhow!("{} is in federation blocklist", domain);
-      return Err(LemmyError::from_error_message(err, "federation_blocked"));
+      return Err("Domain is blocked");
     }
   }
 
-  if let Some(mut allowed) = settings.to_owned().federation.allowed_instances {
-    // Only check allowlist if this is a community, or strict allowlist is enabled.
-    let strict_allowlist = settings.to_owned().federation.strict_allowlist;
-    if use_strict_allowlist || strict_allowlist {
-      // need to allow this explicitly because apub receive might contain objects from our local
-      // instance.
-      allowed.push(local_instance);
-
-      if !allowed.contains(&domain) {
-        let err = anyhow!("{} not in federation allowlist", domain);
-        return Err(LemmyError::from_error_message(
-          err,
-          "federation_not_allowed",
-        ));
-      }
+  if let Some(allowed) = local_site_data.allowed_instances.as_ref() {
+    if !allowed.contains(&domain) {
+      return Err("Domain is not in allowlist");
     }
   }
 
   Ok(())
 }
 
-pub(crate) fn deserialize_one_or_many<'de, T, D>(deserializer: D) -> Result<Vec<T>, D::Error>
-where
-  T: Deserialize<'de>,
-  D: Deserializer<'de>,
-{
-  #[derive(Deserialize)]
-  #[serde(untagged)]
-  enum OneOrMany<T> {
-    One(T),
-    Many(Vec<T>),
-  }
+#[derive(Clone)]
+pub(crate) struct LocalSiteData {
+  local_site: Option<LocalSite>,
+  allowed_instances: Option<Vec<String>>,
+  blocked_instances: Option<Vec<String>>,
+}
 
-  let result: OneOrMany<T> = Deserialize::deserialize(deserializer)?;
-  Ok(match result {
-    OneOrMany::Many(list) => list,
-    OneOrMany::One(value) => vec![value],
+pub(crate) async fn fetch_local_site_data(
+  pool: &DbPool,
+) -> Result<LocalSiteData, diesel::result::Error> {
+  // LocalSite may be missing
+  let local_site = LocalSite::read(pool).await.ok();
+  let allowed = Instance::allowlist(pool).await?;
+  let blocked = Instance::blocklist(pool).await?;
+
+  // These can return empty vectors, so convert them to options
+  let allowed_instances = (!allowed.is_empty()).then_some(allowed);
+  let blocked_instances = (!blocked.is_empty()).then_some(blocked);
+
+  Ok(LocalSiteData {
+    local_site,
+    allowed_instances,
+    blocked_instances,
   })
 }
 
-pub(crate) fn deserialize_one<'de, T, D>(deserializer: D) -> Result<[T; 1], D::Error>
-where
-  T: Deserialize<'de>,
-  D: Deserializer<'de>,
-{
-  #[derive(Deserialize)]
-  #[serde(untagged)]
-  enum MaybeArray<T> {
-    Simple(T),
-    Array([T; 1]),
+#[tracing::instrument(skip(settings, local_site_data))]
+pub(crate) fn check_apub_id_valid_with_strictness(
+  apub_id: &Url,
+  is_strict: bool,
+  local_site_data: &LocalSiteData,
+  settings: &Settings,
+) -> Result<(), LemmyError> {
+  check_apub_id_valid(apub_id, local_site_data, settings).map_err(LemmyError::from_message)?;
+  let domain = apub_id.domain().expect("apud id has domain").to_string();
+  let local_instance = settings
+    .get_hostname_without_port()
+    .expect("local hostname is valid");
+  if domain == local_instance {
+    return Ok(());
   }
 
-  let result: MaybeArray<T> = Deserialize::deserialize(deserializer)?;
-  Ok(match result {
-    MaybeArray::Simple(value) => [value],
-    MaybeArray::Array(value) => value,
-  })
+  if let Some(allowed) = local_site_data.allowed_instances.as_ref() {
+    // Only check allowlist if this is a community
+    if is_strict {
+      // need to allow this explicitly because apub receive might contain objects from our local
+      // instance.
+      let mut allowed_and_local = allowed.clone();
+      allowed_and_local.push(local_instance);
+
+      if !allowed_and_local.contains(&domain) {
+        return Err(LemmyError::from_message(
+          "Federation forbidden by strict allowlist",
+        ));
+      }
+    }
+  }
+  Ok(())
 }
 
 pub enum EndpointType {
@@ -178,7 +241,7 @@ pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError>
     if let Some(port) = actor_id.port() {
       format!(":{}", port)
     } else {
-      "".to_string()
+      String::new()
     },
   );
   Ok(Url::parse(&url)?.into())
@@ -202,11 +265,18 @@ async fn insert_activity(
   sensitive: bool,
   pool: &DbPool,
 ) -> Result<bool, LemmyError> {
-  let ap_id = ap_id.to_owned().into();
-  Ok(
-    blocking(pool, move |conn| {
-      Activity::insert(conn, ap_id, activity, local, sensitive)
-    })
-    .await??,
-  )
+  let ap_id = ap_id.clone().into();
+  Ok(Activity::insert(pool, ap_id, activity, local, Some(sensitive)).await?)
+}
+
+/// Common methods provided by ActivityPub actors (community and person). Not all methods are
+/// implemented by all actors.
+pub trait ActorType: Actor + ApubObject {
+  fn actor_id(&self) -> Url;
+
+  fn private_key(&self) -> Option<String>;
+
+  fn get_public_key(&self) -> PublicKey {
+    PublicKey::new_main_key(self.actor_id(), self.public_key().to_string())
+  }
 }