cloudfront-signer 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55f3da387ee038729bfee7a3dcc7f1b250dba308
-  data.tar.gz: b514f00d64dc1d5713fe04896a9177cead4e5835
+  metadata.gz: 1a9dcd6de6a454594341272c94b9f63766580855
+  data.tar.gz: 3fc69573f4c24f7d7d9d23119d610be44761e947
 SHA512:
-  metadata.gz: d1905499e2278f379ea501f16f860829612b877b50b79835eef25b6a4840668435134bc5775eccfad7049ef123443cf4586472ca17dac23cf02d460fa3750b7d
-  data.tar.gz: 8c5470df9a7cb80dc9a05032ddb63a01ae04e3cce4f03863b45c0b3213b93ddbffa305d861c1d7d892ecf0e4eb66219052006825435dcc3ccf3fc89353c5e42f
+  metadata.gz: 6132b2d861fd06a6d8ec773f132d4027c962b1e5406550f24855791e333fb11af0ae72fa35809ed71d773332a7076a3d77b9f95ae2d4d675bb6a2ad06741a746
+  data.tar.gz: 8722d602d33b1d0f453c13468f2fdea8cbd50bb3b6382b0627aed383559339340f3f2ead7a3bb5c1012862aff97118596dfe0bc4a8c151c9cf00aa1c36d6fb46

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 
 coverage
