[TASK] Remove function index
[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 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
31 *
32 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
33 * @internal
34 */
35
36
37 /**
38 * TYPO3 user authentication, backend
39 * Could technically have been the same class as t3lib_userauthgroup since these two are always used together and only together.
40 * 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.
41 * This class contains the configuration of the database fields used plus some functions for the authentication process of backend users.
42 *
43 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
44 * @package TYPO3
45 * @subpackage t3lib
46 */
47 class t3lib_beUserAuth extends t3lib_userAuthGroup {
48 var $session_table = 'be_sessions'; // Table to use for session data.
49
50 var $user_table = 'be_users'; // Table in database with userdata
51 var $username_column = 'username'; // Column for login-name
52 var $userident_column = 'password'; // Column for password
53 var $userid_column = 'uid'; // Column for user-id
54 var $lastLogin_column = 'lastlogin';
55
56 var $enablecolumns = Array(
57 'rootLevel' => 1,
58 'deleted' => 'deleted',
59 'disabled' => 'disable',
60 'starttime' => 'starttime',
61 'endtime' => 'endtime'
62 );
63
64 var $formfield_uname = 'username'; // formfield with login-name
65 var $formfield_uident = 'userident'; // formfield with password
66 var $formfield_chalvalue = 'challenge'; // formfield with a unique value which is used to encrypt the password and username
67 var $formfield_status = 'login_status'; // formfield with status: *'login', 'logout'
68
69 var $writeStdLog = 1; // Decides if the writelog() function is called at login and logout
70 var $writeAttemptLog = 1; // If the writelog() functions is called if a login-attempt has be tried without success
71
72 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.
73 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.
74 var $challengeStoredInCookie = TRUE;
75
76
77 // User Config:
78 var $uc;
79
80 // User Config Default values:
81 // The array may contain other fields for configuration. For this, see "setup" extension and "TSConfig" document (User TSconfig, "setup.[xxx]....")
82 /*
83 Reserved keys for other storage of session data:
84 moduleData
85 moduleSessionID
86 */
87 var $uc_default = Array(
88 'interfaceSetup' => '', // serialized content that is used to store interface pane and menu positions. Set by the logout.php-script
89 'moduleData' => Array(), // user-data for the modules
90 'thumbnailsByDefault' => 0,
91 'emailMeAtLogin' => 0,
92 'condensedMode' => 0,
93 'noMenuMode' => 0,
94 'startModule' => 'help_aboutmodules',
95 'hideSubmoduleIcons' => 0,
96 'helpText' => 1,
97 'titleLen' => 30,
98 'edit_wideDocument' => '0',
99 'edit_showFieldHelp' => 'icon',
100 'edit_RTE' => '1',
101 'edit_docModuleUpload' => '1',
102 'enableFlashUploader' => '1',
103 'disableCMlayers' => 0,
104 'navFrameWidth' => '', // Default is 245 pixels
105 'navFrameResizable' => 0,
106 'resizeTextareas' => 1,
107 'resizeTextareas_MaxHeight' => 300,
108 'resizeTextareas_Flexible' => 1,
109 );
110
111 /**
112 * Constructor
113 */
114 public function __construct() {
115 $this->name = self::getCookieName();
116 $this->loginType = 'BE';
117 }
118
119 /**
120 * @static
121 * @return string
122 *
123 * returns the configured cookie name
124 */
125 public static function getCookieName() {
126 $configuredCookieName = trim($GLOBALS['TYPO3_CONF_VARS']['BE']['cookieName']);
127 if (empty($configuredCookieName)) {
128 $configuredCookieName = 'be_typo_user';
129 }
130 return $configuredCookieName;
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 $out = 1;
154 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['enabledBeUserIPLock']) {
155 $IPList = $this->getTSConfigVal('options.lockToIP');
156 if (trim($IPList)) {
157 $baseIP = t3lib_div::getIndpEnv('REMOTE_ADDR');
158 $out = t3lib_div::cmpIP($baseIP, $IPList);
159 }
160 }
161 return $out;
162 }
163
164 /**
165 * 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.
166 * 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.
167 * This function is called right after ->start() in fx. init.php
168 *
169 * @return void
170 */
171 function backendCheckLogin() {
172 if (!$this->user['uid']) {
173 if (!defined('TYPO3_PROCEED_IF_NO_USER') || !TYPO3_PROCEED_IF_NO_USER) {
174 t3lib_utility_Http::redirect($GLOBALS['BACK_PATH']);
175 }
176 } else { // ...and if that's the case, call these functions
177 $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
178 if ($this->checkLockToIP()) {
179 if ($this->isUserAllowedToLogin()) {
180 $this->backendSetUC(); // Setting the UC array. It's needed with fetchGroupData first, due to default/overriding of values.
181 $this->emailAtLogin(); // email at login - if option set.
182 } else {
183 throw new RuntimeException('Login Error: TYPO3 is in maintenance mode at the moment. Only administrators are allowed access.', 1294585860);
184 }
185 } else {
186 throw new RuntimeException('Login Error: IP locking prevented you from being authorized. Can\'t proceed, sorry.', 1294585861);
187 }
188 }
189 }
190
191 /**
192 * If the backend script is in CLI mode, it will try to load a backend user named by the CLI module name (in lowercase)
193 *
194 * @return boolean Returns TRUE if a CLI user was loaded, otherwise FALSE!
195 */
196 function checkCLIuser() {
197 // First, check if cliMode is enabled:
198 if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI) {
199 if (!$this->user['uid']) {
200 if (substr($GLOBALS['MCONF']['name'], 0, 5) == '_CLI_') {
201 $userName = strtolower($GLOBALS['MCONF']['name']);
202 $this->setBeUserByName($userName);
203 if ($this->user['uid']) {
204 if (!$this->isAdmin()) {
205 return TRUE;
206 } else {
207 die('ERROR: CLI backend user "' . $userName . '" was ADMIN which is not allowed!' . LF . LF);
208 }
209 } else {
210 die('ERROR: No backend user named "' . $userName . '" was found! [Database: ' . TYPO3_db . ']' . LF . LF);
211 }
212 } else {
213 die('ERROR: Module name, "' . $GLOBALS['MCONF']['name'] . '", was not prefixed with "_CLI_"' . LF . LF);
214 }
215 } else {
216 die('ERROR: Another user was already loaded which is impossible in CLI mode!' . LF . LF);
217 }
218 }
219 }
220
221 /**
222 * Initialize the internal ->uc array for the backend user
223 * Will make the overrides if necessary, and write the UC back to the be_users record if changes has happend
224 *
225 * @return void
226 * @internal
227 */
228 function backendSetUC() {
229 // UC - user configuration is a serialized array inside the userobject
230 $temp_theSavedUC = unserialize($this->user['uc']); // if there is a saved uc we implement that instead of the default one.
231 if (is_array($temp_theSavedUC)) {
232 $this->unpack_uc($temp_theSavedUC);
233 }
234 // Setting defaults if uc is empty
235 if (!is_array($this->uc)) {
236 $this->uc = array_merge(
237 $this->uc_default,
238 (array) $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUC'],
239 t3lib_div::removeDotsFromTS((array) $this->getTSConfigProp('setup.default'))
240 );
241 $this->overrideUC();
242 $U = 1;
243 }
244 // If TSconfig is updated, update the defaultUC.
245 if ($this->userTSUpdated) {
246 $this->overrideUC();
247 $U = 1;
248 }
249 // Setting default lang from be_user record.
250 if (!isset($this->uc['lang'])) {
251 $this->uc['lang'] = $this->user['lang'];
252 $U = 1;
253 }
254 // Setting the time of the first login:
255 if (!isset($this->uc['firstLoginTimeStamp'])) {
256 $this->uc['firstLoginTimeStamp'] = $GLOBALS['EXEC_TIME'];
257 $U = TRUE;
258 }
259
260 // Saving if updated.
261 if ($U) {
262 $this->writeUC(); // Method from the t3lib_userauth class.
263 }
264 }
265
266 /**
267 * Override: Call this function every time the uc is updated.
268 * That is 1) by reverting to default values, 2) in the setup-module, 3) userTS changes (userauthgroup)
269 *
270 * @return void
271 * @internal
272 */
273 function overrideUC() {
274 $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...
275 }
276
277 /**
278 * Clears the user[uc] and ->uc to blank strings. Then calls ->backendSetUC() to fill it again with reset contents
279 *
280 * @return void
281 * @internal
282 */
283 function resetUC() {
284 $this->user['uc'] = '';
285 $this->uc = '';
286 $this->backendSetUC();
287 }
288
289 /**
290 * Will send an email notification to warning_email_address/the login users email address when a login session is just started.
291 * Depends on various parameters whether mails are send and to whom.
292 *
293 * @return void
294 * @access private
295 */
296 function emailAtLogin() {
297 if ($this->loginSessionStarted) {
298 // Send notify-mail
299 $subject = 'At "' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '"' .
300 ' from ' . t3lib_div::getIndpEnv('REMOTE_ADDR') .
301 (t3lib_div::getIndpEnv('REMOTE_HOST') ? ' (' . t3lib_div::getIndpEnv('REMOTE_HOST') . ')' : '');
302 $msg = sprintf('User "%s" logged in from %s (%s) at "%s" (%s)',
303 $this->user['username'],
304 t3lib_div::getIndpEnv('REMOTE_ADDR'),
305 t3lib_div::getIndpEnv('REMOTE_HOST'),
306 $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'],
307 t3lib_div::getIndpEnv('HTTP_HOST')
308 );
309
310 // Warning email address
311 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr']) {
312 $warn = 0;
313 $prefix = '';
314 if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 1) { // first bit: All logins
315 $warn = 1;
316 $prefix = $this->isAdmin() ? '[AdminLoginWarning]' : '[LoginWarning]';
317 }
318 if ($this->isAdmin() && (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 2)) { // second bit: Only admin-logins
319 $warn = 1;
320 $prefix = '[AdminLoginWarning]';
321 }
322 if ($warn) {
323 $from = t3lib_utility_Mail::getSystemFrom();
324 /** @var $mail t3lib_mail_Message */
325 $mail = t3lib_div::makeInstance('t3lib_mail_Message');
326 $mail->setTo($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr'])
327 ->setFrom($from)
328 ->setSubject($prefix . ' ' . $subject)
329 ->setBody($msg);
330 $mail->send();
331 }
332 }
333
334 // If An email should be sent to the current user, do that:
335 if ($this->uc['emailMeAtLogin'] && strstr($this->user['email'], '@')) {
336 $from = t3lib_utility_Mail::getSystemFrom();
337 /** @var $mail t3lib_mail_Message */
338 $mail = t3lib_div::makeInstance('t3lib_mail_Message');
339 $mail->setTo($this->user['email'])
340 ->setFrom($from)
341 ->setSubject($subject)
342 ->setBody($msg);
343 $mail->send();
344 }
345 }
346 }
347
348 /**
349 * Determines whether a backend user is allowed to access the backend.
350 *
351 * The conditions are:
352 * + backend user is a regular user and adminOnly is not defined
353 * + backend user is an admin user
354 * + backend user is used in CLI context and adminOnly is explicitely set to "2"
355 *
356 * @return boolean Whether a backend user is allowed to access the backend
357 */
358 protected function isUserAllowedToLogin() {
359 $isUserAllowedToLogin = FALSE;
360 $adminOnlyMode = $GLOBALS['TYPO3_CONF_VARS']['BE']['adminOnly'];
361
362 // Backend user is allowed if adminOnly is not set or user is an admin:
363 if (!$adminOnlyMode || $this->isAdmin()) {
364 $isUserAllowedToLogin = TRUE;
365 // Backend user is allowed if adminOnly is set to 2 (CLI) and a CLI process is running:
366 } elseif ($adminOnlyMode == 2 && (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_CLI)) {
367 $isUserAllowedToLogin = TRUE;
368 }
369
370 return $isUserAllowedToLogin;
371 }
372
373 /**
374 * Logs out the current user and clears the form protection tokens.
375 */
376 public function logoff() {
377 if (isset($GLOBALS['BE_USER'])) {
378 t3lib_formProtection_Factory::get()->clean();
379 }
380 parent::logoff();
381 }
382 }
383
384
385 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php'])) {
386 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']);
387 }
388
389 ?>