selfsdk 0.0.197 → 0.0.200

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88cd6714a5c258e5777b5c7ce465c998b9215fb16459e1687282e3695961fb2a
-  data.tar.gz: b05a49bc266ba95b6a957bea27b31edd5216afeea30dc159ca134b65ecf59261
+  metadata.gz: 74f1c051fdeb2d35ce3d50da6c0f84169f99ea0ad403c456a131a1b992da29ae
+  data.tar.gz: a3a869a1ec7240c3bc0076d44540c53456438008636382bd165e1ab89a32e045
 SHA512:
-  metadata.gz: e9bea262aad81d5125dce00ce7afebb05b454eec6e7c26ab8a147ac5177894add5ae827158418100944bd729f8378c59d0296b57a792e688658edf917f2f7b01
-  data.tar.gz: 2aafa0e3b09648a67e95d662e19694faa9fb56fe90161cb44f045108f5aee004611390e9e702e0b198a0d9516d21e90ec61170a9b79d70f4b66c1a8694b87a3b
+  metadata.gz: 8723dbb549e965ba752e20a35fddc93034ac9dc719344025858eee1c3c2050f411e93a4db48cd38102182d8a801f45c64cebe67aed45c33ad7196e95b764cb43
+  data.tar.gz: 32971cdca3e179fc85ac190ad87fa5ba48fe92f1b63212f6cc948a6a2c989063c471a0dd65219036895a8a28441da99ed5b4ede67f88bf56c37f3aa4a9d5ca11

data/lib/messages/attestation.rb

@@ -24,7 +24,16 @@ module SelfSDK
         @expected_value = payload[:expected_value]
         @operator = payload[:operator]
         @fact_name = name.to_s
-        unless payload[name].nil?
+        if payload[name].nil?
+          return if payload[:facts].nil?
+
+          payload[:facts].each do |f|
+            if f[:key] == name.to_s
+              @value = f[:value]
+              break
+            end
+          end
+        else
           @value = payload[name]
         end
       end

data/lib/messages/connection_request.rb

@@ -0,0 +1,64 @@
+# Copyright 2020 Self Group Ltd. All Rights Reserved.
+
+# frozen_string_literal: true
+
+require 'self_msgproto'
+require_relative 'base'
+require_relative '../ntptime'
+
+module SelfSDK
+  module Messages
+    class ConnectionRequest < Base
+      MSG_TYPE = "identities.connections.req"
+      DEFAULT_EXP_TIMEOUT = 9000
+
+      attr_accessor :facts, :options, :auth
+
+      def initialize(messaging)
+        @typ = MSG_TYPE
+        super
+      end
+
+      def populate(selfid, opts)
+        @id = SecureRandom.uuid
+        @from = @client.jwt.id
+        @to = selfid
+        @exp_timeout = opts.fetch(:exp_timeout, DEFAULT_EXP_TIMEOUT)
+      end
+
+      def parse(input, envelope=nil)
+        super
+        @typ = MSG_TYPE
+        @body = @payload[:msg]
+      end
+
+      def body
+        {
+          typ: MSG_TYPE,
+          iss: @jwt.id,
+          aud: @to,
+          sub: @to,
+          iat: SelfSDK::Time.now.strftime('%FT%TZ'),
+          exp: (SelfSDK::Time.now + @exp_timeout).strftime('%FT%TZ'),
+          jti: SecureRandom.uuid,
+          require_confirmation: true,
+        }
+      end
+
+      protected
+
+      def proto(to_device)
+        @to_device = to_device
+        recipient = "#{@to}:#{@to_device}"
+        ciphertext = encrypt_message(@jwt.prepare(body), [{id: @to, device_id: @to_device}])
+
+        m = SelfMsg::Message.new
+        m.id = @id
+        m.sender = "#{@jwt.id}:#{@messaging.device_id}"
+        m.recipient = recipient
+        m.ciphertext = ciphertext
+        m
+      end
+    end
+  end
+end

data/lib/messages/connection_response.rb

