Module: ActionDispatch::Http::FilterParameters

Extended by:
ActiveSupport::Concern
Included in:
Request
Defined in:
lib/action_dispatch/http/filter_parameters.rb

Overview

Allows you to specify sensitive parameters which will be replaced from the request log by looking 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:

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

Constant Summary collapse

@@parameter_filter_for =
{}

Instance Method Summary collapse

Instance Method Details

#filtered_envObject

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


37
38
39
# File 'lib/action_dispatch/http/filter_parameters.rb', line 37

def filtered_env
  @filtered_env ||= env_filter.filter(@env)
end

#filtered_parametersObject

Return a hash of parameters with all sensitive data replaced.


32
33
34
# File 'lib/action_dispatch/http/filter_parameters.rb', line 32

def filtered_parameters
  @filtered_parameters ||= parameter_filter.filter(parameters)
end