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