Fixed bug #17665: Remove deprecated method redirect() from t3lib_userAuth
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_beuserauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains class for TYPO3 backend user authentication
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 * @internal
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 76: class t3lib_beUserAuth extends t3lib_userAuthGroup
42 * 150: function trackBeUser($flag)
43 * 168: function checkLockToIP()
44 * 188: function backendCheckLogin()
45 * 216: function checkCLIuser()
46 * 240: function backendSetUC()
47 * 278: function overrideUC()
48 * 288: function resetUC()
49 * 301: function emailAtLogin()
50 * 353: function veriCode()
51 *
52 * TOTAL FUNCTIONS: 9
53 * (This index is automatically created/updated by the extension "extdeveval")
54 *
55 */
56
57
58 /**
59 * TYPO3 user authentication, backend
60 * Could technically have been the same class as t3lib_userauthgroup since these two are always used together and only together.
61 * t3lib_userauthgroup contains most of the functions used for checking permissions, authenticating users, setting up the user etc. This class is most interesting in terms of an API for user from outside.
62 * This class contains the configuration of the database fields used plus some functions for the authentication process of backend users.
63 *
64 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
65 * @package TYPO3
66 * @subpackage t3lib
67 */
68 class t3lib_beUserAuth extends t3lib_userAuthGroup {
69 var $session_table = 'be_sessions'; // Table to use for session data.
70 var $name = 'be_typo_user'; // Session/Cookie name
71
72 var $user_table = 'be_users'; // Table in database with userdata
73 var $username_column = 'username'; // Column for login-name
74 var $userident_column = 'password'; // Column for password
75 var $userid_column = 'uid'; // Column for user-id
76 var $lastLogin_column = 'lastlogin';
77
78 var $enablecolumns = Array(
79 'rootLevel' => 1,
80 'deleted' => 'deleted',
81 'disabled' => 'disable',
82 'starttime' => 'starttime',
83 'endtime' => 'endtime'
84 );
85
86 var $formfield_uname = 'username'; // formfield with login-name
87 var $formfield_uident = 'userident'; // formfield with password
88 var $formfield_chalvalue = 'challenge'; // formfield with a unique value which is used to encrypt the password and username
89 var $formfield_status = 'login_status'; // formfield with status: *'login', 'logout'
90
91 var $writeStdLog = 1; // Decides if the writelog() function is called at login and logout
92 var $writeAttemptLog = 1; // If the writelog() functions is called if a login-attempt has be tried without success
93
94 var $auth_timeout_field = 6000; // if > 0 : session-timeout in seconds. if false/<0 : no timeout. if string: The string is fieldname from the usertable where the timeout can be found.
95 var $lifetime = 0; // 0 = Session-cookies. If session-cookies, the browser will stop session when the browser is closed. Else it keeps the session for $lifetime seconds.
96 var $challengeStoredInCookie = TRUE;
97
98
99 // User Config:
100 var $uc;
101
102 // User Config Default values:
103 // The array may contain other fields for configuration. For this, see "setup" extension and "TSConfig" document (User TSconfig, "setup.[xxx]....")
104 /*
105 Reserved keys for other storage of session data:
106 moduleData
107 moduleSessionID
108 */
109 var $uc_default = Array(
110 'interfaceSetup' => '', // serialized content that is used to store interface pane and menu positions. Set by the logout.php-script
111 'moduleData' => Array(), // user-data for the modules
112 'thumbnailsByDefault' => 0,
113 'emailMeAtLogin' => 0,
114 'condensedMode' => 0,
115 'noMenuMode' => 0,
116 'startModule' => 'help_aboutmodules',
117 'hideSubmoduleIcons' => 0,
118 'helpText' => 1,
119 'titleLen' => 30,
120 'edit_wideDocument' => '0',
121 'edit_showFieldHelp' => 'icon',
122 'edit_RTE' => '1',
123 'edit_docModuleUpload' => '1',
124 'enableFlashUploader' => '1',
125 'disableCMlayers' => 0,
126 'navFrameWidth' => '', // Default is 245 pixels
127 'navFrameResizable' => 0,
128 'resizeTextareas' => 1,
129 'resizeTextareas_MaxHeight' => 300,
130 'resizeTextareas_Flexible' => 1,
131 );
132
133
134 /**
135 * Sets the security level for the Backend login
136 *
137 * @return void
138 */
139 function start() {
140 $securityLevel = trim($GLOBALS['TYPO3_CONF_VARS']['BE']['loginSecurityLevel']);
141 $this->security_level = $securityLevel ? $securityLevel : 'superchallenged';
142
143 parent::start();
144 }
145
146 /**
147 * If TYPO3_CONF_VARS['BE']['enabledBeUserIPLock'] is enabled and an IP-list is found in the User TSconfig objString "options.lockToIP", then make an IP comparison with REMOTE_ADDR and return the outcome (true/false)
148 *
149 * @return boolean True, if IP address validates OK (or no check is done at all)
150 * @access private
151 */
152 function checkLockToIP() {
153 global $TYPO3_CONF_VARS;
154 $out = 1;
155 if ($TYPO3_CONF_VARS['BE']['enabledBeUserIPLock']) {
156 $IPList = $this->getTSConfigVal('options.lockToIP');
157 if (trim($IPList)) {
158 $baseIP = t3lib_div::getIndpEnv('REMOTE_ADDR');
159 $out = t3lib_div::cmpIP($baseIP, $IPList);
160 }
161 }
162 return $out;
163 }
164
165 /**
166 * Check if user is logged in and if so, call ->fetchGroupData() to load group information and access lists of all kind, further check IP, set the ->uc array and send login-notification email if required.
167 * If no user is logged in the default behaviour is to exit with an error message, but this will happen ONLY if the constant TYPO3_PROCEED_IF_NO_USER is set true.
168 * This function is called right after ->start() in fx. init.php
169 *
170 * @return void
171 */
172 function backendCheckLogin() {
173 if (!$this->user['uid']) {
174 if (!defined('TYPO3_PROCEED_IF_NO_USER') || !TYPO3_PROCEED_IF_NO_USER) {
175 t3lib_utility_Http::redirect($GLOBALS['BACK_PATH']);
176 }
177 } else { // ...and if that's the case, call these functions
178 $this->fetchGroupData(); // The groups are fetched and ready for permission checking in this initialization. Tables.php must be read before this because stuff like the modules has impact in this
179 if ($this->checkLockToIP()) {
180 if ($this->isUserAllowedToLogin()) {
181 $this->backendSetUC(); // Setting the UC array. It's needed with fetchGroupData first, due to default/overriding of values.
182 $this->emailAtLogin(); // email at login - if option set.
183 } else {
184 throw new RuntimeException('Login Error: TYPO3 is in maintenance mode at the moment. Only administrators are allowed access.');
185 }
186 } else {
187 throw new RuntimeException('Login Error: IP locking prevented you from being authorized. Can\'t proceed, sorry.');
188 }
189 }
190 }
191
192 /**
193 * If the backend script is in CLI mode, it will try to load a backend user named by the CLI module name (in lowercase)
194 *
195 * @return boolean Returns true if a CLI user was loaded, otherwise false!
196 */
197 function checkCLIuser() {
198 // First, check if cliMode is enabled:
199 if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI) {
200 if (!$this->user['uid']) {
201 if (substr($GLOBALS['MCONF']['name'], 0, 5) == '_CLI_') {
202 $userName = strtolower($GLOBALS['MCONF']['name']);
203 $this->setBeUserByName($userName);
204 if ($this->user['uid']) {
205 if (!$this->isAdmin()) {
206 return TRUE;
207 } else {
208 die('ERROR: CLI backend user "' . $userName . '" was ADMIN which is not allowed!' . LF . LF);
209 }
210 } else {
211 die('ERROR: No backend user named "' . $userName . '" was found! [Database: ' . TYPO3_db . ']' . LF . LF);
212 }
213 } else {
214 die('ERROR: Module name, "' . $GLOBALS['MCONF']['name'] . '", was not prefixed with "_CLI_"' . LF . LF);
215 }
216 } else {
217 die('ERROR: Another user was already loaded which is impossible in CLI mode!' . LF . LF);
218 }
219 }
220 }
221
222 /**
223 * Initialize the internal ->uc array for the backend user
224 * Will make the overrides if necessary, and write the UC back to the be_users record if changes has happend
225 *
226 * @return void
227 * @internal
228 */
229 function backendSetUC() {
230 global $TYPO3_CONF_VARS;
231
232 // UC - user configuration is a serialized array inside the userobject
233 $temp_theSavedUC = unserialize($this->user['uc']); // if there is a saved uc we implement that instead of the default one.
234 if (is_array($temp_theSavedUC)) {
235 $this->unpack_uc($temp_theSavedUC);
236 }
237 // Setting defaults if uc is empty
238 if (!is_array($this->uc)) {
239 $this->uc = array_merge(
240 $this->uc_default,
241 (array) $TYPO3_CONF_VARS['BE']['defaultUC'],
242 t3lib_div::removeDotsFromTS((array) $this->getTSConfigProp('setup.default'))
243 );
244 $this->overrideUC();
245 $U = 1;
246 }
247 // If TSconfig is updated, update the defaultUC.
248 if ($this->userTSUpdated) {
249 $this->overrideUC();
250 $U = 1;
251 }
252 // Setting default lang from be_user record.
253 if (!isset($this->uc['lang'])) {
254 $this->uc['lang'] = $this->user['lang'];
255 $U = 1;
256 }
257 // Setting the time of the first login:
258 if (!isset($this->uc['firstLoginTimeStamp'])) {
259 $this->uc['firstLoginTimeStamp'] = $GLOBALS['EXEC_TIME'];
260 $U = TRUE;
261 }
262
263 // Saving if updated.
264 if ($U) {
265 $this->writeUC(); // Method from the t3lib_userauth class.
266 }
267 }
268
269 /**
270 * Override: Call this function every time the uc is updated.
271 * That is 1) by reverting to default values, 2) in the setup-module, 3) userTS changes (userauthgroup)
272 *
273 * @return void
274 * @internal
275 */
276 function overrideUC() {
277 $this->uc = array_merge((array) $this->uc, (array) $this->getTSConfigProp('setup.override')); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
278 }
279
280 /**
281 * Clears the user[uc] and ->uc to blank strings. Then calls ->backendSetUC() to fill it again with reset contents
282 *
283 * @return void
284 * @internal
285 */
286 function resetUC() {
287 $this->user['uc'] = '';
288 $this->uc = '';
289 $this->backendSetUC();
290 }
291
292 /**
293 * Will send an email notification to warning_email_address/the login users email address when a login session is just started.
294 * Depends on various parameters whether mails are send and to whom.
295 *
296 * @return void
297 * @access private
298 */
299 function emailAtLogin() {
300 if ($this->loginSessionStarted) {
301 // Send notify-mail
302 $subject = 'At "' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '"' .
303 ' from ' . t3lib_div::getIndpEnv('REMOTE_ADDR') .
304 (t3lib_div::getIndpEnv('REMOTE_HOST') ? ' (' . t3lib_div::getIndpEnv('REMOTE_HOST') . ')' : '');
305 $msg = sprintf('User "%s" logged in from %s (%s) at "%s" (%s)',
306 $this->user['username'],
307 t3lib_div::getIndpEnv('REMOTE_ADDR'),
308 t3lib_div::getIndpEnv('REMOTE_HOST'),
309 $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'],
310 t3lib_div::getIndpEnv('HTTP_HOST')
311 );
312
313 // Warning email address
314 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr']) {
315 $warn = 0;
316 $prefix = '';
317 if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 1) { // first bit: All logins
318 $warn = 1;
319 $prefix = $this->isAdmin() ? '[AdminLoginWarning]' : '[LoginWarning]';
320 }
321 if ($this->isAdmin() && (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 2)) { // second bit: Only admin-logins
322 $warn = 1;
323 $prefix = '[AdminLoginWarning]';
324 }
325 if ($warn) {
326 $from = t3lib_utility_Mail::getSystemFrom();
327 /** @var $mail t3lib_mail_Message */
328 $mail = t3lib_div::makeInstance('t3lib_mail_Message');
329 $mail->setTo($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr'])
330 ->setFrom($from)
331 ->setSubject($prefix . ' ' . $subject)
332 ->setBody($msg);
333 $mail->send();
334 }
335 }
336
337 // If An email should be sent to the current user, do that:
338 if ($this->uc['emailMeAtLogin'] && strstr($this->user['email'], '@')) {
339 $from = t3lib_utility_Mail::getSystemFrom();
340 /** @var $mail t3lib_mail_Message */
341 $mail = t3lib_div::makeInstance('t3lib_mail_Message');
342 $mail->setTo($this->user['email'])
343 ->setFrom($from)
344 ->setSubject($subject)
345 ->setBody($msg);
346 $mail->send();
347 }
348 }
349 }
350
351 /**
352 * Determines whether a backend user is allowed to access the backend.
353 *
354 * The conditions are:
355 * + backend user is a regular user and adminOnly is not defined
356 * + backend user is an admin user
357 * + backend user is used in CLI context and adminOnly is explicitely set to "2"
358 *
359 * @return boolean Whether a backend user is allowed to access the backend
360 */
361 protected function isUserAllowedToLogin() {
362 $isUserAllowedToLogin = FALSE;
363 $adminOnlyMode = $GLOBALS['TYPO3_CONF_VARS']['BE']['adminOnly'];
364
365 // Backend user is allowed if adminOnly is not set or user is an admin:
366 if (!$adminOnlyMode || $this->isAdmin()) {
367 $isUserAllowedToLogin = TRUE;
368 // Backend user is allowed if adminOnly is set to 2 (CLI) and a CLI process is running:
369 } elseif ($adminOnlyMode == 2 && (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI)) {
370 $isUserAllowedToLogin = TRUE;
371 }
372
373 return $isUserAllowedToLogin;
374 }
375
376 /**
377 * Logs out the current user and clears the form protection tokens.
378 */
379 public function logoff() {
380 if (isset($GLOBALS['BE_USER'])) {
381 t3lib_formProtection_Factory::get()->clean();
382 }
383 parent::logoff();
384 }
385 }
386
387
388 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php'])) {
389 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']);
390 }
391
392 ?>