silkey-sdk 0.0.1

data/lib/silkey/registry_contract/registry_contract.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Silkey # :nodoc: all
+  class RegistryContract
+    CONTRACT_NAME = 'RegistryContractInstance'
+
+    class << self
+      def get_address(name)
+        new.get_address(name)
+      end
+    end
+
+    attr_reader :contract
+
+    delegate :call, to: :contract, prefix: true
+
+    def initialize(params = {})
+      @contract = ContractFactory.call(default_params.merge(params))
+    end
+
+    def get_address(name)
+      Silkey::Utils.add0x(contract_call.get_address(name))
+    end
+
+    def default_params
+      {
+        name: CONTRACT_NAME,
+        address: Configuration.registry_contract_address,
+        abi: Configuration.registry_contract_abi,
+      }.freeze
+    end
+  end
+end

data/lib/silkey/sdk.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Silkey
+  class SDK
+    class << self
+
+      ##
+      # Generates message to sign based on plain object data (keys => values)
+      #
+      # @param [Hash]
+      #
+      # @return [string]
+      #
+      # @example:
+      #
+      #   Silkey::SDK.message_to_sign({ redirectUrl: 'http://silkey.io', refId: 1 });
+      #
+      # returns
+      #
+      #   'redirectUrl=http://silkey.io::refId=1'
+      #
+      def message_to_sign(hash = {})
+        msg = []
+        hash.keys.sort.each do |k|
+          if Silkey::Utils.empty?(hash[k])
+            msg.push("#{k}=")
+          else
+            msg.push("#{k}=#{hash[k]}")
+          end
+        end
+
+        msg.join('::')
+      end
+
+      ##
+      # Generates all needed parameters (including signature) for requesting Silkey SSO
+      #
+      # @param [string] private key of domain owner
+      #
+      # @param [Hash] Hash with data: {redirectUrl*, cancelUrl*, refId, scope, ssoTimestamp*}
+      # marked with * are required by Silkey SSO
+      #
+      # @return [Hash] {{signature, ssoTimestamp, redirectUrl, refId, scope}}
+      #
+      # @example
+      #
+      #   Silkey::SDK.generate_sso_request_params(private_key, data)
+      #
+      def generate_sso_request_params(private_key, hash)
+        redirect_url = hash[:redirectUrl] || ''
+        cancel_url = hash[:cancelUrl] || ''
+        sso_timestamp = hash[:ssoTimestamp] || Silkey::Utils.current_timestamp
+        ref_id = hash[:refId] || ''
+        scope = hash[:scope] || ''
+
+        message = message_to_sign({
+                                    redirectUrl: redirect_url,
+                                    cancelUrl: cancel_url,
+                                    ssoTimestamp: sso_timestamp,
+                                    refId: ref_id,
+                                    scope: scope
+                                  })
+
+        {
+          signature: Silkey::Utils.sign_message(private_key, message),
+          ssoTimestamp: sso_timestamp,
+          redirectUrl: redirect_url,
+          cancelUrl: cancel_url,
+          refId: ref_id,
+          scope: scope
+        }
+      end
+
+      ##
+      # Verifies JWT token payload
+      #
+      # @see https://jwt.io/ for details about token payload data
+      #
+      # @param [string] JWT token returned by Silkey
+      #
+      # @param [string] silkeyPublicKey public ethereum address of Silkey
+      #
+      # @return [JwtPayload|null] null when signature(s) are invalid, otherwise token payload
+      #
+      # @throws when token is invalid or data are corrupted
+      #
+      # @example
+      #
+      #   Silkey::SDK.token_payload_verifier(
+      #     'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
+      #     Silkey::SDK.fetch_silkey_public_key
+      #   )
+      #
+      def token_payload_verifier(token, silkey_public_key = nil)
+        payload = token_payload(token)
+
+        if silkey_signature_valid?(payload, silkey_public_key) != false &&
+           user_signature_valid?(payload) != false
+          return Silkey::Models::JwtPayload.new.import(payload)
+        end
+
+        nil
+      rescue
+        nil
+      end
+
+      ##
+      # Fetches public ethereum Silkey address (directly from blockchain).
+      # This address can be used for token verification
+      #
+      # @param [string] providerUri ie: 'https://infura.io/v3/:infuraId' register to infura.io to get infuraId
+      #
+      # @param [string] address of silkey smart contract registry
+      #
+      # @return [string] public ethereum address of silkey signer
+      #
+      # @see List of Silkey contracts addresses: https://github.com/Silkey-Team/silkey-sdk#silkey-sdk
+      #
+      def fetch_silkey_public_key
+        public_key = Silkey::RegistryContract.get_address('Hades')
+
+        raise "Invalid public key: #{public_key}" unless Silkey::Utils.ethereum_address?(public_key)
+
+        public_key
+      end
+
+      private
+
+      def token_payload(token)
+        # Set password to nil and validation to false otherwise this won't work
+        decoded = JWT.decode token, nil, false
+        decoded[0]
+      end
+
+      def user_signature_valid?(payload)
+        jwt_payload = Silkey::Models::JwtPayload.new.import(payload)
+        utils = Silkey::Utils
+
+        if utils.empty?(jwt_payload.address) ||
+           utils.empty?(jwt_payload.user_signature) ||
+           utils.empty?(jwt_payload.user_signature_timestamp)
+          logger.warn('Verification failed, missing user signature/timestamp and/or address')
+          return false
+        end
+
+        signer = Silkey::Utils
+                 .verify_message(jwt_payload.message_to_sign_by_user, jwt_payload.user_signature)
+
+        success = signer == jwt_payload.address
+
+        unless success
+          logger.warn("user_signature_valid?: expect #{signer} to be equal #{jwt_payload.address}")
+        end
+
+        success
+      rescue StandardError => e
+        logger.error(e)
+        false
+      end
+
+      def silkey_signature_valid?(payload, silkey_public_key)
+        jwt_payload = Silkey::Models::JwtPayload.new.import(payload)
+        utils = Silkey::Utils
+
+        if utils.empty?(jwt_payload.email) && utils.empty?(jwt_payload.silkey_signature)
+          return nil
+        end
+
+        if utils.empty?(jwt_payload.email) ^ utils.empty?(jwt_payload.silkey_signature)
+          logger.warn('Verification failed, missing silkey signature or email')
+          return false
+        end
+
+        if utils.empty?(jwt_payload.silkey_signature_timestamp)
+          logger.warn('Verification failed, missing silkey signature timestamp')
+          return false
+        end
+
+        signer = Silkey::Utils.verify_message(
+          jwt_payload.message_to_sign_by_silkey, jwt_payload.silkey_signature
+        )
+
+        if Silkey::Utils.empty?(silkey_public_key)
+          logger.warn('You are using verification without checking silkey signature. '\
+                      'We strongly recommended to turn on full verification. '\
+                      'This option can be deprecated in the future')
+          return true
+        end
+
+        success = signer == silkey_public_key
+
+        unless success
+          logger.warn("silkey_signature_valid?: expect #{signer} to be equal #{silkey_public_key}")
+        end
+
+        success
+      rescue StandardError => e
+        logger.error(e)
+        false
+      end
+
+      def logger
+        Silkey::LoggerService
+      end
+    end
+  end
+end

