diaspora_federation 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af59c7c4e5a24b7e263f5d216ae15033dcfde71
-  data.tar.gz: 5c0db7743659a37fd00cd7bcad942c063cd46c5f
+  metadata.gz: c09fc18228d8f509ac6ee451d3f86514112cc959
+  data.tar.gz: 7176641baf249258ad914643fb3d0ed07121e481
 SHA512:
-  metadata.gz: a9a83b4a6a02cd027dc0aa3471b2e7f38717ce172776b9d60109ef025a9b0450791be6e2afaed47d4ba63464d09fd36f2388e22c689cc1f0a0577c14de769861
-  data.tar.gz: 4eb06d94138f85abf4ee1d6259fdae829da7ee6fab6a24ea5afb3619feba69bb0dc51b2b17367b1ddc7b94e041c484da4b6161e1627b3390f69ed0f5b9d8c9f2
+  metadata.gz: fb127f2108104ba7a3191af13f2620b8f308df88a67671d488a2f61243c4e04cc11e5f5eb1d31fe5ffda66dee7c35f10d8e6ed5edc995e20b966241f537c1517
+  data.tar.gz: 0b8222a2035a70e4b92f2d599ef0d5ab34c7a17a3ad7b811f203f86e956f80c849ddab90a555b911d50db095c8346b6ab185f95b492b3ecf7b999d47c4cbd244

data/README.md

@@ -43,16 +43,16 @@ DiasporaFederation.configure do |config|
   config.server_uri = AppConfig.pod_uri
 
   config.define_callbacks do
-    on :person_webfinger_fetch do |handle|
-      person = Person.find_local_by_diaspora_handle(handle)
+    on :fetch_person_for_webfinger do |diaspora_id|
+      person = Person.find_local_by_diaspora_id(diaspora_id)
       if person
