crates/apub/src/lib.rs

   1 #[macro_use]
   2 extern crate lazy_static;
   3
   4 pub mod activities;
   5 pub mod activity_queue;
   6 pub mod extensions;
   7 pub mod fetcher;
   8 pub mod http;
   9 pub mod inbox;
  10 pub mod objects;
  11
  12 use crate::extensions::{
  13   group_extensions::GroupExtension,
  14   page_extension::PageExtension,
  15   signatures::{PublicKey, PublicKeyExtension},
  16 };
  17 use activitystreams::{
  18   activity::Follow,
  19   actor::{ApActor, Group, Person},
  20   base::AnyBase,
  21   object::{ApObject, Note, Page},
  22 };
  23 use activitystreams_ext::{Ext1, Ext2};
  24 use anyhow::{anyhow, Context};
  25 use diesel::NotFound;
  26 use lemmy_db_queries::{source::activity::Activity_, ApubObject, DbPool};
  27 use lemmy_db_schema::source::{
  28   activity::Activity,
  29   comment::Comment,
  30   community::Community,
  31   post::Post,
  32   private_message::PrivateMessage,
  33   user::User_,
  34 };
  35 use lemmy_structs::blocking;
  36 use lemmy_utils::{location_info, settings::Settings, LemmyError};
  37 use lemmy_websocket::LemmyContext;
  38 use serde::Serialize;
  39 use std::net::IpAddr;
  40 use url::{ParseError, Url};
  41
  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>;
  49
  50 pub static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
  51
  52 /// Checks if the ID is allowed for sending or receiving.
  53 ///
  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)
  59 ///
  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()?;
  65
  66   if !settings.federation.enabled {
  67     return if domain == local_instance {
  68       Ok(())
  69     } else {
  70       Err(
  71         anyhow!(
  72           "Trying to connect with {}, but federation is disabled",
  73           domain
  74         )
  75         .into(),
  76       )
  77     };
  78   }
  79
  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());
  84   }
  85
  86   if apub_id.scheme() != Settings::get().get_protocol_string() {
  87     return Err(anyhow!("invalid apub id scheme: {:?}", apub_id.scheme()).into());
  88   }
  89
  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() {
  93     Ok(())
  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);
  98
  99     if allowed_instances.contains(&domain) {
 100       Ok(())
 101     } else {
 102       Err(anyhow!("{} not in federation allowlist", domain).into())
 103     }
 104   } else if !blocked_instances.is_empty() {
 105     if blocked_instances.contains(&domain) {
 106       Err(anyhow!("{} is in federation blocklist", domain).into())
 107     } else {
 108       Ok(())
 109     }
 110   } else {
 111     panic!("Invalid config, both allowed_instances and blocked_instances are specified");
 112   }
 113 }
 114
 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(
 123     &self,
 124     creator: &User_,
 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>;
 129 }
 130
 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>;
 137 }
 138
 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 actor_id(&self) -> Url;
 144
 145   // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
 146   fn public_key(&self) -> Option<String>;
 147   fn private_key(&self) -> Option<String>;
 148
 149   async fn send_follow(
 150     &self,
 151     follow_actor_id: &Url,
 152     context: &LemmyContext,
 153   ) -> Result<(), LemmyError>;
 154   async fn send_unfollow(
 155     &self,
 156     follow_actor_id: &Url,
 157     context: &LemmyContext,
 158   ) -> Result<(), LemmyError>;
 159
 160   async fn send_accept_follow(
 161     &self,
 162     follow: Follow,
 163     context: &LemmyContext,
 164   ) -> Result<(), LemmyError>;
 165
 166   async fn send_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 167   async fn send_undo_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 168
 169   async fn send_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 170   async fn send_undo_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 171
 172   async fn send_announce(
 173     &self,
 174     activity: AnyBase,
 175     context: &LemmyContext,
 176   ) -> Result<(), LemmyError>;
 177
 178   /// For a given community, returns the inboxes of all followers.
 179   async fn get_follower_inboxes(&self, pool: &DbPool) -> Result<Vec<Url>, LemmyError>;
 180
 181   // TODO move these to the db rows
 182   fn get_inbox_url(&self) -> Result<Url, ParseError> {
 183     Url::parse(&format!("{}/inbox", &self.actor_id()))
 184   }
 185
 186   fn get_shared_inbox_url(&self) -> Result<Url, LemmyError> {
 187     let actor_id = self.actor_id();
 188     let url = format!(
 189       "{}://{}{}/inbox",
 190       &actor_id.scheme(),
 191       &actor_id.host_str().context(location_info!())?,
 192       if let Some(port) = actor_id.port() {
 193         format!(":{}", port)
 194       } else {
 195         "".to_string()
 196       },
 197     );
 198     Ok(Url::parse(&url)?)
 199   }
 200
 201   fn get_outbox_url(&self) -> Result<Url, ParseError> {
 202     Url::parse(&format!("{}/outbox", &self.actor_id()))
 203   }
 204
 205   fn get_followers_url(&self) -> Result<Url, ParseError> {
 206     Url::parse(&format!("{}/followers", &self.actor_id()))
 207   }
 208
 209   fn get_public_key_ext(&self) -> Result<PublicKeyExtension, LemmyError> {
 210     Ok(
 211       PublicKey {
 212         id: format!("{}#main-key", self.actor_id()),
 213         owner: self.actor_id(),
 214         public_key_pem: self.public_key().context(location_info!())?,
 215       }
 216       .to_ext(),
 217     )
 218   }
 219 }
 220
 221 /// Store a sent or received activity in the database, for logging purposes. These records are not
 222 /// persistent.
 223 pub(crate) async fn insert_activity<T>(
 224   ap_id: &Url,
 225   activity: T,
 226   local: bool,
 227   sensitive: bool,
 228   pool: &DbPool,
 229 ) -> Result<(), LemmyError>
 230 where
 231   T: Serialize + std::fmt::Debug + Send + 'static,
 232 {
 233   let ap_id = ap_id.to_string();
 234   blocking(pool, move |conn| {
 235     Activity::insert(conn, ap_id, &activity, local, sensitive)
 236   })
 237   .await??;
 238   Ok(())
 239 }
 240
 241 pub(crate) enum PostOrComment {
 242   Comment(Comment),
 243   Post(Post),
 244 }
 245
 246 /// Tries to find a post or comment in the local database, without any network requests.
 247 /// This is used to handle deletions and removals, because in case we dont have the object, we can
 248 /// simply ignore the activity.
 249 pub(crate) async fn find_post_or_comment_by_id(
 250   context: &LemmyContext,
 251   apub_id: Url,
 252 ) -> Result<PostOrComment, LemmyError> {
 253   let ap_id = apub_id.clone();
 254   let post = blocking(context.pool(), move |conn| {
 255     Post::read_from_apub_id(conn, &ap_id.into())
 256   })
 257   .await?;
 258   if let Ok(p) = post {
 259     return Ok(PostOrComment::Post(p));
 260   }
 261
 262   let ap_id = apub_id.clone();
 263   let comment = blocking(context.pool(), move |conn| {
 264     Comment::read_from_apub_id(conn, &ap_id.into())
 265   })
 266   .await?;
 267   if let Ok(c) = comment {
 268     return Ok(PostOrComment::Comment(c));
 269   }
 270
 271   Err(NotFound.into())
 272 }
 273
 274 pub(crate) enum Object {
 275   Comment(Comment),
 276   Post(Post),
 277   Community(Community),
 278   User(User_),
 279   PrivateMessage(PrivateMessage),
 280 }
 281
 282 pub(crate) async fn find_object_by_id(
 283   context: &LemmyContext,
 284   apub_id: Url,
 285 ) -> Result<Object, LemmyError> {
 286   let ap_id = apub_id.clone();
 287   if let Ok(pc) = find_post_or_comment_by_id(context, ap_id.to_owned()).await {
 288     return Ok(match pc {
 289       PostOrComment::Post(p) => Object::Post(p),
 290       PostOrComment::Comment(c) => Object::Comment(c),
 291     });
 292   }
 293
 294   let ap_id = apub_id.clone();
 295   let user = blocking(context.pool(), move |conn| {
 296     User_::read_from_apub_id(conn, &ap_id.into())
 297   })
 298   .await?;
 299   if let Ok(u) = user {
 300     return Ok(Object::User(u));
 301   }
 302
 303   let ap_id = apub_id.clone();
 304   let community = blocking(context.pool(), move |conn| {
 305     Community::read_from_apub_id(conn, &ap_id.into())
 306   })
 307   .await?;
 308   if let Ok(c) = community {
 309     return Ok(Object::Community(c));
 310   }
 311
 312   let private_message = blocking(context.pool(), move |conn| {
 313     PrivateMessage::read_from_apub_id(conn, &apub_id.into())
 314   })
 315   .await?;
 316   if let Ok(pm) = private_message {
 317     return Ok(Object::PrivateMessage(pm));
 318   }
 319
 320   Err(NotFound.into())
 321 }