data/lib/silkey/services/logger_service.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Silkey # :nodoc: all
+  class LoggerService
+    class << self
+      delegate :info, :debug, :error, :warn, to: :logger
+
+      def logger
+        if @logger.nil?
+          @logger = Logger.new(STDOUT)
+          @logger.level = Logger::INFO
+          @logger.datetime_format = '%a %d-%m-%Y %H%M '
+        end
+
+        @logger
+      end
+    end
+  end
+end

data/lib/silkey/utils.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Silkey
+  class Utils
+    class << self
+      def empty?(string)
+        string.nil? || string.to_s == ''
+      end
+
+      def remove0x(string)
+        string.to_s.sub('0x', '')
+      end
+
+      def add0x(string)
+        return string if string.to_s[0..1] == '0x'
+
+        "0x#{string}"
+      end
+
+      def hex?(string)
+        return false if empty?(string)
+
+        !remove0x(string)[/\H/]
+      end
+
+      def str_to_bytes32(string)
+        return '' if empty?(string)
+
+        hex = string.to_s.unpack('H*')[0]
+        "0x#{hex}#{['0'].cycle(64 - hex.length).to_a.join('')}"
+      end
+
+      def empty_hex?(string)
+        return true if empty?(string)
+        return false unless hex?(string)
+
+        !remove0x(string).split('').reduce(false) { |non_zero, c| c != '0' || non_zero }
+      end
+
+      def private_key?(string)
+        hex_and_length?(string, 64)
+      end
+
+      def ethereum_address?(string)
+        hex_and_length?(string, 40)
+      end
+
+      def signature?(string)
+        hex_and_length?(string, 130)
+      end
+
+      def current_timestamp
+        Time.now.getutc.to_i
+      end
+
+      def int_to_hex(int)
+        return '' if empty?(int)
+
+        hex = int.to_i.to_s(16)
+
+        return hex if hex.length.even?
+
+        "0#{hex}"
+      end
+
+      def strings_to_hex(arr)
+        arr.map { |str| str.to_s.unpack('H*') }.join('')
+      end
+
+      def sign_message(private_key, message)
+        wallet = Eth::Key.new priv: Silkey::Utils.remove0x(private_key)
+        wallet.personal_sign(message)
+      end
+
+      def sign_plain_message(private_key, message)
+        wallet = Eth::Key.new priv: Silkey::Utils.remove0x(private_key)
+        bin_signature = wallet.sign(message)
+        Eth::Utils.bin_to_hex(bin_signature)
+      end
+
+      def verify_message(message, signature)
+        public_key = Eth::Key.personal_recover(message, signature)
+        return nil if public_key.nil?
+
+        Eth::Utils.public_key_to_address(public_key)
+      end
+
+      def verify_plain_message(message, signature)
+        bin_signature = Eth::Utils.hex_to_bin(signature)
+        hash = Eth::Utils.keccak256(message)
+        public_key = Eth::OpenSsl.recover_compact(hash, bin_signature)
+        return nil if public_key.nil?
+
+        Eth::Utils.public_key_to_address(public_key)
+      end
+
+      private
+
+      def hex_and_length?(string, len)
+        return false if empty_hex?(string)
+        return false unless hex?(string)
+
+        remove0x(string).length == len
+      end
+    end
+  end
+end

