1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
<?php
// $Id: xoopssecurity.php,v 1.1.4.10.2.1 2005/09/18 13:00:39 mithyt2 Exp $
// ------------------------------------------------------------------------ //
// XOOPS - PHP Content Management System //
// Copyright (c) 2000 XOOPS.org //
// <http://www.xoops.org/> //
// ------------------------------------------------------------------------ //
// This program is free software; you can redistribute it and/or modify //
// it under the terms of the GNU General Public License as published by //
// the Free Software Foundation; either version 2 of the License, or //
// (at your option) any later version. //
// //
// You may not change or alter any portion of this comment or credits //
// of supporting developers from this source code or any supporting //
// source code which is considered copyrighted (c) material of the //
// original comment or credit authors. //
// //
// This program is distributed in the hope that it will be useful, //
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
// GNU General Public License for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with this program; if not, write to the Free Software //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA //
// ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu) //
// URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project //
// ------------------------------------------------------------------------- //
/*
* Class for managing security aspects such as checking referers, applying tokens and checking global variables for contamination
*
* @package kernel
* @subpackage core
*
* @author Jan Pedersen <mithrandir@xoops.org>
* @copyright (c) 2000-2005 The Xoops Project - www.xoops.org
*/
class XoopsSecurity {
var $errors = array();
/**
* Constructor
*
**/
function XoopsSecurity() {
}
/**
* Check if there is a valid token in $_REQUEST['XOOPS_TOKEN_REQUEST'] - can be expanded for more wide use, later (Mith)
*
* @param bool $clearIfValid whether to clear the token after validation
*
* @return bool
*/
function check($clearIfValid = true, $token = false) {
return $this->validateToken($token, $clearIfValid);
}
/**
* Create a token in the user's session
*
* @param int $timeout time in seconds the token should be valid
*
* @return string token value
*/
function createToken($timeout = 0)
{
$this->garbageCollection();
if ($timeout == 0) {
$timeout = intval($GLOBALS['xoopsConfig']['session_expire']) * 60; //session_expire is in minutes, we need seconds
if ($timeout == 0 || $timeout > 1000) { //if timeout is still zero - or a very large value
$timeout = 60*60; //set timeout to 60 minutes
}
}
$token_id = md5(uniqid(rand(), true));
// save token data on the server
if (!isset($_SESSION['XOOPS_TOKEN_SESSION'])) {
$_SESSION['XOOPS_TOKEN_SESSION'] = array();
}
$expire_time = time() + intval($timeout);
$token_data = array('id' => $token_id, 'expire' => $expire_time);
array_push($_SESSION['XOOPS_TOKEN_SESSION'], $token_data);
return md5($token_id.$_SERVER['HTTP_USER_AGENT'].XOOPS_DB_PREFIX);
}
/**
* Check if a token is valid. If no token is specified, $_REQUEST['XOOPS_TOKEN_REQUEST'] is checked
*
* @param string $token token to validate
* @param bool $clearIfValid whether to clear the token value if valid
*
* @return bool
**/
function validateToken($token = false, $clearIfValid = true)
{
global $xoopsLogger;
if ( file_exists(XOOPS_ROOT_PATH."/language/".$GLOBALS['xoopsConfig']['language']."/error.php") ) {
include_once XOOPS_ROOT_PATH."/language/".$GLOBALS['xoopsConfig']['language']."/error.php";
} else {
include_once XOOPS_ROOT_PATH."/language/english/error.php";
}
$token = ($token === false) ? @$_REQUEST['XOOPS_TOKEN_REQUEST'] : $token;
if (empty($token) || empty($_SESSION['XOOPS_TOKEN_SESSION'])) {
$xoopsLogger->addExtra('Token Validation', _ER_SEC_NOTOKENFOUND);
$this->setErrors(_ER_SEC_NOTOKENFOUND);
return false;
}
$validFound = false;
$token_data =& $_SESSION['XOOPS_TOKEN_SESSION'];
foreach (array_keys($token_data) as $i) {
if ($token === md5($token_data[$i]['id'].$_SERVER['HTTP_USER_AGENT'].XOOPS_DB_PREFIX)) {
if ($this->filterToken($token_data[$i])) {
if ($clearIfValid) {
// token should be valid once, so clear it once validated
unset($token_data[$i]);
}
$xoopsLogger->addExtra('Token Validation', 'Valid Token Found');
$validFound = true;
}
else {
$str = _ER_SEC_TOKENEXPIRED;
$this->setErrors($str);
$xoopsLogger->addExtra('Token Validation', $str);
}
}
}
if (!$validFound) {
$xoopsLogger->addExtra('Token Validation', _ER_SEC_NOTOKENFOUND);
$this->setErrors(_ER_SEC_NOTOKENFOUND);
}
$this->garbageCollection();
return $validFound;
}
/**
* Clear all token values from user's session
**/
function clearTokens()
{
$_SESSION['XOOPS_TOKEN_SESSION'] = array();
}
/**
* Check whether a token value is expired or not
*
* @param string $token
*
* @return bool
**/
function filterToken($token)
{
return (!empty($token['expire']) && $token['expire'] >= time());
}
/**
* Perform garbage collection, clearing expired tokens
*
* @return void
**/
function garbageCollection() {
if (isset($_SESSION['XOOPS_TOKEN_SESSION']) && count($_SESSION['XOOPS_TOKEN_SESSION']) > 0) {
$_SESSION['XOOPS_TOKEN_SESSION'] = array_filter($_SESSION['XOOPS_TOKEN_SESSION'], array($this, 'filterToken'));
}
}
/**
* Check the user agent's HTTP REFERER against XOOPS_URL
*
* @param int $docheck 0 to not check the referer (used with XML-RPC), 1 to actively check it
*
* @return bool
**/
function checkReferer($docheck=1)
{
if ($docheck == 0) {
return true;
}
$ref = xoops_getenv('HTTP_REFERER');
if ($ref == '') {
return false;
}
$pref = parse_url($ref);
if ( $pref['host'] != $_SERVER['HTTP_HOST']
// PORT might be appended to $_SERVER['HTTP_HOST'] by some browsers
&& $pref['host'].":".$pref['port'] != $_SERVER['HTTP_HOST']
) {
return false;
}
return true;
}
/**
* Check superglobals for contamination
*
* @return void
**/
function checkSuperglobals() {
foreach (array('GLOBALS', '_SESSION', 'HTTP_SESSION_VARS', '_GET', 'HTTP_GET_VARS', '_POST', 'HTTP_POST_VARS', '_COOKIE', 'HTTP_COOKIE_VARS', '_REQUEST', '_SERVER', 'HTTP_SERVER_VARS', '_ENV', 'HTTP_ENV_VARS', '_FILES', 'HTTP_POST_FILES', 'xoopsDB', 'xoopsUser', 'xoopsUserId', 'xoopsUserGroups', 'xoopsUserIsAdmin', 'xoopsConfig', 'xoopsOption', 'xoopsModule', 'xoopsModuleConfig', 'xoopsRequestUri') as $bad_global) {
if (isset($_REQUEST[$bad_global])) {
header('Location: '.XOOPS_URL.'/');
exit();
}
}
}
/**
* Check if visitor's IP address is banned
* Should be changed to return bool and let the action be up to the calling script
*
* @return void
**/
function checkBadips() {
global $xoopsConfig;
if ($xoopsConfig['enable_badips'] == 1 && isset($_SERVER['REMOTE_ADDR']) && $_SERVER['REMOTE_ADDR'] != '') {
foreach ($xoopsConfig['bad_ips'] as $bi) {
if (!empty($bi) && preg_match("/".$bi."/", $_SERVER['REMOTE_ADDR'])) {
exit();
}
}
}
unset($bi);
unset($bad_ips);
unset($xoopsConfig['badips']);
}
/**
* Get the HTML code for a XoopsFormHiddenToken object - used in forms that do not use XoopsForm elements
*
* @return string
**/
function getTokenHTML() {
require_once(XOOPS_ROOT_PATH."/class/xoopsformloader.php");
$token = new XoopsFormHiddenToken();
return $token->render();
}
/**
* Add an error
*
* @param string $error
**/
function setErrors($error)
{
$this->errors[] = trim($error);
}
/**
* Get generated errors
*
* @param bool $ashtml Format using HTML?
*
* @return array|string Array of array messages OR HTML string
*/
function &getErrors($ashtml = false)
{
if (!$ashtml) {
return $this->errors;
} else {
$ret = '';
if (count($this->errors) > 0) {
foreach ($this->errors as $error) {
$ret .= $error.'<br />';
}
}
return $ret;
}
}
}
?>
|