123456789_123456789_123456789_123456789_123456789_

Module: ActionDispatch::Http::FilterParameters

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::ActionCable::Connection::TestRequest, ActionController::TestRequest, ::ActionDispatch::Request, ::ActionDispatch::TestRequest
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.

Instance Method Summary

Instance Method Details

#filtered_env

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

[ GitHub ] 

  


# 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.


  



  [ GitHub ]


  

  


# 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.


  



  [ GitHub ]


  

  


# 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


  








  

    #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.


  



  [ GitHub ]


  

  


# 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