diaspora_federation 0.0.12 → 0.0.13

data/lib/diaspora_federation/entities/contact.rb

@@ -0,0 +1,29 @@
+module DiasporaFederation
+  module Entities
+    # this entity represents a contact with another person. A user issues it
+    # when he starts sharing/following with another user.
+    #
+    # @see Validators::ContactValidator
+    class Contact < Entity
+      # @!attribute [r] author
+      #   The diaspora ID of the person who shares his profile
+      #   @see Person#author
+      #   @return [String] sender ID
+      property :author
+
+      # @!attribute [r] recipient
+      #   The diaspora ID of the person who will be shared with
+      #   @see Validation::Rule::DiasporaId
+      #   @return [String] recipient ID
+      property :recipient
+
+      # @!attribute [r] following
+      #   @return [Boolean] if the author is following the person
+      property :following, default: true
+
+      # @!attribute [r] sharing
+      #   @return [Boolean] if the author is sharing with the person
+      property :sharing, default: true
+    end
+  end
+end

data/lib/diaspora_federation/entities/conversation.rb

@@ -22,17 +22,16 @@ module DiasporaFederation
       #   @return [[Entities::Message]] Messages of this conversation
       entity :messages, [Entities::Message]
 
-      # @!attribute [r] diaspora_id
+      # @!attribute [r] author
       #   The diaspora ID of the person initiated the conversation.
-      #   @see Person#diaspora_id
+      #   @see Person#author
       #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      property :author, xml_name: :diaspora_handle
 
-      # @!attribute [r] participant_ids
+      # @!attribute [r] participants
       #   The diaspora IDs of the persons participating the conversation separated by ";".
-      #   @see Person#diaspora_id
       #   @return [String] participants diaspora IDs
-      property :participant_ids, xml_name: :participant_handles
+      property :participants, xml_name: :participant_handles
     end
   end
 end

data/lib/diaspora_federation/entities/like.rb

@@ -4,32 +4,24 @@ module DiasporaFederation
     #
     # @see Validators::LikeValidator
     class Like < Entity
+      # old signature order
+      # @deprecated
+      LEGACY_SIGNATURE_ORDER = %i(positive guid parent_type parent_guid author).freeze
+
+      include Relayable
+
       # @!attribute [r] positive
       #   If +true+ set a like, if +false+, set a dislike (dislikes are currently not
       #   implemented in the Diaspora frontend).
       #   @return [Boolean] is it a like or a dislike
       property :positive
 
-      # @!attribute [r] guid
-      #   a random string of at least 16 chars.
-      #   @see Validation::Rule::Guid
-      #   @return [String] like guid
-      property :guid
-
-      # @!attribute [r] target_type
-      #   A string describing the type of the target.
+      # @!attribute [r] parent_type
+      #   A string describing the type of the parent.
       #   Can be "Post" or "Comment" (Comments are currently not implemented in the
       #   Diaspora Frontend).
-      #   @return [String] target type
-      property :target_type
-
-      include Relayable
-
-      # @!attribute [r] diaspora_id
-      #   The diaspora ID of the person who posts a like
-      #   @see Person#diaspora_id
-      #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      #   @return [String] parent type
+      property :parent_type, xml_name: :target_type
     end
   end
 end

data/lib/diaspora_federation/entities/message.rb

@@ -4,11 +4,9 @@ module DiasporaFederation
     #
     # @see Validators::MessageValidator
     class Message < Entity
-      # @!attribute [r] guid
-      #   a random string of at least 16 chars.
-      #   @see Validation::Rule::Guid
-      #   @return [String] message guid
-      property :guid
+      # old signature order
+      # @deprecated
+      LEGACY_SIGNATURE_ORDER = %i(guid parent_guid text created_at author conversation_guid).freeze
 
       include Relayable
 
@@ -22,19 +20,15 @@ module DiasporaFederation
       #   @return [Time] creation time
       property :created_at, default: -> { Time.now.utc }
 
-      # @!attribute [r] diaspora_id
-      #   The diaspora ID of the message author.
-      #   @see Person#diaspora_id
-      #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
-
       # @!attribute [r] conversation_guid
       #   guid of a conversation this message belongs to
       #   @see Conversation#guid
       #   @return [String] conversation guid
       property :conversation_guid
 
-      def self.get_target_entity_type(*)
+      # The {Message} parent is a {Conversation}
+      # @return [String] parent type
+      def parent_type
         "Conversation"
       end
     end

data/lib/diaspora_federation/entities/participation.rb

@@ -4,25 +4,17 @@ module DiasporaFederation
     #
     # @see Validators::Participation
     class Participation < Entity
