geetest_ruby_sdk 4.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4f67d9fe2e2bbb890315f13c0214eed4701469d9ec0d44f83dc5b27857e5e68
+  data.tar.gz: 1e036fc6881bd36939e8906e7d654de5c3a1c3a5b8a18622b2235ef60faa9bfc
+SHA512:
+  metadata.gz: 0af8da7eab3fe0bcda683c48b5e0a5684c889374ba94cd6da3b7a747fccb360054c88deef110f3d4d108d8aafb31daaa21df57153c6b9305919b27024635086e
+  data.tar.gz: 66094c37b4d7dd3b9e636b89851a3bfaf9aa8d2c86c7ee5dec32e6e918ee3b00adb3515e40a2ff61245e3cbb24b226e700005dd2a9a5f133caf57314fe6cbdd9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/.idea
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/tags
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# https://github.com/bbatsov/rubocop/blob/master/config/disabled.yml
+# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/**/*'
+    - 'test/**/*'
+    - 'bin/console'
+    - 'bin/setup'
+    - 'Rakefile'
+    - 'lib/geetest_ruby_sdk/version.rb'
+
+# This cop checks whether the source file has a utf-8 encoding comment or not.
+# This check makes sense only for code that should support Ruby 1.9,
+# since in 2.0+ utf-8 is the default source file encoding.
+Style/Encoding:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at huayuehao@jinshuju.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geetest_ruby_sdk.gemspec
+gemspec
+
+gem 'logger'
+gem 'openssl', '~> 2.2'
+gem 'rest-client'
+
+group :test do
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.25', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'webmock'
+  gem 'timecop'
+end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    geetest_ruby_sdk (4.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    ipaddr (1.2.4)
+    logger (1.5.1)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    netrc (0.11.0)
+    openssl (2.2.2)
+      ipaddr
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    timecop (0.9.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  geetest_ruby_sdk!
+  logger
+  openssl (~> 2.2)
+  rake (~> 12.0)
+  rest-client
+  rspec (~> 3.0)
+  rubocop (~> 1.25)
+  rubocop-rspec
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Yuehao Hua
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# GeetestRubySdk
+
+This is A gem for Geetest SDK using Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geetest_ruby_sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install geetest_ruby_sdk
+
+## Usage
+
+This is A gem for Geetest SDK using Ruby
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/geetest_ruby_sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/geetest_ruby_sdk/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GeetestRubySdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/geetest_ruby_sdk/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geetest_ruby_sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/geetest_ruby_sdk.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/geetest_ruby_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'geetest_ruby_sdk'
+  spec.version = GeetestRubySdk::VERSION
+  spec.authors = ['Yuehao Hua', 'Yii Chou']
+  spec.email = ['huayuehao@jinshuju.net, zhouyi@jinshuju,net']
+
+  spec.summary = 'Ruby version of Geetest SDK'
+  spec.homepage = 'https://github.com/jinshuju/geetest-ruby-sdk'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jinshuju/geetest-ruby-sdk'
+  spec.metadata['changelog_uri'] = 'https://github.com/jinshuju/geetest-ruby-sdk'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/geetest/encryptor.rb

@@ -0,0 +1,79 @@
+require 'openssl'
+
+module Geetest
+  # This class is used internally by Geetest to encrypt message
+  # It prefers to be used with chain methods
+  #
+  #  Encryptor.encrypt(string).with(secret).by(digest_mod).to_s
+  #
+  # chain methods
+  # * :encrypt(string) => the message to be encrypted
+  # * :by(digest_mod) => encrypt mode
+  # * :with(secret) => secret_key used by #to_challenge/#to_validate and hmac_sha256 encryption
+  #
+  # return methods
+  # * :to_challenge => generate a geetest challenge string
+  # * :to_validate => generate a geetest validate string
+  # * :to_s => just digest the given string by given digest_mod
+  #
+  # assert methods
+  # * :eq?(string)
+  #
+  class Encryptor
+
+    def self.encrypt(str)
+      new.encrypt(str)
+    end
+
+    def encrypt(str)
+      @str = str.to_s
+      self
+    end
+
+    def with(secret)
+      @secret = secret.to_s
+      self
+    end
+
+    def by(digest_mod)
+      @digest_mod = digest_mod.to_s
+      self
+    end
+
+    def to_challenge
+      return if @str.to_s.empty? || @secret.to_s.empty?
+
+      hexdigest(@str + @secret)
+    end
+
+    def to_validate
+      return if @str.to_s.empty? || @secret.to_s.empty?
+
+      hexdigest(@secret + 'geetest' + @str)
+    end
+
+    def to_s
+      return if @str.to_s.empty?
+
+      hexdigest(@str)
+    end
+    alias inspect to_s
+
+    def eq?(string)
+      self.to_s == string
+    end
+
+    private
+
+    def hexdigest(payload)
+      case @digest_mod
+      when 'sha256'
+        OpenSSL::Digest::SHA256.hexdigest payload
+      when 'hmac_sha256'
+        OpenSSL::HMAC.hexdigest('SHA256', @secret, payload)
+      else
+        OpenSSL::Digest::MD5.hexdigest payload
+      end
+    end
+  end
+end

data/lib/geetest/v3/account.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Geetest
+  module V3
+    # This class is used internally by Geetest to send the request
+    # Mandatory parameters to initialize an instance:
+    # * :captcha_id
+    # * :captcha_key
+    #
+    # => register: to register a geetest service
+    # Optional parameters
+    # * :digest_mod => encrypt mode
+    # * :options => some options for callback like user_name, password
+    #
+    # => validate?: to validate if the geetest is success
+    # Required parameters
+    # * :challenge => the code from client generated by geetest
+    # * :validate => the code from client generated by geetest
+    # * :seccode => the code from client generated by geetest
+    # Optional parameters
+    # * :digest_mod => encrypt mode
+    # * :options => some options for callback like user_name, password
+    class Account
+      BASE_URL = 'http://api.geetest.com'
+      JSON_FORMAT = '1'
+      DEFAULT_DIGEST_MOD = 'md5'
+
+      attr_accessor :captcha_id, :captcha_key, :digest_mod
+
+      def initialize(captcha_id, captcha_key, **options)
+        @captcha_id = captcha_id
+        @captcha_key = captcha_key
+        @digest_mod = options.fetch(:digest_mod, Account::DEFAULT_DIGEST_MOD)
+      end
+
+      def register(**options)
+        Register.new(account: self).register(options)
+      end
+
+      def validate?(challenge: nil, validate: nil, seccode: nil, **options)
+        Validator.new(account: self).valid?(challenge, validate, seccode, options)
+      end
+    end
+  end
+end

data/lib/geetest/v3/concerns/degraded_mode.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Geetest
+  module V3
+    # Create and validate a challenge under degraded model
+    # When a degraded_challenge is created, it will keep valid at least in 21.6 minutes and no more than 43.2 minutes
+    # 21.6 = 36 * 36 / 60 (that means the last 2 chars of base36 timestamp)
+    # By default, the validity of geetest challenge is 10 minutes, so 21.6 minutes is enough in degraded model.
+    module DegradedMode
+      CHALLENGE_LENGTH = 32
+
+      def degraded_challenge
+        timestamp = Time.now.to_i.to_s(36)
+        index = rand(20..26)
+        random = [*'a'..'z', *'0'..'9'].sample(6).join
+        sha = Encryptor.encrypt(timestamp).with(account.captcha_key).by(digest_mod).to_challenge
+        (sha[0,index] + timestamp).ljust(CHALLENGE_LENGTH, random)
+      end
+
+      def degraded?(challenge)
+        return false unless challenge.length == CHALLENGE_LENGTH
+
+        valid_marks = [Time.now.to_i, Time.now.to_i - 36 * 36].map { |t| t.to_s(36)[0,4] }
+        valid_marks.any? do |mark|
+          index = challenge.index(mark)
+          next unless (20..26).include?(index)
+
+          timestamp = challenge[index,6]
+          sha = Encryptor.encrypt(timestamp).with(account.captcha_key).by(digest_mod).to_challenge
+          sha[0, index] == challenge[0, index]
+        end
+      end
+    end
+  end
+end

data/lib/geetest/v3/register.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Geetest
+  module V3
+    # This class is used internally by Geetest to send a register request
+    # => register: to send a get request to geetest service and return a valid result
+    # parameters
+    # * :options => some options for callback like user_name, password
+    class Register
+      include DegradedMode
+
+      REGISTER_URL = '/register.php'.freeze
+
+      attr_reader :account, :digest_mod, :response
+
+      def initialize(account:, digest_mod: nil)
+        @account = account
+        @digest_mod = digest_mod || account.digest_mod
+      end
+
+      def register(**options)
+        payload = { gt: account.captcha_id }
+        options = { json_format: Account::JSON_FORMAT }.merge options.transform_keys(&:to_sym)
+        @response = request! payload, options
+        on_remote_mode
+      rescue *Geetest.exceptions_to_degraded_mode => e
+        Geetest.logger.info "Geetest register request failed for #{e.message}, fall back to degraded mode"
+        on_degraded_mode
+      end
+
+      private
+
+      def request!(payload, options = {})
+        response = RestClient.get "#{Account::BASE_URL}#{REGISTER_URL}", params: payload.merge(options)
+        JSON.parse response.body
+      end
+
+      def on_remote_mode
+        {
+          success: 1,
+          gt: account.captcha_id,
+          challenge: Encryptor.encrypt(@response['challenge']).with(account.captcha_key).by(digest_mod).to_challenge
+        }
+      end
+
+      def on_degraded_mode
+        {
+          success: 0,
+          gt: account.captcha_id,
+          challenge: degraded_challenge
+        }
+      end
+    end
+  end
+end

data/lib/geetest/v3/validator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Geetest
+  module V3
+    # This class is used internally by Geetest to validate by request or local
+    # => valid?: to send a post request to geetest service and return if a geetest is valid
+    # parameters
+    # * :challenge
+    # * :validate
+    # * :seccode
+    # * :options => some options for callback like user_name, password
+    class Validator
+      include DegradedMode
+
+      VALIDATE_URL = '/validate.php'
+
+      attr_reader :account, :digest_mod, :response
+
+      def initialize(account:, digest_mod: nil)
+        @account = account
+        @digest_mod = digest_mod || account.digest_mod
+      end
+
+      def valid?(challenge, validate, seccode, **options)
+        return false if validate.to_s.empty? || challenge.to_s.empty?
+
+        degraded?(challenge) ? degraded_valid?(challenge, validate) : remote_valid?(challenge, validate, seccode, options)
+      end
+
+      private
+
+      def degraded_valid?(challenge, validate)
+        Encryptor.encrypt(challenge).by(digest_mod).eq? validate
+      end
+
+      def remote_valid?(challenge, validate, seccode, options)
+        return false if seccode.to_s.empty?
+        return false unless validate == Encryptor.encrypt(challenge).with(account.captcha_key).by(digest_mod).to_validate
+
+        remote_seccode_valid?(challenge, validate, seccode, **options)
+      end
+
+      def remote_seccode_valid?(challenge, validate, seccode, **options)
+        payload = { challenge: challenge, validate: validate, seccode: seccode }
+        options = { json_format: Account::JSON_FORMAT }.merge options.transform_keys(&:to_sym)
+        @response = request! payload, options
+
+        Encryptor.encrypt(seccode).with(account.captcha_key).by(digest_mod).eq? @response['seccode']
+      end
+
+      def request!(payload, options = {})
+        response = RestClient.post "#{Account::BASE_URL}#{VALIDATE_URL}", payload.merge(options)
+        JSON.parse response.body
+      end
+    end
+  end
+end