]> Untitled Git - lemmy.git/blobdiff - crates/apub/src/lib.rs
Tag posts and comments with language (fixes #440) (#2269)
[lemmy.git] / crates / apub / src / lib.rs
index 7a66e8aa28740ef5d7e33891a00b33fbda8ec719..8fd8588b87ad7ae3bc75f959548724a7ad28e67f 100644 (file)
@@ -1,23 +1,56 @@
 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},
+  InstanceSettingsBuilder,
+  LocalInstance,
+};
+use anyhow::Context;
+use lemmy_api_common::utils::blocking;
+use lemmy_db_schema::{newtypes::DbUrl, source::activity::Activity, utils::DbPool};
+use lemmy_utils::{
+  error::LemmyError,
+  location_info,
+  settings::{structs::Settings, SETTINGS},
+};
+use lemmy_websocket::LemmyContext;
+use once_cell::sync::{Lazy, 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;
 
+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
+fn local_instance(context: &LemmyContext) -> &'static LocalInstance {
+  static LOCAL_INSTANCE: OnceCell<LocalInstance> = OnceCell::new();
+  LOCAL_INSTANCE.get_or_init(|| {
+    let settings = InstanceSettingsBuilder::default()
+      .http_fetch_retry_limit(context.settings().federation.http_fetch_retry_limit)
+      .worker_count(context.settings().federation.worker_count)
+      .debug(context.settings().federation.debug)
+      // TODO No idea why, but you can't pass context.settings() to the verify_url_function closure
+      // without the value getting captured.
+      .verify_url_function(|url| check_apub_id_valid(url, &SETTINGS))
+      .build()
+      .expect("configure federation");
+    LocalInstance::new(
+      context.settings().hostname.to_owned(),
+      context.client().clone(),
+      settings,
+    )
+  })
+}
+
 /// Checks if the ID is allowed for sending or receiving.
 ///
 /// In particular, it checks for:
@@ -29,107 +62,71 @@ 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(
-  apub_id: &Url,
-  use_strict_allowlist: bool,
-  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"))
-    };
+fn check_apub_id_valid(apub_id: &Url, settings: &Settings) -> 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 !settings.federation.enabled {
+    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 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(allowed) = settings.to_owned().federation.allowed_instances {
+    if !allowed.contains(&domain) {
+      return Err("Domain is not in allowlist");
+    }
+  }
+
+  Ok(())
+}
+
+#[tracing::instrument(skip(settings))]
+pub(crate) fn check_apub_id_valid_with_strictness(
+  apub_id: &Url,
+  is_strict: bool,
+  settings: &Settings,
+) -> Result<(), LemmyError> {
+  check_apub_id_valid(apub_id, 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(());
+  }
+
   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 {
+    if is_strict || 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",
+        return Err(LemmyError::from_message(
+          "Federation forbidden by strict 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>),
-  }
-
-  let result: OneOrMany<T> = Deserialize::deserialize(deserializer)?;
-  Ok(match result {
-    OneOrMany::Many(list) => list,
-    OneOrMany::One(value) => vec![value],
-  })
-}
-
-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]),
-  }
-
-  let result: MaybeArray<T> = Deserialize::deserialize(deserializer)?;
-  Ok(match result {
-    MaybeArray::Simple(value) => [value],
-    MaybeArray::Array(value) => value,
-  })
-}
-
 pub enum EndpointType {
   Community,
   Person,
@@ -210,3 +207,15 @@ async fn insert_activity(
     .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())
+  }
+}