-      # @!attribute [r] guid
-      #   a random string of at least 16 chars.
-      #   @see Validation::Rule::Guid
-      #   @return [String] participation guid
-      property :guid
-
-      # @!attribute [r] target_type
-      #   a string describing a type of the target to subscribe on.
-      #   currently only "Post" is supported.
-      #   @return [String] target type
-      property :target_type
+      # old signature order
+      # @deprecated
+      LEGACY_SIGNATURE_ORDER = %i(guid parent_type parent_guid author).freeze
 
       include Relayable
 
-      # @!attribute [r] diaspora_id
-      #   The diaspora ID of the person who subscribes on a post
-      #   @see Person#diaspora_id
-      #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      # @!attribute [r] parent_type
+      #   a string describing a type of the target to subscribe on.
+      #   currently only "Post" is supported.
+      #   @return [String] parent type
+      property :parent_type, xml_name: :target_type
     end
   end
 end

data/lib/diaspora_federation/entities/person.rb

@@ -11,11 +11,15 @@ module DiasporaFederation
       #   @return [String] guid
       property :guid
 
-      # @!attribute [r] diaspora_id
+      # @!attribute [r] author
       #   The diaspora ID of the person
       #   @see Validation::Rule::DiasporaId
       #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      # @!attribute [r] diaspora_id
+      #   Alias for author
+      #   @see Person#author
+      #   @return [String] diaspora ID
+      property :author, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] url
       #   @see Discovery::WebFinger#seed_url

data/lib/diaspora_federation/entities/photo.rb

@@ -10,11 +10,11 @@ module DiasporaFederation
       #   @return [String] guid
       property :guid
 
-      # @!attribute [r] diaspora_id
+      # @!attribute [r] author
       #   The diaspora ID of the person who uploaded the photo
-      #   @see Person#diaspora_id
+      #   @see Person#author
       #   @return [String] author diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      property :author, xml_name: :diaspora_handle
 
       # @!attribute [r] public
       #   Points if the photo is visible to everyone or only to some aspects

data/lib/diaspora_federation/entities/poll_participation.rb

@@ -4,27 +4,21 @@ module DiasporaFederation
     #
     # @see Validators::PollParticipationValidator
     class PollParticipation < Entity
-      # @!attribute [r] guid
-      #   a random string of at least 16 chars.
-      #   @see Validation::Rule::Guid
-      #   @return [String] guid
-      property :guid
+      # old signature order
+      # @deprecated
+      LEGACY_SIGNATURE_ORDER = %i(guid parent_guid author poll_answer_guid).freeze
 
       include Relayable
 
-      # @!attribute [r] diaspora_id
-      #   The diaspora ID of the person who voted in the poll
-      #   @see Person#diaspora_id
-      #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
-
       # @!attribute [r] poll_answer_guid
       #   guid of the answer selected by the user.
       #   @see PollAnswer#guid
       #   @return [String] poll answer guid
       property :poll_answer_guid
 
-      def self.get_target_entity_type(*)
+      # The {PollParticipation} parent is a {Poll}
+      # @return [String] parent type
+      def parent_type
         "Poll"
       end
     end

data/lib/diaspora_federation/entities/post.rb

@@ -0,0 +1,37 @@
+module DiasporaFederation
+  module Entities
+    # this is a module that defines common properties for a post which
+    # include {StatusMessage} and {Reshare}.
+    module Post
+      # on inclusion of this module the required properties for a post are added to the object that includes it
+      #
+      # @!attribute [r] author
+      #   The diaspora ID of the person who posts the post
+      #   @see Person#author
+      #   @return [String] diaspora ID
+      #
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] status message guid
+      #
+      # @!attribute [r] created_at
+      #   post entity creation time
+      #   @return [Time] creation time
+      #
+      # @!attribute [r] provider_display_name
+      #   a string that describes a means by which a user has posted the post
+      #   @return [String] provider display name
+      #
+      # @param [Entity] entity the entity in which it is included
+      def self.included(entity)
+        entity.class_eval do
+          property :author, xml_name: :diaspora_handle
+          property :guid
+          property :created_at, default: -> { Time.now.utc }
+          property :provider_display_name, default: nil
+        end
+      end
+    end
+  end
+end

data/lib/diaspora_federation/entities/profile.rb

@@ -4,11 +4,15 @@ module DiasporaFederation
     #
     # @see Validators::ProfileValidator
     class Profile < Entity
-      # @!attribute [r] diaspora_id
+      # @!attribute [r] author
       #   The diaspora ID of the person
-      #   @see Person#diaspora_id
+      #   @see Person#author
+      #   @return [String] diaspora ID
+      # @!attribute [r] diaspora_id
+      #   Alias for author
+      #   @see Profile#author
       #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      property :author, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] first_name
       #   @deprecated We decided to only use one name field, these should be removed

