modules/Users/authentication/AuthenticationController.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39
  40 class AuthenticationController
  41 {
  42         public $loggedIn = false; //if a user has attempted to login
  43         public $authenticated = false;
  44         public $loginSuccess = false;// if a user has successfully logged in
  45
  46         protected static $authcontrollerinstance = null;
  47
  48         /**
  49          * Creates an instance of the authentication controller and loads it
  50          *
  51          * @param STRING $type - the authentication Controller - default to SugarAuthenticate
  52          * @return AuthenticationController -
  53          */
  54         public function __construct($type = 'SugarAuthenticate')
  55         {
  56             if ($type == 'SugarAuthenticate' && !empty($GLOBALS['system_config']->settings['system_ldap_enabled']) && empty($_SESSION['sugar_user'])){
  57                         $type = 'LDAPAuthenticate';
  58         }
  59
  60         // check in custom dir first, in case someone want's to override an auth controller
  61                 if (file_exists('custom/modules/Users/authentication/'.$type.'/' . $type . '.php')) {
  62             require_once('custom/modules/Users/authentication/'.$type.'/' . $type . '.php');
  63         } elseif (file_exists('modules/Users/authentication/'.$type.'/' . $type . '.php')) {
  64             require_once('modules/Users/authentication/'.$type.'/' . $type . '.php');
  65         } else {
  66             require_once('modules/Users/authentication/SugarAuthenticate/SugarAuthenticate.php');
  67             $type = 'SugarAuthenticate';
  68         }
  69
  70         $this->authController = new $type();
  71         $this->authController->pre_login();
  72         }
  73
  74
  75         /**
  76          * Returns an instance of the authentication controller
  77          *
  78          * @param string $type this is the type of authetnication you want to use default is SugarAuthenticate
  79          * @return an instance of the authetnciation controller
  80          */
  81         public static function getInstance($type = 'SugarAuthenticate')
  82         {
  83                 if (empty(self::$authcontrollerinstance)) {
  84                         self::$authcontrollerinstance = new AuthenticationController($type);
  85                 }
  86
  87                 return self::$authcontrollerinstance;
  88         }
  89
  90         /**
  91          * This function is called when a user initially tries to login.
  92          *
  93          * @param string $username
  94          * @param string $password
  95          * @param array $PARAMS
  96          * @return boolean true if the user successfully logs in or false otherwise.
  97          */
  98         public function login($username, $password, $PARAMS = array())
  99         {
 100                 //kbrill bug #13225
 101                 $_SESSION['loginAttempts'] = (isset($_SESSION['loginAttempts']))? $_SESSION['loginAttempts'] + 1: 1;
 102                 unset($GLOBALS['login_error']);
 103
 104                 if($this->loggedIn)return $this->loginSuccess;
 105                 LogicHook::initialize()->call_custom_logic('Users', 'before_login');
 106
 107                 $this->loginSuccess = $this->authController->loginAuthenticate($username, $password, false, $PARAMS);
 108                 $this->loggedIn = true;
 109
 110                 if($this->loginSuccess){
 111                         //Ensure the user is authorized
 112                         checkAuthUserStatus();
 113
 114                         loginLicense();
 115                         if(!empty($GLOBALS['login_error'])){
 116                                 unset($_SESSION['authenticated_user_id']);
 117                                 $GLOBALS['log']->fatal('FAILED LOGIN: potential hack attempt');
 118                                 $this->loginSuccess = false;
 119                                 return false;
 120                         }
 121
 122                         //call business logic hook
 123                         if(isset($GLOBALS['current_user']))
 124                                 $GLOBALS['current_user']->call_custom_logic('after_login');
 125
 126                         // Check for running Admin Wizard
 127                         $config = new Administration();
 128                         $config->retrieveSettings();
 129                     if ( is_admin($GLOBALS['current_user']) && empty($config->settings['system_adminwizard']) && $_REQUEST['action'] != 'AdminWizard' ) {
 130                                 $GLOBALS['module'] = 'Configurator';
 131                                 $GLOBALS['action'] = 'AdminWizard';
 132                                 ob_clean();
 133                                 header("Location: index.php?module=Configurator&action=AdminWizard");
 134                                 sugar_cleanup(true);
 135                         }
 136
 137                         $ut = $GLOBALS['current_user']->getPreference('ut');
 138                         $checkTimeZone = true;
 139                         if (is_array($PARAMS) && !empty($PARAMS) && isset($PARAMS['passwordEncrypted'])) {
 140                                 $checkTimeZone = false;
 141                         } // if
 142                         if(empty($ut) && $checkTimeZone && $_REQUEST['action'] != 'SetTimezone' && $_REQUEST['action'] != 'SaveTimezone' ) {
 143                                 $GLOBALS['module'] = 'Users';
 144                                 $GLOBALS['action'] = 'Wizard';
 145                                 ob_clean();
 146                                 header("Location: index.php?module=Users&action=Wizard");
 147                                 sugar_cleanup(true);
 148                         }
 149                 }else{
 150                         //kbrill bug #13225
 151                         LogicHook::initialize();
 152                         $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 153                         $GLOBALS['log']->fatal('FAILED LOGIN:attempts[' .$_SESSION['loginAttempts'] .'] - '. $username);
 154                 }
 155                 // if password has expired, set a session variable
 156
 157                 return $this->loginSuccess;
 158         }
 159
 160         /**
 161          * This is called on every page hit.
 162          * It returns true if the current session is authenticated or false otherwise
 163          *
 164          * @return booelan
 165          */
 166         public function sessionAuthenticate()
 167         {
 168                 if(!$this->authenticated){
 169                         $this->authenticated = $this->authController->sessionAuthenticate();
 170                 }
 171                 if($this->authenticated){
 172                         if(!isset($_SESSION['userStats']['pages'])){
 173                             $_SESSION['userStats']['loginTime'] = time();
 174                             $_SESSION['userStats']['pages'] = 0;
 175                         }
 176                         $_SESSION['userStats']['lastTime'] = time();
 177                         $_SESSION['userStats']['pages']++;
 178
 179                 }
 180                 return $this->authenticated;
 181         }
 182
 183         /**
 184          * Called when a user requests to logout. Should invalidate the session and redirect
 185          * to the login page.
 186          */
 187         public function logout()
 188         {
 189                 $GLOBALS['current_user']->call_custom_logic('before_logout');
 190                 $this->authController->logout();
 191                 LogicHook::initialize();
 192                 $GLOBALS['logic_hook']->call_custom_logic('Users', 'after_logout');
 193         }
 194 }