[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 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 FrontenUserAuthentication
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 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'])) {
434 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'] as $funcName) {
435 $_params = [
436 'pObj' => $this,
437 ];
438 GeneralUtility::callUserFunction($funcName, $_params, $this);
439 }
440 }
441 // Set $this->gc_time if not explicitly specified
442 if ($this->gc_time === 0) {
443 // Default to 86400 seconds (1 day) if $this->sessionTimeout is 0
444 $this->gc_time = $this->sessionTimeout === 0 ? 86400 : $this->sessionTimeout;
445 }
446 // If we're lucky we'll get to clean up old sessions
447 if (rand() % 100 <= $this->gc_probability) {
448 $this->gc();
449 }
450 }
451
452 /**
453 * Sets the session cookie for the current disposal.
454 *
455 * @throws Exception
456 */
457 protected function setSessionCookie()
458 {
459 $isSetSessionCookie = $this->isSetSessionCookie();
460 $isRefreshTimeBasedCookie = $this->isRefreshTimeBasedCookie();
461 if ($isSetSessionCookie || $isRefreshTimeBasedCookie) {
462 $settings = $GLOBALS['TYPO3_CONF_VARS']['SYS'];
463 // Get the domain to be used for the cookie (if any):
464 $cookieDomain = $this->getCookieDomain();
465 // If no cookie domain is set, use the base path:
466 $cookiePath = $cookieDomain ? '/' : GeneralUtility::getIndpEnv('TYPO3_SITE_PATH');
467 // If the cookie lifetime is set, use it:
468 $cookieExpire = $isRefreshTimeBasedCookie ? $GLOBALS['EXEC_TIME'] + $this->lifetime : 0;
469 // Use the secure option when the current request is served by a secure connection:
470 $cookieSecure = (bool)$settings['cookieSecure'] && GeneralUtility::getIndpEnv('TYPO3_SSL');
471 // Do not set cookie if cookieSecure is set to "1" (force HTTPS) and no secure channel is used:
472 if ((int)$settings['cookieSecure'] !== 1 || GeneralUtility::getIndpEnv('TYPO3_SSL')) {
473 setcookie($this->name, $this->id, $cookieExpire, $cookiePath, $cookieDomain, $cookieSecure, true);
474 $this->cookieWasSetOnCurrentRequest = true;
475 } else {
476 throw new Exception('Cookie was not set since HTTPS was forced in $TYPO3_CONF_VARS[SYS][cookieSecure].', 1254325546);
477 }
478 $this->logger->debug(
479 ($isRefreshTimeBasedCookie ? 'Updated Cookie: ' : 'Set Cookie: ')
480 . $this->id . ($cookieDomain ? ', ' . $cookieDomain : '')
481 );
482 }
483 }
484
485 /**
486 * Gets the domain to be used on setting cookies.
487 * The information is taken from the value in $GLOBALS['TYPO3_CONF_VARS']['SYS']['cookieDomain'].
488 *
489 * @return string The domain to be used on setting cookies
490 */
491 protected function getCookieDomain()
492 {
493 $result = '';
494 $cookieDomain = $GLOBALS['TYPO3_CONF_VARS']['SYS']['cookieDomain'];
495 // If a specific cookie domain is defined for a given TYPO3_MODE,
496 // use that domain
497 if (!empty($GLOBALS['TYPO3_CONF_VARS'][$this->loginType]['cookieDomain'])) {
498 $cookieDomain = $GLOBALS['TYPO3_CONF_VARS'][$this->loginType]['cookieDomain'];
499 }
500 if ($cookieDomain) {
501 if ($cookieDomain[0] === '/') {
502 $match = [];
503 $matchCnt = @preg_match($cookieDomain, GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY'), $match);
504 if ($matchCnt === false) {
505 $this->logger->critical('The regular expression for the cookie domain (' . $cookieDomain . ') contains errors. The session is not shared across sub-domains.');
506 } elseif ($matchCnt) {
507 $result = $match[0];
508 }
509 } else {
510 $result = $cookieDomain;
511 }
512 }
513 return $result;
514 }
515
516 /**
517 * Get the value of a specified cookie.
518 *
519 * @param string $cookieName The cookie ID
520 * @return string The value stored in the cookie
521 */
522 protected function getCookie($cookieName)
523 {
524 return isset($_COOKIE[$cookieName]) ? stripslashes($_COOKIE[$cookieName]) : '';
525 }
526
527 /**
528 * Determine whether a session cookie needs to be set (lifetime=0)
529 *
530 * @return bool
531 * @internal
532 */
533 public function isSetSessionCookie()
534 {
535 return ($this->newSessionID || $this->forceSetCookie) && $this->lifetime == 0;
536 }
537
538 /**
539 * Determine whether a non-session cookie needs to be set (lifetime>0)
540 *
541 * @return bool
542 * @internal
543 */
544 public function isRefreshTimeBasedCookie()
545 {
546 return $this->lifetime > 0;
547 }
548
549 /**
550 * Checks if a submission of username and password is present or use other authentication by auth services
551 *
552 * @throws \RuntimeException
553 * @internal
554 */
555 public function checkAuthentication()
556 {
557 // No user for now - will be searched by service below
558 $tempuserArr = [];
559 $tempuser = false;
560 // User is not authenticated by default
561 $authenticated = false;
562 // User want to login with passed login data (name/password)
563 $activeLogin = false;
564 // Indicates if an active authentication failed (not auto login)
565 $this->loginFailure = false;
566 $this->logger->debug('Login type: ' . $this->loginType);
567 // The info array provide additional information for auth services
568 $authInfo = $this->getAuthInfoArray();
569 // Get Login/Logout data submitted by a form or params
570 $loginData = $this->getLoginFormData();
571 $this->logger->debug('Login data', $loginData);
572 // Active logout (eg. with "logout" button)
573 if ($loginData['status'] === 'logout') {
574 if ($this->writeStdLog) {
575 // $type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid
576 $this->writelog(255, 2, 0, 2, 'User %s logged out', [$this->user['username']], '', 0, 0);
577 }
578 $this->logger->info('User logged out. Id: ' . $this->id);
579 $this->logoff();
580 }
581 // Determine whether we need to skip session update.
582 // This is used mainly for checking session timeout in advance without refreshing the current session's timeout.
583 $skipSessionUpdate = (bool)GeneralUtility::_GP('skipSessionUpdate');
584 $haveSession = false;
585 $anonymousSession = false;
586 if (!$this->newSessionID) {
587 // Read user session
588 $authInfo['userSession'] = $this->fetchUserSession($skipSessionUpdate);
589 $haveSession = is_array($authInfo['userSession']);
590 if ($haveSession && !empty($authInfo['userSession']['ses_anonymous'])) {
591 $anonymousSession = true;
592 }
593 }
594
595 // Active login (eg. with login form).
596 if (!$haveSession && $loginData['status'] === 'login') {
597 $activeLogin = true;
598 $this->logger->debug('Active login (eg. with login form)');
599 // check referrer for submitted login values
600 if ($this->formfield_status && $loginData['uident'] && $loginData['uname']) {
601 $httpHost = GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY');
602 if (!$this->getMethodEnabled && ($httpHost != $authInfo['refInfo']['host'] && !$GLOBALS['TYPO3_CONF_VARS']['SYS']['doNotCheckReferer'])) {
603 throw new \RuntimeException('TYPO3 Fatal Error: Error: This host address ("' . $httpHost . '") and the referer host ("' . $authInfo['refInfo']['host'] . '") mismatches! ' .
604 'It is possible that the environment variable HTTP_REFERER is not passed to the script because of a proxy. ' .
605 'The site administrator can disable this check in the "All Configuration" section of the Install Tool (flag: TYPO3_CONF_VARS[SYS][doNotCheckReferer]).', 1270853930);
606 }
607 // Delete old user session if any
608 $this->logoff();
609 }
610 // Refuse login for _CLI users, if not processing a CLI request type
611 // (although we shouldn't be here in case of a CLI request type)
612 if (strtoupper(substr($loginData['uname'], 0, 5)) === '_CLI_' && !(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI)) {
613 throw new \RuntimeException('TYPO3 Fatal Error: You have tried to login using a CLI user. Access prohibited!', 1270853931);
614 }
615 }
616
617 // Cause elevation of privilege, make sure regenerateSessionId is called later on
618 if ($anonymousSession && $loginData['status'] === 'login') {
619 $activeLogin = true;
620 }
621
622 if ($haveSession) {
623 $this->logger->debug('User session found', [
624 $this->userid_column => $authInfo['userSession'][$this->userid_column],
625 $this->username_column => $authInfo['userSession'][$this->username_column],
626 ]);
627 } else {
628 $this->logger->debug('No user session found');
629 }
630 if (is_array($this->svConfig['setup'] ?? false)) {
631 $this->logger->debug('SV setup', $this->svConfig['setup']);
632 }
633
634 // Fetch user if ...
635 if (
636 $activeLogin || !empty($this->svConfig['setup'][$this->loginType . '_alwaysFetchUser'])
637 || !$haveSession && !empty($this->svConfig['setup'][$this->loginType . '_fetchUserIfNoSession'])
638 ) {
639 // Use 'auth' service to find the user
640 // First found user will be used
641 $subType = 'getUser' . $this->loginType;
642 foreach ($this->getAuthServices($subType, $loginData, $authInfo) as $serviceObj) {
643 if ($row = $serviceObj->getUser()) {
644 $tempuserArr[] = $row;
645 $this->logger->debug('User found', [
646 $this->userid_column => $row[$this->userid_column],
647 $this->username_column => $row[$this->username_column],
648 ]);
649 // User found, just stop to search for more if not configured to go on
650 if (!$this->svConfig['setup'][$this->loginType . '_fetchAllUsers']) {
651 break;
652 }
653 }
654 }
655
656 if ($this->svConfig['setup'][$this->loginType . '_alwaysFetchUser']) {
657 $this->logger->debug($this->loginType . '_alwaysFetchUser option is enabled');
658 }
659 if (empty($tempuserArr)) {
660 $this->logger->debug('No user found by services');
661 } else {
662 $this->logger->debug(count($tempuserArr) . ' user records found by services');
663 }
664 }
665
666 // If no new user was set we use the already found user session
667 if (empty($tempuserArr) && $haveSession && !$anonymousSession) {
668 $tempuserArr[] = $authInfo['userSession'];
669 $tempuser = $authInfo['userSession'];
670 // User is authenticated because we found a user session
671 $authenticated = true;
672 $this->logger->debug('User session used', [
673 $this->userid_column => $authInfo['userSession'][$this->userid_column],
674 $this->username_column => $authInfo['userSession'][$this->username_column],
675 ]);
676 }
677 // Re-auth user when 'auth'-service option is set
678 if (!empty($this->svConfig['setup'][$this->loginType . '_alwaysAuthUser'])) {
679 $authenticated = false;
680 $this->logger->debug('alwaysAuthUser option is enabled');
681 }
682 // Authenticate the user if needed
683 if (!empty($tempuserArr) && !$authenticated) {
684 foreach ($tempuserArr as $tempuser) {
685 // Use 'auth' service to authenticate the user
686 // If one service returns FALSE then authentication failed
687 // a service might return 100 which means there's no reason to stop but the user can't be authenticated by that service
688 $this->logger->debug('Auth user', $tempuser);
689 $subType = 'authUser' . $this->loginType;
690
691 foreach ($this->getAuthServices($subType, $loginData, $authInfo) as $serviceObj) {
692 if (($ret = $serviceObj->authUser($tempuser)) > 0) {
693 // If the service returns >=200 then no more checking is needed - useful for IP checking without password
694 if ((int)$ret >= 200) {
695 $authenticated = true;
696 break;
697 }
698 if ((int)$ret >= 100) {
699 } else {
700 $authenticated = true;
701 }
702 } else {
703 $authenticated = false;
704 break;
705 }
706 }
707
708 if ($authenticated) {
709 // Leave foreach() because a user is authenticated
710 break;
711 }
712 }
713 }
714
715 // If user is authenticated a valid user is in $tempuser
716 if ($authenticated) {
717 // Reset failure flag
718 $this->loginFailure = false;
719 // Insert session record if needed:
720 if (!$haveSession || $anonymousSession || $tempuser['ses_id'] != $this->id && $tempuser['uid'] != $authInfo['userSession']['ses_userid']) {
721 $sessionData = $this->createUserSession($tempuser);
722
723 // Preserve session data on login
724 if ($anonymousSession) {
725 $sessionData = $this->getSessionBackend()->update(
726 $this->id,
727 ['ses_data' => $authInfo['userSession']['ses_data']]
728 );
729 }
730
731 $this->user = array_merge(
732 $tempuser,
733 $sessionData
734 );
735 // The login session is started.
736 $this->loginSessionStarted = true;
737 if (is_array($this->user)) {
738 $this->logger->debug('User session finally read', [
739 $this->userid_column => $this->user[$this->userid_column],
740 $this->username_column => $this->user[$this->username_column],
741 ]);
742 }
743 } elseif ($haveSession) {
744 // if we come here the current session is for sure not anonymous as this is a pre-condition for $authenticated = true
745 $this->user = $authInfo['userSession'];
746 }
747
748 if ($activeLogin && !$this->newSessionID) {
749 $this->regenerateSessionId();
750 }
751
752 // User logged in - write that to the log!
753 if ($this->writeStdLog && $activeLogin) {
754 $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')], '', '', '');
755 }
756 if ($activeLogin) {
757 $this->logger->info('User ' . $tempuser[$this->username_column] . ' logged in from ' . GeneralUtility::getIndpEnv('REMOTE_ADDR') . ' (' . GeneralUtility::getIndpEnv('REMOTE_HOST') . ')');
758 }
759 if (!$activeLogin) {
760 $this->logger->debug('User ' . $tempuser[$this->username_column] . ' authenticated from ' . GeneralUtility::getIndpEnv('REMOTE_ADDR') . ' (' . GeneralUtility::getIndpEnv('REMOTE_HOST') . ')');
761 }
762 } else {
763 // User was not authenticated, so we should reuse the existing anonymous session
764 if ($anonymousSession) {
765 $this->user = $authInfo['userSession'];
766 }
767
768 // Mark the current login attempt as failed
769 if ($activeLogin || !empty($tempuserArr)) {
770 $this->loginFailure = true;
771 if (empty($tempuserArr) && $activeLogin) {
772 $logData = [
773 'loginData' => $loginData
774 ];
775 $this->logger->warning('Login failed', $logData);
776 }
777 if (!empty($tempuserArr)) {
778 $logData = [
779 $this->userid_column => $tempuser[$this->userid_column],
780 $this->username_column => $tempuser[$this->username_column],
781 ];
782 $this->logger->warning('Login failed', $logData);
783 }
784 }
785 }
786
787 // If there were a login failure, check to see if a warning email should be sent:
788 if ($this->loginFailure && $activeLogin) {
789 $this->logger->debug(
790 'Call checkLogFailures',
791 [
792 'warningEmail' => $this->warningEmail,
793 'warningPeriod' => $this->warningPeriod,
794 'warningMax' => $this->warningMax
795 ]
796 );
797
798 // Hook to implement login failure tracking methods
799 if (
800 !empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postLoginFailureProcessing'])
801 && is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postLoginFailureProcessing'])
802 ) {
803 $_params = [];
804 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postLoginFailureProcessing'] as $_funcRef) {
805 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
806 }
807 } else {
808 // If no hook is implemented, wait for 5 seconds
809 sleep(5);
810 }
811
812 $this->checkLogFailures($this->warningEmail, $this->warningPeriod, $this->warningMax);
813 }
814 }
815
816 /**
817 * Creates a new session ID.
818 *
819 * @return string The new session ID
820 */
821 public function createSessionId()
822 {
823 return GeneralUtility::makeInstance(Random::class)->generateRandomHexString($this->hash_length);
824 }
825
826 /**
827 * Initializes authentication services to be used in a foreach loop
828 *
829 * @param string $subType e.g. getUserFE
830 * @param array $loginData
831 * @param array $authInfo
832 * @return \Traversable A generator of service objects
833 */
834 protected function getAuthServices(string $subType, array $loginData, array $authInfo): \Traversable
835 {
836 $serviceChain = '';
837 while (is_object($serviceObj = GeneralUtility::makeInstanceService('auth', $subType, $serviceChain))) {
838 $serviceChain .= ',' . $serviceObj->getServiceKey();
839 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
840 yield $serviceObj;
841 }
842 if ($serviceChain) {
843 $this->logger->debug($subType . ' auth services called: ' . $serviceChain);
844 }
845 }
846
847 /**
848 * Regenerate the session ID and transfer the session to new ID
849 * Call this method whenever a user proceeds to a higher authorization level
850 * e.g. when an anonymous session is now authenticated.
851 *
852 * @param array $existingSessionRecord If given, this session record will be used instead of fetching again
853 * @param bool $anonymous If true session will be regenerated as anonymous session
854 */
855 protected function regenerateSessionId(array $existingSessionRecord = [], bool $anonymous = false)
856 {
857 if (empty($existingSessionRecord)) {
858 $existingSessionRecord = $this->getSessionBackend()->get($this->id);
859 }
860
861 // Update session record with new ID
862 $oldSessionId = $this->id;
863 $this->id = $this->createSessionId();
864 $updatedSession = $this->getSessionBackend()->set($this->id, $existingSessionRecord);
865 $this->sessionData = unserialize($updatedSession['ses_data']);
866 // Merge new session data into user/session array
867 $this->user = array_merge($this->user ?? [], $updatedSession);
868 $this->getSessionBackend()->remove($oldSessionId);
869 $this->newSessionID = true;
870 }
871
872 /*************************
873 *
874 * User Sessions
875 *
876 *************************/
877
878 /**
879 * Creates a user session record and returns its values.
880 *
881 * @param array $tempuser User data array
882 *
883 * @return array The session data for the newly created session.
884 */
885 public function createUserSession($tempuser)
886 {
887 $this->logger->debug('Create session ses_id = ' . $this->id);
888 // Delete any session entry first
889 $this->getSessionBackend()->remove($this->id);
890 // Re-create session entry
891 $sessionRecord = $this->getNewSessionRecord($tempuser);
892 $sessionRecord = $this->getSessionBackend()->set($this->id, $sessionRecord);
893 // Updating lastLogin_column carrying information about last login.
894 $this->updateLoginTimestamp($tempuser[$this->userid_column]);
895 return $sessionRecord;
896 }
897
898 /**
899 * Updates the last login column in the user with the given id
900 *
901 * @param int $userId
902 */
903 protected function updateLoginTimestamp(int $userId)
904 {
905 if ($this->lastLogin_column) {
906 $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->user_table);
907 $connection->update(
908 $this->user_table,
909 [$this->lastLogin_column => $GLOBALS['EXEC_TIME']],
910 [$this->userid_column => $userId]
911 );
912 }
913 }
914
915 /**
916 * Returns a new session record for the current user for insertion into the DB.
917 * This function is mainly there as a wrapper for inheriting classes to override it.
918 *
919 * @param array $tempuser
920 * @return array User session record
921 */
922 public function getNewSessionRecord($tempuser)
923 {
924 $sessionIpLock = '[DISABLED]';
925 if ($this->lockIP && empty($tempuser['disableIPlock'])) {
926 $sessionIpLock = $this->ipLockClause_remoteIPNumber($this->lockIP);
927 }
928
929 return [
930 'ses_id' => $this->id,
931 'ses_iplock' => $sessionIpLock,
932 'ses_userid' => $tempuser[$this->userid_column] ?? 0,
933 'ses_tstamp' => $GLOBALS['EXEC_TIME'],
934 'ses_data' => '',
935 ];
936 }
937
938 /**
939 * Read the user session from db.
940 *
941 * @param bool $skipSessionUpdate
942 * @return array|bool User session data, false if $this->id does not represent valid session
943 */
944 public function fetchUserSession($skipSessionUpdate = false)
945 {
946 $this->logger->debug('Fetch session ses_id = ' . $this->id);
947 try {
948 $sessionRecord = $this->getSessionBackend()->get($this->id);
949 } catch (SessionNotFoundException $e) {
950 return false;
951 }
952
953 $this->sessionData = unserialize($sessionRecord['ses_data']);
954 // Session is anonymous so no need to fetch user
955 if (!empty($sessionRecord['ses_anonymous'])) {
956 return $sessionRecord;
957 }
958
959 // Fetch the user from the DB
960 $userRecord = $this->getRawUserByUid((int)$sessionRecord['ses_userid']);
961 if ($userRecord) {
962 $userRecord = array_merge($sessionRecord, $userRecord);
963 // A user was found
964 $userRecord['ses_tstamp'] = (int)$userRecord['ses_tstamp'];
965 $userRecord['is_online'] = (int)$userRecord['ses_tstamp'];
966
967 if (!empty($this->auth_timeout_field)) {
968 // Get timeout-time from usertable
969 $timeout = (int)$userRecord[$this->auth_timeout_field];
970 } else {
971 $timeout = $this->sessionTimeout;
972 }
973 // If timeout > 0 (TRUE) and current time has not exceeded the latest sessions-time plus the timeout in seconds then accept user
974 // Use a gracetime-value to avoid updating a session-record too often
975 if ($timeout > 0 && $GLOBALS['EXEC_TIME'] < $userRecord['ses_tstamp'] + $timeout) {
976 $sessionUpdateGracePeriod = 61;
977 if (!$skipSessionUpdate && $GLOBALS['EXEC_TIME'] > ($userRecord['ses_tstamp'] + $sessionUpdateGracePeriod)) {
978 // Update the session timestamp by writing a dummy update. (Backend will update the timestamp)
979 $updatesSession = $this->getSessionBackend()->update($this->id, []);
980 $userRecord = array_merge($userRecord, $updatesSession);
981 }
982 } else {
983 // Delete any user set...
984 $this->logoff();
985 $userRecord = false;
986 }
987 }
988 return $userRecord;
989 }
990
991 /**
992 * Log out current user!
993 * Removes the current session record, sets the internal ->user array to a blank string;
994 * Thereby the current user (if any) is effectively logged out!
995 */
996 public function logoff()
997 {
998 $this->logger->debug('logoff: ses_id = ' . $this->id);
999 // Release the locked records
1000 BackendUtility::lockRecords();
1001 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'])) {
1002 $_params = [];
1003 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'] as $_funcRef) {
1004 if ($_funcRef) {
1005 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1006 }
1007 }
1008 }
1009 $this->performLogoff();
1010 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'])) {
1011 $_params = [];
1012 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'] as $_funcRef) {
1013 if ($_funcRef) {
1014 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1015 }
1016 }
1017 }
1018 }
1019
1020 /**
1021 * Perform the logoff action. Called from logoff() as a way to allow subclasses to override
1022 * what happens when a user logs off, without needing to reproduce the hook calls and logging
1023 * that happens in the public logoff() API method.
1024 */
1025 protected function performLogoff()
1026 {
1027 if ($this->id) {
1028 $this->getSessionBackend()->remove($this->id);
1029 }
1030 $this->user = null;
1031 }
1032
1033 /**
1034 * Empty / unset the cookie
1035 *
1036 * @param string $cookieName usually, this is $this->name
1037 */
1038 public function removeCookie($cookieName)
1039 {
1040 $cookieDomain = $this->getCookieDomain();
1041 // If no cookie domain is set, use the base path
1042 $cookiePath = $cookieDomain ? '/' : GeneralUtility::getIndpEnv('TYPO3_SITE_PATH');
1043 setcookie($cookieName, null, -1, $cookiePath, $cookieDomain);
1044 }
1045
1046 /**
1047 * Determine whether there's an according session record to a given session_id.
1048 * Don't care if session record is still valid or not.
1049 *
1050 * @param string $id Claimed Session ID
1051 * @return bool Returns TRUE if a corresponding session was found in the database
1052 */
1053 public function isExistingSessionRecord($id)
1054 {
1055 try {
1056 $sessionRecord = $this->getSessionBackend()->get($id);
1057 if (empty($sessionRecord)) {
1058 return false;
1059 }
1060 // If the session does not match the current IP lock, it should be treated as invalid
1061 // and a new session should be created.
1062 if ($sessionRecord['ses_iplock'] !== $this->ipLockClause_remoteIPNumber($this->lockIP) && $sessionRecord['ses_iplock'] !== '[DISABLED]') {
1063 return false;
1064 }
1065 return true;
1066 } catch (SessionNotFoundException $e) {
1067 return false;
1068 }
1069 }
1070
1071 /**
1072 * Returns whether this request is going to set a cookie
1073 * or a cookie was already found in the system
1074 *
1075 * @return bool Returns TRUE if a cookie is set
1076 */
1077 public function isCookieSet()
1078 {
1079 return $this->cookieWasSetOnCurrentRequest || $this->getCookie($this->name);
1080 }
1081
1082 /*************************
1083 *
1084 * SQL Functions
1085 *
1086 *************************/
1087 /**
1088 * This returns the restrictions needed to select the user respecting
1089 * enable columns and flags like deleted, hidden, starttime, endtime
1090 * and rootLevel
1091 *
1092 * @return QueryRestrictionContainerInterface
1093 * @internal
1094 */
1095 protected function userConstraints(): QueryRestrictionContainerInterface
1096 {
1097 $restrictionContainer = GeneralUtility::makeInstance(DefaultRestrictionContainer::class);
1098
1099 if (empty($this->enablecolumns['disabled'])) {
1100 $restrictionContainer->removeByType(HiddenRestriction::class);
1101 }
1102
1103 if (empty($this->enablecolumns['deleted'])) {
1104 $restrictionContainer->removeByType(DeletedRestriction::class);
1105 }
1106
1107 if (empty($this->enablecolumns['starttime'])) {
1108 $restrictionContainer->removeByType(StartTimeRestriction::class);
1109 }
1110
1111 if (empty($this->enablecolumns['endtime'])) {
1112 $restrictionContainer->removeByType(EndTimeRestriction::class);
1113 }
1114
1115 if (!empty($this->enablecolumns['rootLevel'])) {
1116 $restrictionContainer->add(GeneralUtility::makeInstance(RootLevelRestriction::class, [$this->user_table]));
1117 }
1118
1119 return $restrictionContainer;
1120 }
1121
1122 /**
1123 * Returns the IP address to lock to.
1124 * The IP address may be partial based on $parts.
1125 *
1126 * @param int $parts 1-4: Indicates how many parts of the IP address to return. 4 means all, 1 means only first number.
1127 * @return string (Partial) IP address for REMOTE_ADDR
1128 */
1129 protected function ipLockClause_remoteIPNumber($parts)
1130 {
1131 $IP = GeneralUtility::getIndpEnv('REMOTE_ADDR');
1132 if ($parts >= 4) {
1133 return $IP;
1134 }
1135 $parts = MathUtility::forceIntegerInRange($parts, 1, 3);
1136 $IPparts = explode('.', $IP);
1137 for ($a = 4; $a > $parts; $a--) {
1138 unset($IPparts[$a - 1]);
1139 }
1140 return implode('.', $IPparts);
1141 }
1142
1143 /*************************
1144 *
1145 * Session and Configuration Handling
1146 *
1147 *************************/
1148 /**
1149 * This writes $variable to the user-record. This is a way of providing session-data.
1150 * You can fetch the data again through $this->uc in this class!
1151 * If $variable is not an array, $this->uc is saved!
1152 *
1153 * @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
1154 */
1155 public function writeUC($variable = '')
1156 {
1157 if (is_array($this->user) && $this->user[$this->userid_column]) {
1158 if (!is_array($variable)) {
1159 $variable = $this->uc;
1160 }
1161 $this->logger->debug('writeUC: ' . $this->userid_column . '=' . (int)$this->user[$this->userid_column]);
1162 GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->user_table)->update(
1163 $this->user_table,
1164 ['uc' => serialize($variable)],
1165 [$this->userid_column => (int)$this->user[$this->userid_column]],
1166 ['uc' => Connection::PARAM_LOB]
1167 );
1168 }
1169 }
1170
1171 /**
1172 * Sets $theUC as the internal variable ->uc IF $theUC is an array.
1173 * If $theUC is FALSE, the 'uc' content from the ->user array will be unserialized and restored in ->uc
1174 *
1175 * @param mixed $theUC If an array, then set as ->uc, otherwise load from user record
1176 */
1177 public function unpack_uc($theUC = '')
1178 {
1179 if (!$theUC && isset($this->user['uc'])) {
1180 $theUC = unserialize($this->user['uc']);
1181 }
1182 if (is_array($theUC)) {
1183 $this->uc = $theUC;
1184 }
1185 }
1186
1187 /**
1188 * Stores data for a module.
1189 * The data is stored with the session id so you can even check upon retrieval
1190 * if the module data is from a previous session or from the current session.
1191 *
1192 * @param string $module Is the name of the module ($MCONF['name'])
1193 * @param mixed $data Is the data you want to store for that module (array, string, ...)
1194 * @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.
1195 */
1196 public function pushModuleData($module, $data, $noSave = 0)
1197 {
1198 $this->uc['moduleData'][$module] = $data;
1199 $this->uc['moduleSessionID'][$module] = $this->id;
1200 if (!$noSave) {
1201 $this->writeUC();
1202 }
1203 }
1204
1205 /**
1206 * Gets module data for a module (from a loaded ->uc array)
1207 *
1208 * @param string $module Is the name of the module ($MCONF['name'])
1209 * @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).
1210 * @return mixed The module data if available: $this->uc['moduleData'][$module];
1211 */
1212 public function getModuleData($module, $type = '')
1213 {
1214 if ($type !== 'ses' || (isset($this->uc['moduleSessionID'][$module]) && $this->uc['moduleSessionID'][$module] == $this->id)) {
1215 return $this->uc['moduleData'][$module];
1216 }
1217 return null;
1218 }
1219
1220 /**
1221 * Returns the session data stored for $key.
1222 * The data will last only for this login session since it is stored in the user session.
1223 *
1224 * @param string $key The key associated with the session data
1225 * @return mixed
1226 */
1227 public function getSessionData($key)
1228 {
1229 return $this->sessionData[$key] ?? null;
1230 }
1231
1232 /**
1233 * Set session data by key.
1234 * The data will last only for this login session since it is stored in the user session.
1235 *
1236 * @param string $key A non empty string to store the data under
1237 * @param mixed $data Data store store in session
1238 */
1239 public function setSessionData($key, $data)
1240 {
1241 if (empty($key)) {
1242 throw new \InvalidArgumentException('Argument key must not be empty', 1484311516);
1243 }
1244 $this->sessionData[$key] = $data;
1245 }
1246
1247 /**
1248 * Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database.
1249 * The data will last only for this login session since it is stored in the session table.
1250 *
1251 * @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.
1252 * @param mixed $data The data to store in index $key
1253 */
1254 public function setAndSaveSessionData($key, $data)
1255 {
1256 $this->sessionData[$key] = $data;
1257 $this->user['ses_data'] = serialize($this->sessionData);
1258 $this->logger->debug('setAndSaveSessionData: ses_id = ' . $this->id);
1259 $updatedSession = $this->getSessionBackend()->update(
1260 $this->id,
1261 ['ses_data' => $this->user['ses_data']]
1262 );
1263 $this->user = array_merge($this->user ?? [], $updatedSession);
1264 }
1265
1266 /*************************
1267 *
1268 * Misc
1269 *
1270 *************************/
1271 /**
1272 * Returns an info array with Login/Logout data submitted by a form or params
1273 *
1274 * @return array
1275 * @internal
1276 */
1277 public function getLoginFormData()
1278 {
1279 $loginData = [];
1280 $loginData['status'] = GeneralUtility::_GP($this->formfield_status);
1281 if ($this->getMethodEnabled) {
1282 $loginData['uname'] = GeneralUtility::_GP($this->formfield_uname);
1283 $loginData['uident'] = GeneralUtility::_GP($this->formfield_uident);
1284 } else {
1285 $loginData['uname'] = GeneralUtility::_POST($this->formfield_uname);
1286 $loginData['uident'] = GeneralUtility::_POST($this->formfield_uident);
1287 }
1288 // Only process the login data if a login is requested
1289 if ($loginData['status'] === 'login') {
1290 $loginData = $this->processLoginData($loginData);
1291 }
1292 $loginData = array_map('trim', $loginData);
1293 return $loginData;
1294 }
1295
1296 /**
1297 * Processes Login data submitted by a form or params depending on the
1298 * passwordTransmissionStrategy
1299 *
1300 * @param array $loginData Login data array
1301 * @param string $passwordTransmissionStrategy Alternative passwordTransmissionStrategy. Used when authentication services wants to override the default.
1302 * @return array
1303 * @internal
1304 */
1305 public function processLoginData($loginData, $passwordTransmissionStrategy = '')
1306 {
1307 $loginSecurityLevel = trim($GLOBALS['TYPO3_CONF_VARS'][$this->loginType]['loginSecurityLevel']) ?: 'normal';
1308 $passwordTransmissionStrategy = $passwordTransmissionStrategy ?: $loginSecurityLevel;
1309 $this->logger->debug('Login data before processing', $loginData);
1310 $serviceChain = '';
1311 $subType = 'processLoginData' . $this->loginType;
1312 $authInfo = $this->getAuthInfoArray();
1313 $isLoginDataProcessed = false;
1314 $processedLoginData = $loginData;
1315 while (is_object($serviceObject = GeneralUtility::makeInstanceService('auth', $subType, $serviceChain))) {
1316 $serviceChain .= ',' . $serviceObject->getServiceKey();
1317 $serviceObject->initAuth($subType, $loginData, $authInfo, $this);
1318 $serviceResult = $serviceObject->processLoginData($processedLoginData, $passwordTransmissionStrategy);
1319 if (!empty($serviceResult)) {
1320 $isLoginDataProcessed = true;
1321 // If the service returns >=200 then no more processing is needed
1322 if ((int)$serviceResult >= 200) {
1323 unset($serviceObject);
1324 break;
1325 }
1326 }
1327 unset($serviceObject);
1328 }
1329 if ($isLoginDataProcessed) {
1330 $loginData = $processedLoginData;
1331 $this->logger->debug('Processed login data', $processedLoginData);
1332 }
1333 return $loginData;
1334 }
1335
1336 /**
1337 * Returns an info array which provides additional information for auth services
1338 *
1339 * @return array
1340 * @internal
1341 */
1342 public function getAuthInfoArray()
1343 {
1344 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->user_table);
1345 $expressionBuilder = $queryBuilder->expr();
1346 $authInfo = [];
1347 $authInfo['loginType'] = $this->loginType;
1348 $authInfo['refInfo'] = parse_url(GeneralUtility::getIndpEnv('HTTP_REFERER'));
1349 $authInfo['HTTP_HOST'] = GeneralUtility::getIndpEnv('HTTP_HOST');
1350 $authInfo['REMOTE_ADDR'] = GeneralUtility::getIndpEnv('REMOTE_ADDR');
1351 $authInfo['REMOTE_HOST'] = GeneralUtility::getIndpEnv('REMOTE_HOST');
1352 $authInfo['showHiddenRecords'] = $this->showHiddenRecords;
1353 // Can be overidden in localconf by SVCONF:
1354 $authInfo['db_user']['table'] = $this->user_table;
1355 $authInfo['db_user']['userid_column'] = $this->userid_column;
1356 $authInfo['db_user']['username_column'] = $this->username_column;
1357 $authInfo['db_user']['userident_column'] = $this->userident_column;
1358 $authInfo['db_user']['usergroup_column'] = $this->usergroup_column;
1359 $authInfo['db_user']['enable_clause'] = $this->userConstraints()->buildExpression(
1360 [$this->user_table => $this->user_table],
1361 $expressionBuilder
1362 );
1363 if ($this->checkPid && $this->checkPid_value !== null) {
1364 $authInfo['db_user']['checkPidList'] = $this->checkPid_value;
1365 $authInfo['db_user']['check_pid_clause'] = $expressionBuilder->in(
1366 'pid',
1367 GeneralUtility::intExplode(',', $this->checkPid_value)
1368 );
1369 } else {
1370 $authInfo['db_user']['checkPidList'] = '';
1371 $authInfo['db_user']['check_pid_clause'] = '';
1372 }
1373 $authInfo['db_groups']['table'] = $this->usergroup_table;
1374 return $authInfo;
1375 }
1376
1377 /**
1378 * Check the login data with the user record data for builtin login methods
1379 *
1380 * @param array $user User data array
1381 * @param array $loginData Login data array
1382 * @param string $passwordCompareStrategy Alternative passwordCompareStrategy. Used when authentication services wants to override the default.
1383 * @return bool TRUE if login data matched
1384 */
1385 public function compareUident($user, $loginData, $passwordCompareStrategy = '')
1386 {
1387 return (string)$loginData['uident_text'] !== '' && (string)$loginData['uident_text'] === (string)$user[$this->userident_column];
1388 }
1389
1390 /**
1391 * Garbage collector, removing old expired sessions.
1392 *
1393 * @internal
1394 */
1395 public function gc()
1396 {
1397 $this->getSessionBackend()->collectGarbage($this->gc_time);
1398 }
1399
1400 /**
1401 * DUMMY: Writes to log database table (in some extension classes)
1402 *
1403 * @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
1404 * @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 !!)
1405 * @param int $error flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1406 * @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
1407 * @param string $details Default text that follows the message
1408 * @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...
1409 * @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.)
1410 * @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.)
1411 * @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.)
1412 */
1413 public function writelog($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)
1414 {
1415 }
1416
1417 /**
1418 * DUMMY: Check login failures (in some extension classes)
1419 *
1420 * @param string $email Email address
1421 * @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
1422 * @param int $maxFailures Max allowed failures before a warning mail is sent
1423 * @ignore
1424 */
1425 public function checkLogFailures($email, $secondsBack, $maxFailures)
1426 {
1427 }
1428
1429 /**
1430 * Raw initialization of the be_user with uid=$uid
1431 * This will circumvent all login procedures and select a be_users record from the
1432 * database and set the content of ->user to the record selected.
1433 * Thus the BE_USER object will appear like if a user was authenticated - however without
1434 * a session id and the fields from the session table of course.
1435 * Will check the users for disabled, start/endtime, etc. ($this->user_where_clause())
1436 *
1437 * @param int $uid The UID of the backend user to set in ->user
1438 * @internal
1439 * @see SC_mod_tools_be_user_index::compareUsers(), \TYPO3\CMS\Setup\Controller\SetupModuleController::simulateUser(), freesite_admin::startCreate()
1440 */
1441 public function setBeUserByUid($uid)
1442 {
1443 $this->user = $this->getRawUserByUid($uid);
1444 }
1445
1446 /**
1447 * Raw initialization of the be_user with username=$name
1448 *
1449 * @param string $name The username to look up.
1450 * @see \TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setBeUserByUid()
1451 * @internal
1452 */
1453 public function setBeUserByName($name)
1454 {
1455 $this->user = $this->getRawUserByName($name);
1456 }
1457
1458 /**
1459 * Fetching raw user record with uid=$uid
1460 *
1461 * @param int $uid The UID of the backend user to set in ->user
1462 * @return array user record or FALSE
1463 * @internal
1464 */
1465 public function getRawUserByUid($uid)
1466 {
1467 $query = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->user_table);
1468 $query->setRestrictions($this->userConstraints());
1469 $query->select('*')
1470 ->from($this->user_table)
1471 ->where($query->expr()->eq('uid', $query->createNamedParameter($uid, \PDO::PARAM_INT)));
1472
1473 return $query->execute()->fetch();
1474 }
1475
1476 /**
1477 * Fetching raw user record with username=$name
1478 *
1479 * @param string $name The username to look up.
1480 * @return array user record or FALSE
1481 * @see \TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getUserByUid()
1482 * @internal
1483 */
1484 public function getRawUserByName($name)
1485 {
1486 $query = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->user_table);
1487 $query->setRestrictions($this->userConstraints());
1488 $query->select('*')
1489 ->from($this->user_table)
1490 ->where($query->expr()->eq('username', $query->createNamedParameter($name, \PDO::PARAM_STR)));
1491
1492 return $query->execute()->fetch();
1493 }
1494
1495 /**
1496 * Get a user from DB by username
1497 * provided for usage from services
1498 *
1499 * @param array $dbUser User db table definition: $this->db_user
1500 * @param string $username user name
1501 * @param string $extraWhere Additional WHERE clause: " AND ...
1502 * @return mixed User array or FALSE
1503 */
1504 public function fetchUserRecord($dbUser, $username, $extraWhere = '')
1505 {
1506 $user = false;
1507 if ($username || $extraWhere) {
1508 $query = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($dbUser['table']);
1509 $query->getRestrictions()->removeAll()
1510 ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
1511
1512 $constraints = array_filter([
1513 QueryHelper::stripLogicalOperatorPrefix($dbUser['check_pid_clause']),
1514 QueryHelper::stripLogicalOperatorPrefix($dbUser['enable_clause']),
1515 QueryHelper::stripLogicalOperatorPrefix($extraWhere),
1516 ]);
1517
1518 if (!empty($username)) {
1519 array_unshift(
1520 $constraints,
1521 $query->expr()->eq(
1522 $dbUser['username_column'],
1523 $query->createNamedParameter($username, \PDO::PARAM_STR)
1524 )
1525 );
1526 }
1527
1528 $user = $query->select('*')
1529 ->from($dbUser['table'])
1530 ->where(...$constraints)
1531 ->execute()
1532 ->fetch();
1533 }
1534
1535 return $user;
1536 }
1537
1538 /**
1539 * @internal
1540 * @return string
1541 */
1542 public function getSessionId() : string
1543 {
1544 return $this->id;
1545 }
1546
1547 /**
1548 * @internal
1549 * @return string
1550 */
1551 public function getLoginType() : string
1552 {
1553 return $this->loginType;
1554 }
1555
1556 /**
1557 * Returns initialized session backend. Returns same session backend if called multiple times
1558 *
1559 * @return SessionBackendInterface
1560 */
1561 protected function getSessionBackend()
1562 {
1563 if (!isset($this->sessionBackend)) {
1564 $this->sessionBackend = GeneralUtility::makeInstance(SessionManager::class)->getSessionBackend($this->loginType);
1565 }
1566 return $this->sessionBackend;
1567 }
1568 }