diaspora_federation 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1cc502235f056676364d5b56b814650f284c8e5
-  data.tar.gz: 2b031425ffe4b1b5d83ac789ee674dc0f31f423a
+  metadata.gz: 704840223f25af1abc3fa00ed7d0cc931d45665e
+  data.tar.gz: cf78859d34900183ca8c5ee07ab7a24357239369
 SHA512:
-  metadata.gz: 0f4691907170170b696306f6c65cfc2855e9b95b166850f1c72c5f96fdbe6657c0cf31cb6b8ab3cf55369da424103388d0e24be445e34cf61daaa1b2ad1a187a
-  data.tar.gz: 12e1dde41d27bd0ee229a2befd99a6d6329bd7aca49f822e3d29c0a79e6135892238672321cdf1ad64813b78e441552fc318733729415f32c1f0983b42c4a4b8
+  metadata.gz: 632e343a34a267c990681ce3f34ab39cdf47f8807cb7f3ec56fd98b49e9bb801f9dd0b9c8c018f0e8bc86356ddb37a320858a2741be19bb79e6498cab1627cda
+  data.tar.gz: 4c7c62f615b3caeae02bde51718136c5be9696cdd768257db25d563bb7c9323a01081d778fc87f262ff90adbc31c06c64a364bb95172a66c273229c284058d08

data/lib/diaspora_federation.rb

@@ -12,6 +12,7 @@ require "diaspora_federation/entities"
 
 require "diaspora_federation/discovery"
 require "diaspora_federation/salmon"
+require "diaspora_federation/receiver"
 
 # diaspora* federation library
 module DiasporaFederation
@@ -27,6 +28,9 @@ module DiasporaFederation
     fetch_author_public_key_by_entity_guid
     entity_author_is_local?
     fetch_entity_author_id_by_guid
+    queue_public_receive
+    queue_private_receive
+    save_entity_after_receive
   )
 
   class << self
@@ -121,6 +125,20 @@ module DiasporaFederation
     #   @param [String] guid of the entity
     #   @return [String] Diaspora ID of the person
     #
+    # queue_public_receive
+    #   Queue a public salmon xml to process in background
+    #   @param [String] xml salmon xml
+    #
+    # queue_private_receive
+    #   Queue a private salmon xml to process in background
+    #   @param [String] guid guid of the receiver person
+    #   @param [String] xml salmon xml
+    #   @return [Boolean] true if successful, false if the user was not found
+    #
+    # save_entity_after_receive
+    #   After the xml was parsed and processed the gem calls this callback to persist the entity
+    #   @param [DiasporaFederation::Entity] entity the received entity after processing
+    #
     # @see Callbacks#on
     #
     # @example

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -75,6 +75,10 @@ module DiasporaFederation
       #     Panzer draft for Salmon, paragraph 3.3
       property :salmon_url
 
+      # @!attribute [r] subscribe_url
+      #   This url is used to find another user on the home-pod of the user in the webfinger.
+      property :subscribe_url
+
       # @!attribute [r] guid
       #   @deprecated Either convert these to +Property+ elements or move to the
       #     +hCard+, which actually has fields for an +UID+ defined in the +vCard+
@@ -121,6 +125,9 @@ module DiasporaFederation
       # +salmon_url+ link relation
       REL_SALMON = "salmon"
 
+      # +subscribe_url+ link relation
+      REL_SUBSCRIBE = "http://ostatus.org/schema/1.0/subscribe"
+
       # @deprecated This should be a +Property+ or moved to the +hcard+, but +Link+
       #   is inappropriate according to the specification (will affect older
       #   Diaspora* installations).
@@ -152,17 +159,19 @@ module DiasporaFederation
         public_key = parse_link(links, REL_PUBKEY)
 
         new(
-          acct_uri:    data[:subject],
-          alias_url:   parse_alias(data[:aliases]),
-          hcard_url:   parse_link(links, REL_HCARD),
-          seed_url:    parse_link(links, REL_SEED),
-          profile_url: parse_link(links, REL_PROFILE),
-          atom_url:    parse_link(links, REL_ATOM),
-          salmon_url:  parse_link(links, REL_SALMON),
+          acct_uri:      data[:subject],
+          alias_url:     parse_alias(data[:aliases]),
+          hcard_url:     parse_link(links, REL_HCARD),
+          seed_url:      parse_link(links, REL_SEED),
+          profile_url:   parse_link(links, REL_PROFILE),
+          atom_url:      parse_link(links, REL_ATOM),
+          salmon_url:    parse_link(links, REL_SALMON),
+
+          subscribe_url: parse_link_template(links, REL_SUBSCRIBE),
 
           # TODO: remove me!  ##########
-          guid:        parse_link(links, REL_GUID),
-          public_key:  (Base64.strict_decode64(public_key) if public_key)
+          guid:          parse_link(links, REL_GUID),
+          public_key:    (Base64.strict_decode64(public_key) if public_key)
         )
       end
 
@@ -182,27 +191,18 @@ module DiasporaFederation
       private_class_method :parse_xml_and_validate
 
       def add_links_to(doc)
