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