signed_form 0.1.2 → 0.2.0

data/spec/fixtures/views/_fields.html.erb

@@ -0,0 +1,2 @@
+<%= f.text_field :name %>
+<%= f.text_field :birthdate %>

data/spec/fixtures/views/form.html.erb

@@ -0,0 +1,4 @@
+<%= form_for :user, signed: true, url: '/users', method: :post do |f| %>
+  <%= f.text_field :address %>
+  <%= render partial: '/fields', locals: { f: f } %>
+<% end %>

data/spec/form_builder_spec.rb

@@ -20,18 +20,35 @@ class Widget
   end
 end
 
+class ControllerRenderer < AbstractController::Base
+  include AbstractController::Rendering
+  self.view_paths = [ActionView::FileSystemResolver.new(File.join(File.dirname(__FILE__), 'fixtures', 'views'))]
+
+  view_context_class.class_eval do
+    def url_for(*args)
+      '/users'
+    end
+
+    def protect_against_forgery?
+      false
+    end
+  end
+end
+
+class MockBuilder < ActionView::Helpers::FormBuilder; end
+
 describe SignedForm::FormBuilder do
   include SignedFormViewHelper
 
-  before { SignedForm::HMAC.secret_key = "abc123" }
-  after  { SignedForm::HMAC.secret_key = nil }
+  before { SignedForm.secret_key = "abc123" }
+  before { SignedForm.options[:digest] = false }
 
   let(:user) { User.new }
   let(:widget) { Widget.new }
 
-  describe "signed_form_for" do
+  describe "form_for tag" do
     it "should build a form with signature" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.text_field :name
       end
 
@@ -43,17 +60,73 @@ describe SignedForm::FormBuilder do
       content.should =~ Regexp.new(regex, Regexp::MULTILINE)
     end
 
-    it "should set a target" do
-      content = signed_form_for(User.new, sign_destination: true) do |f|
+    it "should not sign if no option is present" do
+      content = form_for(User.new) do |f|
         f.text_field :name
       end
 
+      content.should_not =~ /form_signature/
+    end
+
+    context "signed default" do
+      before { SignedForm.options[:signed] = true }
+
+      it "should sign a form when the default option is set" do
+        content = form_for(User.new) do |f|
+          f.text_field :name
+        end
+
+        content.should =~ /form_signature/
+      end
+
+      it "should allow the form to be overriden" do
+        content = form_for(User.new, signed: false) do |f|
+          f.text_field :name
+        end
+
+        content.should_not =~ /form_signature/
+      end
+    end
+  end
+
+  describe "third party builders" do
+    it "should build a signed form" do
+      content = form_for(User.new, signed: true, builder: MockBuilder) do |f|
+        f.text_field :name
+      end
       data = get_data_from_form(content)
-      data.size.should == 2
-      data.should include(:__options__)
-      data[:__options__].should include(:method, :url)
-      data[:__options__][:method].should == :post
-      data[:__options__][:url].should == '/users'
+      data['user'].should include(:name)
+    end
+
+    it "should raise if a builder isn't supported" do
+      expect { form_for(User.new, signed: true, builder: Class.new) {} }.to raise_error
+    end
+  end
+
+  describe "sign_destination" do
+    after do
+      @data.should include(:_options_)
+      @data[:_options_].should include(:method, :url)
+      @data[:_options_][:method].should == :post
+      @data[:_options_][:url].should == '/users'
+    end
+
+    it "should set a target" do
+      content = form_for(User.new, signed: true, sign_destination: true) do |f|
+        f.text_field :name
+      end
+
+      @data = get_data_from_form(content)
+    end
+
+    it "should set a target when the default options are enabled" do
+      SignedForm.options[:sign_destination] = true
+
+      content = form_for(User.new, signed: true) do |f|
+        f.text_field :name
+      end
+
+      @data = get_data_from_form(content)
     end
   end
 
@@ -69,18 +142,16 @@ describe SignedForm::FormBuilder do
                :object, :radio_button, :parent_builder,
                :collection_check_boxes, :grouped_collection_select, :select,
                :collection_select, :collection_radio_buttons, :time_select,
-               :datetime_select, :time_zone_select, :date_select]
+               :datetime_select, :time_zone_select, :date_select, :search_field]
 
     after do