@@ -0,0 +1,52 @@
+# Copyright 2020 Self Group Ltd. All Rights Reserved.
+
+# frozen_string_literal: true
+
+require 'self_msgproto'
+require_relative 'base'
+require_relative '../ntptime'
+
+module SelfSDK
+  module Messages
+    class ConnectionResponse < Base
+      MSG_TYPE = "identities.connections.resp"
+      DEFAULT_EXP_TIMEOUT = 900
+
+      attr_accessor :facts, :options, :auth
+
+      def initialize(messaging)
+        @typ = MSG_TYPE
+        super
+      end
+
+      def populate(selfid)
+        @id = SecureRandom.uuid
+        @from = @client.jwt.id
+        @to = selfid
+      end
+
+      def parse(input, envelope=nil)
+        @typ = MSG_TYPE
+        @payload = get_payload input
+        @body = @payload[:msg]
+        @status = @payload[:status]
+      end
+
+      def get_payload(input)
+        body = if input.is_a? String
+                 input
+               else
+                 input.ciphertext
+               end
+
+        jwt = JSON.parse(body, symbolize_names: true)
+        payload = JSON.parse(@jwt.decode(jwt[:payload]), symbolize_names: true)
+        header = JSON.parse(@jwt.decode(jwt[:protected]), symbolize_names: true)
+        @from = payload[:iss]
+        verify! jwt, header[:kid]
+        payload
+      end
+
+    end
+  end
+end

data/lib/messages/fact.rb

@@ -14,11 +14,15 @@ module SelfSDK
       end
 
       def parse(fact)
-        @name = @messaging.source.normalize_fact_name! fact[:fact]
+        @name = @messaging.source.normalize_fact_name fact[:fact]
         @operator = @messaging.source.normalize_operator!(fact[:operator])
         @sources = []
         fact[:sources]&.each do |s|
-          @sources << @messaging.source.normalize_source!(s)
+          @sources << s.to_s
+        end
+        @issuers = []
+        fact[:issuers]&.each do |i|
+          @issuers << i.to_s
         end
 
         @expected_value = fact[:expected_value] || ""
@@ -39,6 +43,7 @@ module SelfSDK
 
       def to_hash
         h = { fact: @name }
+        h[:issuers] = @issuers if @issuers.length > 0
         unless @sources.nil?
           h[:sources] = @sources if @sources.length > 0
         end

data/lib/messages/fact_issue.rb

@@ -0,0 +1,95 @@
+# Copyright 2020 Self Group Ltd. All Rights Reserved.
+
+# frozen_string_literal: true
+
+require 'self_msgproto'
+require_relative 'base'
+require_relative '../ntptime'
+
+module SelfSDK
+  module Messages
+    class FactIssue < Base
+      MSG_TYPE = "identities.facts.issue"
+      DEFAULT_EXP_TIMEOUT = 900
+
+      def initialize(messaging)
+        @typ = MSG_TYPE
+        super
+      end
+
+      def populate(selfid, facts, opts)
+        @id = opts.fetch(:cid, SecureRandom.uuid)
+        @exp_timeout = opts.fetch(:exp_timeout, DEFAULT_EXP_TIMEOUT)
+        @viewers = opts.fetch(:viewers, nil)
+
+        @from = @jwt.id
+        @to = selfid
+        @attestations = build_attestations!(facts)
+      end
+
+      def body
+        b = {
+          typ: MSG_TYPE,
+          iss: @jwt.id,
+          aud: @to,
+          sub: @to,
+          iat: SelfSDK::Time.now.strftime('%FT%TZ'),
+          exp: (SelfSDK::Time.now + @exp_timeout).strftime('%FT%TZ'),
+          cid: @id,
+          jti: SecureRandom.uuid,
+          status: 'verified',
+          attestations: @attestations
+        }
+        # viewers
+        b[:viewers] = @viewers unless @viewers.nil?
+        b
+      end
+
+      protected
+
+      def proto(to_device)
+        @to_device = to_device
+        recipient = "#{@to}:#{@to_device}"
+        ciphertext = encrypt_message(@jwt.prepare(body), [{id: @to, device_id: @to_device}])
+
+        m = SelfMsg::Message.new
+        m.id = @id
+        m.sender = "#{@jwt.id}:#{@messaging.device_id}"
+        m.recipient = recipient
+        m.ciphertext = ciphertext
+        m
+      end
+
+      private
+
+      def build_attestations!(facts)
+        raise 'facts must be provided in the form of an array' unless facts.kind_of?(Array)
+
+        attestations = []
+        facts.each do |fact|
+          att = fact.transform_keys(&:to_sym)
+          raise 'invalid attestation : does not provide a key' if !att.has_key?(:key) || att[:key].empty?
+
+          raise 'invalid attestation : does not provide a value' if !att.has_key?(:value) || att[:value].empty?
+          att.delete(:source)
+
+          attestations << sign(fact[:source], att)
+        end
+
+        attestations
+      end
+
+      def sign(source, facts)
+        fact = { jti: SecureRandom.uuid,
+                 sub: @to,
+                 iss: @from,
+                 iat: SelfSDK::Time.now.strftime('%FT%TZ'),
+                 exp: (SelfSDK::Time.now + @exp_timeout).strftime('%FT%TZ'),
+                 source: source,
+                 verified: true,
+                 facts: [ facts ] }
+        @client.jwt.signed(fact)
+      end
+    end
+  end
+end

