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