data/lib/silkey/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Silkey
+  VERSION = '0.0.1'
+end

data/lib/silkey_sdk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'silkey-sdk'

data/silkey-sdk.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silkey/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.6'
+  spec.name = 'silkey-sdk'
+  spec.version = Silkey::VERSION
+  spec.authors = ['silkey.io']
+  spec.email = ['dariusz@silkey.io']
+
+  spec.summary = 'Silkey SDK for Ruby.'
+  spec.homepage = 'https://github.com/Silkey-Team/ruby-sdk'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activesupport', '~> 6.0'
+  spec.add_dependency 'jwt', '~> 2.2.2'
+  spec.add_dependency 'eth', '~> 0.4.12'
+  spec.add_dependency 'ethereum.rb', '~> 2.5'
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'virtus_convert', '~> 0.1'
+  spec.add_development_dependency 'rdoc', '~> 6.2', '>= 6.2.1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'factory_bot', '~> 6.1'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.3'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8'
+end

metadata

@@ -0,0 +1,332 @@
+--- !ruby/object:Gem::Specification
+name: silkey-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- silkey.io
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: eth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.12
+- !ruby/object:Gem::Dependency
+  name: ethereum.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: virtus_convert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description:
+email:
+- dariusz@silkey.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- DEVELOPMENT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doc/CHANGELOG_md.html
+- doc/LICENSE_txt.html
+- doc/Object.html
+- doc/README_md.html
+- doc/Silkey.html
+- doc/Silkey/ClientFactory.html
+- doc/Silkey/Configuration.html
+- doc/Silkey/Contract.html
+- doc/Silkey/Contract/FrozenArray.html
+- doc/Silkey/ContractFactory.html
+- doc/Silkey/LoggerService.html
+- doc/Silkey/Models.html
+- doc/Silkey/Models/JwtPayload.html
+- doc/Silkey/RegistryContract.html
+- doc/Silkey/SDK.html
+- doc/Silkey/Utils.html
+- doc/created.rid
+- doc/css/fonts.css
+- doc/css/rdoc.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/navigation.js
+- doc/js/navigation.js.gz
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/search_index.js.gz
+- doc/js/searcher.js
+- doc/js/searcher.js.gz
+- doc/table_of_contents.html
+- lib/silkey-sdk.rb
+- lib/silkey.rb
+- lib/silkey/abi/registry_contract_abi.json
+- lib/silkey/configuration.rb
+- lib/silkey/contract.rb
+- lib/silkey/factories/client_factory.rb
+- lib/silkey/factories/contract_factory.rb
+- lib/silkey/models/jwt_payload.rb
+- lib/silkey/registry_contract/registry_contract.rb
+- lib/silkey/sdk.rb
+- lib/silkey/services/logger_service.rb
+- lib/silkey/utils.rb
+- lib/silkey/version.rb
+- lib/silkey_sdk.rb
+- silkey-sdk.gemspec
+homepage: https://github.com/Silkey-Team/ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Silkey SDK for Ruby.
+test_files: []