Allows you to specify sensitive parameters which will be replaced from the request log by looking in the query string of the request and all subhashes of the params hash to filter. If a block is given, each key and value of the params hash and all subhashes is passed to it, the value or key can be replaced using String#replace or similar method.

Examples:

env["action_dispatch.parameter_filter"] = [:password]
=> replaces the value to all keys matching /password/i with "[FILTERED]"

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

env["action_dispatch.parameter_filter"] = lambda do |k,v|
  v.reverse! if k =~ /secret/i
end
=> reverses the value to all keys matching /secret/i
Methods
E
F
P
Constants
KV_RE = '[^&;=]+'
 
PAIR_RE = %r{(#{KV_RE})=(#{KV_RE})}
 
Instance Public methods
filtered_env()

Return a hash of request.env with all sensitive data replaced.

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 35
def filtered_env
  @filtered_env ||= env_filter.filter(@env)
end
filtered_parameters()

Return a hash of parameters with all sensitive data replaced.

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 30
def filtered_parameters
  @filtered_parameters ||= parameter_filter.filter(parameters)
end
filtered_path()

Reconstructed a path with all sensitive GET parameters replaced.

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 40
def filtered_path
  @filtered_path ||= query_string.empty? ? path : "#{path}?#{filtered_query_string}"
end
Instance Protected methods
env_filter()
# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 50
def env_filter
  parameter_filter_for(Array.wrap(@env["action_dispatch.parameter_filter"]) << /RAW_POST_DATA/)
end
filtered_query_string()
# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 60
def filtered_query_string
  query_string.gsub(PAIR_RE) do |_|
    parameter_filter.filter([[$1, $2]]).first.join("=")
  end
end
parameter_filter()
# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 46
def parameter_filter
  parameter_filter_for(@env["action_dispatch.parameter_filter"])
end
parameter_filter_for(filters)
# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 54
def parameter_filter_for(filters)
  ParameterFilter.new(filters)
end