-      @data.should be
-      @data.size.should == 1
       @data['user'].size.should == 1
       @data['user'].should include(:name)
     end
 
     fields.each do |field|
       it "should add to the allowed attributes when #{field} is used" do
-        content = signed_form_for(User.new) do |f|
+        content = form_for(User.new, signed: true) do |f|
           f.send field, :name
         end
 
@@ -89,7 +160,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when collection_check_boxes is used", action_pack: /4\.\d+/ do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.collection_check_boxes :name, ['a', 'b'], :to_s, :to_s
       end
 
@@ -100,7 +171,7 @@ describe SignedForm::FormBuilder do
       continent   = Struct.new('Continent', :continent_name, :countries)
       country     = Struct.new('Country', :country_id, :country_name)
 
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.grouped_collection_select(:name, [continent.new("<Africa>", [country.new("<sa>", "<South Africa>")])],
                                     :countries, :continent_name, :country_id, :country_name)
       end
@@ -109,7 +180,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when select is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.select :name, %w(a b)
       end
 
@@ -117,7 +188,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when collection_select is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.collection_select :name, %w(a b), :to_s, :to_s
       end
 
@@ -125,7 +196,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when collection_radio_buttons is used", action_pack: /4\.\d+/ do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.collection_radio_buttons :name, %w(a b), :to_s, :to_s
       end
 
@@ -133,7 +204,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when date_select is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.date_select :name
       end
 
@@ -141,7 +212,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when time_select is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.time_select :name
       end
 
@@ -149,7 +220,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when datetime_select is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.datetime_select :name
       end
 
@@ -157,7 +228,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when time_zone_select is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.time_zone_select :name
       end
 
@@ -165,7 +236,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should add to the allowed attributes when radio_button is used" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.radio_button :name, ['bar']
       end
 
@@ -175,7 +246,7 @@ describe SignedForm::FormBuilder do
 
   describe "add_signed_fields" do
     it "should add fields to the marshaled data" do
-      content = signed_form_for(User.new) do |f|
+      content = form_for(User.new, signed: true) do |f|
         f.add_signed_fields :name, :address
       end
 
@@ -189,7 +260,7 @@ describe SignedForm::FormBuilder do
     it "should nest attributes" do
       user.stub(widgets: [widget])
 
-      content = signed_form_for(user) do |f|
+      content = form_for(user, signed: true) do |f|
         f.fields_for :widgets do |ff|
           ff.text_field :name
         end
@@ -200,7 +271,7 @@ describe SignedForm::FormBuilder do
     end
 
     it "should deeply nest attributes" do
-      content = signed_form_for(:author, url: '/') do |f|
+      content = form_for(:author, url: '/', signed: true) do |f|
         f.fields_for :books do |ff|
           ff.text_field :name
           ff.check_box :hardcover
@@ -218,7 +289,7 @@ describe SignedForm::FormBuilder do
     end
 
     specify "nested arrays should not have duplicates" do
-      content = signed_form_for(:author, url: '/') do |f|
+      content = form_for(:author, url: '/', signed: true) do |f|
         f.fields_for :books do |ff|
           ff.text_field :name
           ff.text_field :name
@@ -230,7 +301,7 @@ describe SignedForm::FormBuilder do
     end
 
     specify "attribute arrays should not have duplicates" do
-      content = signed_form_for(:author, url: '/') do |f|
+      content = form_for(:author, url: '/', signed: true) do |f|
         f.text_field :name
         f.text_field :name
       end
@@ -239,4 +310,40 @@ describe SignedForm::FormBuilder do
       data[:author].size.should == 1
     end
   end
+
+  describe "form digests" do
+    before { SignedForm.options[:digest] = true }
+
+    let (:controller) { ControllerRenderer.new }
+
+    it "should append a digest to the marshaled data" do
+      controller.render template: 'form'
+
+      data = get_data_from_form(controller.response_body)
+      data[:_options_].should include(:digest)
+    end
+
+    it "should not digest if the option is disabled" do
+      SignedForm.options[:digest] = false
+
+      controller.render template: 'form'
+      data = get_data_from_form(controller.response_body)
+      data[:_options_].should_not include(:digest)
+    end
+
+    it "should get the digest from the view paths" do
+      controller.render template: 'form'
+      data = get_data_from_form(controller.response_body)
+      digestor = data[:_options_][:digest]
+      digestor.view_paths = controller.view_paths
+      digestor.to_s.should == "6a161ab9978322e8251d809b3558ab1a"
+    end
+
+    it "should set a grace period" do
+      controller.render template: 'form'
+      data = get_data_from_form(controller.response_body)
+      data[:_options_].should include(:digest_expiration)
+      (Time.now..(Time.now + SignedForm.options[:digest_grace_period])).should cover(data[:_options_][:digest_expiration])
+    end
+  end
 end

