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