daqing_rucaptcha 3.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2b719f287469ecff61b9845fb21e08569ac0681120edf027f4d90a7f18b4da4
+  data.tar.gz: c8dde4c9dc2d489a4ef528355821f83a42872d46cfe3910e2bb72deea9268822
+SHA512:
+  metadata.gz: 0e26b2885cdc74f804fd84656a4856de80f589e882073226fd5c833195222284b8eea24d906cde2c8898bc8cdb15469ff885e175de45113d7c41405287758518
+  data.tar.gz: a76c9929abd65c502748cd62dbcc44a61c37840d8ea0445abdbc1c5dd5b87bd4d2ff0f28c3e1492343f70678614ae8a0143f85cc975143ecbbde90787b6f536f

data/README.md

@@ -0,0 +1,188 @@
+# RuCaptcha
+
+[![Gem Version](https://badge.fury.io/rb/rucaptcha.svg)](https://badge.fury.io/rb/rucaptcha)
+[![build](https://github.com/huacnlee/rucaptcha/workflows/build/badge.svg)](https://github.com/huacnlee/rucaptcha/actions?query=workflow%3Abuild)
+
+Captcha Gem for Rails, which generates captcha image by Rust.
+
+> NOTE: According to the use of Ruby China, the verification code looks like has a lower than 5% probability of being parsed by OCR and the verification code is cracked (All Image Captcha libs are has same problem). It is recommended that you use the IP rate limit to enhance the protection.
+> NOTE: 以 Ruby China 的使用来看，验证码似乎有低于 5% 的概率被 OCR 读取解析 (图片验证码都有这个问题) 导致验证码被破解（我们从日志分析绝大多数是成功的，但偶尔一个成功，配合大量机器攻击，导致注册了很多的垃圾账号），建议你额外配合 IP 频率限制的功能来加强保护。
+
+> 如果你需要更高强度的验证，建议选择商用服务。
+
+[中文介绍和使用说明](https://ruby-china.org/topics/27832)
+
+## Example
+
+<img src="https://user-images.githubusercontent.com/5518/196329734-fee49f62-050b-44c8-a5a8-7ffdd3c5a3f6.png" height="50" alt="0"> <img src="https://user-images.githubusercontent.com/5518/196329738-64b264a1-e3fb-4804-ac46-0df18fb31d1e.png" height="50" alt="1"> <img src="https://user-images.githubusercontent.com/5518/196329740-e10ded26-ba46-4e9b-93b8-ce30c198f880.png" height="50" alt="2"> <img src="https://user-images.githubusercontent.com/5518/196329743-c7b055b8-b309-4554-8c95-66c5caf4437d.png" height="50" alt="3"> <img src="https://user-images.githubusercontent.com/5518/196329745-eb68f0c3-ccac-4fa3-aa7a-cc4c2caeb41e.png" height="50" alt="4"> <img src="https://user-images.githubusercontent.com/5518/196329746-b15a9f71-262e-4699-87c7-a5561c6caf2c.png" height="50" alt="5"> <img src="https://user-images.githubusercontent.com/5518/196329747-d111a5d3-89a1-487b-989e-5be8059488c2.png" height="50" alt="6"> <img src="https://user-images.githubusercontent.com/5518/196329749-2cb44aa3-8b59-427c-91f3-59566d6de8a5.png" height="50" alt="7"> <img src="https://user-images.githubusercontent.com/5518/196329754-ae64374b-f2e5-44b8-a7f4-3aee1405c193.png" height="50" alt="8"> <img src="https://user-images.githubusercontent.com/5518/196329755-26b88705-bf34-4d32-a4dc-076530582a90.png" height="50" alt="9">
+
+## Feature
+
+- Native Gem base on Rust.
+- For Rails Application;
+- Simple, Easy to use;
+- High performance.
+
+## Usage
+
+Put rucaptcha in your `Gemfile`:
+
+```
+gem 'rucaptcha'
+```
+
+Create `config/initializers/rucaptcha.rb`
+
+```rb
+RuCaptcha.configure do
+  # Custom captcha code expire time if you need, default: 2 minutes
+  # self.expires_in = 120
+
+  # [Requirement / 重要]
+  # Store Captcha code where, this config more like Rails config.cache_store
+  # default: Read config info from `Rails.application.config.cache_store`
+  # But RuCaptcha requirements cache_store not in [:null_store, :memory_store, :file_store]
+  # 默认：会从 Rails 配置的 cache_store 里面读取相同的配置信息，并尝试用可以运行的方式，用于存储验证码字符
+  # 但如果是 [:null_store, :memory_store, :file_store] 之类的，你可以通过下面的配置项单独给 RuCaptcha 配置 cache_store
+  self.cache_store = :mem_cache_store
+
+  # If you wants disable `cache_store` check warning, you can do it, default: false
+  # 如果想要 disable cache_store 的 warning，就设置为 true，default false
+  # self.skip_cache_store_check = true
+
+  # Chars length, default: 5, allows: [3 - 7]
+  # self.length = 5
+
+  # Enable or disable Strikethrough, default: true
+  # self.line = true
+
+  # Enable or disable noise, default: false
+  # self.noise = false
+
+  # Set the image format, default: png, allows: [jpeg, png, webp]
+  # self.format = 'png'
+end
+```
+
+RuCaptcha 没有使用 Rails Session 来存储验证码信息，因为 Rails 的默认 Session 是存储在 Cookie 里面，如果验证码存在里面会存在 [Replay attack](https://en.wikipedia.org/wiki/Replay_attack) 漏洞，导致验证码关卡被攻破。
+
+所以我在设计上要求 RuCaptcha 得配置一个可以支持分布式的后端存储方案例如：Memcached 或 Redis 以及其他可以支持分布式的 cache_store 方案。
+
+同时，为了保障易用性，默认会尝试使用 `:file_store` 的方式，将验证码存在应用程序的 `tmp/cache/rucaptcha/session` 目录（但请注意，多机器部署这样是无法正常运作的）。
+
+所以，我建议大家使用的时候，配置上 `cache_store` （详见 [Rails Guides 缓存配置部分](https://ruby-china.github.io/rails-guides/caching_with_rails.html#%E9%85%8D%E7%BD%AE)的文档）到一个 Memcached 或 Redis，这才是最佳实践。
+
+#
+
+(RuCaptha do not use Rails Session to store captcha information. As the default session is stored in Cookie in Rails, there's a [Replay attack](https://en.wikipedia.org/wiki/Replay_attack) bug which may causes capthcha being destroyed if we store captcha in Rails Session.
+
+So in my design I require RuCaptcha to configure a distributed backend storage scheme, such as Memcached, Redis or other cache_store schemes which support distribution.
+
+Meanwhile, for the ease of use, RuCapthca would try to use `:file_store` by default and store the capthca in `tmp/cache/rucaptcha/session` directory (kindly note that it's not working if deploy on multiple machine).
+
+For recommendation, configure the `cache_store`（more details on [Rails Guides Configuration of Cache Stores](http://guides.rubyonrails.org/caching_with_rails.html#configuration)） to Memcached or Redis, that would be the best practice.)
+
+#
+
+Controller `app/controller/account_controller.rb`
+
+When you called `verify_rucaptcha?`, it uses value from `params[:_rucaptcha]` to validate.
+
+```rb
+class AccountController < ApplicationController
+  def create
+    @user = User.new(params[:user])
+    if verify_rucaptcha?(@user) && @user.save
+      redirect_to root_path, notice: 'Sign up successed.'
+    else
+      render 'account/new'
+    end
+  end
+end
+
+class ForgotPasswordController < ApplicationController
+  def create
+    # without any args
+    if verify_rucaptcha?
+      to_send_email
+    else
+      redirect_to '/forgot-password', alert: 'Invalid captcha code.'
+    end
+  end
+end
+```
+
+> TIP: Sometimes you may need to keep last verified captcha code in session on `verify_rucaptcha?` method call, you can use `keep_session: true`. For example: `verify_rucaptcha? @user, keep_session: true`.
+
+View `app/views/account/new.html.erb`
+
+```erb
+<form method="POST">
+  ...
+  <div class="form-group">
+    <%= rucaptcha_input_tag(class: 'form-control', placeholder: 'Input Captcha') %>
+    <%= rucaptcha_image_tag(alt: 'Captcha') %>
+  </div>
+  ...
+
+  <div class="form-group">
+    <button type="submit" class="btn btn-primary">Submit</button>
+  </div>
+</form>
+```
+
+And if you are using [Devise](https://github.com/plataformatec/devise), you can read this reference to add validation: [RuCaptcha with Devise](https://github.com/huacnlee/rucaptcha/wiki/Working-with-Devise).
+
+### Write your test skip captcha validation
+
+for RSpec
+
+```rb
+describe 'sign up and login', type: :feature do
+  before do
+    allow_any_instance_of(ActionController::Base).to receive(:verify_rucaptcha?).and_return(true)
+  end
+
+  it { ... }
+end
+```
+
+for MiniTest
+
+```rb
+class ActionDispatch::IntegrationTest
+  def sign_in(user)
+    ActionController::Base.any_instance.stubs(:verify_rucaptcha?).returns(true)
+    post user_session_path \
+         'user[email]'    => user.email,
+         'user[password]' => user.password
+  end
+end
+```
+
+### Invalid message without Devise
+
+When you are using this gem without Devise, you may find out that the invalid message is missing.
+For this case, use the trick below to add your i18n invalid message manually.
+
+```rb
+if verify_rucaptcha?(@user) && @user.save
+  do_whatever_you_want
+  redirect_to someplace_you_want
+else
+  # this is the trick
+  @user.errors.add(:base, t('rucaptcha.invalid'))
+  render :new
+end
+```
+
+## Performance
+
+`rake benchmark` to run benchmark test.
+
+```
+Warming up --------------------------------------
+      Generate image    51.000  i/100ms
+Calculating -------------------------------------
+      Generate image    526.350  (± 2.5%) i/s -      2.652k in   5.041681s
+```

data/Rakefile

@@ -0,0 +1,71 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+require "rubygems/package_task"
+require "bundler"
+
+CROSS_PLATFORMS = %w[
+  aarch64-linux
+  arm64-darwin
+  x64-mingw32
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-musl
+]
+
+spec = Bundler.load_gemspec("rucaptcha.gemspec")
+
+Gem::PackageTask.new(spec).define
+
+Rake::ExtensionTask.new("rucaptcha", spec) do |ext|
+  ext.lib_dir = "lib/rucaptcha"
+  ext.source_pattern = "*.{rs,toml}"
+  ext.cross_compile = true
+  ext.cross_platform = CROSS_PLATFORMS
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+def create_captcha(length = 5, difficulty = 5)
+  require "rucaptcha"
+  RuCaptchaCore.create(length, difficulty, false, false, "png")
+end
+
+task :preview do
+  require "rucaptcha"
+  res = create_captcha()
+  warn "-------------------------\n#{res[0]}"
+  puts res[1].pack("c*")
+end
+
+task :memory do
+  require "rucaptcha"
+  require "memory_profiler"
+
+  create_captcha()
+
+  report = MemoryProfiler.report do
+    1000.times do
+      create_captcha()
+    end
+  end
+
+  GC.start
+  report.pretty_print
+
+  puts "------------------------- Result Guide -------------------------"
+  puts "If [Total retained] have any bytes, there will have memory leak."
+end
+
+task :benchmark do
+  require "rucaptcha"
+  require "benchmark/ips"
+
+  RuCaptchaCore.create(5, 5, true, true, "png")
+
+  Benchmark.ips do |x|
+    x.report("Generate image") { RuCaptchaCore.create(5, 5, true, true, "png") }
+    x.compare!
+  end
+end

data/app/controllers/ru_captcha/captcha_controller.rb

@@ -0,0 +1,14 @@
+module RuCaptcha
+  class CaptchaController < ActionController::Base
+    def index
+      return head :ok if request.head?
+
+      headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
+      headers["Pragma"] = "no-cache"
+      data = generate_rucaptcha
+
+      opts = { disposition: "inline", type: "image/jpeg" }
+      send_data data, opts
+    end
+  end
+end

data/config/locales/rucaptcha.de-DE.yml

@@ -0,0 +1,3 @@
+'de-DE':
+  rucaptcha:
+    invalid: "Falsches Captcha (Wenn es nicht erkannt wird, klicken Sie darauf , um das Captcha zu aktualisieren)"

data/config/locales/rucaptcha.en.yml

@@ -0,0 +1,3 @@
+en:
+  rucaptcha:
+    invalid: "The captcha code is incorrect (if you can't read, you can click image to refresh it)"

data/config/locales/rucaptcha.pt-BR.yml

@@ -0,0 +1,3 @@
+'pt-BR':
+  rucaptcha:
+    invalid: "Código inválido!"

data/config/locales/rucaptcha.zh-CN.yml

@@ -0,0 +1,3 @@
+'zh-CN':
+  rucaptcha:
+    invalid: "验证码不正确（如无法识别，可以点击刷新验证码）"

data/config/locales/rucaptcha.zh-TW.yml

@@ -0,0 +1,3 @@
+'zh-TW':
+  rucaptcha:
+    invalid: "驗證碼不正確（如無法識別，可以點擊刷新驗證碼）"

data/config/routes.rb

@@ -0,0 +1,3 @@
+RuCaptcha::Engine.routes.draw do
+  root to: "captcha#index"
+end