rucaptcha 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51c8a512c9e753bf74549211821f381dcbb97464
-  data.tar.gz: c074c183fbeee85e221a05fd45398ffef44a573d
+  metadata.gz: 0740eff0acb8f6c4fb6b4da226b3abbcab71412c
+  data.tar.gz: 75b309cf315d5dd39b4d0f1692639ac86613258c
 SHA512:
-  metadata.gz: 8997bfca05ece7d0fb5ec808000bcb6bd0d6a9f423e3a37cc464fe4c5bbeeec9d9b4a80f1bd3fdcd97446ae2b75acdd0b965843c6af6873ea3f11d5a6c0a30f6
-  data.tar.gz: 93f67bb005cfd26835a27f3d5fc13ed3957dae4c609764bfc766bebe176959f355964fbc699a7fd597bc7aeaf23d9be93c7a25f05284b4aaf13b43a6f6e2aee0
+  metadata.gz: 33372cd726889909c636742cc61bc23ccb2e7c4f4e3b0a509fb05ace0867cfff0e486a4f2ea11b20491c173df28d161f63206ed380ba1efca29eb202fb25ab62
+  data.tar.gz: 679be16335e6740e7167b65e5b20a9c32c4e9386aceeb2cab57735a77919b1144230c02ffbc17e75c4911c56e0e65294ae9dbd57d4c5eb7cba75eb6736d9a2e9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+2.2.0
+-----
+
+- Add option `config.length` for support change number chars.
+- Add option `config.strikethrough` for enable or disable strikethrough.
+
 2.1.3
 -----
 

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/huacnlee/rucaptcha.svg)](https://travis-ci.org/huacnlee/rucaptcha)
 [![Code Climate](https://codeclimate.com/github/huacnlee/rucaptcha/badges/gpa.svg)](https://codeclimate.com/github/huacnlee/rucaptcha)
 
-This is a Captcha gem for Rails Applications. It drawing captcha image with C code.
+This is a Captcha gem for Rails Applications which generates captcha image by C code.
 
 ## Example
 
@@ -14,7 +14,7 @@ This is a Captcha gem for Rails Applications. It drawing captcha image with C co
 
 ## Feature
 
-- No dependencies. No ImageMagick, No RMagick.
+- No dependencies. No ImageMagick. No RMagick;
 - For Rails Application;
 - Simple, Easy to use;
 - High performance.
@@ -42,12 +42,35 @@ RuCaptcha.configure do
   # 默认：会从 Rails 配置的 cache_store 里面读取相同的配置信息，并尝试用可以运行的方式，用于存储验证码字符
   # 但如果是 [:null_store, :memory_store, :file_store] 之类的，你可以通过下面的配置项单独给 RuCaptcha 配置 cache_store
   self.cache_store = :mem_cache_store
+  # Chars length, default: 5, allows: [3 - 7]
+  # self.length = 5
+  # enable/disable Strikethrough.
+  # self.strikethrough = true
 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 will uses value from `params[:_rucaptcha]` to validation.
+When you called `verify_rucaptcha?`, it uses value from `params[:_rucaptcha]` to validate.
 
 ```rb
 class AccountController < ApplicationController
@@ -73,7 +96,7 @@ class ForgotPasswordController < ApplicationController
 end
 ```
 
-> TIP: Sometime you may need 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`.
+> 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`
 
@@ -92,7 +115,7 @@ View `app/views/account/new.html.erb`
 </form>
 ```
 
-And if you are use Devise, you can read this to add validation: [RuCaptcha with Devise](https://github.com/huacnlee/rucaptcha/wiki/Working-with-Devise).
+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
 
@@ -120,3 +143,19 @@ class ActionDispatch::IntegrationTest
   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
+```

data/ext/rucaptcha/rucaptcha.c

@@ -1,6 +1,6 @@
 // http://github.com/ITikhonov/captcha
 const int gifsize;
-void captcha(unsigned char im[70*200], unsigned char l[6]);
+void captcha(unsigned char im[70*200], unsigned char l[8], int length, int i_line);
 void makegif(unsigned char im[70*200], unsigned char gif[gifsize], int style);
 
 #include <unistd.h>
@@ -152,18 +152,37 @@ static void filter(unsigned char im[70*200]) {
 
 static const char *letters="abcdafahijklmnopqrstuvwxyz";
 
-void captcha(unsigned char im[70*200], unsigned char l[6]) {
+void captcha(unsigned char im[70*200], unsigned char l[8], int length, int i_line) {
   unsigned char swr[200];
   uint8_t s1,s2;
 
   int f=open("/dev/urandom",O_RDONLY);
   read(f,l,5); read(f,swr,200); read(f,dr,sizeof(dr)); read(f,&s1,1); read(f,&s2,1);
   close(f);
+  memset(im,0xff,200*70); s1=s1&0x7f; s2=s2&0x3f;
 
-  memset(im,0xff,200*70); s1=s1&0x7f; s2=s2&0x3f; l[0]%=25; l[1]%=25; l[2]%=25; l[3]%=25; l[4]%=25; l[5]=0;
-  int p=30; p=letter(l[0],p,im,swr,s1,s2); p=letter(l[1],p,im,swr,s1,s2); p=letter(l[2],p,im,swr,s1,s2); p=letter(l[3],p,im,swr,s1,s2); letter(l[4],p,im,swr,s1,s2);
-  line(im,swr,s1); dots(im); // blur(im); // filter(im);
-  l[0]=letters[l[0]]; l[1]=letters[l[1]]; l[2]=letters[l[2]]; l[3]=letters[l[3]]; l[4]=letters[l[4]];
+  int x;
+  for(x=0;x<length;x++){
+    l[x]%=25;
+  }
+  for(x=length;x<8;x++){
+    l[length]=0;
+  }
+  //l[0]%=25; l[1]%=25; l[2]%=25; l[3]%=25; l[4]=0; // l[4]%=25; l[5]=0;
+  int p=30;
+  for(x=0;x<length;x++){
+    p=letter(l[x],p,im,swr,s1,s2);
+  }
+  //p=letter(l[0],p,im,swr,s1,s2); p=letter(l[1],p,im,swr,s1,s2); p=letter(l[2],p,im,swr,s1,s2); p=letter(l[3],p,im,swr,s1,s2); //letter(l[4],p,im,swr,s1,s2);
+  if (i_line == 1) {
+    line(im,swr,s1);
+  }
+  dots(im); // blur(im); // filter(im);
+
+  for(x=0;x<length;x++){
+    l[x]=letters[l[x]];
+  }
+  //l[1]=letters[l[1]]; l[2]=letters[l[2]]; l[3]=letters[l[3]]; //l[4]=letters[l[4]];
 }
 
 // #ifdef CAPTCHA
@@ -188,20 +207,22 @@ VALUE RuCaptcha = Qnil;
 
 void Init_rucaptcha();
 
-VALUE create(VALUE self, VALUE style);
+VALUE create(VALUE self, VALUE style, VALUE length, VALUE line);
 
 void Init_rucaptcha() {
   RuCaptcha = rb_define_module("RuCaptcha");
-  rb_define_singleton_method(RuCaptcha, "create", create, 1);
+  rb_define_singleton_method(RuCaptcha, "create", create, 3);
 }
 
-VALUE create(VALUE self, VALUE style) {
-  char l[6];
+VALUE create(VALUE self, VALUE style, VALUE length, VALUE line) {
+  char l[8];
   unsigned char im[80*200];
   unsigned char gif[gifsize];
   int i_style = FIX2INT(style);
+  int i_length = FIX2INT(length);
+  int i_line = FIX2INT(line);
 
-  captcha(im, l);
+  captcha(im, l, i_length, i_line);
   makegif(im, gif, i_style);
 
   VALUE result = rb_ary_new2(2);
@@ -211,4 +232,3 @@ VALUE create(VALUE self, VALUE style) {
   return result;
 }
 
-

data/lib/rucaptcha.rb

@@ -8,14 +8,18 @@ require 'rucaptcha/controller_helpers'
 require 'rucaptcha/view_helpers'
 require 'rucaptcha/cache'
 require 'rucaptcha/engine'
+require 'rucaptcha/errors/configuration'
 
 module RuCaptcha
   class << self
     def config
       return @config if defined?(@config)
       @config = Configuration.new
-      @config.style       = :colorful
-      @config.expires_in  = 2.minutes
+      @config.style         = :colorful
+      @config.length        = 5
+      @config.strikethrough = true
+      @config.expires_in    = 2.minutes
+
       if Rails.application
         @config.cache_store = Rails.application.config.cache_store
       else
@@ -31,7 +35,14 @@ module RuCaptcha
 
     def generate()
       style = config.style == :colorful ? 1 : 0
-      self.create(style)
+      length = config.length
+
+      unless length.in?(3..7)
+        raise Rucaptcha::Errors::Configuration, 'length config error, value must in 3..7'
+      end
+
+      strikethrough = config.strikethrough ? 1 : 0
+      self.create(style, length, strikethrough)
     end
 
     def check_cache_store!
@@ -47,7 +58,7 @@ module RuCaptcha
   But your current set is #{cache_store}, it has changed to :file_store for working.
   NOTE: :file_store is still not a good way, it only works with single server case.
 
-  Please make config file `config/initializes/rucaptcha.rb` to setup `cache_store`.
+  Please make config file `config/initializers/rucaptcha.rb` to setup `cache_store`.
   More infomation please read GitHub RuCaptcha README file.
   https://github.com/huacnlee/rucaptcha
 

data/lib/rucaptcha/configuration.rb

@@ -7,5 +7,9 @@ module RuCaptcha
     attr_accessor :expires_in
     # Color style, default: :colorful, allows: [:colorful, :black_white]
     attr_accessor :style
+    # Chars length: default 5, allows: [3..7]
+    attr_accessor :length
+    # strikethrough, default: true
+    attr_accessor :strikethrough
   end
 end

data/lib/rucaptcha/errors/configuration.rb

@@ -0,0 +1,5 @@
+module Rucaptcha
+  module Errors
+    class Configuration < StandardError; end
+  end
+end

data/lib/rucaptcha/version.rb

@@ -1,3 +1,3 @@
 module RuCaptcha
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucaptcha
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -62,6 +62,7 @@ files:
 - lib/rucaptcha/configuration.rb
 - lib/rucaptcha/controller_helpers.rb
 - lib/rucaptcha/engine.rb
+- lib/rucaptcha/errors/configuration.rb
 - lib/rucaptcha/version.rb
 - lib/rucaptcha/view_helpers.rb
 homepage: https://github.com/huacnlee/rucaptcha
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: This is a Captcha gem for Rails Applications. It drawing captcha image with