+doc

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 3.0.2 / 2017-06-22
+
+* Provides an option to URI escape the path before signing it. Issue and accepted PR from [@mynock](https://github.com/mynock)
+* Replaces Fixnum with Integer for Ruby 2.4.1. Issue and accepted PR from [@scott-knight](https://github.com/scott-knight)
+
 ## 3.0.1 / 2017-01-20
 
 * Supports signing frozen strings. Bug reported by [@alexandermayr](https://github.com/alexandermayr).

data/Rakefile

@@ -8,3 +8,14 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 task default: :spec
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include %w(README.md LICENSE lib/cloudfront-signer.rb)
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--coverage-report'
+  rdoc.markup = 'markdown'
+end

data/lib/cloudfront-signer.rb

@@ -142,6 +142,13 @@ module Aws
         build_url subject, { remove_spaces: true, html_escape: true }, policy_options
       end
 
+      # Public: Sign a url (as above) but URI encode the string first.
+      #
+      # Returns a String
+      def self.sign_url_escaped(subject, policy_options = {})
+        build_url subject, { uri_escape: true }, policy_options
+      end
+
       # Public: Sign a stream path part or filename (spaces are allowed in
       # stream paths and so are not removed).
       #
@@ -159,6 +166,13 @@ module Aws
                   policy_options
       end
 
+      # Public: Sign a stream path or filename but URI encode the string first
+      #
+      # Returns a String
+      def self.sign_path_escaped(subject, policy_options = {})
+        build_url subject, { uri_escape: true }, policy_options
+      end
+
       # Public: Builds a signed url or stream resource name with optional
       # configuration and policy options
       #
@@ -170,6 +184,7 @@ module Aws
         separator = subject =~ /\?/ ? '&' : '?'
 
         subject.gsub!(/\s/, '%20') if configuration_options[:remove_spaces]
+        subject = URI.escape(subject) if configuration_options[:uri_escape]
 
         result = subject +
                  separator +
@@ -244,9 +259,9 @@ module Aws
         case timelike
         when String then Time.parse(timelike).to_i
         when Time   then timelike.to_i
-        when Fixnum then timelike
+        when Integer then timelike
         else fail ArgumentError,
-                  'Invalid argument - String, Fixnum or Time required - ' \
+                  'Invalid argument - String, Integer or Time required - ' \
                   "#{timelike.class} passed."
         end
       end

data/lib/cloudfront-signer/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module CF
-    VERSION = '3.0.1'.freeze
+    VERSION = '3.0.2'.freeze
   end
 end

data/spec/files/custom_policy.json

@@ -0,0 +1,12 @@
+{
+   "Statement": [
+      {
+         "Resource": "https://d84l721fxaaqy9.cloudfront.net/downloads/",
+         "Condition": {
+           "DateLessThan": { "AWS:EpochTime": 1255674716 },
+           "DateGreaterThan": {"AWS:EpochTime": 1241073790 },
+           "IpAddress": { "AWS:SourceIp": "216.98.35.1/32" }
+         }
+      }
+   ]
+}

data/spec/files/private_key.pem

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXgIBAAKBgQCp280I7v8JBVJBN7Kdfl4eD+noyqzbLAsz9mIr07hZQ3PjVa5g
+3j5Q8oXioU2ycxzXephfPr83l/FTAtPSZQ94Jh6u/CdoEYXfEtFbJYQ2lHXrra36
+yVcyyxQ6tAKgUHdWnZ/vbItUhLnhCSqwelTNpgRzf6AKdVOtQPaZ+bnkQQIDAQAB
+AoGAXWSPTbQq4gjc+yLmwJW0pg7V67tUY4XJ+x4jSDm3CM1/sKVxpa1M0jEm0D8k
+e1Ozrf6oPOZBOQ4AEEZjtTD/2Yi8U0bwG97fg9NlZddGNN2jj8pEOWY53/iVWcfb
+VGXVDlhUA0uIZhKK3Sl2SW9t/8p7affjJmGKn2nGLieRKIkCQQDQmExXqRnVNtCz
+qjTPt81MU4cIrzXr/tUC9s6An8OcgiTDjiIOnY3XB/F19lpMQIMEzrB7f04GrpkQ
+0w6p/3NXAkEA0HXjiSyZaEoXoR2e/dTZrKw8npnjjW0CpKeSf8PK8qpFPK0UJOk7
+aU0rStQmoAmygcHiw3hJ7slyVS8f9zn+JwJBAMMVbHCfadWKSm19RZ7um0ZC6Asr
+MhbgYX9AK6kHwf3hiViK2TcqCrmMaDqWh6TAwMgCNfOKAAMnz2d4vEIo8kkCQQCl
+qnq4gkQsWG2s8jBvg1+2VW8bkCsCMvbdyfqoJP69mUnK7bXLm7tGdTiJkE5d8zb0
+3hQLyiXfaiK9xeS+gk0TAkEAtuFcd+taoBnjhVL6q0OhNuA1T1+qYr5fyzQWKKKC
++WMRi2/JCJCL/SX12q5hMq759VnzfnbgqwAq6MlPUZKEBQ==
+-----END RSA PRIVATE KEY-----

data/spec/signer_spec.rb

@@ -12,14 +12,42 @@ RSpec.shared_examples 'is configured' do
   end
 end
 
+FILES_PATH = File.expand_path(File.dirname(__FILE__) + '/files')
+KEY_PAIR_ID = 'APKAIKUROOUNR2BAFUUU'.freeze
+
 RSpec.describe Aws::CF::Signer do
-  let(:key_pair_id) { 'APKAIKUROOUNR2BAFUUU' }
-  let(:key_path) do
-    File.expand_path File.dirname(__FILE__) + "/keys/pk-#{key_pair_id}.pem"
-  end
+  let(:key_path) { FILES_PATH + "/pk-#{KEY_PAIR_ID}.pem" }
+  let(:other_key_path) { FILES_PATH + '/private_key.pem' }
   let(:key) { File.readlines(key_path).join '' }
 
-  describe 'defaults' do
+  describe 'Errors' do
+    it 'raises ArgumentError when invalid path is passed to key_path' do
+      expect do
+        Aws::CF::Signer.configure { |config| config.key_path = 'foo/bar' }
+      end.to raise_error ArgumentError
+    end
+
+    it 'raises OpenSSL::PKey::RSAError when invalid key is passed' do
+      expect do
+        Aws::CF::Signer.configure { |config| config.key = '' }
+      end.to raise_error OpenSSL::PKey::RSAError
+    end
+
+    it 'raises ArgumentError when no key is provided through private_key' do
+      expect do
+        Aws::CF::Signer.configure { |_config| }
+      end.to raise_error ArgumentError
+    end
+
+    it "raises ArgumentError when no key is provided through key_path doesn't" \
+         'allow to guess key_pair_id' do
+      expect do
+        Aws::CF::Signer.configure { |config| config.key_path = other_key_path }
+      end.to raise_error ArgumentError
+    end
+  end
+
+  describe 'Defaults' do
     it 'expire urls and paths in one hour by default' do
       expect(Aws::CF::Signer.default_expires).to eq 3600
     end
@@ -31,10 +59,10 @@ RSpec.describe Aws::CF::Signer do
     end
   end
 
-  context 'configured with key and key_pair_id' do
+  context 'When configured with key and key_pair_id' do
     before do
       Aws::CF::Signer.configure do |config|
-        config.key_pair_id = key_pair_id
+        config.key_pair_id = KEY_PAIR_ID
         config.key = key
       end
     end
@@ -42,7 +70,7 @@ RSpec.describe Aws::CF::Signer do
     include_examples 'is configured'
   end
 
-  context 'configured with key_path' do
+  context 'When configured with key_path' do
     before(:each) do
       Aws::CF::Signer.configure { |config| config.key_path = key_path }
     end
@@ -52,31 +80,28 @@ RSpec.describe Aws::CF::Signer do
     end
 
     describe 'when signing a url' do
+      let(:url) { 'https://example.com/somerésource?opt1=one&opt2=two' }
+      let(:url_with_spaces) { 'http://example.com/sign me' }
+
       it "doesn't modifies the passed url" do
-        url = 'http://somedomain.com/sign'.freeze
+        url = 'http://example.com/'.freeze
         expect(Aws::CF::Signer.sign_url(url)).not_to match(/\s/)
       end
 
       it 'removes spaces' do
-        url = 'http://somedomain.com/sign me'
-        expect(Aws::CF::Signer.sign_url(url)).not_to match(/\s/)
+        expect(Aws::CF::Signer.sign_url(url_with_spaces)).not_to match(/\s/)
       end
 
       it "doesn't HTML encode the signed url by default" do
-        url = 'http://somedomain.com/someresource?opt1=one&opt2=two'
         expect(Aws::CF::Signer.sign_url(url)).to match(/\?|=|&/)
       end
 
       it 'HTML encodes the signed url when using sign_url_safe' do
-        url = 'http://somedomain.com/someresource?opt1=one&opt2=two'
         expect(Aws::CF::Signer.sign_url_safe(url)).not_to match(/\?|=|&/)
       end
 
-      it 'expires when specified inline' do
-        url = 'http://somedomain.com/sign'
-        signed_url = Aws::CF::Signer.sign_url(url, expires: Time.now + 600)
-        expires_value = get_query_value(signed_url, 'Expires').to_i
-        expect(expires_value).to eq(Time.now.to_i + 600)
+      it 'URL encodes the signed URL when using sign_url_escaped' do
+        expect(Aws::CF::Signer.sign_url_escaped(url)).not_to match(/é/)
       end
     end
 
@@ -85,6 +110,62 @@ RSpec.describe Aws::CF::Signer do
         path = '/prefix/sign me'
         expect(Aws::CF::Signer.sign_path(path)).to match(/\s/)
       end
+
+      it 'HTML encodes the signed path when using sign_path_safe' do
+        path = '/prefix/sign me?'
+        expect(Aws::CF::Signer.sign_path_safe(path)).not_to match(/\?|=|&/)
+      end
+
+      it 'URL encodes the signed path when using sign_path_escaped' do
+        path = '/préfix/sign me?'
+        expect(Aws::CF::Signer.sign_path_escaped(path)).not_to match(/[é ]+/)
+      end
+    end
+
+    describe ':expires option' do
+      subject(:sign_url) { Aws::CF::Signer.sign_url '', expires: expires }
+
+      { 'Time' => Time.now,
+        'String' => '2018-01-01',
+        'Integer' => 1_514_782_800,
+        'NilClass' => nil }.each do |klass, value|
+        context "as a #{klass}" do
+          let(:expires) { value }
+          it "doesn't raise an error" do
+            expect { subject }.not_to raise_error
+          end
+        end
+      end
+
+      context 'not as a String, Integer or Time' do
+        let(:expires) { [[], {}, true, 1.0].sample }
+        it 'raises ArgumentError' do
+          expect { subject }.to raise_error ArgumentError
+        end
+      end
+    end
+
+    describe 'Custom Policy' do
+      it 'builds policy from policy_options' do
+        signed_url = Aws::CF::Signer.sign_url(
+          'https://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz',
+          starting: 'Thu, 30 Apr 2009 06:43:10 GMT',
+          expires: 'Fri, 16 Oct 2009 06:31:56 GMT',
+          resource: 'https://d84l721fxaaqy9.cloudfront.net/downloads/',
+          ip_range: '216.98.35.1/32'
+        )
+        policy_value = get_query_value(signed_url, 'Policy')
+        expect(policy_value).not_to be_empty
+      end
+
+      it 'builds policy from policy_file' do
+        signed_url = Aws::CF::Signer.sign_url(
+          'https://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz',
+          policy_file: FILES_PATH + '/custom_policy.json'
+        )
+        policy_value = get_query_value(signed_url, 'Policy')
+        expect(policy_value).not_to be_empty
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudfront-signer
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Anthony Bouch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,8 +64,10 @@ files:
 - lib/cloudfront-signer/version.rb
 - lib/generators/cloudfront/install/install_generator.rb
 - lib/generators/cloudfront/install/templates/cloudfront_signer.rb
-- spec/keys/pk-APKAIKUROOUNR2BAFUUU.pem
-- spec/keys/rsa-APKAIKUROOUNR2BAFUUU.pem
+- spec/files/custom_policy.json
+- spec/files/pk-APKAIKUROOUNR2BAFUUU.pem
+- spec/files/private_key.pem
+- spec/files/rsa-APKAIKUROOUNR2BAFUUU.pem
 - spec/signer_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/leonelgalan/cloudfront-signer
@@ -88,12 +90,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cloudfront-signer
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A gem to sign url and stream paths for Amazon CloudFront private content.
 test_files:
-- spec/keys/pk-APKAIKUROOUNR2BAFUUU.pem
-- spec/keys/rsa-APKAIKUROOUNR2BAFUUU.pem
+- spec/files/custom_policy.json
+- spec/files/pk-APKAIKUROOUNR2BAFUUU.pem
+- spec/files/private_key.pem
+- spec/files/rsa-APKAIKUROOUNR2BAFUUU.pem
 - spec/signer_spec.rb
 - spec/spec_helper.rb