Added comment to SECURE_ONLY constant.
[fa-stable.git] / includes / session.inc
1 <?php
2 /**********************************************************************
3         Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU General Public License, GPL,
5         as published by the Free Software Foundation, either version 3
6         of the License, or (at your option) any later version.
7         This program is distributed in the hope that it will be useful,
8         but WITHOUT ANY WARRANTY; without even the implied warranty of
9         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10         See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12 define('VARLIB_PATH', $path_to_root.'/tmp');
13 define('VARLOG_PATH', $path_to_root.'/tmp');
14 define('SECURE_ONLY', true); // if you really need also http (unsecure) access allowed, you can set this to NULL
15
16 class SessionManager
17 {
18         function sessionStart($name, $limit = 0, $path = '/', $domain = null, $secure = null)
19         {
20                 // Set the cookie name
21                 session_name($name);
22
23                 // Set SSL level
24                 $https = isset($secure) ? $secure : (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off');
25
26                 // Set session cookie options
27                 if (version_compare(PHP_VERSION, '5.2', '<')) // avoid failure on older php versions
28                         session_set_cookie_params($limit, $path, $domain, $https);
29                 else
30                         session_set_cookie_params($limit, $path, $domain, $https, true);
31
32                 session_start();
33
34                 // Make sure the session hasn't expired, and destroy it if it has
35                 if ($this->validateSession())
36                 {
37                         // Check to see if the session is new or a hijacking attempt
38                         if(!$this->preventHijacking())
39                         {
40                                 // Reset session data and regenerate id
41                                 $_SESSION = array();
42                                 $_SESSION['IPaddress'] = $_SERVER['REMOTE_ADDR'];
43                                 $_SESSION['userAgent'] = @$_SERVER['HTTP_USER_AGENT'];
44                                 $this->regenerateSession();
45
46                         // Give a 5% chance of the session id changing on any request
47                         }
48                         elseif (rand(1, 100) <= 5)
49                         {
50                                 $this->regenerateSession();
51                         }
52                 }
53                 else
54                 {
55                         $_SESSION = array();
56                         session_destroy();
57                         session_start();
58                 }
59         }
60
61         function preventHijacking()
62         {
63                 if (!isset($_SESSION['IPaddress']) || !isset($_SESSION['userAgent']))
64                         return false;
65
66                 if ($_SESSION['IPaddress'] != $_SERVER['REMOTE_ADDR'])
67                         return false;
68
69                 if ( $_SESSION['userAgent'] != @$_SERVER['HTTP_USER_AGENT'])
70                         return false;
71
72                 return true;
73         }
74
75         function regenerateSession()
76         {
77                 // If this session is obsolete it means there already is a new id
78                 if (isset($_SESSION['OBSOLETE']) && ($_SESSION['OBSOLETE'] == true))
79                         return;
80
81                 // Set current session to expire in 10 seconds
82                 $_SESSION['OBSOLETE'] = true;
83                 $_SESSION['EXPIRES'] = time() + 10;
84
85                 // Create new session without destroying the old one
86                 session_regenerate_id();
87                 // Grab current session ID and close both sessions to allow other scripts to use them
88                 $newSession = session_id();
89                 session_write_close();
90                 // Set session ID to the new one, and start it back up again
91
92                 session_id($newSession);
93                 session_start();
94                 
95                 // Now we unset the obsolete and expiration values for the session we want to keep
96                 unset($_SESSION['OBSOLETE']);
97                 unset($_SESSION['EXPIRES']);
98         }
99
100         function validateSession()
101         {
102                 if (isset($_SESSION['OBSOLETE']) && !isset($_SESSION['EXPIRES']) )
103                         return false;
104
105                 if (isset($_SESSION['EXPIRES']) && $_SESSION['EXPIRES'] < time())
106                         return false;
107
108                 return true;
109         }
110 }
111
112 function output_html($text)
113 {
114         global $before_box, $Ajax, $messages;
115         // Fatal errors are not send to error_handler,
116         // so we must check the output
117         if ($text && preg_match('/\bFatal error(<.*?>)?:(.*)/i', $text, $m)) {
118                 $Ajax->aCommands = array();  // Don't update page via ajax on errors
119                 $text = preg_replace('/\bFatal error(<.*?>)?:(.*)/i','', $text);
120                 $messages[] = array(E_ERROR, $m[2], null, null);
121         }
122         $Ajax->run();
123         return  in_ajax() ? fmt_errors() : ($before_box.fmt_errors().$text);
124 }
125 //----------------------------------------------------------------------------------------
126
127 function kill_login()
128 {
129         session_unset();
130         session_destroy();
131 }
132 //----------------------------------------------------------------------------------------
133
134 function login_fail()
135 {
136         global $path_to_root;
137
138         header("HTTP/1.1 401 Authorization Required");
139         echo "<center><br><br><font size='5' color='red'><b>" . _("Incorrect Password") . "<b></font><br><br>";
140         echo "<b>" . _("The user and password combination is not valid for the system.") . "<b><br><br>";
141         echo _("If you are not an authorized user, please contact your system administrator to obtain an account to enable you to use the system.");
142         echo "<br><a href='$path_to_root/index.php'>" . _("Try again") . "</a>";
143         echo "</center>";
144         kill_login();
145         die();
146 }
147
148 function password_reset_fail()
149 {
150         global $path_to_root;
151         
152         echo "<center><br><br><font size='5' color='red'><b>" . _("Incorrect Email") . "<b></font><br><br>";
153         echo "<b>" . _("The email address does not exist in the system, or is used by more than one user.") . "<b><br><br>";
154
155         echo _("Plase try again or contact your system administrator to obtain new password.");
156         echo "<br><a href='$path_to_root/index.php?reset=1'>" . _("Try again") . "</a>";
157         echo "</center>";
158
159         kill_login();
160         die();
161 }
162
163 function password_reset_success()
164 {
165         global $path_to_root;
166
167         echo "<center><br><br><font size='5' color='green'><b>" . _("New password sent") . "<b></font><br><br>";
168         echo "<b>" . _("A new password has been sent to your mailbox.") . "<b><br><br>";
169
170         echo "<br><a href='$path_to_root/index.php'>" . _("Login here") . "</a>";
171         echo "</center>";
172         
173         kill_login();
174         die();
175 }
176
177 function check_faillog()
178 {
179         global $SysPrefs, $login_faillog;
180
181         $user = $_SESSION["wa_current_user"]->user;
182
183         $_SESSION["wa_current_user"]->login_attempt++;
184         if (@$SysPrefs->login_delay && (@$login_faillog[$user][$_SERVER['REMOTE_ADDR']] >= @$SysPrefs->login_max_attempts) && (time() < $login_faillog[$user]['last'] + $SysPrefs->login_delay))
185                 return true;
186
187         return false;
188 }
189
190 /*
191         Ensure file is re-read on next request if php caching is active
192 */
193 function cache_invalidate($filename)
194 {
195         if (function_exists('opcache_invalidate'))      // OpCode extension
196                 opcache_invalidate($filename);
197 }
198
199 /*
200         Simple brute force attack detection is performed before connection to company database is open. Therefore access counters have to be stored in file.
201         Login attempts counter is created for every new user IP, which partialy prevent DOS attacks.
202 */
203 function write_login_filelog($login, $result)
204 {
205         global $login_faillog, $SysPrefs, $path_to_root;
206
207         $user = $_SESSION["wa_current_user"]->user;
208
209         $ip = $_SERVER['REMOTE_ADDR'];
210
211         if (!isset($login_faillog[$user][$ip]) || $result) // init or reset on successfull login
212                 $login_faillog[$user] = array($ip => 0, 'last' => '');
213
214         if (!$result)
215         {
216                 if ($login_faillog[$user][$ip] < @$SysPrefs->login_max_attempts) {
217
218                         $login_faillog[$user][$ip]++;
219                 } else {
220                         $login_faillog[$user][$ip] = 0; // comment out to restart counter only after successfull login.
221                         error_log(sprintf(_("Brute force attack on account '%s' detected. Access for non-logged users temporarily blocked."     ), $login));
222                 }
223                 $login_faillog[$user]['last'] = time();
224         }
225
226         $msg = "<?php\n";
227         $msg .= "/*\n";
228         $msg .= "Login attempts info.\n";
229         $msg .= "*/\n";
230         $msg .= "\$login_faillog = " .var_export($login_faillog, true). ";\n";
231
232         $filename = VARLIB_PATH."/faillog.php";
233
234         if ((!file_exists($filename) && is_writable(VARLIB_PATH)) || is_writable($filename))
235         {
236                 file_put_contents($filename, $msg);
237                 cache_invalidate($filename);
238         }
239 }
240
241 //----------------------------------------------------------------------------------------
242
243 function check_page_security($page_security)
244 {
245         global $SysPrefs;
246         
247         $msg = '';
248         
249         if (!$_SESSION["wa_current_user"]->check_user_access())
250         {
251                 // notification after upgrade from pre-2.2 version
252                 $msg = $_SESSION["wa_current_user"]->old_db ?
253                          _("Security settings have not been defined for your user account.")
254                                 . "<br>" . _("Please contact your system administrator.")       
255                         : _("Please remove \$security_groups and \$security_headings arrays from config.php file!");
256         } elseif (!$SysPrefs->db_ok && !$_SESSION["wa_current_user"]->can_access('SA_SOFTWAREUPGRADE')) 
257         {
258                 $msg = _('Access to application has been blocked until database upgrade is completed by system administrator.');
259         }
260         
261         if ($msg){
262                 display_error($msg);
263                 end_page(@$_REQUEST['popup']);
264                 kill_login();
265                 exit;
266         }
267
268         if (!$_SESSION["wa_current_user"]->can_access_page($page_security))
269         {
270
271                 echo "<center><br><br><br><b>";
272                 echo _("The security settings on your account do not permit you to access this function");
273                 echo "</b>";
274                 echo "<br><br><br><br></center>";
275                 end_page(@$_REQUEST['popup']);
276                 exit;
277         }
278         if (!$SysPrefs->db_ok 
279                 && !in_array($page_security, array('SA_SOFTWAREUPGRADE', 'SA_OPEN', 'SA_BACKUP')))
280         {
281                 display_error(_('System is blocked after source upgrade until database is updated on System/Software Upgrade page'));
282                 end_page();
283                 exit;
284         }
285
286 }
287 /*
288         Helper function for setting page security level depeding on 
289         GET start variable and/or some value stored in session variable.
290         Before the call $page_security should be set to default page_security value.
291 */
292 function set_page_security($value=null, $trans = array(), $gtrans = array())
293 {
294         global $page_security;
295
296         // first check is this is not start page call
297         foreach($gtrans as $key => $area)
298                 if (isset($_GET[$key])) {
299                         $page_security = $area;
300                         return;
301                 }
302
303         // then check session value
304         if (isset($trans[$value])) {
305                 $page_security = $trans[$value];
306                 return;
307         }
308 }
309
310 //-----------------------------------------------------------------------------
311 //      Removing magic quotes from nested arrays/variables
312 //
313 function strip_quotes($data)
314 {
315         if(version_compare(phpversion(), '5.4', '<') && get_magic_quotes_gpc()) {
316                 if(is_array($data)) {
317                         foreach($data as $k => $v) {
318                                 $data[$k] = strip_quotes($data[$k]);
319                         }
320                 } else
321                         return stripslashes($data);
322         }
323         return $data;
324 }
325
326 /*
327         htmlspecialchars does not support certain encodings.
328         ISO-8859-2 fortunately has the same special characters positions as 
329         ISO-8859-1, so fix is easy. If any other unsupported encoding is used,
330         add workaround here.
331 */
332 function html_specials_encode($str)
333 {
334         return htmlspecialchars($str, ENT_QUOTES, $_SESSION['language']->encoding=='iso-8859-2' ?
335                  'ISO-8859-1' : $_SESSION['language']->encoding);
336 }
337
338 function html_cleanup(&$parms)
339 {
340         foreach($parms as $name => $value) {
341                 if (is_array($value))
342                         html_cleanup($parms[$name]);
343                 else
344                         $parms[$name] = html_specials_encode($value);
345         }
346         reset($parms); // needed for direct key() usage later throughout the sources
347 }
348
349 //============================================================================
350 //
351 //
352 function login_timeout()
353 {
354         // skip timeout on logout page
355         if ($_SESSION["wa_current_user"]->logged) {
356                 $tout = $_SESSION["wa_current_user"]->timeout;
357                 if ($tout && (time() > $_SESSION["wa_current_user"]->last_act + $tout))
358                 {
359                         $_SESSION["wa_current_user"]->logged = false;
360                 }
361                 $_SESSION["wa_current_user"]->last_act = time();
362         }
363 }
364 //============================================================================
365 if (!isset($path_to_root))
366 {
367         $path_to_root = ".";
368 }
369
370 // Prevent register_globals vulnerability
371 if (isset($_GET['path_to_root']) || isset($_POST['path_to_root']))
372         die("Restricted access");
373
374 include_once($path_to_root . "/includes/errors.inc");
375 // colect all error msgs
376 set_error_handler('error_handler' /*, errtypes */);
377 set_exception_handler('exception_handler');
378
379 include_once($path_to_root . "/includes/current_user.inc");
380 include_once($path_to_root . "/frontaccounting.php");
381 include_once($path_to_root . "/admin/db/security_db.inc");
382 include_once($path_to_root . "/includes/lang/language.inc");
383 include_once($path_to_root . "/config_db.php");
384 include_once($path_to_root . "/includes/ajax.inc");
385 include_once($path_to_root . "/includes/ui/ui_msgs.inc");
386 include_once($path_to_root . "/includes/prefs/sysprefs.inc");
387
388 include_once($path_to_root . "/includes/hooks.inc");
389 //
390 // include all extensions hook files.
391 //
392 foreach ($installed_extensions as $ext)
393 {
394         if (file_exists($path_to_root.'/'.$ext['path'].'/hooks.php'))
395                 include_once($path_to_root.'/'.$ext['path'].'/hooks.php');
396 }
397
398 ini_set('session.gc_maxlifetime', 36000); // moved from below.
399
400 $Session_manager = new SessionManager();
401 $Session_manager->sessionStart('FA'.md5(dirname(__FILE__)), 0, '/', null, SECURE_ONLY);
402
403 $_SESSION['SysPrefs'] = new sys_prefs();
404
405 $SysPrefs = &$_SESSION['SysPrefs'];
406
407 //----------------------------------------------------------------------------------------
408 // set to reasonable values if not set in config file (pre-2.3.12 installations)
409
410 if ((!isset($SysPrefs->login_delay)) || ($SysPrefs->login_delay < 0))
411     $SysPrefs->login_delay = 10;
412
413 if ((!isset($SysPrefs->login_max_attempts)) || ($SysPrefs->login_max_attempts < 0))
414     $SysPrefs->login_max_attempts = 3; 
415
416 if ($SysPrefs->go_debug > 0)
417         $cur_error_level = -1;
418 else
419         $cur_error_level = E_USER_WARNING|E_USER_ERROR|E_USER_NOTICE;
420
421 error_reporting($cur_error_level);
422 ini_set("display_errors", "On");
423
424 if ($SysPrefs->error_logfile != '') {
425         ini_set("error_log", $SysPrefs->error_logfile);
426         ini_set("ignore_repeated_errors", "On");
427         ini_set("log_errors", "On");
428 }
429
430 /*
431         Uncomment the setting below when using FA on shared hosting
432         to avoid unexpeced session timeouts.
433         Make sure this directory exists and is writable!
434 */
435 // ini_set('session.save_path', VARLIB_PATH.'/');
436
437 // ini_set('session.gc_maxlifetime', 36000); // 10hrs - moved to before session_manager
438
439 hook_session_start(@$_POST["company_login_name"]);
440
441 // this is to fix the "back-do-you-want-to-refresh" issue - thanx PHPFreaks
442 header("Cache-control: private");
443
444 get_text_init();
445
446 if ($SysPrefs->login_delay > 0 && file_exists(VARLIB_PATH."/faillog.php"))
447         include_once(VARLIB_PATH."/faillog.php");
448
449 // Page Initialisation
450 if (!isset($_SESSION['wa_current_user']) || !$_SESSION['wa_current_user']->logged_in()
451         || !isset($_SESSION['language']) || !method_exists($_SESSION['language'], 'set_language'))
452 {
453         $l = array_search_value($dflt_lang, $installed_languages,  'code');
454         $_SESSION['language'] = new language($l['name'], $l['code'], $l['encoding'],
455          (isset($l['rtl']) && $l['rtl'] === true) ? 'rtl' : 'ltr');
456 }
457
458 $_SESSION['language']->set_language($_SESSION['language']->code);
459
460
461 include_once($path_to_root . "/includes/access_levels.inc");
462 include_once($path_to_root . "/version.php");
463 include_once($path_to_root . "/includes/main.inc");
464 include_once($path_to_root . "/includes/app_entries.inc");
465
466 // Ajax communication object
467 $Ajax = new Ajax();
468
469 // js/php validation rules container
470 $Validate = array();
471 // bindings for editors
472 $Editors = array();
473 // page help. Currently help for function keys.
474 $Pagehelp = array();
475
476 $Refs = new references();
477
478 // intercept all output to destroy it in case of ajax call
479 register_shutdown_function('end_flush');
480 ob_start('output_html',0);
481
482 if (!isset($_SESSION["wa_current_user"]))
483         $_SESSION["wa_current_user"] = new current_user();
484
485 html_cleanup($_GET);
486 html_cleanup($_POST);
487 html_cleanup($_REQUEST);
488 html_cleanup($_SERVER);
489
490 // logout.php is the only page we should have always 
491 // accessable regardless of access level and current login status.
492 if (!defined('FA_LOGOUT_PHP_FILE')){
493
494         login_timeout();
495
496         if (!$_SESSION["wa_current_user"]->old_db && file_exists($path_to_root . '/company/'.user_company().'/installed_extensions.php'))
497                 include($path_to_root . '/company/'.user_company().'/installed_extensions.php');
498
499         install_hooks();
500
501         if (!$_SESSION["wa_current_user"]->logged_in())
502         {
503       if (@$SysPrefs->allow_password_reset && !$SysPrefs->allow_demo_mode
504         && (isset($_GET['reset']) || isset($_POST['email_entry_field']))) {
505                   if (!isset($_POST["email_entry_field"])) {
506         include($path_to_root . "/access/password_reset.php");
507         exit();
508       }
509       else {
510         if (isset($_POST["company_login_nickname"]) && !isset($_POST["company_login_name"])) {
511           for ($i = 0; $i < count($db_connections); $i++) {
512             if ($db_connections[$i]["name"] == $_POST["company_login_nickname"]) {
513               $_POST["company_login_name"] = $i;
514               unset($_POST["company_login_nickname"]);
515               break 1; // cannot pass variables to break from PHP v5.4 onwards
516             }
517           }
518         }
519         $_succeed = isset($db_connections[$_POST["company_login_name"]]) &&
520           $_SESSION["wa_current_user"]->reset_password($_POST["company_login_name"],
521           $_POST["email_entry_field"]);
522         if ($_succeed)
523         {
524           password_reset_success();
525         }
526
527         password_reset_fail();
528       }
529     }
530                 // Show login screen
531                 if (!isset($_POST["user_name_entry_field"]) or $_POST["user_name_entry_field"] == "")
532                 {
533                         // strip ajax marker from uri, to force synchronous page reload
534                         $_SESSION['timeout'] = array( 'uri'=>preg_replace('/JsHttpRequest=(?:(\d+)-)?([^&]+)/s',
535                                         '', html_specials_encode($_SERVER['REQUEST_URI'])),
536                                 'post' => $_POST);
537                 if (in_ajax())
538                         $Ajax->popup($path_to_root ."/access/timeout.php");
539                 else
540                         include($path_to_root . "/access/login.php");
541                         exit;
542                 } else {
543                         if (isset($_POST["company_login_nickname"]) && !isset($_POST["company_login_name"])) {
544                                 for ($i = 0; $i < count($db_connections); $i++) {
545                                         if ($db_connections[$i]["name"] == $_POST["company_login_nickname"]) {
546                                                 $_POST["company_login_name"] = $i;
547                                                 unset($_POST["company_login_nickname"]);
548                                                 break 1; // cannot pass variables to break from PHP v5.4 onwards
549                                         }
550                                 }
551                         }
552                         $succeed = isset($db_connections[$_POST["company_login_name"]]) &&
553                                 $_SESSION["wa_current_user"]->login($_POST["company_login_name"],
554                                 $_POST["user_name_entry_field"], $_POST["password"]);
555                         // select full vs fallback ui mode on login
556                         $_SESSION["wa_current_user"]->ui_mode = $_POST['ui_mode'];
557                         if (!$succeed)
558                         {
559                         // Incorrect password
560                                 if (isset($_SESSION['timeout'])) {
561                                         include($path_to_root . "/access/login.php");
562                                         exit;
563                                 } else
564                                         login_fail();
565                         }
566                         elseif(isset($_SESSION['timeout']) && !$_SESSION['timeout']['post'])
567                         {
568                                 // in case of GET request redirect to avoid confirmation dialog 
569                                 // after return from menu option
570                                 header("HTTP/1.1 307 Temporary Redirect");
571                                 header("Location: ".$_SESSION['timeout']['uri']);
572                                 exit();
573                         }
574                         $lang = &$_SESSION['language'];
575                         $lang->set_language($_SESSION['language']->code);
576                 }
577         } else
578         {
579                 set_global_connection();
580
581                 if (db_fixed())
582                         db_set_encoding($_SESSION['language']->encoding);
583
584                 $SysPrefs->refresh();
585         }
586         if (!isset($_SESSION["App"])) {
587                 $_SESSION["App"] = new front_accounting();
588                 $_SESSION["App"]->init();
589         }
590 }
591
592 // POST vars cleanup needed for direct reuse.
593 // We quote all values later with db_escape() before db update.
594 $_POST = strip_quotes($_POST);