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