# frozen_string_literal: true require "active_support/parameter_filter" module ActionDispatch module Http # = 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. module FilterParameters ENV_MATCH = [/RAW_POST_DATA/, "rack.request.form_vars"] # :nodoc: NULL_PARAM_FILTER = ActiveSupport::ParameterFilter.new # :nodoc: NULL_ENV_FILTER = ActiveSupport::ParameterFilter.new ENV_MATCH # :nodoc: def initialize super @filtered_parameters = nil @filtered_env = nil @filtered_path = nil @parameter_filter = nil end # Returns a hash of parameters with all sensitive data replaced. def filtered_parameters @filtered_parameters ||= parameter_filter.filter(parameters) rescue ActionDispatch::Http::Parameters::ParseError @filtered_parameters = {} end # Returns a hash of request.env with all sensitive data replaced. def filtered_env @filtered_env ||= env_filter.filter(@env) end # Reconstructs a path with all sensitive GET parameters replaced. def filtered_path @filtered_path ||= query_string.empty? ? path : "#{path}?#{filtered_query_string}" end # Returns the +ActiveSupport::ParameterFilter+ object used to filter in this request. 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 private 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 def parameter_filter_for(filters) # :doc: ActiveSupport::ParameterFilter.new(filters) end 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 end end end