Module: ActionDispatch::Http::FilterParameters

Included in:
Request
Defined in:
actionpack/lib/action_dispatch/http/filter_parameters.rb

Overview

Allows you to specify sensitive query string and POST parameters to filter from the request log.

# Replaces values with "[FILTERED]" for keys that match /foo|bar/i.
env["action_dispatch.parameter_filter"] = [:foo, "bar"]

For more information about filter behavior, see ActiveSupport::ParameterFilter.

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.



35
36
37
 
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 35

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

#filtered_parameters ⇒ Object

Returns a hash of parameters with all sensitive data replaced.



28
29
30
31
32
 
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 28

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.



40
41
42
 
# 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

#initialize ⇒ Object 



19
20
21
22
23
24
25
 
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 19

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

#parameter_filter ⇒ Object

Returns the ActiveSupport::ParameterFilter object used to filter in this request.



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

def parameter_filter
  @parameter_filter ||= if has_header?("action_dispatch.parameter_filter")
    parameter_filter_for get_header("action_dispatch.parameter_filter")
  else
    NULL_PARAM_FILTER
  end
end