data/spec/hmac_spec.rb

@@ -1,34 +1,24 @@
 require 'spec_helper'
 
 describe SignedForm::HMAC do
-  describe 'create_hmac' do
-    it 'should raise if no key is given' do
-      expect { SignedForm::HMAC.create_hmac "foo" }.to raise_error(SignedForm::Errors::NoSecretKey)
-    end
+  it 'should raise if no key is given' do
+    expect { SignedForm::HMAC.new }.to raise_error(SignedForm::Errors::NoSecretKey)
+  end
 
-    context 'when a key is present' do
-      before { SignedForm::HMAC.secret_key = "superdupersecret" }
-      after  { SignedForm::HMAC.secret_key = nil }
+  describe 'create' do
+    let(:hmac) { SignedForm::HMAC.new(secret_key: "superdupersecret") }
 
-      it 'should create a hex signature' do
-        SignedForm::HMAC.create_hmac("my signed message").length.should == 40
-      end
+    it 'should create a hex signature' do
+      hmac.create("my signed message").length.should == 40
+      hmac.create("my signed message").should == "93c1ecd4c10122cbf873ca6cf9eff08888565054"
     end
   end
 
-  describe 'verify_hmac' do
-    it 'should raise if no key is given' do
-      expect { SignedForm::HMAC.verify_hmac 'foo', 'bar' }.to raise_error(SignedForm::Errors::NoSecretKey)
-    end
-
-    context 'when a key is present' do
-      before { SignedForm::HMAC.secret_key = "superdupersecret" }
-      after  { SignedForm::HMAC.secret_key = nil }
-
-      let(:signature) { SignedForm::HMAC.create_hmac "My super secret" }
+  describe 'verify' do
+    let(:hmac) { SignedForm::HMAC.new(secret_key: "superdupersecret") }
+    let(:signature) { hmac.create "My super secret" }
 
-      specify { SignedForm::HMAC.verify_hmac(signature, "My super secret").should be_true }
-      specify { SignedForm::HMAC.verify_hmac(signature, "My bad secret").should_not be_true }
-    end
+    specify { hmac.verify(signature, "My super secret").should be_true }
+    specify { hmac.verify(signature, "My bad secret").should_not be_true }
   end
 end

data/spec/permit_signed_params_spec.rb

@@ -4,77 +4,94 @@ class Controller < ActionController::Base
   include SignedForm::ActionController::PermitSignedParams
 
   public :permit_signed_form_data
+
+  def view_paths
+    [File.join(File.dirname(__FILE__), 'fixtures', 'views')]
+  end
 end
 
 describe SignedForm::ActionController::PermitSignedParams do
   let(:controller) { Controller.new }
+  let(:hmac)       { SignedForm::HMAC.new(secret_key: SignedForm.secret_key) }
+  let(:params)     { controller.params }
+  let(:template)   { double(view_paths: [File.join(File.dirname(__FILE__), 'fixtures', 'views')], virtual_path: 'form') }
+  let(:digestor)   { SignedForm::Digestor.new(template) }
+
+  def marshal_and_sign(data)
+    encoded_data = Base64.strict_encode64(Marshal.dump(data))
+    signature = hmac.create(encoded_data)
+    "#{encoded_data}--#{signature}"
+  end
 
   before do
-    SignedForm::HMAC.secret_key = "abc123"
+    SignedForm.secret_key = "abc123"
 
     Controller.any_instance.stub(request: double('request', method: 'POST', request_method: 'POST', fullpath: '/users', url: '/users'))
     Controller.any_instance.stub(params: { "user" => { name: "Erich Menge", occupation: 'developer' } })
-  end
 
-  after  { SignedForm::HMAC.secret_key = nil }
+    params.stub(:[]).and_call_original
+    params.stub(:[]).with('user').and_return(params)
+  end
 
   it "should raise if signature isn't valid" do
-    controller.params['form_signature'] = "bad signature"
+    params['form_signature'] = "bad signature"
     expect { controller.permit_signed_form_data }.to raise_error(SignedForm::Errors::InvalidSignature)
   end
 
