RubyGems - sanitize - Versions diffs - 2.1.1 → 6.0.0 - Mend

sanitize 2.1.1 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of sanitize might be problematic. Click here for more details.

Files changed (30) hide show

checksums.yaml +4 -4
data/HISTORY.md +520 -55
data/LICENSE +1 -1
data/README.md +438 -168
data/lib/sanitize/config/basic.rb +12 -32
data/lib/sanitize/config/default.rb +118 -0
data/lib/sanitize/config/relaxed.rb +716 -53
data/lib/sanitize/config/restricted.rb +3 -23
data/lib/sanitize/config.rb +53 -79
data/lib/sanitize/css.rb +348 -0
data/lib/sanitize/transformers/clean_cdata.rb +3 -3
data/lib/sanitize/transformers/clean_comment.rb +6 -3
data/lib/sanitize/transformers/clean_css.rb +57 -0
data/lib/sanitize/transformers/clean_doctype.rb +19 -0
data/lib/sanitize/transformers/clean_element.rb +192 -124
data/lib/sanitize/version.rb +3 -1
data/lib/sanitize.rb +172 -143
data/test/common.rb +3 -0
data/test/test_clean_comment.rb +47 -0
data/test/test_clean_css.rb +67 -0
data/test/test_clean_doctype.rb +71 -0
data/test/test_clean_element.rb +545 -0
data/test/test_config.rb +65 -0
data/test/test_malicious_css.rb +42 -0
data/test/test_malicious_html.rb +235 -0
data/test/test_parser.rb +75 -0
data/test/test_sanitize.rb +151 -675
data/test/test_sanitize_css.rb +424 -0
data/test/test_transformers.rb +230 -0
metadata +44 -41

data/README.md CHANGED Viewed

@@ -1,20 +1,37 @@
 Sanitize
 ========
-Sanitize is a whitelist-based HTML sanitizer. Given a list of acceptable
-elements and attributes, Sanitize will remove all unacceptable HTML from a
-string.
+Sanitize is an allowlist-based HTML and CSS sanitizer. It removes all HTML
+and/or CSS from a string except the elements, attributes, and properties you
+choose to allow.
-Using a simple configuration syntax, you can tell Sanitize to allow certain
+Using a simple configuration syntax, you can tell Sanitize to allow certain HTML
 elements, certain attributes within those elements, and even certain URL
