method

filter_parameter_logging

v2.2.1 - Show latest stable - 0 notes - Class: ActionController::Base

1.0.0
1.1.6 (0)
1.2.6 (0)
2.0.3 (0)
2.1.0 (0)
2.2.1 (0)
2.3.8 (0)
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

filter_parameter_logging(*filter_words, &block) public

Replace sensitive parameter data from the request log. Filters parameters 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 parameter hash and all subhashes is passed to it, the value or key can be replaced using String#replace or similar method.

Examples:

  filter_parameter_logging
  => Does nothing, just slows the logging process down

  filter_parameter_logging :password
  => replaces the value to all keys matching /password/i with "[FILTERED]"

  filter_parameter_logging :foo, "bar"
  => replaces the value to all keys matching /foo|bar/i with "[FILTERED]"

  filter_parameter_logging { |k,v| v.reverse! if k =~ /secret/i }
  => reverses the value to all keys matching /secret/i

  filter_parameter_logging(: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]"

Show source

# File actionpack/lib/action_controller/base.rb, line 484
      def filter_parameter_logging(*filter_words, &block)
        parameter_filter = Regexp.new(filter_words.collect{ |s| s.to_s }.join('|'), true) if filter_words.length > 0

        define_method(:filter_parameters) do |unfiltered_parameters|
          filtered_parameters = {}

          unfiltered_parameters.each do |key, value|
            if key =~ parameter_filter
              filtered_parameters[key] = '[FILTERED]'
            elsif value.is_a?(Hash)
              filtered_parameters[key] = filter_parameters(value)
            elsif block_given?
              key = key.dup
              value = value.dup if value
              yield key, value
              filtered_parameters[key] = value
            else
              filtered_parameters[key] = value
            end
          end

          filtered_parameters
        end
        protected :filter_parameters
      end

filter_parameter_logging

Related methods