2 extern crate lazy_static;
5 pub mod activity_queue;
12 use crate::extensions::{
13 group_extensions::GroupExtension,
14 page_extension::PageExtension,
15 signatures::{PublicKey, PublicKeyExtension},
17 use activitystreams::{
19 actor::{ApActor, Group, Person},
21 object::{ApObject, Note, Page},
23 use activitystreams_ext::{Ext1, Ext2};
24 use anyhow::{anyhow, Context};
26 use lemmy_db_queries::{source::activity::Activity_, ApubObject, DbPool};
27 use lemmy_db_schema::source::{
32 private_message::PrivateMessage,
35 use lemmy_structs::blocking;
36 use lemmy_utils::{location_info, settings::Settings, LemmyError};
37 use lemmy_websocket::LemmyContext;
40 use url::{ParseError, Url};
42 /// Activitystreams type for community
43 type GroupExt = Ext2<ApActor<ApObject<Group>>, GroupExtension, PublicKeyExtension>;
44 /// Activitystreams type for user
45 type PersonExt = Ext1<ApActor<ApObject<Person>>, PublicKeyExtension>;
46 /// Activitystreams type for post
47 type PageExt = Ext1<ApObject<Page>, PageExtension>;
48 type NoteExt = ApObject<Note>;
50 pub static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
52 /// Checks if the ID is allowed for sending or receiving.
54 /// In particular, it checks for:
55 /// - federation being enabled (if its disabled, only local URLs are allowed)
56 /// - the correct scheme (either http or https)
57 /// - URL being in the allowlist (if it is active)
58 /// - URL not being in the blocklist (if it is active)
60 /// Note that only one of allowlist and blacklist can be enabled, not both.
61 fn check_is_apub_id_valid(apub_id: &Url) -> Result<(), LemmyError> {
62 let settings = Settings::get();
63 let domain = apub_id.domain().context(location_info!())?.to_string();
64 let local_instance = settings.get_hostname_without_port()?;
66 if !settings.federation.enabled {
67 return if domain == local_instance {
72 "Trying to connect with {}, but federation is disabled",
80 let host = apub_id.host_str().context(location_info!())?;
81 let host_as_ip = host.parse::<IpAddr>();
82 if host == "localhost" || host_as_ip.is_ok() {
83 return Err(anyhow!("invalid hostname: {:?}", host).into());
86 if apub_id.scheme() != Settings::get().get_protocol_string() {
87 return Err(anyhow!("invalid apub id scheme: {:?}", apub_id.scheme()).into());
90 let mut allowed_instances = Settings::get().get_allowed_instances();
91 let blocked_instances = Settings::get().get_blocked_instances();
92 if allowed_instances.is_empty() && blocked_instances.is_empty() {
94 } else if !allowed_instances.is_empty() {
95 // need to allow this explicitly because apub receive might contain objects from our local
96 // instance. split is needed to remove the port in our federation test setup.
97 allowed_instances.push(local_instance);
99 if allowed_instances.contains(&domain) {
102 Err(anyhow!("{} not in federation allowlist", domain).into())
104 } else if !blocked_instances.is_empty() {
105 if blocked_instances.contains(&domain) {
106 Err(anyhow!("{} is in federation blocklist", domain).into())
111 panic!("Invalid config, both allowed_instances and blocked_instances are specified");
115 /// Common functions for ActivityPub objects, which are implemented by most (but not all) objects
116 /// and actors in Lemmy.
117 #[async_trait::async_trait(?Send)]
118 pub trait ApubObjectType {
119 async fn send_create(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
120 async fn send_update(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
121 async fn send_delete(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
122 async fn send_undo_delete(
125 context: &LemmyContext,
126 ) -> Result<(), LemmyError>;
127 async fn send_remove(&self, mod_: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
128 async fn send_undo_remove(&self, mod_: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
131 #[async_trait::async_trait(?Send)]
132 pub trait ApubLikeableType {
133 async fn send_like(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
134 async fn send_dislike(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
135 async fn send_undo_like(&self, creator: &User_, context: &LemmyContext)
136 -> Result<(), LemmyError>;
139 /// Common methods provided by ActivityPub actors (community and user). Not all methods are
140 /// implemented by all actors.
141 #[async_trait::async_trait(?Send)]
142 pub trait ActorType {
143 fn is_local(&self) -> bool;
144 fn actor_id(&self) -> Url;
146 // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
147 fn public_key(&self) -> Option<String>;
148 fn private_key(&self) -> Option<String>;
150 async fn send_follow(
152 follow_actor_id: &Url,
153 context: &LemmyContext,
154 ) -> Result<(), LemmyError>;
155 async fn send_unfollow(
157 follow_actor_id: &Url,
158 context: &LemmyContext,
159 ) -> Result<(), LemmyError>;
161 async fn send_accept_follow(
164 context: &LemmyContext,
165 ) -> Result<(), LemmyError>;
167 async fn send_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
168 async fn send_undo_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
170 async fn send_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
171 async fn send_undo_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
173 async fn send_announce(
176 context: &LemmyContext,
177 ) -> Result<(), LemmyError>;
179 /// For a given community, returns the inboxes of all followers.
180 async fn get_follower_inboxes(&self, pool: &DbPool) -> Result<Vec<Url>, LemmyError>;
182 fn get_shared_inbox_or_inbox_url(&self) -> Url;
184 /// Outbox URL is not generally used by Lemmy, so it can be generated on the fly (but only for
186 fn get_outbox_url(&self) -> Result<Url, LemmyError> {
187 if !self.is_local() {
188 return Err(anyhow!("get_outbox_url() called for remote actor").into());
190 Ok(Url::parse(&format!("{}/outbox", &self.actor_id()))?)
193 fn get_public_key_ext(&self) -> Result<PublicKeyExtension, LemmyError> {
196 id: format!("{}#main-key", self.actor_id()),
197 owner: self.actor_id(),
198 public_key_pem: self.public_key().context(location_info!())?,
205 pub enum EndpointType {
213 /// Generates the ActivityPub ID for a given object type and ID.
214 pub fn generate_apub_endpoint(
215 endpoint_type: EndpointType,
217 ) -> Result<lemmy_db_schema::Url, ParseError> {
218 let point = match endpoint_type {
219 EndpointType::Community => "c",
220 EndpointType::User => "u",
221 EndpointType::Post => "post",
222 EndpointType::Comment => "comment",
223 EndpointType::PrivateMessage => "private_message",
229 Settings::get().get_protocol_and_hostname(),
237 pub fn generate_followers_url(
238 actor_id: &lemmy_db_schema::Url,
239 ) -> Result<lemmy_db_schema::Url, ParseError> {
240 Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
243 pub fn generate_inbox_url(
244 actor_id: &lemmy_db_schema::Url,
245 ) -> Result<lemmy_db_schema::Url, ParseError> {
246 Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
249 pub fn generate_shared_inbox_url(
250 actor_id: &lemmy_db_schema::Url,
251 ) -> Result<lemmy_db_schema::Url, LemmyError> {
252 let actor_id = actor_id.clone().into_inner();
256 &actor_id.host_str().context(location_info!())?,
257 if let Some(port) = actor_id.port() {
263 Ok(Url::parse(&url)?.into())
266 /// Store a sent or received activity in the database, for logging purposes. These records are not
268 pub(crate) async fn insert_activity<T>(
274 ) -> Result<(), LemmyError>
276 T: Serialize + std::fmt::Debug + Send + 'static,
278 let ap_id = ap_id.to_string();
279 blocking(pool, move |conn| {
280 Activity::insert(conn, ap_id, &activity, local, sensitive)
286 pub(crate) enum PostOrComment {
291 /// Tries to find a post or comment in the local database, without any network requests.
292 /// This is used to handle deletions and removals, because in case we dont have the object, we can
293 /// simply ignore the activity.
294 pub(crate) async fn find_post_or_comment_by_id(
295 context: &LemmyContext,
297 ) -> Result<PostOrComment, LemmyError> {
298 let ap_id = apub_id.clone();
299 let post = blocking(context.pool(), move |conn| {
300 Post::read_from_apub_id(conn, &ap_id.into())
303 if let Ok(p) = post {
304 return Ok(PostOrComment::Post(p));
307 let ap_id = apub_id.clone();
308 let comment = blocking(context.pool(), move |conn| {
309 Comment::read_from_apub_id(conn, &ap_id.into())
312 if let Ok(c) = comment {
313 return Ok(PostOrComment::Comment(c));
319 pub(crate) enum Object {
322 Community(Community),
324 PrivateMessage(PrivateMessage),
327 pub(crate) async fn find_object_by_id(
328 context: &LemmyContext,
330 ) -> Result<Object, LemmyError> {
331 let ap_id = apub_id.clone();
332 if let Ok(pc) = find_post_or_comment_by_id(context, ap_id.to_owned()).await {
334 PostOrComment::Post(p) => Object::Post(p),
335 PostOrComment::Comment(c) => Object::Comment(c),
339 let ap_id = apub_id.clone();
340 let user = blocking(context.pool(), move |conn| {
341 User_::read_from_apub_id(conn, &ap_id.into())
344 if let Ok(u) = user {
345 return Ok(Object::User(u));
348 let ap_id = apub_id.clone();
349 let community = blocking(context.pool(), move |conn| {
350 Community::read_from_apub_id(conn, &ap_id.into())
353 if let Ok(c) = community {
354 return Ok(Object::Community(c));
357 let private_message = blocking(context.pool(), move |conn| {
358 PrivateMessage::read_from_apub_id(conn, &apub_id.into())
361 if let Ok(pm) = private_message {
362 return Ok(Object::PrivateMessage(pm));