data/lib/diaspora_federation/entities/relayable.rb

@@ -2,15 +2,44 @@ module DiasporaFederation
   module Entities
     # this is a module that defines common properties for relayable entities
     # which include Like, Comment, Participation, Message, etc. Each relayable
-    # has a parent, identified by guid. Relayables also are signed and signing/verificating
+    # has a parent, identified by guid. Relayables also are signed and signing/verification
     # logic is embedded into Salmon XML processing code.
     module Relayable
+      include Logging
+
+      # digest instance used for signing
+      DIGEST = OpenSSL::Digest::SHA256.new
+
+      # order from the parsed xml for signature
+      # @return [Array] order from xml
+      attr_reader :xml_order
+
+      # additional properties from parsed xml
+      # @return [Hash] additional xml elements
+      attr_reader :additional_xml_elements
+
       # on inclusion of this module the required properties for a relayable are added to the object that includes it
       #
+      # @!attribute [r] author
+      #   The diaspora ID of the author.
+      #   @see Person#author
+      #   @return [String] diaspora ID
+      #
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] comment guid
+      #
       # @!attribute [r] parent_guid
       #   @see StatusMessage#guid
       #   @return [String] parent guid
       #
+      # @!attribute [r] author_signature
+      #   Contains a signature of the entity using the private key of the author of a post itself.
+      #   The presence of this signature is mandatory. Without it the entity won't be accepted by
+      #   a target pod.
+      #   @return [String] author signature
+      #
       # @!attribute [r] parent_author_signature
       #   Contains a signature of the entity using the private key of the author of a parent post
       #   This signature is required only when federation from upstream (parent) post author to
@@ -19,95 +48,170 @@ module DiasporaFederation
       #
       #   @return [String] parent author signature
       #
-      # @!attribute [r] author_signature
-      #   Contains a signature of the entity using the private key of the author of a post itself.
-      #   The presence of this signature is mandatory. Without it the entity won't be accepted by
-      #   a target pod.
-      #   @return [String] author signature
-      #
       # @param [Entity] entity the entity in which it is included
       def self.included(entity)
         entity.class_eval do
+          property :author, xml_name: :diaspora_handle
+          property :guid
           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
+          property :parent_author_signature, default: nil
         end
-      end
-
-      # Generates XML and updates signatures
-      # @see Entity#to_xml
-      # @return [Nokogiri::XML::Element] root element containing properties as child elements
-      def to_xml
-        entity_xml.tap do |xml|
-          hash = to_h
-          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]
-        end
+        entity.extend ParseXML
       end
 
-      # Exception raised when verify_signatures fails to verify signatures (signatures are wrong)
-      class SignatureVerificationFailed < ArgumentError
+      # Initializes a new relayable Entity with order and additional xml elements
+      #
+      # @param [Hash] data entity data
+      # @param [Array] xml_order order from xml
+      # @param [Hash] additional_xml_elements additional xml elements
+      # @see DiasporaFederation::Entity#initialize
+      def initialize(data, xml_order=nil, additional_xml_elements={})
+        @xml_order = xml_order
+        @additional_xml_elements = additional_xml_elements
+
+        super(data)
       end
 
       # 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, 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
-        )
+      def verify_signatures
+        pubkey = DiasporaFederation.callbacks.trigger(:fetch_public_key_by_diaspora_id, author)
+        raise PublicKeyNotFound, "author_signature author=#{author} guid=#{guid}" if pubkey.nil?
+        raise SignatureVerificationFailed, "wrong author_signature" unless verify_signature(pubkey, author_signature)
 
-        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
+        parent_author_local = DiasporaFederation.callbacks.trigger(:entity_author_is_local?, parent_type, parent_guid)
+        verify_parent_author_signature unless parent_author_local
       end
 
+      private
+
       # this happens only on downstream federation
