yoti 1.3.1 → 1.4.0

data/lib/yoti/protobuf/main.rb

@@ -1,8 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('./attrpubapi/', __dir__)
+
 require 'google/protobuf'
 require 'json'
-require_relative 'v3/attrpubapi/list_pb.rb'
-require_relative 'v3/compubapi/encrypted_data_pb.rb'
-require_relative 'v3/compubapi/signed_time_stamp_pb.rb'
+
+require_relative 'attrpubapi/List_pb.rb'
+require_relative 'compubapi/EncryptedData_pb.rb'
+require_relative 'compubapi/SignedTimestamp_pb.rb'
 
 module Yoti
   module Protobuf
@@ -13,43 +16,65 @@ module Yoti
       CT_DATE = :DATE # string in RFC3339 format (YYYY-MM-DD)
       CT_PNG = :PNG # standard .png image
       CT_JSON = :JSON # json_string
+      CT_MULTI_VALUE = :MULTI_VALUE # multi value
+      CT_INT = :INT # integer
 
       def current_user(receipt)
         return nil unless valid_receipt?(receipt)
 
         profile_content = receipt['other_party_profile_content']
         decoded_profile_content = Base64.decode64(profile_content)
-        Yoti::Protobuf::CompubapiV3::EncryptedData.decode(decoded_profile_content)
+        Yoti::Protobuf::Compubapi::EncryptedData.decode(decoded_profile_content)
       end
 
       def attribute_list(data)
-        Yoti::Protobuf::AttrpubapiV3::AttributeList.decode(data)
+        Yoti::Protobuf::Attrpubapi::AttributeList.decode(data)
       end
 
-      def value_based_on_content_type(value, content_type = nil)
-        case content_type
-        when CT_UNDEFINED
-          raise ProtobufError, 'The content type is invalid.'
-        when CT_STRING, CT_DATE
-          value.encode('utf-8')
-        when CT_JSON
-           JSON.parse(value)
+      def value_based_on_attribute_name(value, attr_name)
+        case attr_name
+        when Yoti::Attribute::DOCUMENT_IMAGES
+          raise(TypeError, 'Document Images could not be decoded') unless value.is_a?(Yoti::MultiValue)
+
+          value.allow_type(Yoti::Image).items
         else
           value
         end
       end
 
-      def image_uri_based_on_content_type(value, content_type = nil)
+      def value_based_on_content_type(value, content_type = nil)
+        raise(TypeError, 'Warning: value is NULL') if value.empty? && content_type != CT_STRING
+
         case content_type
+        when CT_STRING, CT_DATE
+          value.encode('utf-8')
+        when CT_JSON
+          JSON.parse(value)
+        when CT_INT
+          value.to_i
         when CT_JPEG
-          'data:image/jpeg;base64,'.concat(Base64.strict_encode64(value))
+          Yoti::ImageJpeg.new(value)
         when CT_PNG
-          'data:image/png;base64,'.concat(Base64.strict_encode64(value))
+          Yoti::ImagePng.new(value)
+        when CT_MULTI_VALUE
+          convert_multi_value(value)
+        else
+          Yoti::Log.logger.warn("Unknown Content Type '#{content_type}', parsing as a String")
+          value.encode('utf-8')
         end
       end
 
       private
 
+      def convert_multi_value(value)
+        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)
+        end
+        MultiValue.new(items)
+      end
+
       def valid_receipt?(receipt)
         receipt.key?('other_party_profile_content') &&
           !receipt['other_party_profile_content'].nil? &&

data/lib/yoti/ssl.rb

@@ -26,8 +26,8 @@ module Yoti
 
         begin
           private_key.private_decrypt(Base64.urlsafe_decode64(encrypted_connect_token))
-        rescue StandardError => error
-          raise SslError, "Could not decrypt token. #{error}"
+        rescue StandardError => e
+          raise SslError, "Could not decrypt token. #{e}"
         end
       end
 
@@ -51,11 +51,11 @@ module Yoti
       # @param iv [String] base 64 decoded iv
       # @param text [String] base 64 decoded cyphered text
       # @return [String] base 64 decoded deciphered text
