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