darkhelmet-sanitize 1.2.0.dev.20091104

data/HISTORY

@@ -0,0 +1,73 @@
+Sanitize History
+================================================================================
+
+Version 1.2.0.dev (git)
+  * Added support for transformers, which allow you to filter and alter nodes
+    using your own custom logic, on top of (or instead of) Sanitize's core
+    filter. See the README for details.
+  * Requires Nokogiri >= 1.4.0.
+  * Added elements h1 through h6 to the Relaxed whitelist. [Suggested by David
+    Reese]
+
+Version 1.1.0 (2009-10-11)
+  * Migrated from Hpricot to Nokogiri. Requires libxml2 >= 2.7.2 [Adam Hooper]
+  * Added an :output config setting to allow the output format to be specified.
+    Supported formats are :xhtml (the default) and :html (which outputs HTML4).
+  * Changed protocol regex to ensure Sanitize doesn't kill URLs with colons in 
+    path segments. [Peter Cooper]
+
+Version 1.0.8 (2009-04-23)
+  * Added a workaround for an Hpricot bug that prevents attribute names from
+    being downcased in recent versions of Hpricot. This was exploitable to
+    prevent non-whitelisted protocols from being cleaned. [Reported by Ben
+    Wanicur]
+
+Version 1.0.7 (2009-04-11)
+  * Requires Hpricot 0.8.1+, which is finally compatible with Ruby 1.9.1.
+  * Fixed a bug that caused named character entities containing digits (like
+    ²) to be escaped when they shouldn't have been. [Reported by Sebastian
+    Steinmetz]
+
+Version 1.0.6 (2009-02-23)
+  * Removed htmlentities gem dependency.
+  * Existing well-formed character entity references in the input string are now
+    preserved rather than being decoded and re-encoded.
+  * The ' character is now encoded as ' instead of ' to prevent
+    problems in IE6.
+  * You can now specify the symbol :all in place of an element name in the
+    attributes config hash to allow certain attributes on all elements. [Thanks
+    to Mutwin Kraus]
+
+Version 1.0.5 (2009-02-05)
+  * Fixed a bug introduced in version 1.0.3 that prevented non-whitelisted
+    protocols from being cleaned when relative URLs were allowed. [Reported by
+    Dev Purkayastha]
+  * Fixed "undefined method `parent='" exceptions caused by parser changes in
+    edge Hpricot.
+
+Version 1.0.4 (2009-01-16)
+  * Fixed a bug that made it possible to sneak a non-whitelisted element through
+    by repeating it several times in a row. All versions of Sanitize prior to
+    1.0.4 are vulnerable. [Reported by Cristobal]
+
+Version 1.0.3 (2009-01-15)
+  * Fixed a bug whereby incomplete Unicode or hex entities could be used to
+    prevent non-whitelisted protocols from being cleaned. Since IE6 and Opera
+    still decode the incomplete entities, users of those browsers may be
+    vulnerable to malicious script injection on websites using versions of
+    Sanitize prior to 1.0.3.
+
+Version 1.0.2 (2009-01-04)
+  * Fixed a bug that caused an exception to be thrown when parsing a valueless
+    attribute that's expected to contain a URL.
+
+Version 1.0.1 (2009-01-01)
+  * You can now specify :relative in a protocol config array to allow attributes
+    containing relative URLs with no protocol. The Basic and Relaxed configs
+    have been updated to allow relative URLs.
+  * Added a workaround for an Hpricot bug that causes HTML entities for
+    non-ASCII characters to be replaced by question marks, and all other
+    entities to be destructively decoded.
+
+Version 1.0.0 (2008-12-25)
+  * First release.

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 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.

data/README.rdoc

