diaspora_federation 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79f5ac9d463c824a36b9769994431ac6e66625fd
-  data.tar.gz: 270ed5a33de71c405bdcd584c620d3f1d97422c9
+  metadata.gz: 42c68f5013a4c3f538bdf2d0c304d79b42e09ab5
+  data.tar.gz: a3a21dd08bac81bc602fbee8e9ce7f4f726d7413
 SHA512:
-  metadata.gz: 14ed9bc7669bf07166bebacfe43bbb0cb78821010964181f94f3f395838ba7836755ebdc913048f7455fa6ca6cf0e78e281190ec1f914591c5233a641d986040
-  data.tar.gz: 91b6f07218394e0e066aefd973de6ddc4fa7c0d694c4ee25e53504d15f5371036e8b765f1d911f6008464c9f86e23e66a2a9010c32e3fb4f30da8c064099668e
+  metadata.gz: d4858c3925cd46cd2adf8097066340445129c7630f6a41c8560edac13cc233c825d7b8ae593f3bc917848003f722f4035dca0bf6716c87edb56f99035ffd4b20
+  data.tar.gz: 8bca5a011c3bb00cc128ef5cea489fe1e575bcdb6a3a74cede7fa5336f7c86f6b102ed0e3980b2a370eeba42e14d6c0b7d99b29a40ee7673477645420d9c1bc8

data/Changelog.md

