Ticket #1897: filter_logged_params_v3.diff

actionpack/test/controller/filter_params_test.rb

@@ +1 @@
+require File.dirname(__FILE__) + '/../abstract_unit'
+
+class TestController < ActionController::Base
+end
+
+class RequestTest < Test::Unit::TestCase
+  def setup
+    @controller = TestController.new
+  end
+  
+  def test_filter_params
+    assert TestController.respond_to?(:filter_logged_params)
+    assert ! @controller.respond_to?(:filter_params)
+    
+    TestController.filter_logged_params
+    assert @controller.respond_to?(:filter_params)
+    
+    test_hashes = [[{},{},[]],
+    [{'foo'=>'bar'},{'foo'=>'bar'},[]],
+    [{'foo'=>'bar'},{'foo'=>'bar'},%w'food'],
+    [{'foo'=>'bar'},{'foo'=>'[FILTERED]'},%w'foo'],
+    [{'foo'=>'bar', 'bar'=>'foo'},{'foo'=>'[FILTERED]', 'bar'=>'foo'},%w'foo baz'],
+    [{'foo'=>'bar', 'baz'=>'foo'},{'foo'=>'[FILTERED]', 'baz'=>'[FILTERED]'},%w'foo baz'],
+    [{'bar'=>{'foo'=>'bar','bar'=>'foo'}},{'bar'=>{'foo'=>'[FILTERED]','bar'=>'foo'}},%w'fo'],
+    [{'foo'=>{'foo'=>'bar','bar'=>'foo'}},{'foo'=>'[FILTERED]'},%w'f banana']]
+    
+    test_hashes.each do |before_filter, after_filter, filter_words|
+      TestController.filter_logged_params(*filter_words)
+      assert_equal after_filter, @controller.filter_params(before_filter)
+      
+      filter_words.push('blah')
+      TestController.filter_logged_params(*filter_words) do |key, value|
+        value.reverse! if key =~ /bargain/
+      end
+      before_filter['barg'] = {'bargain'=>'gain', 'blah'=>'bar', 'bar'=>{'bargain'=>{'blah'=>'foo'}}}
+      after_filter['barg'] = {'bargain'=>'niag', 'blah'=>'[FILTERED]', 'bar'=>{'bargain'=>{'blah'=>'[FILTERED]'}}}
+      assert_equal after_filter, @controller.filter_params(before_filter)
+    end
+  end
+end

actionpack/lib/action_controller/benchmarking.rb

@@ -70 +70 @@
-        log_message  = "Completed in #{sprintf("%.5f", runtime)} (#{(1 / runtime).floor} reqs/sec)"
-        log_message << rendering_runtime(runtime) if @rendering_runtime
-        log_message << active_record_runtime(runtime) if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
-complete_request_uri
+(self.respond_to?(:filter_params) ? complete_request_uri.gsub(/\?.*/,'?[FILTERED]') : complete_request_uri)
-        logger.info(log_message)
-      end
-    end

actionpack/lib/action_controller/base.rb

@@ -346 +346 @@
-        require 'action_controller/upload_progress'
-        include ActionController::UploadProgress
-      end
+      
+      # Replace sensitive paramater data from the request log.
+      # Filters paramaters that have any of the arguments as a substring.
+      # Looks in all subhashes of the param hash for keys to filter.
+      # If a block is given, each key and value of the paramater hash and all
+      # subhashes is passed to it, the value or key
+      # can be replaced using String#replace or similar method.
+      # Examples:
+      #   filter_logged_params 
+      #   => Does nothing, just slows the logging process down
+      #
+      #   filter_logged_params :password
+      #   => replaces the value to all keys matching /password/i with "[FILTERED]"
+      #
+      #   filter_logged_params :foo, "bar"
+      #   => replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
+      #
+      #   filter_logged_params {|k,v| v.reverse! if k =~ /secret/i}
+      #   => reverses the value to all keys matching /secret/i
+      #
+      #   filter_logged_params(:foo, "bar") {|k,v| v.reverse! if k =~ /secret/i}
+      #   => reverses the value to all keys matching /secret/i, and 
+      #      replaces the value to all keys matching /foo|bar/i with "[FILTERED]"
+      def filter_logged_params(*filter_words, &block)
+        param_filter = Regexp.new(filter_words.collect{|s|s.to_s}.join('|'),true) if filter_words.length > 0
+        define_method("filter_params") do |hash|
+          newhash = {}
+          hash.each do |key, value|
+            if key =~ param_filter
+              newhash[key] = '[FILTERED]'
+            elsif value.is_a?(Hash)
+              newhash[key] = filter_params(value) 
+            elsif block_given?
+              key, value = key.dup, value.dup
+              yield key, value
+              newhash[key] = value
+            else newhash[key] = value
+            end
+          end
+          newhash
+        end
+      end
-    end
-
-    public
@@ -815 +857 @@
-
-      def log_processing
-        logger.info "\n\nProcessing #{controller_class_name}\##{action_name} (for #{request_origin})"
-
+self.respond_to?(:filter_params) ? filter_params(@params).inspect : 
-      end
-    
-      def perform_action