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