модуль ActionDispatch::Http::FilterParameters

Позволяет указать чувствительные параметры, которые будут заменены в журнале запроса, просматривая строку запроса и все вложенные хэши в хэше параметров для фильтрации. Фильтрация определенных подключаемых ключей из хэша возможна с использованием нотации точек: 'credit_card.number'. Если указан блок, каждый ключ и значение хэша параметров и всех вложенных хэшей передаются в него, где значение или ключ могут быть заменены с помощью методов String#replace или подобных.

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"] = [ /\Apin\z/i, /\Apin_/i ]
=> replaces the value for the exact (case-insensitive) key 'pin' and all
(case-insensitive) keys beginning with 'pin_', with "[FILTERED]"
Does not match keys with 'pin' as a substring, such as 'shipping_id'.

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.match?(/secret/i)
end
=> reverses the value to all keys matching /secret/i

Константы

KV_RE
PAIR_RE

Публичные методы класса

new() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 39
def initialize
  super
  @filtered_parameters = nil
  @filtered_env        = nil
  @filtered_path       = nil
end

Вызывает метод суперкласса

Публичные методы экземпляра

filtered_env() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 54
def filtered_env
  @filtered_env ||= env_filter.filter(@env)
end

Возвращает хэш request.env с заменёнными всеми конфиденциальными данными.

filtered_parameters() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 47
def filtered_parameters
  @filtered_parameters ||= parameter_filter.filter(parameters)
rescue ActionDispatch::Http::Parameters::ParseError
  @filtered_parameters = {}
end

Возвращает хэш параметров со всеми заменёнными конфиденциальными данными.

filtered_path() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 59
def filtered_path
  @filtered_path ||= query_string.empty? ? path : "#{path}?#{filtered_query_string}"
end

Восстанавливает путь со всеми заменёнными конфиденциальными параметрами GET.

Приватные методы экземпляра

env_filter() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 70
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_query_string() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 83
def filtered_query_string # :doc:
  query_string.gsub(PAIR_RE) do |_|
    parameter_filter.filter($1 => $2).first.join("=")
  end
end

parameter_filter() Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 64
def parameter_filter # :doc:
  parameter_filter_for fetch_header("action_dispatch.parameter_filter") {
    return NULL_PARAM_FILTER
  }
end

parameter_filter_for(filters) Показать исходный код

# File actionpack/lib/action_dispatch/http/filter_parameters.rb, line 77
def parameter_filter_for(filters) # :doc:
  ActiveSupport::ParameterFilter.new(filters)
end