yoti 1.5.0 → 1.6.4

data/lib/yoti/dynamic_share_service/policy/source_constraint.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DynamicSharingService
+    # A list of anchors to require for a dynamic share
+    class SourceConstraint
+      DRIVING_LICENCE = 'DRIVING_LICENCE'
+      PASSPORT = 'PASSPORT'
+      NATIONAL_ID = 'NATIONAL_ID'
+      PASS_CARD = 'PASS_CARD'
+
+      SOURCE_CONSTRAINT = 'SOURCE'
+
+      attr_reader :anchors
+
+      def soft_preference
+        return @soft_preference if @soft_preference
+
+        false
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+
+      def as_json(*_args)
+        obj = {
+          type: SOURCE_CONSTRAINT,
+          preferred_sources: {
+            anchors: @anchors.map(&:as_json)
+          }
+        }
+        obj[:preferred_sources][:soft_preference] = @soft_preference unless @soft_preference.nil?
+        obj
+      end
+
+      def initialize
+        @anchors = []
+      end
+
+      def self.builder
+        SourceConstraintBuilder.new
+      end
+    end
+
+    # Builder for SourceConstraint
+    class SourceConstraintBuilder
+      def initialize
+        @constraint = SourceConstraint.new
+      end
+
+      def with_anchor_by_value(value, sub_type)
+        anchor = WantedAnchor.builder.with_value(value).with_sub_type(sub_type).build
+        with_anchor(anchor)
+      end
+
+      def with_anchor(anchor)
+        @constraint.anchors.push(anchor)
+        self
+      end
+
+      def with_passport(sub_type = nil)
+        with_anchor_by_value(SourceConstraint::PASSPORT, sub_type)
+      end
+
+      def with_driving_licence(sub_type = nil)
+        with_anchor_by_value(SourceConstraint::DRIVING_LICENCE, sub_type)
+      end
+
+      def with_national_id(sub_type = nil)
+        with_anchor_by_value(SourceConstraint::NATIONAL_ID, sub_type)
+      end
+
+      def with_passcard(sub_type = nil)
+        with_anchor_by_value(SourceConstraint::PASS_CARD, sub_type)
+      end
+
+      def with_soft_preference(preference = true)
+        @constraint.instance_variable_set(:@soft_preference, preference)
+        self
+      end
+
+      def build
+        Marshal.load Marshal.dump @constraint
+      end
+    end
+  end
+end

data/lib/yoti/dynamic_share_service/policy/wanted_anchor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DynamicSharingService
+    # A wanted anchor for a source based constraint
+    class WantedAnchor
+      attr_reader :value
+      attr_reader :sub_type
+
+      def initialize
+        @value = ''
+        @sub_type = nil
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+
+      def as_json
+        obj = {
+          name: @value
+        }
+        obj[:sub_type] = @sub_type if @sub_type
+        obj
+      end
+
+      def self.builder
+        WantedAnchorBuilder.new
+      end
+    end
+
+    # Builder for WantedAnchor
+    class WantedAnchorBuilder
+      def initialize
+        @anchor = WantedAnchor.new
+      end
+
+      def with_value(value)
+        @anchor.instance_variable_set(:@value, value)
+        self
+      end
+
+      def with_sub_type(sub_type = nil)
+        @anchor.instance_variable_set(:@sub_type, sub_type)
+        self
+      end
+
+      def build
+        Marshal.load Marshal.dump @anchor
+      end
+    end
+  end
+end

data/lib/yoti/dynamic_share_service/policy/wanted_attribute.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DynamicSharingService
+    # Describes a wanted attribute in a dynamic sharing policy
+    class WantedAttribute
+      attr_reader :name
+      attr_reader :derivation
+      attr_reader :constraints
+
+      def initialize
+        @constraints = []
+      end
+
+      def accept_self_asserted
+        return true if @accept_self_asserted
+
+        false
+      end
+
+      def to_json(*_args)
+        as_json.to_json
+      end
+
+      def as_json(*_args)
+        obj = {
+          name: @name
+        }
+        obj[:derivation] = @derivation if derivation
+        obj[:accept_self_asserted] = @accept_self_asserted if accept_self_asserted
+        obj[:constraints] = @constraints.map(&:as_json) unless constraints.empty?
+        obj
+      end
+
+      def self.builder
+        WantedAttributeBuilder.new
+      end
+    end
+
+    # Builder for WantedAttribute
+    class WantedAttributeBuilder
+      def initialize
+        @attribute = WantedAttribute.new
+      end
+
+      #
+      # @param [String] name
+      #
+      def with_name(name)
+        @attribute.instance_variable_set(:@name, name)
+        self
+      end
+
+      #
+      # @param [String] derivation
+      #
+      def with_derivation(derivation)
+        @attribute.instance_variable_set(:@derivation, derivation)
+        self
+      end
+
+      #
+      # @param constraint Constraint to apply to the requested attribute
+      #
+      def with_constraint(constraint)
+        @attribute.constraints.push(constraint)
+        self
+      end
+
+      #
+      # @param [Bool] accept
+      #
+      def with_accept_self_asserted(accept = true)
+        @attribute.instance_variable_set(:@accept_self_asserted, accept)
+        self
+      end
+
+      def build
+        raise 'Attribute name missing' if @attribute.name.nil? || @attribute.name == ''
+
+        Marshal.load Marshal.dump @attribute
+      end
+    end
+  end
+end

