Class/Module Index [+]

Quicksearch

ActionDispatch::Http::FilterParameters

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

Constants

KV_RE
PAIR_RE

Public Instance Methods

filtered_env() click to toggle source

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

# File lib/action_dispatch/http/filter_parameters.rb, line 37
def filtered_env
  @filtered_env ||= env_filter.filter(@env)
end
filtered_parameters() click to toggle source

Return a hash of parameters with all sensitive data replaced.

# File lib/action_dispatch/http/filter_parameters.rb, line 32
def filtered_parameters
  @filtered_parameters ||= parameter_filter.filter(parameters)
end
filtered_path() click to toggle source

Reconstructed a path with all sensitive GET parameters replaced.

# File lib/action_dispatch/http/filter_parameters.rb, line 42
def filtered_path
  @filtered_path ||= query_string.empty? ? path : "#{path}?#{filtered_query_string}"
end

Protected Instance Methods

env_filter() click to toggle source
# File lib/action_dispatch/http/filter_parameters.rb, line 52
def env_filter
  parameter_filter_for(Array.wrap(@env["action_dispatch.parameter_filter"]) << /RAW_POST_DATA/)
end
filtered_query_string() click to toggle source
# File lib/action_dispatch/http/filter_parameters.rb, line 62
def filtered_query_string
  query_string.gsub(PAIR_RE) do |_|
    parameter_filter.filter([[$1, $2]]).first.join("=")
  end
end
parameter_filter() click to toggle source
# File lib/action_dispatch/http/filter_parameters.rb, line 48
def parameter_filter
  parameter_filter_for(@env["action_dispatch.parameter_filter"])
end
parameter_filter_for(filters) click to toggle source
# File lib/action_dispatch/http/filter_parameters.rb, line 56
def parameter_filter_for(filters)
  @@parameter_filter_for[filters] ||= ParameterFilter.new(filters)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.