federails 0.1.0 → 0.3.0

data/lib/fediverse/inbox.rb

@@ -2,34 +2,33 @@ require 'fediverse/request'
 
 module Fediverse
   class Inbox
+    @@handlers = {} # rubocop:todo Style/ClassVars
     class << self
+      def register_handler(activity_type, object_type, klass, method)
+        @@handlers[activity_type] ||= {}
+        @@handlers[activity_type][object_type] ||= {}
+        @@handlers[activity_type][object_type][klass] = method
+      end
+
       def dispatch_request(payload)
-        case payload['type']
-        when 'Create'
-          handle_create_request payload
-        when 'Follow'
-          handle_create_follow_request payload
-        when 'Accept'
-          handle_accept_request payload
-        when 'Undo'
-          handle_undo_request payload
-        else
-          # FIXME: Fails silently
-          # raise NotImplementedError
-          Rails.logger.debug { "Unhandled activity type: #{payload['type']}" }
+        handlers = get_handlers(payload['type'], payload['object'].is_a?(Hash) ? payload.dig('object', 'type') : nil)
+        handlers.each_pair do |klass, method|
+          klass.send method, payload
         end
+        return unless handlers.empty?
+
+        # FIXME: Fails silently
+        # raise NotImplementedError
+        Rails.logger.debug { "Unhandled activity type: #{payload['type']}" }
       end
 
       private
 
-      def handle_create_request(payload)
-        activity = Request.get(payload['object'])
-        case activity['type']
-        when 'Follow'
-          handle_create_follow_request activity
-        when 'Note'
-          handle_create_note activity
-        end
+      def get_handlers(activity_type, object_type)
+        {}.merge(@@handlers.dig(activity_type, object_type) || {})
+          .merge(@@handlers.dig(activity_type, '*') || {})
+          .merge(@@handlers.dig('*', '*') || {})
+          .merge(@@handlers.dig('*', object_type) || {})
       end
 
       def handle_create_follow_request(activity)
@@ -39,33 +38,30 @@ module Fediverse
         Federails::Following.create! actor: actor, target_actor: target_actor, federated_url: activity['id']
       end
 
-      def handle_create_note(activity)
-        actor = Federails::Actor.find_or_create_by_object activity['attributedTo']
-        Note.create! actor: actor, content: activity['content'], federated_url: activity['id']
-      end
+      def handle_accept_request(activity)
+        original_activity = Request.get(activity['object'])
 
-      def handle_accept_request(payload)
-        activity = Request.get(payload['object'])
-        raise "Can't accept things that are not Follow" unless activity['type'] == 'Follow'
-
-        actor        = Federails::Actor.find_or_create_by_object activity['actor']
-        target_actor = Federails::Actor.find_or_create_by_object activity['object']
-        raise 'Follow not accepted by target actor but by someone else' if payload['actor'] != target_actor.federated_url
+        actor        = Federails::Actor.find_or_create_by_object original_activity['actor']
+        target_actor = Federails::Actor.find_or_create_by_object original_activity['object']
+        raise 'Follow not accepted by target actor but by someone else' if activity['actor'] != target_actor.federated_url
 
         follow = Federails::Following.find_by actor: actor, target_actor: target_actor
         follow.accept!
       end
 
-      def handle_undo_request(payload)
-        activity = payload['object']
-        raise "Can't undo things that are not Follow" unless activity['type'] == 'Follow'
+      def handle_undo_request(activity)
+        original_activity = activity['object']
 
-        actor        = Federails::Actor.find_or_create_by_object activity['actor']
-        target_actor = Federails::Actor.find_or_create_by_object activity['object']
+        actor        = Federails::Actor.find_or_create_by_object original_activity['actor']
+        target_actor = Federails::Actor.find_or_create_by_object original_activity['object']
 
         follow = Federails::Following.find_by actor: actor, target_actor: target_actor
         follow&.destroy
       end
     end
+
+    register_handler 'Follow', '*', self, :handle_create_follow_request
+    register_handler 'Accept', 'Follow', self, :handle_accept_request
+    register_handler 'Undo', 'Follow', self, :handle_undo_request
   end
 end

data/lib/fediverse/notifier.rb

@@ -1,21 +1,60 @@
+require 'fediverse/signature'
+
 module Fediverse
   class Notifier
     class << self
       def post_to_inboxes(activity)
         actors = activity.recipients
-
         Rails.logger.debug('Nobody to notice') && return if actors.count.zero?
 
