Roundcubemail devel
view | history | commit | commitdiff
thomascube
2011-02-09 57d261bb8524387e794951e0ed6462fa677daace
commit | author | age
45f56c 1 <?php
T 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  *
21e724 36  * $washer = new washtml($config);
T 37  * $washer->wash($html);
45f56c 38  * It return a sanityzed string of the $html parameter without html and head tags.
T 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.
21e724 46  * $washer->extlinks is a reference to a boolean that is set to true if remote images were removed. (FE: show remote images link)
45f56c 47  *
T 48  * INTERNALS:
49  *
21e724 50  * Only tags and attributes in the static lists $html_elements and $html_attributes
45f56c 51  * are kept, inline styles are also filtered: all style identifiers matching
T 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  *  - ...
2337a8 72  *
A 73  * Roundcube Changes:
74  * - added $block_elements
75  * - changed $ignore_elements behaviour
0b7f3a 76  * - added RFC2397 support
b6f040 77  * - base URL support
b46e5b 78  * - invalid HTML comments removal before parsing
45f56c 79  */
T 80
81 class washtml
82 {
21e724 83   /* Allowed HTML elements (default) */
f7fff8 84   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');
21e724 85   
2337a8 86   /* Ignore these HTML tags and their content */
A 87   static $ignore_elements = array('script', 'applet', 'embed', 'object', 'style');
21e724 88   
T 89   /* Allowed HTML attributes */
4cc74f 90   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');  
503e01 91
A 92   /* Block elements which could be empty but cannot be returned in short form (<tag />) */
4d268b 93   static $block_elements = array('div', 'p', 'pre', 'blockquote', 'a', 'font', 'center', 'table', 'ul', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'ol', 'dl', 'strong', 'i', 'b');
21e724 94   
T 95   /* State for linked objects in HTML */
96   public $extlinks = false;
45f56c 97
21e724 98   /* Current settings */
T 99   private $config = array();
100
101   /* Registered callback functions for tags */
102   private $handlers = array();
103   
45f56c 104   /* Allowed HTML elements */
21e724 105   private $_html_elements = array();
T 106
107   /* Ignore these HTML tags but process their content */
108   private $_ignore_elements = array();
45f56c 109
503e01 110   /* Block elements which could be empty but cannot be returned in short form (<tag />) */
A 111   private $_block_elements = array();
112
45f56c 113   /* Allowed HTML attributes */
21e724 114   private $_html_attribs = array();
T 115   
45f56c 116
21e724 117   /* Constructor */
T 118   public function __construct($p = array()) {
119     $this->_html_elements = array_flip((array)$p['html_elements']) + array_flip(self::$html_elements) ;
120     $this->_html_attribs = array_flip((array)$p['html_attribs']) + array_flip(self::$html_attribs);
121     $this->_ignore_elements = array_flip((array)$p['ignore_elements']) + array_flip(self::$ignore_elements);
503e01 122     $this->_block_elements = array_flip((array)$p['block_elements']) + array_flip(self::$block_elements);
A 123     unset($p['html_elements'], $p['html_attribs'], $p['ignore_elements'], $p['block_elements']);
21e724 124     $this->config = $p + array('show_washed'=>true, 'allow_remote'=>false, 'cid_map'=>array());
T 125   }
126   
127   /* Register a callback function for a certain tag */
128   public function add_callback($tagName, $callback)
129   {
130     $this->handlers[$tagName] = $callback;
131   }
132   
45f56c 133   /* Check CSS style */
21e724 134   private function wash_style($style) {
45f56c 135     $s = '';
T 136
0b7f3a 137     foreach (explode(';', $style) as $declaration) {
A 138       if (preg_match('/^\s*([a-z\-]+)\s*:\s*(.*)\s*$/i', $declaration, $match)) {
45f56c 139         $cssid = $match[1];
T 140         $str = $match[2];
141         $value = '';
0b7f3a 142         while (sizeof($str) > 0 &&
45f56c 143           preg_match('/^(url\(\s*[\'"]?([^\'"\)]*)[\'"]?\s*\)'./*1,2*/
T 144                  '|rgb\(\s*[0-9]+\s*,\s*[0-9]+\s*,\s*[0-9]+\s*\)'.
145                  '|-?[0-9.]+\s*(em|ex|px|cm|mm|in|pt|pc|deg|rad|grad|ms|s|hz|khz|%)?'.
146                  '|#[0-9a-f]{3,6}|[a-z0-9\-]+'.
147                  ')\s*/i', $str, $match)) {
0b7f3a 148           if ($match[2]) {
b6f040 149             if (($src = $this->config['cid_map'][$match[2]])
A 150                 || ($src = $this->config['cid_map'][$this->config['base_url'].$match[2]])) {
0b7f3a 151               $value .= ' url('.htmlspecialchars($src, ENT_QUOTES) . ')';
b6f040 152             }
0b7f3a 153             else if (preg_match('/^(http|https|ftp):.*$/i', $match[2], $url)) {
A 154               if ($this->config['allow_remote'])
155                 $value .= ' url('.htmlspecialchars($url[0], ENT_QUOTES).')';
45f56c 156               else
21e724 157                 $this->extlinks = true;
c505e5 158             }
a0d29e 159             else if (preg_match('/^data:.+/i', $match[2])) { // RFC2397
A 160               $value .= ' url('.htmlspecialchars($match[2], ENT_QUOTES).')';
0b7f3a 161             }
a0d29e 162           }
A 163           else if ($match[0] != 'url' && $match[0] != 'rbg') //whitelist ?
45f56c 164             $value .= ' ' . $match[0];
T 165           $str = substr($str, strlen($match[0]));
166         }
0b7f3a 167         if ($value)
45f56c 168           $s .= ($s?' ':'') . $cssid . ':' . $value . ';';
T 169       }
170     }
171     return $s;
172   }
173
174   /* Take a node and return allowed attributes and check values */
21e724 175   private function wash_attribs($node) {
45f56c 176     $t = '';
T 177     $washed;
178
0b7f3a 179     foreach ($node->attributes as $key => $plop) {
45f56c 180       $key = strtolower($key);
T 181       $value = $node->getAttribute($key);
0b7f3a 182       if (isset($this->_html_attribs[$key]) ||
e98f24 183          ($key == 'href' && preg_match('/^(http:|https:|ftp:|mailto:|#).+/i', $value)))
45f56c 184         $t .= ' ' . $key . '="' . htmlspecialchars($value, ENT_QUOTES) . '"';
0b7f3a 185       else if ($key == 'style' && ($style = $this->wash_style($value)))
45f56c 186         $t .= ' style="' . $style . '"';
0b7f3a 187       else if ($key == 'background' || ($key == 'src' && strtolower($node->tagName) == 'img')) { //check tagName anyway
b6f040 188         if (($src = $this->config['cid_map'][$value])
A 189             || ($src = $this->config['cid_map'][$this->config['base_url'].$value])) {
c505e5 190           $t .= ' ' . $key . '="' . htmlspecialchars($src, ENT_QUOTES) . '"';
T 191         }
0b7f3a 192         else if (preg_match('/^(http|https|ftp):.+/i', $value)) {
A 193           if ($this->config['allow_remote'])
45f56c 194             $t .= ' ' . $key . '="' . htmlspecialchars($value, ENT_QUOTES) . '"';
T 195           else {
21e724 196             $this->extlinks = true;
T 197             if ($this->config['blocked_src'])
4cc74f 198               $t .= ' ' . $key . '="' . htmlspecialchars($this->config['blocked_src'], ENT_QUOTES) . '"';
45f56c 199           }
c505e5 200         }
0b7f3a 201         else if (preg_match('/^data:.+/i', $value)) { // RFC2397
A 202           $t .= ' ' . $key . '="' . htmlspecialchars($value, ENT_QUOTES) . '"';
203         }
45f56c 204       } else
T 205         $washed .= ($washed?' ':'') . $key;
206     }
21e724 207     return $t . ($washed && $this->config['show_washed']?' x-washed="'.$washed.'"':'');
45f56c 208   }
T 209
210   /* The main loop that recurse on a node tree.
211    * It output only allowed tags with allowed attributes
212    * and allowed inline styles */
21e724 213   private function dumpHtml($node) {
45f56c 214     if(!$node->hasChildNodes())
T 215       return '';
216
217     $node = $node->firstChild;
218     $dump = '';
219
220     do {
221       switch($node->nodeType) {
222       case XML_ELEMENT_NODE: //Check element
223         $tagName = strtolower($node->tagName);
b6f040 224         if ($callback = $this->handlers[$tagName]) {
21e724 225           $dump .= call_user_func($callback, $tagName, $this->wash_attribs($node), $this->dumpHtml($node));
b6f040 226         }
A 227         else if (isset($this->_html_elements[$tagName])) {
21e724 228           $content = $this->dumpHtml($node);
T 229           $dump .= '<' . $tagName . $this->wash_attribs($node) .
be6f3a 230             // create closing tag for block elements, but also for elements
A 231             // with content or with some attributes (eg. style, class) (#1486812)
232             ($content != '' || $node->hasAttributes() || isset($this->_block_elements[$tagName]) ? ">$content</$tagName>" : ' />');
b6f040 233         }
A 234         else if (isset($this->_ignore_elements[$tagName])) {
45f56c 235           $dump .= '<!-- ' . htmlspecialchars($tagName, ENT_QUOTES) . ' not allowed -->';
b6f040 236         }
A 237         else {
2337a8 238           $dump .= '<!-- ' . htmlspecialchars($tagName, ENT_QUOTES) . ' ignored -->';
A 239           $dump .= $this->dumpHtml($node); // ignore tags not its content
b6f040 240         }
21e724 241         break;
T 242       case XML_CDATA_SECTION_NODE:
243         $dump .= $node->nodeValue;
45f56c 244         break;
T 245       case XML_TEXT_NODE:
246         $dump .= htmlspecialchars($node->nodeValue);
247         break;
248       case XML_HTML_DOCUMENT_NODE:
21e724 249         $dump .= $this->dumpHtml($node);
45f56c 250         break;
21e724 251       case XML_DOCUMENT_TYPE_NODE:
T 252         break;
45f56c 253       default:
21e724 254         $dump . '<!-- node type ' . $node->nodeType . ' -->';
45f56c 255       }
T 256     } while($node = $node->nextSibling);
257
258     return $dump;
259   }
260
261   /* Main function, give it untrusted HTML, tell it if you allow loading
262    * remote images and give it a map to convert "cid:" urls. */
b6f040 263   public function wash($html)
A 264   {
265     // Charset seems to be ignored (probably if defined in the HTML document)
21e724 266     $node = new DOMDocument('1.0', $this->config['charset']);
T 267     $this->extlinks = false;
b6f040 268
A 269     // Find base URL for images
270     if (preg_match('/<base\s+href=[\'"]*([^\'"]+)/is', $html, $matches))
271       $this->config['base_url'] = $matches[1];
272     else
273       $this->config['base_url'] = '';
274
b46e5b 275     // Remove invalid HTML comments (#1487759)
57d261 276     $html = preg_replace('/<!--[^->]*>/', '', $html);
b46e5b 277
45f56c 278     @$node->loadHTML($html);
21e724 279     return $this->dumpHtml($node);
45f56c 280   }
T 281
282 }
283
2337a8 284 ?>