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