-        message = Federails::ApplicationController.renderer.new.render(
+        message = payload(activity)
+        actors.each do |recipient|
+          Rails.logger.debug { "Sending activity ##{activity.id} to #{recipient.inbox_url}" }
+          post_to_inbox(to: recipient, message: message, from: activity.actor)
+        end
+      end
+
+      private
+
+      def payload(activity)
+        Federails::ServerController.renderer.new.render(
           template: 'federails/server/activities/show',
           assigns:  { activity: activity },
           format:   :json
         )
-        actors.each do |actor|
-          Rails.logger.debug { "Sending activity ##{activity.id} to #{actor.inbox_url}" }
-          Faraday.post actor.inbox_url, message, 'Content-Type' => 'application/json', 'Accept' => 'application/json'
+      end
+
+      def post_to_inbox(to:, message:, from: nil)
+        conn = Faraday.default_connection
+        conn.builder.build_response(
+          conn,
+          signed_request(to: to, message: message, from: from)
+        )
+      end
+
+      def signed_request(to:, message:, from:)
+        req = request(to: to, message: message)
+        req.headers['Signature'] = Fediverse::Signature.sign(sender: from, request: req) if from
+        req
+      end
+
+      def request(to:, message:) # rubocop:todo Metrics/AbcSize
+        Faraday.default_connection.build_request(:post) do |req|
+          req.url to.inbox_url
+          req.body = message
+          req.headers['Content-Type'] = Mime[:activitypub].to_s
+          req.headers['Accept'] = Mime[:activitypub].to_s
+          req.headers['Host'] = URI.parse(to.inbox_url).host
+          req.headers['Date'] = Time.now.utc.httpdate
+          req.headers['Digest'] = digest(message)
         end
       end
+
+      def digest(message)
+        "SHA-256=#{Base64.strict_encode64(
+          OpenSSL::Digest.new('SHA256').digest(message)
+        )}"
+      end
     end
   end
 end

data/lib/fediverse/signature.rb

@@ -0,0 +1,49 @@
+module Fediverse
+  class Signature
+    class << self
+      def sign(sender:, request:)
+        private_key = OpenSSL::PKey::RSA.new sender.private_key, Rails.application.credentials.secret_key_base
+        headers = '(request-target) host date digest'
+        sig = Base64.strict_encode64(
+          private_key.sign(
+            OpenSSL::Digest.new('SHA256'), signature_payload(request: request, headers: headers)
+          )
+        )
+        {
+          keyId:     sender.key_id,
+          headers:   headers,
+          signature: sig,
+        }.map { |k, v| "#{k}=\"#{v}\"" }.join(',')
+      end
+
+      def verify(sender:, request:)
+        raise 'Unsigned headers' unless request.headers['Signature']
+
+        signature_header = request.headers['Signature'].split(',').to_h do |pair|
+          /\A(?<key>[\w]+)="(?<value>.*)"\z/ =~ pair
+          [key, value]
+        end
+
+        headers   = signature_header['headers']
+        signature = Base64.decode64(signature_header['signature'])
+        key       = OpenSSL::PKey::RSA.new(sender.public_key)
+
+        comparison_string = signature_payload(request: request, headers: headers)
+
+        key.verify(OpenSSL::Digest.new('SHA256'), signature, comparison_string)
+      end
+
+      private
+
+      def signature_payload(request:, headers:)
+        headers.split.map do |signed_header_name|
+          if signed_header_name == '(request-target)'
+            "(request-target): #{request.http_method} #{URI.parse(request.path).path}"
+          else
+            "#{signed_header_name}: #{request.headers[signed_header_name.capitalize]}"
+          end
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/fediverse/webfinger.rb

@@ -30,28 +30,52 @@ module Fediverse
 
       # Returns actor id
       def webfinger(username, domain)
-        scheme = Federails.configuration.force_ssl ? 'https' : 'http'
-        json = get_json "#{scheme}://#{domain}/.well-known/webfinger", resource: "acct:#{username}@#{domain}"
+        json = webfinger_response(username, domain)
         link = json['links'].find { |l| l['type'] == 'application/activity+json' }
 
         link['href'] if link
       end
 
+      # Returns remote follow link template, or complete link if actor_url is provided
+      def remote_follow_url(username, domain, actor_url: nil)
+        json = webfinger_response(username, domain)
+        link = json['links'].find { |l| l['rel'] == 'http://ostatus.org/schema/1.0/subscribe' }
+        return nil if link&.dig('template').nil?
+
+        if actor_url
+          link['template'].gsub('{uri}', CGI.escape(actor_url))
+        else
+          link['template']
+        end
+      end
+
       private
 
+      def webfinger_response(username, domain)
+        scheme = Federails.configuration.force_ssl ? 'https' : 'http'
+        get_json "#{scheme}://#{domain}/.well-known/webfinger", resource: "acct:#{username}@#{domain}"
+      end
+
+      def server_and_port(id)
+        uri = URI.parse id
+        if uri.port && [80, 443].exclude?(uri.port)
+          "#{uri.host}:#{uri.port}"
+        else
+          uri.host
+        end
+      end
+
       def webfinger_to_actor(data)
