3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
36 * Define the threshold for the ids reactions.
38 private $threshold = array(
52 * This function includes the IDS vendor parts and runs the
53 * detection routines on the request array.
55 * @param object $args cake controller object
59 public function check(&$args) {
60 // lets bypass a few civicrm urls from this check
61 static $skip = array('civicrm/admin/setting/updateConfigBackend', 'civicrm/admin/messageTemplates');
62 $path = implode('/', $args);
63 if (in_array($path, $skip)) {
67 // Add request url and user agent.
68 $_REQUEST['IDS_request_uri'] = $_SERVER['REQUEST_URI'];
69 if (isset($_SERVER['HTTP_USER_AGENT'])) {
70 $_REQUEST['IDS_user_agent'] = $_SERVER['HTTP_USER_AGENT'];
73 $configFile = self
::createConfigFile(FALSE);
75 // init the PHPIDS and pass the REQUEST array
76 require_once 'IDS/Init.php';
78 $init = IDS_Init
::init($configFile);
79 $ids = new IDS_Monitor($_REQUEST, $init);
81 catch (Exception
$e) {
82 // might be an old stale copy of Config.IDS.ini
83 // lets try to rebuild it again and see if it works
84 $configFile = self
::createConfigFile(TRUE);
85 $init = IDS_Init
::init($configFile);
86 $ids = new IDS_Monitor($_REQUEST, $init);
89 $result = $ids->run();
90 if (!$result->isEmpty()) {
91 $this->react($result);
98 * Create the default config file for the IDS system.
101 * Should we recreate it irrespective if it exists or not.
104 * the full path to the config file
106 public static function createConfigFile($force = FALSE) {
107 $config = CRM_Core_Config
::singleton();
108 $configFile = $config->configAndLogDir
. 'Config.IDS.ini';
109 if (!$force && file_exists($configFile)) {
113 $tmpDir = empty($config->uploadDir
) ? CIVICRM_TEMPLATE_COMPILEDIR
: $config->uploadDir
;
115 // also clear the stat cache in case we are upgrading
118 global $civicrm_root;
122 filter_path = {$civicrm_root}/packages/IDS/default_filter.xml
124 HTML_Purifier_Path = IDS/vendors/htmlpurifier/HTMLPurifier.auto.php
125 HTML_Purifier_Cache = $tmpDir
127 exceptions[] = __utmz
128 exceptions[] = __utmc
129 exceptions[] = widget_code
130 exceptions[] = html_message
131 exceptions[] = text_message
132 exceptions[] = body_html
133 exceptions[] = msg_html
134 exceptions[] = msg_text
135 exceptions[] = msg_subject
136 exceptions[] = description
138 exceptions[] = thankyou_text
139 exceptions[] = intro_text
140 exceptions[] = body_text
141 exceptions[] = footer_text
142 exceptions[] = thankyou_text
143 exceptions[] = tf_thankyou_text
144 exceptions[] = thankyou_footer
145 exceptions[] = thankyou_footer_text
146 exceptions[] = new_text
147 exceptions[] = renewal_text
148 exceptions[] = help_pre
149 exceptions[] = help_post
150 exceptions[] = confirm_title
151 exceptions[] = confirm_text
152 exceptions[] = confirm_footer_text
153 exceptions[] = confirm_email_text
154 exceptions[] = report_header
155 exceptions[] = report_footer
158 exceptions[] = instructions
159 exceptions[] = suggested_message
160 exceptions[] = page_text
162 if (file_put_contents($configFile, $contents) === FALSE) {
163 CRM_Core_Error
::movedSiteError($configFile);
166 // also create the .htaccess file so we prevent the reading of the log and ini files
167 // via a browser, CRM-3875
168 CRM_Utils_File
::restrictAccess($config->configAndLogDir
);
174 * This function reacts on the values in the incoming results array.
176 * Depending on the impact value certain actions are
179 * @param IDS_Report $result
183 private function react(IDS_Report
$result) {
185 $impact = $result->getImpact();
186 if ($impact >= $this->threshold
['kick']) {
187 $this->log($result, 3, $impact);
188 $this->kick($result);
191 elseif ($impact >= $this->threshold
['warn']) {
192 $this->log($result, 2, $impact);
193 $this->warn($result);
196 elseif ($impact >= $this->threshold
['log']) {
197 $this->log($result, 0, $impact);
206 * This function writes an entry about the intrusion to the database.
208 * @param array $result
209 * @param int $reaction
213 private function log($result, $reaction = 0) {
214 $ip = (isset($_SERVER['SERVER_ADDR']) &&
215 $_SERVER['SERVER_ADDR'] != '127.0.0.1') ?
$_SERVER['SERVER_ADDR'] : (
216 isset($_SERVER['HTTP_X_FORWARDED_FOR']) ?
$_SERVER['HTTP_X_FORWARDED_FOR'] : '127.0.0.1'
220 $session = CRM_Core_Session
::singleton();
221 foreach ($result as $event) {
223 'name' => $event->getName(),
224 'value' => stripslashes($event->getValue()),
225 'page' => $_SERVER['REQUEST_URI'],
226 'userid' => $session->get('userID'),
227 'session' => session_id() ?
session_id() : '0',
229 'reaction' => $reaction,
230 'impact' => $result->getImpact(),
234 CRM_Core_Error
::debug_var('IDS Detector Details', $data);
241 * @param array $result
245 private function warn($result) {
250 * Kick (whatever that means!).
252 * @param array $result
256 private function kick($result) {
257 $session = CRM_Core_Session
::singleton();
260 $msg = ts('There is a validation error with your HTML input. Your activity is a bit suspicious, hence aborting');
262 $path = implode('/', $args);
265 array("civicrm/ajax/rest", "civicrm/api/json")
267 require_once "api/v3/utils.php";
268 $error = civicrm_api3_create_error(
271 'IP' => $_SERVER['REMOTE_ADDR'],
272 'error_code' => 'IDS_KICK',
273 'level' => 'security',
274 'referer' => $_SERVER['HTTP_REFERER'],
275 'reason' => 'XSS suspected',
278 CRM_Utils_JSON
::output($error);
280 CRM_Core_Error
::fatal($msg);