program/lib/washtml.php

   1 <?php
   2 /*                Washtml, a HTML sanityzer.
   3  *
   4  * Copyright (c) 2007 Frederic Motte <fmotte@ubixis.com>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /* Please send me your comments about this code if you have some, thanks, Fred. */
  29
  30 /* OVERVIEW:
  31  *
  32  * Wahstml take an untrusted HTML and return a safe html string.
  33  *
  34  * SYNOPSIS:
  35  *
  36  * $washer = new washtml($config);
  37  * $washer->wash($html);
  38  * It return a sanityzed string of the $html parameter without html and head tags.
  39  * $html is a string containing the html code to wash.
  40  * $config is an array containing options:
  41  *   $config['allow_remote'] is a boolean to allow link to remote images.
  42  *   $config['blocked_src'] string with image-src to be used for blocked remote images
  43  *   $config['show_washed'] is a boolean to include washed out attributes as x-washed
  44  *   $config['cid_map'] is an array where cid urls index urls to replace them.
  45  *   $config['charset'] is a string containing the charset of the HTML document if it is not defined in it.
  46  * $washer->extlinks is a reference to a boolean that is set to true if remote images were removed. (FE: show remote images link)
  47  *
  48  * INTERNALS:
  49  *
  50  * Only tags and attributes in the static lists $html_elements and $html_attributes
  51  * are kept, inline styles are also filtered: all style identifiers matching
  52  * /[a-z\-]/i are allowed. Values matching colors, sizes, /[a-z\-]/i and safe
  53  * urls if allowed and cid urls if mapped are kept.
  54  *
  55  * BUGS: It MUST be safe !
  56  *  - Check regexp
  57  *  - urlencode URLs instead of htmlspecials
  58  *  - Check is a 3 bytes utf8 first char can eat '">'
  59  *  - Update PCRE: CVE-2007-1659 - CVE-2007-1660 - CVE-2007-1661 - CVE-2007-1662
  60  *                 CVE-2007-4766 - CVE-2007-4767 - CVE-2007-4768
  61  *    http://lists.debian.org/debian-security-announce/debian-security-announce-2007/msg00177.html
  62  *  - ...
  63  *
  64  * MISSING:
  65  *  - relative links, can be implemented by prefixing an absolute path, ask me
  66  *    if you need it...
  67  *  - ...
  68  *
  69  * Dont be a fool:
  70  *  - Dont alter data on a GET: '<img src="http://yourhost/mail?action=delete&uid=3267" />'
  71  *  - ...
  72  *
  73  * Roundcube Changes:
  74  * - added $block_elements
  75  * - changed $ignore_elements behaviour
  76  */
  77
  78 class washtml
  79 {
  80   /* Allowed HTML elements (default) */
  81   static $html_elements = array('a', 'abbr', 'acronym', 'address', 'area', 'b', 'basefont', 'bdo', 'big', 'blockquote', 'br', 'caption', 'center', 'cite', 'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dir', 'div', 'dl', 'dt', 'em', 'fieldset', 'font', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'ins', 'label', 'legend', 'li', 'map', 'menu', 'nobr', 'ol', 'p', 'pre', 'q', 's', 'samp', 'small', 'span', 'strike', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'u', 'ul', 'var', 'wbr', 'img');
  82
  83   /* Ignore these HTML tags and their content */
  84   static $ignore_elements = array('script', 'applet', 'embed', 'object', 'style');
  85
  86   /* Allowed HTML attributes */
  87   static $html_attribs = array('name', 'class', 'title', 'alt', 'width', 'height', 'align', 'nowrap', 'col', 'row', 'id', 'rowspan', 'colspan', 'cellspacing', 'cellpadding', 'valign', 'bgcolor', 'color', 'border', 'bordercolorlight', 'bordercolordark', 'face', 'marginwidth', 'marginheight', 'axis', 'border', 'abbr', 'char', 'charoff', 'clear', 'compact', 'coords', 'vspace', 'hspace', 'cellborder', 'size', 'lang', 'dir');
  88
  89   /* Block elements which could be empty but cannot be returned in short form (<tag />) */
  90   static $block_elements = array('div', 'p', 'pre', 'blockquote');
  91
  92   /* State for linked objects in HTML */
  93   public $extlinks = false;
  94
  95   /* Current settings */
  96   private $config = array();
  97
  98   /* Registered callback functions for tags */
  99   private $handlers = array();
 100
 101   /* Allowed HTML elements */
 102   private $_html_elements = array();
 103
 104   /* Ignore these HTML tags but process their content */
 105   private $_ignore_elements = array();
 106
 107   /* Block elements which could be empty but cannot be returned in short form (<tag />) */
 108   private $_block_elements = array();
 109
 110   /* Allowed HTML attributes */
 111   private $_html_attribs = array();
 112
 113
 114   /* Constructor */
 115   public function __construct($p = array()) {
 116     $this->_html_elements = array_flip((array)$p['html_elements']) + array_flip(self::$html_elements) ;
 117     $this->_html_attribs = array_flip((array)$p['html_attribs']) + array_flip(self::$html_attribs);
 118     $this->_ignore_elements = array_flip((array)$p['ignore_elements']) + array_flip(self::$ignore_elements);
 119     $this->_block_elements = array_flip((array)$p['block_elements']) + array_flip(self::$block_elements);
 120     unset($p['html_elements'], $p['html_attribs'], $p['ignore_elements'], $p['block_elements']);
 121     $this->config = $p + array('show_washed'=>true, 'allow_remote'=>false, 'cid_map'=>array());
 122   }
 123
 124   /* Register a callback function for a certain tag */
 125   public function add_callback($tagName, $callback)
 126   {
 127     $this->handlers[$tagName] = $callback;
 128   }
 129
 130   /* Check CSS style */
 131   private function wash_style($style) {
 132     $s = '';
 133
 134     foreach(explode(';', $style) as $declaration) {
 135       if(preg_match('/^\s*([a-z\-]+)\s*:\s*(.*)\s*$/i', $declaration, $match)) {
 136         $cssid = $match[1];
 137         $str = $match[2];
 138         $value = '';
 139         while(sizeof($str) > 0 &&
 140           preg_match('/^(url\(\s*[\'"]?([^\'"\)]*)[\'"]?\s*\)'./*1,2*/
 141                  '|rgb\(\s*[0-9]+\s*,\s*[0-9]+\s*,\s*[0-9]+\s*\)'.
 142                  '|-?[0-9.]+\s*(em|ex|px|cm|mm|in|pt|pc|deg|rad|grad|ms|s|hz|khz|%)?'.
 143                  '|#[0-9a-f]{3,6}|[a-z0-9\-]+'.
 144                  ')\s*/i', $str, $match)) {
 145           if($match[2]) {
 146             if($src = $this->config['cid_map'][$match[2]])
 147               $value .= ' url(\''.htmlspecialchars($src, ENT_QUOTES) . '\')';
 148             else if(preg_match('/^(http|https|ftp):.*$/i', $match[2], $url)) {
 149               if($this->config['allow_remote'])
 150                 $value .= ' url(\''.htmlspecialchars($url[0], ENT_QUOTES).'\')';
 151               else
 152                 $this->extlinks = true;
 153             }
 154           } else if($match[0] != 'url' && $match[0] != 'rbg')//whitelist ?
 155             $value .= ' ' . $match[0];
 156           $str = substr($str, strlen($match[0]));
 157         }
 158         if($value)
 159           $s .= ($s?' ':'') . $cssid . ':' . $value . ';';
 160       }
 161     }
 162     return $s;
 163   }
 164
 165   /* Take a node and return allowed attributes and check values */
 166   private function wash_attribs($node) {
 167     $t = '';
 168     $washed;
 169
 170     foreach($node->attributes as $key => $plop) {
 171       $key = strtolower($key);
 172       $value = $node->getAttribute($key);
 173       if(isset($this->_html_attribs[$key]) ||
 174          ($key == 'href' && preg_match('/^(http:|https:|ftp:|mailto:|#).+/i', $value)))
 175         $t .= ' ' . $key . '="' . htmlspecialchars($value, ENT_QUOTES) . '"';
 176       else if($key == 'style' && ($style = $this->wash_style($value)))
 177         $t .= ' style="' . $style . '"';
 178       else if($key == 'background' || ($key == 'src' && strtolower($node->tagName) == 'img')) { //check tagName anyway
 179         if($src = $this->config['cid_map'][$value]) {
 180           $t .= ' ' . $key . '="' . htmlspecialchars($src, ENT_QUOTES) . '"';
 181         }
 182         else if(preg_match('/^(http|https|ftp):.+/i', $value)) {
 183           if($this->config['allow_remote'])
 184             $t .= ' ' . $key . '="' . htmlspecialchars($value, ENT_QUOTES) . '"';
 185           else {
 186             $this->extlinks = true;
 187             if ($this->config['blocked_src'])
 188               $t .= ' ' . $key . '="' . htmlspecialchars($this->config['blocked_src'], ENT_QUOTES) . '"';
 189           }
 190         }
 191       } else
 192         $washed .= ($washed?' ':'') . $key;
 193     }
 194     return $t . ($washed && $this->config['show_washed']?' x-washed="'.$washed.'"':'');
 195   }
 196
 197   /* The main loop that recurse on a node tree.
 198    * It output only allowed tags with allowed attributes
 199    * and allowed inline styles */
 200   private function dumpHtml($node) {
 201     if(!$node->hasChildNodes())
 202       return '';
 203
 204     $node = $node->firstChild;
 205     $dump = '';
 206
 207     do {
 208       switch($node->nodeType) {
 209       case XML_ELEMENT_NODE: //Check element
 210         $tagName = strtolower($node->tagName);
 211         if($callback = $this->handlers[$tagName]) {
 212           $dump .= call_user_func($callback, $tagName, $this->wash_attribs($node), $this->dumpHtml($node));
 213         } else if(isset($this->_html_elements[$tagName])) {
 214           $content = $this->dumpHtml($node);
 215           $dump .= '<' . $tagName . $this->wash_attribs($node) .
 216             ($content || isset($this->_block_elements[$tagName]) ? ">$content</$tagName>" : ' />');
 217         } else if(isset($this->_ignore_elements[$tagName])) {
 218           $dump .= '<!-- ' . htmlspecialchars($tagName, ENT_QUOTES) . ' not allowed -->';
 219         } else {
 220           $dump .= '<!-- ' . htmlspecialchars($tagName, ENT_QUOTES) . ' ignored -->';
 221           $dump .= $this->dumpHtml($node); // ignore tags not its content
 222         }
 223         break;
 224       case XML_CDATA_SECTION_NODE:
 225         $dump .= $node->nodeValue;
 226         break;
 227       case XML_TEXT_NODE:
 228         $dump .= htmlspecialchars($node->nodeValue);
 229         break;
 230       case XML_HTML_DOCUMENT_NODE:
 231         $dump .= $this->dumpHtml($node);
 232         break;
 233       case XML_DOCUMENT_TYPE_NODE:
 234         break;
 235       default:
 236         $dump . '<!-- node type ' . $node->nodeType . ' -->';
 237       }
 238     } while($node = $node->nextSibling);
 239
 240     return $dump;
 241   }
 242
 243   /* Main function, give it untrusted HTML, tell it if you allow loading
 244    * remote images and give it a map to convert "cid:" urls. */
 245   public function wash($html) {
 246     //Charset seems to be ignored (probably if defined in the HTML document)
 247     $node = new DOMDocument('1.0', $this->config['charset']);
 248     $this->extlinks = false;
 249     @$node->loadHTML($html);
 250     return $this->dumpHtml($node);
 251   }
 252
 253 }
 254
 255 ?>