Module: ActionDispatch::Http::FilterParameters
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | actionpack/lib/action_dispatch/http/filter_parameters.rb |
Overview
Action Dispatch HTTP Filter Parameters
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
-
ENV_MATCH =
Internal use only
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 20[/RAW_POST_DATA/, "rack.request.form_vars"]
-
NULL_ENV_FILTER =
Internal use only
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 22ActiveSupport::ParameterFilter.new ENV_MATCH
-
NULL_PARAM_FILTER =
Internal use only
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 21ActiveSupport::ParameterFilter.new
Instance Method Summary
-
#filtered_env
Returns a hash of request.env with all sensitive data replaced.
-
#filtered_parameters
Returns a hash of parameters with all sensitive data replaced.
-
#filtered_path
Reconstructs a path with all sensitive GET parameters replaced.
- #initialize
-
#parameter_filter
Returns the
::ActiveSupport::ParameterFilter
object used to filter in this request. - #env_filter private
- #filtered_query_string private
- #parameter_filter_for(filters) private
Instance Method Details
#env_filter (private)
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 60
def env_filter # :doc: user_key = fetch_header("action_dispatch.parameter_filter") { return NULL_ENV_FILTER } parameter_filter_for(Array(user_key) + ENV_MATCH) end
#filtered_env
Returns a hash of request.env with all sensitive data replaced.
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 40
def filtered_env @filtered_env ||= env_filter.filter(@env) end
#filtered_parameters
Returns a hash of parameters with all sensitive data replaced.
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 33
def filtered_parameters @filtered_parameters ||= parameter_filter.filter(parameters) rescue ActionDispatch::Http::Parameters::ParseError @filtered_parameters = {} end
#filtered_path
Reconstructs a path with all sensitive GET parameters replaced.
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 45
def filtered_path @filtered_path ||= query_string.empty? ? path : "#{path}?#{filtered_query_string}" end
#filtered_query_string (private)
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 71
def filtered_query_string # :doc: parts = query_string.split(/([&;])/) filtered_parts = parts.map do |part| if part.include?("=") key, value = part.split("=", 2) parameter_filter.filter(key => value).first.join("=") else part end end filtered_parts.join("") end
#initialize
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 24
def initialize super @filtered_parameters = nil @filtered_env = nil @filtered_path = nil @parameter_filter = nil end
#parameter_filter
Returns the ::ActiveSupport::ParameterFilter
object used to filter in this request.
# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 51
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
#parameter_filter_for(filters) (private)
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 67
def parameter_filter_for(filters) # :doc: ActiveSupport::ParameterFilter.new(filters) end