модуль ERB::Util

# File activesupport/lib/active_support/core_ext/string/output_safety.rb, line 19
def html_escape(s)
  unwrapped_html_escape(s).html_safe
end

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

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 50
def html_escape_once(s)
  result = ActiveSupport::Multibyte::Unicode.tidy_bytes(s.to_s).gsub(HTML_ESCAPE_ONCE_REGEXP, HTML_ESCAPE)
  s.html_safe? ? result.html_safe : result
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 112
def json_escape(s)
  result = s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_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 перед включением их в тег скрипта, чтобы избежать уязвимости XSS:

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

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

Если ваш JSON используется дальше для вставки в DOM, будьте внимательны к тому, как он вставляется в html(). Большинство плагинов jQuery делают это. Если это так, убедитесь, что вы html_escape или sanitize любое сгенерированное пользователем содержимое, возвращаемое вашим JSON.

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

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

ВНИМАНИЕ: этот помощник работает только с правильным JSON. Использование этого с не-JSON значениями откроет серьезные уязвимости XSS. Например, если вы замените current_user.to_json в приведенном выше примере пользовательским вводом, браузер с удовольствием выполнит эту строку как 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).