Added $Id$ keywords, cleaned up comment tags
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_beuserauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2003 Kasper Skaarhoj (kasper@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 Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasper@typo3.com>
34 * @internal
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 75: class t3lib_beUserAuth extends t3lib_userAuthGroup
42 * 149: function trackBeUser($flag)
43 * 162: function checkLockToIP()
44 * 182: function backendCheckLogin()
45 * 207: function backendSetUC()
46 * 242: function overrideUC()
47 * 252: function resetUC()
48 * 265: function emailAtLogin()
49 * 317: function veriCode()
50 *
51 * TOTAL FUNCTIONS: 8
52 * (This index is automatically created/updated by the extension "extdeveval")
53 *
54 */
55
56
57
58
59
60
61
62
63
64
65 /**
66 * TYPO3 user authentication, backend
67 * Could technically have been the same class as t3lib_userauthgroup since these two are always used together and only together.
68 * 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.
69 * This class contains the configuration of the database fields used plus some functions for the authentication process of backend users.
70 *
71 * @author Kasper Skaarhoj <kasper@typo3.com>
72 * @package TYPO3
73 * @subpackage t3lib
74 */
75 class t3lib_beUserAuth extends t3lib_userAuthGroup {
76 var $session_table = 'be_sessions'; // Table to use for session data.
77 var $name = 'be_typo_user'; // Session/Cookie name
78
79 var $user_table = 'be_users'; // Table in database with userdata
80 var $username_column = 'username'; // Column for login-name
81 var $userident_column = 'password'; // Column for password
82 var $userid_column = 'uid'; // Column for user-id
83 var $lastLogin_column = 'lastlogin';
84 var $notifyHeader = 'From: TYPO3 Login notify <no_reply@no_reply.no_reply>';
85
86 var $enablecolumns = Array (
87 'rootLevel' => 1,
88 'deleted' => 'deleted',
89 'disabled' => 'disable',
90 'starttime' => 'starttime',
91 'endtime' => 'endtime'
92 );
93
94 var $formfield_uname = 'username'; // formfield with login-name
95 var $formfield_uident = 'userident'; // formfield with password
96 var $formfield_chalvalue = 'challenge'; // formfield with a unique value which is used to encrypt the password and username
97 var $formfield_status = 'login_status'; // formfield with status: *'login', 'logout'
98 var $security_level = 'challenged'; // sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
99
100 var $writeStdLog = 1; // Decides if the writelog() function is called at login and logout
101 var $writeAttemptLog = 1; // If the writelog() functions is called if a login-attempt has be tried without success
102
103 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.
104
105 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.
106 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.
107
108
109
110 // User Config:
111 var $uc;
112
113 // User Config Default values:
114 /*
115 Reserved keys for other storage of session data:
116 moduleData
117 moduleSessionID
118 */
119 var $uc_default = Array (
120 // 'lang' => 'dk', // this value will be transferred from $BE_USER->user[lang] if not set...
121 'interfaceSetup' => '', // serialized content that is used to store interface pane and menu positions. Set by the logout.php-script
122 'moduleData' => Array(), // user-data for the modules
123 'thumbnailsByDefault' => 0,
124 'emailMeAtLogin' => 0,
125 'condensedMode' => 0,
126 'noMenuMode' => 0,
127 'startInTaskCenter' => 0,
128 'localFrameEdit' => 0,
129 'dontEditInPageModule' => 0,
130 'hideSubmoduleIcons' => 0,
131 'helpText' => 1,
132 'titleLen' => 30,
133 'edit_wideDocument' => '0',
134 'edit_showFieldHelp' => 'icon',
135 'edit_RTE' => '1',
136 'edit_docModuleUpload' => '1',
137 'disableCMlayers' => 0,
138 'navFrameWidth' => '', // Default is 245 pixels
139 );
140
141
142 /**
143 * 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...
144 *
145 * @param boolean
146 * @return void
147 * @access private
148 */
149 function trackBeUser($flag) {
150 if ($flag && t3lib_extMgm::isLoaded('beuser_tracking')) {
151 $query = 'INSERT INTO sys_trackbeuser (userid,tstamp,script) VALUES ('.$this->user['uid'].','.time().',"'.addslashes(t3lib_div::getIndpEnv('REQUEST_URI')).'")';
152 $res = mysql(TYPO3_db,$query);
153 }
154 }
155
156 /**
157 * 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)
158 *
159 * @return boolean True, if IP address validates OK (or no check is done at all)
160 * @access private
161 */
162 function checkLockToIP() {
163 global $TYPO3_CONF_VARS;
164 $out=1;
165 if ($TYPO3_CONF_VARS['BE']['enabledBeUserIPLock']) {
166 $IPList = $this->getTSConfigVal('options.lockToIP');
167 if (trim($IPList)) {
168 $baseIP = t3lib_div::getIndpEnv('REMOTE_ADDR');
169 $out=t3lib_div::cmpIP($baseIP, $IPList);
170 }
171 }
172 return $out;
173 }
174
175 /**
176 * 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.
177 * 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.
178 * This function is called right after ->start() in fx. init.php
179 *
180 * @return void
181 */
182 function backendCheckLogin() {
183 if (!$this->user['uid']) {
184 if (!defined('TYPO3_PROCEED_IF_NO_USER') || !TYPO3_PROCEED_IF_NO_USER) {
185 t3lib_BEfunc::typo3PrintError ('Login-error','No user logged in! Sorry, I can\'t proceed then!<br /><br />(You must have cookies enabled!)',0);
186 exit;
187 }
188 } else { // ...and if that's the case, call these functions
189 $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
190 if ($this->checkLockToIP()) {
191 $this->backendSetUC(); // Setting the UC array. It's needed with fetchGroupData first, due to default/overriding of values.
192 $this->emailAtLogin(); // email at login - if option set.
193 } else {
194 t3lib_BEfunc::typo3PrintError ('Login-error','IP locking prevented you from being authorized. Can\'t proceed, sorry.',0);
195 exit;
196 }
197 }
198 }
199
200 /**
201 * Initialize the internal ->uc array for the backend user
202 * Will make the overrides if necessary, and write the UC back to the be_users record if changes has happend
203 *
204 * @return void
205 * @internal
206 */
207 function backendSetUC() {
208 // UC - user configuration is a serialized array inside the userobject
209 $temp_theSavedUC=unserialize($this->user['uc']); // if there is a saved uc we implement that instead of the default one.
210 if (is_array($temp_theSavedUC)) {
211 $this->unpack_uc($temp_theSavedUC);
212 }
213 // Setting defaults if uc is empty
214 if (!is_array($this->uc)) {
215 $this->uc = array_merge($this->uc_default,$TYPO3_CONF_VARS['BE']['defaultUC'],$this->getTSConfigProp('setup.default')); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
216 $this->overrideUC();
217 $U=1;
218 }
219 // If TSconfig is updated, update the defaultUC.
220 if ($this->userTSUpdated) {
221 $this->overrideUC();
222 $U=1;
223 }
224 // Setting default lang from be_user record.
225 if (!isset($this->uc['lang'])) {
226 $this->uc['lang']=$this->user['lang'];
227 $U=1;
228 }
229 // Saving if updated.
230 if ($U) {
231 $this->writeUC(); // Method from the t3lib_userauth class.
232 }
233 }
234
235 /**
236 * Override: Call this function every time the uc is updated.
237 * That is 1) by reverting to default values, 2) in the setup-module, 3) userTS changes (userauthgroup)
238 *
239 * @return void
240 * @internal
241 */
242 function overrideUC() {
243 $this->uc = array_merge($this->uc,$this->getTSConfigProp('setup.override')); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble...
244 }
245
246 /**
247 * Clears the user[uc] and ->uc to blank strings. Then calls ->backendSetUC() to fill it again with reset contents
248 *
249 * @return void
250 * @internal
251 */
252 function resetUC() {
253 $this->user['uc']='';
254 $this->uc='';
255 $this->backendSetUC();
256 }
257
258 /**
259 * Will send an email notification to warning_email_address/the login users email address when a login session is just started.
260 * Depends on various parameters whether mails are send and to whom.
261 *
262 * @return void
263 * @access private
264 */
265 function emailAtLogin() {
266 if ($this->loginSessionStarted) {
267 // Send notify-mail
268 $subject = 'At "'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].'"'.
269 ' from '.t3lib_div::getIndpEnv('REMOTE_ADDR').
270 (t3lib_div::getIndpEnv('REMOTE_HOST') ? ' ('.t3lib_div::getIndpEnv('REMOTE_HOST').')' : '');
271 $msg = sprintf ('User "%s" logged in from %s (%s) at "%s" (%s)',
272 $this->user['username'],
273 t3lib_div::getIndpEnv('REMOTE_ADDR'),
274 t3lib_div::getIndpEnv('REMOTE_HOST'),
275 $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'],
276 t3lib_div::getIndpEnv('HTTP_HOST')
277 );
278
279 // Warning email address
280 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr']) {
281 $warn=0;
282 $prefix='';
283 if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 1) { // first bit: All logins
284 $warn=1;
285 $prefix= $this->isAdmin() ? '[AdminLoginWarning]' : '[LoginWarning]';
286 }
287 if ($this->isAdmin() && (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_mode']) & 2)) { // second bit: Only admin-logins
288 $warn=1;
289 $prefix='[AdminLoginWarning]';
290 }
291 if ($warn) {
292 mail($GLOBALS['TYPO3_CONF_VARS']['BE']['warning_email_addr'],
293 $prefix.' '.$subject,
294 $msg,
295 $this->notifyHeader
296 );
297 }
298 }
299
300 // If An email should be sent to the current user, do that:
301 if ($this->uc['emailMeAtLogin'] && strstr($this->user['email'],'@')) {
302 mail($this->user['email'],
303 $subject,
304 $msg,
305 $this->notifyHeader
306 );
307 }
308 }
309 }
310
311 /**
312 * VeriCode returns 10 first chars of a md5 hash of the session cookie AND the encryptionKey from TYPO3_CONF_VARS.
313 * This code is used as an alternative verification when the JavaScript interface executes cmd's to tce_db.php from eg. MSIE 5.0 because the proper referer is not passed with this browser...
314 *
315 * @return string
316 */
317 function veriCode() {
318 return substr(md5($this->id.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']),0,10);
319 }
320 }
321
322
323
324
325 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']) {
326 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_beuserauth.php']);
327 }
328 ?>