-      def decipher(key, iv, text)
+      def decipher(key, user_iv, text)
         ssl_decipher = OpenSSL::Cipher.new('AES-256-CBC')
         ssl_decipher.decrypt
         ssl_decipher.key = key
-        ssl_decipher.iv = iv
+        ssl_decipher.iv = user_iv
         ssl_decipher.update(text) + ssl_decipher.final
       end
 
@@ -63,8 +63,8 @@ module Yoti
 
       def private_key
         @private_key ||= OpenSSL::PKey::RSA.new(pem)
-      rescue StandardError => error
-        raise SslError, "The secure key is invalid. #{error}"
+      rescue StandardError => e
+        raise SslError, "The secure key is invalid. #{e}"
       end
     end
   end

data/lib/yoti/util/age_processor.rb

@@ -1,11 +1,11 @@
 module Yoti
   # Process age attribute
   class AgeProcessor
-    AGE_PATTERN = "age_(over|under):[1-9][0-9]?[0-9]?"
+    AGE_PATTERN = 'age_(over|under):[1-9][0-9]?[0-9]?'
 
     # check if the key matches the format age_[over|under]:[1-999]
     def self.is_age_verification(age_field)
-        return /#{AGE_PATTERN}/.match?(age_field)
+      /#{AGE_PATTERN}/.match?(age_field)
     end
   end
-end
+end

data/lib/yoti/util/anchor_processor.rb

@@ -4,97 +4,98 @@ require 'date'
 module Yoti
   # Parse attribute anchors
   class AnchorProcessor
-    # Define whether the search function get_anchor_value_by_oid
-    # should return the next value in the array
-    attr_reader :get_next
-
-    protected :get_next
-
     def initialize(anchors_list)
-        @anchors_list = anchors_list
-        @get_next = false
+      @anchors_list = anchors_list
+      @get_next = false
     end
 
     def process
-        result_data = { "sources" => [], "verifiers" => [] }
-        anchor_types = self.anchor_types
-
-        @anchors_list.each do |anchor|
-            x509_certs_list = convert_certs_list_to_X509(anchor.origin_server_certs)
-            yoti_signed_time_stamp = process_signed_time_stamp(anchor.signed_time_stamp)
-
-            anchor.origin_server_certs.each do |cert|
-                anchor_types.each do |type, oid|
-                    yotiAnchor = get_anchor_by_oid(cert, oid, anchor.sub_type, yoti_signed_time_stamp, x509_certs_list)
-                    if !yotiAnchor.nil? then
-                        result_data[type].push(yotiAnchor)
-                    end
-                end
-            end
+      result_data = { 'sources' => [], 'verifiers' => [] }
+      anchor_types = self.anchor_types
+
+      @anchors_list.each do |anchor|
+        x509_certs_list = convert_certs_list_to_X509(anchor.origin_server_certs)
+        yoti_signed_time_stamp = process_signed_time_stamp(anchor.signed_time_stamp)
+
+        anchor.origin_server_certs.each do |cert|
+          anchor_types.each do |type, oid|
+            yoti_anchor = get_anchor_by_oid(cert, oid, anchor.sub_type, yoti_signed_time_stamp, x509_certs_list)
+            result_data[type].push(yoti_anchor) unless yoti_anchor.nil?
+          end
         end
+      end
 
-        return result_data
+      result_data
     end
 
     def convert_certs_list_to_X509(certs_list)
-        x509_certs_list = []
-        certs_list.each do |cert|
-           x509_cert = OpenSSL::X509::Certificate.new cert
-           x509_certs_list.push x509_cert
-        end
+      x509_certs_list = []
+      certs_list.each do |cert|
+        x509_cert = OpenSSL::X509::Certificate.new cert
+        x509_certs_list.push x509_cert
+      end
 
-        return x509_certs_list
+      x509_certs_list
     end
 
     def process_signed_time_stamp(signed_time_stamp_binary)