data/lib/yoti/dynamic_share_service/share_url.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Yoti
+  module DynamicSharingService
+    class Share
+      attr_reader :share_url, :ref_id
+
+      def initialize(data)
+        @share_url = data['qrcode']
+        @ref_id = data['ref_id']
+      end
+    end
+
+    def self.create_share_url_endpoint
+      "/qrcodes/apps/#{Yoti.configuration.client_sdk_id}"
+    end
+
+    def self.create_share_url_query
+      "?nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
+    end
+
+    def self.create_share_url(scenario)
+      endpoint = "#{create_share_url_endpoint}#{create_share_url_query}"
+      uri = URI("#{Yoti.configuration.api_endpoint}#{endpoint}")
+
+      unsigned = Net::HTTP::Post.new uri
+      unsigned.body = scenario.to_json
+
+      signed_request = Yoti::SignedRequest.new(
+        unsigned,
+        endpoint,
+        scenario
+      ).sign
+
+      response = Net::HTTP.start(
+        uri.hostname,
+        uri.port,
+        use_ssl: true
+      ) do |http|
+        http.request signed_request
+      end
+
+      create_share_url_parse_response response
+    end
+
+    def self.create_share_url_parse_response(response)
+      if response.code.to_i < 200 || response.code.to_i >= 300
+        case response.code
+        when '400'
+          raise InvalidDataError
+        when '404'
+          raise ApplicationNotFoundError
+        else
+          raise UnknownHTTPError, response.code
+        end
+      end
+
+      Share.new JSON.parse response.body
+    end
+
+    class InvalidDataError < StandardError
+      def initialize(msg = 'JSON is incorrect, contains invalid data')
+        super
+      end
+    end
+
+    class ApplicationNotFoundError < StandardError
+      def initialize(msg = 'Application was not found')
+        super
+      end
+    end
+
+    class UnknownHTTPError < StandardError
+      def initialize(code = nil, msg = 'Unknown HTTP Error')
+        msg = "#{msg}: #{code}" unless code.nil?
+        super msg
+      end
+    end
+  end
+end

data/lib/yoti/http/profile_request.rb

@@ -15,6 +15,7 @@ module Yoti
 
     def request
       yoti_request = Yoti::Request.new
+      yoti_request.add_header('X-Yoti-Auth-Key', Yoti::SSL.auth_key_from_pem)
       yoti_request.encrypted_connect_token = @encrypted_connect_token
       yoti_request.http_method = 'GET'
       yoti_request.endpoint = 'profile'

data/lib/yoti/http/request.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module Yoti
   # Manage the API's HTTPS requests
   class Request
@@ -14,6 +16,15 @@ module Yoti
     # @return [Hash] the body sent with the request
     attr_accessor :payload
 
+    def initialize
+      @headers = {}
+    end
+
+    # Adds a HTTP header to the request
+    def add_header(header, value)
+      @headers[header] = value
+    end
+
     # Makes a HTTP request after signing the headers
     # @return [Hash] the body from the HTTP request
     def body
@@ -51,6 +62,10 @@ module Yoti
         raise RequestError, "Request method not allowed: #{@http_method}"
       end
 
+      @headers.each do |header, value|
+        http_req[header] = value
+      end
+
       http_req
     end
 

data/lib/yoti/http/signed_request.rb

@@ -11,12 +11,9 @@ module Yoti
     end
 
     def sign
