selfsdk 0.0.184 → 0.0.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c16f1734a708b0ebd37ca4fa0cea0e48db09344d4efb0654e5b4df6a37fd2d4
-  data.tar.gz: 32313fa1c28a57370c43d7100bdacc06bad28f0722ba0589a63c24bd0327bfd2
+  metadata.gz: b2efe13e1c9449fe24bbfbe5754377fe0ef1dc3bd8a5815b6ccc77f854ab8339
+  data.tar.gz: 07c371286f2aa7fd97ac2a4423daeb2ac3b767be2bb54c0233a7d5db8d1bde91
 SHA512:
-  metadata.gz: 9a015baa1ed364efcc422af5de6a54f87cbb953cdb45de7f397aa8cd2273b99c8ce4f6fbba0fc62f0ef803f38edf8155fbb1e9e14042b4f4ff76b391147da614
-  data.tar.gz: dfec1973db212e016774292d57bda452727cadd201ecdb80ab0f507a97ff3df244887ffde06704a618de63e0d101c75b7e8c879ff983654892d9496a50db7889
+  metadata.gz: '0748ed14d36949e1a96b8299d325189ea0a8f554e2b31d95d0831763051c74f0440f6f319e1808372bc1f09a43c3da7035bf1554843df9adda6d1eecaa51eae6'
+  data.tar.gz: 73f72a6b7357359af3d07bb5067b718147a32395fdee1a24fca29a82adeaafe7956483860ab7e8b74864d9e2dbb4fef11e9193651dd79c41e56f1a21f9c65984

data/lib/crypto.rb

@@ -141,12 +141,17 @@ module SelfSDK
       if File.exist?(session_file_name)
         # 7a) if carol's session file exists load the pickle from the file
         session_with_bob = SelfCrypto::Session.from_pickle(File.read(session_file_name), @storage_key)
-      else
-        # 7b-i) if you have not previously sent or received a message to/from bob,
-        #       you should extract the initial message from the group message intended
-        #       for your account id.
-        m = SelfCrypto::GroupMessage.new(message.to_s).get_message("#{@client.jwt.id}:#{@device}")
+      end
+
+      # 7b-i) if you have not previously sent or received a message to/from bob,
+      #       you should extract the initial message from the group message intended
+      #       for your account id.
+      m = SelfCrypto::GroupMessage.new(message.to_s).get_message("#{@client.jwt.id}:#{@device}")
 
+      # if there is no session, create one
+      # if there is an existing session and we are sent a one time key message, check
+      # if it belongs to this current session and create a new inbound session if it doesn't
+      if session_with_bob.nil? || m.instance_of?(SelfCrypto::PreKeyMessage) and !session_with_bob.will_receive?(m)
         # 7b-ii) use the initial message to create a session for bob or carol
         session_with_bob = @account.inbound_session(m)
 

data/lib/messages/attestation.rb

@@ -37,7 +37,7 @@ module SelfSDK
       end
 
       def validate!(original)
-        raise ::StandardError.new("invalid origin") if @to != original.to
+        raise ::StandardError.new("invalid origin") if @to.split(":").first != original.to
       end
 
       def signed

data/lib/messages/document_sign_resp.rb

@@ -0,0 +1,44 @@
+# 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 DocumentSignResponse < Base
+      MSG_TYPE = "document.sign.resp"
+      DEFAULT_EXP_TIMEOUT = 900
+
+      attr_accessor :objects, :signed_objects
+
+      def initialize(messaging)
+        @typ = MSG_TYPE
+        super
+      end
+
+      def parse(input, envelope)
+        @input = input
+        @typ = SelfSDK::Messages::DocumentSignResponse::MSG_TYPE
+        @payload = get_payload(input)
+        @id = payload[:cid]
+        @from = payload[:iss]
+        @to = payload[:sub]
+        @expires = ::Time.parse(payload[:exp])
+        @issued = ::Time.parse(payload[:iat])
+        @audience = payload[:aud]
+        @status = payload[:status]
+        @objects = payload[:objects]
+        @signed_objects = payload[:signed_objects]
+      end
+
+      protected
+
+      def proto(to_device)
+        nil
+      end
+    end
+  end
+end

data/lib/messages/fact_request.rb