-        signed_time_stamp = Yoti::Protobuf::CompubapiV3::SignedTimestamp.decode(signed_time_stamp_binary)
-        time_in_sec = signed_time_stamp.timestamp/1000000
-        date_time = DateTime.parse(Time.at(time_in_sec).to_s)
-        return Yoti::SignedTimeStamp.new(signed_time_stamp.version, date_time)
+      signed_time_stamp = Yoti::Protobuf::Compubapi::SignedTimestamp.decode(signed_time_stamp_binary)
+      time_in_sec = signed_time_stamp.timestamp / 1000000
+      date_time = Time.parse(Time.at(time_in_sec).to_s)
+      Yoti::SignedTimeStamp.new(signed_time_stamp.version, date_time)
     end
 
     def get_anchor_by_oid(cert, oid, sub_type, signed_time_stamp, x509_certs_list)
-        asn1Obj = OpenSSL::ASN1.decode(cert)
-        anchorValue = get_anchor_value_by_oid(asn1Obj, oid)
+      asn1_obj = OpenSSL::ASN1.decode(cert)
+      anchor_value = get_anchor_value_by_oid(asn1_obj, oid)
 
-        return nil unless !anchorValue.nil?
+      return nil if anchor_value.nil?
 
-        return Yoti::Anchor.new(anchorValue, sub_type, signed_time_stamp, x509_certs_list)
+      Yoti::Anchor.new(anchor_value, sub_type, signed_time_stamp, x509_certs_list)
     end
 
     def get_anchor_value_by_oid(obj, oid)
+      case obj
+      when OpenSSL::ASN1::Sequence, Array
+        return get_anchor_value_by_asn1_sequence(obj, oid)
+      when OpenSSL::ASN1::ASN1Data
+        return get_anchor_value_by_asn1_data(obj.value, oid)
+      end
+
+      # In case it's not a valid object
+      nil
+    end
 
-        case obj
-        when OpenSSL::ASN1::Sequence, Array
-            obj.each do |child_obj|
-                result = get_anchor_value_by_oid(child_obj, oid)
-                if result != nil
-                    return result
-                end
-            end
-        when OpenSSL::ASN1::ASN1Data
-            if obj.value.respond_to?(:to_s) && obj.value === oid
-                @get_next = true
-            elsif obj.value.respond_to?(:to_s) && @get_next
-                rawValue = OpenSSL::ASN1.decode(obj.value)
-                anchorValue = rawValue.value[0].value
-                @get_next = false
-                return anchorValue
-            end
-
-            return get_anchor_value_by_oid(obj.value, oid)
-        else
-            return nil
-        end
+    def get_anchor_value_by_asn1_data(value, oid)
+      if value.respond_to?(:to_s) && value == oid
+        @get_next = true
+      elsif value.respond_to?(:to_s) && @get_next
+        raw_value = OpenSSL::ASN1.decode(value)
+        anchor_value = raw_value.value[0].value
+        @get_next = false
+        return anchor_value
+      end
+
+      get_anchor_value_by_oid(value, oid)
+    end
 
-        # In case it's not a valid object
-        return nil
+    def get_anchor_value_by_asn1_sequence(obj, oid)
+      obj.each do |child_obj|
+        result = get_anchor_value_by_oid(child_obj, oid)
+        return result unless result.nil?
+      end
+      nil
     end
 
     def anchor_types
-        return { "sources" => '1.3.6.1.4.1.47127.1.1.1',
-                 "verifiers" => '1.3.6.1.4.1.47127.1.1.2',
-               }
+      { 'sources' => '1.3.6.1.4.1.47127.1.1.1',
+        'verifiers' => '1.3.6.1.4.1.47127.1.1.2' }
     end
+
+    protected
+
+    # Define whether the search function get_anchor_value_by_oid
+    # should return the next value in the array
+    attr_reader :get_next
   end
-end
+end

data/lib/yoti/util/log.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+module Yoti
+  module Log
+    class << self
+      def logger
+        @logger || create_logger(STDOUT)
+      end
+
+      def output(output_stream)
+        create_logger(output_stream)
+      end
+
+      private
+
+      def create_logger(output_stream)
+        @logger = Logger.new(output_stream)
+        @logger.progname = 'Yoti'
+        @logger
+      end
+    end
+  end
+end

