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