modules/Users/authentication/SugarAuthenticate/SugarAuthenticateUser.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-2012 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
  41 /**
  42  * This file is where the user authentication occurs. No redirection should happen in this file.
  43  *
  44  */
  45 class SugarAuthenticateUser{
  46
  47         /**
  48          * Does the actual authentication of the user and returns an id that will be used
  49          * to load the current user (loadUserOnSession)
  50          *
  51          * @param STRING $name
  52          * @param STRING $password
  53          * @param STRING $fallback - is this authentication a fallback from a failed authentication
  54          * @return STRING id - used for loading the user
  55          */
  56         function authenticateUser($name, $password, $fallback=false)
  57         {
  58             $row = User::findUserPassword($name, $password, "(portal_only IS NULL OR portal_only !='1') AND (is_group IS NULL OR is_group !='1') AND status !='Inactive'");
  59
  60             // set the ID in the seed user.  This can be used for retrieving the full user record later
  61                 //if it's falling back on Sugar Authentication after the login failed on an external authentication return empty if the user has external_auth_disabled for them
  62                 if (empty ($row) || !empty($row['external_auth_only'])) {
  63                         return '';
  64                 } else {
  65                         return $row['id'];
  66                 }
  67         }
  68         /**
  69          * Checks if a user is a sugarLogin user
  70          * which implies they should use the sugar authentication to login
  71          *
  72          * @param STRING $name
  73          * @param STRIUNG $password
  74          * @return boolean
  75          */
  76         function isSugarLogin($name, $password)
  77         {
  78             $row = User::findUserPassword($name, $password, "(portal_only IS NULL OR portal_only !='1') AND (is_group IS NULL OR is_group !='1') AND status !='Inactive' AND sugar_login=1");
  79             return !empty($row);
  80         }
  81
  82         /**
  83          * this is called when a user logs in
  84          *
  85          * @param STRING $name
  86          * @param STRING $password
  87          * @param STRING $fallback - is this authentication a fallback from a failed authentication
  88          * @return boolean
  89          */
  90         function loadUserOnLogin($name, $password, $fallback = false, $PARAMS = array()) {
  91                 global $login_error;
  92
  93                 $GLOBALS['log']->debug("Starting user load for ". $name);
  94                 if(empty($name) || empty($password)) return false;
  95                 $input_hash = $password;
  96                 $passwordEncrypted = false;
  97                 if (!empty($PARAMS) && isset($PARAMS['passwordEncrypted']) && $PARAMS['passwordEncrypted']) {
  98                         $passwordEncrypted = true;
  99                 }// if
 100                 if (!$passwordEncrypted) {
 101                         $input_hash = SugarAuthenticate::encodePassword($password);
 102                 } // if
 103                 $user_id = $this->authenticateUser($name, $input_hash, $fallback);
 104                 if(empty($user_id)) {
 105                         $GLOBALS['log']->fatal('SECURITY: User authentication for '.$name.' failed');
 106                         return false;
 107                 }
 108                 $this->loadUserOnSession($user_id);
 109                 return true;
 110         }
 111         /**
 112          * Loads the current user bassed on the given user_id
 113          *
 114          * @param STRING $user_id
 115          * @return boolean
 116          */
 117         function loadUserOnSession($user_id=''){
 118                 if(!empty($user_id)){
 119                         $_SESSION['authenticated_user_id'] = $user_id;
 120                 }
 121
 122                 if(!empty($_SESSION['authenticated_user_id']) || !empty($user_id)){
 123                         $GLOBALS['current_user'] = new User();
 124                         if($GLOBALS['current_user']->retrieve($_SESSION['authenticated_user_id'])){
 125
 126                                 return true;
 127                         }
 128                 }
 129                 return false;
 130
 131         }
 132
 133 }
 134
 135 ?>