Merge pull request #133 from BluntBlade/master

加上对回调请求进行签名验证的逻辑

.rspec

@@ -1 +1 @@
---colour -f nested
+--colour -f documentation

.travis.yml

@@ -7,3 +7,6 @@ rvm:
 before_script:
   - export QINIU_ACCESS_KEY=QWYn5TFQsLLU1pL5MFEmX3s5DmHdUThav9WyOWOm
   - export QINIU_SECRET_KEY=Bxckh6FA-Fbs9Yt3i3cbKVK22UPBmAOHJcL95pGz
+gemfile:
+  - Gemfile
+  - rails3/Gemfile

CHANGELOG.md

@@ -1,5 +1,19 @@
 ## CHANGE LOG
 
+### V6.5.1
+
+- 为 Qiniu::Auth 添加验证七牛回调请求签名合法性的函数。[https://github.com/qiniu/ruby-sdk/pull/133](https://github.com/qiniu/ruby-sdk/pull/133)
+
+### v6.5.0
+
+- 为 Qiniu::Auth 添加一个异常处理逻辑，在 Access Key 和 Secret Key 未正常设置（nil 值）的情况下给出正确提示。[https://github.com/qiniu/ruby-sdk/pull/126](https://github.com/qiniu/ruby-sdk/pull/126)
+
+### v6.4.2
+
+- gem 兼容性调整 。 [https://github.com/qiniu/ruby-sdk/pull/122](https://github.com/qiniu/ruby-sdk/pull/122)
+
+- 上传策略参数调整 。 [https://github.com/qiniu/ruby-sdk/pull/120](https://github.com/qiniu/ruby-sdk/pull/120)
+
 ### v6.4.1
 
 - 将 mime-types 的依赖版本升级到 2.4.3 。 [https://github.com/qiniu/ruby-sdk/pull/113](https://github.com/qiniu/ruby-sdk/pull/113)
@@ -33,7 +47,7 @@
 ### v6.2.2
 
 - 为/pfop接口添加`pipeline`参数，用于指明使用哪个命名转码队列。  [https://github.com/qiniu/ruby-sdk/pull/92](https://github.com/qiniu/ruby-sdk/pull/92)
-- 为authorize_download_url()添加`:fop`参数，用于生成含数据处理指令的授权下载URL。  
+- 为authorize_download_url()添加`:fop`参数，用于生成含数据处理指令的授权下载URL。
 
 ### v6.2.1
 

Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in qiniu-s3.gemspec
-gemspec
+# Specify your gem's dependencies in qiniu.gemspec
+gemspec :name => 'qiniu'
 
 # platforms :jruby do
 #   gem "jruby-openssl"

Gemfile.lock

@@ -1,30 +1,37 @@
 PATH
   remote: .
   specs:
-    qiniu (6.4.1)
-      json (~> 1.7)
-      mime-types (~> 2.4.3)
-      rest-client (~> 1.6)
+    qiniu (6.5.1)
+      json (~> 1.8)
+      mime-types (~> 1.19)
+      rest-client (~> 1.7.3)
       ruby-hmac (~> 0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.5)
     fakeweb (1.3.0)
-    json (1.8.1)
-    mime-types (1.23)
-    rake (10.0.3)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
+    json (1.8.2)
+    mime-types (1.25.1)
+    netrc (0.10.3)
+    rake (10.4.2)
+    rest-client (1.7.3)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
     ruby-hmac (0.4.0)
 
 PLATFORMS

lib/qiniu.rb

@@ -64,12 +64,11 @@ module Qiniu
         opts[:enable_resumable_upload] = true unless opts.has_key?(:enable_resumable_upload)
 
         if opts[:enable_resumable_upload] && File::size(source_file) > Config.settings[:block_size]
-          code, data, raw_headers = Storage.upload_with_token(opts[:uptoken],
+          code, data, raw_headers = Storage.resumable_upload_with_token(opts[:uptoken],
                                             opts[:file],
                                             opts[:bucket],
                                             opts[:key],
                                             opts[:mime_type],
-                                            opts[:note],
                                             opts[:customer],
                                             opts[:callback_params],
                                             opts[:rotate])

lib/qiniu/auth.rb

@@ -25,6 +25,18 @@ module Qiniu
           # 默认授权期1小时
           return Time.now.to_i + DEFAULT_AUTH_SECONDS
         end # calculate_deadline
+
+        def calculate_hmac_sha1_digest(sk, str)
+          begin
+            sign = HMAC::SHA1.new(sk).update(str).digest
+          rescue RuntimeError => e
+            raise RuntimeError, "Please set Qiniu's access_key and secret_key before authorize any tokens."
+          rescue
+            raise
+          else
+            return sign
+          end
+        end
       end # class << self
 
       class PutPolicy
@@ -49,7 +61,9 @@ module Qiniu
           :return_url             => "returnUrl"           ,
           :return_body            => "returnBody"          ,
           :callback_url           => "callbackUrl"         ,
+          :callback_host          => "callbackHost"        ,
           :callback_body          => "callbackBody"        ,
+          :callback_body_type     => "callbackBodyType"    ,
           :persistent_ops         => "persistentOps"       ,
           :persistent_notify_url  => "persistentNotifyUrl" ,
           :persistent_pipeline    => "persistentPipeline"  ,
@@ -58,6 +72,7 @@ module Qiniu
           :deadline               => "deadline"            ,
           :insert_only            => "insertOnly"          ,
           :fsize_limit            => "fsizeLimit"          ,
+          :callback_fetch_key     => "callbackFetchKey"    ,
           :detect_mime            => "detectMime"          ,
           :mime_limit             => "mimeLimit"
         } # PARAMS
@@ -166,7 +181,7 @@ module Qiniu
           end
 
           ### 生成数字签名
-          sign = HMAC::SHA1.new(secret_key).update(download_url).digest
+          sign = calculate_hmac_sha1_digest(secret_key, download_url)
           encoded_sign = Utils.urlsafe_base64_encode(sign)
 
           ### 生成下载授权凭证
@@ -191,11 +206,7 @@ module Qiniu
           return authorize_download_url(download_url, args)
         end # authorize_download_url_2
 
-        def generate_acctoken(url, body = '')
-          ### 提取AK/SK信息
-          access_key = Config.settings[:access_key]
-          secret_key = Config.settings[:secret_key]
-
+        def generate_acctoken_sign_with_mac(access_key, secret_key, url, body)
           ### 解析URL，生成待签名字符串
           uri = URI.parse(url)
           signing_str = uri.path
@@ -216,14 +227,13 @@ module Qiniu
           end
 
           ### 生成数字签名
-          sign = HMAC::SHA1.new(secret_key).update(signing_str).digest
-          encoded_sign = Utils.urlsafe_base64_encode(sign)
+          sign = calculate_hmac_sha1_digest(secret_key, signing_str)
+          return Utils.urlsafe_base64_encode(sign)
+        end # generate_acctoken_sign_with_mac
 
-          ### 生成管理授权凭证
-          acctoken = "#{access_key}:#{encoded_sign}"
-
-          ### 返回管理授权凭证
-          return acctoken
+        def generate_acctoken(url, body = '')
+          encoded_sign = generate_acctoken_sign_with_mac(Config.settings[:access_key], Config.settings[:secret_key], url, body)
+          return "#{Config.settings[:access_key]}:#{encoded_sign}"
         end # generate_acctoken
 
         def generate_uptoken(put_policy)
@@ -235,7 +245,7 @@ module Qiniu
           encoded_put_policy = Utils.urlsafe_base64_encode(put_policy.to_json)
 
           ### 生成数字签名
-          sign = HMAC::SHA1.new(secret_key).update(encoded_put_policy).digest
+          sign = calculate_hmac_sha1_digest(secret_key, encoded_put_policy)
           encoded_sign = Utils.urlsafe_base64_encode(sign)
 
           ### 生成上传授权凭证
@@ -244,6 +254,31 @@ module Qiniu
           ### 返回上传授权凭证
           return uptoken
         end # generate_uptoken
+
+        def authenticate_callback_request(auth_str, url, body = '')
+          ### 提取AK/SK信息
+          access_key = Config.settings[:access_key]
+          secret_key = Config.settings[:secret_key]
+
+          ### 检查签名格式
+          ak_pos = auth_str.index(access_key)
+          if ak_pos.nil? then
+            return false
+          end
+
+          colon_pos = auth_str.index(':', ak_pos + 1)
+          if colon_pos.nil? || ((ak_pos + access_key.length) != colon_pos) then
+            return false
+          end
+
+          encoded_sign = generate_acctoken_sign_with_mac(access_key, secret_key, url, body)
+          sign_pos = auth_str.index(encoded_sign, colon_pos + 1)
+          if sign_pos.nil? || ((sign_pos + encoded_sign.length) != auth_str.length) then
+            return false
+          end
+
+          return true
+        end # authenticate_callback_request
       end # class << self
 
     end # module Auth

lib/qiniu/http.rb

@@ -65,7 +65,7 @@ module Qiniu
         end
 
         content_type = resp_headers["content-type"][0]
-        if !content_type.nil? && content_type == API_RESULT_MIMETYPE then
+        if !content_type.nil? && !content_type.downcase.index(API_RESULT_MIMETYPE).nil? then
           # 如果是JSON格式，则反序列化
           resp_body = Utils.safe_json_parse(resp_body)
         end
@@ -117,7 +117,7 @@ module Qiniu
         end
 
         content_type = resp_headers["content-type"][0]
-        if !content_type.nil? && content_type == API_RESULT_MIMETYPE then
+        if !content_type.nil? && !content_type.downcase.index(API_RESULT_MIMETYPE).nil? then
           # 如果是JSON格式，则反序列化
           resp_body = Utils.safe_json_parse(resp_body)
         end

lib/qiniu/misc.rb

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
 
+require 'qiniu/http'
+
 module Qiniu
     module Misc
       class << self

lib/qiniu/version.rb

@@ -3,7 +3,7 @@
 module Qiniu
     module Version
       MAJOR = 6
-      MINOR = 4
+      MINOR = 5
       PATCH = 1
       # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
       #

qiniu.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake", ">= 0.9"
   gem.add_development_dependency "rspec", ">= 2.11"
   gem.add_development_dependency "fakeweb", "~> 1.3"
-  gem.add_runtime_dependency "json", "~> 1.7"
-  gem.add_runtime_dependency "rest-client", "~> 1.6"
+  gem.add_runtime_dependency "json", "~> 1.8"
+  gem.add_runtime_dependency "rest-client", "~> 1.7.3"
   gem.add_runtime_dependency "mime-types", "~> 2.4.3"
   gem.add_runtime_dependency "ruby-hmac", "~> 0.4"
   gem.add_runtime_dependency "jruby-openssl", "~> 0.7" if RUBY_PLATFORM == "java"

rails3/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails3/qiniu.gemspec
+gemspec :name => 'qiniu'

rails3/qiniu.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../../lib/qiniu/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["why404","BluntBlade"]
+  gem.email         = ["sdk@qiniu.com"]
+  gem.description   = %q{Qiniu Resource (Cloud) Storage SDK for Ruby. See: http://developer.qiniu.com/docs/v6/sdk/ruby-sdk.html}
+  gem.summary       = %q{Qiniu Resource (Cloud) Storage SDK for Ruby}
+  gem.homepage      = "https://github.com/qiniu/ruby-sdk"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "qiniu"
+  gem.require_paths = ["lib"]
+  gem.version       = Qiniu::Version.to_s
+  gem.license       = "MIT"
+
+  # specify any dependencies here; for example:
+  gem.add_development_dependency "rake", ">= 0.9"
+  gem.add_development_dependency "rspec", ">= 2.11"
+  gem.add_development_dependency "fakeweb", "~> 1.3"
+  gem.add_runtime_dependency "json", "~> 1.8"
+  gem.add_runtime_dependency "rest-client", "~> 1.7.3"
+  gem.add_runtime_dependency "mime-types", "~> 1.19"
+  gem.add_runtime_dependency "ruby-hmac", "~> 0.4"
+  gem.add_runtime_dependency "jruby-openssl", "~> 0.7" if RUBY_PLATFORM == "java"
+end

spec/qiniu/auth_spec.rb

@@ -3,6 +3,7 @@
 
 require 'spec_helper'
 require 'qiniu/auth'
+require 'qiniu/config'
 require 'qiniu/storage'
 require 'digest/sha1'
 
@@ -68,7 +69,60 @@ module Qiniu
           puts data.inspect
         end
       end
-
     end
-  end # module Storage
+
+    ### 测试回调签名
+    context ".authenticate_callback_request" do
+      it "should works" do
+        url = '/test.php'
+        body = 'name=xxx&size=1234'
+        false.should == Qiniu::Auth.authenticate_callback_request('ABCD', url, body)
+        false.should == Qiniu::Auth.authenticate_callback_request(Config.settings[:access_key], url, body)
+        false.should == Qiniu::Auth.authenticate_callback_request('QBox ' + Config.settings[:access_key] + ':', url, body)
+        false.should == Qiniu::Auth.authenticate_callback_request('QBox ' + Config.settings[:access_key] + ':????', url, body)
+
+        acctoken = Qiniu::Auth.generate_acctoken(url, body)
+        auth_str = 'QBox ' + acctoken
+
+        false.should == Qiniu::Auth.authenticate_callback_request(auth_str + '  ', url, body)
+        true.should == Qiniu::Auth.authenticate_callback_request(auth_str, url, body)
+        true.should == Qiniu::Auth.authenticate_callback_request(acctoken, url, body)
+      end
+    end
+  end # module Auth
+
+  module Exception_Auth
+    describe Exception_Auth, :not_set_ak_sk => true do
+      ### 测试未设置 ak/sk 的异常抛出情况
+      context ".not_set_ak_sk" do
+        it "should works" do
+          puts Qiniu::Config.instance_variable_get("@settings").inspect
+
+          begin
+            uptoken = Qiniu::Auth.generate_uptoken({})
+          rescue => e
+            e.message.should == "Please set Qiniu's access_key and secret_key before authorize any tokens."
+          else
+            fail "Not raise any exception."
+          end
+
+          begin
+            download_url = Qiniu::Auth.authorize_download_url("http://test.qiniudn.com/a_private_file")
+          rescue => e
+            e.message.should == "Please set Qiniu's access_key and secret_key before authorize any tokens."
+          else
+            fail "Not raise any exception."
+          end
+
+          begin
+            acctoken = Qiniu::Auth.generate_acctoken("http://rsf.qbox.me/list")
+          rescue => e
+            e.message.should == "Please set Qiniu's access_key and secret_key before authorize any tokens."
+          else
+            fail "Not raise any exception."
+          end
+        end
+      end
+    end
+  end # module Exception_Auth
 end # module Qiniu

spec/qiniu/image_spec.rb

@@ -59,14 +59,18 @@ module Qiniu
         end
       end
 
-=begin
       context ".exif" do
         it "should works" do
-          code, data = Qiniu::Fop::Image.exif(@source_image_url)
+          result = Qiniu.get(@bucket, 'gogopher.jpg')
+          result["url"].should_not be_empty
+          puts result.inspect
+
+          code, data, headers = Qiniu::Fop::Image.exif(result["url"])
+          code.should == 200
           puts data.inspect
+          puts headers.inspect
         end
       end
-=end
 
       context ".mogrify_preview_url" do
         it "should works" do

spec/qiniu/qiniu_spec.rb

@@ -34,7 +34,7 @@ module Qiniu
     context ".buckets" do
       it "should works" do
         result = Qiniu.buckets
-        result.should_not be_false
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -42,7 +42,7 @@ module Qiniu
     context ".set_protected" do
       it "should works" do
         result = Qiniu.set_protected(@bucket, 1)
-        result.should_not be_false
+        expect(result).to eq(true)
         puts result.inspect
       end
     end
@@ -50,7 +50,7 @@ module Qiniu
     context ".set_separator" do
       it "should works" do
         result = Qiniu.set_separator(@bucket, "-")
-        result.should_not be_false
+        expect(result).to eq(true)
         puts result.inspect
       end
     end
@@ -58,7 +58,7 @@ module Qiniu
     context ".set_style" do
       it "should works" do
         result = Qiniu.set_style(@bucket, "small.jpg", "imageMogr/auto-orient/thumbnail/!120x120r/gravity/center/crop/!120x120/quality/80")
-        result.should_not be_false
+        expect(result).to eq(true)
         puts result.inspect
       end
     end
@@ -66,7 +66,7 @@ module Qiniu
     context ".unset_style" do
       it "should works" do
         result = Qiniu.unset_style(@bucket, "small.jpg")
-        result.should_not be_false
+        expect(result).to eq(true)
         puts result.inspect
       end
     end
@@ -82,7 +82,7 @@ module Qiniu
           :enable_crc32_check => true
         }
         result = Qiniu.upload_file(upload_opts)
-        result.should_not be_false
+        expect(result).to_not be_empty
         puts result.inspect
       end
 
@@ -132,24 +132,22 @@ module Qiniu
         File.unlink(localfile) if File.exists?(localfile)
         #expect
         puts result1.inspect
-        result1.should_not be_false
-        result1.should_not be_empty
+        expect(result1).to_not be_empty
         #stat
         result2 = Qiniu.stat(@bucket, key)
         puts result2.inspect
-        result2.should_not be_false
+        expect(result2).to_not be_empty
         #delete
         result3 = Qiniu.delete(@bucket, key)
         puts result3.inspect
-        result3.should_not be_false
+        expect(result3).to eq(true)
       end
     end
 
     context ".stat" do
       it "should works" do
         result = Qiniu.stat(@bucket, @key)
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -157,8 +155,7 @@ module Qiniu
     context ".get" do
       it "should works" do
         result = Qiniu.get(@bucket, @key, "qiniu_spec.rb", 10)
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -166,8 +163,7 @@ module Qiniu
     context ".download" do
       it "should works" do
         result = Qiniu.download(@bucket, @key, "rs_spec.rb", 10)
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -175,8 +171,7 @@ module Qiniu
     context ".batch" do
       it "should works" do
         result = Qiniu.batch("stat", @bucket, [@key])
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -184,8 +179,7 @@ module Qiniu
     context ".batch_stat" do
       it "should works" do
         result = Qiniu.batch_stat(@bucket, [@key])
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -193,8 +187,7 @@ module Qiniu
     context ".batch_get" do
       it "should works" do
         result = Qiniu.batch_get(@bucket, [@key])
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -202,8 +195,7 @@ module Qiniu
     context ".batch_download" do
       it "should works" do
         result = Qiniu.batch_download(@bucket, [@key])
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -236,42 +228,40 @@ module Qiniu
     context ".move" do
       it "should works" do
         result = Qiniu.move(@bucket, @key, @bucket, @key2)
-        result.should_not be_false
+        expect(result).to eq(true)
 
         result2 = Qiniu.stat(@bucket, @key2)
-        result2.should_not be_false
+        expect(result2).to_not be_empty
 
         result3 = Qiniu.move(@bucket, @key2, @bucket, @key)
-        result3.should_not be_false
+        expect(result3).to eq(true)
       end
     end
 
     context ".copy" do
       it "should works" do
         result = Qiniu.copy(@bucket, @key, @bucket, @key2)
-        result.should_not be_false
+        expect(result).to eq(true)
 
         result3 = Qiniu.delete(@bucket, @key2)
-        result3.should_not be_false
+        expect(result3).to eq(true)
       end
     end
 
     context ".delete" do
       it "should works" do
         result = Qiniu.delete(@bucket, @key)
-        result.should_not be_false
+        expect(result).to eq(true)
       end
     end
 
     context ".image_info" do
       it "should works" do
         data = Qiniu.get(@test_image_bucket, @test_image_key)
-        data.should_not be_false
-        data.should_not be_empty
+        expect(data).to_not be_empty
         puts data.inspect
         result = Qiniu.image_info(data["url"])
-        result.should_not be_false
-        result.should_not be_empty
+        expect(result).to_not be_empty
         puts result.inspect
       end
     end
@@ -279,8 +269,7 @@ module Qiniu
     context ".image_mogrify_save_as" do
       it "should works" do
         data = Qiniu.get(@test_image_bucket, @test_image_key)
-        data.should_not be_false
-        data.should_not be_empty
+        expect(data).to_not be_empty
         puts data.inspect
 
         dest_key = "cropped-" + @test_image_key
@@ -295,8 +284,7 @@ module Qiniu
           :auto_orient => true
         }
         result2 = Qiniu.image_mogrify_save_as(@test_image_bucket, dest_key, src_img_url, mogrify_options)
-        result2.should_not be_false
-        result2.should_not be_empty
+        expect(result2).to_not be_empty
         puts result2.inspect
       end
     end

spec/spec_helper.rb

@@ -8,6 +8,9 @@ RSpec.configure do |config|
   config.before :all do
     Qiniu.establish_connection! :access_key => ENV["QINIU_ACCESS_KEY"], :secret_key => ENV["QINIU_SECRET_KEY"]
   end
+  config.before :each, :not_set_ak_sk => true do
+    Qiniu.establish_connection! :access_key => nil, :secret_key => nil
+  end
 end
 
 def make_unique_bucket (bucket)