-      @http_req['X-Yoti-Auth-Key'] = @auth_key
       @http_req['X-Yoti-Auth-Digest'] = message_signature
       @http_req['X-Yoti-SDK'] = Yoti.configuration.sdk_identifier
       @http_req['X-Yoti-SDK-Version'] = "#{Yoti.configuration.sdk_identifier}-#{Yoti::VERSION}"
-      @http_req['Content-Type'] = 'application/json'
-      @http_req['Accept'] = 'application/json'
       @http_req
     end
 

data/lib/yoti/protobuf/main.rb

@@ -6,6 +6,9 @@ require 'json'
 require_relative 'attrpubapi/List_pb.rb'
 require_relative 'compubapi/EncryptedData_pb.rb'
 require_relative 'compubapi/SignedTimestamp_pb.rb'
+require_relative 'sharepubapi/ExtraData_pb.rb'
+require_relative 'sharepubapi/IssuingAttributes_pb.rb'
+require_relative 'sharepubapi/ThirdPartyAttribute_pb.rb'
 
 module Yoti
   module Protobuf
@@ -40,12 +43,20 @@ module Yoti
         decipher_profile(receipt['profile_content'], receipt['wrapped_receipt_key'])
       end
 
+      def extra_data(receipt)
+        return nil if receipt['extra_data_content'].nil? || receipt['extra_data_content'] == ''
+
+        decipher_extra_data(receipt['extra_data_content'], receipt['wrapped_receipt_key'])
+      end
+
       def attribute_list(data)
         Yoti::Protobuf::Attrpubapi::AttributeList.decode(data)
       end
 
       def value_based_on_attribute_name(value, attr_name)
         case attr_name
+        when Yoti::Attribute::DOCUMENT_DETAILS
+          Yoti::DocumentDetails.new(value)
         when Yoti::Attribute::DOCUMENT_IMAGES
           raise(TypeError, 'Document Images could not be decoded') unless value.is_a?(Yoti::MultiValue)
 
@@ -83,7 +94,7 @@ module Yoti
         proto_multi_value = Yoti::Protobuf::Attrpubapi::MultiValue.decode(value)
         items = []
         proto_multi_value.values.each do |item|
-          items.append value_based_on_content_type(item.data, item.content_type)
+          items << value_based_on_content_type(item.data, item.content_type)
         end
         MultiValue.new(items)
       end
@@ -100,11 +111,21 @@ module Yoti
       end
 
       def decipher_profile(profile_content, wrapped_key)
-        encrypted_data = decode_profile(profile_content)
-        unwrapped_key = Yoti::SSL.decrypt_token(wrapped_key)
-        decrypted_data = Yoti::SSL.decipher(unwrapped_key, encrypted_data.iv, encrypted_data.cipher_text)
+        decrypted_data = decipher_data(profile_content, wrapped_key)
         Protobuf.attribute_list(decrypted_data)
       end
+
+      def decipher_extra_data(extra_data_content, wrapped_key)
+        decrypted_data = decipher_data(extra_data_content, wrapped_key)
+        proto = Yoti::Protobuf::Sharepubapi::ExtraData.decode(decrypted_data)
+        Share::ExtraData.new(proto)
+      end
+
+      def decipher_data(encrypted_content, wrapped_key)
+        encrypted_data = decode_profile(encrypted_content)
+        unwrapped_key = Yoti::SSL.decrypt_token(wrapped_key)
+        Yoti::SSL.decipher(unwrapped_key, encrypted_data.iv, encrypted_data.cipher_text)
+      end
     end
   end
 end

data/lib/yoti/protobuf/sharepubapi/DataEntry_pb.rb

@@ -0,0 +1,29 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: DataEntry.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "sharepubapi_v1.DataEntry" do
+    optional :type, :enum, 1, "sharepubapi_v1.DataEntry.Type"
+    optional :value, :bytes, 2
+  end
+  add_enum "sharepubapi_v1.DataEntry.Type" do
+    value :UNDEFINED, 0
+    value :INVOICE, 1
+    value :PAYMENT_TRANSACTION, 2
+    value :LOCATION, 3
+    value :TRANSACTION, 4
+    value :AGE_VERIFICATION_SECRET, 5
+    value :THIRD_PARTY_ATTRIBUTE, 6
+  end
+end
+
+module Yoti
+  module Protobuf
+    module Sharepubapi
+      DataEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.DataEntry").msgclass
+      DataEntry::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("sharepubapi_v1.DataEntry.Type").enummodule
+    end
+  end
+end