Rails HTML Sanitizers 这个 gem 负责对 Rails 应用程序中的 HTML 片段进行清洗。具体来说,这是一组用于清洗 HTML 片段的函数:
Rails HTML Sanitizers 这个 gem 负责对 Rails 应用程序中的 HTML 片段进行清洗。具体来说,这是一组用于清洗 HTML 片段的函数:
This gem is responsible for sanitizing HTML fragments in Rails applications. Specifically, this is the set of sanitizers used to implement the Action View SanitizerHelper methods sanitize, sanitize_css, strip_tags and strip_links.
Rails HTML Sanitizer is only intended to be used with Rails applications. If you need similar functionality but aren't using Rails, consider using the underlying sanitization library Loofah directly.
All sanitizers respond to sanitize, and are available in variants that use either HTML4 or HTML5 parsing, under the Rails::HTML4 and Rails::HTML5 namespaces, respectively.
NOTE: The HTML5 sanitizers are not supported on JRuby. Users may programmatically check for support by calling Rails::HTML::Sanitizer.html5_support?.
full_sanitizer = Rails::HTML5::FullSanitizer.new
full_sanitizer.sanitize("Bold no more! See more here...")
# => Bold no more! See more here...or, if you insist on parsing the content as HTML4:
full_sanitizer = Rails::HTML4::FullSanitizer.new
full_sanitizer.sanitize("Bold no more! See more here...")
# => Bold no more! See more here...link_sanitizer = Rails::HTML5::LinkSanitizer.new
link_sanitizer.sanitize('Only the link text will be kept.')
# => Only the link text will be kept.or, if you insist on parsing the content as HTML4:
link_sanitizer = Rails::HTML4::LinkSanitizer.new
link_sanitizer.sanitize('Only the link text will be kept.')
# => Only the link text will be kept.This sanitizer is also available as an HTML4 variant, but for simplicity we'll document only the HTML5 variant below.
…Scrubbers are objects responsible for removing nodes or attributes you don't want in your HTML document.
This gem includes two scrubbers Rails::HTML::PermitScrubber and Rails::HTML::TargetScrubber.
Rails::HTML::PermitScrubberThis scrubber allows you to permit only the tags and attributes you want.
scrubber = Rails::HTML::PermitScrubber.new
scrubber.tags = ['a']
html_fragment = Loofah.fragment('')
html_fragment.scrub!(scrubber)
html_fragment.to_s # => ""By default, inner content is left, but it can be removed as well.
scrubber = Rails::HTML::PermitScrubber.new
scrubber.tags = ['a']
html_fragment = Loofah.fragment('text')
html_fragment.scrub!(scrubber)
html_fragment.to_s # => "text"
scrubber = Rails::HTML::PermitScrubber.new(prune: true)
scrubber.tags = ['a']
html_fragment = Loofah.fragment('text')
html_fragment.scrub!(scrubber)
html_fragment.to_s # => ""Rails::HTML::TargetScrubberWhere PermitScrubber picks out tags and attributes to permit in sanitization,
Rails::HTML::TargetScrubber targets them for removal. See https://github.com/flavorjones/loofah/blob/main/lib/loofah/html5/safelist.rb for the tag list.
Note: by default, it will scrub anything that is not part of the permitted tags from
loofah HTML5::Scrub.allowed_element?.
scrubber = Rails::HTML::TargetScrubber.new
scrubber.tags = ['img']
html_fragment = Loofah.fragment('')
html_fragment.scrub!(scrubber)
html_fragment.to_s # => ""Similarly to PermitScrubber, nodes can be fully pruned.
scrubber = Rails::HTML::TargetScrubber.new
scrubber.tags = ['span']
html_fragment = Loofah.fragment('text')
html_fragment.scrub!(scrubber)
html_fragment.to_s # => "text"
scrubber = Rails::HTML::TargetScrubber.new(prune: true)
scrubber.tags = ['span']
html_fragment = Loofah.fragment('text')
html_fragment.scrub!(scrubber)
html_fragment.to_s # => ""You can also create custom scrubbers in your application if you want to.
class CommentScrubber Rails HTML sanitizers are intended to be used by the view layer, at page-render time. They are not intended to sanitize persisted strings that will be sanitized again at page-render time.
Proper HTML sanitization will replace some characters with HTML entities. For example, text containing a `= 2.7 | yes | yes | | 1.5.x | >= 2.5 | no | while Rails 6.1 is in security support | | 1.4.x | >= 1.8.7 | no | no |
Loofah is what underlies the sanitizers and scrubbers of rails-html-sanitizer.
The node argument passed to some methods in a custom scrubber is an instance of Nokogiri::XML::Node.
Rails HTML Sanitizers is work of many contributors. You're encouraged to submit pull requests, propose features and discuss issues.
See CONTRIBUTING.
Trying to report a possible security vulnerability in this project? Please check out the Rails project's security policy for instructions.
Rails HTML Sanitizers is released under the MIT License.
暂无开放 Issues,或尚未同步最近议题。