include/clean.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38 require_once 'include/HTMLPurifier/HTMLPurifier.standalone.php';
  39 require_once 'include/HTMLPurifier/HTMLPurifier.autoload.php';
  40
  41 /**
  42  * cid: scheme implementation
  43  */
  44 class HTMLPurifier_URIScheme_cid extends HTMLPurifier_URIScheme
  45 {
  46     public $browsable = true;
  47     public $may_omit_host = true;
  48
  49     public function doValidate(&$uri, $config, $context) {
  50         $uri->userinfo = null;
  51         $uri->port     = null;
  52         $uri->host     = null;
  53         $uri->query    = null;
  54         $uri->fragment = null;
  55         return true;
  56     }
  57
  58 }
  59
  60 class HTMLPurifier_Filter_Xmp extends HTMLPurifier_Filter
  61 {
  62
  63     public $name = 'Xmp';
  64
  65     public function preFilter($html, $config, $context)
  66     {
  67         return preg_replace("#<(/)?xmp>#i", "<\\1pre>", $html);
  68     }
  69 }
  70
  71 class SugarCleaner
  72 {
  73     /**
  74      * Singleton instance
  75      * @var SugarCleaner
  76      */
  77     static public $instance;
  78
  79     /**
  80      * HTMLPurifier instance
  81      * @var HTMLPurifier
  82      */
  83     protected $purifier;
  84
  85     function __construct()
  86     {
  87         global $sugar_config;
  88         $config = HTMLPurifier_Config::createDefault();
  89
  90         if(!is_dir(sugar_cached("htmlclean"))) {
  91             create_cache_directory("htmlclean");
  92         }
  93         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
  94         $config->set('Core.Encoding', 'UTF-8');
  95         $hidden_tags = array('script' => true, 'style' => true, 'title' => true, 'head' => true);
  96         $config->set('Core.HiddenElements', $hidden_tags);
  97         $config->set('Cache.SerializerPath', sugar_cached("htmlclean"));
  98         $config->set('URI.Base', $sugar_config['site_url']);
  99         $config->set('CSS.Proprietary', true);
 100         $config->set('HTML.TidyLevel', 'light');
 101         $config->set('HTML.ForbiddenElements', array('body' => true, 'html' => true));
 102         $config->set('AutoFormat.RemoveEmpty', false);
 103         // for style
 104         //$config->set('Filter.ExtractStyleBlocks', true);
 105         $config->set('Filter.ExtractStyleBlocks.TidyImpl', false); // can't use csstidy, GPL
 106         // for object
 107         $config->set('HTML.SafeObject', true);
 108         // for embed
 109         $config->set('HTML.SafeEmbed', true);
 110         $config->set('Output.FlashCompat', true);
 111         // for iframe and xmp
 112         $config->set('Filter.Custom',  array(new HTMLPurifier_Filter_Xmp()));
 113         // for link
 114         $config->set('HTML.DefinitionID', 'Sugar HTML Def');
 115         $config->set('HTML.DefinitionRev', 2);
 116         $config->set('Cache.DefinitionImpl', null); // TODO: remove this later!
 117         // IDs are namespaced
 118         $config->set('Attr.EnableID', true);
 119         $config->set('Attr.IDPrefix', 'sugar_text_');
 120
 121         if ($def = $config->maybeGetRawHTMLDefinition()) {
 122             $form = $def->addElement(
 123                         'link',   // name
 124                         'Flow',  // content set
 125                         'Empty', // allowed children
 126                         'Core', // attribute collection
 127                  array( // attributes
 128                         'href*' => 'URI',
 129                         'rel' => 'Enum#stylesheet', // only stylesheets supported here
 130                         'type' => 'Enum#text/css' // only CSS supported here
 131                         )
 132             );
 133             $iframe = $def->addElement(
 134                         'iframe',   // name
 135                         'Flow',  // content set
 136                         'Optional: #PCDATA | Flow | Block', // allowed children
 137                         'Core', // attribute collection
 138                  array( // attributes
 139                         'src*' => 'URI',
 140                     'frameborder' => 'Enum#0,1',
 141                     'marginwidth' =>  'Pixels',
 142                     'marginheight' =>  'Pixels',
 143                     'scrolling' => 'Enum#|yes,no,auto',
 144                         'align' => 'Enum#top,middle,bottom,left,right,center',
 145                     'height' => 'Length',
 146                     'width' => 'Length',
 147                  )
 148             );
 149             $iframe->excludes=array('iframe');
 150         }
 151         $uri = $config->getDefinition('URI');
 152         $uri->addFilter(new SugarURIFilter(), $config);
 153         HTMLPurifier_URISchemeRegistry::instance()->register('cid', new HTMLPurifier_URIScheme_cid());
 154
 155         $this->purifier = new HTMLPurifier($config);
 156     }
 157
 158     /**
 159      * Get cleaner instance
 160      * @return SugarCleaner
 161      */
 162     public static function getInstance()
 163     {
 164         if(is_null(self::$instance)) {
 165             self::$instance = new self;
 166         }
 167         return self::$instance;
 168     }
 169
 170     /**
 171      * Clean string from potential XSS problems
 172      * @param string $html
 173      * @param bool $encoded Was it entity-encoded?
 174      * @return string
 175      */
 176     static public function cleanHtml($html, $encoded = false)
 177     {
 178         if(empty($html)) return $html;
 179
 180         if($encoded) {
 181             $html = from_html($html);
 182         }
 183         if(!preg_match('<[^-A-Za-z0-9 `~!@#$%^&*()_=+{}\[\];:\'",./\\?\r\n|\x80-\xFF]>', $html)) {
 184             /* if it only has "safe" chars, don't bother */
 185             $cleanhtml = $html;
 186         } else {
 187             $purifier = self::getInstance()->purifier;
 188             $cleanhtml = $purifier->purify($html);
 189 //            $styles = $purifier->context->get('StyleBlocks');
 190 //            if(count($styles) > 0) {
 191 //                $cleanhtml = "<style>".join("</style><style>", $styles)."</style>".$cleanhtml;
 192 //            }
 193         }
 194         if($encoded) {
 195             $cleanhtml = to_html($cleanhtml);
 196         }
 197         return $cleanhtml;
 198     }
 199
 200     static public function stripTags($string, $encoded = true)
 201     {
 202         if($encoded) {
 203             $string = from_html($string);
 204         }
 205         $string = filter_var($string, FILTER_SANITIZE_STRIPPED, FILTER_FLAG_NO_ENCODE_QUOTES);
 206         return $encoded?to_html($string):$string;
 207     }
 208 }
 209
 210 /**
 211  * URI filter for HTMLPurifier
 212  * Approves only resource URIs that are in the list of trusted domains
 213  * Until we have comprehensive CSRF protection, we need to sanitize URLs in emails, etc.
 214  * to avoid CSRF attacks.
 215  */
 216 class SugarURIFilter extends HTMLPurifier_URIFilter
 217 {
 218     public $name = 'SugarURIFilter';
 219 //    public $post = true;
 220     protected $allowed = array();
 221
 222     public function prepare($config)
 223     {
 224         global $sugar_config;
 225         if(!empty($sugar_config['security_trusted_domains']) && is_array($sugar_config['security_trusted_domains']))
 226         {
 227             $this->allowed = $sugar_config['security_trusted_domains'];
 228         }
 229         /* Allow this host?
 230         $def = $config->getDefinition('URI');
 231         if(!empty($def->base) && !empty($this->base->host)) {
 232             $this->allowed[] = $def->base->host;
 233         }
 234         */
 235     }
 236
 237     public function filter(&$uri, $config, $context)
 238     {
 239         // skip non-resource URIs
 240         if (!$context->get('EmbeddedURI', true)) return true;
 241
 242         //if(empty($this->allowed)) return false;
 243
 244         if(!empty($uri->scheme) && strtolower($uri->scheme) != 'http' && strtolower($uri->scheme) != 'https') {
 245                 // do not touch non-HTTP URLs
 246                 return true;
 247             }
 248
 249         // relative URLs permitted since email templates use it
 250                 // if(empty($uri->host)) return false;
 251             // allow URLs with no query
 252                 if(empty($uri->query)) return true;
 253
 254                 // allow URLs for known good hosts
 255                 foreach($this->allowed as $allow) {
 256             // must be equal to our domain or subdomain of our domain
 257             if($uri->host == $allow || substr($uri->host, -(strlen($allow)+1)) == ".$allow") {
 258                 return true;
 259             }
 260         }
 261
 262         // Here we try to block URLs that may be used for nasty XSRF stuff by
 263         // referring back to Sugar URLs
 264         // allow URLs that don't start with /? or /index.php?
 265                 if(!empty($uri->path) && $uri->path != '/' && strtolower(substr($uri->path, -10)) != '/index.php') {
 266                         return true;
 267                 }
 268
 269         $query_items = array();
 270                 parse_str(from_html($uri->query), $query_items);
 271             // weird query, probably harmless
 272                 if(empty($query_items)) return true;
 273         // suspiciously like SugarCRM query, reject
 274                 if(!empty($query_items['module']) && !empty($query_items['action'])) return false;
 275         // looks like non-download entry point - allow only specific entry points
 276                 if(!empty($query_items['entryPoint']) && !in_array($query_items['entryPoint'], array('download', 'image', 'getImage'))) {
 277                         return false;
 278                 }
 279
 280                 return true;
 281     }
 282 }