@@ -35,6 +35,7 @@ module SelfSDK
         @description = opts.include?(:description) ? opts[:description] : nil
         @exp_timeout = opts.fetch(:exp_timeout, DEFAULT_EXP_TIMEOUT)
         @allowed_for = opts.fetch(:allowed_for, nil)
+        @auth = opts.fetch(:auth, false)
 
         @intermediary = if opts.include?(:intermediary)
                           opts[:intermediary]
@@ -91,6 +92,7 @@ module SelfSDK
         b[:options] = @options unless (@options.nil? || @options == false)
         b[:description] = @description unless (@description.nil? || @description.empty?)
         b[:allowed_until] = (SelfSDK::Time.now + @allowed_for).strftime('%FT%TZ') unless @allowed_for.nil?
+        b[:auth] = @auth unless @auth.nil?
         b
       end
 

data/lib/messages/fact_response.rb

@@ -11,7 +11,7 @@ module SelfSDK
     class FactResponse < Base
       MSG_TYPE = "identities.facts.query.resp"
 
-      attr_accessor :facts, :audience
+      attr_accessor :facts, :audience, :auth
 
       def parse(input, envelope=nil)
         @input = input
@@ -24,6 +24,7 @@ module SelfSDK
         @issued = ::Time.parse(payload[:iat])
         @audience = payload[:aud]
         @status = payload[:status]
+        @auth = payload[:auth]
         @facts = []
         payload[:facts] = [] if payload[:facts].nil?
         payload[:facts].each do |f|
@@ -69,7 +70,7 @@ module SelfSDK
         @facts.each do |fact|
           encoded_facts.push(fact.to_hash)
         end
-        
+
         { typ: MSG_TYPE,
           iss: @jwt.id,
           sub: @sub || @to,
@@ -79,7 +80,8 @@ module SelfSDK
           cid: @id,
           jti: SecureRandom.uuid,
           status: @status,
-          facts: encoded_facts }        
+          facts: encoded_facts,
+          auth: @auth }
       end
 
       protected

data/lib/messages/message.rb

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

data/lib/selfsdk.rb

@@ -21,6 +21,7 @@ require_relative 'services/facts'
 require_relative 'services/identity'
 require_relative 'services/messaging'
 require_relative 'services/chat'
+require_relative 'services/docs'
 
 # Namespace for classes and modules that handle Self interactions.
 module SelfSDK
@@ -88,6 +89,11 @@ module SelfSDK
       @chat ||= SelfSDK::Services::Chat.new(messaging, identity)
     end
 
+    # Provides access to SelfSDK::Services::Docs service
+    def docs
+      @docs ||= SelfSDK::Services::Docs.new(messaging, @client.self_url)
+    end
+
     def app_id
       client.jwt.id
     end

data/lib/services/auth.rb

@@ -89,11 +89,11 @@ module SelfSDK
         body = @client.jwt.encode(request(selfid, opts))
 
         if @client.env.empty?
-          return "https://joinself.page.link/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
         elsif @client.env == 'development'
-          return "https://joinself.page.link/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
         end
-        "https://joinself.page.link/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
+        "https://#{@client.env}.links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
       end
 
       # Adds an observer for an authentication response

data/lib/services/docs.rb

