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. Filtering only certain sub-keys from a hash is possible by using the dot notation: ‘credit_card.number’. If a block is given, each key and value of the params hash and all sub-hashes is passed to it, where the value or the 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"] = [ "credit_card.code" ]
#=> replaces { credit_card: {code: "xxxx"} } with "[FILTERED]", does not
change { file: { code: "xxxx"} }

env["action_dispatch.parameter_filter"] = -> (k, v) do
  v.reverse! if k =~ /secret/i
end
#=> reverses the value to all keys matching /secret/i

Constant Summary

Instance Method Summary

Instance Method Details

#env_filter (private)

[ GitHub ] 

  


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



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.


  



  [ GitHub ]


  

  


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



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 42



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


  








  

    #filtered_path  
  



  

    

Reconstructs a path with all sensitive GET parameters replaced.


  



  [ GitHub ]


  

  


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



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 77



def filtered_query_string # :doc:
  query_string.gsub(PAIR_RE) do |_|
    parameter_filter.filter($1 => $2).first.join("=")
  end
end


  








  

    #initialize  
  

  [ GitHub ]


  

  


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



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


  








  

    #parameter_filter   (private)
  

  [ GitHub ]


  

  


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



def parameter_filter # :doc:
  parameter_filter_for fetch_header("action_dispatch.parameter_filter") {
    return NULL_PARAM_FILTER
  }
end


  








  

    #parameter_filter_for(filters)   (private)
  

  [ GitHub ]


  

  


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



def parameter_filter_for(filters) # :doc:
  ParameterFilter.new(filters)
end