Fixed bug #17665: Remove deprecated method redirect() from t3lib_userAuth
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_userauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (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 * Contains a base class for authentication of users in TYPO3, both frontend and backend.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 * @author René Fritz <r.fritz@colorcube.de>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 111: class t3lib_userAuth
42 * 195: function start()
43 * 329: function checkAuthentication()
44 *
45 * SECTION: User Sessions
46 * 569: function createUserSession ($tempuser)
47 * 606: function fetchUserSession()
48 * 657: function logoff()
49 *
50 * SECTION: SQL Functions
51 * 713: function user_where_clause()
52 * 727: function ipLockClause()
53 * 745: function ipLockClause_remoteIPNumber($parts)
54 * 766: function hashLockClause()
55 * 777: function hashLockClause_getHashInt()
56 *
57 * SECTION: Session and Configuration Handling
58 * 809: function writeUC($variable='')
59 * 824: function unpack_uc($theUC='')
60 * 840: function pushModuleData($module,$data,$noSave=0)
61 * 853: function getModuleData($module,$type='')
62 * 866: function getSessionData($key)
63 * 879: function setAndSaveSessionData($key,$data)
64 *
65 * SECTION: Misc
66 * 912: function getLoginFormData()
67 * 939: function processLoginData($loginData, $security_level='')
68 * 981: function getAuthInfoArray()
69 * 1011: function compareUident($user, $loginData, $security_level='')
70 * 1050: function gc()
71 * 1064: function redirect()
72 * 1086: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid)
73 * 1095: function checkLogFailures()
74 * 1108: function setBeUserByUid($uid)
75 * 1120: function setBeUserByName($name)
76 * 1131: function getRawUserByUid($uid)
77 * 1149: function getRawUserByName($name)
78 *
79 * SECTION: Create/update user - EXPERIMENTAL
80 * 1188: function fetchUserRecord($dbUser, $username, $extraWhere='' )
81 *
82 * TOTAL FUNCTIONS: 29
83 * (This index is automatically created/updated by the extension "extdeveval")
84 *
85 */
86
87
88 require_once(t3lib_extMgm::extPath('sv') . 'class.tx_sv_authbase.php');
89
90
91 /**
92 * Authentication of users in TYPO3
93 *
94 * This class is used to authenticate a login user.
95 * The class is used by both the frontend and backend. In both cases this class is a parent class to beuserauth and feuserauth
96 *
97 * See Inside TYPO3 for more information about the API of the class and internal variables.
98 *
99 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
100 * @author René Fritz <r.fritz@colorcube.de>
101 * @package TYPO3
102 * @subpackage t3lib
103 */
104 class t3lib_userAuth {
105 var $global_database = ''; // Which global database to connect to
106 var $session_table = ''; // Table to use for session data.
107 var $name = ''; // Session/Cookie name
108 var $get_name = ''; // Session/GET-var name
109
110 var $user_table = ''; // Table in database with userdata
111 var $username_column = ''; // Column for login-name
112 var $userident_column = ''; // Column for password
113 var $userid_column = ''; // Column for user-id
114 var $lastLogin_column = '';
115
116 var $enablecolumns = array(
117 'rootLevel' => '', // Boolean: If true, 'AND pid=0' will be a part of the query...
118 'disabled' => '',
119 'starttime' => '',
120 'endtime' => '',
121 'deleted' => ''
122 );
123
124 var $formfield_uname = ''; // formfield with login-name
125 var $formfield_uident = ''; // formfield with password
126 var $formfield_chalvalue = ''; // formfield with a unique value which is used to encrypt the password and username
127 var $formfield_status = ''; // formfield with status: *'login', 'logout'. If empty login is not verified.
128 var $security_level = 'normal'; // sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
129
130 var $auth_timeout_field = 0; // Server session lifetime. If > 0: session-timeout in seconds. If false or <0: no timeout. If string: The string is a fieldname from the usertable where the timeout can be found.
131 var $lifetime = 0; // Client session lifetime. 0 = Session-cookies. If session-cookies, the browser will stop the session when the browser is closed. Otherwise this specifies the lifetime of a cookie that keeps the session.
132 var $gc_time = 0; // GarbageCollection. Purge all server session data older than $gc_time seconds. 0 = default to $this->timeout or use 86400 seconds (1 day) if $this->lifetime is 0
133 var $gc_probability = 1; // Possibility (in percent) for GarbageCollection to be run.
134 var $writeStdLog = FALSE; // Decides if the writelog() function is called at login and logout
135 var $writeAttemptLog = FALSE; // If the writelog() functions is called if a login-attempt has be tried without success
136 var $sendNoCacheHeaders = TRUE; // If this is set, headers is sent to assure, caching is NOT done
137 var $getFallBack = FALSE; // 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
138 var $hash_length = 32; // The ident-hash is normally 32 characters and should be! But if you are making sites for WAP-devices og other lowbandwidth stuff, you may shorten the length. Never let this value drop below 6. A length of 6 would give you more than 16 mio possibilities.
139 var $getMethodEnabled = FALSE; // Setting this flag true lets user-authetication happen from GET_VARS if POST_VARS are not set. Thus you may supply username/password from the URL.
140 var $lockIP = 4; // If set, will lock the session to the users IP address (all four numbers. Reducing to 1-3 means that only first, second or third part of the IP address is used).
141 var $lockHashKeyWords = 'useragent'; // Keyword list (commalist with no spaces!): "useragent". Each keyword indicates some information that can be included in a integer hash made to lock down usersessions. Configurable through $TYPO3_CONF_VARS[TYPO3_MODE]['lockHashKeyWords']
142
143 var $warningEmail = ''; // warning -emailaddress:
144 var $warningPeriod = 3600; // Period back in time (in seconds) in which number of failed logins are collected
145 var $warningMax = 3; // The maximum accepted number of warnings before an email is sent
146 var $checkPid = TRUE; // If set, the user-record must $checkPid_value as pid
147 var $checkPid_value = 0; // The pid, the user-record must have as page-id
148
149 // Internals
150 var $id; // Internal: Will contain session_id (MD5-hash)
151 var $cookieId; // Internal: Will contain the session_id gotten from cookie or GET method. This is used in statistics as a reliable cookie (one which is known to come from $_COOKIE).
152 var $loginFailure = FALSE; // Indicates if an authentication was started but failed
153 var $loginSessionStarted = FALSE; // Will be set to true if the login session is actually written during auth-check.
154
155 var $user; // Internal: Will contain user- AND session-data from database (joined tables)
156 var $get_URL_ID = ''; // Internal: Will will be set to the url--ready (eg. '&login=ab7ef8d...') GET-auth-var if getFallBack is true. Should be inserted in links!
157
158 var $newSessionID = FALSE; // Will be set to true if a new session ID was created
159 var $forceSetCookie = FALSE; // Will force the session cookie to be set everytime (lifetime must be 0)
160 var $dontSetCookie = FALSE; // Will prevent the setting of the session cookie (takes precedence over forceSetCookie)
161 var $challengeStoredInCookie = FALSE; // If set, the challenge value will be stored in a session as well so the server can check that is was not forged.
162 var $loginType = ''; // Login type, used for services.
163
164 var $svConfig = array(); // "auth" services configuration array from $TYPO3_CONF_VARS['SVCONF']['auth']
165 var $writeDevLog = FALSE; // write messages into the devlog?
166
167
168 /**
169 * Starts a user session
170 * Typical configurations will:
171 * a) check if session cookie was set and if not, set one,
172 * b) check if a password/username was sent and if so, try to authenticate the user
173 * c) Lookup a session attached to a user and check timeout etc.
174 * d) Garbage collection, setting of no-cache headers.
175 * If a user is authenticated the database record of the user (array) will be set in the ->user internal variable.
176 *
177 * @return void
178 */
179 function start() {
180 global $TYPO3_CONF_VARS;
181
182 // backend or frontend login - used for auth services
183 $this->loginType = ($this->name == 'fe_typo_user') ? 'FE' : 'BE';
184
185 // set level to normal if not already set
186 if (!$this->security_level) {
187 // Notice: cannot use TYPO3_MODE here because BE user can be logged in and operate inside FE!
188 $this->security_level = trim($TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel']);
189 if (!$this->security_level) {
190 $this->security_level = 'normal';
191 }
192 }
193
194 // enable dev logging if set
195 if ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog']) {
196 $this->writeDevLog = TRUE;
197 }
198 if ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog' . $this->loginType]) {
199 $this->writeDevLog = TRUE;
200 }
201 if (TYPO3_DLOG) {
202 $this->writeDevLog = TRUE;
203 }
204
205 if ($this->writeDevLog) {
206 t3lib_div::devLog('## Beginning of auth logging.', 't3lib_userAuth');
207 }
208
209 // Init vars.
210 $mode = '';
211 $this->newSessionID = FALSE;
212 // $id is set to ses_id if cookie is present. Else set to false, which will start a new session
213 $id = $this->getCookie($this->name);
214 $this->svConfig = $TYPO3_CONF_VARS['SVCONF']['auth'];
215
216 // if we have a flash client, take the ID from the GP
217 if (!$id && $GLOBALS['CLIENT']['BROWSER'] == 'flash') {
218 $id = t3lib_div::_GP($this->name);
219 }
220
221 // If fallback to get mode....
222 if (!$id && $this->getFallBack && $this->get_name) {
223 $id = isset($_GET[$this->get_name]) ? t3lib_div::_GET($this->get_name) : '';
224 if (strlen($id) != $this->hash_length) {
225 $id = '';
226 }
227 $mode = 'get';
228 }
229 $this->cookieId = $id;
230
231 // If new session or client tries to fix session...
232 if (!$id || !$this->isExistingSessionRecord($id)) {
233 // New random session-$id is made
234 $id = $this->createSessionId();
235 // New session
236 $this->newSessionID = TRUE;
237 }
238
239 // Internal var 'id' is set
240 $this->id = $id;
241
242 // If fallback to get mode....
243 if ($mode == 'get' && $this->getFallBack && $this->get_name) {
244 $this->get_URL_ID = '&' . $this->get_name . '=' . $id;
245 }
246
247 // Set session hashKey lock keywords from configuration; currently only 'useragent' can be used.
248 $this->lockHashKeyWords = $TYPO3_CONF_VARS[$this->loginType]['lockHashKeyWords'];
249
250 // Make certain that NO user is set initially
251 $this->user = '';
252
253 // Check to see if anyone has submitted login-information and if so register the user with the session. $this->user[uid] may be used to write log...
254 $this->checkAuthentication();
255
256 // Make certain that NO user is set initially. ->check_authentication may have set a session-record which will provide us with a user record in the next section:
257 unset($this->user);
258
259 // determine whether we need to skip session update.
260 // This is used mainly for checking session timeout without
261 // refreshing the session itself while checking.
262 if (t3lib_div::_GP('skipSessionUpdate')) {
263 $skipSessionUpdate = TRUE;
264 } else {
265 $skipSessionUpdate = FALSE;
266 }
267
268 // re-read user session
269 $this->user = $this->fetchUserSession($skipSessionUpdate);
270
271 if ($this->writeDevLog && is_array($this->user)) {
272 t3lib_div::devLog('User session finally read: ' . t3lib_div::arrayToLogString($this->user, array($this->userid_column, $this->username_column)), 't3lib_userAuth', -1);
273 }
274 if ($this->writeDevLog && !is_array($this->user)) {
275 t3lib_div::devLog('No user session found.', 't3lib_userAuth', 2);
276 }
277
278 // Setting cookies
279 if (!$this->dontSetCookie) {
280 $this->setSessionCookie();
281 }
282
283 // Hook for alternative ways of filling the $this->user array (is used by the "timtaw" extension)
284 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'])) {
285 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'] as $funcName) {
286 $_params = array(
287 'pObj' => &$this,
288 );
289 t3lib_div::callUserFunction($funcName, $_params, $this);
290 }
291 }
292
293 // Set all posible headers that could ensure that the script is not cached on the client-side
294 if ($this->sendNoCacheHeaders) {
295 header('Expires: 0');
296 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
297 header('Cache-Control: no-cache, must-revalidate');
298 header('Pragma: no-cache');
299 }
300
301 // Set $this->gc_time if not explicitely specified
302 if ($this->gc_time == 0) {
303 $this->gc_time = ($this->auth_timeout_field == 0 ? 86400 : $this->auth_timeout_field); // Default to 1 day if $this->auth_timeout_field is 0
304 }
305
306 // If we're lucky we'll get to clean up old sessions....
307 if ((rand() % 100) <= $this->gc_probability) {
308 $this->gc();
309 }
310
311 }
312
313 /**
314 * Sets the session cookie for the current disposal.
315 *
316 * @return void
317 */
318 protected function setSessionCookie() {
319 $isSetSessionCookie = $this->isSetSessionCookie();
320 $isRefreshTimeBasedCookie = $this->isRefreshTimeBasedCookie();
321
322 if ($isSetSessionCookie || $isRefreshTimeBasedCookie) {
323 $settings = $GLOBALS['TYPO3_CONF_VARS']['SYS'];
324
325 // Get the domain to be used for the cookie (if any):
326 $cookieDomain = $this->getCookieDomain();
327 // If no cookie domain is set, use the base path:
328 $cookiePath = ($cookieDomain ? '/' : t3lib_div::getIndpEnv('TYPO3_SITE_PATH'));
329 // If the cookie lifetime is set, use it:
330 $cookieExpire = ($isRefreshTimeBasedCookie ? $GLOBALS['EXEC_TIME'] + $this->lifetime : 0);
331 // Use the secure option when the current request is served by a secure connection:
332 $cookieSecure = (bool) $settings['cookieSecure'] && t3lib_div::getIndpEnv('TYPO3_SSL');
333 // Deliver cookies only via HTTP and prevent possible XSS by JavaScript:
334 $cookieHttpOnly = (bool) $settings['cookieHttpOnly'];
335
336 // Do not set cookie if cookieSecure is set to "1" (force HTTPS) and no secure channel is used:
337 if ((int) $settings['cookieSecure'] !== 1 || t3lib_div::getIndpEnv('TYPO3_SSL')) {
338 setcookie(
339 $this->name,
340 $this->id,
341 $cookieExpire,
342 $cookiePath,
343 $cookieDomain,
344 $cookieSecure,
345 $cookieHttpOnly
346 );
347 } else {
348 throw new t3lib_exception(
349 'Cookie was not set since HTTPS was forced in $TYPO3_CONF_VARS[SYS][cookieSecure].',
350 1254325546
351 );
352 }
353
354 if ($this->writeDevLog) {
355 $devLogMessage = ($isRefreshTimeBasedCookie ? 'Updated Cookie: ' : 'Set Cookie: ') . $this->id;
356 t3lib_div::devLog($devLogMessage . ($cookieDomain ? ', ' . $cookieDomain : ''), 't3lib_userAuth');
357 }
358 }
359 }
360
361 /**
362 * Gets the domain to be used on setting cookies.
363 * The information is taken from the value in $TYPO3_CONF_VARS[SYS][cookieDomain].
364 *
365 * @return string The domain to be used on setting cookies
366 */
367 protected function getCookieDomain() {
368 $result = '';
369 $cookieDomain = $GLOBALS['TYPO3_CONF_VARS']['SYS']['cookieDomain'];
370 // If a specific cookie domain is defined for a given TYPO3_MODE,
371 // use that domain
372 if (!empty($GLOBALS['TYPO3_CONF_VARS'][$this->loginType]['cookieDomain'])) {
373 $cookieDomain = $GLOBALS['TYPO3_CONF_VARS'][$this->loginType]['cookieDomain'];
374 }
375
376 if ($cookieDomain) {
377 if ($cookieDomain{0} == '/') {
378 $match = array();
379 $matchCnt = @preg_match($cookieDomain, t3lib_div::getIndpEnv('TYPO3_HOST_ONLY'), $match);
380 if ($matchCnt === FALSE) {
381 t3lib_div::sysLog('The regular expression for the cookie domain (' . $cookieDomain . ') contains errors. The session is not shared across sub-domains.', 'Core', 3);
382 } elseif ($matchCnt) {
383 $result = $match[0];
384 }
385 } else {
386 $result = $cookieDomain;
387 }
388 }
389
390 return $result;
391 }
392
393 /**
394 * Get the value of a specified cookie.
395 *
396 * Uses HTTP_COOKIE, if available, to avoid a IE8 bug where multiple
397 * cookies with the same name might be returned if the user accessed
398 * the site without "www." first and switched to "www." later:
399 * Cookie: fe_typo_user=AAA; fe_typo_user=BBB
400 * In this case PHP will set _COOKIE as the first cookie, when we
401 * would need the last one (which is what this function then returns).
402 *
403 * @param string The cookie ID
404 * @return string The value stored in the cookie
405 */
406 protected function getCookie($cookieName) {
407 if (isset($_SERVER['HTTP_COOKIE'])) {
408 $cookies = t3lib_div::trimExplode(';', $_SERVER['HTTP_COOKIE']);
409 foreach ($cookies as $cookie) {
410 list ($name, $value) = t3lib_div::trimExplode('=', $cookie);
411 if (strcmp(trim($name), $cookieName) == 0) {
412 // Use the last one
413 $cookieValue = urldecode($value);
414 }
415 }
416 } else {
417 // Fallback if there is no HTTP_COOKIE, use original method:
418 $cookieValue = isset($_COOKIE[$cookieName]) ? stripslashes($_COOKIE[$cookieName]) : '';
419 }
420 return $cookieValue;
421 }
422
423 /**
424 * Determine whether a session cookie needs to be set (lifetime=0)
425 *
426 * @return boolean
427 * @internal
428 */
429 function isSetSessionCookie() {
430 return ($this->newSessionID || $this->forceSetCookie) && $this->lifetime == 0;
431 }
432
433 /**
434 * Determine whether a non-session cookie needs to be set (lifetime>0)
435 *
436 * @return boolean
437 * @internal
438 */
439 function isRefreshTimeBasedCookie() {
440 return $this->lifetime > 0;
441 }
442
443 /**
444 * Checks if a submission of username and password is present or use other authentication by auth services
445 *
446 * @return void
447 * @internal
448 */
449 function checkAuthentication() {
450
451 // No user for now - will be searched by service below
452 $tempuserArr = array();
453 $tempuser = FALSE;
454
455 // User is not authenticated by default
456 $authenticated = FALSE;
457
458 // User want to login with passed login data (name/password)
459 $activeLogin = FALSE;
460
461 // Indicates if an active authentication failed (not auto login)
462 $this->loginFailure = FALSE;
463
464 if ($this->writeDevLog) {
465 t3lib_div::devLog('Login type: ' . $this->loginType, 't3lib_userAuth');
466 }
467
468 // The info array provide additional information for auth services
469 $authInfo = $this->getAuthInfoArray();
470
471 // Get Login/Logout data submitted by a form or params
472 $loginData = $this->getLoginFormData();
473
474 if ($this->writeDevLog) {
475 t3lib_div::devLog('Login data: ' . t3lib_div::arrayToLogString($loginData), 't3lib_userAuth');
476 }
477
478
479 // active logout (eg. with "logout" button)
480 if ($loginData['status'] == 'logout') {
481 if ($this->writeStdLog) {
482 // $type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid
483 $this->writelog(255, 2, 0, 2, 'User %s logged out', array($this->user['username']), '', 0, 0);
484 } // Logout written to log
485 if ($this->writeDevLog) {
486 t3lib_div::devLog('User logged out. Id: ' . $this->id, 't3lib_userAuth', -1);
487 }
488
489 $this->logoff();
490 }
491
492 // active login (eg. with login form)
493 if ($loginData['status'] == 'login') {
494 $activeLogin = TRUE;
495
496 if ($this->writeDevLog) {
497 t3lib_div::devLog('Active login (eg. with login form)', 't3lib_userAuth');
498 }
499
500 // check referer for submitted login values
501 if ($this->formfield_status && $loginData['uident'] && $loginData['uname']) {
502 $httpHost = t3lib_div::getIndpEnv('TYPO3_HOST_ONLY');
503 if (!$this->getMethodEnabled && ($httpHost != $authInfo['refInfo']['host'] && !$GLOBALS['TYPO3_CONF_VARS']['SYS']['doNotCheckReferer'])) {
504 throw new RuntimeException(
505 'TYPO3 Fatal Error: Error: This host address ("' . $httpHost . '") and the referer host ("' . $authInfo['refInfo']['host'] . '") mismatches!<br />
506 It\'s possible that the environment variable HTTP_REFERER is not passed to the script because of a proxy.<br />
507 The site administrator can disable this check in the "All Configuration" section of the Install Tool (flag: TYPO3_CONF_VARS[SYS][doNotCheckReferer]).',
508 1270853930
509 );
510 }
511
512 // delete old user session if any
513 $this->logoff();
514 }
515
516 // Refuse login for _CLI users, if not processing a CLI request type
517 // (although we shouldn't be here in case of a CLI request type)
518 if ((strtoupper(substr($loginData['uname'], 0, 5)) == '_CLI_') && !(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI)) {
519 throw new RuntimeException(
520 'TYPO3 Fatal Error: You have tried to login using a CLI user. Access prohibited!',
521 1270853931
522 );
523 }
524 }
525
526
527 // the following code makes auto-login possible (if configured). No submitted data needed
528
529 // determine whether we need to skip session update.
530 // This is used mainly for checking session timeout without
531 // refreshing the session itself while checking.
532 if (t3lib_div::_GP('skipSessionUpdate')) {
533 $skipSessionUpdate = TRUE;
534 } else {
535 $skipSessionUpdate = FALSE;
536 }
537
538 // re-read user session
539 $authInfo['userSession'] = $this->fetchUserSession($skipSessionUpdate);
540 $haveSession = is_array($authInfo['userSession']) ? TRUE : FALSE;
541
542 if ($this->writeDevLog) {
543 if ($haveSession) {
544 t3lib_div::devLog('User session found: ' . t3lib_div::arrayToLogString($authInfo['userSession'], array($this->userid_column, $this->username_column)), 't3lib_userAuth', 0);
545 }
546 if (is_array($this->svConfig['setup'])) {
547 t3lib_div::devLog('SV setup: ' . t3lib_div::arrayToLogString($this->svConfig['setup']), 't3lib_userAuth', 0);
548 }
549 }
550
551 // fetch user if ...
552 if ($activeLogin
553 || (!$haveSession && $this->svConfig['setup'][$this->loginType . '_fetchUserIfNoSession'])
554 || $this->svConfig['setup'][$this->loginType . '_alwaysFetchUser']) {
555
556 // use 'auth' service to find the user
557 // first found user will be used
558 $serviceChain = '';
559 $subType = 'getUser' . $this->loginType;
560 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
561 $serviceChain .= ',' . $serviceObj->getServiceKey();
562 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
563 if ($row = $serviceObj->getUser()) {
564 $tempuserArr[] = $row;
565
566 if ($this->writeDevLog) {
567 t3lib_div::devLog('User found: ' . t3lib_div::arrayToLogString($row, array($this->userid_column, $this->username_column)), 't3lib_userAuth', 0);
568 }
569
570 // user found, just stop to search for more if not configured to go on
571 if (!$this->svConfig['setup'][$this->loginType . '_fetchAllUsers']) {
572 break;
573 }
574 }
575 unset($serviceObj);
576 }
577 unset($serviceObj);
578
579 if ($this->writeDevLog && $this->svConfig['setup'][$this->loginType . '_alwaysFetchUser']) {
580 t3lib_div::devLog($this->loginType . '_alwaysFetchUser option is enabled', 't3lib_userAuth');
581 }
582 if ($this->writeDevLog && $serviceChain) {
583 t3lib_div::devLog($subType . ' auth services called: ' . $serviceChain, 't3lib_userAuth');
584 }
585 if ($this->writeDevLog && !count($tempuserArr)) {
586 t3lib_div::devLog('No user found by services', 't3lib_userAuth');
587 }
588 if ($this->writeDevLog && count($tempuserArr)) {
589 t3lib_div::devLog(count($tempuserArr) . ' user records found by services', 't3lib_userAuth');
590 }
591 }
592
593
594 // If no new user was set we use the already found user session
595 if (!count($tempuserArr) && $haveSession) {
596 $tempuserArr[] = $authInfo['userSession'];
597 $tempuser = $authInfo['userSession'];
598 // User is authenticated because we found a user session
599 $authenticated = TRUE;
600
601 if ($this->writeDevLog) {
602 t3lib_div::devLog('User session used: ' . t3lib_div::arrayToLogString($authInfo['userSession'], array($this->userid_column, $this->username_column)), 't3lib_userAuth');
603 }
604 }
605
606
607 // Re-auth user when 'auth'-service option is set
608 if ($this->svConfig['setup'][$this->loginType . '_alwaysAuthUser']) {
609 $authenticated = FALSE;
610 if ($this->writeDevLog) {
611 t3lib_div::devLog('alwaysAuthUser option is enabled', 't3lib_userAuth');
612 }
613 }
614
615
616 // Authenticate the user if needed
617 if (count($tempuserArr) && !$authenticated) {
618
619 foreach ($tempuserArr as $tempuser) {
620
621 // use 'auth' service to authenticate the user
622 // if one service returns FALSE then authentication failed
623 // a service might return 100 which means there's no reason to stop but the user can't be authenticated by that service
624
625 if ($this->writeDevLog) {
626 t3lib_div::devLog('Auth user: ' . t3lib_div::arrayToLogString($tempuser), 't3lib_userAuth');
627 }
628
629 $serviceChain = '';
630 $subType = 'authUser' . $this->loginType;
631 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
632 $serviceChain .= ',' . $serviceObj->getServiceKey();
633 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
634 if (($ret = $serviceObj->authUser($tempuser)) > 0) {
635
636 // if the service returns >=200 then no more checking is needed - useful for IP checking without password
637 if (intval($ret) >= 200) {
638 $authenticated = TRUE;
639 break;
640 } elseif (intval($ret) >= 100) {
641 // Just go on. User is still not authenticated but there's no reason to stop now.
642 } else {
643 $authenticated = TRUE;
644 }
645
646 } else {
647 $authenticated = FALSE;
648 break;
649 }
650 unset($serviceObj);
651 }
652 unset($serviceObj);
653
654 if ($this->writeDevLog && $serviceChain) {
655 t3lib_div::devLog($subType . ' auth services called: ' . $serviceChain, 't3lib_userAuth');
656 }
657
658 if ($authenticated) {
659 // leave foreach() because a user is authenticated
660 break;
661 }
662 }
663 }
664
665 // If user is authenticated a valid user is in $tempuser
666 if ($authenticated) {
667 // reset failure flag
668 $this->loginFailure = FALSE;
669
670 // Insert session record if needed:
671 if (!($haveSession && (
672 $tempuser['ses_id'] == $this->id || // check if the tempuser has the current session id
673 $tempuser['uid'] == $authInfo['userSession']['ses_userid'] // check if the tempuser has the uid of the fetched session user
674 ))) {
675 $this->createUserSession($tempuser);
676
677 // The login session is started.
678 $this->loginSessionStarted = TRUE;
679 }
680
681 // User logged in - write that to the log!
682 if ($this->writeStdLog && $activeLogin) {
683 $this->writelog(255, 1, 0, 1,
684 'User %s logged in from %s (%s)',
685 array($tempuser[$this->username_column], t3lib_div::getIndpEnv('REMOTE_ADDR'), t3lib_div::getIndpEnv('REMOTE_HOST')),
686 '', '', '', -1, '', $tempuser['uid']
687 );
688 }
689
690 if ($this->writeDevLog && $activeLogin) {
691 t3lib_div::devLog('User ' . $tempuser[$this->username_column] . ' logged in from ' . t3lib_div::getIndpEnv('REMOTE_ADDR') . ' (' . t3lib_div::getIndpEnv('REMOTE_HOST') . ')', 't3lib_userAuth', -1);
692 }
693 if ($this->writeDevLog && !$activeLogin) {
694 t3lib_div::devLog('User ' . $tempuser[$this->username_column] . ' authenticated from ' . t3lib_div::getIndpEnv('REMOTE_ADDR') . ' (' . t3lib_div::getIndpEnv('REMOTE_HOST') . ')', 't3lib_userAuth', -1);
695 }
696
697 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSL'] == 3 && $this->user_table == 'be_users') {
698 $requestStr = substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT'), strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL') . TYPO3_mainDir));
699 $backendScript = t3lib_BEfunc::getBackendScript();
700 if ($requestStr == $backendScript && t3lib_div::getIndpEnv('TYPO3_SSL')) {
701 list(, $url) = explode('://', t3lib_div::getIndpEnv('TYPO3_SITE_URL'), 2);
702 list($server, $address) = explode('/', $url, 2);
703 if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSLPort'])) {
704 $sslPortSuffix = ':' . intval($GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSLPort']);
705 $server = str_replace($sslPortSuffix, '', $server); // strip port from server
706 }
707 t3lib_utility_Http::redirect('http://' . $server . '/' . $address . TYPO3_mainDir . $backendScript);
708 }
709 }
710
711 } elseif ($activeLogin || count($tempuserArr)) {
712 $this->loginFailure = TRUE;
713
714 if ($this->writeDevLog && !count($tempuserArr) && $activeLogin) {
715 t3lib_div::devLog('Login failed: ' . t3lib_div::arrayToLogString($loginData), 't3lib_userAuth', 2);
716 }
717 if ($this->writeDevLog && count($tempuserArr)) {
718 t3lib_div::devLog('Login failed: ' . t3lib_div::arrayToLogString($tempuser, array($this->userid_column, $this->username_column)), 't3lib_userAuth', 2);
719 }
720 }
721
722
723 // If there were a login failure, check to see if a warning email should be sent:
724 if ($this->loginFailure && $activeLogin) {
725 if ($this->writeDevLog) {
726 t3lib_div::devLog('Call checkLogFailures: ' . t3lib_div::arrayToLogString(array('warningEmail' => $this->warningEmail, 'warningPeriod' => $this->warningPeriod, 'warningMax' => $this->warningMax,)), 't3lib_userAuth', -1);
727 }
728
729 $this->checkLogFailures($this->warningEmail, $this->warningPeriod, $this->warningMax);
730 }
731 }
732
733 /**
734 * Creates a new session ID.
735 *
736 * @return string The new session ID
737 */
738 public function createSessionId() {
739 return t3lib_div::getRandomHexString($this->hash_length);
740 }
741
742
743 /*************************
744 *
745 * User Sessions
746 *
747 *************************/
748
749
750 /**
751 * Creates a user session record.
752 *
753 * @param array user data array
754 * @return void
755 */
756 function createUserSession($tempuser) {
757
758 if ($this->writeDevLog) {
759 t3lib_div::devLog('Create session ses_id = ' . $this->id, 't3lib_userAuth');
760 }
761
762 // delete session entry first
763 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
764 $this->session_table,
765 'ses_id = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table) . '
766 AND ses_name = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
767 );
768
769 // re-create session entry
770 $insertFields = $this->getNewSessionRecord($tempuser);
771 $GLOBALS['TYPO3_DB']->exec_INSERTquery($this->session_table, $insertFields);
772
773 // Updating lastLogin_column carrying information about last login.
774 if ($this->lastLogin_column) {
775 $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
776 $this->user_table,
777 $this->userid_column . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($tempuser[$this->userid_column], $this->user_table),
778 array($this->lastLogin_column => $GLOBALS['EXEC_TIME'])
779 );
780 }
781 }
782
783 /**
784 * Returns a new session record for the current user for insertion into the DB.
785 * This function is mainly there as a wrapper for inheriting classes to override it.
786 *
787 * @return array user session record
788 */
789 function getNewSessionRecord($tempuser) {
790 return array(
791 'ses_id' => $this->id,
792 'ses_name' => $this->name,
793 'ses_iplock' => $tempuser['disableIPlock'] ? '[DISABLED]' : $this->ipLockClause_remoteIPNumber($this->lockIP),
794 'ses_hashlock' => $this->hashLockClause_getHashInt(),
795 'ses_userid' => $tempuser[$this->userid_column],
796 'ses_tstamp' => $GLOBALS['EXEC_TIME']
797 );
798 }
799
800 /**
801 * Read the user session from db.
802 *
803 * @return array user session data
804 */
805 function fetchUserSession($skipSessionUpdate = FALSE) {
806
807 $user = '';
808
809 if ($this->writeDevLog) {
810 t3lib_div::devLog('Fetch session ses_id = ' . $this->id, 't3lib_userAuth');
811 }
812
813 // fetch the user session from the DB
814 $statement = $this->fetchUserSessionFromDB();
815 $user = FALSE;
816 if ($statement) {
817 $statement->execute();
818 $user = $statement->fetch();
819 $statement->free();
820 }
821
822 if ($statement && $user) {
823 // A user was found
824 if (is_string($this->auth_timeout_field)) {
825 $timeout = intval($user[$this->auth_timeout_field]); // Get timeout-time from usertable
826 } else {
827 $timeout = intval($this->auth_timeout_field); // Get timeout from object
828 }
829 // If timeout > 0 (true) and currenttime has not exceeded the latest sessions-time plus the timeout in seconds then accept user
830 // Option later on: We could check that last update was at least x seconds ago in order not to update twice in a row if one script redirects to another...
831 if ($timeout > 0 && ($GLOBALS['EXEC_TIME'] < ($user['ses_tstamp'] + $timeout))) {
832 if (!$skipSessionUpdate) {
833 $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
834 $this->session_table,
835 'ses_id=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table) . '
836 AND ses_name=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table),
837 array('ses_tstamp' => $GLOBALS['EXEC_TIME'])
838 );
839 $user['ses_tstamp'] = $GLOBALS['EXEC_TIME']; // Make sure that the timestamp is also updated in the array
840 }
841
842 } else {
843 $this->logoff(); // delete any user set...
844 }
845 } else {
846 $this->logoff(); // delete any user set...
847 }
848 return $user;
849 }
850
851 /**
852 * Log out current user!
853 * Removes the current session record, sets the internal ->user array to a blank string; Thereby the current user (if any) is effectively logged out!
854 *
855 * @return void
856 */
857 function logoff() {
858 if ($this->writeDevLog) {
859 t3lib_div::devLog('logoff: ses_id = ' . $this->id, 't3lib_userAuth');
860 }
861
862 // Hook for pre-processing the logoff() method, requested and implemented by andreas.otto@dkd.de:
863 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'])) {
864 $_params = array();
865 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'] as $_funcRef) {
866 if ($_funcRef) {
867 t3lib_div::callUserFunction($_funcRef, $_params, $this);
868 }
869 }
870 }
871
872 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
873 $this->session_table,
874 'ses_id = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table) . '
875 AND ses_name = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
876 );
877
878 $this->user = '';
879
880 // Hook for post-processing the logoff() method, requested and implemented by andreas.otto@dkd.de:
881 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'])) {
882 $_params = array();
883 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'] as $_funcRef) {
884 if ($_funcRef) {
885 t3lib_div::callUserFunction($_funcRef, $_params, $this);
886 }
887 }
888 }
889 }
890
891 /**
892 * Determine whether there's an according session record to a given session_id
893 * in the database. Don't care if session record is still valid or not.
894 *
895 * @param integer Claimed Session ID
896 * @return boolean Returns true if a corresponding session was found in the database
897 */
898 function isExistingSessionRecord($id) {
899 $statement = $GLOBALS['TYPO3_DB']->prepare_SELECTquery(
900 'COUNT(*)',
901 $this->session_table,
902 'ses_id = :ses_id'
903 );
904 $statement->execute(array(':ses_id' => $id));
905 $row = $statement->fetch(t3lib_db_PreparedStatement::FETCH_NUM);
906 $statement->free();
907
908 return (($row[0] ? TRUE : FALSE));
909 }
910
911
912 /*************************
913 *
914 * SQL Functions
915 *
916 *************************/
917
918 /**
919 * The session_id is used to find user in the database.
920 * Two tables are joined: The session-table with user_id of the session and the usertable with its primary key
921 * if the client is flash (e.g. from a flash application inside TYPO3 that does a server request)
922 * then don't evaluate with the hashLockClause, as the client/browser is included in this hash
923 * and thus, the flash request would be rejected
924 *
925 * @return t3lib_db_PreparedStatement
926 * @access private
927 */
928 protected function fetchUserSessionFromDB() {
929 $statement = NULL;
930 $ipLockClause = $this->ipLockClause();
931
932 if ($GLOBALS['CLIENT']['BROWSER'] == 'flash') {
933 // if on the flash client, the veri code is valid, then the user session is fetched
934 // from the DB without the hashLock clause
935 if (t3lib_div::_GP('vC') == $this->veriCode()) {
936 $statement = $GLOBALS['TYPO3_DB']->prepare_SELECTquery(
937 '*',
938 $this->session_table . ',' . $this->user_table,
939 $this->session_table . '.ses_id = :ses_id
940 AND ' . $this->session_table . '.ses_name = :ses_name
941 AND ' . $this->session_table . '.ses_userid = ' . $this->user_table . '.' . $this->userid_column . '
942 ' . $ipLockClause['where'] . '
943 ' . $this->user_where_clause()
944 );
945 $statement->bindValues(array(
946 ':ses_id' => $this->id,
947 ':ses_name' => $this->name,
948 ));
949 $statement->bindValues($ipLockClause['parameters']);
950 }
951 } else {
952 $statement = $GLOBALS['TYPO3_DB']->prepare_SELECTquery(
953 '*',
954 $this->session_table . ',' . $this->user_table,
955 $this->session_table . '.ses_id = :ses_id
956 AND ' . $this->session_table . '.ses_name = :ses_name
957 AND ' . $this->session_table . '.ses_userid = ' . $this->user_table . '.' . $this->userid_column . '
958 ' . $ipLockClause['where'] . '
959 ' . $this->hashLockClause() . '
960 ' . $this->user_where_clause()
961 );
962 $statement->bindValues(array(
963 ':ses_id' => $this->id,
964 ':ses_name' => $this->name,
965 ));
966 $statement->bindValues($ipLockClause['parameters']);
967 }
968 return $statement;
969 }
970
971
972 /**
973 * This returns the where-clause needed to select the user with respect flags like deleted, hidden, starttime, endtime
974 *
975 * @return string
976 * @access private
977 */
978 protected function user_where_clause() {
979 return (($this->enablecolumns['rootLevel']) ? 'AND ' . $this->user_table . '.pid=0 ' : '') .
980 (($this->enablecolumns['disabled']) ? ' AND ' . $this->user_table . '.' . $this->enablecolumns['disabled'] . '=0' : '') .
981 (($this->enablecolumns['deleted']) ? ' AND ' . $this->user_table . '.' . $this->enablecolumns['deleted'] . '=0' : '') .
982 (($this->enablecolumns['starttime']) ? ' AND (' . $this->user_table . '.' . $this->enablecolumns['starttime'] . '<=' . $GLOBALS['EXEC_TIME'] . ')' : '') .
983 (($this->enablecolumns['endtime']) ? ' AND (' . $this->user_table . '.' . $this->enablecolumns['endtime'] . '=0 OR ' . $this->user_table . '.' . $this->enablecolumns['endtime'] . '>' . $GLOBALS['EXEC_TIME'] . ')' : '');
984 }
985
986 /**
987 * This returns the where prepared statement-clause needed to lock a user to the IP address
988 *
989 * @return array
990 * @access private
991 */
992 protected function ipLockClause() {
993 $statementClause = array(
994 'where' => '',
995 'parameters' => array(),
996 );
997 if ($this->lockIP) {
998 $statementClause['where'] = 'AND (
999 ' . $this->session_table . '.ses_iplock = :ses_iplock
1000 OR ' . $this->session_table . '.ses_iplock=\'[DISABLED]\'
1001 )';
1002 $statementClause['parameters'] = array(
1003 ':ses_iplock' => $this->ipLockClause_remoteIPNumber($this->lockIP),
1004 );
1005 }
1006 return $statementClause;
1007 }
1008
1009 /**
1010 * Returns the IP address to lock to.
1011 * The IP address may be partial based on $parts.
1012 *
1013 * @param integer 1-4: Indicates how many parts of the IP address to return. 4 means all, 1 means only first number.
1014 * @return string (Partial) IP address for REMOTE_ADDR
1015 * @access private
1016 */
1017 protected function ipLockClause_remoteIPNumber($parts) {
1018 $IP = t3lib_div::getIndpEnv('REMOTE_ADDR');
1019
1020 if ($parts >= 4) {
1021 return $IP;
1022 } else {
1023 $parts = t3lib_div::intInRange($parts, 1, 3);
1024 $IPparts = explode('.', $IP);
1025 for ($a = 4; $a > $parts; $a--) {
1026 unset($IPparts[$a - 1]);
1027 }
1028 return implode('.', $IPparts);
1029 }
1030 }
1031
1032 /**
1033 * VeriCode returns 10 first chars of a md5 hash of the session cookie AND the encryptionKey from TYPO3_CONF_VARS.
1034 * This code is used as an alternative verification when the JavaScript interface executes cmd's to tce_db.php from eg. MSIE 5.0 because the proper referer is not passed with this browser...
1035 *
1036 * @return string
1037 */
1038 public function veriCode() {
1039 return substr(md5($this->id . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']), 0, 10);
1040 }
1041
1042 /**
1043 * This returns the where-clause needed to lock a user to a hash integer
1044 *
1045 * @return string
1046 * @access private
1047 */
1048 protected function hashLockClause() {
1049 $wherePart = 'AND ' . $this->session_table . '.ses_hashlock=' . intval($this->hashLockClause_getHashInt());
1050 return $wherePart;
1051 }
1052
1053 /**
1054 * Creates hash integer to lock user to. Depends on configured keywords
1055 *
1056 * @return integer Hash integer
1057 * @access private
1058 */
1059 protected function hashLockClause_getHashInt() {
1060 $hashStr = '';
1061
1062 if (t3lib_div::inList($this->lockHashKeyWords, 'useragent')) {
1063 $hashStr .= ':' . t3lib_div::getIndpEnv('HTTP_USER_AGENT');
1064 }
1065
1066 return t3lib_div::md5int($hashStr);
1067 }
1068
1069
1070 /*************************
1071 *
1072 * Session and Configuration Handling
1073 *
1074 *************************/
1075
1076 /**
1077 * This writes $variable to the user-record. This is a way of providing session-data.
1078 * You can fetch the data again through $this->uc in this class!
1079 * If $variable is not an array, $this->uc is saved!
1080 *
1081 * @param array An array you want to store for the user as session data. If $variable is not supplied (is blank string), the internal variable, ->uc, is stored by default
1082 * @return void
1083 */
1084 function writeUC($variable = '') {
1085 if (is_array($this->user) && $this->user[$this->userid_column]) {
1086 if (!is_array($variable)) {
1087 $variable = $this->uc;
1088 }
1089
1090 if ($this->writeDevLog) {
1091 t3lib_div::devLog('writeUC: ' . $this->userid_column . '=' . intval($this->user[$this->userid_column]), 't3lib_userAuth');
1092 }
1093 $GLOBALS['TYPO3_DB']->exec_UPDATEquery($this->user_table, $this->userid_column . '=' . intval($this->user[$this->userid_column]), array('uc' => serialize($variable)));
1094 }
1095 }
1096
1097 /**
1098 * Sets $theUC as the internal variable ->uc IF $theUC is an array. If $theUC is false, the 'uc' content from the ->user array will be unserialized and restored in ->uc
1099 *
1100 * @param mixed If an array, then set as ->uc, otherwise load from user record
1101 * @return void
1102 */
1103 function unpack_uc($theUC = '') {
1104 if (!$theUC) {
1105 $theUC = unserialize($this->user['uc']);
1106 }
1107 if (is_array($theUC)) {
1108 $this->uc = $theUC;
1109 }
1110 }
1111
1112 /**
1113 * Stores data for a module.
1114 * The data is stored with the session id so you can even check upon retrieval if the module data is from a previous session or from the current session.
1115 *
1116 * @param string $module is the name of the module ($MCONF['name'])
1117 * @param mixed $data is the data you want to store for that module (array, string, ...)
1118 * @param boolean If $noSave is set, then the ->uc array (which carries all kinds of user data) is NOT written immediately, but must be written by some subsequent call.
1119 * @return void
1120 */
1121 function pushModuleData($module, $data, $noSave = 0) {
1122 $this->uc['moduleData'][$module] = $data;
1123 $this->uc['moduleSessionID'][$module] = $this->id;
1124 if (!$noSave) {
1125 $this->writeUC();
1126 }
1127 }
1128
1129 /**
1130 * Gets module data for a module (from a loaded ->uc array)
1131 *
1132 * @param string $module is the name of the module ($MCONF['name'])
1133 * @param string If $type = 'ses' then module data is returned only if it was stored in the current session, otherwise data from a previous session will be returned (if available).
1134 * @return mixed The module data if available: $this->uc['moduleData'][$module];
1135 */
1136 function getModuleData($module, $type = '') {
1137 if ($type != 'ses' || $this->uc['moduleSessionID'][$module] == $this->id) {
1138 return $this->uc['moduleData'][$module];
1139 }
1140 }
1141
1142 /**
1143 * Returns the session data stored for $key.
1144 * The data will last only for this login session since it is stored in the session table.
1145 *
1146 * @param string Pointer to an associative key in the session data array which is stored serialized in the field "ses_data" of the session table.
1147 * @return mixed
1148 */
1149 function getSessionData($key) {
1150 $sesDat = unserialize($this->user['ses_data']);
1151 return $sesDat[$key];
1152 }
1153
1154 /**
1155 * Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database.
1156 * The data will last only for this login session since it is stored in the session table.
1157 *
1158 * @param string Pointer to an associative key in the session data array which is stored serialized in the field "ses_data" of the session table.
1159 * @param mixed The variable to store in index $key
1160 * @return void
1161 */
1162 function setAndSaveSessionData($key, $data) {
1163 $sesDat = unserialize($this->user['ses_data']);
1164 $sesDat[$key] = $data;
1165 $this->user['ses_data'] = serialize($sesDat);
1166
1167 if ($this->writeDevLog) {
1168 t3lib_div::devLog('setAndSaveSessionData: ses_id = ' . $this->user['ses_id'], 't3lib_userAuth');
1169 }
1170 $GLOBALS['TYPO3_DB']->exec_UPDATEquery($this->session_table, 'ses_id=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->user['ses_id'], $this->session_table), array('ses_data' => $this->user['ses_data']));
1171 }
1172
1173
1174 /*************************
1175 *
1176 * Misc
1177 *
1178 *************************/
1179
1180 /**
1181 * Returns an info array with Login/Logout data submitted by a form or params
1182 *
1183 * @return array
1184 * @internal
1185 */
1186 function getLoginFormData() {
1187 $loginData = array();
1188 if ($this->getMethodEnabled) {
1189 $loginData['status'] = t3lib_div::_GP($this->formfield_status);
1190 $loginData['uname'] = t3lib_div::_GP($this->formfield_uname);
1191 $loginData['uident'] = t3lib_div::_GP($this->formfield_uident);
1192 $loginData['chalvalue'] = t3lib_div::_GP($this->formfield_chalvalue);
1193 } else {
1194 $loginData['status'] = t3lib_div::_POST($this->formfield_status);
1195 $loginData['uname'] = t3lib_div::_POST($this->formfield_uname);
1196 $loginData['uident'] = t3lib_div::_POST($this->formfield_uident);
1197 $loginData['chalvalue'] = t3lib_div::_POST($this->formfield_chalvalue);
1198 }
1199 $loginData = $this->processLoginData($loginData);
1200
1201 return $loginData;
1202 }
1203
1204 /**
1205 * Processes Login data submitted by a form or params depending on the
1206 * security_level
1207 *
1208 * @param array login data array
1209 * @param string Alternative security_level. Used when authentication services wants to override the default.
1210 * @return array processed login data array
1211 * @internal
1212 */
1213 function processLoginData($loginData, $security_level = '') {
1214 global $TYPO3_CONF_VARS;
1215
1216 $loginSecurityLevel = $security_level ? $security_level : ($TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel'] ? $TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel'] : $this->security_level);
1217
1218 // Processing data according to the state it was submitted in.
1219 // ($loginSecurityLevel should reflect the security level used on the data being submitted in the login form)
1220 if ($loginSecurityLevel == 'normal') {
1221 $loginData['uident_text'] = $loginData['uident'];
1222 $loginData['uident_challenged'] = (string) md5($loginData['uname'] . ':' . $loginData['uident'] . ':' . $loginData['chalvalue']);
1223 $loginData['uident_superchallenged'] = (string) md5($loginData['uname'] . ':' . (md5($loginData['uident'])) . ':' . $loginData['chalvalue']);
1224 } elseif ($loginSecurityLevel == 'challenged') {
1225 $loginData['uident_text'] = '';
1226 $loginData['uident_challenged'] = $loginData['uident'];
1227 $loginData['uident_superchallenged'] = '';
1228 } elseif ($loginSecurityLevel == 'superchallenged') {
1229 $loginData['uident_text'] = '';
1230 $loginData['uident_challenged'] = '';
1231 $loginData['uident_superchallenged'] = $loginData['uident'];
1232 }
1233
1234 // The password "uident" is set based on the internal security setting of TYPO3
1235 // Example:
1236 // $this->security_level for the backend must be "superchallenged" because passwords are stored as md5-hashes in the be_users table
1237 // $this->security_level for the frontend must be "normal" or "challenged" because passwords are stored as clear-text in the fe_users tables
1238 if ($this->security_level == 'normal') {
1239 $loginData['uident'] = $loginData['uident_text'];
1240 } elseif ($this->security_level == 'challenged') {
1241 $loginData['uident'] = $loginData['uident_challenged'];
1242 } elseif ($this->security_level == 'superchallenged') {
1243 $loginData['uident'] = $loginData['uident_superchallenged'];
1244 }
1245
1246 return $loginData;
1247 }
1248
1249 /**
1250 * Returns an info array which provides additional information for auth services
1251 *
1252 * @return array
1253 * @internal
1254 */
1255 function getAuthInfoArray() {
1256 $authInfo = array();
1257 $authInfo['loginType'] = $this->loginType;
1258 $authInfo['refInfo'] = parse_url(t3lib_div::getIndpEnv('HTTP_REFERER'));
1259 $authInfo['HTTP_HOST'] = t3lib_div::getIndpEnv('HTTP_HOST');
1260 $authInfo['REMOTE_ADDR'] = t3lib_div::getIndpEnv('REMOTE_ADDR');
1261 $authInfo['REMOTE_HOST'] = t3lib_div::getIndpEnv('REMOTE_HOST');
1262 $authInfo['security_level'] = $this->security_level;
1263 $authInfo['showHiddenRecords'] = $this->showHiddenRecords;
1264 // can be overidden in localconf by SVCONF:
1265 $authInfo['db_user']['table'] = $this->user_table;
1266 $authInfo['db_user']['userid_column'] = $this->userid_column;
1267 $authInfo['db_user']['username_column'] = $this->username_column;
1268 $authInfo['db_user']['userident_column'] = $this->userident_column;
1269 $authInfo['db_user']['usergroup_column'] = $this->usergroup_column;
1270 $authInfo['db_user']['enable_clause'] = $this->user_where_clause();
1271 $authInfo['db_user']['checkPidList'] = $this->checkPid ? $this->checkPid_value : '';
1272 $authInfo['db_user']['check_pid_clause'] = $this->checkPid ? ' AND pid IN (' . $GLOBALS['TYPO3_DB']->cleanIntList($authInfo['db_user']['checkPidList']) . ')' : '';
1273 $authInfo['db_groups']['table'] = $this->usergroup_table;
1274 return $authInfo;
1275 }
1276
1277 /**
1278 * Check the login data with the user record data for builtin login methods
1279 *
1280 * @param array user data array
1281 * @param array login data array
1282 * @param string Alternative security_level. Used when authentication services wants to override the default.
1283 * @return boolean true if login data matched
1284 */
1285 function compareUident($user, $loginData, $security_level = '') {
1286
1287 $OK = FALSE;
1288 $security_level = $security_level ? $security_level : $this->security_level;
1289
1290 switch ($security_level) {
1291 case 'superchallenged': // If superchallenged the password in the database ($user[$this->userident_column]) must be a md5-hash of the original password.
1292 case 'challenged':
1293
1294 // Check challenge stored in cookie:
1295 if ($this->challengeStoredInCookie) {
1296 session_start();
1297 if ($_SESSION['login_challenge'] !== $loginData['chalvalue']) {
1298 if ($this->writeDevLog) {
1299 t3lib_div::devLog('PHP Session stored challenge "' . $_SESSION['login_challenge'] . '" and submitted challenge "' . $loginData['chalvalue'] . '" did not match, so authentication failed!', 't3lib_userAuth', 2);
1300 }
1301 $this->logoff();
1302 return FALSE;
1303 }
1304 }
1305
1306 if ((string) $loginData['uident'] === (string) md5($user[$this->username_column] . ':' . $user[$this->userident_column] . ':' . $loginData['chalvalue'])) {
1307 $OK = TRUE;
1308 }
1309 break;
1310 default: // normal
1311 if ((string) $loginData['uident'] === (string) $user[$this->userident_column]) {
1312 $OK = TRUE;
1313 }
1314 break;
1315 }
1316
1317 return $OK;
1318 }
1319
1320 /**
1321 * Garbage collector, removing old expired sessions.
1322 *
1323 * @return void
1324 * @internal
1325 */
1326 function gc() {
1327 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
1328 $this->session_table,
1329 'ses_tstamp < ' . intval($GLOBALS['EXEC_TIME'] - ($this->gc_time)) .
1330 ' AND ses_name = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
1331 );
1332 }
1333
1334 /**
1335 * DUMMY: Writes to log database table (in some extension classes)
1336 *
1337 * @param integer $type: denotes which module that has submitted the entry. This is the current list: 1=tce_db; 2=tce_file; 3=system (eg. sys_history save); 4=modules; 254=Personal settings changed; 255=login / out action: 1=login, 2=logout, 3=failed login (+ errorcode 3), 4=failure_warning_email sent
1338 * @param integer $action: denotes which specific operation that wrote the entry (eg. 'delete', 'upload', 'update' and so on...). Specific for each $type. Also used to trigger update of the interface. (see the log-module for the meaning of each number !!)
1339 * @param integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1340 * @param integer $details_nr: The message number. Specific for each $type and $action. in the future this will make it possible to translate errormessages to other languages
1341 * @param string $details: Default text that follows the message
1342 * @param array $data: Data that follows the log. Might be used to carry special information. If an array the first 5 entries (0-4) will be sprintf'ed the details-text...
1343 * @param string $tablename: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
1344 * @param integer $recuid: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
1345 * @param integer $recpid: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
1346 * @return void
1347 * @see t3lib_userauthgroup::writelog()
1348 */
1349 function writelog($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid) {
1350 }
1351
1352 /**
1353 * DUMMY: Check login failures (in some extension classes)
1354 *
1355 * @return void
1356 * @ignore
1357 */
1358 function checkLogFailures() {
1359 }
1360
1361 /**
1362 * Raw initialization of the be_user with uid=$uid
1363 * This will circumvent all login procedures and select a be_users record from the database and set the content of ->user to the record selected. Thus the BE_USER object will appear like if a user was authenticated - however without a session id and the fields from the session table of course.
1364 * Will check the users for disabled, start/endtime, etc. ($this->user_where_clause())
1365 *
1366 * @param integer The UID of the backend user to set in ->user
1367 * @return void
1368 * @internal
1369 * @see SC_mod_tools_be_user_index::compareUsers(), SC_mod_user_setup_index::simulateUser(), freesite_admin::startCreate()
1370 */
1371 function setBeUserByUid($uid) {
1372 $this->user = $this->getRawUserByUid($uid);
1373 }
1374
1375 /**
1376 * Raw initialization of the be_user with username=$name
1377 *
1378 * @param string The username to look up.
1379 * @return void
1380 * @see t3lib_userAuth::setBeUserByUid()
1381 * @internal
1382 */
1383 function setBeUserByName($name) {
1384 $this->user = $this->getRawUserByName($name);
1385 }
1386
1387 /**
1388 * Fetching raw user record with uid=$uid
1389 *
1390 * @param integer The UID of the backend user to set in ->user
1391 * @return array user record or FALSE
1392 * @internal
1393 */
1394 function getRawUserByUid($uid) {
1395 $user = FALSE;
1396 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->user_table, 'uid=' . intval($uid) . ' ' . $this->user_where_clause());
1397 if ($dbres) {
1398 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1399 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1400 }
1401 return $user;
1402 }
1403
1404 /**
1405 * Fetching raw user record with username=$name
1406 *
1407 * @param string The username to look up.
1408 * @return array user record or FALSE
1409 * @see t3lib_userAuth::getUserByUid()
1410 * @internal
1411 */
1412 function getRawUserByName($name) {
1413 $user = FALSE;
1414 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->user_table, 'username=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($name, $this->user_table) . ' ' . $this->user_where_clause());
1415 if ($dbres) {
1416 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1417 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1418 }
1419 return $user;
1420 }
1421
1422
1423 /*************************
1424 *
1425 * Create/update user - EXPERIMENTAL
1426 *
1427 *************************/
1428
1429 /**
1430 * Get a user from DB by username
1431 * provided for usage from services
1432 *
1433 * @param array User db table definition: $this->db_user
1434 * @param string user name
1435 * @param string additional WHERE clause: " AND ...
1436 * @return mixed user array or FALSE
1437 */
1438 function fetchUserRecord($dbUser, $username, $extraWhere = '') {
1439 $user = FALSE;
1440
1441 $usernameClause = $username ? ($dbUser['username_column'] . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($username, $dbUser['table'])) : '';
1442
1443 if ($username || $extraWhere) {
1444
1445 // Look up the user by the username and/or extraWhere:
1446 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1447 '*',
1448 $dbUser['table'],
1449 $usernameClause .
1450 $dbUser['check_pid_clause'] .
1451 $dbUser['enable_clause'] .
1452 $extraWhere
1453 );
1454
1455 if ($dbres) {
1456 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1457 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1458 }
1459 }
1460 return $user;
1461 }
1462 }
1463
1464
1465 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauth.php'])) {
1466 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauth.php']);
1467 }
1468
1469 ?>