@@ -0,0 +1,71 @@
+# Copyright 2020 Self Group Ltd. All Rights Reserved.
+
+# frozen_string_literal: true
+
+# Namespace for classes and modules that handle SelfSDK gem
+module SelfSDK
+  # Namespace for classes and modules that handle selfsdk-gem public ui
+  module Services
+    # Input class to handle document requests on self network.
+    class Docs
+      attr_accessor :app_id
+
+      # Creates a new docs service.
+      # Docs service mainly allows you to send document signature requests.
+      #
+      # @param messaging [SelfSDK::Messaging] messaging object.
+      #
+      # @return [SelfSDK::Services::Docs] docs service.
+      def initialize(messaging, url)
+        @messaging = messaging
+        @self_url = url
+      end
+
+      # Sends a signature request to the specified user.
+      #
+      # @param recipient [string] the recipient of the request.
+      # @param body [string] the message to be displayed to the user.
+      # @param objects [Array] array of objects to be signed. provide an empty array if 
+      # you just want the body to be signed.
+      # @yield [request] Invokes the given block when a response is received.
+      def request_signature(recipient, body, objects, &block)
+        jti = SecureRandom.uuid
+        req = {
+          jti: jti,
+          typ: "document.sign.req",
+          aud: recipient,
+          msg: body,
+          objects: [],
+        }
+
+        auth_token = @messaging.client.jwt.auth_token
+        objects.each do |o|
+          req[:objects] << SelfSDK::Chat::FileObject.new(auth_token, @self_url).build_from_data(
+            o[:name],
+            o[:data],
+            o[:mime]
+          ).to_payload
+        end
+
+        if block_given?
+          @messaging.client.set_observer(OpenStruct.new({
+            id: jti,
+            to: recipient,
+            from: @messaging.client.jwt.id
+          }), timeout: 60 * 60 * 10, &block)
+
+          return @messaging.send(recipient, req)
+        end
+
+        @messaging.send(recipient, req)
+      end
+
+      # Subscribes to all document sign responses.
+      #
+      # @yield [request] Invokes the given block when a response is received.
+      def subscribe(&block)
+        @messaging.subscribe(:document_sign_response, &block)
+      end
+    end
+  end
+end

data/lib/services/facts.rb

@@ -8,7 +8,7 @@ module SelfSDK
   module Services
     # Self provides this self-hosted verified intermediary.
     DEFAULT_INTERMEDIARY = "self_intermediary"
-    # Input class to handle authentication requests on self network.
+    # Input class to handle fact requests on self network.
     class Facts
       # Creates a new facts service.
       # Facts service mainly manages fact requests against self users wanting
@@ -32,7 +32,7 @@ module SelfSDK
       #  @param selfid [string] the receiver of the authentication request.
       #  @param [Hash] opts the options to authenticate.
       #  @option opts [String] :cid The unique identifier of the authentication request.
-      #  @yield [request] Invokes the block with a street name for each result.
+      # @yield [request] Invokes the given block when a response is received.
       #  @return [Object] SelfSDK:::Messages::FactRequest
       #
       # @overload request(selfid, facts, opts = {})
@@ -41,6 +41,7 @@ module SelfSDK
       #  @option opts [String] :cid The unique identifier of the authentication request.
       #  @option opts [Integer] :exp_timeout timeout in seconds to expire the request.
       #  @option opts [Integer] :allowed_for number of seconds for enabling recurrent requests.
+      #  @option opts [Boolean] :auth allows displaying the request as anuthentication request with facts.
       #  @return [Object] SelfSDK:::Messages::FactRequest
       def request(selfid, facts, opts = {}, &block)
         SelfSDK.logger.info "authenticating #{selfid}"
@@ -116,11 +117,11 @@ module SelfSDK
         body = @client.jwt.encode(request(selfid, facts, opts))
 
         if @client.env.empty?
-          return "https://joinself.page.link/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app"
         elsif @client.env == 'development'
-          return "https://joinself.page.link/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
+          return "https://links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.dev"
         end
-        "https://joinself.page.link/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
+        "https://#{@client.env}.links.joinself.com/?link=#{callback}%3Fqr=#{body}&apn=com.joinself.app.#{@client.env}"
       end
 
       private
@@ -151,7 +152,13 @@ module SelfSDK
         raise 'provided fact does not specify a name' if f[:fact].empty?
         return unless f.has_key? :sources
 
-        valid_sources = [SOURCE_USER_SPECIFIED, SOURCE_PASSPORT, SOURCE_DRIVING_LICENSE, SOURCE_IDENTITY_CARD]
+        valid_sources = [ SOURCE_USER_SPECIFIED, 
+                          SOURCE_PASSPORT, 
+                          SOURCE_DRIVING_LICENSE, 
+                          SOURCE_IDENTITY_CARD, 
+                          SOURCE_TWITTER,
+                          SOURCE_LINKEDIN,
+                          SOURCE_FACEBOK ]
         factsForPassport = [ FACT_DOCUMENT_NUMBER, 
           FACT_SURNAME, 
           FACT_GIVEN_NAMES,
@@ -176,7 +183,11 @@ module SelfSDK
           FACT_DISPLAY_NAME,
           FACT_EMAIL,
           FACT_PHONE ]
