Fixed bug #17133: Pagetree - qtip can be used to execute custom javascript (XSS)...
[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 var $notifyHeader = 'From: TYPO3 Login notify <no_reply@no_reply.no_reply>';
78
79 var $enablecolumns = Array(
80 'rootLevel' => 1,
81 'deleted' => 'deleted',
82 'disabled' => 'disable',
83 'starttime' => 'starttime',
84 'endtime' => 'endtime'
85 );
86
87 var $formfield_uname = 'username'; // formfield with login-name
88 var $formfield_uident = 'userident'; // formfield with password
89 var $formfield_chalvalue = 'challenge'; // formfield with a unique value which is used to encrypt the password and username
90 var $formfield_status = 'login_status'; // formfield with status: *'login', 'logout'
91
92 var $writeStdLog = 1; // Decides if the writelog() function is called at login and logout
93 var $writeAttemptLog = 1; // If the writelog() functions is called if a login-attempt has be tried without success
94
95 var $auth_include = ''; // this is the name of the include-file containing the login form. If not set, login CAN be anonymous. If set login IS needed.
96
97 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.
98 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.
99 var $challengeStoredInCookie = TRUE;
100
101
102 // User Config:
103 var $uc;
104
105 // User Config Default values:
106 // The array may contain other fields for configuration. For this, see "setup" extension and "TSConfig" document (User TSconfig, "setup.[xxx]....")
107 /*
108 Reserved keys for other storage of session data:
109 moduleData
110 moduleSessionID
111 */
112 var $uc_default = Array(
113 'interfaceSetup' => '', // serialized content that is used to store interface pane and menu positions. Set by the logout.php-script
114 'moduleData' => Array(), // user-data for the modules
115 'thumbnailsByDefault' => 0,
116 'emailMeAtLogin' => 0,
117 'condensedMode' => 0,
118 'noMenuMode' => 0,
119 'startModule' => 'help_aboutmodules',
120 'hideSubmoduleIcons' => 0,
121 'helpText' => 1,
122 'titleLen' => 30,
123 'edit_wideDocument' => '0',
124 'edit_showFieldHelp' => 'icon',
125 'edit_RTE' => '1',
126 'edit_docModuleUpload' => '1',
127 'enableFlashUploader' => '1',
128 'disableCMlayers' => 0,
129 'navFrameWidth' => '', // Default is 245 pixels
130 'navFrameResizable' => 0,
131 'resizeTextareas' => 1,
132 'resizeTextareas_MaxHeight' => 300,
133 'resizeTextareas_Flexible' => 1,
134 );
135
136
137 /**
138 * Sets the security level for the Backend login
139 *
140 * @return void
141 */
142 function start() {
143 $securityLevel = trim($GLOBALS['TYPO3_CONF_VARS']['BE']['loginSecurityLevel']);
144 $this->security_level = $securityLevel ? $securityLevel : 'superchallenged';
145
146 parent::start();
147 }
148
149 /**
150 * If flag is set and the extensions 'beuser_tracking' is loaded, this will insert a table row with the REQUEST_URI of current script - thus tracking the scripts the backend users uses...
151 * This function works ONLY with the "beuser_tracking" extension and is deprecated since it does nothing useful.
152 *
153 * @param boolean Activate insertion of the URL.
154 * @return void
155 * @deprecated since TYPO3 3.6, this function will be removed in TYPO3 4.6.
156 */
157 function trackBeUser($flag) {
158 t3lib_div::logDeprecatedFunction();
159
160 if ($flag && t3lib_extMgm::isLoaded('beuser_tracking')) {
161 $insertFields = array(
162 'userid' => intval($this->user['uid']),
163 'tstamp' => $GLOBALS['EXEC_TIME'],
164 'script' => t3lib_div::getIndpEnv('REQUEST_URI')
165 );
166
167 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_trackbeuser', $insertFields);
168 }
169 }
170
171 /**
172 * 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)
173 *
174 * @return boolean True, if IP address validates OK (or no check is done at all)
175 * @access private
176 */
177 function checkLockToIP() {
178 global $TYPO3_CONF_VARS;
179 $out = 1;
180 if ($TYPO3_CONF_VARS['BE']['enabledBeUserIPLock']) {
181 $IPList = $this->getTSConfigVal('options.lockToIP');
182 if (trim($IPList)) {
183 $baseIP = t3lib_div::getIndpEnv('REMOTE_ADDR');
184 $out = t3lib_div::cmpIP($baseIP, $IPList);
185 }
186 }
187 return $out;
188 }
189
190 /**
191 * 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.
192 * 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.
193 * This function is called right after ->start() in fx. init.php
194 *
195 * @return void
196 */
197 function backendCheckLogin() {
198 if (!$this->user['uid']) {
199 if (!defined('TYPO3_PROCEED_IF_NO_USER') || !TYPO3_PROCEED_IF_NO_USER) {
200 t3lib_utility_Http::redirect($GLOBALS['BACK_PATH']);
201 }
202 } else { // ...and if that's the case, call these functions
203 $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
204 if ($this->checkLockToIP()) {
205 if ($this->isUserAllowedToLogin()) {
206 $this->backendSetUC(); // Setting the UC array. It's needed with fetchGroupData first, due to default/overriding of values.
207 $this->emailAtLogin(); // email at login - if option set.
208 } else {
209 throw new RuntimeException('Login Error: TYPO3 is in maintenance mode at the moment. Only administrators are allowed access.');
210 }
211 } else {
212 throw new RuntimeException('Login Error: IP locking prevented you from being authorized. Can\'t proceed, sorry.');
213 }
214 }
215 }
216
217 /**
218 * If the backend script is in CLI mode, it will try to load a backend user named by the CLI module name (in lowercase)
219 *
220 * @return boolean Returns true if a CLI user was loaded, otherwise false!
221 */
222 function checkCLIuser() {
223 // First, check if cliMode is enabled:
224 if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI) {
225 if (!$this->user['uid']) {
226 if (substr($GLOBALS['MCONF']['name'], 0, 5) == '_CLI_') {
227 $userName = strtolower($GLOBALS['MCONF']['name']);
228 $this->setBeUserByName($userName);
229 if ($this->user['uid']) {
230 if (!$this->isAdmin()) {
231 return TRUE;
232 } else {
233 die('ERROR: CLI backend user "' . $userName . '" was ADMIN which is not allowed!' . LF . LF);
234 }
235 } else {
236 die('ERROR: No backend user named "' . $userName . '" was found! [Database: ' . TYPO3_db . ']' . LF . LF);
237 }
238 } else {
239 die('ERROR: Module name, "' . $GLOBALS['MCONF']['name'] . '", was not prefixed with "_CLI_"' . LF . LF);
240 }
241 } else {
242 die('ERROR: Another user was already loaded which is impossible in CLI mode!' . LF . LF);
243 }
244 }
245 }
246
247 /**
248 * Initialize the internal ->uc array for the backend user
249 * Will make the overrides if necessary, and write the UC back to the be_users record if changes has happend
250 *
251 * @return void
252 * @internal
253 */
254 function backendSetUC() {
255 global $TYPO3_CONF_VARS;
256
257 // UC - user configuration is a serialized array inside the userobject
258 $temp_theSavedUC = unserialize($this->user['uc']); // if there is a saved uc we implement that instead of the default one.
259 if (is_array($temp_theSavedUC)) {
260 $this->unpack_uc($temp_theSavedUC);
261 }
262 // Setting defaults if uc is empty
263 if (!is_array($this->uc)) {
264 $this->uc = array_merge(
265 $this->uc_default,
266 (array) $TYPO3_CONF_VARS['BE']['defaultUC'],
267 t3lib_div::removeDotsFromTS((array) $this->getTSConfigProp('setup.default'))
268 );
269 $this->overrideUC();
270 $U = 1;
271 }
272 // If TSconfig is updated, update the defaultUC.
273 if ($this->userTSUpdated) {
274 $this->overrideUC();
275 $U = 1;
276 }
277 // Setting default lang from be_user record.
278 if (!isset($this->uc['lang'])) {
279 $this->uc['lang'] = $this->user['lang'];
280 $U = 1;
281 }
282 // Setting the time of the first login:
283 if (!isset($this->uc['firstLoginTimeStamp'])) {
284 $this->uc['firstLoginTimeStamp'] = $GLOBALS['EXEC_TIME'];
285 $U = TRUE;
286 }
287
288 // Saving if updated.
289 if ($U) {
290 $this->writeUC(); // Method from the t3lib_userauth class.
291 }
292 }
293
294 /**
295 * Override: Call this function every time the uc is updated.
296 * That is 1) by reverting to default values, 2) in the setup-module, 3) userTS changes (userauthgroup)
297 *
298 * @return void
299 * @internal
300 */
301 function overrideUC() {
302 $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...
303 }
304
305 /**
306 * Clears the user[uc] and ->uc to blank strings. Then calls ->backendSetUC() to fill it again with reset contents
307 *
308 * @return void
309 * @internal
310 */
311 function resetUC() {
312 $this->user['uc'] = '';
313 $this->uc = '';
314 $this->backendSetUC();
315 }
316
317 /**
318 * Will send an email notification to warning_email_address/the login users email address when a login session is just started.
319 * Depends on various parameters whether mails are send and to whom.
320 *
321 * @return void
322 * @access private
323 */
324 function emailAtLogin() {
325 if ($this->loginSessionStarted) {
326 // Send notify-mail
327 $subject = 'At "' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '"' .
328 ' from ' . t3lib_div::getIndpEnv('REMOTE_ADDR') .
329 (t3lib_div::getIndpEnv('REMOTE_HOST') ? ' (' . t3lib_div::getIndpEnv('REMOTE_HOST') . ')' : '');
330 $msg = sprintf('User "%s" logged in from %s (%s) at "%s" (%s)',
331 $this->user['username'],
332 t3lib_div::getIndpEnv('REMOTE_ADDR'),
333 t3lib_div::getIndpEnv('REMOTE_HOST'),
334 $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'],
335 t3lib_div::getIndpEnv('HTTP_HOST')
336 );
337
338 // Warning email address
339 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr']) {
340 $warn = 0;
341 $prefix = '';
342 if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 1) { // first bit: All logins
343 $warn = 1;
344 $prefix = $this->isAdmin() ? '[AdminLoginWarning]' : '[LoginWarning]';
345 }
346 if ($this->isAdmin() && (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 2)) { // second bit: Only admin-logins
347 $warn = 1;
348 $prefix = '[AdminLoginWarning]';
349 }
350 if ($warn) {
351 t3lib_utility_Mail::mail($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr'],
352 $prefix . ' ' . $subject,
353 $msg,
354 $this->notifyHeader
355 );
356 }
357 }
358
359 // If An email should be sent to the current user, do that:
360 if ($this->uc['emailMeAtLogin'] && strstr($this->user['email'], '@')) {
361 t3lib_utility_Mail::mail($this->user['email'],
362 $subject,
363 $msg,
364 $this->notifyHeader
365 );
366 }
367 }
368 }
369
370 /**
371 * Determines whether a backend user is allowed to access the backend.
372 *
373 * The conditions are:
374 * + backend user is a regular user and adminOnly is not defined
375 * + backend user is an admin user
376 * + backend user is used in CLI context and adminOnly is explicitely set to "2"
377 *
378 * @return boolean Whether a backend user is allowed to access the backend
379 */
380 protected function isUserAllowedToLogin() {
381 $isUserAllowedToLogin = FALSE;
382 $adminOnlyMode = $GLOBALS['TYPO3_CONF_VARS']['BE']['adminOnly'];
383
384 // Backend user is allowed if adminOnly is not set or user is an admin:
385 if (!$adminOnlyMode || $this->isAdmin()) {
386 $isUserAllowedToLogin = TRUE;
387 // Backend user is allowed if adminOnly is set to 2 (CLI) and a CLI process is running:
388 } elseif ($adminOnlyMode == 2 && (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI)) {
389 $isUserAllowedToLogin = TRUE;
390 }
391
392 return $isUserAllowedToLogin;
393 }
394
395 /**
396 * Logs out the current user and clears the form protection tokens.
397 */
398 public function logoff() {
399 if (isset($GLOBALS['BE_USER'])) {
400 t3lib_formProtection_Factory::get(
401 't3lib_formprotection_BackendFormProtection'
402 )->clean();
403 }
404 parent::logoff();
405 }
406 }
407
408
409 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php'])) {
410 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']);
411 }
412
413 ?>