data/lib/messages/fact_request.rb

@@ -87,7 +87,7 @@ module SelfSDK
         b = {
           typ: MSG_TYPE,
           iss: @jwt.id,
-          aud: @to,
+          aud: @intermediary ? @intermediary : @to,
           sub: @to,
           iat: SelfSDK::Time.now.strftime('%FT%TZ'),
           exp: (SelfSDK::Time.now + @exp_timeout).strftime('%FT%TZ'),

data/lib/messages/fact_response.rb

@@ -48,7 +48,7 @@ module SelfSDK
       end
 
       def fact(name)
-        name = @messaging.source.normalize_fact_name!(name)
+        name = @messaging.source.normalize_fact_name(name)
         @facts.select{|f| f.name == name}.first
       end
 

data/lib/messages/message.rb

@@ -11,6 +11,7 @@ require_relative "chat_invite"
 require_relative "chat_join"
 require_relative "chat_remove"
 require_relative "document_sign_resp"
+require_relative "connection_response"
 
 module SelfSDK
   module Messages
@@ -55,6 +56,9 @@ module SelfSDK
       when SelfSDK::Messages::DocumentSignResponse::MSG_TYPE
         m = DocumentSignResponse.new(messaging)
         m.parse(body, envelope)
+      when SelfSDK::Messages::ConnectionResponse::MSG_TYPE
+        m = ConnectionResponse.new(messaging)
+        m.parse(body, envelope)
       else
         raise StandardError.new("Invalid message type #{payload[:typ]}.")
       end

data/lib/messaging.rb

@@ -430,9 +430,8 @@ module SelfSDK
         message.validate! @uuid_observer[message.id][:original_message] if @uuid_observer.include? message.id
         notify_observer(message)
       end
-
     rescue StandardError => e
-      p "Error processing incoming message #{input.to_json}"
+      p "Error processing incoming message #{e.message}"
       SelfSDK.logger.info e
       # p e.backtrace
       nil

data/lib/services/chat.rb

@@ -6,6 +6,8 @@ require 'self_crypto'
 require_relative '../chat/file_object'
 require_relative '../chat/group'
 require_relative '../chat/message'
+require_relative "../messages/connection_request"
+
 module SelfSDK
   module Services
     class Chat
@@ -160,6 +162,46 @@ module SelfSDK
         send(members, typ: "chat.remove", gid: gid )
       end
 
+      # Generates a connection request in form of QR
+      #
+      #  @opts opts [Integer] :exp_timeout timeout in seconds to expire the request.
+      def generate_connection_qr(opts = {})
+        req = SelfSDK::Messages::ConnectionRequest.new(@messaging)
+        req.populate(@jwt.id, opts)
+        body = @jwt.prepare(req.body)
+
+        ::RQRCode::QRCode.new(body, level: 'l')
+      end
+
+      # Generates a connection request in form of deep link
+      #
+      # @param callback [String] the url you'll be redirected if the app is not installed.
+      #  @opts opts [Integer] :exp_timeout timeout in seconds to expire the request.
+      def generate_connection_deep_link(callback, opts = {})
+        req = SelfSDK::Messages::ConnectionRequest.new(@messaging)
+        req.populate(@jwt.id, opts)
+        body = @jwt.prepare(req.body)
+        body = @jwt.encode(body)
+
+        env = @messaging.client.client.env
+        if env.empty?
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
+        elsif env == 'development'
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
+        end
+
+        "https://#{env}.links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{env}"
+      end
+
+      # Subscribes to a connection response
+      #
+      #  @yield [request] Invokes the block with a connection response message.
+      def on_connection(&block)
+        @messaging.subscribe :connection_response do |msg|
+          block.call(msg)
+        end
+      end
+
       private
 
       # sends a confirmation for a list of messages to a list of recipients.

data/lib/services/facts.rb

@@ -1,13 +1,13 @@
 # Copyright 2020 Self Group Ltd. All Rights Reserved.
 
 # frozen_string_literal: true
+require_relative '../messages/fact_issue.rb'
 
 # Namespace for classes and modules that handle SelfSDK gem
 module SelfSDK
   # Namespace for classes and modules that handle selfsdk-gem public ui
   module Services
     # Self provides this self-hosted verified intermediary.
-    DEFAULT_INTERMEDIARY = "self_intermediary"
     # Input class to handle fact requests on self network.
     class Facts
       # Creates a new facts service.
@@ -93,6 +93,57 @@ module SelfSDK
         opts[:auth] = false
         @requester.generate_deep_link(facts, callback, opts)
       end
+
+      # Issues a custom fact and sends it to the user.
+      #
+      # @param selfid [String] self identifier for the message recipient.
+      # @param facts [Array<Fact>] facts to be sent to the user
+      # @option opts [String] :viewers list of self identifiers for the user that will have access to this facts.
+      def issue(selfid, facts, opts = {})
+        hased_facts = []
+        facts.each do |f|
+          hased_facts << f.to_hash
+        end
+
+        SelfSDK.logger.info "issuing facts for #{selfid}"
+        msg = SelfSDK::Messages::FactIssue.new(@requester.messaging)
+        msg.populate(selfid, hased_facts, opts)
+
+        msg.send_message
+      end
+
+      # Facts to be issued
+      class Fact
+        attr_accessor :key, :value, :group
+
+        def initialize(key, value, source, group = nil)
+          @key = key
+          @value = value
+          @source = source
+          @group = group
+        end
+
+        def to_hash
+          b = { key: @key, value: @value, source: @source }
+          b[:group] = @group.to_hash unless @group.nil?
+          b
+        end
+      end
+
+      class Group
+        attr_accessor :name, :icon
+
+        def initialize(name, icon = "")
+          @name = name
+          @icon = icon
+        end
+
+        def to_hash
+          b = { name: @name }
+          b[:icon] = @icon unless @icon.empty?
+          b
+        end
+      end
     end
   end
 end

data/lib/services/requester.rb

@@ -10,6 +10,8 @@ module SelfSDK
     DEFAULT_INTERMEDIARY = "self_intermediary"
     # Input class to handle fact requests on self network.
     class Requester
+      attr_reader :messaging
+
       # Creates a new facts service.
       # Facts service mainly manages fact requests against self users wanting
       # to share their verified facts with your app.
@@ -155,7 +157,7 @@ module SelfSDK
                  else
                    { fact: f }
                  end
-          # validate_fact!(fact)
+          validate_fact!(fact) unless fact.key?('issuers')
           fs << fact
         end
         fs
@@ -164,77 +166,18 @@ module SelfSDK
       def validate_fact!(f)
         errInvalidFactToSource = 'provided source does not support given fact'
         errInvalidSource = 'provided fact does not specify a valid source'
+        fact_name = f[:fact].to_s
 
-        raise 'provided fact does not specify a name' if f[:fact].empty?
+        raise 'provided fact does not specify a name' if fact_name.empty?
         return unless f.has_key? :sources
+        return if f.has_key? :issuers # skip the validation if is a custom fact
 
-        valid_sources = [SOURCE_USER_SPECIFIED,
-                         SOURCE_PASSPORT,
-                         SOURCE_DRIVING_LICENSE,
-                         SOURCE_IDENTITY_CARD,
-                         SOURCE_TWITTER,
-                         SOURCE_LINKEDIN,
-                         SOURCE_FACEBOK]
-        fact_for_passport = [FACT_DOCUMENT_NUMBER,
-                             FACT_SURNAME,
-                             FACT_GIVEN_NAMES,
-                             FACT_DATE_OF_BIRTH,
-                             FACT_DATE_OF_EXPIRATION,
-                             FACT_SEX,
-                             FACT_NATIONALITY,
-                             FACT_COUNTRY_OF_ISSUANCE]
-
-        facts_for_dl = [FACT_DOCUMENT_NUMBER,
-                        FACT_SURNAME,
-                        FACT_GIVEN_NAMES,
-                        FACT_DATE_OF_BIRTH,
-                        FACT_DATE_OF_ISSUANCE,
-                        FACT_DATE_OF_EXPIRATION,
-                        FACT_ADDRESS, 
-                        FACT_ISSUING_AUTHORITY,
-                        FACT_PLACE_OF_BIRTH, 
-                        FACT_COUNTRY_OF_ISSUANCE]
-
-        facts_for_user = [FACT_DOCUMENT_NUMBER,
-                          FACT_DISPLAY_NAME,
-                          FACT_EMAIL,
-                          FACT_PHONE]
-
-        facts_for_twitter = [FACT_ACCOUNT_ID, FACT_NICKNAME]
-        facts_for_linkedin = [FACT_ACCOUNT_ID, FACT_NICKNAME]
-        facts_for_facebook = [FACT_ACCOUNT_ID, FACT_NICKNAME]
-        facts_for_live = [FACT_SELFIE]
+        raise "invalid fact '#{fact_name}'" unless @messaging.source.core_fact?(fact_name)
 
+        spec = @messaging.source.sources
         f[:sources].each do |s|
-          raise errInvalidSource unless valid_sources.include? s.to_s
-
-          if s.to_s == SOURCE_PASSPORT || s.to_s == SOURCE_IDENTITY_CARD
-            raise errInvalidFactToSource unless fact_for_passport.include? f[:fact]
-          end
-
-          if s.to_s == SOURCE_DRIVING_LICENSE
-            raise errInvalidFactToSource unless facts_for_dl.include? f[:fact]
-          end
-
-          if s.to_s == SOURCE_USER_SPECIFIED
-            raise errInvalidFactToSource unless facts_for_user.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_TWITTER
-            raise errInvalidFactToSource unless facts_for_twitter.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_LINKEDIN
-            raise errInvalidFactToSource unless facts_for_linkedin.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_FACEBOOK
-            raise errInvalidFactToSource unless facts_for_facebook.include? f[:fact].to_s
-          end
-
-          if s.to_s == SOURCE_LIVE
-            raise errInvalidFactToSource unless facts_for_live.include? f[:fact].to_s
-          end
+          raise errInvalidSource unless spec.key?(s.to_s)
+          raise errInvalidFactToSource unless spec[s.to_s].include? fact_name.to_s
         end
       end
     end

data/lib/sources.rb

@@ -7,6 +7,8 @@ require_relative "source_definition.rb"
 
 module SelfSDK
   class Sources
+    attr_reader :sources, :facts
+
     def initialize(sources_file)
       @sources = SOURCE_DATA["sources"]
       @facts = []
@@ -15,10 +17,12 @@ module SelfSDK
       end
     end
 
-    def normalize_fact_name!(fact)
-      fact = fact.to_s
-      raise "invalid fact '#{fact}'" unless @facts.include?(fact)
-      fact
+    def normalize_fact_name(fact)
+      fact.to_s
+    end
+
+    def normalize_source(source)
+      source.to_s
     end
 
     def validate_source!(source)
@@ -37,6 +41,10 @@ module SelfSDK
       get(operators, input, "operator")
     end
 
+    def core_fact?(fact)
+      @facts.include? fact.to_s
+    end
+
     def message_type(s)
       types = { fact_request: SelfSDK::Messages::FactRequest::MSG_TYPE,
                 fact_response: SelfSDK::Messages::FactResponse::MSG_TYPE,
@@ -47,11 +55,13 @@ module SelfSDK
                 chat_join: SelfSDK::Messages::ChatJoin::MSG_TYPE,
                 chat_remove: SelfSDK::Messages::ChatRemove::MSG_TYPE,
                 document_sign_response: SelfSDK::Messages::DocumentSignResponse::MSG_TYPE,
+                connection_response: SelfSDK::Messages::ConnectionResponse::MSG_TYPE,
                }
       raise "invalid message type '#{s}'" unless types.key? s
       return types[s]
     end
 
+
     private
 
     def get(options, input, option_type)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selfsdk
 version: !ruby/object:Gem::Version
-  version: 0.0.197
+  version: 0.0.200
 platform: ruby
 authors:
 - Aldgate Ventures
@@ -184,14 +184,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.13
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -342,8 +348,11 @@ files:
 - lib/messages/chat_message_delivered.rb
 - lib/messages/chat_message_read.rb
 - lib/messages/chat_remove.rb
+- lib/messages/connection_request.rb
+- lib/messages/connection_response.rb
 - lib/messages/document_sign_resp.rb
 - lib/messages/fact.rb
+- lib/messages/fact_issue.rb
 - lib/messages/fact_request.rb
 - lib/messages/fact_response.rb
 - lib/messages/message.rb
@@ -381,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: joinself sdk