-          
+
+        factsForTwitter = [ FACT_ACCOUNT_ID, FACT_NICKNAME ]
+        factsForLinkedin = [ FACT_ACCOUNT_ID, FACT_NICKNAME ]
+        factsForFacebook = [ FACT_ACCOUNT_ID, FACT_NICKNAME ]
+  
         f[:sources].each do |s|
           raise errInvalidSource unless valid_sources.include? s.to_s
 
@@ -191,6 +202,18 @@ module SelfSDK
           if s.to_s == SOURCE_USER_SPECIFIED
             raise errInvalidFactToSource unless factsForUser.include? f[:fact].to_s
           end
+
+          if s.to_s == SOURCE_TWITTER
+            raise errInvalidFactToSource unless factsForTwitter.include? f[:fact].to_s
+          end
+
+          if s.to_s == SOURCE_LINKEDIN
+            raise errInvalidFactToSource unless factsForLinkedin.include? f[:fact].to_s
+          end
+
+          if s.to_s == SOURCE_FACEBOOK
+            raise errInvalidFactToSource unless factsForFacebok.include? f[:fact].to_s
+          end
         end
       end
     end

data/lib/sources.rb

@@ -22,11 +22,16 @@ module SelfSDK
   FACT_CATEGORIES = "categories"
   FACT_SORT_CODE = "sort_code"
   FACT_COUNTRY_OF_ISSUANCE = "country_of_issuance"
+  FACT_ACCOUNT_ID = "account_id"
+  FACT_NICKNAME = "nickname"
 
   SOURCE_USER_SPECIFIED = "user_specified"
   SOURCE_PASSPORT = "passport"
   SOURCE_DRIVING_LICENSE = "driving_license"
   SOURCE_IDENTITY_CARD = "identity_card"
+  SOURCE_TWITTER = "twitter"
+  SOURCE_LINKEDIN = "linkedin"
+  SOURCE_FACEBOOK = "facebook"
 
   class << self
     def message_type(s)
@@ -40,6 +45,7 @@ module SelfSDK
                 chat_invite: SelfSDK::Messages::ChatInvite::MSG_TYPE,
                 chat_join: SelfSDK::Messages::ChatJoin::MSG_TYPE,
                 chat_remove: SelfSDK::Messages::ChatRemove::MSG_TYPE,
+                document_sign_response: SelfSDK::Messages::DocumentSignResponse::MSG_TYPE,
                }
       raise "invalid message type '#{s}'" unless types.key? s
       return types[s]
@@ -74,7 +80,9 @@ module SelfSDK
                 valid_to: FACT_VALID_TO,
                 categories: FACT_CATEGORIES,
                 sort_code: FACT_SORT_CODE,
-                country_of_issuance: FACT_COUNTRY_OF_ISSUANCE }
+                country_of_issuance: FACT_COUNTRY_OF_ISSUANCE, 
+                account_id: FACT_ACCOUNT_ID,
+                nickname: FACT_NICKNAME }
       get(facts, input, "fact")
     end
 
@@ -82,7 +90,10 @@ module SelfSDK
       sources = { user_specified: SOURCE_USER_SPECIFIED,
                 passport: SOURCE_PASSPORT,
                 driving_license: SOURCE_DRIVING_LICENSE,
-                identity_card: SOURCE_IDENTITY_CARD }
+                identity_card: SOURCE_IDENTITY_CARD,
+                twitter: SOURCE_TWITTER,
+                linkedin: SOURCE_LINKEDIN,
+                facebook: SOURCE_FACEBOOK }
       get(sources, input, "source")
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selfsdk
 version: !ruby/object:Gem::Version
-  version: 0.0.184
+  version: 0.0.187
 platform: ruby
 authors:
 - Aldgate Ventures
@@ -345,6 +345,7 @@ files:
 - lib/messages/chat_message_delivered.rb
 - lib/messages/chat_message_read.rb
 - lib/messages/chat_remove.rb
+- lib/messages/document_sign_resp.rb
 - lib/messages/fact.rb
 - lib/messages/fact_request.rb
 - lib/messages/fact_response.rb
@@ -354,6 +355,7 @@ files:
 - lib/selfsdk.rb
 - lib/services/auth.rb
 - lib/services/chat.rb
+- lib/services/docs.rb
 - lib/services/facts.rb
 - lib/services/identity.rb
 - lib/services/messaging.rb