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