-        uri    = URI.parse data['id']
-        server = uri.host
-        server += ":#{uri.port}" if uri.port && [80, 443].exclude?(uri.port)
         Federails::Actor.new federated_url:  data['id'],
                              username:       data['preferredUsername'],
                              name:           data['name'],
-                             server:         server,
+                             server:         server_and_port(data['id']),
                              inbox_url:      data['inbox'],
                              outbox_url:     data['outbox'],
                              followers_url:  data['followers'],
                              followings_url: data['following'],
-                             profile_url:    data['url']
+                             profile_url:    data['url'],
+                             public_key:     data.dig('publicKey', 'publicKeyPem')
       end
 
       def get_json(url, payload = {})

data/lib/generators/federails/copy_client_views/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies the client views to be overridden in main application
+
+Example:
+    bin/rails generate copy_client_views
+
+    This will create:
+        app/views/federails/client/**/*

data/lib/generators/federails/copy_client_views/copy_client_views_generator.rb

@@ -0,0 +1,9 @@
+module Federails
+  class CopyClientViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../app/views', __dir__)
+
+    def copy_views
+      directory 'federails/client', Rails.root.join('app', 'views', 'federails', 'client')
+    end
+  end
+end

data/lib/generators/federails/install/install_generator.rb

@@ -3,8 +3,8 @@ module Federails
     source_root File.expand_path('templates', __dir__)
 
     def copy_files
-      copy_file 'federails.yml', 'config/federails.yml'
-      copy_file 'federails.rb', 'config/initializers/federails.rb'
+      copy_file 'federails.yml', Rails.root.join('config', 'federails.yml')
+      copy_file 'federails.rb', Rails.root.join('config', 'initializers', 'federails.rb')
     end
   end
 end

data/lib/generators/federails/install/templates/federails.yml

@@ -6,9 +6,11 @@ defaults: &defaults
   site_host: http://localhost
   site_port: 3000
   enable_discovery: true
+  open_registrations: false
   app_layout: 'layouts/application'
   server_routes_path: federation
   client_routes_path: app
+  #base_client_controller: ::ActionController::Base
 
 development:
   <<: *defaults

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: federails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,21 +119,22 @@ files:
 - Rakefile
 - app/assets/config/federails_manifest.js
 - app/assets/stylesheets/federails/application.css
-- app/controllers/federails/application_controller.rb
 - app/controllers/federails/client/activities_controller.rb
 - app/controllers/federails/client/actors_controller.rb
 - app/controllers/federails/client/followings_controller.rb
+- app/controllers/federails/client_controller.rb
 - app/controllers/federails/server/activities_controller.rb
 - app/controllers/federails/server/actors_controller.rb
 - app/controllers/federails/server/followings_controller.rb
 - app/controllers/federails/server/nodeinfo_controller.rb
-- app/controllers/federails/server/server_controller.rb
 - app/controllers/federails/server/web_finger_controller.rb
-- app/helpers/federails/application_helper.rb
+- app/controllers/federails/server_controller.rb
+- app/helpers/federails/server_helper.rb
 - app/jobs/federails/application_job.rb
 - app/jobs/federails/notify_inbox_job.rb
 - app/mailers/federails/application_mailer.rb
 - app/models/concerns/federails/entity.rb
+- app/models/concerns/federails/has_uuid.rb
 - app/models/federails/activity.rb
 - app/models/federails/actor.rb
 - app/models/federails/application_record.rb
@@ -158,7 +159,9 @@ files:
 - app/views/federails/client/actors/index.json.jbuilder
 - app/views/federails/client/actors/show.html.erb
 - app/views/federails/client/actors/show.json.jbuilder
+- app/views/federails/client/common/_client_links.html.erb
 - app/views/federails/client/followings/_follow.html.erb
+- app/views/federails/client/followings/_follow_actions.html.erb
 - app/views/federails/client/followings/_follower.html.erb
 - app/views/federails/client/followings/_following.json.jbuilder
 - app/views/federails/client/followings/_form.html.erb
@@ -166,24 +169,26 @@ files:
 - app/views/federails/client/followings/index.json.jbuilder
 - app/views/federails/client/followings/show.html.erb
 - app/views/federails/client/followings/show.json.jbuilder
