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 pub mod routes;
  12
  13 use crate::extensions::{
  14   group_extensions::GroupExtension,
  15   page_extension::PageExtension,
  16   signatures::{PublicKey, PublicKeyExtension},
  17 };
  18 use activitystreams::{
  19   activity::Follow,
  20   actor::{ApActor, Group, Person},
  21   base::AnyBase,
  22   object::{ApObject, Note, Page},
  23 };
  24 use activitystreams_ext::{Ext1, Ext2};
  25 use anyhow::{anyhow, Context};
  26 use diesel::NotFound;
  27 use lemmy_api_structs::blocking;
  28 use lemmy_db_queries::{source::activity::Activity_, ApubObject, DbPool};
  29 use lemmy_db_schema::{
  30   source::{
  31     activity::Activity,
  32     comment::Comment,
  33     community::Community,
  34     post::Post,
  35     private_message::PrivateMessage,
  36     user::User_,
  37   },
  38   DbUrl,
  39 };
  40 use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
  41 use lemmy_websocket::LemmyContext;
  42 use serde::Serialize;
  43 use std::net::IpAddr;
  44 use url::{ParseError, Url};
  45
  46 /// Activitystreams type for community
  47 type GroupExt = Ext2<ApActor<ApObject<Group>>, GroupExtension, PublicKeyExtension>;
  48 /// Activitystreams type for user
  49 type PersonExt = Ext1<ApActor<ApObject<Person>>, PublicKeyExtension>;
  50 /// Activitystreams type for post
  51 type PageExt = Ext1<ApObject<Page>, PageExtension>;
  52 type NoteExt = ApObject<Note>;
  53
  54 pub static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
  55
  56 /// Checks if the ID is allowed for sending or receiving.
  57 ///
  58 /// In particular, it checks for:
  59 /// - federation being enabled (if its disabled, only local URLs are allowed)
  60 /// - the correct scheme (either http or https)
  61 /// - URL being in the allowlist (if it is active)
  62 /// - URL not being in the blocklist (if it is active)
  63 ///
  64 /// Note that only one of allowlist and blacklist can be enabled, not both.
  65 fn check_is_apub_id_valid(apub_id: &Url) -> Result<(), LemmyError> {
  66   let settings = Settings::get();
  67   let domain = apub_id.domain().context(location_info!())?.to_string();
  68   let local_instance = settings.get_hostname_without_port()?;
  69
  70   if !settings.federation().enabled {
  71     return if domain == local_instance {
  72       Ok(())
  73     } else {
  74       Err(
  75         anyhow!(
  76           "Trying to connect with {}, but federation is disabled",
  77           domain
  78         )
  79         .into(),
  80       )
  81     };
  82   }
  83
  84   let host = apub_id.host_str().context(location_info!())?;
  85   let host_as_ip = host.parse::<IpAddr>();
  86   if host == "localhost" || host_as_ip.is_ok() {
  87     return Err(anyhow!("invalid hostname {}: {}", host, apub_id).into());
  88   }
  89
  90   if apub_id.scheme() != Settings::get().get_protocol_string() {
  91     return Err(anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id).into());
  92   }
  93
  94   let allowed_instances = Settings::get().get_allowed_instances();
  95   let blocked_instances = Settings::get().get_blocked_instances();
  96
  97   if allowed_instances.is_none() && blocked_instances.is_none() {
  98     Ok(())
  99   } else if let Some(mut allowed) = allowed_instances {
 100     // need to allow this explicitly because apub receive might contain objects from our local
 101     // instance. split is needed to remove the port in our federation test setup.
 102     allowed.push(local_instance);
 103
 104     if allowed.contains(&domain) {
 105       Ok(())
 106     } else {
 107       Err(anyhow!("{} not in federation allowlist", domain).into())
 108     }
 109   } else if let Some(blocked) = blocked_instances {
 110     if blocked.contains(&domain) {
 111       Err(anyhow!("{} is in federation blocklist", domain).into())
 112     } else {
 113       Ok(())
 114     }
 115   } else {
 116     panic!("Invalid config, both allowed_instances and blocked_instances are specified");
 117   }
 118 }
 119
 120 /// Common functions for ActivityPub objects, which are implemented by most (but not all) objects
 121 /// and actors in Lemmy.
 122 #[async_trait::async_trait(?Send)]
 123 pub trait ApubObjectType {
 124   async fn send_create(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 125   async fn send_update(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 126   async fn send_delete(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 127   async fn send_undo_delete(
 128     &self,
 129     creator: &User_,
 130     context: &LemmyContext,
 131   ) -> Result<(), LemmyError>;
 132   async fn send_remove(&self, mod_: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 133   async fn send_undo_remove(&self, mod_: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 134 }
 135
 136 #[async_trait::async_trait(?Send)]
 137 pub trait ApubLikeableType {
 138   async fn send_like(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 139   async fn send_dislike(&self, creator: &User_, context: &LemmyContext) -> Result<(), LemmyError>;
 140   async fn send_undo_like(&self, creator: &User_, context: &LemmyContext)
 141     -> Result<(), LemmyError>;
 142 }
 143
 144 /// Common methods provided by ActivityPub actors (community and user). Not all methods are
 145 /// implemented by all actors.
 146 #[async_trait::async_trait(?Send)]
 147 pub trait ActorType {
 148   fn is_local(&self) -> bool;
 149   fn actor_id(&self) -> Url;
 150
 151   // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
 152   fn public_key(&self) -> Option<String>;
 153   fn private_key(&self) -> Option<String>;
 154
 155   async fn send_follow(
 156     &self,
 157     follow_actor_id: &Url,
 158     context: &LemmyContext,
 159   ) -> Result<(), LemmyError>;
 160   async fn send_unfollow(
 161     &self,
 162     follow_actor_id: &Url,
 163     context: &LemmyContext,
 164   ) -> Result<(), LemmyError>;
 165
 166   async fn send_accept_follow(
 167     &self,
 168     follow: Follow,
 169     context: &LemmyContext,
 170   ) -> Result<(), LemmyError>;
 171
 172   async fn send_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 173   async fn send_undo_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 174
 175   async fn send_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 176   async fn send_undo_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
 177
 178   async fn send_announce(
 179     &self,
 180     activity: AnyBase,
 181     context: &LemmyContext,
 182   ) -> Result<(), LemmyError>;
 183
 184   /// For a given community, returns the inboxes of all followers.
 185   async fn get_follower_inboxes(&self, pool: &DbPool) -> Result<Vec<Url>, LemmyError>;
 186
 187   fn get_shared_inbox_or_inbox_url(&self) -> Url;
 188
 189   /// Outbox URL is not generally used by Lemmy, so it can be generated on the fly (but only for
 190   /// local actors).
 191   fn get_outbox_url(&self) -> Result<Url, LemmyError> {
 192     if !self.is_local() {
 193       return Err(anyhow!("get_outbox_url() called for remote actor").into());
 194     }
 195     Ok(Url::parse(&format!("{}/outbox", &self.actor_id()))?)
 196   }
 197
 198   fn get_public_key_ext(&self) -> Result<PublicKeyExtension, LemmyError> {
 199     Ok(
 200       PublicKey {
 201         id: format!("{}#main-key", self.actor_id()),
 202         owner: self.actor_id(),
 203         public_key_pem: self.public_key().context(location_info!())?,
 204       }
 205       .to_ext(),
 206     )
 207   }
 208 }
 209
 210 pub enum EndpointType {
 211   Community,
 212   User,
 213   Post,
 214   Comment,
 215   PrivateMessage,
 216 }
 217
 218 /// Generates the ActivityPub ID for a given object type and ID.
 219 pub fn generate_apub_endpoint(
 220   endpoint_type: EndpointType,
 221   name: &str,
 222 ) -> Result<DbUrl, ParseError> {
 223   let point = match endpoint_type {
 224     EndpointType::Community => "c",
 225     EndpointType::User => "u",
 226     EndpointType::Post => "post",
 227     EndpointType::Comment => "comment",
 228     EndpointType::PrivateMessage => "private_message",
 229   };
 230
 231   Ok(
 232     Url::parse(&format!(
 233       "{}/{}/{}",
 234       Settings::get().get_protocol_and_hostname(),
 235       point,
 236       name
 237     ))?
 238     .into(),
 239   )
 240 }
 241
 242 pub fn generate_followers_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
 243   Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
 244 }
 245
 246 pub fn generate_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
 247   Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
 248 }
 249
 250 pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError> {
 251   let actor_id = actor_id.clone().into_inner();
 252   let url = format!(
 253     "{}://{}{}/inbox",
 254     &actor_id.scheme(),
 255     &actor_id.host_str().context(location_info!())?,
 256     if let Some(port) = actor_id.port() {
 257       format!(":{}", port)
 258     } else {
 259       "".to_string()
 260     },
 261   );
 262   Ok(Url::parse(&url)?.into())
 263 }
 264
 265 pub(crate) fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
 266   Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
 267 }
 268
 269 /// Store a sent or received activity in the database, for logging purposes. These records are not
 270 /// persistent.
 271 pub(crate) async fn insert_activity<T>(
 272   ap_id: &Url,
 273   activity: T,
 274   local: bool,
 275   sensitive: bool,
 276   pool: &DbPool,
 277 ) -> Result<(), LemmyError>
 278 where
 279   T: Serialize + std::fmt::Debug + Send + 'static,
 280 {
 281   let ap_id = ap_id.to_owned().into();
 282   blocking(pool, move |conn| {
 283     Activity::insert(conn, ap_id, &activity, local, sensitive)
 284   })
 285   .await??;
 286   Ok(())
 287 }
 288
 289 pub(crate) enum PostOrComment {
 290   Comment(Box<Comment>),
 291   Post(Box<Post>),
 292 }
 293
 294 /// Tries to find a post or comment in the local database, without any network requests.
 295 /// This is used to handle deletions and removals, because in case we dont have the object, we can
 296 /// simply ignore the activity.
 297 pub(crate) async fn find_post_or_comment_by_id(
 298   context: &LemmyContext,
 299   apub_id: Url,
 300 ) -> Result<PostOrComment, LemmyError> {
 301   let ap_id = apub_id.clone();
 302   let post = blocking(context.pool(), move |conn| {
 303     Post::read_from_apub_id(conn, &ap_id.into())
 304   })
 305   .await?;
 306   if let Ok(p) = post {
 307     return Ok(PostOrComment::Post(Box::new(p)));
 308   }
 309
 310   let ap_id = apub_id.clone();
 311   let comment = blocking(context.pool(), move |conn| {
 312     Comment::read_from_apub_id(conn, &ap_id.into())
 313   })
 314   .await?;
 315   if let Ok(c) = comment {
 316     return Ok(PostOrComment::Comment(Box::new(c)));
 317   }
 318
 319   Err(NotFound.into())
 320 }
 321
 322 pub(crate) enum Object {
 323   Comment(Comment),
 324   Post(Post),
 325   Community(Community),
 326   User(User_),
 327   PrivateMessage(PrivateMessage),
 328 }
 329
 330 pub(crate) async fn find_object_by_id(
 331   context: &LemmyContext,
 332   apub_id: Url,
 333 ) -> Result<Object, LemmyError> {
 334   let ap_id = apub_id.clone();
 335   if let Ok(pc) = find_post_or_comment_by_id(context, ap_id.to_owned()).await {
 336     return Ok(match pc {
 337       PostOrComment::Post(p) => Object::Post(*p),
 338       PostOrComment::Comment(c) => Object::Comment(*c),
 339     });
 340   }
 341
 342   let ap_id = apub_id.clone();
 343   let user = blocking(context.pool(), move |conn| {
 344     User_::read_from_apub_id(conn, &ap_id.into())
 345   })
 346   .await?;
 347   if let Ok(u) = user {
 348     return Ok(Object::User(u));
 349   }
 350
 351   let ap_id = apub_id.clone();
 352   let community = blocking(context.pool(), move |conn| {
 353     Community::read_from_apub_id(conn, &ap_id.into())
 354   })
 355   .await?;
 356   if let Ok(c) = community {
 357     return Ok(Object::Community(c));
 358   }
 359
 360   let private_message = blocking(context.pool(), move |conn| {
 361     PrivateMessage::read_from_apub_id(conn, &apub_id.into())
 362   })
 363   .await?;
 364   if let Ok(pm) = private_message {
 365     return Ok(Object::PrivateMessage(pm));
 366   }
 367
 368   Err(NotFound.into())
 369 }