-  it "should permit attributes that are allowed" do
-    params = controller.params
-
-    data      = Base64.strict_encode64(Marshal.dump("user" => [:name]))
-    signature = SignedForm::HMAC.create_hmac(data)
-
-    params['form_signature'] = "#{data}--#{signature}"
-
-    params.should_receive(:require).with('user').and_return(params)
-    params.should_receive(:permit).with(:name).and_return(params)
-    controller.permit_signed_form_data
-  end
-
-  it "should verify current url matches targeted url" do
-    params = controller.params
+  context "when the parameters are good" do
+    before { params.should_receive(:permit).with(:name).and_return(params) }
 
-    data      = Base64.strict_encode64(Marshal.dump("user" => [:name], :__options__ => { method: 'post', url: '/users'  }))
-    signature = SignedForm::HMAC.create_hmac(data)
+    it "should permit attributes that are allowed" do
+      params['form_signature'] = marshal_and_sign "user" => [:name]
+      controller.permit_signed_form_data
+    end
 
-    params['form_signature'] = "#{data}--#{signature}"
+    it "should verify current url matches targeted url" do
+      params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { method: 'post', url: '/users'  })
 
-    params.stub(:require).with('user').and_return(params)
-    params.stub(:permit).with(:name).and_return(params)
-    controller.request.should_receive(:fullpath).and_return '/users'
-    controller.permit_signed_form_data
+      controller.request.should_receive(:fullpath).and_return '/users'
+      controller.permit_signed_form_data
+    end
   end
 
   it "should reject if url doesn't match" do
-    params = controller.params
-
-    data      = Base64.strict_encode64(Marshal.dump("user" => [:name], :__options__ => { method: 'post', url: '/admin'  }))
-    signature = SignedForm::HMAC.create_hmac(data)
-
-    params['form_signature'] = "#{data}--#{signature}"
-
-    params.stub(:require).with('user').and_return(params)
-    params.stub(:permit).with(:name).and_return(params)
+    params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { method: 'post', url: '/admin' })
+    expect { controller.permit_signed_form_data }.to raise_error(SignedForm::Errors::InvalidURL)
+  end
 
+  it "should reject if the method doesn't match" do
+    params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { method: 'put', url: '/users' })
     expect { controller.permit_signed_form_data }.to raise_error(SignedForm::Errors::InvalidURL)
   end
 
-  it "should reject if method doesn't match" do
-    params = controller.params
+  context "when the digest is bad" do
+    before { digestor.stub(:to_s).and_return "bad" }
+
+    it "should not reject if inside grace period" do
+      params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { digest: digestor, digest_expiration: Time.now + 20 })
+      expect { controller.permit_signed_form_data }.not_to raise_error(SignedForm::Errors::ExpiredForm)
+    end
 
-    data      = Base64.strict_encode64(Marshal.dump("user" => [:name], :__options__ => { method: 'put', url: '/users'  }))
-    signature = SignedForm::HMAC.create_hmac(data)
+    it "should reject if outside the grace period" do
+      params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { digest: digestor, digest_expiration: Time.now - 20 })
+      expect { controller.permit_signed_form_data }.to raise_error(SignedForm::Errors::ExpiredForm)
+    end
 
-    params['form_signature'] = "#{data}--#{signature}"
+    it "should reject if no grace period" do
+      params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { digest: digestor })
+      expect { controller.permit_signed_form_data }.to raise_error(SignedForm::Errors::ExpiredForm)
+    end
+  end
 
-    params.stub(:require).with('user').and_return(params)
-    params.stub(:permit).with(:name).and_return(params)
+  context "when the digest is good" do
+    it "should not reject if outside grace period" do
+      params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { digest: digestor, digest_expiration: Time.now - 20 })
+      expect { controller.permit_signed_form_data }.not_to raise_error(SignedForm::Errors::ExpiredForm)
+    end
 
-    expect { controller.permit_signed_form_data }.to raise_error(SignedForm::Errors::InvalidURL)
+    it "should not reject if no grace period" do
+      params['form_signature'] = marshal_and_sign("user" => [:name], :_options_ => { digest: digestor })
+      expect { controller.permit_signed_form_data }.not_to raise_error(SignedForm::Errors::ExpiredForm)
+    end
   end
 end