ruby-common 1.0.0

data/lib/ruby-common/v5/Signature5VerifierService.rb

@@ -0,0 +1,90 @@
+require 'base64'
+require 'date'
+
+require_relative '../common/PhpUnpack.rb'
+require_relative '../common/Ipv6Utils.rb'
+require_relative '../common/Utils.rb'
+require_relative '../common/Exceptions.rb'
+require_relative './CryptMethodConstans.rb'
+require_relative './AbstractSymmetricCrypt.rb'
+require_relative './MyOpenSSL.rb'
+require_relative './OpenSSLAEAD.rb'
+require_relative './Secretbox.rb'
+require_relative './StructUnpacker.rb'
+require_relative './Secretbox.rb'
+require_relative '../common/VerifierConstants.rb'
+require_relative './Signature5VerificationResult.rb'
+require_relative './CryptFactory.rb'
+
+
+class Signature5VerifierService
+  VERSION = 5;
+  HEADER_LENGTH = 11;
+
+  def self.verifySignature(signature, user_agent, key, ip_addresses)
+    parsed = parse(signature, key)
+    verify(parsed, ip_addresses, user_agent)
+    return Signature5VerificationResult.new(parsed)
+  end
+
+  class << self
+    private
+
+
+    def parse(signature, key)
+      signature_decoded = SignatureVerifierUtils.base64_decode(signature)
+      key = SignatureVerifierUtils.base64_decode(key)
+
+      raise SignatureParseError, 'Malformed signature' if signature_decoded.bytes.length < HEADER_LENGTH;
+
+      unpack = PhpUnpack.unpack("Cversion/nlength/Jzone_id", signature_decoded);
+
+      raise SignatureParseError, 'Malformed signature' if unpack['version'].first != VERSION;
+
+      length = unpack['length'].first;
+      zone_id = unpack['zone_id'];
+
+      raise SignatureParseError, 'Truncated signature payload' if signature_decoded.bytes.length < length;
+
+      decrypted_payload = decrypt_payload(signature_decoded, key)
+      decrypted_payload['zone_id']= zone_id
+      return decrypted_payload
+    end
+
+    def decrypt_payload(signature_decoded, key)
+      crypt = CryptFactory.create_from_payload(signature_decoded)
+      decrypted_payload = crypt.decrypt_with_key(signature_decoded, key)
+      return StructUnpacker::parse_payload(decrypted_payload)
+    end
+
+    def verify(parsed, ip_addresses, user_agent)
+      matching_ip = nil
+    
+      ip_addresses.each do |ip_address|
+        if parsed['ipv4.ip']
+          if ip_address == parsed['ipv4.ip']
+            matching_ip = ip_address
+            break
+          end
+        end
+    
+        if parsed['ipv6.ip']
+          if IpV6Utils.abbreviate(parsed['ipv6.ip']) == IpV6Utils.abbreviate(ip_address)
+            matching_ip = ip_address
+            break
+          end
+        end
+      end
+    
+      raise VerifyError, 'Signature IP mismatch' if matching_ip.nil?
+      unless parsed['b.ua'] == user_agent
+        raise VerifyError, 'Signature user agent mismatch'
+      end
+
+      unless VerifierConstants::RESULTS[parsed['result'].to_i] == parsed['verdict']
+        raise VerifyError, 'Result mismatch'
+      end
+    end
+
+  end
+end

data/lib/ruby-common/v5/StructUnpacker.rb

