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