Fixed DoS hole for fe_session_data table. See changelog for log description.
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / class.tslib_feuserauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2005 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Front End session user. Login and session data
29 * Included from index_ts.php
30 *
31 * $Id$
32 * Revised for TYPO3 3.6 June/2003 by Kasper Skaarhoj
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 * @author René Fritz <r.fritz@colorcube.de>
36 */
37 /**
38 * [CLASS/FUNCTION INDEX of SCRIPT]
39 *
40 *
41 *
42 * 77: class tslib_feUserAuth extends t3lib_userAuth
43 * 141: function fetchGroupData()
44 * 194: function getUserTSconf()
45 *
46 * SECTION: Session data management functions
47 * 239: function fetchSessionData()
48 * 261: function storeSessionData()
49 * 287: function getKey($type,$key)
50 * 312: function setKey($type,$key,$data)
51 * 337: function record_registration($recs)
52 *
53 * TOTAL FUNCTIONS: 7
54 * (This index is automatically created/updated by the extension "extdeveval")
55 *
56 */
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71 /**
72 * Extension class for Front End User Authentication.
73 *
74 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
75 * @author René Fritz <r.fritz@colorcube.de>
76 * @package TYPO3
77 * @subpackage tslib
78 */
79 class tslib_feUserAuth extends t3lib_userAuth {
80 var $session_table = 'fe_sessions'; // Table to use for session data.
81 var $name = 'fe_typo_user'; // Session/Cookie name
82 var $get_name = 'ftu'; // Session/GET-var name
83
84 var $user_table = 'fe_users'; // Table in database with userdata
85 var $username_column = 'username'; // Column for login-name
86 var $userident_column = 'password'; // Column for password
87 var $userid_column = 'uid'; // Column for user-id
88 var $lastLogin_column = 'lastlogin';
89
90 var $enablecolumns = Array (
91 'deleted' => 'deleted',
92 'disabled' => 'disable',
93 'starttime' => 'starttime',
94 'endtime' => 'endtime'
95 );
96 var $formfield_uname = 'user'; // formfield with login-name
97 var $formfield_uident = 'pass'; // formfield with password
98 var $formfield_chalvalue = 'challenge'; // formfield with a unique value which is used to encrypt the password and username
99 var $formfield_status = 'logintype'; // formfield with status: *'login', 'logout'
100 var $security_level = ''; // sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
101
102 var $auth_include = ''; // this is the name of the include-file containing the login form. If not set, login CAN be anonymous. If set login IS needed.
103
104 var $auth_timeout_field = 6000; // if > 0 : session-timeout in seconds. if false/<0 : no timeout. if string: The string is fieldname from the usertable where the timeout can be found.
105
106 var $lifetime = 0; // 0 = Session-cookies. If session-cookies, the browser will stop session when the browser is closed. Else it keeps the session for $lifetime seconds.
107 var $sendNoCacheHeaders = 0;
108 var $getFallBack = 1; // If this is set, authentication is also accepted by the _GET. Notice that the identification is NOT 128bit MD5 hash but reduced. This is done in order to minimize the size for mobile-devices, such as WAP-phones
109 var $hash_length = 10;
110 var $getMethodEnabled = 1; // Login may be supplied by url.
111
112 var $usergroup_column = 'usergroup';
113 var $usergroup_table = 'fe_groups';
114 var $groupData = Array(
115 'title' =>Array(),
116 'uid' =>Array(),
117 'pid' =>Array()
118 );
119 var $TSdataArray=array(); // Used to accumulate the TSconfig data of the user
120 var $userTS = array();
121 var $userTSUpdated=0;
122 var $showHiddenRecords=0;
123
124 // Session and user data:
125 /*
126 There are two types of data that can be stored: UserData and Session-Data. Userdata is for the login-user, and session-data for anyone viewing the pages.
127 'Keys' are keys in the internal dataarray of the data. When you get or set a key in one of the data-spaces (user or session) you decide the type of the variable (not object though)
128 'Reserved' keys are:
129 - 'recs': Array: Used to 'register' records, eg in a shopping basket. Structure: [recs][tablename][record_uid]=number
130 - sys: Reserved for TypoScript standard code.
131 */
132 var $sesData = Array();
133 var $sesData_change = 0;
134 var $userData_change = 0;
135
136
137 /**
138 * Will select all fe_groups records that the current fe_user is member of - and which groups are also allowed in the current domain.
139 * It also accumulates the TSconfig for the fe_user/fe_groups in ->TSdataArray
140 *
141 * @return integer Returns the number of usergroups for the frontend users (if the internal user record exists and the usergroup field contains a value)
142 */
143 function fetchGroupData() {
144 $this->TSdataArray = array();
145 $this->userTS = array();
146 $this->userTSUpdated = 0;
147 $this->groupData = Array(
148 'title' => Array(),
149 'uid' => Array(),
150 'pid' => Array()
151 );
152
153 // Setting default configuration:
154 $this->TSdataArray[]=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultUserTSconfig'];
155
156 // get the info data for auth services
157 $authInfo = $this->getAuthInfoArray();
158
159 if ($this->writeDevLog) t3lib_div::devLog('Get usergroups for user: '.t3lib_div::arrayToLogString($this->user, array($this->userid_column,$this->username_column)), 'tslib_feUserAuth');
160
161 $groupDataArr = array();
162
163 // use 'auth' service to find the groups for the user
164 $serviceChain='';
165 $subType = 'getGroups'.$this->loginType;
166 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
167 $serviceChain.=','.$serviceObj->getServiceKey();
168 $serviceObj->initAuth($subType, array(), $authInfo, $this);
169
170 $groupData = $serviceObj->getGroups($this->user, $groupDataArr);
171 if(is_array($groupData) && count($groupData)) {
172 $groupDataArr = t3lib_div::array_merge($groupDataArr, $groupData); // Keys in $groupData should be unique ids of the groups (like "uid") so this function will override groups.
173 }
174 unset($serviceObj);
175 }
176 if ($this->writeDevLog AND $serviceChain) t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 'tslib_feUserAuth');
177 if ($this->writeDevLog AND !count($groupDataArr)) t3lib_div::devLog('No usergroups found by services', 'tslib_feUserAuth');
178 if ($this->writeDevLog AND count($groupDataArr)) t3lib_div::devLog(count($groupDataArr).' usergroup records found by services', 'tslib_feUserAuth');
179
180
181 // use 'auth' service to check the usergroups if they are really valid
182 foreach($groupDataArr as $groupData) {
183 // by default a group is valid
184 $validGroup = TRUE;
185
186 $serviceChain='';
187 $subType = 'authGroups'.$this->loginType;
188 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
189 $serviceChain.=','.$serviceObj->getServiceKey();
190 $serviceObj->initAuth($subType, array(), $authInfo, $this);
191
192 if (!$serviceObj->authGroup($this->user, $groupData)) {
193 $validGroup = FALSE;
194 if ($this->writeDevLog) t3lib_div::devLog($subType.' auth service did not auth group: '.t3lib_div::arrayToLogString($groupData, 'uid,title'), 'tslib_feUserAuth', 2);
195
196 break;
197 }
198 unset($serviceObj);
199 }
200 unset($serviceObj);
201
202 if ($validGroup) {
203 $this->groupData['title'][$groupData['uid']]=$groupData['title'];
204 $this->groupData['uid'][$groupData['uid']]=$groupData['uid'];
205 $this->groupData['pid'][$groupData['uid']]=$groupData['pid'];
206 $this->groupData['TSconfig'][$groupData['uid']]=$groupData['TSconfig'];
207 }
208 }
209
210 if (count($this->groupData) && count($this->groupData['TSconfig'])) {
211 // TSconfig: collect it in the order it was collected
212 foreach($this->groupData['TSconfig'] as $TSdata) {
213 $this->TSdataArray[]=$TSdata;
214 }
215
216 $this->TSdataArray[]=$this->user['TSconfig'];
217
218 // Sort information
219 ksort($this->groupData['title']);
220 ksort($this->groupData['uid']);
221 ksort($this->groupData['pid']);
222 }
223
224 return count($this->groupData['uid']) ? count($this->groupData['uid']) : 0;
225 }
226
227 /**
228 * Returns the parsed TSconfig for the fe_user
229 * First time this function is called it will parse the TSconfig and store it in $this->userTS. Subsequent requests will not re-parse the TSconfig but simply return what is already in $this->userTS
230 *
231 * @return array TSconfig array for the fe_user
232 */
233 function getUserTSconf() {
234 if (!$this->userTSUpdated) {
235 // Parsing the user TS (or getting from cache)
236 $this->TSdataArray = t3lib_TSparser::checkIncludeLines_array($this->TSdataArray);
237 $userTS = implode(chr(10).'[GLOBAL]'.chr(10),$this->TSdataArray);
238 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
239 $parseObj->parse($userTS);
240 $this->userTS = $parseObj->setup;
241
242 $this->userTSUpdated=1;
243 }
244 return $this->userTS;
245 }
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263 /*****************************************
264 *
265 * Session data management functions
266 *
267 ****************************************/
268
269 /**
270 * Fetches the session data for the user (from the fe_session_data table) based on the ->id of the current user-session.
271 * The session data is restored to $this->sesData
272 * 1/100 calls will also do a garbage collection.
273 *
274 * @return void
275 * @access private
276 * @see storeSessionData()
277 */
278 function fetchSessionData() {
279 // Gets SesData if any
280 if ($this->id) {
281 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'fe_session_data', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, 'fe_session_data'));
282 if ($sesDataRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres)) {
283 $this->sesData = unserialize($sesDataRow['content']);
284 }
285 }
286 // delete old data:
287 if ((rand()%100) <= 1) { // a possibility of 1 % for garbage collection.
288 $GLOBALS['TYPO3_DB']->exec_DELETEquery('fe_session_data', 'tstamp < '.intval(time()-3600*24)); // all data older than 24 hours are deleted.
289 }
290 }
291
292 /**
293 * Will write UC and session data.
294 * If the flag $this->userData_change has been set, the function ->writeUC is called (which will save persistent user session data)
295 * If the flag $this->sesData_change has been set, the fe_session_data table is updated with the content of $this->sesData (deleting any old record, inserting new)
296 *
297 * @return void
298 * @see fetchSessionData(), getKey(), setKey()
299 */
300 function storeSessionData() {
301 // Saves UC and SesData if changed.
302 if ($this->userData_change) {
303 $this->writeUC('');
304 }
305 if ($this->sesData_change) {
306 if ($this->id) {
307 $insertFields = array (
308 'hash' => $this->id,
309 'content' => serialize($this->sesData),
310 'tstamp' => time()
311 );
312 $GLOBALS['TYPO3_DB']->exec_DELETEquery('fe_session_data', 'hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, 'fe_session_data'));
313 $GLOBALS['TYPO3_DB']->exec_INSERTquery('fe_session_data', $insertFields);
314 }
315 }
316 }
317
318 /**
319 * Returns session data for the fe_user; Either persistent data following the fe_users uid/profile (requires login) or current-session based (not available when browse is closed, but does not require login)
320 *
321 * @param string Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
322 * @param string Key from the data array to return; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines which key to return the value for.
323 * @return mixed Returns whatever value there was in the array for the key, $key
324 * @see setKey()
325 */
326 function getKey($type,$key) {
327 if ($key) {
328 switch($type) {
329 case 'user':
330 return $this->uc[$key];
331 break;
332 case 'ses':
333 return $this->sesData[$key];
334 break;
335 }
336 }
337 }
338
339 /**
340 * Saves session data, either persistent or bound to current session cookie. Please see getKey() for more details.
341 * When a value is set the flags $this->userData_change or $this->sesData_change will be set so that the final call to ->storeSessionData() will know if a change has occurred and needs to be saved to the database.
342 * Notice: The key "recs" is already used by the function record_registration() which stores table/uid=value pairs in that key. This is used for the shopping basket among other things.
343 * Notice: Simply calling this function will not save the data to the database! The actual saving is done in storeSessionData() which is called as some of the last things in index_ts.php. So if you exit before this point, nothing gets saved of course! And the solution is to call $GLOBALS['TSFE']->storeSessionData(); before you exit.
344 *
345 * @param string Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
346 * @param string Key from the data array to store incoming data in; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines in which key the $data value will be stored.
347 * @param mixed The data value to store in $key
348 * @return void
349 * @see setKey(), storeSessionData(), record_registration()
350 */
351 function setKey($type,$key,$data) {
352 if ($key) {
353 switch($type) {
354 case 'user':
355 if ($this->user['uid']) {
356 $this->uc[$key]=$data;
357 $this->userData_change=1;
358 }
359 break;
360 case 'ses':
361 $this->sesData[$key]=$data;
362 $this->sesData_change=1;
363 break;
364 }
365 }
366 }
367
368 /**
369 * Registration of records/"shopping basket" in session data
370 * This will take the input array, $recs, and merge into the current "recs" array found in the session data.
371 * If a change in the recs storage happens (which it probably does) the function setKey() is called in order to store the array again.
372 *
373 * @param array The data array to merge into/override the current recs values. The $recs array is constructed as [table]][uid] = scalar-value (eg. string/integer).
374 * @param integer The maximum size of stored session data. If zero, no limit is applied and even confirmation of cookie session is discarded.
375 * @return void
376 */
377 function record_registration($recs,$maxSizeOfSessionData=0) {
378
379 // Storing value ONLY if there is a confirmed cookie set (->cookieID), otherwise a shellscript could easily be spamming the fe_sessions table with bogus content and thus bloat the database
380 if (!$maxSizeOfSessionData || $this->cookieId===$this->id) {
381 if ($recs['clear_all']) {
382 $this->setKey('ses','recs','');
383 }
384 $change=0;
385 $recs_array=$this->getKey('ses','recs');
386 reset($recs);
387 while(list($table,$data)=each($recs)) {
388 if (is_array($data)) {
389 reset($data);
390 while(list($rec_id,$value)=each($data)) {
391 if ($value != $recs_array[$table][$rec_id]) {
392 $recs_array[$table][$rec_id] = $value;
393 $change=1;
394 }
395 }
396 }
397 }
398 if ($change && (!$maxSizeOfSessionData || strlen(serialize($recs_array))<$maxSizeOfSessionData)) {
399 $this->setKey('ses','recs',$recs_array);
400 }
401 }
402 }
403 }
404
405
406 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['tslib/class.tslib_feuserauth.php']) {
407 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['tslib/class.tslib_feuserauth.php']);
408 }
409 ?>