@@ -0,0 +1,110 @@
+require_relative "../common/Exceptions.rb"
+require_relative "../common/PhpUnpack.rb"
+require_relative "./PhpUnserializer.rb"
+
+require 'msgpack' 
+require 'json'
+
+class StructUnpacker
+  SERIALIZE_HEADER = "S"
+  JSON_HEADER = "J"
+  MSG_HEADER = "M"
+  RFC3986_HEADER = "H"
+
+  def self.parse_payload(decrypted_payload)
+    header = decrypted_payload.to_s[0]
+
+    case header
+    when SERIALIZE_HEADER, "Serialize", "serialize"
+      return serialize_unpack(decrypted_payload)
+    when MSG_HEADER, "Msgpack", "msgpack"
+      return msg_unpack(decrypted_payload)
+    when JSON_HEADER, "StructJson", "json"
+      return json_unpack(decrypted_payload)
+    when RFC3986_HEADER, "StructRfc3986", "rfc3986"
+      return rfc3986_unpack(decrypted_payload)
+    else
+      raise StructParseError, "Unsupported struct class #{header}"
+    end
+  end
+
+  class << self
+    private
+
+    def serialize_unpack(buffer)
+      raise StructParseError, "Unexpected serializer type" if !buffer.to_s.start_with?(SERIALIZE_HEADER)
+
+      begin
+        payload = buffer.to_s[SERIALIZE_HEADER.length..-1]
+        return PhpUnserializer.new(payload).unserialize
+      rescue StandardError => e
+        raise StructParseError, "Error parsing Serialize struct: #{e.message}"
+      end
+    end
+
+    def json_unpack(payload)
+      begin
+        str_payload = payload.to_s[1..-1]
+        JSON.parse(str_payload)
+      rescue JSON::ParserError => e
+        raise StructParseError, "Error parsing StructJson struct: #{e.message}"
+      end
+    end
+
+    def msg_unpack(buffer)
+      begin
+        slice = buffer[1..-1] 
+        return MessagePack.unpack(slice)
+      rescue StandardError => e
+        raise StructParseError, "Error parsing MsgPack struct: #{e.message}"
+      end
+    end
+
+    def rfc3986_unpack(data)
+      begin
+        query_string = data.to_s
+        decoded = decode_url(query_string)
+        pairs = decoded.split('&')
+        result = {}
+
+        pairs.each do |pair|
+          key, value = pair.split('=', 2)
+          result[key] = value || ""
+        end
+
+        result
+      rescue StandardError => e
+        raise StructParseError, "Error parsing StructRfc3986 struct: #{e.message}"
+      end
+    end
+
+    def decode_url(encoded_url)
+      decoded_url = ""
+      i = 0
+
+      while i < encoded_url.length
+        c = encoded_url[i]
+        if c == '%'
+          if i + 2 < encoded_url.length
+            hex = encoded_url[i + 1, 2]
+            begin
+              decoded_url << [hex].pack('H*')
+              i += 3
+            rescue ArgumentError
+              decoded_url << c
+              i += 1
+            end
+          else
+            decoded_url << c
+            i += 1
+          end
+        else
+          decoded_url << c
+          i += 1
+        end
+      end
+
+      decoded_url
+    end
+  end
+end

data/lib/ruby-common/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Common
+    VERSION = "1.0.0"
+  end
+end

data/lib/ruby-common.rb

@@ -0,0 +1,7 @@
+require_relative "./ruby-common/version.rb"
+require_relative "./ruby-common/Signature4Verifier.rb"
+require_relative "./ruby-common/Signature5Verifier.rb"
+
+module RubyCommon
+  class Error < StandardError; end
+end

data/sig/ruby/common.rbs

@@ -0,0 +1,6 @@
+module Ruby
+  module Common
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ruby-common
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adrian Parzych
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 
+email:
+- adrian.parzych@iterative.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/ruby-common.rb
+- lib/ruby-common/Signature4Verifier.rb
+- lib/ruby-common/Signature5Verifier.rb
+- lib/ruby-common/common/Exceptions.rb
+- lib/ruby-common/common/Ipv6Utils.rb
+- lib/ruby-common/common/PhpUnpack.rb
+- lib/ruby-common/common/Utils.rb
+- lib/ruby-common/common/VerifierConstants.rb
+- lib/ruby-common/v4/AsymmetricOpenSSL.rb
+- lib/ruby-common/v4/Signature4VerificationResult.rb
+- lib/ruby-common/v4/Signature4VerifierService.rb
+- lib/ruby-common/v5/AbstractSymmetricCrypt.rb
+- lib/ruby-common/v5/CryptFactory.rb
+- lib/ruby-common/v5/CryptMethodConstans.rb
+- lib/ruby-common/v5/DecryptResult.rb
+- lib/ruby-common/v5/MyOpenSSL.rb
+- lib/ruby-common/v5/OpenSSLAEAD.rb
+- lib/ruby-common/v5/PhpUnserializer.rb
+- lib/ruby-common/v5/Secretbox.rb
+- lib/ruby-common/v5/Signature5VerificationResult.rb
+- lib/ruby-common/v5/Signature5VerifierService.rb
+- lib/ruby-common/v5/StructUnpacker.rb
+- lib/ruby-common/version.rb
+- sig/ruby/common.rbs
+homepage: https://docs.adscore.com/js-api/#signature-verification.html
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.adscore.com/
+  source_code_uri: https://github.com/Adscore/ruby-common
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: This library provides various utilities for parsing [Adscore](https://adscore.com)
+  signatures v4 and v5, and virtually anything that might be useful for customers
+  doing server-side integration with the service.
+test_files: []