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