@@ -1,3 +1,20 @@
+# 0.2.3
+
+## Features
+
+Add `blocking` flag to `Contact` entity [#80](https://github.com/diaspora/diaspora_federation/pull/80)
+Introduce alternative form for `AccountMigration` entity signature [#89](https://github.com/diaspora/diaspora_federation/pull/89)
+
+## Refactor
+
+Extract signing of `AccountMigration` to a different module [#89](https://github.com/diaspora/diaspora_federation/pull/89)
+Remove participants limit for conversations [#91](https://github.com/diaspora/diaspora_federation/pull/91)
+
+## Bug fixes
+
+Fix when booleans in relayables are false [#90](https://github.com/diaspora/diaspora_federation/pull/90)
+Fix relayable signatures for messages with invalid XML characters [#95](https://github.com/diaspora/diaspora_federation/pull/95)
+
 # 0.2.2
 
 ## Features

data/lib/diaspora_federation/discovery/discovery.rb

@@ -26,7 +26,7 @@ module DiasporaFederation
         person
       rescue DiscoveryError
         raise # simply re-raise DiscoveryError
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         raise DiscoveryError, "Failed discovery for #{diaspora_id}: #{e.class}: #{e.message}"
       end
 
@@ -48,7 +48,7 @@ module DiasporaFederation
         response = HttpClient.get(url)
         raise "Failed to fetch #{url}: #{response.status}" unless response.success?
         response.body
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         unless http_fallback && url.start_with?("https://")
           raise DiscoveryError, "Failed to fetch #{url} for #{diaspora_id}: #{e.class}: #{e.message}"
         end
@@ -78,7 +78,7 @@ module DiasporaFederation
 
         # This tries the WebFinger URL with https first, then falls back to http if webfinger_http_fallback is enabled.
         @webfinger = WebFinger.from_json(get(webfinger_url, DiasporaFederation.webfinger_http_fallback))
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         logger.warn "WebFinger failed, retrying with legacy WebFinger for #{diaspora_id}: #{e.class}: #{e.message}"
         @webfinger = WebFinger.from_xml(get(legacy_webfinger_url_from_host_meta))
       end

data/lib/diaspora_federation/entities.rb

@@ -13,6 +13,7 @@ require "diaspora_federation/entities/related_entity"
 # abstract types
 require "diaspora_federation/entities/post"
 require "diaspora_federation/entities/signable"
+require "diaspora_federation/entities/account_migration/signable"
 require "diaspora_federation/entities/relayable"
 
 # types

data/lib/diaspora_federation/entities/account_migration.rb

@@ -5,10 +5,12 @@ module DiasporaFederation
     #
     # @see Validators::AccountMigrationValidator
     class AccountMigration < Entity
-      include Signable
+      include AccountMigration::Signable
 
       # @!attribute [r] author
-      #   The old diaspora* ID of the person who changes their ID
+      #   Sender of the AccountMigration message. Usually it is the old diaspora* ID of the person who changes their ID.
+      #   This property is also allowed to be the new diaspora* ID, which is equal to the author of the included
+      #   profile.
       #   @see Person#author
       #   @return [String] author diaspora* ID
       property :author, :string
@@ -19,20 +21,39 @@ module DiasporaFederation
       entity :profile, Entities::Profile
 
       # @!attribute [r] signature
-      #   Signature that validates original and target diaspora* IDs with the new key of person
+      #   Signature that validates original and target diaspora* IDs with the private key of the second identity, other
+      #   than the entity author. So if the author is the old identity then this signature is made with the new identity
+      #   key, and vice versa.
       #   @return [String] signature
       property :signature, :string, default: nil
 
-      # @return [String] string representation of this object
-      def to_s
-        "AccountMigration:#{author}:#{profile.author}"
+      # @!attribute [r] old_identity
+      #   Optional attribute which keeps old diaspora* ID. Must be present when author attribute contains new diaspora*
+      #   ID.
+      #   @return [String] old identity
+      property :old_identity, :string, default: nil
+
+      # Returns diaspora* ID of the old person identity.
+      # @return [String] diaspora* ID of the old person identity
+      def old_identity
+        return @old_identity if author_is_new_id?
+        author
+      end
+
+      # Returns diaspora* ID of the new person identity.
+      # @return [String] diaspora* ID of the new person identity
+      def new_identity
+        profile.author
       end
 
+      # @return [String] string representation of this object
+      alias to_s unique_migration_descriptor
+
       # Shortcut for calling super method with sensible arguments
       #
       # @see DiasporaFederation::Entities::Signable#verify_signature
       def verify_signature
-        super(profile.author, :signature)
+        super(signer_id, :signature)
       end
 
       # Calls super and additionally does signature verification for the instantiated entity.
@@ -44,30 +65,33 @@ module DiasporaFederation
 
       private
 
-      # @see DiasporaFederation::Entities::Signable#signature_data
-      def signature_data
-        to_s
+      def author_is_new_id?
+        author == new_identity
+      end
+
+      def signer_id
+        author_is_new_id? ? @old_identity : new_identity
       end
 
       def enriched_properties
         super.tap do |hash|
-          hash[:signature] = signature || sign_with_new_key
+          hash[:signature] = signature || sign_with_respective_key
         end
       end
 
-      # Sign with new user's key
-      # @raise [NewPrivateKeyNotFound] if the new user's private key is not found
+      # Sign with the key of the #signer_id identity
+      # @raise [PrivateKeyNotFound] if the signer's private key is not found
       # @return [String] A Base64 encoded signature of #signature_data with key
-      def sign_with_new_key
-        privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key, profile.author)
-        raise NewPrivateKeyNotFound, "author=#{profile.author} obj=#{self}" if privkey.nil?
+      def sign_with_respective_key
+        privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key, signer_id)
+        raise PrivateKeyNotFound, "signer=#{signer_id} obj=#{self}" if privkey.nil?
         sign_with_key(privkey).tap do
-          logger.info "event=sign status=complete signature=signature author=#{profile.author} obj=#{self}"
+          logger.info "event=sign status=complete signature=signature signer=#{signer_id} obj=#{self}"
         end
       end
 
       # Raised, if creating the signature fails, because the new private key of a user was not found
-      class NewPrivateKeyNotFound < RuntimeError
+      class PrivateKeyNotFound < RuntimeError
       end
     end
   end

data/lib/diaspora_federation/entities/account_migration/signable.rb

@@ -0,0 +1,24 @@
+module DiasporaFederation
+  module Entities
+    class AccountMigration < Entity
+      # AccountMigration::Signable is a module that encapsulates basic signature generation/verification flow for
+      # AccountMigration entity.
+      #
+      # It is possible that implementation of diaspora* protocol requires to compute the signature for the
+      # AccountMigration entity without instantiating the entity. In this case this module may be useful.
+      module Signable
+        include Entities::Signable
+
+        # @return [String] string which is uniquely represents migration occasion
+        def unique_migration_descriptor
+          "AccountMigration:#{old_identity}:#{new_identity}"
+        end
+
+        # @see DiasporaFederation::Entities::Signable#signature_data
+        def signature_data
+          unique_migration_descriptor
+        end
+      end
+    end
+  end
+end

data/lib/diaspora_federation/entities/contact.rb

@@ -25,10 +25,25 @@ module DiasporaFederation
       #   @return [Boolean] if the author is sharing with the person
       property :sharing, :boolean, default: true
 
+      # @!attribute [r] blocking
+      #   @return [Boolean] if the author is blocking the person
+      property :blocking, :boolean, optional: true, default: false
+
       # @return [String] string representation of this object
       def to_s
         "Contact:#{author}:#{recipient}"
       end
+
+      private
+
+      def validate
+        super
+
+        return unless (following || sharing) && blocking
+
+        raise ValidationError,
+              "flags invalid: following:#{following}/sharing:#{sharing} and blocking:#{blocking} can't both be true"
+      end
     end
   end
 end

data/lib/diaspora_federation/entities/relayable.rb

@@ -148,7 +148,7 @@ module DiasporaFederation
           hash[:parent_author_signature] = parent_author_signature || sign_with_parent_author_if_available.to_s
         end
         order = signature_order + %i[author_signature parent_author_signature]
-        order.map {|element| [element, data[element] || ""] }.to_h
+        order.map {|element| [element, data[element].to_s] }.to_h
       end
 
       def signature_order=(order)

data/lib/diaspora_federation/entity.rb

@@ -277,7 +277,7 @@ module DiasporaFederation
 
       case self.class.class_props[name]
       when :string
-        value.to_s
+        value.to_s.gsub(INVALID_XML_REGEX, "\uFFFD")
       when :timestamp
         value.nil? ? "" : value.utc.iso8601
       else
@@ -310,7 +310,7 @@ module DiasporaFederation
     # Create simple node, fill it with text and append to root
     def simple_node(doc, name, value)
       Nokogiri::XML::Element.new(name.to_s, doc).tap do |node|
-        node.content = value.gsub(INVALID_XML_REGEX, "\uFFFD") unless value.empty?
+        node.content = value unless value.empty?
       end
     end
 

data/lib/diaspora_federation/federation/diaspora_url_parser.rb

@@ -26,7 +26,7 @@ module DiasporaFederation
         class_name = Entity.entity_class(type).to_s.rpartition("::").last
         return if DiasporaFederation.callbacks.trigger(:fetch_related_entity, class_name, guid)
         Fetcher.fetch_public(author, type, guid)
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         logger.error "Failed to fetch linked entity #{type}:#{guid}: #{e.class}: #{e.message}"
       end
     end

data/lib/diaspora_federation/federation/fetcher.rb

@@ -11,7 +11,7 @@ module DiasporaFederation
         type = entity_name(entity_type).to_s
         raise "Already fetching ..." if fetching[type].include?(guid)
         fetch_from_url(author, type, guid)
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         raise NotFetchable, "Failed to fetch #{entity_type}:#{guid} from #{author}: #{e.class}: #{e.message}"
       end
 

data/lib/diaspora_federation/federation/receiver.rb

@@ -15,7 +15,7 @@ module DiasporaFederation
                       Salmon::MagicEnvelope.unenvelop(magic_env_xml)
                     end
         Public.new(magic_env).receive
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         logger.error "failed to receive public message: #{e.class}: #{e.message}"
         logger.debug "received data:\n#{data}"
         raise e
@@ -36,7 +36,7 @@ module DiasporaFederation
                       Salmon::MagicEnvelope.unenvelop(magic_env_xml)
                     end
         Private.new(magic_env, recipient_id).receive
-      rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue => e # rubocop:disable Style/RescueStandardError
         logger.error "failed to receive private message for #{recipient_id}: #{e.class}: #{e.message}"
         logger.debug "received data:\n#{data}"
         raise e

data/lib/diaspora_federation/federation/receiver/abstract_receiver.rb

@@ -17,7 +17,7 @@ module DiasporaFederation
         # Validates and receives the entity
         def receive
           validate_and_receive
-        rescue => e # rubocop:disable Lint/RescueWithoutErrorClass
+        rescue => e # rubocop:disable Style/RescueStandardError
           logger.error "failed to receive #{entity}"
           raise e
         end

data/lib/diaspora_federation/validators.rb

@@ -19,7 +19,7 @@ end
 require "diaspora_federation/validators/rules/birthday"
 require "diaspora_federation/validators/rules/boolean"
 require "diaspora_federation/validators/rules/diaspora_id"
-require "diaspora_federation/validators/rules/diaspora_id_count"
+require "diaspora_federation/validators/rules/diaspora_id_list"
 require "diaspora_federation/validators/rules/guid"
 require "diaspora_federation/validators/rules/not_nil"
 require "diaspora_federation/validators/rules/public_key"

data/lib/diaspora_federation/validators/account_migration_validator.rb

@@ -7,6 +7,8 @@ module DiasporaFederation
       rule :author, :diaspora_id
 
       rule :profile, :not_nil
+
+      rule :old_identity, :diaspora_id
     end
   end
 end

data/lib/diaspora_federation/validators/contact_validator.rb

@@ -8,6 +8,7 @@ module DiasporaFederation
       rule :recipient, :diaspora_id
       rule :following, :boolean
       rule :sharing, :boolean
+      rule :blocking, :boolean
     end
   end
 end

data/lib/diaspora_federation/validators/conversation_validator.rb

@@ -9,7 +9,7 @@ module DiasporaFederation
 
       rule :subject, [:not_empty, length: {maximum: 255}]
 
-      rule :participants, diaspora_id_count: {maximum: 20}
+      rule :participants, diaspora_id_list: {minimum: 2}
       rule :messages, :not_nil
     end
   end

data/lib/diaspora_federation/validators/rules/diaspora_id_list.rb

@@ -0,0 +1,41 @@
+module Validation
+  module Rule
+    # Rule for validating the number of diaspora* IDs in a string.
+    # The evaluated string is split at ";".
+    class DiasporaIdList
+      # This rule can have a +minimum+ or +maximum+ param.
+      # @return [Hash] params
+      attr_reader :params
+
+      # Creates a new rule for a diaspora* ID list validation
+      # @param [Hash] params
+      # @option params [Integer] :minimum minimum allowed id count
+      # @option params [Integer] :maximum maximum allowed id count
+      def initialize(params={})
+        %i[minimum maximum].each do |param|
+          if params.include?(param) && !params[param].is_a?(Integer)
+            raise ArgumentError, "The :#{param} needs to be an Integer"
+          end
+        end
+
+        @params = params
+      end
+
+      # The error key for this rule
+      # @return [Symbol] error key
+      def error_key
+        :diaspora_id_list
+      end
+
+      def valid_value?(value)
+        ids = value.split(";")
+        return false if params.include?(:maximum) && ids.count > params[:maximum]
+        return false if params.include?(:minimum) && ids.count < params[:minimum]
+        ids.each do |id|
+          return false if DiasporaId::DIASPORA_ID.match(id).nil?
+        end
+        true
+      end
+    end
+  end
+end

data/lib/diaspora_federation/version.rb

@@ -1,4 +1,4 @@
 module DiasporaFederation
   # the gem version
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Benjamin Neff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-23 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +19,7 @@ dependencies:
         version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +29,7 @@ dependencies:
         version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +50,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,7 @@ files:
 - lib/diaspora_federation/entities.rb
 - lib/diaspora_federation/entities/account_deletion.rb
 - lib/diaspora_federation/entities/account_migration.rb
+- lib/diaspora_federation/entities/account_migration/signable.rb
 - lib/diaspora_federation/entities/comment.rb
 - lib/diaspora_federation/entities/contact.rb
 - lib/diaspora_federation/entities/conversation.rb
@@ -202,7 +203,7 @@ files:
 - lib/diaspora_federation/validators/rules/birthday.rb
 - lib/diaspora_federation/validators/rules/boolean.rb
 - lib/diaspora_federation/validators/rules/diaspora_id.rb
-- lib/diaspora_federation/validators/rules/diaspora_id_count.rb
+- lib/diaspora_federation/validators/rules/diaspora_id_list.rb
 - lib/diaspora_federation/validators/rules/guid.rb
 - lib/diaspora_federation/validators/rules/not_nil.rb
 - lib/diaspora_federation/validators/rules/public_key.rb
@@ -230,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: diaspora* federation library

data/lib/diaspora_federation/validators/rules/diaspora_id_count.rb

@@ -1,37 +0,0 @@
-module Validation
-  module Rule
-    # Rule for validating the number of diaspora* IDs in a string.
-    # The evaluated string is split at ";" and the result will be counted.
-    class DiasporaIdCount
-      # This rule must have a +maximum+ param.
-      # @return [Hash] params
-      attr_reader :params
-
-      # Creates a new rule for a maximum diaspora* ID count validation
-      # @param [Hash] params
-      # @option params [Integer] :maximum maximum allowed id count
-      def initialize(params)
-        unless params.include?(:maximum) && params[:maximum].is_a?(Integer)
-          raise ArgumentError, "A number has to be specified for :maximum"
-        end
-
-        @params = params
-      end
-
-      # The error key for this rule
-      # @return [Symbol] error key
-      def error_key
-        :diaspora_id_count
-      end
-
-      def valid_value?(value)
-        ids = value.split(";")
-        return false unless ids.count <= params[:maximum]
-        ids.each do |id|
-          return false if DiasporaId::DIASPORA_ID.match(id).nil?
-        end
-        true
-      end
-    end
-  end
-end