модуль ERB::Util

Утилитарный метод для экранирования символов тегов HTML. Этот метод также имеет псевдоним h.

В ваших шаблонах ERB используйте этот метод для экранирования любых небезопасных данных. Например:

<%=h @person.name %>

puts html_escape('is a > 0 & a < 10?')
# => is a &gt; 0 &amp; a &lt; 10?

# File activesupport/lib/active_support/core_ext/string/output_safety.rb, line 20
def html_escape(s)
  s = s.to_s
  if s.html_safe?
    s
  else
    s.gsub(HTML_ESCAPE_REGEXP, HTML_ESCAPE).html_safe
  end
end

Утилитарный метод для экранирования HTML без воздействия на существующие экранированные сущности.

html_escape_once('1 < 2 &amp; 3')
# => "1 &lt; 2 &amp; 3"

html_escape_once('&lt;&lt; Accept & Checkout')
# => "&lt;&lt; Accept &amp; Checkout"

# File activesupport/lib/active_support/core_ext/string/output_safety.rb, line 45
def html_escape_once(s)
  result = s.to_s.gsub(HTML_ESCAPE_ONCE_REGEXP, HTML_ESCAPE)
  s.html_safe? ? result.html_safe : result
end

Утилитарный метод для экранирования сущностей HTML в строках JSON. В частности, символы &, > и < заменяются на их эквивалентные unicode-экранированные формы - u0026, u003e и u003c. Последовательности Unicode u2028 и u2029 также экранируются, так как они рассматриваются как символы новой строки в некоторых движках JavaScript. Эти последовательности имеют идентичное значение, как исходные символы в контексте строки JSON, поэтому, предполагая, что вход является валидным и правильно сформированным значением JSON, вывод будет иметь эквивалентное значение при разборе:

json = JSON.generate({ name: "</script><script>alert('PWNED!!!')</script>"})
# => "{\"name\":\"</script><script>alert('PWNED!!!')</script>\"}"

json_escape(json)
# => "{\"name\":\"\\u003C/script\\u003E\\u003Cscript\\u003Ealert('PWNED!!!')\\u003C/script\\u003E\"}"

JSON.parse(json) == JSON.parse(json_escape(json))
# => true

Предполагаемый сценарий использования этого метода заключается в экранировании строк JSON перед их включением в тег script для предотвращения уязвимости XSS:

<script>
  var currentUser = <%= raw json_escape(current_user.to_json) %>;
</script>

Необходимо raw результат json_escape, чтобы кавычки не были преобразованы в " сущности. json_escape не автоматически помечает результат как безопасный для HTML, так как исходное значение небезопасно для использования внутри атрибутов HTML.

Если вам нужно выводить JSON в другом месте вашего HTML, вы можете сделать что-то вроде этого, так как все небезопасные символы (включая кавычки) будут автоматически экранированы для вас:

<div data-user-info="<%= current_user.to_json %>">...</div>

ВНИМАНИЕ: этот помощник работает только с корректными значениями JSON. Использование его с не-JSON значениями откроет серьезные уязвимости XSS. Например, если вы замените current_user.to_json в примере выше на пользовательский ввод, браузер с удовольствием eval() этой строки как JavaScript.

Экранирование, выполненное в этом методе, идентично тому, что выполняется в кодировщике JSON Active Support, когда ActiveSupport.escape_html_entities_in_json установлено в true. Поскольку это преобразование идемпотентно, этот помощник может быть применен даже если ActiveSupport.escape_html_entities_in_json уже true.

Поэтому, когда вы не уверены, включен ли ActiveSupport.escape_html_entities_in_json, или не уверены, откуда пришла ваша строка JSON, рекомендуется всегда применять этот помощник (другие библиотеки, такие как драгоценный камень JSON, не предоставляют такого рода защиты по умолчанию; также некоторые драгоценные камни могут переопределять to_json для обхода кодировщика Active Support).

# File activesupport/lib/active_support/core_ext/string/output_safety.rb, line 102
def json_escape(s)
  result = s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_ESCAPE)
  s.html_safe? ? result.html_safe : result
end