2 namespace TYPO3\CMS\Core\Authentication
;
5 * This file is part of the TYPO3 CMS project.
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.
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
14 * The TYPO3 project - inspiring people to share!
17 use TYPO3\CMS\Backend\Utility\BackendUtility
;
18 use TYPO3\CMS\Core\Crypto\Random
;
19 use TYPO3\CMS\Core\Database\Connection
;
20 use TYPO3\CMS\Core\Database\ConnectionPool
;
21 use TYPO3\CMS\Core\Database\Query\QueryHelper
;
22 use TYPO3\CMS\Core\Database\Query\Restriction\DefaultRestrictionContainer
;
23 use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction
;
24 use TYPO3\CMS\Core\Database\Query\Restriction\EndTimeRestriction
;
25 use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction
;
26 use TYPO3\CMS\Core\Database\Query\Restriction\QueryRestrictionContainerInterface
;
27 use TYPO3\CMS\Core\Database\Query\Restriction\RootLevelRestriction
;
28 use TYPO3\CMS\Core\Database\Query\Restriction\StartTimeRestriction
;
29 use TYPO3\CMS\Core\Exception
;
30 use TYPO3\CMS\Core\Session\Backend\Exception\SessionNotFoundException
;
31 use TYPO3\CMS\Core\Session\Backend\SessionBackendInterface
;
32 use TYPO3\CMS\Core\Session\SessionManager
;
33 use TYPO3\CMS\Core\Utility\GeneralUtility
;
34 use TYPO3\CMS\Core\Utility\MathUtility
;
35 use TYPO3\CMS\Sv\AuthenticationService
;
38 * Authentication of users in TYPO3
40 * This class is used to authenticate a login user.
41 * The class is used by both the frontend and backend.
42 * In both cases this class is a parent class to BackendUserAuthentication and FrontenUserAuthentication
44 * See Inside TYPO3 for more information about the API of the class and internal variables.
46 abstract class AbstractUserAuthentication
55 * Session/GET-var name
58 public $get_name = '';
61 * Table in database with user data
64 public $user_table = '';
67 * Table in database with user groups
70 public $usergroup_table = '';
73 * Column for login-name
76 public $username_column = '';
82 public $userident_column = '';
88 public $userid_column = '';
91 * Column for user group information
94 public $usergroup_column = '';
97 * Column name for last login timestamp
100 public $lastLogin_column = '';
103 * Enable field columns of user table
106 public $enablecolumns = [
108 // Boolean: If TRUE, 'AND pid=0' will be a part of the query...
118 public $showHiddenRecords = false;
121 * Form field with login-name
124 public $formfield_uname = '';
127 * Form field with password
130 public $formfield_uident = '';
133 * Form field with status: *'login', 'logout'. If empty login is not verified.
136 public $formfield_status = '';
139 * Session timeout (on the server)
141 * If >0: session-timeout in seconds.
142 * If <=0: Instant logout after login.
146 public $sessionTimeout = 0;
149 * Name for a field to fetch the server session timeout from.
150 * If not empty this is a field name from the user table where the timeout can be found.
153 public $auth_timeout_field = '';
156 * Lifetime for the session-cookie (on the client)
158 * If >0: permanent cookie with given lifetime
159 * If 0: session-cookie
160 * Session-cookie means the browser will remove it when the browser is closed.
164 public $lifetime = 0;
168 * Purge all server session data older than $gc_time seconds.
169 * 0 = default to $this->sessionTimeout or use 86400 seconds (1 day) if $this->sessionTimeout == 0
175 * Probability for garbage collection to be run (in percent)
178 public $gc_probability = 1;
181 * Decides if the writelog() function is called at login and logout
184 public $writeStdLog = false;
187 * Log failed login attempts
190 public $writeAttemptLog = false;
193 * Send no-cache headers
196 public $sendNoCacheHeaders = true;
199 * If this is set, authentication is also accepted by $_GET.
200 * Notice that the identification is NOT 128bit MD5 hash but reduced.
201 * This is done in order to minimize the size for mobile-devices, such as WAP-phones
204 public $getFallBack = false;
207 * The ident-hash is normally 32 characters and should be!
208 * But if you are making sites for WAP-devices or other low-bandwidth stuff,
209 * you may shorten the length.
210 * Never let this value drop below 6!
211 * A length of 6 would give you more than 16 mio possibilities.
214 public $hash_length = 32;
217 * Setting this flag TRUE lets user-authentication happen from GET_VARS if
218 * POST_VARS are not set. Thus you may supply username/password with the URL.
221 public $getMethodEnabled = false;
224 * If set to 4, the session will be locked to the user's IP address (all four numbers).
225 * Reducing this to 1-3 means that only the given number of parts of the IP address is used.
233 public $warningEmail = '';
236 * Time span (in seconds) within the number of failed logins are collected
239 public $warningPeriod = 3600;
242 * The maximum accepted number of warnings before an email to $warningEmail is sent
245 public $warningMax = 3;
248 * If set, the user-record must be stored at the page defined by $checkPid_value
251 public $checkPid = true;
254 * The page id the user record must be stored at
257 public $checkPid_value = 0;
260 * session_id (MD5-hash)
267 * Indicates if an authentication was started but failed
270 public $loginFailure = false;
273 * Will be set to TRUE if the login session is actually written during auth-check.
276 public $loginSessionStarted = false;
279 * @var array|NULL contains user- AND session-data from database (joined tables)
285 * Will be added to the url (eg. '&login=ab7ef8d...')
286 * GET-auth-var if getFallBack is TRUE. Should be inserted in links!
290 public $get_URL_ID = '';
293 * Will be set to TRUE if a new session ID was created
296 public $newSessionID = false;
299 * Will force the session cookie to be set every time (lifetime must be 0)
302 public $forceSetCookie = false;
305 * Will prevent the setting of the session cookie (takes precedence over forceSetCookie)
308 public $dontSetCookie = false;
313 protected $cookieWasSetOnCurrentRequest = false;
316 * Login type, used for services.
319 public $loginType = '';
322 * "auth" services configuration array from $GLOBALS['TYPO3_CONF_VARS']['SVCONF']['auth']
325 public $svConfig = [];
328 * Write messages to the devlog
331 public $writeDevLog = false;
339 * @var SessionBackendInterface
341 protected $sessionBackend;
344 * Holds deserialized data from session records.
345 * 'Reserved' keys are:
346 * - 'recs': (DEPRECATED) Array: Used to 'register' records, eg in a shopping basket. Structure: [recs][tablename][record_uid]=number
347 * - 'sys': Reserved for TypoScript standard code.
350 protected $sessionData = [];
353 * Initialize some important variables
355 public function __construct()
357 // This function has to stay even if it's empty
358 // Implementations of that abstract class might call parent::__construct();
362 * Starts a user session
363 * Typical configurations will:
364 * a) check if session cookie was set and if not, set one,
365 * b) check if a password/username was sent and if so, try to authenticate the user
366 * c) Lookup a session attached to a user and check timeout etc.
367 * d) Garbage collection, setting of no-cache headers.
368 * If a user is authenticated the database record of the user (array) will be set in the ->user internal variable.
373 public function start()
375 // Backend or frontend login - used for auth services
376 if (empty($this->loginType
)) {
377 throw new Exception('No loginType defined, should be set explicitly by subclass', 1476045345);
379 // Enable dev logging if set
380 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog']) {
381 $this->writeDevLog
= true;
383 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog' . $this->loginType
]) {
384 $this->writeDevLog
= true;
387 $this->writeDevLog
= true;
389 if ($this->writeDevLog
) {
390 GeneralUtility
::devLog('## Beginning of auth logging.', self
::class);
394 $this->newSessionID
= false;
395 // $id is set to ses_id if cookie is present. Else set to FALSE, which will start a new session
396 $id = $this->getCookie($this->name
);
397 $this->svConfig
= $GLOBALS['TYPO3_CONF_VARS']['SVCONF']['auth'];
399 // If fallback to get mode....
400 if (!$id && $this->getFallBack
&& $this->get_name
) {
401 $id = isset($_GET[$this->get_name
]) ? GeneralUtility
::_GET($this->get_name
) : '';
402 if (strlen($id) != $this->hash_length
) {
408 // If new session or client tries to fix session...
409 if (!$id ||
!$this->isExistingSessionRecord($id)) {
410 // New random session-$id is made
411 $id = $this->createSessionId();
413 $this->newSessionID
= true;
415 // Internal var 'id' is set
417 // If fallback to get mode....
418 if ($mode === 'get' && $this->getFallBack
&& $this->get_name
) {
419 $this->get_URL_ID
= '&' . $this->get_name
. '=' . $id;
421 // Make certain that NO user is set initially
423 // Set all possible headers that could ensure that the script is not cached on the client-side
424 if ($this->sendNoCacheHeaders
&& !(TYPO3_REQUESTTYPE
& TYPO3_REQUESTTYPE_CLI
)) {
425 header('Expires: 0');
426 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
427 $cacheControlHeader = 'no-cache, must-revalidate';
428 $pragmaHeader = 'no-cache';
429 // Prevent error message in IE when using a https connection
430 // see http://forge.typo3.org/issues/24125
431 $clientInfo = GeneralUtility
::clientInfo();
432 if ($clientInfo['BROWSER'] === 'msie' && GeneralUtility
::getIndpEnv('TYPO3_SSL')) {
433 // Some IEs can not handle no-cache
434 // see http://support.microsoft.com/kb/323308/en-us
435 $cacheControlHeader = 'must-revalidate';
436 // IE needs "Pragma: private" if SSL connection
437 $pragmaHeader = 'private';
439 header('Cache-Control: ' . $cacheControlHeader);
440 header('Pragma: ' . $pragmaHeader);
442 // Load user session, check to see if anyone has submitted login-information and if so authenticate
443 // the user with the session. $this->user[uid] may be used to write log...
444 $this->checkAuthentication();
446 if (!$this->dontSetCookie
) {
447 $this->setSessionCookie();
449 // Hook for alternative ways of filling the $this->user array (is used by the "timtaw" extension)
450 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'])) {
451 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'] as $funcName) {
455 GeneralUtility
::callUserFunction($funcName, $_params, $this);
458 // Set $this->gc_time if not explicitly specified
459 if ($this->gc_time
=== 0) {
460 // Default to 86400 seconds (1 day) if $this->sessionTimeout is 0
461 $this->gc_time
= $this->sessionTimeout
=== 0 ?
86400 : $this->sessionTimeout
;
463 // If we're lucky we'll get to clean up old sessions
464 if (rand() %
100 <= $this->gc_probability
) {
470 * Sets the session cookie for the current disposal.
475 protected function setSessionCookie()
477 $isSetSessionCookie = $this->isSetSessionCookie();
478 $isRefreshTimeBasedCookie = $this->isRefreshTimeBasedCookie();
479 if ($isSetSessionCookie ||
$isRefreshTimeBasedCookie) {
480 $settings = $GLOBALS['TYPO3_CONF_VARS']['SYS'];
481 // Get the domain to be used for the cookie (if any):
482 $cookieDomain = $this->getCookieDomain();
483 // If no cookie domain is set, use the base path:
484 $cookiePath = $cookieDomain ?
'/' : GeneralUtility
::getIndpEnv('TYPO3_SITE_PATH');
485 // If the cookie lifetime is set, use it:
486 $cookieExpire = $isRefreshTimeBasedCookie ?
$GLOBALS['EXEC_TIME'] +
$this->lifetime
: 0;
487 // Use the secure option when the current request is served by a secure connection:
488 $cookieSecure = (bool)$settings['cookieSecure'] && GeneralUtility
::getIndpEnv('TYPO3_SSL');
489 // Do not set cookie if cookieSecure is set to "1" (force HTTPS) and no secure channel is used:
490 if ((int)$settings['cookieSecure'] !== 1 || GeneralUtility
::getIndpEnv('TYPO3_SSL')) {
491 setcookie($this->name
, $this->id
, $cookieExpire, $cookiePath, $cookieDomain, $cookieSecure, true);
492 $this->cookieWasSetOnCurrentRequest
= true;
494 throw new Exception('Cookie was not set since HTTPS was forced in $TYPO3_CONF_VARS[SYS][cookieSecure].', 1254325546);
496 if ($this->writeDevLog
) {
497 $devLogMessage = ($isRefreshTimeBasedCookie ?
'Updated Cookie: ' : 'Set Cookie: ') . $this->id
;
498 GeneralUtility
::devLog($devLogMessage . ($cookieDomain ?
', ' . $cookieDomain : ''), self
::class);
504 * Gets the domain to be used on setting cookies.
505 * The information is taken from the value in $GLOBALS['TYPO3_CONF_VARS']['SYS']['cookieDomain'].
507 * @return string The domain to be used on setting cookies
509 protected function getCookieDomain()
512 $cookieDomain = $GLOBALS['TYPO3_CONF_VARS']['SYS']['cookieDomain'];
513 // If a specific cookie domain is defined for a given TYPO3_MODE,
515 if (!empty($GLOBALS['TYPO3_CONF_VARS'][$this->loginType
]['cookieDomain'])) {
516 $cookieDomain = $GLOBALS['TYPO3_CONF_VARS'][$this->loginType
]['cookieDomain'];
519 if ($cookieDomain[0] === '/') {
521 $matchCnt = @preg_match
($cookieDomain, GeneralUtility
::getIndpEnv('TYPO3_HOST_ONLY'), $match);
522 if ($matchCnt === false) {
523 GeneralUtility
::sysLog('The regular expression for the cookie domain (' . $cookieDomain . ') contains errors. The session is not shared across sub-domains.', 'core', GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
524 } elseif ($matchCnt) {
528 $result = $cookieDomain;
535 * Get the value of a specified cookie.
537 * @param string $cookieName The cookie ID
538 * @return string The value stored in the cookie
540 protected function getCookie($cookieName)
542 return isset($_COOKIE[$cookieName]) ?
stripslashes($_COOKIE[$cookieName]) : '';
546 * Determine whether a session cookie needs to be set (lifetime=0)
551 public function isSetSessionCookie()
553 return ($this->newSessionID ||
$this->forceSetCookie
) && $this->lifetime
== 0;
557 * Determine whether a non-session cookie needs to be set (lifetime>0)
562 public function isRefreshTimeBasedCookie()
564 return $this->lifetime
> 0;
568 * Checks if a submission of username and password is present or use other authentication by auth services
570 * @throws \RuntimeException
574 public function checkAuthentication()
576 // No user for now - will be searched by service below
579 // User is not authenticated by default
580 $authenticated = false;
581 // User want to login with passed login data (name/password)
582 $activeLogin = false;
583 // Indicates if an active authentication failed (not auto login)
584 $this->loginFailure
= false;
585 if ($this->writeDevLog
) {
586 GeneralUtility
::devLog('Login type: ' . $this->loginType
, self
::class);
588 // The info array provide additional information for auth services
589 $authInfo = $this->getAuthInfoArray();
590 // Get Login/Logout data submitted by a form or params
591 $loginData = $this->getLoginFormData();
592 if ($this->writeDevLog
) {
593 GeneralUtility
::devLog('Login data: ' . GeneralUtility
::arrayToLogString($loginData), self
::class);
595 // Active logout (eg. with "logout" button)
596 if ($loginData['status'] === 'logout') {
597 if ($this->writeStdLog
) {
598 // $type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid
599 $this->writelog(255, 2, 0, 2, 'User %s logged out', [$this->user
['username']], '', 0, 0);
601 // Logout written to log
602 if ($this->writeDevLog
) {
603 GeneralUtility
::devLog('User logged out. Id: ' . $this->id
, self
::class, -1);
607 // Determine whether we need to skip session update.
608 // This is used mainly for checking session timeout in advance without refreshing the current session's timeout.
609 $skipSessionUpdate = (bool)GeneralUtility
::_GP('skipSessionUpdate');
610 $haveSession = false;
611 $anonymousSession = false;
612 if (!$this->newSessionID
) {
614 $authInfo['userSession'] = $this->fetchUserSession($skipSessionUpdate);
615 $haveSession = is_array($authInfo['userSession']);
616 if ($haveSession && !empty($authInfo['userSession']['ses_anonymous'])) {
617 $anonymousSession = true;
621 // Active login (eg. with login form).
622 if (!$haveSession && $loginData['status'] === 'login') {
624 if ($this->writeDevLog
) {
625 GeneralUtility
::devLog('Active login (eg. with login form)', self
::class);
627 // check referrer for submitted login values
628 if ($this->formfield_status
&& $loginData['uident'] && $loginData['uname']) {
629 $httpHost = GeneralUtility
::getIndpEnv('TYPO3_HOST_ONLY');
630 if (!$this->getMethodEnabled
&& ($httpHost != $authInfo['refInfo']['host'] && !$GLOBALS['TYPO3_CONF_VARS']['SYS']['doNotCheckReferer'])) {
631 throw new \
RuntimeException('TYPO3 Fatal Error: Error: This host address ("' . $httpHost . '") and the referer host ("' . $authInfo['refInfo']['host'] . '") mismatches! ' .
632 'It is possible that the environment variable HTTP_REFERER is not passed to the script because of a proxy. ' .
633 'The site administrator can disable this check in the "All Configuration" section of the Install Tool (flag: TYPO3_CONF_VARS[SYS][doNotCheckReferer]).', 1270853930);
635 // Delete old user session if any
638 // Refuse login for _CLI users, if not processing a CLI request type
639 // (although we shouldn't be here in case of a CLI request type)
640 if (strtoupper(substr($loginData['uname'], 0, 5)) === '_CLI_' && !(TYPO3_REQUESTTYPE
& TYPO3_REQUESTTYPE_CLI
)) {
641 throw new \
RuntimeException('TYPO3 Fatal Error: You have tried to login using a CLI user. Access prohibited!', 1270853931);
645 // Cause elevation of privilege, make sure regenerateSessionId is called later on
646 if ($anonymousSession && $loginData['status'] === 'login') {
650 if ($this->writeDevLog
) {
652 GeneralUtility
::devLog('User session found: ' . GeneralUtility
::arrayToLogString($authInfo['userSession'], [$this->userid_column
, $this->username_column
]), self
::class, 0);
654 GeneralUtility
::devLog('No user session found.', self
::class, 2);
656 if (is_array($this->svConfig
['setup'])) {
657 GeneralUtility
::devLog('SV setup: ' . GeneralUtility
::arrayToLogString($this->svConfig
['setup']), self
::class, 0);
663 $activeLogin ||
$this->svConfig
['setup'][$this->loginType
. '_alwaysFetchUser']
664 ||
!$haveSession && $this->svConfig
['setup'][$this->loginType
. '_fetchUserIfNoSession']
666 // Use 'auth' service to find the user
667 // First found user will be used
668 $subType = 'getUser' . $this->loginType
;
669 /** @var AuthenticationService $serviceObj */
670 foreach ($this->getAuthServices($subType, $loginData, $authInfo) as $serviceObj) {
671 if ($row = $serviceObj->getUser()) {
672 $tempuserArr[] = $row;
673 if ($this->writeDevLog
) {
674 GeneralUtility
::devLog('User found: ' . GeneralUtility
::arrayToLogString($row, [$this->userid_column
, $this->username_column
]), self
::class, 0);
676 // User found, just stop to search for more if not configured to go on
677 if (!$this->svConfig
['setup'][$this->loginType
. '_fetchAllUsers']) {
683 if ($this->writeDevLog
&& $this->svConfig
['setup'][$this->loginType
. '_alwaysFetchUser']) {
684 GeneralUtility
::devLog($this->loginType
. '_alwaysFetchUser option is enabled', self
::class);
686 if ($this->writeDevLog
&& empty($tempuserArr)) {
687 GeneralUtility
::devLog('No user found by services', self
::class);
689 if ($this->writeDevLog
&& !empty($tempuserArr)) {
690 GeneralUtility
::devLog(count($tempuserArr) . ' user records found by services', self
::class);
694 // If no new user was set we use the already found user session
695 if (empty($tempuserArr) && $haveSession && !$anonymousSession) {
696 $tempuserArr[] = $authInfo['userSession'];
697 $tempuser = $authInfo['userSession'];
698 // User is authenticated because we found a user session
699 $authenticated = true;
700 if ($this->writeDevLog
) {
701 GeneralUtility
::devLog('User session used: ' . GeneralUtility
::arrayToLogString($authInfo['userSession'], [$this->userid_column
, $this->username_column
]), self
::class);
704 // Re-auth user when 'auth'-service option is set
705 if ($this->svConfig
['setup'][$this->loginType
. '_alwaysAuthUser']) {
706 $authenticated = false;
707 if ($this->writeDevLog
) {
708 GeneralUtility
::devLog('alwaysAuthUser option is enabled', self
::class);
711 // Authenticate the user if needed
712 if (!empty($tempuserArr) && !$authenticated) {
713 foreach ($tempuserArr as $tempuser) {
714 // Use 'auth' service to authenticate the user
715 // If one service returns FALSE then authentication failed
716 // a service might return 100 which means there's no reason to stop but the user can't be authenticated by that service
717 if ($this->writeDevLog
) {
718 GeneralUtility
::devLog('Auth user: ' . GeneralUtility
::arrayToLogString($tempuser), self
::class);
720 $subType = 'authUser' . $this->loginType
;
722 foreach ($this->getAuthServices($subType, $loginData, $authInfo) as $serviceObj) {
723 if (($ret = $serviceObj->authUser($tempuser)) > 0) {
724 // If the service returns >=200 then no more checking is needed - useful for IP checking without password
725 if ((int)$ret >= 200) {
726 $authenticated = true;
728 } elseif ((int)$ret >= 100) {
730 $authenticated = true;
733 $authenticated = false;
738 if ($authenticated) {
739 // Leave foreach() because a user is authenticated
745 // If user is authenticated a valid user is in $tempuser
746 if ($authenticated) {
747 // Reset failure flag
748 $this->loginFailure
= false;
749 // Insert session record if needed:
750 if (!$haveSession ||
$anonymousSession ||
$tempuser['ses_id'] != $this->id
&& $tempuser['uid'] != $authInfo['userSession']['ses_userid']) {
751 $sessionData = $this->createUserSession($tempuser);
753 // Preserve session data on login
754 if ($anonymousSession) {
755 $sessionData = $this->getSessionBackend()->update(
757 ['ses_data' => $authInfo['userSession']['ses_data']]
761 $this->user
= array_merge(
765 // The login session is started.
766 $this->loginSessionStarted
= true;
767 if ($this->writeDevLog
&& is_array($this->user
)) {
768 GeneralUtility
::devLog('User session finally read: ' . GeneralUtility
::arrayToLogString($this->user
, [$this->userid_column
, $this->username_column
]), self
::class, -1);
770 } elseif ($haveSession) {
771 // if we come here the current session is for sure not anonymous as this is a pre-condition for $authenticated = true
772 $this->user
= $authInfo['userSession'];
775 if ($activeLogin && !$this->newSessionID
) {
776 $this->regenerateSessionId();
779 // User logged in - write that to the log!
780 if ($this->writeStdLog
&& $activeLogin) {
781 $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')], '', '', '');
783 if ($this->writeDevLog
&& $activeLogin) {
784 GeneralUtility
::devLog('User ' . $tempuser[$this->username_column
] . ' logged in from ' . GeneralUtility
::getIndpEnv('REMOTE_ADDR') . ' (' . GeneralUtility
::getIndpEnv('REMOTE_HOST') . ')', self
::class, -1);
786 if ($this->writeDevLog
&& !$activeLogin) {
787 GeneralUtility
::devLog('User ' . $tempuser[$this->username_column
] . ' authenticated from ' . GeneralUtility
::getIndpEnv('REMOTE_ADDR') . ' (' . GeneralUtility
::getIndpEnv('REMOTE_HOST') . ')', self
::class, -1);
789 } elseif ($anonymousSession) {
790 // User was not authenticated, so we should reuse the existing anonymous session
791 $this->user
= $authInfo['userSession'];
792 } elseif ($activeLogin ||
!empty($tempuserArr)) {
793 $this->loginFailure
= true;
794 if ($this->writeDevLog
&& empty($tempuserArr) && $activeLogin) {
795 GeneralUtility
::devLog('Login failed: ' . GeneralUtility
::arrayToLogString($loginData), self
::class, 2);
797 if ($this->writeDevLog
&& !empty($tempuserArr)) {
798 GeneralUtility
::devLog('Login failed: ' . GeneralUtility
::arrayToLogString($tempuser, [$this->userid_column
, $this->username_column
]), self
::class, 2);
802 // If there were a login failure, check to see if a warning email should be sent:
803 if ($this->loginFailure
&& $activeLogin) {
804 if ($this->writeDevLog
) {
805 GeneralUtility
::devLog('Call checkLogFailures: ' . GeneralUtility
::arrayToLogString(['warningEmail' => $this->warningEmail
, 'warningPeriod' => $this->warningPeriod
, 'warningMax' => $this->warningMax
]), self
::class, -1);
808 // Hook to implement login failure tracking methods
810 !empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postLoginFailureProcessing'])
811 && is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postLoginFailureProcessing'])
814 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postLoginFailureProcessing'] as $_funcRef) {
815 GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
818 // If no hook is implemented, wait for 5 seconds
822 $this->checkLogFailures($this->warningEmail
, $this->warningPeriod
, $this->warningMax
);
827 * Creates a new session ID.
829 * @return string The new session ID
831 public function createSessionId()
833 return GeneralUtility
::makeInstance(Random
::class)->generateRandomHexString($this->hash_length
);
837 * Initializes authentication services to be used in a foreach loop
839 * @param string $subType e.g. getUserFE
840 * @param array $loginData
841 * @param array $authInfo
842 * @return \Traversable A generator of service objects
844 protected function getAuthServices(string $subType, array $loginData, array $authInfo): \Traversable
847 while (is_object($serviceObj = GeneralUtility
::makeInstanceService('auth', $subType, $serviceChain))) {
848 $serviceChain .= ',' . $serviceObj->getServiceKey();
849 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
852 if ($this->writeDevLog
&& $serviceChain) {
853 GeneralUtility
::devLog($subType . ' auth services called: ' . $serviceChain, self
::class);
858 * Regenerate the session ID and transfer the session to new ID
859 * Call this method whenever a user proceeds to a higher authorization level
860 * e.g. when an anonymous session is now authenticated.
862 * @param array $existingSessionRecord If given, this session record will be used instead of fetching again
863 * @param bool $anonymous If true session will be regenerated as anonymous session
865 protected function regenerateSessionId(array $existingSessionRecord = [], bool $anonymous = false)
867 if (empty($existingSessionRecord)) {
868 $existingSessionRecord = $this->getSessionBackend()->get($this->id
);
871 // Update session record with new ID
872 $oldSessionId = $this->id
;
873 $this->id
= $this->createSessionId();
874 $updatedSession = $this->getSessionBackend()->set($this->id
, $existingSessionRecord);
875 $this->sessionData
= unserialize($updatedSession['ses_data']);
876 // Merge new session data into user/session array
877 $this->user
= array_merge($this->user ??
[], $updatedSession);
878 $this->getSessionBackend()->remove($oldSessionId);
879 $this->newSessionID
= true;
882 /*************************
886 *************************/
889 * Creates a user session record and returns its values.
891 * @param array $tempuser User data array
893 * @return array The session data for the newly created session.
895 public function createUserSession($tempuser)
897 if ($this->writeDevLog
) {
898 GeneralUtility
::devLog('Create session ses_id = ' . $this->id
, self
::class);
900 // Delete any session entry first
901 $this->getSessionBackend()->remove($this->id
);
902 // Re-create session entry
903 $sessionRecord = $this->getNewSessionRecord($tempuser);
904 $sessionRecord = $this->getSessionBackend()->set($this->id
, $sessionRecord);
905 // Updating lastLogin_column carrying information about last login.
906 $this->updateLoginTimestamp($tempuser[$this->userid_column
]);
907 return $sessionRecord;
911 * Updates the last login column in the user with the given id
915 protected function updateLoginTimestamp(int $userId)
917 if ($this->lastLogin_column
) {
918 $connection = GeneralUtility
::makeInstance(ConnectionPool
::class)->getConnectionForTable($this->user_table
);
921 [$this->lastLogin_column
=> $GLOBALS['EXEC_TIME']],
922 [$this->userid_column
=> $userId]
928 * Returns a new session record for the current user for insertion into the DB.
929 * This function is mainly there as a wrapper for inheriting classes to override it.
931 * @param array $tempuser
932 * @return array User session record
934 public function getNewSessionRecord($tempuser)
936 $sessionIpLock = '[DISABLED]';
937 if ($this->lockIP
&& empty($tempuser['disableIPlock'])) {
938 $sessionIpLock = $this->ipLockClause_remoteIPNumber($this->lockIP
);
942 'ses_id' => $this->id
,
943 'ses_iplock' => $sessionIpLock,
944 'ses_userid' => $tempuser[$this->userid_column
] ??
0,
945 'ses_tstamp' => $GLOBALS['EXEC_TIME'],
951 * Read the user session from db.
953 * @param bool $skipSessionUpdate
954 * @return array|bool User session data, false if $this->id does not represent valid session
956 public function fetchUserSession($skipSessionUpdate = false)
958 if ($this->writeDevLog
) {
959 GeneralUtility
::devLog('Fetch session ses_id = ' . $this->id
, self
::class);
962 $sessionRecord = $this->getSessionBackend()->get($this->id
);
963 } catch (SessionNotFoundException
$e) {
967 // Fail if user session is not in current IPLock Range
968 if ($sessionRecord['ses_iplock'] !== $this->ipLockClause_remoteIPNumber($this->lockIP
) && $sessionRecord['ses_iplock'] !== '[DISABLED]') {
972 $this->sessionData
= unserialize($sessionRecord['ses_data']);
973 // Session is anonymous so no need to fetch user
974 if ($sessionRecord['ses_anonymous']) {
975 return $sessionRecord;
978 // Fetch the user from the DB
979 $userRecord = $this->getRawUserByUid((int)$sessionRecord['ses_userid']);
981 $userRecord = array_merge($sessionRecord, $userRecord);
983 $userRecord['ses_tstamp'] = (int)$userRecord['ses_tstamp'];
984 $userRecord['is_online'] = (int)$userRecord['ses_tstamp'];
986 if (!empty($this->auth_timeout_field
)) {
987 // Get timeout-time from usertable
988 $timeout = (int)$userRecord[$this->auth_timeout_field
];
990 $timeout = $this->sessionTimeout
;
992 // If timeout > 0 (TRUE) and current time has not exceeded the latest sessions-time plus the timeout in seconds then accept user
993 // Use a gracetime-value to avoid updating a session-record too often
994 if ($timeout > 0 && $GLOBALS['EXEC_TIME'] < $userRecord['ses_tstamp'] +
$timeout) {
995 $sessionUpdateGracePeriod = 61;
996 if (!$skipSessionUpdate && $GLOBALS['EXEC_TIME'] > ($userRecord['ses_tstamp'] +
$sessionUpdateGracePeriod)) {
997 // Update the session timestamp by writing a dummy update. (Backend will update the timestamp)
998 $updatesSession = $this->getSessionBackend()->update($this->id
, []);
999 $userRecord = array_merge($userRecord, $updatesSession);
1002 // Delete any user set...
1004 $userRecord = false;
1011 * Log out current user!
1012 * Removes the current session record, sets the internal ->user array to a blank string;
1013 * Thereby the current user (if any) is effectively logged out!
1017 public function logoff()
1019 if ($this->writeDevLog
) {
1020 GeneralUtility
::devLog('logoff: ses_id = ' . $this->id
, self
::class);
1022 // Release the locked records
1023 BackendUtility
::lockRecords();
1024 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'])) {
1026 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'] as $_funcRef) {
1028 GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1032 $this->performLogoff();
1033 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'])) {
1035 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'] as $_funcRef) {
1037 GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1044 * Perform the logoff action. Called from logoff() as a way to allow subclasses to override
1045 * what happens when a user logs off, without needing to reproduce the hook calls and logging
1046 * that happens in the public logoff() API method.
1050 protected function performLogoff()
1053 $this->getSessionBackend()->remove($this->id
);
1059 * Empty / unset the cookie
1061 * @param string $cookieName usually, this is $this->name
1064 public function removeCookie($cookieName)
1066 $cookieDomain = $this->getCookieDomain();
1067 // If no cookie domain is set, use the base path
1068 $cookiePath = $cookieDomain ?
'/' : GeneralUtility
::getIndpEnv('TYPO3_SITE_PATH');
1069 setcookie($cookieName, null, -1, $cookiePath, $cookieDomain);
1073 * Determine whether there's an according session record to a given session_id.
1074 * Don't care if session record is still valid or not.
1076 * @param string $id Claimed Session ID
1077 * @return bool Returns TRUE if a corresponding session was found in the database
1079 public function isExistingSessionRecord($id)
1082 return !empty($this->getSessionBackend()->get($id));
1083 } catch (SessionNotFoundException
$e) {
1089 * Returns whether this request is going to set a cookie
1090 * or a cookie was already found in the system
1092 * @return bool Returns TRUE if a cookie is set
1094 public function isCookieSet()
1096 return $this->cookieWasSetOnCurrentRequest ||
$this->getCookie($this->name
);
1099 /*************************
1103 *************************/
1105 * This returns the restrictions needed to select the user respecting
1106 * enable columns and flags like deleted, hidden, starttime, endtime
1109 * @return QueryRestrictionContainerInterface
1112 protected function userConstraints(): QueryRestrictionContainerInterface
1114 $restrictionContainer = GeneralUtility
::makeInstance(DefaultRestrictionContainer
::class);
1116 if (empty($this->enablecolumns
['disabled'])) {
1117 $restrictionContainer->removeByType(HiddenRestriction
::class);
1120 if (empty($this->enablecolumns
['deleted'])) {
1121 $restrictionContainer->removeByType(DeletedRestriction
::class);
1124 if (empty($this->enablecolumns
['starttime'])) {
1125 $restrictionContainer->removeByType(StartTimeRestriction
::class);
1128 if (empty($this->enablecolumns
['endtime'])) {
1129 $restrictionContainer->removeByType(EndTimeRestriction
::class);
1132 if (!empty($this->enablecolumns
['rootLevel'])) {
1133 $restrictionContainer->add(GeneralUtility
::makeInstance(RootLevelRestriction
::class, [$this->user_table
]));
1136 return $restrictionContainer;
1140 * This returns the where-clause needed to select the user
1141 * with respect flags like deleted, hidden, starttime, endtime
1145 * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
1147 protected function user_where_clause()
1149 GeneralUtility
::logDeprecatedFunction();
1152 if ($this->enablecolumns
['rootLevel']) {
1153 $whereClause .= ' AND ' . $this->user_table
. '.pid=0 ';
1155 if ($this->enablecolumns
['disabled']) {
1156 $whereClause .= ' AND ' . $this->user_table
. '.' . $this->enablecolumns
['disabled'] . '=0';
1158 if ($this->enablecolumns
['deleted']) {
1159 $whereClause .= ' AND ' . $this->user_table
. '.' . $this->enablecolumns
['deleted'] . '=0';
1161 if ($this->enablecolumns
['starttime']) {
1162 $whereClause .= ' AND (' . $this->user_table
. '.' . $this->enablecolumns
['starttime'] . '<=' . $GLOBALS['EXEC_TIME'] . ')';
1164 if ($this->enablecolumns
['endtime']) {
1165 $whereClause .= ' AND (' . $this->user_table
. '.' . $this->enablecolumns
['endtime'] . '=0 OR '
1166 . $this->user_table
. '.' . $this->enablecolumns
['endtime'] . '>' . $GLOBALS['EXEC_TIME'] . ')';
1168 return $whereClause;
1172 * Returns the IP address to lock to.
1173 * The IP address may be partial based on $parts.
1175 * @param int $parts 1-4: Indicates how many parts of the IP address to return. 4 means all, 1 means only first number.
1176 * @return string (Partial) IP address for REMOTE_ADDR
1178 protected function ipLockClause_remoteIPNumber($parts)
1180 $IP = GeneralUtility
::getIndpEnv('REMOTE_ADDR');
1184 $parts = MathUtility
::forceIntegerInRange($parts, 1, 3);
1185 $IPparts = explode('.', $IP);
1186 for ($a = 4; $a > $parts; $a--) {
1187 unset($IPparts[$a - 1]);
1189 return implode('.', $IPparts);
1194 * VeriCode returns 10 first chars of a md5 hash of the session cookie AND the encryptionKey from TYPO3_CONF_VARS.
1195 * This code is used as an alternative verification when the JavaScript interface executes cmd's to
1196 * tce_db.php from eg. MSIE 5.0 because the proper referer is not passed with this browser...
1199 * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
1201 public function veriCode()
1203 GeneralUtility
::logDeprecatedFunction();
1204 return substr(md5($this->id
. $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']), 0, 10);
1207 /*************************
1209 * Session and Configuration Handling
1211 *************************/
1213 * This writes $variable to the user-record. This is a way of providing session-data.
1214 * You can fetch the data again through $this->uc in this class!
1215 * If $variable is not an array, $this->uc is saved!
1217 * @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
1220 public function writeUC($variable = '')
1222 if (is_array($this->user
) && $this->user
[$this->userid_column
]) {
1223 if (!is_array($variable)) {
1224 $variable = $this->uc
;
1226 if ($this->writeDevLog
) {
1227 GeneralUtility
::devLog(
1228 'writeUC: ' . $this->userid_column
. '=' . (int)$this->user
[$this->userid_column
],
1232 GeneralUtility
::makeInstance(ConnectionPool
::class)->getConnectionForTable($this->user_table
)->update(
1234 ['uc' => serialize($variable)],
1235 [$this->userid_column
=> (int)$this->user
[$this->userid_column
]],
1236 ['uc' => Connection
::PARAM_LOB
]
1242 * Sets $theUC as the internal variable ->uc IF $theUC is an array.
1243 * If $theUC is FALSE, the 'uc' content from the ->user array will be unserialized and restored in ->uc
1245 * @param mixed $theUC If an array, then set as ->uc, otherwise load from user record
1248 public function unpack_uc($theUC = '')
1250 if (!$theUC && isset($this->user
['uc'])) {
1251 $theUC = unserialize($this->user
['uc']);
1253 if (is_array($theUC)) {
1259 * Stores data for a module.
1260 * The data is stored with the session id so you can even check upon retrieval
1261 * if the module data is from a previous session or from the current session.
1263 * @param string $module Is the name of the module ($MCONF['name'])
1264 * @param mixed $data Is the data you want to store for that module (array, string, ...)
1265 * @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.
1268 public function pushModuleData($module, $data, $noSave = 0)
1270 $this->uc
['moduleData'][$module] = $data;
1271 $this->uc
['moduleSessionID'][$module] = $this->id
;
1278 * Gets module data for a module (from a loaded ->uc array)
1280 * @param string $module Is the name of the module ($MCONF['name'])
1281 * @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).
1282 * @return mixed The module data if available: $this->uc['moduleData'][$module];
1284 public function getModuleData($module, $type = '')
1286 if ($type !== 'ses' ||
(isset($this->uc
['moduleSessionID'][$module]) && $this->uc
['moduleSessionID'][$module] == $this->id
)) {
1287 return $this->uc
['moduleData'][$module];
1293 * Returns the session data stored for $key.
1294 * The data will last only for this login session since it is stored in the user session.
1296 * @param string $key The key associated with the session data
1299 public function getSessionData($key)
1301 return $this->sessionData
[$key] ??
null;
1305 * Set session data by key.
1306 * The data will last only for this login session since it is stored in the user session.
1308 * @param string $key A non empty string to store the data under
1309 * @param mixed $data Data store store in session
1312 public function setSessionData($key, $data)
1315 throw new \
InvalidArgumentException('Argument key must not be empty', 1484311516);
1317 $this->sessionData
[$key] = $data;
1321 * Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database.
1322 * The data will last only for this login session since it is stored in the session table.
1324 * @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.
1325 * @param mixed $data The data to store in index $key
1328 public function setAndSaveSessionData($key, $data)
1330 $this->sessionData
[$key] = $data;
1331 $this->user
['ses_data'] = serialize($this->sessionData
);
1332 if ($this->writeDevLog
) {
1333 GeneralUtility
::devLog('setAndSaveSessionData: ses_id = ' . $this->id
, self
::class);
1335 $updatedSession = $this->getSessionBackend()->update(
1337 ['ses_data' => $this->user
['ses_data']]
1339 $this->user
= array_merge($this->user ??
[], $updatedSession);
1342 /*************************
1346 *************************/
1348 * Returns an info array with Login/Logout data submitted by a form or params
1353 public function getLoginFormData()
1356 $loginData['status'] = GeneralUtility
::_GP($this->formfield_status
);
1357 if ($this->getMethodEnabled
) {
1358 $loginData['uname'] = GeneralUtility
::_GP($this->formfield_uname
);
1359 $loginData['uident'] = GeneralUtility
::_GP($this->formfield_uident
);
1361 $loginData['uname'] = GeneralUtility
::_POST($this->formfield_uname
);
1362 $loginData['uident'] = GeneralUtility
::_POST($this->formfield_uident
);
1364 // Only process the login data if a login is requested
1365 if ($loginData['status'] === 'login') {
1366 $loginData = $this->processLoginData($loginData);
1368 $loginData = array_map('trim', $loginData);
1373 * Processes Login data submitted by a form or params depending on the
1374 * passwordTransmissionStrategy
1376 * @param array $loginData Login data array
1377 * @param string $passwordTransmissionStrategy Alternative passwordTransmissionStrategy. Used when authentication services wants to override the default.
1381 public function processLoginData($loginData, $passwordTransmissionStrategy = '')
1383 $loginSecurityLevel = trim($GLOBALS['TYPO3_CONF_VARS'][$this->loginType
]['loginSecurityLevel']) ?
: 'normal';
1384 $passwordTransmissionStrategy = $passwordTransmissionStrategy ?
: $loginSecurityLevel;
1385 if ($this->writeDevLog
) {
1386 GeneralUtility
::devLog('Login data before processing: ' . GeneralUtility
::arrayToLogString($loginData), self
::class);
1389 $subType = 'processLoginData' . $this->loginType
;
1390 $authInfo = $this->getAuthInfoArray();
1391 $isLoginDataProcessed = false;
1392 $processedLoginData = $loginData;
1393 while (is_object($serviceObject = GeneralUtility
::makeInstanceService('auth', $subType, $serviceChain))) {
1394 $serviceChain .= ',' . $serviceObject->getServiceKey();
1395 $serviceObject->initAuth($subType, $loginData, $authInfo, $this);
1396 $serviceResult = $serviceObject->processLoginData($processedLoginData, $passwordTransmissionStrategy);
1397 if (!empty($serviceResult)) {
1398 $isLoginDataProcessed = true;
1399 // If the service returns >=200 then no more processing is needed
1400 if ((int)$serviceResult >= 200) {
1401 unset($serviceObject);
1405 unset($serviceObject);
1407 if ($isLoginDataProcessed) {
1408 $loginData = $processedLoginData;
1409 if ($this->writeDevLog
) {
1410 GeneralUtility
::devLog('Processed login data: ' . GeneralUtility
::arrayToLogString($processedLoginData), self
::class);
1417 * Returns an info array which provides additional information for auth services
1422 public function getAuthInfoArray()
1424 $queryBuilder = GeneralUtility
::makeInstance(ConnectionPool
::class)->getQueryBuilderForTable($this->user_table
);
1425 $expressionBuilder = $queryBuilder->expr();
1427 $authInfo['loginType'] = $this->loginType
;
1428 $authInfo['refInfo'] = parse_url(GeneralUtility
::getIndpEnv('HTTP_REFERER'));
1429 $authInfo['HTTP_HOST'] = GeneralUtility
::getIndpEnv('HTTP_HOST');
1430 $authInfo['REMOTE_ADDR'] = GeneralUtility
::getIndpEnv('REMOTE_ADDR');
1431 $authInfo['REMOTE_HOST'] = GeneralUtility
::getIndpEnv('REMOTE_HOST');
1432 $authInfo['showHiddenRecords'] = $this->showHiddenRecords
;
1433 // Can be overidden in localconf by SVCONF:
1434 $authInfo['db_user']['table'] = $this->user_table
;
1435 $authInfo['db_user']['userid_column'] = $this->userid_column
;
1436 $authInfo['db_user']['username_column'] = $this->username_column
;
1437 $authInfo['db_user']['userident_column'] = $this->userident_column
;
1438 $authInfo['db_user']['usergroup_column'] = $this->usergroup_column
;
1439 $authInfo['db_user']['enable_clause'] = $this->userConstraints()->buildExpression(
1440 [$this->user_table
=> ''],
1443 if ($this->checkPid
&& $this->checkPid_value
!== null) {
1444 $authInfo['db_user']['checkPidList'] = $this->checkPid_value
;
1445 $authInfo['db_user']['check_pid_clause'] = $expressionBuilder->in(
1447 GeneralUtility
::intExplode(',', $this->checkPid_value
)
1450 $authInfo['db_user']['checkPidList'] = '';
1451 $authInfo['db_user']['check_pid_clause'] = '';
1453 $authInfo['db_groups']['table'] = $this->usergroup_table
;
1458 * Check the login data with the user record data for builtin login methods
1460 * @param array $user User data array
1461 * @param array $loginData Login data array
1462 * @param string $passwordCompareStrategy Alternative passwordCompareStrategy. Used when authentication services wants to override the default.
1463 * @return bool TRUE if login data matched
1465 public function compareUident($user, $loginData, $passwordCompareStrategy = '')
1467 return (string)$loginData['uident_text'] !== '' && (string)$loginData['uident_text'] === (string)$user[$this->userident_column
];
1471 * Garbage collector, removing old expired sessions.
1476 public function gc()
1478 $this->getSessionBackend()->collectGarbage($this->gc_time
);
1482 * DUMMY: Writes to log database table (in some extension classes)
1484 * @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
1485 * @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 !!)
1486 * @param int $error flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1487 * @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
1488 * @param string $details Default text that follows the message
1489 * @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...
1490 * @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.)
1491 * @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.)
1492 * @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.)
1495 public function writelog($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid)
1500 * DUMMY: Check login failures (in some extension classes)
1502 * @param string $email Email address
1503 * @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
1504 * @param int $maxFailures Max allowed failures before a warning mail is sent
1508 public function checkLogFailures($email, $secondsBack, $maxFailures)
1513 * Raw initialization of the be_user with uid=$uid
1514 * This will circumvent all login procedures and select a be_users record from the
1515 * database and set the content of ->user to the record selected.
1516 * Thus the BE_USER object will appear like if a user was authenticated - however without
1517 * a session id and the fields from the session table of course.
1518 * Will check the users for disabled, start/endtime, etc. ($this->user_where_clause())
1520 * @param int $uid The UID of the backend user to set in ->user
1523 * @see SC_mod_tools_be_user_index::compareUsers(), \TYPO3\CMS\Setup\Controller\SetupModuleController::simulateUser(), freesite_admin::startCreate()
1525 public function setBeUserByUid($uid)
1527 $this->user
= $this->getRawUserByUid($uid);
1531 * Raw initialization of the be_user with username=$name
1533 * @param string $name The username to look up.
1535 * @see \TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::setBeUserByUid()
1538 public function setBeUserByName($name)
1540 $this->user
= $this->getRawUserByName($name);
1544 * Fetching raw user record with uid=$uid
1546 * @param int $uid The UID of the backend user to set in ->user
1547 * @return array user record or FALSE
1550 public function getRawUserByUid($uid)
1552 $query = GeneralUtility
::makeInstance(ConnectionPool
::class)->getQueryBuilderForTable($this->user_table
);
1553 $query->setRestrictions($this->userConstraints());
1555 ->from($this->user_table
)
1556 ->where($query->expr()->eq('uid', $query->createNamedParameter($uid, \PDO
::PARAM_INT
)));
1558 return $query->execute()->fetch();
1562 * Fetching raw user record with username=$name
1564 * @param string $name The username to look up.
1565 * @return array user record or FALSE
1566 * @see \TYPO3\CMS\Core\Authentication\AbstractUserAuthentication::getUserByUid()
1569 public function getRawUserByName($name)
1571 $query = GeneralUtility
::makeInstance(ConnectionPool
::class)->getQueryBuilderForTable($this->user_table
);
1572 $query->setRestrictions($this->userConstraints());
1574 ->from($this->user_table
)
1575 ->where($query->expr()->eq('username', $query->createNamedParameter($name, \PDO
::PARAM_STR
)));
1577 return $query->execute()->fetch();
1581 * Get a user from DB by username
1582 * provided for usage from services
1584 * @param array $dbUser User db table definition: $this->db_user
1585 * @param string $username user name
1586 * @param string $extraWhere Additional WHERE clause: " AND ...
1587 * @return mixed User array or FALSE
1589 public function fetchUserRecord($dbUser, $username, $extraWhere = '')
1592 if ($username ||
$extraWhere) {
1593 $query = GeneralUtility
::makeInstance(ConnectionPool
::class)->getQueryBuilderForTable($dbUser['table']);
1594 $query->getRestrictions()->removeAll()
1595 ->add(GeneralUtility
::makeInstance(DeletedRestriction
::class));
1597 $constraints = array_filter([
1598 QueryHelper
::stripLogicalOperatorPrefix($dbUser['check_pid_clause']),
1599 QueryHelper
::stripLogicalOperatorPrefix($dbUser['enable_clause']),
1600 QueryHelper
::stripLogicalOperatorPrefix($extraWhere),
1603 if (!empty($username)) {
1607 $dbUser['username_column'],
1608 $query->createNamedParameter($username, \PDO
::PARAM_STR
)
1613 $user = $query->select('*')
1614 ->from($dbUser['table'])
1615 ->where(...$constraints)
1627 public function getSessionId() : string
1636 public function getLoginType() : string
1638 return $this->loginType
;
1642 * Returns initialized session backend. Returns same session backend if called multiple times
1644 * @return SessionBackendInterface
1646 protected function getSessionBackend()
1648 if (!isset($this->sessionBackend
)) {
1649 $this->sessionBackend
= GeneralUtility
::makeInstance(SessionManager
::class)->getSessionBackend($this->loginType
);
1651 return $this->sessionBackend
;