data/lib/yoti/version.rb

@@ -1,4 +1,4 @@
 module Yoti
   # @return [String] the gem's current version
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/yoti.rb

@@ -15,9 +15,14 @@ require_relative 'yoti/data_type/anchor'
 require_relative 'yoti/data_type/profile'
 require_relative 'yoti/data_type/attribute'
 require_relative 'yoti/data_type/signed_time_stamp'
+require_relative 'yoti/data_type/image'
+require_relative 'yoti/data_type/image_jpeg'
+require_relative 'yoti/data_type/image_png'
+require_relative 'yoti/data_type/multi_value'
 
 require_relative 'yoti/util/age_processor'
 require_relative 'yoti/util/anchor_processor'
+require_relative 'yoti/util/log.rb'
 
 require_relative 'yoti/activity_details'
 require_relative 'yoti/client'

data/rubocop.yml

@@ -1,9 +1,11 @@
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
   Exclude:
     - 'examples/rails/config/**/*'
+    - 'lib/yoti/protobuf/attrpubapi/*'
+    - 'lib/yoti/protobuf/compubapi/*'
 
 Metrics/AbcSize:
   Max: 23
@@ -13,6 +15,7 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Exclude:
     - spec/**/**/*.rb
+    - yoti.gemspec
 
 Metrics/CyclomaticComplexity:
   Max: 9
@@ -23,6 +26,8 @@ Metrics/LineLength:
 Metrics/MethodLength:
   CountComments: false
   Max: 19
+  Exclude:
+    - spec/yoti/data_type/multi_value_spec.rb
 
 Style/Documentation:
   Enabled: false
@@ -32,3 +37,14 @@ Style/FrozenStringLiteralComment:
 
 Style/NumericLiterals:
   Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Naming/MethodName:
+  Exclude:
+    - lib/yoti/util/anchor_processor.rb
+
+Naming/PredicateName:
+  Exclude:
+    - lib/yoti/util/age_processor.rb

data/yoti.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'yoti/version'
 
@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
+  spec.add_dependency 'google-protobuf', '~> 3.7.0'
   spec.add_dependency 'protobuf', '~> 3.6'
-  spec.add_dependency 'google-protobuf', '~> 3.6.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'dotenv', '~> 2.2'
   spec.add_development_dependency 'generator_spec', '~> 0.9'
   spec.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Sebastian Zaremba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: protobuf
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
-  name: google-protobuf
+  name: protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.1
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.1
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
@@ -189,6 +190,10 @@ files:
 - lib/yoti/configuration.rb
 - lib/yoti/data_type/anchor.rb
 - lib/yoti/data_type/attribute.rb
+- lib/yoti/data_type/image.rb
+- lib/yoti/data_type/image_jpeg.rb
+- lib/yoti/data_type/image_png.rb
+- lib/yoti/data_type/multi_value.rb
 - lib/yoti/data_type/profile.rb
 - lib/yoti/data_type/signed_time_stamp.rb
 - lib/yoti/errors.rb
@@ -198,20 +203,17 @@ files:
 - lib/yoti/http/profile_request.rb
 - lib/yoti/http/request.rb
 - lib/yoti/http/signed_request.rb
-- lib/yoti/protobuf/definitions/attrpubapi/attribute.proto
-- lib/yoti/protobuf/definitions/attrpubapi/list.proto
-- lib/yoti/protobuf/definitions/attrpubapi/signing.proto
-- lib/yoti/protobuf/definitions/compubapi/encrypted_data.proto
-- lib/yoti/protobuf/definitions/compubapi/signed_time_stamp.proto
+- lib/yoti/protobuf/attrpubapi/Attribute_pb.rb
+- lib/yoti/protobuf/attrpubapi/ContentType_pb.rb
+- lib/yoti/protobuf/attrpubapi/List_pb.rb
+- lib/yoti/protobuf/attrpubapi/Signing_pb.rb
+- lib/yoti/protobuf/compubapi/EncryptedData_pb.rb
+- lib/yoti/protobuf/compubapi/SignedTimestamp_pb.rb
 - lib/yoti/protobuf/main.rb
-- lib/yoti/protobuf/v3/attrpubapi/attribute_pb.rb
-- lib/yoti/protobuf/v3/attrpubapi/list_pb.rb
-- lib/yoti/protobuf/v3/attrpubapi/signing_pb.rb
-- lib/yoti/protobuf/v3/compubapi/encrypted_data_pb.rb
-- lib/yoti/protobuf/v3/compubapi/signed_time_stamp_pb.rb
 - lib/yoti/ssl.rb
 - lib/yoti/util/age_processor.rb
 - lib/yoti/util/anchor_processor.rb
+- lib/yoti/util/log.rb
 - lib/yoti/version.rb
 - login_flow.png
 - rubocop.yml
@@ -236,8 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Yoti Ruby SDK for back-end integration.

data/lib/yoti/protobuf/definitions/attrpubapi/attribute.proto

@@ -1,52 +0,0 @@
-syntax = "proto3";
-
-package Yoti.Protobuf.attrpubapi_v3;
-
-option java_package = "com.yoti.attrpubapi_v3";
-option java_outer_classname = "AttrProto";
-
-
-// ContentType indicates how to interpret the ‘Value’ field of an Attribute.
-enum ContentType {
-	// UNDEFINED should not be seen, and is used as an error placeholder
-	// value.
-	UNDEFINED = 0;
-
-	// STRING means the value is UTF-8 encoded text.
-	STRING = 1;
-
-	// JPEG indicates a standard .jpeg image.
-	JPEG = 2;
-
-	// Date as string in RFC3339 format (YYYY-MM-DD).
-	DATE = 3;
-
-	// PNG indicates a standard .png image.
-	PNG = 4;
-}
-
-
-message Attribute {
-	string name = 1;
-
-	bytes value = 2;
-
-	ContentType content_type = 3;
-
-	repeated Anchor anchors = 4;
-}
-
-
-message Anchor {
-	bytes artifact_link = 1;
-
-	repeated bytes origin_server_certs = 2;
-
-	bytes artifact_signature = 3;
-
-	string sub_type = 4;
-
-	bytes signature = 5;
-
-	bytes signed_time_stamp = 6;
-}

data/lib/yoti/protobuf/definitions/attrpubapi/list.proto

@@ -1,27 +0,0 @@
-syntax = "proto3";
-
-package Yoti.Protobuf.attrpubapi_v3;
-
-import "Attribute.proto";
-
-option java_package = "com.yoti.attrpubapi_v3";
-option java_outer_classname = "AttrProto";
-
-
-// AttributeAndId is a simple container for holding an attribute's value
-// alongside its ID.
-message AttributeAndId {
-	Attribute attribute = 1;
-
-	bytes attribute_id = 2;
-}
-
-
-message AttributeAndIdList {
-    repeated AttributeAndId attribute_and_id_list = 1;
-}
-
-
-message AttributeList {
-    repeated Attribute attributes = 1;
-}

data/lib/yoti/protobuf/definitions/attrpubapi/signing.proto

@@ -1,23 +0,0 @@
-syntax = "proto3";
-
-package Yoti.Protobuf.attrpubapi_v3;
-
-import "Attribute.proto";
-
-option java_package = "com.yoti.attrpubapi_v3";
-option java_outer_classname = "AttrProto";
-
-
-message AttributeSigning {
-	string name = 1;
-
-	bytes value = 2;
-
-	ContentType content_type = 3;
-
-	bytes artifact_signature = 4;
-
-	string sub_type = 5;
-
-	bytes signed_time_stamp = 6;
-}

data/lib/yoti/protobuf/definitions/compubapi/encrypted_data.proto

@@ -1,15 +0,0 @@
-syntax = "proto3";
-
-package Yoti.Protobuf.compubapi_v3;
-
-option java_package = "com.yoti.compubapi_v3";
-option java_outer_classname = "EncryptedDataProto";
-
-message EncryptedData {
-    // the iv will be used in conjunction with the secret key
-    // received via other channel in order to decrypt the cipher_text
-    bytes iv = 1;
-
-    // block of bytes to be decrypted
-    bytes cipher_text = 2;
-}