-        DiasporaFederation::WebFinger::WebFinger.new(
+        DiasporaFederation::Discovery::WebFinger.new(
           # ...
         )
       end
     end
 
-    on :person_hcard_fetch do |guid|
+    on :fetch_person_for_hcard do |guid|
       # ...
     end
   end

data/lib/diaspora_federation.rb

@@ -3,16 +3,22 @@ require "diaspora_federation/logging"
 require "diaspora_federation/callbacks"
 require "diaspora_federation/properties_dsl"
 require "diaspora_federation/entity"
+require "diaspora_federation/validators"
 
-require "diaspora_federation/web_finger"
+require "diaspora_federation/fetcher"
+
+require "diaspora_federation/entities"
+
+require "diaspora_federation/discovery"
 
 # diaspora* federation library
 module DiasporaFederation
   extend Logging
 
   @callbacks = Callbacks.new %i(
-    person_webfinger_fetch
-    person_hcard_fetch
+    fetch_person_for_webfinger
+    fetch_person_for_hcard
+    save_person_after_webfinger
   )
 
   class << self
@@ -30,6 +36,12 @@ module DiasporaFederation
     #   config.server_uri = AppConfig.pod_uri
     attr_accessor :server_uri
 
+    # Set the bundle of certificate authorities (CA) certificates
+    #
+    # @example
+    #   config.certificate_authorities = AppConfig.environment.certificate_authorities.get
+    attr_accessor :certificate_authorities
+
     # configure the federation library
     #
     # @example
@@ -63,10 +75,17 @@ module DiasporaFederation
     # called from after_initialize
     # @raise [ConfigurationError] if the configuration is incomplete or invalid
     def validate_config
-      configuration_error "Missing server_uri" unless @server_uri.respond_to? :host
+      configuration_error "server_uri: Missing or invalid" unless @server_uri.respond_to? :host
+
+      configuration_error "certificate_authorities: Not configured" if @certificate_authorities.nil?
+      unless File.file? @certificate_authorities
+        configuration_error "certificate_authorities: File not found: #{@certificate_authorities}"
+      end
+
       unless @callbacks.definition_complete?
         configuration_error "Missing handlers for #{@callbacks.missing_handlers.join(', ')}"
       end
+
       logger.info "successfully configured the federation library"
     end
 

data/lib/diaspora_federation/discovery.rb

@@ -0,0 +1,14 @@
+module DiasporaFederation
+  # This module provides the namespace for the various classes implementing
+  # WebFinger and other protocols used for metadata discovery on remote servers
+  # in the Diaspora* network.
+  module Discovery
+  end
+end
+
+require "diaspora_federation/discovery/exceptions"
+require "diaspora_federation/discovery/xrd_document"
+require "diaspora_federation/discovery/host_meta"
+require "diaspora_federation/discovery/web_finger"
+require "diaspora_federation/discovery/h_card"
+require "diaspora_federation/discovery/discovery"

data/lib/diaspora_federation/discovery/discovery.rb

@@ -0,0 +1,94 @@
+module DiasporaFederation
+  module Discovery
+    # This class contains the logic to fetch all data for the given diaspora ID
+    class Discovery
+      include DiasporaFederation::Logging
+
+      # @return [String] the diaspora ID of the account
+      attr_reader :diaspora_id
+
+      # create a discovery class for the diaspora-id
+      # @param [String] diaspora_id the diaspora id to discover
+      def initialize(diaspora_id)
+        @diaspora_id = clean_diaspora_id(diaspora_id)
+      end
+
+      # fetch all metadata for the account and saves it via callback
+      # @return [Person]
+      def fetch_and_save
+        logger.info "Fetch data for #{diaspora_id}"
+
+        unless diaspora_id == clean_diaspora_id(webfinger.acct_uri)
+          raise DiscoveryError, "Diaspora ID does not match: Wanted #{diaspora_id} but got" \
+                                " #{clean_diaspora_id(webfinger.acct_uri)}"
+        end
+
+        DiasporaFederation.callbacks.trigger(:save_person_after_webfinger, person)
+        logger.info "successfully webfingered #{diaspora_id}"
+        person
+      end
+
+      private
+
+      def clean_diaspora_id(diaspora_id)
+        diaspora_id.strip.sub("acct:", "").to_s.downcase
+      end
+
+      def get(url, http_fallback=false)
+        logger.info "Fetching #{url} for #{diaspora_id}"
+        response = Fetcher.get(url)
+        raise "Failed to fetch #{url}: #{response.status}" unless response.success?
+        response.body
+      rescue => e
+        if http_fallback && url.start_with?("https://")
+          logger.warn "Retry with http: #{url} for #{diaspora_id}: #{e.class}: #{e.message}"
+          url.sub!("https://", "http://")
+          retry
+        else
+          raise DiscoveryError, "Failed to fetch #{url} for #{diaspora_id}: #{e.class}: #{e.message}"
+        end
+      end
+
+      def host_meta_url
+        domain = diaspora_id.split("@")[1]
+        "https://#{domain}/.well-known/host-meta"
+      end
+
+      def legacy_webfinger_url_from_host_meta
+        # this tries the xrd url with https first, then falls back to http
+        host_meta = HostMeta.from_xml get(host_meta_url, true)
+        host_meta.webfinger_template_url.gsub("{uri}", "acct:#{diaspora_id}")
+      end
+
+      def webfinger
+        @webfinger ||= WebFinger.from_xml get(legacy_webfinger_url_from_host_meta)
+      end
+
+      def hcard
+        @hcard ||= HCard.from_html get(webfinger.hcard_url)
+      end
+
+      def person
+        @person ||= Entities::Person.new(
+          guid:         hcard.guid || webfinger.guid,
+          diaspora_id:  diaspora_id,
+          url:          webfinger.seed_url,
+          exported_key: hcard.public_key || webfinger.public_key,
+          profile:      profile
+        )
+      end
+
+      def profile
+        Entities::Profile.new(
+          diaspora_id:      diaspora_id,
+          first_name:       hcard.first_name,
+          last_name:        hcard.last_name,
+          image_url:        hcard.photo_large_url,
+          image_url_medium: hcard.photo_medium_url,
+          image_url_small:  hcard.photo_small_url,
+          searchable:       hcard.searchable
+        )
+      end
+    end
+  end
+end

data/lib/diaspora_federation/{web_finger → discovery}/exceptions.rb

@@ -1,5 +1,5 @@
 module DiasporaFederation
-  module WebFinger
+  module Discovery
     # Raised, if the XML structure is invalid
     class InvalidDocument < RuntimeError
     end
@@ -11,5 +11,9 @@ module DiasporaFederation
     # * if the html passed to {HCard.from_html} in some way is malformed, invalid or incomplete.
     class InvalidData < RuntimeError
     end
+
+    # Raised, if there is an error while discover a new person
+    class DiscoveryError < RuntimeError
+    end
   end
 end

data/lib/diaspora_federation/{web_finger → discovery}/h_card.rb

@@ -1,5 +1,5 @@
 module DiasporaFederation
-  module WebFinger
+  module Discovery
     # This class provides the means of generating an parsing account data to and
     # from the hCard format.
     # hCard is based on +RFC 2426+ (vCard) which got superseded by +RFC 6350+.
@@ -15,17 +15,17 @@ module DiasporaFederation
     #
     # @example Creating a hCard document from a person hash
     #   hc = HCard.new(
-    #     guid:                  "0123456789abcdef",
-    #     nickname:              "user",
-    #     full_name:             "User Name",
-    #     seed_url:              "https://server.example/",
-    #     photo_large_url:       "https://server.example/uploads/l.jpg",
-    #     photo_medium_url:      "https://server.example/uploads/m.jpg",
-    #     photo_small_url:       "https://server.example/uploads/s.jpg",
-    #     serialized_public_key: "-----BEGIN PUBLIC KEY-----\nABCDEF==\n-----END PUBLIC KEY-----",
-    #     searchable:            true,
-    #     first_name:            "User",
-    #     last_name:             "Name"
+    #     guid:             "0123456789abcdef",
+    #     nickname:         "user",
+    #     full_name:        "User Name",
+    #     seed_url:         "https://server.example/",
+    #     photo_large_url:  "https://server.example/uploads/l.jpg",
+    #     photo_medium_url: "https://server.example/uploads/m.jpg",
+    #     photo_small_url:  "https://server.example/uploads/s.jpg",
+    #     public_key:       "-----BEGIN PUBLIC KEY-----\nABCDEF==\n-----END PUBLIC KEY-----",
+    #     searchable:       true,
+    #     first_name:       "User",
+    #     last_name:        "Name"
     #   )
     #   html_string = hc.to_html
     #
@@ -48,12 +48,12 @@ module DiasporaFederation
       property :guid
 
       # @!attribute [r] nickname
-      #   the first part of the diaspora handle
+      #   the first part of the diaspora ID
       #   @return [String] nickname
       property :nickname
 
       # @!attribute [r] full_name
-      #  @return [String] display name of the user
+      #   @return [String] display name of the user
       property :full_name
 
       # @!attribute [r] url
@@ -70,10 +70,8 @@ module DiasporaFederation
       #   DER-encoded PKCS#1 key beginning with the text
       #   "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".
       #
-      #   @note the public key is new in the hcard and is optional now.
-      #
       #   @return [String] public key
-      property :public_key, default: nil
+      property :public_key
 
       # @!attribute [r] photo_large_url
       #   @return [String] url to the big avatar (300x300)
@@ -163,8 +161,8 @@ module DiasporaFederation
       def self.from_html(html_string)
         doc = parse_html_and_validate(html_string)
 
-        data = {
-          guid:             content_from_doc(doc, :uid),
+        new(
+          guid:             guid_from_doc(doc),
           nickname:         content_from_doc(doc, :nickname),
           full_name:        content_from_doc(doc, :fn),
           url:              element_from_doc(doc, :url)["href"],
@@ -172,15 +170,13 @@ module DiasporaFederation
           photo_medium_url: photo_from_doc(doc, :photo_medium),
           photo_small_url:  photo_from_doc(doc, :photo_small),
           searchable:       (content_from_doc(doc, :searchable) == "true"),
+          # TODO: public key is new and can be missing
+          public_key:       (content_from_doc(doc, :key) unless element_from_doc(doc, :key).nil?),
 
-          # TODO: change me!  ###################
+          # TODO: remove first_name and last_name!
           first_name:       content_from_doc(doc, :given_name),
           last_name:        content_from_doc(doc, :family_name)
-          #######################################
-        }
-        # TODO: public key is new and can be missing
-        data[:public_key] = content_from_doc(doc, :key) unless element_from_doc(doc, :key).nil?
-        new(data)
+        )
       end
 
       private
@@ -288,6 +284,14 @@ module DiasporaFederation
         element_from_doc(doc, photo_selector)["src"]
       end
       private_class_method :photo_from_doc
+
+      # @deprecated hack for old hcard
+      # @todo remove this when all pods have the new generator
+      def self.guid_from_doc(doc)
+        uid_element = element_from_doc(doc, :uid)
+        uid_element.content unless uid_element[:class].include? "nickname"
+      end
+      private_class_method :guid_from_doc
     end
   end
 end

data/lib/diaspora_federation/{web_finger → discovery}/host_meta.rb

@@ -1,6 +1,6 @@
 
 module DiasporaFederation
-  module WebFinger
+  module Discovery
     # Generates and parses Host Meta documents.
     #
     # This is a minimal implementation of the standard, only to the degree of what
@@ -19,8 +19,14 @@ module DiasporaFederation
     class HostMeta
       private_class_method :new
 
+      # create a new host-meta instance
+      # @param [String] webfinger_url the webfinger-url
+      def initialize(webfinger_url)
+        @webfinger_url = webfinger_url
+      end
+
       # URL fragment to append to the base URL
-      WEBFINGER_SUFFIX = "webfinger?q={uri}"
+      WEBFINGER_SUFFIX = "/webfinger?q={uri}"
 
       # Returns the WebFinger URL that was used to build this instance (either from
       # xml or by giving a base URL).
@@ -42,18 +48,14 @@ module DiasporaFederation
 
       # Builds a new HostMeta instance and constructs the WebFinger URL from the
       # given base URL by appending HostMeta::WEBFINGER_SUFFIX.
+      # @param [String, URL] base_url the base-url for the webfinger-url
       # @return [HostMeta]
       # @raise [InvalidData] if the webfinger url is malformed
       def self.from_base_url(base_url)
-        raise ArgumentError, "base_url is not a String" unless base_url.instance_of?(String)
-
-        base_url += "/" unless base_url.end_with?("/")
-        webfinger_url = base_url + WEBFINGER_SUFFIX
+        webfinger_url = "#{base_url.to_s.chomp('/')}#{WEBFINGER_SUFFIX}"
         raise InvalidData, "invalid webfinger url: #{webfinger_url}" unless webfinger_url_valid?(webfinger_url)
 
-        hm = allocate
-        hm.instance_variable_set(:@webfinger_url, webfinger_url)
-        hm
+        new(webfinger_url)
       end
 
       # Reads the given Host Meta XML document string and populates the
@@ -67,16 +69,14 @@ module DiasporaFederation
         webfinger_url = webfinger_url_from_xrd(data)
         raise InvalidData, "invalid webfinger url: #{webfinger_url}" unless webfinger_url_valid?(webfinger_url)
 
-        hm = allocate
-        hm.instance_variable_set(:@webfinger_url, webfinger_url)
-        hm
+        new(webfinger_url)
       end
 
       # Applies some basic sanity-checking to the given URL
       # @param [String] url validation subject
       # @return [Boolean] validation result
       def self.webfinger_url_valid?(url)
-        !url.nil? && url.instance_of?(String) && url =~ %r{^https?:\/\/.*\{uri\}}i
+        !url.nil? && url.instance_of?(String) && url =~ %r{^https?:\/\/.*\/.*\{uri\}.*}i
       end
       private_class_method :webfinger_url_valid?
 

data/lib/diaspora_federation/{web_finger → discovery}/web_finger.rb

@@ -1,5 +1,5 @@
 module DiasporaFederation
-  module WebFinger
+  module Discovery
     # The WebFinger document used for Diaspora* user discovery is based on an older
     # draft of the specification you can find in the wiki of the "webfinger" project
     # on {http://code.google.com/p/webfinger/wiki/WebFingerProtocol Google Code}
@@ -147,20 +147,23 @@ module DiasporaFederation
       def self.from_xml(webfinger_xml)
         data = parse_xml_and_validate(webfinger_xml)
 
-        hcard_url, seed_url, guid, profile_url, atom_url, salmon_url, public_key = parse_links(data)
+        links = data[:links]
+
+        # TODO: remove! public key is deprecated in webfinger
+        public_key  = parse_link(links, REL_PUBKEY)
 
         new(
           acct_uri:    data[:subject],
-          alias_url:   data[:aliases].first,
-          hcard_url:   hcard_url,
-          seed_url:    seed_url,
-          profile_url: profile_url,
-          atom_url:    atom_url,
-          salmon_url:  salmon_url,
+          alias_url:   clean_alias(data[:aliases].first),
+          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),
 
           # TODO: remove me!  ##########
-          guid:        guid,
-          public_key:  Base64.strict_decode64(public_key)
+          guid:        parse_link(links, REL_GUID),
+          public_key:  (Base64.strict_decode64(public_key) if public_key)
         )
       end
 