-      # @param [Hash] data hash with data to verify
-      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(
-          data, data[:parent_author_signature], pkey
+      def verify_parent_author_signature
+        pubkey = DiasporaFederation.callbacks.trigger(:fetch_author_public_key_by_entity_guid, parent_type, parent_guid)
+
+        raise PublicKeyNotFound, "parent_author_signature parent_guid=#{parent_guid} guid=#{guid}" if pubkey.nil?
+        unless verify_signature(pubkey, parent_author_signature)
+          raise SignatureVerificationFailed, "wrong parent_author_signature parent_guid=#{parent_guid}"
+        end
+      end
+
+      # Check that signature is a correct signature
+      #
+      # @param [OpenSSL::PKey::RSA] pubkey An RSA key
+      # @param [String] signature The signature to be verified.
+      # @return [Boolean] signature valid
+      def verify_signature(pubkey, signature)
+        if signature.nil?
+          logger.warn "event=verify_signature status=abort reason=no_signature guid=#{guid}"
+          return false
+        end
+
+        pubkey.verify(DIGEST, Base64.decode64(signature), signature_data).tap do |valid|
+          logger.info "event=verify_signature status=complete guid=#{guid} valid=#{valid}"
+        end
+      end
+
+      # sign with author key
+      # @raise [AuthorPrivateKeyNotFound] if the author private key is not found
+      # @return [String] A Base64 encoded signature of #signature_data with key
+      def sign_with_author
+        privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key_by_diaspora_id, author)
+        raise AuthorPrivateKeyNotFound, "author=#{author} guid=#{guid}" if privkey.nil?
+        sign_with_key(privkey).tap do
+          logger.info "event=sign status=complete signature=author_signature author=#{author} guid=#{guid}"
+        end
+      end
+
+      # sign with parent author key, if the parent author is local (if the private key is found)
+      # @return [String] A Base64 encoded signature of #signature_data with key
+      def sign_with_parent_author_if_available
+        privkey = DiasporaFederation.callbacks.trigger(
+          :fetch_author_private_key_by_entity_guid, parent_type, parent_guid
         )
+        if privkey
+          sign_with_key(privkey).tap do
+            logger.info "event=sign status=complete signature=parent_author_signature guid=#{guid}"
+          end
+        end
       end
-      private_class_method :verify_parent_signature
 
-      # Adds signatures to a given hash with the keys of the author and the parent
-      # if the signatures are not in the hash yet and if the keys are available.
+      # Sign the data with the key
       #
-      # @param [Hash] data hash given for a signing
-      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?
+      # @param [OpenSSL::PKey::RSA] privkey An RSA key
+      # @return [String] A Base64 encoded signature of #signature_data with key
+      def sign_with_key(privkey)
+        Base64.strict_encode64(privkey.sign(DIGEST, signature_data))
+      end
+
+      # Sort all XML elements according to the order used for the signatures.
+      # It updates also the signatures with the keys of the author and the parent
+      # if the signatures are not there yet and if the keys are available.
+      #
+      # @return [Hash] sorted xml elements with updated signatures
+      def xml_elements
+        xml_data = super.merge(additional_xml_elements)
+        Hash[signature_order.map {|element| [element, xml_data[element]] }].tap do |xml_elements|
+          xml_elements[:author_signature] = author_signature || sign_with_author
+          xml_elements[:parent_author_signature] = parent_author_signature || sign_with_parent_author_if_available.to_s
         end
+      end
 
-        if data[:parent_author_signature].nil?
-          pkey = DiasporaFederation.callbacks.trigger(
-            :fetch_author_private_key_by_entity_guid,
-            klass.get_target_entity_type(data),
-            data[:parent_guid]
-          )
-          data[:parent_author_signature] = Signing.sign_with_key(data, pkey) unless pkey.nil?
+      # the order for signing
+      # @return [Array]
+      def signature_order
+        xml_order.nil? ? self.class::LEGACY_SIGNATURE_ORDER : xml_order.reject {|name| name =~ /signature/ }
+      end
+
+      # @return [String] signature data string
+      def signature_data
+        data = to_h.merge(additional_xml_elements)
+        signature_order.map {|name| data[name] }.join(";")
+      end
+
+      # override class methods from {Entity} to parse the xml
+      module ParseXML
+        private
+
+        # @param [Nokogiri::XML::Element] root_node xml nodes
+        # @return [Entity] instance
+        def populate_entity(root_node)
+          # Use all known properties to build the Entity (entity_data). All additional xml elements
+          # are respected and attached to a hash as string (additional_xml_elements). It also remembers
+          # the order of the xml-nodes (xml_order). This is needed to support receiving objects from
+          # the future versions of Diaspora, where new elements may have been added.
+          entity_data = {}
+          additional_xml_elements = {}
+
+          xml_order = root_node.element_children.map do |child|
+            xml_name = child.name
+            property = find_property_for_xml_name(xml_name)
+
+            if property
+              entity_data[property] = parse_element_from_node(xml_name, class_props[property], root_node)
+              property
+            else
+              additional_xml_elements[xml_name] = child.text
+              xml_name
+            end
+          end
+
+          new(entity_data, xml_order, additional_xml_elements).tap(&:verify_signatures)
         end
       end
+
+      # Exception raised when creating the author_signature failes, because the private key was not found
+      class AuthorPrivateKeyNotFound < RuntimeError
+      end
+
+      # Exception raised when verify_signatures fails to verify signatures (no public key found)
+      class PublicKeyNotFound < RuntimeError
+      end
+
+      # Exception raised when verify_signatures fails to verify signatures (signatures are wrong)
+      class SignatureVerificationFailed < RuntimeError
+      end
     end
   end
 end