-        doc.links << {rel:  REL_HCARD,
-                      type: "text/html",
-                      href: @hcard_url}
-        doc.links << {rel:  REL_SEED,
-                      type: "text/html",
-                      href: @seed_url}
+        doc.links << {rel: REL_HCARD, type: "text/html", href: @hcard_url}
+        doc.links << {rel: REL_SEED, type: "text/html", href: @seed_url}
 
         # TODO: remove me!  ##############
-        doc.links << {rel:  REL_GUID,
-                      type: "text/html",
-                      href: @guid}
+        doc.links << {rel: REL_GUID, type: "text/html", href: @guid}
         ##################################
 
-        doc.links << {rel:  REL_PROFILE,
-                      type: "text/html",
-                      href: @profile_url}
-        doc.links << {rel:  REL_ATOM,
-                      type: "application/atom+xml",
-                      href: @atom_url}
-        doc.links << {rel:  REL_SALMON,
-                      href: @salmon_url}
+        doc.links << {rel: REL_PROFILE, type: "text/html", href: @profile_url}
+        doc.links << {rel: REL_ATOM, type: "application/atom+xml", href: @atom_url}
+        doc.links << {rel: REL_SALMON, href: @salmon_url}
+
+        doc.links << {rel: REL_SUBSCRIBE, template: @subscribe_url}
 
         # TODO: remove me!  ##############
         doc.links << {rel:  REL_PUBKEY,
@@ -211,12 +211,23 @@ module DiasporaFederation
         ##################################
       end
 
+      def self.find_link(links, rel)
+        links.find {|l| l[:rel] == rel }
+      end
+      private_class_method :find_link
+
       def self.parse_link(links, rel)
-        element = links.find {|l| l[:rel] == rel }
+        element = find_link(links, rel)
         element ? element[:href] : nil
       end
       private_class_method :parse_link
 
+      def self.parse_link_template(links, rel)
+        element = find_link(links, rel)
+        element ? element[:template] : nil
+      end
+      private_class_method :parse_link_template
+
       # this method is used to parse the alias_url from the XML.
       # * redmatrix has sometimes no alias, return nil
       # * old pods had quotes around the alias url, this can be removed later

data/lib/diaspora_federation/entities/message.rb

@@ -33,6 +33,10 @@ module DiasporaFederation
       #   @see Conversation#guid
       #   @return [String] conversation guid
       property :conversation_guid
+
+      def self.get_target_entity_type(*)
+        "Conversation"
+      end
     end
   end
 end

data/lib/diaspora_federation/entities/poll_participation.rb

@@ -23,6 +23,10 @@ module DiasporaFederation
       #   @see PollAnswer#guid
       #   @return [String] poll answer guid
       property :poll_answer_guid
+
+      def self.get_target_entity_type(*)
+        "Poll"
+      end
     end
   end
 end

data/lib/diaspora_federation/entities/relayable.rb

@@ -31,6 +31,10 @@ module DiasporaFederation
           property :parent_guid
           property :parent_author_signature, default: nil
           property :author_signature, default: nil
+
+          def self.get_target_entity_type(data)
+            data[:target_type] || "Post"
+          end
         end
       end
 
@@ -40,7 +44,7 @@ module DiasporaFederation
       def to_xml
         entity_xml.tap do |xml|
           hash = to_h
-          Relayable.update_signatures!(hash)
+          Relayable.update_signatures!(hash, self.class)
 
           xml.at_xpath("author_signature").content = hash[:author_signature]
           xml.at_xpath("parent_author_signature").content = hash[:parent_author_signature]
@@ -54,21 +58,29 @@ module DiasporaFederation
       # verifies the signatures (+author_signature+ and +parent_author_signature+ if needed)
       # @param [Hash] data hash with data to verify
       # @raise [SignatureVerificationFailed] if the signature is not valid or no public key is found
-      def self.verify_signatures(data)
+      def self.verify_signatures(data, klass)
         pkey = DiasporaFederation.callbacks.trigger(:fetch_public_key_by_diaspora_id, data[:diaspora_id])
         raise SignatureVerificationFailed, "failed to fetch public key for #{data[:diaspora_id]}" if pkey.nil?
         raise SignatureVerificationFailed, "wrong author_signature" unless Signing.verify_signature(
           data, data[:author_signature], pkey
         )
 
-        author_is_local = DiasporaFederation.callbacks.trigger(:entity_author_is_local?, "Post", data[:parent_guid])
-        verify_parent_signature(data) unless author_is_local
+        author_is_local = DiasporaFederation.callbacks.trigger(
+          :entity_author_is_local?,
+          klass.get_target_entity_type(data),
+          data[:parent_guid]
+        )
+        verify_parent_signature(data, klass) unless author_is_local
       end
 
       # this happens only on downstream federation
       # @param [Hash] data hash with data to verify
-      def self.verify_parent_signature(data)
-        pkey = DiasporaFederation.callbacks.trigger(:fetch_author_public_key_by_entity_guid, "Post", data[:parent_guid])
+      def self.verify_parent_signature(data, klass)
+        pkey = DiasporaFederation.callbacks.trigger(
+          :fetch_author_public_key_by_entity_guid,
+          klass.get_target_entity_type(data),
+          data[:parent_guid]
+        )
         raise SignatureVerificationFailed,
               "failed to fetch public key for author of #{data[:parent_guid]}" if pkey.nil?
         raise SignatureVerificationFailed, "wrong parent_author_signature" unless Signing.verify_signature(
@@ -81,7 +93,7 @@ module DiasporaFederation
       # if the signatures are not in the hash yet and if the keys are available.
       #
       # @param [Hash] data hash given for a signing
-      def self.update_signatures!(data)
+      def self.update_signatures!(data, klass)
         if data[:author_signature].nil?
           pkey = DiasporaFederation.callbacks.trigger(:fetch_private_key_by_diaspora_id, data[:diaspora_id])
           data[:author_signature] = Signing.sign_with_key(data, pkey) unless pkey.nil?
@@ -90,7 +102,7 @@ module DiasporaFederation
         if data[:parent_author_signature].nil?
           pkey = DiasporaFederation.callbacks.trigger(
             :fetch_author_private_key_by_entity_guid,
-            "Post",
+            klass.get_target_entity_type(data),
             data[:parent_guid]
           )
           data[:parent_author_signature] = Signing.sign_with_key(data, pkey) unless pkey.nil?

data/lib/diaspora_federation/receiver.rb

@@ -0,0 +1,28 @@
+module DiasporaFederation
+  # Raised if failed to fetch a public key of the sender of the received message
+  class SenderKeyNotFound < Exception
+  end
+
+  # Raised if recipient private key is missing for a private receive
+  class RecipientKeyNotFound < Exception
+  end
+
+  # Common base for Private and Public receivers
+  #   @see Receiver::Public
+  #   @see Receiver::Private
+  class Receiver
+    def initialize(salmon_xml)
+      @salmon_xml = salmon_xml
+    end
+
+    def receive!
+      sender_id = slap.author_id
+      public_key = DiasporaFederation.callbacks.trigger(:fetch_public_key_by_diaspora_id, sender_id)
+      raise SenderKeyNotFound if public_key.nil?
+      DiasporaFederation.callbacks.trigger(:save_entity_after_receive, slap.entity(public_key))
+    end
+  end
+end
+
+require "diaspora_federation/receiver/private"
+require "diaspora_federation/receiver/public"

data/lib/diaspora_federation/receiver/private.rb

@@ -0,0 +1,19 @@
+module DiasporaFederation
+  class Receiver
+    # Receiver::Private is used to receive private messages, which are addressed to a specific user, encrypted with his
+    # public key and packed using Salmon::EncryptedSlap
+    class Private < Receiver
+      def initialize(salmon_xml, recipient_private_key)
+        super(salmon_xml)
+        raise RecipientKeyNotFound if recipient_private_key.nil?
+        @recipient_private_key = recipient_private_key
+      end
+
+      protected
+
+      def slap
+        @salmon ||= Salmon::EncryptedSlap.from_xml(@salmon_xml, @recipient_private_key)
+      end
+    end
+  end
+end

data/lib/diaspora_federation/receiver/public.rb

@@ -0,0 +1,13 @@
+module DiasporaFederation
+  class Receiver
+    # Receiver::Public is used to receive public messages, which are not addressed to a specific user, unencrypted
+    # and packed using Salmon::Slap
+    class Public < Receiver
+      protected
+
+      def slap
+        @salmon ||= Salmon::Slap.from_xml(@salmon_xml)
+      end
+    end
+  end
+end

data/lib/diaspora_federation/salmon/encrypted_slap.rb

@@ -1,3 +1,5 @@
+require "json"
+
 module DiasporaFederation
   module Salmon
     # +EncryptedSlap+ provides class methods for generating and parsing encrypted

data/lib/diaspora_federation/salmon/xml_payload.rb

@@ -99,7 +99,9 @@ module DiasporaFederation
           end
         }]
 
-        Entities::Relayable.verify_signatures(data) if klass.included_modules.include?(Entities::Relayable)
+        if klass.included_modules.include?(Entities::Relayable)
+          Entities::Relayable.verify_signatures(data, klass)
+        end
 
         klass.new(data)
       end

data/lib/diaspora_federation/version.rb

@@ -1,4 +1,4 @@
 module DiasporaFederation
   # the gem version
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Benjamin Neff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-13 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -19,7 +19,7 @@ dependencies:
         version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6.4
+        version: 1.6.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6.4
+        version: 1.6.7.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,9 @@ files:
 - lib/diaspora_federation/fetcher.rb
 - lib/diaspora_federation/logging.rb
 - lib/diaspora_federation/properties_dsl.rb
+- lib/diaspora_federation/receiver.rb
+- lib/diaspora_federation/receiver/private.rb
+- lib/diaspora_federation/receiver/public.rb
 - lib/diaspora_federation/salmon.rb
 - lib/diaspora_federation/salmon/aes.rb
 - lib/diaspora_federation/salmon/encrypted_slap.rb