Module: ActionDispatch::Http::FilterParameters

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 the query string of the request and all sub-hashes of the params hash to filter. Filtering only certain sub-keys from a hash is possible by using the dot notation: ‘credit_card.number’. If a block is given, each key and value of the params hash and all sub-hashes are passed to it, where the value or the key can be replaced using String#replace or similar methods.

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"] = [ /\Apin\z/i, /\Apin_/i ]
=> replaces the value for the exact (case-insensitive) key 'pin' and all
(case-insensitive) keys beginning with 'pin_', with "[FILTERED]"
Does not match keys with 'pin' as a substring, such as 'shipping_id'.

env["action_dispatch.parameter_filter"] = [ "credit_card.code" ]
=> replaces { credit_card: {code: "xxxx"} } with "[FILTERED]", does not
change { file: { code: "xxxx"} }

env["action_dispatch.parameter_filter"] = -> (k, v) do
  v.reverse! if k.match?(/secret/i)
end
=> reverses the value to all keys matching /secret/i

Constant Summary collapse

ENV_MATCH =

:nodoc:

[/RAW_POST_DATA/, "rack.request.form_vars"]
NULL_PARAM_FILTER =

:nodoc:

ActiveSupport::ParameterFilter.new
NULL_ENV_FILTER =

:nodoc:

ActiveSupport::ParameterFilter.new ENV_MATCH

Instance Method Summary collapse

Instance Method Details

#filtered_env ⇒ Object

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



54
55
56
 
# File 'lib/action_dispatch/http/filter_parameters.rb', line 54

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

#filtered_parameters ⇒ Object

Returns a hash of parameters with all sensitive data replaced.



47
48
49
50
51
 
# File 'lib/action_dispatch/http/filter_parameters.rb', line 47

def filtered_parameters
  @filtered_parameters ||= parameter_filter.filter(parameters)
rescue ActionDispatch::Http::Parameters::ParseError
  @filtered_parameters = {}
end

#filtered_path ⇒ Object

Reconstructs a path with all sensitive GET parameters replaced.



59
60
61
 
# File 'lib/action_dispatch/http/filter_parameters.rb', line 59

def filtered_path
  @filtered_path ||= query_string.empty? ? path : "#{path}?#{filtered_query_string}"
end

#initialize ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/action_dispatch/http/filter_parameters.rb', line 39

def initialize
  super
  @filtered_parameters = nil
  @filtered_env        = nil
  @filtered_path       = nil
end