-#[macro_use]
-extern crate lazy_static;
+use crate::fetcher::post_or_comment::PostOrComment;
+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 mod activity_queue;
-pub mod extensions;
+pub(crate) mod activity_lists;
+pub(crate) mod collections;
pub mod fetcher;
pub mod http;
-pub mod migrations;
+pub(crate) mod mentions;
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
+}
-use crate::{extensions::signatures::PublicKey, fetcher::post_or_comment::PostOrComment};
-use anyhow::{anyhow, Context};
-use lemmy_api_common::blocking;
-use lemmy_db_queries::{source::activity::Activity_, DbPool};
-use lemmy_db_schema::{
- source::{activity::Activity, person::Person},
- CommunityId,
- DbUrl,
-};
-use lemmy_db_views_actor::community_person_ban_view::CommunityPersonBanView;
-use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
-use serde::Serialize;
-use std::net::IpAddr;
-use url::{ParseError, Url};
+#[derive(Clone)]
+struct VerifyUrlData(LemmyContext);
-static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
+#[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.
///
/// - URL being in the allowlist (if it is active)
/// - URL not being in the blocklist (if it is active)
///
-pub(crate) fn check_is_apub_id_valid(
+/// `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, 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 {
- Err(
- anyhow!(
- "Trying to connect with {}, but federation is disabled",
- domain
- )
- .into(),
- )
- };
+) -> 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() {
- return Err(anyhow!("invalid hostname {}: {}", host, apub_id).into());
+ 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() {
- return Err(anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id).into());
+ 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) {
- return Err(anyhow!("{} is in federation blocklist", domain).into());
+ 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) {
- return Err(anyhow!("{} not in federation allowlist", domain).into());
- }
+ if let Some(allowed) = local_site_data.allowed_instances.as_ref() {
+ if !allowed.contains(&domain) {
+ return Err("Domain is not in allowlist");
}
}
Ok(())
}
-/// Common methods provided by ActivityPub actors (community and person). Not all methods are
-/// implemented by all actors.
-trait ActorType {
- fn is_local(&self) -> bool;
- fn actor_id(&self) -> Url;
- fn name(&self) -> String;
-
- // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
- fn public_key(&self) -> Option<String>;
- fn private_key(&self) -> Option<String>;
+#[derive(Clone)]
+pub(crate) struct LocalSiteData {
+ local_site: Option<LocalSite>,
+ allowed_instances: Option<Vec<String>>,
+ blocked_instances: Option<Vec<String>>,
+}
- fn get_shared_inbox_or_inbox_url(&self) -> Url;
+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,
+ })
+}
- /// Outbox URL is not generally used by Lemmy, so it can be generated on the fly (but only for
- /// local actors).
- fn get_outbox_url(&self) -> Result<Url, LemmyError> {
- /* TODO
- if !self.is_local() {
- return Err(anyhow!("get_outbox_url() called for remote actor").into());
- }
- */
- Ok(Url::parse(&format!("{}/outbox", &self.actor_id()))?)
+#[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(());
}
- fn get_public_key(&self) -> Result<PublicKey, LemmyError> {
- Ok(PublicKey {
- id: format!("{}#main-key", self.actor_id()),
- owner: self.actor_id(),
- public_key_pem: self.public_key().context(location_info!())?,
- })
- }
-}
+ 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);
-#[async_trait::async_trait(?Send)]
-pub trait CommunityType {
- fn followers_url(&self) -> Url;
- async fn get_follower_inboxes(
- &self,
- pool: &DbPool,
- settings: &Settings,
- ) -> Result<Vec<Url>, LemmyError>;
+ if !allowed_and_local.contains(&domain) {
+ return Err(LemmyError::from_message(
+ "Federation forbidden by strict allowlist",
+ ));
+ }
+ }
+ }
+ Ok(())
}
pub enum EndpointType {
}
/// Generates an apub endpoint for a given domain, IE xyz.tld
-fn generate_apub_endpoint_for_domain(
+pub fn generate_local_apub_endpoint(
endpoint_type: EndpointType,
name: &str,
domain: &str,
Ok(Url::parse(&format!("{}/{}/{}", domain, point, name))?.into())
}
-/// Generates the ActivityPub ID for a given object type and ID.
-pub fn generate_apub_endpoint(
- endpoint_type: EndpointType,
- name: &str,
- protocol_and_hostname: &str,
-) -> Result<DbUrl, ParseError> {
- generate_apub_endpoint_for_domain(endpoint_type, name, protocol_and_hostname)
-}
-
pub fn generate_followers_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
}
Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
}
+pub fn generate_site_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
+ let mut actor_id: Url = actor_id.clone().into();
+ actor_id.set_path("site_inbox");
+ Ok(actor_id.into())
+}
+
pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError> {
let actor_id: Url = actor_id.clone().into();
let url = format!(
if let Some(port) = actor_id.port() {
format!(":{}", port)
} else {
- "".to_string()
+ String::new()
},
);
Ok(Url::parse(&url)?.into())
}
-fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
- Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
+pub fn generate_outbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
+ Ok(Url::parse(&format!("{}/outbox", actor_id))?.into())
}
-/// Takes in a shortname of the type dessalines@xyz.tld or dessalines (assumed to be local), and outputs the actor id.
-/// Used in the API for communities and users.
-pub fn build_actor_id_from_shortname(
- endpoint_type: EndpointType,
- short_name: &str,
- settings: &Settings,
-) -> Result<DbUrl, ParseError> {
- let split = short_name.split('@').collect::<Vec<&str>>();
-
- let name = split[0];
-
- // If there's no @, its local
- let domain = if split.len() == 1 {
- settings.get_protocol_and_hostname()
- } else {
- format!("{}://{}", settings.get_protocol_string(), split[1])
- };
-
- generate_apub_endpoint_for_domain(endpoint_type, name, &domain)
+fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
+ Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
}
/// Store a sent or received activity in the database, for logging purposes. These records are not
/// persistent.
-async fn insert_activity<T>(
+#[tracing::instrument(skip(pool))]
+async fn insert_activity(
ap_id: &Url,
- activity: T,
+ activity: serde_json::Value,
local: bool,
sensitive: bool,
pool: &DbPool,
-) -> Result<(), LemmyError>
-where
- T: Serialize + std::fmt::Debug + Send + 'static,
-{
- let ap_id = ap_id.to_owned().into();
- blocking(pool, move |conn| {
- Activity::insert(conn, ap_id, &activity, local, sensitive)
- })
- .await??;
- Ok(())
+) -> Result<bool, LemmyError> {
+ let ap_id = ap_id.clone().into();
+ Ok(Activity::insert(pool, ap_id, activity, local, Some(sensitive)).await?)
}
-async fn check_community_or_site_ban(
- person: &Person,
- community_id: CommunityId,
- pool: &DbPool,
-) -> Result<(), LemmyError> {
- if person.banned {
- return Err(anyhow!("Person is banned from site").into());
- }
- let person_id = person.id;
- let is_banned =
- move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
- if blocking(pool, is_banned).await? {
- return Err(anyhow!("Person is banned from community").into());
- }
+/// 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;
- Ok(())
+ fn private_key(&self) -> Option<String>;
+
+ fn get_public_key(&self) -> PublicKey {
+ PublicKey::new_main_key(self.actor_id(), self.public_key().to_string())
+ }
}
projects / lemmy.git / blobdiff