@@ -0,0 +1,249 @@
+= 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.
+
+Using a simple configuration syntax, you can tell Sanitize to allow certain
+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.
+
+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. When in doubt, Sanitize always errs on the side of
+caution.
+
+*Author*::    Ryan Grove (mailto:ryan@wonko.com)
+*Version*::   1.2.0.dev (git)
+*Copyright*:: Copyright (c) 2009 Ryan Grove. All rights reserved.
+*License*::   MIT License (http://opensource.org/licenses/mit-license.php)
+*Website*::   http://github.com/rgrove/sanitize
+
+== Requires
+
+* Nokogiri >= 1.4.0
+* libxml2 >= 2.7.2
+
+== Installation
+
+Latest stable release:
+
+  gem install sanitize
+
+Latest development version:
+
+  gem install sanitize -s http://gemcutter.org --prerelease
+
+== Usage
+
+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
+behind.
+
+  require 'rubygems'
+  require 'sanitize'
+
+  html = '<b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg" />'
+
+  Sanitize.clean(html) # => 'foo'
+
+== Configuration
+
+In addition to the ultra-safe default settings, Sanitize comes with three other
+built-in modes.
+
+=== Sanitize::Config::RESTRICTED
+
+Allows only very simple inline formatting markup. No links, images, or block
+elements.
+
+  Sanitize.clean(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 <code>rel="nofollow"</code> attribute is added to all links to
+mitigate SEO spam.
+
+  Sanitize.clean(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, <code>rel="nofollow"</code> is not
+added to links.
+
+  Sanitize.clean(html, Sanitize::Config::RELAXED)
+  # => '<b><a href="http://foo.com/">foo</a></b><img src="http://foo.com/bar.jpg" />'
+
+=== Custom Configuration
+
+If the built-in modes don't meet your needs, you can easily specify a custom
+configuration:
+
+  Sanitize.clean(html, :elements => ['a', 'span'],
+      :attributes => {'a' => ['href', 'title'], 'span' => ['class']},
+      :protocols => {'a' => {'href' => ['http', 'https', 'mailto']}})
+
+==== :elements
+
+Array of element names to allow. Specify all names in lowercase.
+
+  :elements => [
+    'a', 'b', 'blockquote', 'br', 'cite', 'code', 'dd', 'dl', 'dt', 'em',
+    'i', 'li', 'ol', 'p', 'pre', 'q', 'small', 'strike', 'strong', 'sub',
+    'sup', 'u', 'ul'
+  ]
+
+==== :attributes
+
+Attributes to allow for specific elements. Specify all element names and
+attributes in lowercase.
+
+  :attributes => {
+    'a'          => ['href', 'title'],
+    'blockquote' => ['cite'],
+    'img'        => ['alt', 'src', 'title']
+  }
+
+If you'd like to allow certain attributes on all elements, use the symbol
+<code>:all</code> instead of an element name.
+
+  :attributes => {
+    :all => ['class'],
+    'a'  => ['href', 'title']
+  }
+
+==== :add_attributes
+
+Attributes to add to specific elements. If the attribute already exists, it will
+be replaced with the value specified here. Specify all element names and
+attributes in lowercase.
+
+  :add_attributes => {
+    'a' => {'rel' => 'nofollow'}
+  }
+
+==== :protocols
+
+URL protocols to allow in specific attributes. If an attribute is listed here
+and contains a protocol other than those specified (or if it contains no
+protocol at all), it will be removed.
+
+  :protocols => {
+    'a'   => {'href' => ['ftp', 'http', 'https', 'mailto']},
+    'img' => {'src'  => ['http', 'https']}
+  }
+
+If you'd like to allow the use of relative URLs which don't have a protocol,
+include the symbol <code>:relative</code> in the protocol array:
+
+  :protocols => {
+    'a' => {'href' => ['http', 'https', :relative]}
+  }
+
+=== Transformers
+
+Transformers allow you to filter and alter nodes using your own custom logic, on
+top of (or instead of) Sanitize's core filter. A transformer is any object that
+responds to <code>call()</code> (such as a lambda or proc) and returns either
+<code>nil</code> or a Hash containing certain optional response values.
+
+To use one or more transformers, pass them to the <code>:transformers</code>
+config setting:
+
+  Sanitize.clean(html, :transformers => [transformer_one, transformer_two])
+
+==== Input
+
+Each registered transformer's <code>call()</code> method will be called once for
+each element node in the HTML, and will receive as an argument an environment
+Hash that contains the following items:
+
+[<code>:config</code>]
+  The current Sanitize configuration Hash.
+
+[<code>:node</code>]
+  A Nokogiri::XML::Node object representing an HTML element.
+
+==== 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 <code>document()</code>
+method. Any changes will be reflected instantly 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. It's
+important to note that Nokogiri traverses markup from the deepest node upward,
+not from the first node to the last node:
+
+  html        = '<div><span>foo</span></div>'
+  transformer = lambda{|env| puts env[:node].name }
+
+  # Prints "span", then "div".
+  Sanitize.clean(html, :transformers => transformer)
+
+Transformers have a tremendous amount of power, including the power to
+completely bypass Sanitize's built-in filtering. Be careful!
+
+==== Output
+
+A transformer may return either +nil+ or a Hash. A return value of +nil+
+indicates that the transformer does not wish to act on the current node in any
+way. A returned Hash may contain the following items, all of which are optional:
+
+[<code>:attr_whitelist</code>]
+  Array of attribute names to add to the whitelist for the current node, in
+  addition to any whitelisted attributes already defined in the current config.
+
+[<code>:node</code>]
+  A Nokogiri::XML::Node object that should replace the current node. All
+  subsequent transformers and Sanitize itself will receive this new node.
+
+[<code>:whitelist</code>]
+  If _true_, the current node (and only the current node) will be whitelisted,
+  regardless of the current Sanitize config.
+
+[<code>:whitelist_nodes</code>]
+  Array of specific Nokogiri::XML::Node objects to whitelist, anywhere in the
+  document, regardless of the current Sanitize config.
+
+== Contributors
+
+The following lovely people have contributed to Sanitize in the form of patches
+or ideas that later became code:
+
+* Peter Cooper <git@peterc.org>
+* Gabe da Silveira <gabe@websaviour.com>
+* Ryan Grove <ryan@wonko.com>
+* Adam Hooper <adam@adamhooper.com>
+* Mutwin Kraus <mutle@blogage.de>
+* Dev Purkayastha <dev.purkayastha@gmail.com>
+* David Reese <work@whatcould.com>
+* Ben Wanicur <bwanicur@verticalresponse.com>
+
+== License
+
+Copyright (c) 2009 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.

data/lib/sanitize/config/basic.rb

@@ -0,0 +1,49 @@
+#--
+# Copyright (c) 2009 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.
+#++
+
+class Sanitize
+  module Config
+    BASIC = {
+      :elements => [
+        'a', 'b', 'blockquote', 'br', 'cite', 'code', 'dd', 'dl', 'dt', 'em',
+        'i', 'li', 'ol', 'p', 'pre', 'q', 'small', 'strike', 'strong', 'sub',
+        'sup', 'u', 'ul'],
+
+      :attributes => {
+        'a'          => ['href'],
+        'blockquote' => ['cite'],
+        'q'          => ['cite']
+      },
+
+      :add_attributes => {
+        'a' => {'rel' => 'nofollow'}
+      },
+
+      :protocols => {
+        'a'          => {'href' => ['ftp', 'http', 'https', 'mailto',
+                                    :relative]},
+        'blockquote' => {'cite' => ['http', 'https', :relative]},
+        'q'          => {'cite' => ['http', 'https', :relative]}
+      }
+    }
+  end
+end

data/lib/sanitize/config/relaxed.rb

@@ -0,0 +1,59 @@
+#--
+# Copyright (c) 2009 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.
+#++
+
+
+
+class Sanitize
+  module Config
+    RELAXED = {
+      :elements => [
+        'a', 'b', 'blockquote', 'br', 'caption', 'cite', 'code', 'col',
+        'colgroup', 'dd', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
+        'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'small', 'strike', 'strong',
+        'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'u',
+        'ul'],
+
+      :attributes => {
+        'a'          => ['href', 'title'],
+        'blockquote' => ['cite'],
+        'col'        => ['span', 'width'],
+        'colgroup'   => ['span', 'width'],
+        'img'        => ['align', 'alt', 'height', 'src', 'title', 'width'],
+        'ol'         => ['start', 'type'],
+        'q'          => ['cite'],
+        'table'      => ['summary', 'width'],
+        'td'         => ['abbr', 'axis', 'colspan', 'rowspan', 'width'],
+        'th'         => ['abbr', 'axis', 'colspan', 'rowspan', 'scope',
+                         'width'],
+        'ul'         => ['type']
+      },
+
+      :protocols => {
+        'a'          => {'href' => ['ftp', 'http', 'https', 'mailto',
+                                    :relative]},
+        'blockquote' => {'cite' => ['http', 'https', :relative]},
+        'img'        => {'src'  => ['http', 'https', :relative]},
+        'q'          => {'cite' => ['http', 'https', :relative]}
+      }
+    }
+  end
+end

data/lib/sanitize/config/restricted.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2009 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.
+#++
+
+class Sanitize
+  module Config
+    RESTRICTED = {
+      :elements => ['b', 'em', 'i', 'strong', 'u']
+    }
+  end
+end

data/lib/sanitize/config.rb

@@ -0,0 +1,55 @@
+#--
+# Copyright (c) 2009 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.
+#++
+
+class Sanitize
+  module Config
+    DEFAULT = {
+      # Whether or not to allow HTML comments. Allowing comments is strongly
+      # discouraged, since IE allows script execution within conditional
+      # comments.
+      :allow_comments => false,
+
+      # HTML attributes to add to specific elements. By default, no attributes
+      # are added.
+      :add_attributes => {},
+
+      # HTML attributes to allow in specific elements. By default, no attributes
+      # are allowed.
+      :attributes => {},
+
+      # HTML elements to allow. By default, no elements are allowed (which means
+      # that all HTML will be stripped).
+      :elements => [],
+
+      # Output format. Supported formats are :html and :xhtml (which is the
+      # default).
+      :output => :xhtml,
+
+      # URL handling protocols to allow in specific attributes. By default, no
+      # protocols are allowed. Use :relative in place of a protocol if you want
+      # to allow relative URLs sans protocol.
+      :protocols => {},
+
+      :transformers => []
+    }
+  end
+end

data/lib/sanitize/version.rb

@@ -0,0 +1,3 @@
+class Sanitize
+  VERSION = '1.2.0.dev.20091104'
+end

data/lib/sanitize.rb

@@ -0,0 +1,228 @@
+# encoding: utf-8
+#--
+# Copyright (c) 2009 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.
+#++
+
+require 'nokogiri'
+require 'sanitize/version'
+require 'sanitize/config'
+require 'sanitize/config/restricted'
+require 'sanitize/config/basic'
+require 'sanitize/config/relaxed'
+
+class Sanitize
+  attr_reader :config
+
+  # Matches an attribute value that could be treated by a browser as a URL
+  # with a protocol prefix, such as "http:" or "javascript:". Any string of zero
+  # or more characters followed by a colon is considered a match, even if the
+  # colon is encoded as an entity and even if it's an incomplete entity (which
+  # IE6 and Opera will still parse).
+  REGEX_PROTOCOL = /^([A-Za-z0-9\+\-\.\&\;\#\s]*?)(?:\:|&#0*58|&#x0*3a)/i
+
+  #--
+  # Class Methods
+  #++
+
+  # Returns a sanitized copy of _html_, using the settings in _config_ if
+  # specified.
+  def self.clean(html, config = {})
+    sanitize = Sanitize.new(config)
+    sanitize.clean(html)
+  end
+
+  # Performs Sanitize#clean in place, returning _html_, or +nil+ if no changes
+  # were made.
+  def self.clean!(html, config = {})
+    sanitize = Sanitize.new(config)
+    sanitize.clean!(html)
+  end
+
+  # Sanitizes the specified Nokogiri::XML::Node and all its children.
+  def self.clean_node!(node, config = {})
+    sanitize = Sanitize.new(config)
+    sanitize.clean_node!(node)
+  end
+
+  #--
+  # Instance Methods
+  #++
+
+  # Returns a new Sanitize object initialized with the settings in _config_.
+  def initialize(config = {})
+    # Sanitize configuration.
+    @config = Config::DEFAULT.merge(config)
+    @config[:transformers] = Array(@config[:transformers])
+
+    # Specific nodes to whitelist (along with all their attributes). This array
+    # is generated at runtime by transformers, and is cleared before and after
+    # a fragment is cleaned (so it applies only to a specific fragment).
+    @whitelist_nodes = []
+  end
+
+  # Returns a sanitized copy of _html_.
+  def clean(html)
+    dupe = html.dup
+    clean!(dupe) || dupe
+  end
+
+  # Performs clean in place, returning _html_, or +nil+ if no changes were
+  # made.
+  def clean!(html)
+    @whitelist_nodes = []
+    fragment = Nokogiri::HTML::DocumentFragment.parse(html)
+    clean_node!(fragment)
+    @whitelist_nodes = []
+
+    output_method_params = {:encoding => 'utf-8', :indent => 0}
+
+    if @config[:output] == :xhtml
+      output_method = fragment.method(:to_xhtml)
+      output_method_params[:save_with] = Nokogiri::XML::Node::SaveOptions::AS_XHTML
+    elsif @config[:output] == :html
+      output_method = fragment.method(:to_html)
+    else
+      raise Error, "unsupported output format: #{@config[:output]}"
+    end
+
+    result = output_method.call(output_method_params)
+
+    # Nokogiri 1.3.3 (and possibly earlier versions) always returns a US-ASCII
+    # string no matter what we ask for. This will be fixed in 1.4.0, but for
+    # now we have to hack around it to prevent errors.
+    result.force_encoding('utf-8') if RUBY_VERSION >= '1.9'
+
+    return result == html ? nil : html[0, html.length] = result
+  end
+
+  # Sanitizes the specified Nokogiri::XML::Node and all its children.
+  def clean_node!(node)
+    raise ArgumentError unless node.is_a?(Nokogiri::XML::Node)
+
+    node.traverse do |traversed_node|
+      if traversed_node.element?
+        clean_element!(traversed_node)
+      elsif traversed_node.comment?
+        traversed_node.unlink unless @config[:allow_comments]
+      elsif traversed_node.cdata?
+        traversed_node.replace(Nokogiri::XML::Text.new(traversed_node.text,
+            traversed_node.document))
+      end
+    end
+
+    node
+  end
+
+  private
+
+  def clean_element!(node)
+    # Run this node through all configured transformers.
+    transform = transform_element!(node)
+
+    # If this node is in the dynamic whitelist array (built at runtime by
+    # transformers), let it live with all of its attributes intact.
+    return if @whitelist_nodes.include?(node)
+
+    name = node.name.to_s.downcase
+
+    # Delete any element that isn't in the whitelist.
+    unless transform[:whitelist] || @config[:elements].include?(name)
+      node.children.each { |n| node.add_previous_sibling(n) }
+      node.unlink
+      return
+    end
+
+    attr_whitelist = (transform[:attr_whitelist] +
+        (@config[:attributes][name] || []) +
+        (@config[:attributes][:all] || [])).uniq
+
+    if attr_whitelist.empty?
+      # Delete all attributes from elements with no whitelisted attributes.
+      node.attribute_nodes.each {|attr| attr.remove }
+    else
+      # Delete any attribute that isn't in the whitelist for this element.
+      node.attribute_nodes.each do |attr|
+        attr.unlink unless attr_whitelist.include?(attr.name.downcase)
+      end
+
+      # Delete remaining attributes that use unacceptable protocols.
+      if @config[:protocols].has_key?(name)
+        protocol = @config[:protocols][name]
+
+        node.attribute_nodes.each do |attr|
+          attr_name = attr.name.downcase
+          next false unless protocol.has_key?(attr_name)
+
+          del = if attr.value.to_s.downcase =~ REGEX_PROTOCOL
+            !protocol[attr_name].include?($1.downcase)
+          else
+            !protocol[attr_name].include?(:relative)
+          end
+
+          attr.unlink if del
+        end
+      end
+    end
+
+    # Add required attributes.
+    if @config[:add_attributes].has_key?(name)
+      @config[:add_attributes][name].each do |key, val|
+        node[key] = val
+      end
+    end
+
+    transform
+  end
+
+  def transform_element!(node)
+    output = {
+      :attr_whitelist => [],
+      :node           => node,
+      :whitelist      => false
+    }
+
+    @config[:transformers].inject(node) do |transformer_node, transformer|
+      transform = transformer.call({
+        :config => @config,
+        :node   => transformer_node
+      })
+
+      if transform.nil?
+        transformer_node
+      elsif transform.is_a?(Hash)
+        if transform[:whitelist_nodes].is_a?(Array)
+          @whitelist_nodes += transform[:whitelist_nodes] 
+          @whitelist_nodes.uniq!
+        end
+
+        output[:attr_whitelist]  += transform[:attr_whitelist] if transform[:attr_whitelist].is_a?(Array)
+        output[:whitelist]      ||= true if transform[:whitelist]
+        output[:node]             = transform[:node].is_a?(Nokogiri::XML::Node) ? transform[:node] : output[:node]
+      else
+        raise Error, "transformer output must be a Hash or nil"
+      end
+    end
+
+    node.replace(output[:node]) if node != output[:node]
+
+    return output
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: darkhelmet-sanitize
+version: !ruby/object:Gem::Version 
+  version: 1.2.0.dev.20091104
+platform: ruby
+authors: 
+- Ryan Grove
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.0
+    version: 
+description: 
+email: ryan@wonko.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- HISTORY
+- LICENSE
+- README.rdoc
+- lib/sanitize/config/basic.rb
+- lib/sanitize/config/relaxed.rb
+- lib/sanitize/config/restricted.rb
+- lib/sanitize/config.rb
+- lib/sanitize/version.rb
+- lib/sanitize.rb
+has_rdoc: true
+homepage: http://github.com/rgrove/sanitize/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: riposte
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Whitelist-based HTML sanitizer.
+test_files: []
+