-- app/views/federails/server/activities/_activity.json.jbuilder
-- app/views/federails/server/activities/outbox.json.jbuilder
-- app/views/federails/server/activities/show.json.jbuilder
-- app/views/federails/server/actors/_actor.json.jbuilder
-- app/views/federails/server/actors/followers.json.jbuilder
-- app/views/federails/server/actors/following.json.jbuilder
-- app/views/federails/server/actors/show.json.jbuilder
-- app/views/federails/server/followings/_following.json.jbuilder
-- app/views/federails/server/followings/show.json.jbuilder
-- app/views/federails/server/nodeinfo/index.json.jbuilder
-- app/views/federails/server/nodeinfo/show.json.jbuilder
-- app/views/federails/server/web_finger/find.json.jbuilder
-- app/views/federails/server/web_finger/host_meta.xml.erb
+- app/views/federails/server/activities/_activity.activitypub.jbuilder
+- app/views/federails/server/activities/outbox.activitypub.jbuilder
+- app/views/federails/server/activities/show.activitypub.jbuilder
+- app/views/federails/server/actors/_actor.activitypub.jbuilder
+- app/views/federails/server/actors/followers.activitypub.jbuilder
+- app/views/federails/server/actors/following.activitypub.jbuilder
+- app/views/federails/server/actors/show.activitypub.jbuilder
+- app/views/federails/server/followings/_following.activitypub.jbuilder
+- app/views/federails/server/followings/show.activitypub.jbuilder
+- app/views/federails/server/nodeinfo/index.nodeinfo.jbuilder
+- app/views/federails/server/nodeinfo/show.nodeinfo.jbuilder
+- app/views/federails/server/web_finger/find.jrd.jbuilder
+- app/views/federails/server/web_finger/host_meta.xrd.erb
+- config/initializers/mime_types.rb
 - config/routes.rb
 - db/migrate/20200712133150_create_federails_actors.rb
 - db/migrate/20200712143127_create_federails_followings.rb
 - db/migrate/20200712174938_create_federails_activities.rb
-- db/migrate/20240731145400_change_actor_entity_rel_to_polymorphic.rb
+- db/migrate/20241002094500_add_uuids.rb
+- db/migrate/20241002094501_add_keypair_to_actors.rb
 - lib/federails.rb
 - lib/federails/configuration.rb
 - lib/federails/engine.rb
@@ -192,7 +197,10 @@ files:
 - lib/fediverse/inbox.rb
 - lib/fediverse/notifier.rb
 - lib/fediverse/request.rb
+- lib/fediverse/signature.rb
 - lib/fediverse/webfinger.rb
+- lib/generators/federails/copy_client_views/USAGE
+- lib/generators/federails/copy_client_views/copy_client_views_generator.rb
 - lib/generators/federails/install/USAGE
 - lib/generators/federails/install/install_generator.rb
 - lib/generators/federails/install/templates/federails.rb
@@ -222,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: An ActivityPub engine for Ruby on Rails

data/app/controllers/federails/server/server_controller.rb

@@ -1,17 +0,0 @@
-module Federails
-  module Server
-    class ServerController < Federails::ApplicationController
-      protect_from_forgery with: :null_session
-
-      # def policy_scope(scope, policy_scope_class: nil)
-      #   scope = [scope, :server] unless policy_scope_class
-      #   super(scope, policy_scope_class: policy_scope_class)
-      # end
-
-      # def authorize(record, query = nil, policy_class: nil)
-      #   record = [:server, record] unless policy_class
-      #   super(record, query, policy_class: policy_class)
-      # end
-    end
-  end
-end

data/app/helpers/federails/application_helper.rb

@@ -1,4 +0,0 @@
-module Federails
-  module ApplicationHelper
-  end
-end

data/app/views/federails/server/actors/_actor.json.jbuilder

@@ -1,11 +0,0 @@
-json.set! '@context', 'https://www.w3.org/ns/activitystreams'
-
-json.id actor.federated_url
-json.name actor.name
-json.type actor.entity_configuration[:actor_type]
-json.preferredUsername actor.username
-json.inbox actor.inbox_url
-json.outbox actor.outbox_url
-json.followers actor.followers_url
-json.following actor.followings_url
-json.url actor.profile_url

data/db/migrate/20240731145400_change_actor_entity_rel_to_polymorphic.rb

@@ -1,11 +0,0 @@
-class ChangeActorEntityRelToPolymorphic < ActiveRecord::Migration[7.0]
-  def change
-    remove_foreign_key :federails_actors, column: :user_id, to_table: Federails::Configuration.user_table
-    remove_index :federails_actors, :user_id, unique: true
-    change_table :federails_actors do |t|
-      t.rename :user_id, :entity_id
-      t.string :entity_type, null: true, default: Federails::Configuration.user_class&.demodulize
-      t.index [:entity_type, :entity_id], name: 'index_federails_actors_on_entity', unique: true
-    end
-  end
-end