+use crate::fetcher::post_or_comment::PostOrComment;
+use activitypub_federation::{
+ core::signatures::PublicKey,
+ traits::{Actor, ApubObject},
+ InstanceSettings,
+ LocalInstance,
+};
+use anyhow::Context;
+use diesel::PgConnection;
+use lemmy_api_common::utils::blocking;
+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, 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 mod migrations;
+pub(crate) mod mentions;
pub mod objects;
+pub mod protocol;
-#[macro_use]
-extern crate lazy_static;
+static CONTEXT: Lazy<Vec<serde_json::Value>> = Lazy::new(|| {
+ serde_json::from_str(include_str!("../assets/lemmy/context.json")).expect("parse context")
+});
-use crate::fetcher::post_or_comment::PostOrComment;
-use anyhow::{anyhow, Context};
-use lemmy_api_common::blocking;
-use lemmy_apub_lib::{
- activity_queue::send_activity,
- traits::ActorType,
- webfinger::{webfinger_resolve_actor, WebfingerType},
-};
-use lemmy_db_schema::{newtypes::DbUrl, source::activity::Activity, DbPool};
-use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
-use lemmy_websocket::LemmyContext;
-use log::info;
-use serde::Serialize;
-use std::net::IpAddr;
-use url::{ParseError, Url};
+// 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.
+fn local_instance(context: &LemmyContext) -> &'static LocalInstance {
+ static LOCAL_INSTANCE: OnceCell<LocalInstance> = OnceCell::new();
+ LOCAL_INSTANCE.get_or_init(|| {
+ let conn = &mut context
+ .pool()
+ .get()
+ .expect("getting connection for LOCAL_INSTANCE init");
+ // Local site may be missing
+ let local_site = &LocalSite::read(conn);
+ let worker_count = local_site
+ .as_ref()
+ .map(|l| l.federation_worker_count)
+ .unwrap_or(64) as u64;
+ let http_fetch_retry_limit = local_site
+ .as_ref()
+ .map(|l| l.federation_http_fetch_retry_limit)
+ .unwrap_or(25);
+ let federation_debug = local_site
+ .as_ref()
+ .map(|l| l.federation_debug)
+ .unwrap_or(true);
+
+ let settings = InstanceSettings::builder()
+ .http_fetch_retry_limit(http_fetch_retry_limit)
+ .worker_count(worker_count)
+ .debug(federation_debug)
+ // TODO No idea why, but you can't pass context.settings() to the verify_url_function closure
+ // without the value getting captured.
+ .http_signature_compat(true)
+ .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.
///
/// - 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))]
+// TODO This function needs to be called by incoming activities
+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(allowed) = local_site_data.allowed_instances.as_ref() {
+ if !allowed.contains(&domain) {
+ return Err("Domain is not in allowlist");
}
}
- if let Some(mut allowed) = settings.to_owned().federation.allowed_instances {
+ Ok(())
+}
+
+#[derive(Clone)]
+pub(crate) struct LocalSiteData {
+ local_site: Option<LocalSite>,
+ allowed_instances: Option<Vec<String>>,
+ blocked_instances: Option<Vec<String>>,
+}
+
+pub(crate) fn fetch_local_site_data(
+ conn: &mut PgConnection,
+) -> Result<LocalSiteData, diesel::result::Error> {
+ // LocalSite may be missing
+ let local_site = LocalSite::read(conn).ok();
+ let allowed = Instance::allowlist(conn)?;
+ let blocked = Instance::blocklist(conn)?;
+
+ // These can return empty vectors, so convert them to options
+ let allowed_instances = (!allowed.is_empty()).then(|| allowed);
+ let blocked_instances = (!blocked.is_empty()).then(|| blocked);
+
+ Ok(LocalSiteData {
+ local_site,
+ allowed_instances,
+ blocked_instances,
+ })
+}
+
+#[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(());
+ }
+
+ if let Some(allowed) = local_site_data.allowed_instances.as_ref() {
// 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 {
+ let strict_allowlist = local_site_data
+ .local_site
+ .as_ref()
+ .map(|l| l.federation_strict_allowlist)
+ .unwrap_or(true);
+ if is_strict || strict_allowlist {
// need to allow this explicitly because apub receive might contain objects from our local
// instance.
- allowed.push(local_instance);
+ let mut allowed_and_local = allowed.to_owned();
+ allowed_and_local.push(local_instance);
- if !allowed.contains(&domain) {
- return Err(anyhow!("{} not in federation allowlist", domain).into());
+ if !allowed_and_local.contains(&domain) {
+ return Err(LemmyError::from_message(
+ "Federation forbidden by strict allowlist",
+ ));
}
}
}
-
Ok(())
}
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!(
Ok(Url::parse(&format!("{}/moderators", community_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 async fn get_actor_id_from_name(
- webfinger_type: WebfingerType,
- short_name: &str,
- context: &LemmyContext,
-) -> Result<DbUrl, LemmyError> {
- let split = short_name.split('@').collect::<Vec<&str>>();
-
- let name = split[0];
-
- // If there's no @, its local
- if split.len() == 1 {
- let domain = context.settings().get_protocol_and_hostname();
- let endpoint_type = match webfinger_type {
- WebfingerType::Person => EndpointType::Person,
- WebfingerType::Group => EndpointType::Community,
- };
- Ok(generate_local_apub_endpoint(endpoint_type, name, &domain)?)
- } else {
- let protocol = context.settings().get_protocol_string();
- Ok(
- webfinger_resolve_actor(name, split[1], webfinger_type, context.client(), protocol)
- .await?
- .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,
-{
+) -> Result<bool, LemmyError> {
let ap_id = ap_id.to_owned().into();
- blocking(pool, move |conn| {
- Activity::insert(conn, ap_id, &activity, local, sensitive)
- })
- .await??;
- Ok(())
+ Ok(
+ blocking(pool, move |conn| {
+ Activity::insert(conn, ap_id, activity, local, Some(sensitive))
+ })
+ .await??,
+ )
}
-pub(crate) async fn send_lemmy_activity<T: Serialize>(
- context: &LemmyContext,
- activity: &T,
- activity_id: &Url,
- actor: &dyn ActorType,
- inboxes: Vec<Url>,
- sensitive: bool,
-) -> Result<(), LemmyError> {
- if !context.settings().federation.enabled || inboxes.is_empty() {
- return Ok(());
- }
-
- info!("Sending activity {}", activity_id.to_string());
-
- // Don't send anything to ourselves
- // TODO: this should be a debug assert
- let hostname = context.settings().get_hostname_without_port()?;
- let inboxes: Vec<&Url> = inboxes
- .iter()
- .filter(|i| i.domain().expect("valid inbox url") != hostname)
- .collect();
+/// 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;
- let serialised_activity = serde_json::to_string(&activity)?;
+ fn private_key(&self) -> Option<String>;
- insert_activity(
- activity_id,
- serialised_activity.clone(),
- true,
- sensitive,
- context.pool(),
- )
- .await?;
-
- send_activity(
- serialised_activity,
- actor,
- inboxes,
- context.client(),
- context.activity_queue(),
- )
- .await
+ fn get_public_key(&self) -> PublicKey {
+ PublicKey::new_main_key(self.actor_id(), self.public_key().to_string())
+ }
}
projects / lemmy.git / blobdiff