-protocols within attributes that contain URLs. Any HTML elements or attributes
-that you don't explicitly allow will be removed.
+protocols within attributes that contain URLs. You can also allow specific CSS
+properties, @ rules, and URL protocols in elements or attributes containing CSS.
+Any HTML or CSS that you don't explicitly allow will be removed.
-Because it's based on Nokogiri, a full-fledged HTML parser, rather than a bunch
-of fragile regular expressions, Sanitize has no trouble dealing with malformed
-or maliciously-formed HTML and returning safe output.
+Sanitize is based on the [Nokogumbo HTML5 parser][nokogumbo], which parses HTML
+exactly the same way modern browsers do, and [Crass][crass], which parses CSS
+exactly the same way modern browsers do. As long as your allowlist config only
+allows safe markup and CSS, even the most malformed or malicious input will be
+transformed into safe output.
-[![Build Status](https://travis-ci.org/rgrove/sanitize.png?branch=master)](https://travis-ci.org/rgrove/sanitize?branch=master)
+[![Gem Version](https://badge.fury.io/rb/sanitize.svg)](http://badge.fury.io/rb/sanitize)
+[![Tests](https://github.com/rgrove/sanitize/workflows/Tests/badge.svg)](https://github.com/rgrove/sanitize/actions?query=workflow%3ATests)
+[crass]:https://github.com/rgrove/crass
+[nokogumbo]:https://github.com/rubys/nokogumbo
+Links
+-----
+* [Home](https://github.com/rgrove/sanitize/)
+* [API Docs](http://rubydoc.info/github/rgrove/sanitize/master)
+* [Issues](https://github.com/rgrove/sanitize/issues)
+* [Release History](https://github.com/rgrove/sanitize/blob/master/HISTORY.md#sanitize-history)
+* [Online Demo](https://sanitize.herokuapp.com/)
+* [Biased comparison of Ruby HTML sanitization libraries](https://github.com/rgrove/sanitize/blob/master/COMPARISON.md)
 Installation
 -------------
@@ -23,63 +40,206 @@ Installation
 gem install sanitize
 ```
+Quick Start
+-----------
+```ruby
+require 'sanitize'
+# Clean up an HTML fragment using Sanitize's permissive but safe Relaxed config.
+# This also sanitizes any CSS in `<style>` elements or `style` attributes.
+Sanitize.fragment(html, Sanitize::Config::RELAXED)
+# Clean up an HTML document using the Relaxed config.
+Sanitize.document(html, Sanitize::Config::RELAXED)
+# Clean up a standalone CSS stylesheet using the Relaxed config.
+Sanitize::CSS.stylesheet(css, Sanitize::Config::RELAXED)
+# Clean up some CSS properties using the Relaxed config.
+Sanitize::CSS.properties(css, Sanitize::Config::RELAXED)
+```
 Usage
 -----
+Sanitize can sanitize the following types of input:
+* HTML fragments
+* HTML documents
+* CSS stylesheets inside HTML `<style>` elements
+* CSS properties inside HTML `style` attributes
+* Standalone CSS stylesheets
+* Standalone CSS properties
+However, please note that Sanitize _cannot_ fully sanitize the contents of
+`<math>` or `<svg>` elements, since these elements don't follow the same parsing
+rules as the rest of HTML. If this is something you need, you may want to look
+for another solution.
+### HTML Fragments
+A fragment is a snippet of HTML that doesn't contain a root-level `<html>`
+element.
 If you don't specify any configuration options, Sanitize will use its strictest
-settings by default, which means it will strip all HTML and leave only text
+settings by default, which means it will strip all HTML and leave only safe text
 behind.
 ```ruby
-require 'rubygems'
-require 'sanitize'
+html = '<b><a href="http://foo.com/">foo</a></b><img src="bar.jpg">'
+Sanitize.fragment(html)
+# => 'foo'
+```
+To keep certain elements, add them to the element allowlist.
+```ruby
+Sanitize.fragment(html, :elements => ['b'])
+# => '<b>foo</b>'
+```
-html = '<b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg">'
+### HTML Documents
-Sanitize.clean(html) # => 'foo'
+When sanitizing a document, the `<html>` element must be allowlisted. You can
+also set `:allow_doctype` to `true` to allow well-formed document type
+definitions.
+```ruby
+html = %[
+  <!DOCTYPE html>
+  <html>
+    <b><a href="http://foo.com/">foo</a></b><img src="bar.jpg">
+  </html>
+]
+Sanitize.document(html,
+  :allow_doctype => true,
+  :elements      => ['html']
+)
+# => %[
+#   <!DOCTYPE html>
+#   <html>foo
+#
+#   </html>
+# ]
+```
+### CSS in HTML
+To sanitize CSS in an HTML fragment or document, first allowlist the `<style>`
+element and/or the `style` attribute. Then allowlist the CSS properties,
+@ rules, and URL protocols you wish to allow. You can also choose whether to
+allow CSS comments or browser compatibility hacks.
+```ruby
+html = %[
+  <style>
+    div { color: green; width: 1024px; }
+  </style>
+  <div style="height: 100px; width: 100px;"></div>
+  <p>hello!</p>
+]
+Sanitize.fragment(html,
+  :elements   => ['div', 'style'],
+  :attributes => {'div' => ['style']},
+  :css => {
+    :properties => ['width']
+  }
+)
+#=> %[
+#   <style>
+#     div {  width: 1024px; }
+#   </style>
+#
+#   <div style=" width: 100px;"></div>
+#   hello!
+# ]
+```
+### Standalone CSS
+Sanitize will happily clean up a standalone CSS stylesheet or property string
+without needing to invoke the HTML parser.
+```ruby
+css = %[
+  @import url(evil.css);
+  a { text-decoration: none; }
+  a:hover {
+    left: expression(alert('xss!'));
+    text-decoration: underline;
+  }
+]
+Sanitize::CSS.stylesheet(css, Sanitize::Config::RELAXED)
+# => %[
+#
+#
+#
+#   a { text-decoration: none; }
+#
+#   a:hover {
+#
+#     text-decoration: underline;
+#   }
+# ]
+Sanitize::CSS.properties(%[
+  left: expression(alert('xss!'));
+  text-decoration: underline;
+], Sanitize::Config::RELAXED)
+# => %[
+#
+#   text-decoration: underline;
+# ]
-# or sanitize an entire HTML document (example assumes _html_ is whitelisted)
-html = '<!DOCTYPE html><html><b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg"></html>'
-Sanitize.clean_document(html) # => '<!DOCTYPE html>\n<html>foo</html>\n'
 ```
 Configuration
 -------------
 In addition to the ultra-safe default settings, Sanitize comes with three other
-built-in modes.
+built-in configurations that you can use out of the box or adapt to meet your
+needs.
 ### Sanitize::Config::RESTRICTED
-Allows only very simple inline formatting markup. No links, images, or block
-elements.
+Allows only very simple inline markup. No links, images, or block elements.
 ```ruby
-Sanitize.clean(html, Sanitize::Config::RESTRICTED) # => '<b>foo</b>'
+Sanitize.fragment(html, Sanitize::Config::RESTRICTED)
+# => '<b>foo</b>'
 ```
 ### Sanitize::Config::BASIC
-Allows a variety of markup including formatting tags, links, and lists. Images
-and tables are not allowed, links are limited to FTP, HTTP, HTTPS, and mailto
-protocols, and a `rel="nofollow"` attribute is added to all links to
+Allows a variety of markup including formatting elements, links, and lists.
+Images and tables are not allowed, links are limited to FTP, HTTP, HTTPS, and
+mailto protocols, and a `rel="nofollow"` attribute is added to all links to
 mitigate SEO spam.
 ```ruby
-Sanitize.clean(html, Sanitize::Config::BASIC)
+Sanitize.fragment(html, Sanitize::Config::BASIC)
 # => '<b><a href="http://foo.com/" rel="nofollow">foo</a></b>'
 ```
 ### Sanitize::Config::RELAXED
-Allows an even wider variety of markup than BASIC, including images and tables.
-Links are still limited to FTP, HTTP, HTTPS, and mailto protocols, while images
-are limited to HTTP and HTTPS. In this mode, `rel="nofollow"` is not added to
-links.
+Allows an even wider variety of markup, including images and tables, as well as
+safe CSS. Links are still limited to FTP, HTTP, HTTPS, and mailto protocols,
+while images are limited to HTTP and HTTPS. In this mode, `rel="nofollow"` is
+not added to links.
 ```ruby
-Sanitize.clean(html, Sanitize::Config::RELAXED)
-# => '<b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg">'
+Sanitize.fragment(html, Sanitize::Config::RELAXED)
+# => '<b><a href="http://foo.com/">foo</a></b><img src="bar.jpg">'
 ```
 ### Custom Configuration
@@ -88,11 +248,51 @@ If the built-in modes don't meet your needs, you can easily specify a custom
 configuration:
 ```ruby
-Sanitize.clean(html, :elements => ['a', 'span'],
-    :attributes => {'a' => ['href', 'title'], 'span' => ['class']},
-    :protocols => {'a' => {'href' => ['http', 'https', 'mailto']}})
+Sanitize.fragment(html,
+  :elements => ['a', 'span'],
+  :attributes => {
+    'a'    => ['href', 'title'],
+    'span' => ['class']
+  },
+  :protocols => {
+    'a' => {'href' => ['http', 'https', 'mailto']}
+  }
+)
+```
+You can also start with one of Sanitize's built-in configurations and then
+customize it to meet your needs.
+The built-in configs are deeply frozen to prevent people from modifying them
+(either accidentally or maliciously). To customize a built-in config, create a
+new copy using `Sanitize::Config.merge()`, like so:
+```ruby
+# Create a customized copy of the Basic config, adding <div> and <table> to the
+# existing allowlisted elements.
+Sanitize.fragment(html, Sanitize::Config.merge(Sanitize::Config::BASIC,
+  :elements        => Sanitize::Config::BASIC[:elements] + ['div', 'table'],
+  :remove_contents => true
+))
 ```
+The example above adds the `<div>` and `<table>` elements to a copy of the
+existing list of elements in `Sanitize::Config::BASIC`. If you instead want to
+completely overwrite the elements array with your own, you can omit the `+`
+operation:
+```ruby
+# Overwrite :elements instead of creating a copy with new entries.
+Sanitize.fragment(html, Sanitize::Config.merge(Sanitize::Config::BASIC,
+  :elements        => ['div', 'table'],
+  :remove_contents => true
+))
+```
+### Config Settings
 #### :add_attributes (Hash)
 Attributes to add to specific elements. If the attribute already exists, it will
@@ -111,9 +311,15 @@ Whether or not to allow HTML comments. Allowing comments is strongly
 discouraged, since IE allows script execution within conditional comments. The
 default value is `false`.
+#### :allow_doctype (boolean)
+Whether or not to allow well-formed HTML doctype declarations such as "<!DOCTYPE
+html>" when sanitizing a document. This setting is ignored when sanitizing
+fragments. The default value is `false`.
 #### :attributes (Hash)
-Attributes to allow for specific elements. Specify all element names and
+Attributes to allow on specific elements. Specify all element names and
 attributes in lowercase.
 ```ruby
@@ -124,8 +330,8 @@ attributes in lowercase.
 }
 ```
-If you'd like to allow certain attributes on all elements, use the symbol
-`:all` instead of an element name.
+If you'd like to allow certain attributes on all elements, use the symbol `:all`
+instead of an element name.
 ```ruby
 # Allow the class attribute on all elements.
@@ -135,8 +341,8 @@ If you'd like to allow certain attributes on all elements, use the symbol
 }
 ```
-To allow arbitrary HTML5 `data-*` attributes, use the symbol
-`:data` in place of an attribute name.
+To allow arbitrary HTML5 `data-*` attributes, use the symbol `:data` in place of
+an attribute name.
 ```ruby
 # Allow arbitrary HTML5 data-* attributes on <div> elements.
@@ -145,9 +351,67 @@ To allow arbitrary HTML5 `data-*` attributes, use the symbol
 }
 ```
-#### :elements (Array)
+#### :css (Hash)
+Hash of the following CSS config settings to be used when sanitizing CSS (either
+standalone or embedded in HTML).
+##### :css => :allow_comments (boolean)
+Whether or not to allow CSS comments. The default value is `false`.
+##### :css => :allow_hacks (boolean)
+Whether or not to allow browser compatibility hacks such as the IE `*` and `_`
+hacks. These are generally harmless, but technically result in invalid CSS. The
+default is `false`.
+##### :css => :at_rules (Array or Set)
+Names of CSS [at-rules][at-rules] to allow that may not have associated blocks,
+such as `import` or `charset`. Names should be specified in lowercase.
+[at-rules]:https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule
+##### :css => :at_rules_with_properties (Array or Set)
+Names of CSS [at-rules][at-rules] to allow that may have associated blocks
+containing CSS properties. At-rules like `font-face` and `page` fall into this
+category. Names should be specified in lowercase.
+##### :css => :at_rules_with_styles (Array or Set)
+Names of CSS [at-rules][at-rules] to allow that may have associated blocks
+containing style rules. At-rules like `media` and `keyframes` fall into this
+category. Names should be specified in lowercase.
+##### :css => :import_url_validator
+This is a `Proc` (or other callable object) that will be called and passed
+the URL specified for any `@import` [at-rules][at-rules].
-Array of element names to allow. Specify all names in lowercase.
+You can use this to limit what can be imported, for example something
+like the following to limit `@import` to Google Fonts URLs:
+```ruby
+Proc.new { |url| url.start_with?("https://fonts.googleapis.com") }
+```
+##### :css => :properties (Array or Set)
+List of CSS property names to allow. Names should be specified in lowercase.
+##### :css => :protocols (Array or Set)
+URL protocols to allow in CSS URLs. Should be specified in lowercase.
+If you'd like to allow the use of relative URLs which don't have a protocol,
+include the symbol `:relative` in the protocol array.
+#### :elements (Array or Set)
+Array of HTML element names to allow. Specify all names in lowercase. Any
+elements not in this array will be removed.
 ```ruby
 :elements => %w[
@@ -156,14 +420,22 @@ Array of element names to allow. Specify all names in lowercase.
 ]
 ```
-#### :output (Symbol)
+**Warning:** Sanitize cannot fully sanitize the contents of `<math>` or `<svg>`
+elements, since these elements don't follow the same parsing rules as the rest
+of HTML. If you add `math` or `svg` to the allowlist, you must assume that any
+content inside them will be allowed, even if that content would otherwise be
+removed by Sanitize.
-Output format. Supported formats are `:html` and `:xhtml`,
-defaulting to `:html`.
+#### :parser_options (Hash)
-#### :output_encoding (String)
+[Parsing options](https://github.com/rubys/nokogumbo/tree/master#parsing-options) to be supplied to `nokogumbo`.
-Character encoding to use for HTML output. Default is `utf-8`.
+```ruby
+:parser_options => {
+  max_errors: -1,
+  max_tree_depth: -1
+}
+```
 #### :protocols (Hash)
@@ -187,99 +459,106 @@ include the symbol `:relative` in the protocol array:
 }
 ```
-#### :remove_contents (boolean or Array)
+#### :remove_contents (boolean or Array or Set)
-If set to +true+, Sanitize will remove the contents of any non-whitelisted
+If this is `true`, Sanitize will remove the contents of any non-allowlisted
 elements in addition to the elements themselves. By default, Sanitize leaves the
 safe parts of an element's contents behind when the element is removed.
-If set to an array of element names, then only the contents of the specified
-elements (when filtered) will be removed, and the contents of all other filtered
-elements will be left behind.
+If this is an Array or Set of element names, then only the contents of the
+specified elements (when filtered) will be removed, and the contents of all
+other filtered elements will be left behind.
-The default value is `false`.
+The default value is `%w[iframe math noembed noframes noscript plaintext script style svg xmp]`.
-#### :transformers
+#### :transformers (Array or callable)
-Custom transformer or array of custom transformers to run using depth-first
-traversal. See the Transformers section below for details.
+Custom HTML transformer or array of custom transformers. See the Transformers
+section below for details.
-#### :transformers_breadth
+#### :whitespace_elements (Hash)
-Custom transformer or array of custom transformers to run using breadth-first
-traversal. See the Transformers section below for details.
+Hash of element names which, when removed, should have their contents surrounded
+by whitespace to preserve readability.
-#### :whitespace_elements (Array)
+Each element name is a key pointing to another Hash, which provides the specific
+whitespace that should be inserted `:before` and `:after` the removed element's
+position. The `:after` value will only be inserted if the removed element has
+children, in which case it will be inserted after those children.
-Array of lowercase element names that should be replaced with whitespace when
-removed in order to preserve readability. For example,
-`foo<div>bar</div>baz` will become
-`foo bar baz` when the `<div>` is removed.
+```ruby
+:whitespace_elements => {
+  'br'  => { :before => "\n", :after => "" },
+  'div' => { :before => "\n", :after => "\n" },
+  'p'   => { :before => "\n", :after => "\n" }
+}
+```
-By default, the following elements are included in the
-`:whitespace_elements` array:
+The default elements with whitespace added before and after are:
 ```
-address article aside blockquote br dd div dl dt footer h1 h2 h3 h4 h5
-h6 header hgroup hr li nav ol p pre section ul
+address article aside blockquote br dd div dl dt
+footer h1 h2 h3 h4 h5 h6 header hgroup hr li nav
+ol p pre section ul
 ```
-### Transformers
+## Transformers
-Transformers allow you to filter and modify nodes using your own custom logic,
-on top of (or instead of) Sanitize's core filter. A transformer is any object
-that responds to `call()` (such as a lambda or proc).
+Transformers allow you to filter and modify HTML nodes using your own custom
+logic, on top of (or instead of) Sanitize's core filter. A transformer is any
+object that responds to `call()` (such as a lambda or proc).
-To use one or more transformers, pass them to the `:transformers`
-config setting. You may pass a single transformer or an array of transformers.
+To use one or more transformers, pass them to the `:transformers` config
+setting. You may pass a single transformer or an array of transformers.
 ```ruby
-Sanitize.clean(html, :transformers => [transformer_one, transformer_two])
+Sanitize.fragment(html, :transformers => [
+  transformer_one,
+  transformer_two
+])
 ```
-#### Input
+### Input
-Each registered transformer's `call()` method will be called once for
-each node in the HTML (including elements, text nodes, comments, etc.), and will
-receive as an argument an environment Hash that contains the following items:
+Each transformer's `call()` method will be called once for each node in the HTML
+(including elements, text nodes, comments, etc.), and will receive as an
+argument a Hash that contains the following items:
   * **:config** - The current Sanitize configuration Hash.
-  * **:is_whitelisted** - `true` if the current node has been whitelisted by a
+  * **:is_allowlisted** - `true` if the current node has been allowlisted by a
     previous transformer, `false` otherwise. It's generally bad form to remove
-    a node that a previous transformer has whitelisted.
+    a node that a previous transformer has allowlisted.
   * **:node** - A `Nokogiri::XML::Node` object representing an HTML node. The
     node may be an element, a text node, a comment, a CDATA node, or a document
     fragment. Use Nokogiri's inspection methods (`element?`, `text?`, etc.) to
     selectively ignore node types you aren't interested in.
+  * **:node_allowlist** - Set of `Nokogiri::XML::Node` objects in the current
+    document that have been allowlisted by previous transformers, if any. It's
+    generally bad form to remove a node that a previous transformer has
+    allowlisted.
   * **:node_name** - The name of the current HTML node, always lowercase (e.g.
     "div" or "span"). For non-element nodes, the name will be something like
     "text", "comment", "#cdata-section", "#document-fragment", etc.
-  * **:node_whitelist** - Set of `Nokogiri::XML::Node` objects in the current
-    document that have been whitelisted by previous transformers, if any. It's
-    generally bad form to remove a node that a previous transformer has
-    whitelisted.
-  * **:traversal_mode** - Current node traversal mode, either `:depth` for
-    depth-first (the default mode) or `:breadth` for breadth-first.
-#### Output
+### Output
 A transformer doesn't have to return anything, but may optionally return a Hash,
 which may contain the following items:
-  * **:node_whitelist** -  Array or Set of specific Nokogiri::XML::Node objects
-    to add to the document's whitelist, bypassing the current Sanitize config.
-    These specific nodes and all their attributes will be whitelisted, but
-    their children will not be.
+  * **:node_allowlist** -  Array or Set of specific `Nokogiri::XML::Node`
+    objects to add to the document's allowlist, bypassing the current Sanitize
+    config. These specific nodes and all their attributes will be allowlisted,
+    but their children will not be.
 If a transformer returns anything other than a Hash, the return value will be
 ignored.
-#### Processing
+### Processing
 Each transformer has full access to the `Nokogiri::XML::Node` that's passed into
 it and to the rest of the document via the node's `document()` method. Any
@@ -288,58 +567,85 @@ in the document and passed on to subsequently called transformers and to
 Sanitize itself. A transformer may even call Sanitize internally to perform
 custom sanitization if needed.
-Nodes are passed into transformers in the order in which they're traversed. By
-default, depth-first traversal is used, meaning that markup is traversed from
-the deepest node upward (not from the first node to the last node):
+Nodes are passed into transformers in the order in which they're traversed.
+Sanitize performs top-down traversal, meaning that nodes are traversed in the
+same order you'd read them in the HTML, starting at the top node, then its first
+child, and so on.
 ```ruby
-html        = '<div><span>foo</span></div>'
-transformer = lambda{|env| puts env[:node_name] }
-# Prints "text", "span", "div", "#document-fragment".
-Sanitize.clean(html, :transformers => transformer)
-```
-You may use the `:transformers_breadth` config to specify one or more
-transformers that should traverse nodes in breadth-first mode:
+html = %[
+  <header>
+    <span>
+      <strong>foo</strong>
+    </span>
+    <p>bar</p>
+  </header>
+  <footer></footer>
+]
-```ruby
-html        = '<div><span>foo</span></div>'
-transformer = lambda{|env| puts env[:node_name] }
+transformer = lambda do |env|
+  puts env[:node_name] if env[:node].element?
+end
-# Prints "#document-fragment", "div", "span", "text".
-Sanitize.clean(html, :transformers_breadth => transformer)
+# Prints "header", "span", "strong", "p", "footer".
+Sanitize.fragment(html, :transformers => transformer)
 ```
 Transformers have a tremendous amount of power, including the power to
 completely bypass Sanitize's built-in filtering. Be careful! Your safety is in
 your own hands.
-#### Example: Transformer to whitelist YouTube video embeds
+### Example: Transformer to allow image URLs by domain
+The following example demonstrates how to remove image elements unless they use
+a relative URL or are hosted on a specific domain. It assumes that the `<img>`
+element and its `src` attribute are already allowlisted.
+```ruby
+require 'uri'
+image_allowlist_transformer = lambda do |env|
+  # Ignore everything except <img> elements.
+  return unless env[:node_name] == 'img'
+  node      = env[:node]
+  image_uri = URI.parse(node['src'])
+  # Only allow relative URLs or URLs with the example.com domain. The
+  # image_uri.host.nil? check ensures that protocol-relative URLs like
+  # "//evil.com/foo.jpg".
+  unless image_uri.host == 'example.com' || (image_uri.host.nil? && image_uri.relative?)
+    node.unlink # `Nokogiri::XML::Node#unlink` removes a node from the document
+  end
+end
+```
+### Example: Transformer to allow YouTube video embeds
-The following example demonstrates how to create a depth-first Sanitize
-transformer that will safely whitelist valid YouTube video embeds without having
-to blindly allow other kinds of embedded content, which would be the case if you
-tried to do this by just whitelisting all `<iframe>` elements:
+The following example demonstrates how to create a transformer that will safely
+allow valid YouTube video embeds without having to allow other kinds of embedded
+content, which would be the case if you tried to do this by just allowing all
+`<iframe>` elements:
 ```ruby
-lambda do |env|
+youtube_transformer = lambda do |env|
   node      = env[:node]
   node_name = env[:node_name]
-  # Don't continue if this node is already whitelisted or is not an element.
-  return if env[:is_whitelisted] || !node.element?
+  # Don't continue if this node is already allowlisted or is not an element.
+  return if env[:is_allowlisted] || !node.element?
   # Don't continue unless the node is an iframe.
   return unless node_name == 'iframe'
   # Verify that the video URL is actually a valid YouTube video URL.
-  return unless node['src'] =~ /\A(https?:)?\/\/(?:www\.)?youtube(?:-nocookie)?\.com\//
+  return unless node['src'] =~ %r|\A(?:https?:)?//(?:www\.)?youtube(?:-nocookie)?\.com/|
   # We're now certain that this is a YouTube embed, but we still need to run
   # it through a special Sanitize step to ensure that no unwanted elements or
   # attributes that don't belong in a YouTube embed can sneak in.
-  Sanitize.clean_node!(node, {
+  Sanitize.node!(node, {
     :elements => %w[iframe],
     :attributes => {
@@ -349,51 +655,15 @@ lambda do |env|
   # Now that we're sure that this is a valid YouTube embed and that there are
   # no unwanted elements or attributes hidden inside it, we can tell Sanitize
-  # to whitelist the current node.
-  {:node_whitelist => [node]}
+  # to allowlist the current node.
+  {:node_allowlist => [node]}
 end
-```
-Contributors
-------------
-Sanitize was created and is maintained by Ryan Grove (ryan@wonko.com).
-The following lovely people have also contributed to Sanitize:
-* Ben Anderson
-* Wilson Bilkovich
-* Peter Cooper
-* Gabe da Silveira
-* Nicholas Evans
-* Nils Gemeinhardt
-* Adam Hooper
-* Mutwin Kraus
-* Eaden McKee
-* Dev Purkayastha
-* David Reese
-* Ardie Saeidi
-* Rafael Souza
-* Ben Wanicur
-License
--------
-Copyright (c) 2014 Ryan Grove (ryan@wonko.com)
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the 'Software'), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+html = %[
+<iframe width="420" height="315" src="//www.youtube.com/embed/dQw4w9WgXcQ"
+    frameborder="0" allowfullscreen></iframe>
+]
+Sanitize.fragment(html, :transformers => youtube_transformer)
+# => '<iframe width="420" height="315" src="//www.youtube.com/embed/dQw4w9WgXcQ" frameborder="0" allowfullscreen=""></iframe>'
+```