123456789_123456789_123456789_123456789_123456789_

Module: ActionDispatch::Http::FilterParameters

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
ActionController::TestRequest, ::ActionDispatch::Request, ::ActionDispatch::TestRequest
Defined in: actionpack/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. If a block is given, each key and value of the params hash and all sub-hashes is passed to it, the value or key can be replaced using String#replace or similar method.

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"] = lambda do |k,v|
  v.reverse! if k =~ /secret/i
end
#=> reverses the value to all keys matching /secret/i

Constant Summary

Instance Method Summary

Instance Method Details

#filtered_env

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

[ GitHub ] 

  


# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 41



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


  








  

    #filtered_parameters  
  



  

    

Return a hash of parameters with all sensitive data replaced.


  



  [ GitHub ]


  

  


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



def filtered_parameters
  @filtered_parameters ||= parameter_filter.filter(parameters)
end


  








  

    #filtered_path  
  



  

    

Reconstructed a path with all sensitive GET parameters replaced.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 46



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


  








  

    #initialize(env)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/http/filter_parameters.rb', line 28



def initialize(env)
  super
  @filtered_parameters = nil
  @filtered_env        = nil
  @filtered_path       = nil
end