@@ -172,10 +175,10 @@ module DiasporaFederation
       # @return [Hash] data XML data
       # @raise [InvalidData] if the given XML string is invalid or incomplete
       def self.parse_xml_and_validate(webfinger_xml)
-        data = XrdDocument.xml_data(webfinger_xml)
-        valid = data.key?(:subject) && data.key?(:aliases) && data.key?(:links)
-        raise InvalidData, "webfinger xml is incomplete" unless valid
-        data
+        XrdDocument.xml_data(webfinger_xml).tap do |data|
+          valid = data.key?(:subject) && data.key?(:aliases) && data.key?(:links)
+          raise InvalidData, "webfinger xml is incomplete" unless valid
+        end
       end
       private_class_method :parse_xml_and_validate
 
@@ -209,22 +212,15 @@ module DiasporaFederation
         ##################################
       end
 
-      def self.parse_links(data)
-        links = data[:links]
-        hcard   = parse_link(links, REL_HCARD)
-        seed    = parse_link(links, REL_SEED)
-        guid    = parse_link(links, REL_GUID)
-        profile = parse_link(links, REL_PROFILE)
-        atom    = parse_link(links, REL_ATOM)
-        salmon  = parse_link(links, REL_SALMON)
-        pubkey  = parse_link(links, REL_PUBKEY)
-        raise InvalidData, "webfinger xml is incomplete" unless [hcard, seed, guid, profile, atom, salmon, pubkey].all?
-        [hcard[:href], seed[:href], guid[:href], profile[:href], atom[:href], salmon[:href], pubkey[:href]]
+      def self.parse_link(links, rel)
+        element = links.find {|l| l[:rel] == rel }
+        element ? element[:href] : nil
       end
-      private_class_method :parse_links
+      private_class_method :parse_link
 
-      def self.parse_link(links, rel)
-        links.find {|l| l[:rel] == rel }
+      # @deprecated remove this, when all pods use this gem for generation
+      def self.clean_alias(alias_string)
+        alias_string.gsub(/\A"|"\Z/, "")
       end
       private_class_method :parse_link
     end