includes/auth/auth.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Bugdar
   5 || # Copyright ©2002-2007 Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version 2 of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 require_once('./includes/api_user.php');
  23
  24 /**
  25 * Abstract Authentication
  26 *
  27 * This is an abstract class that is used to provide authentication for
  28 * Bugdar.
  29 *
  30 * @author               Blue Static
  31 * @copyright    Copyright (c)2002 - 2007, Blue Static
  32 * @version              $Revision$
  33 * @package              Bugdar
  34 *
  35 */
  36 class Authentication
  37 {
  38         /**
  39         * The database connection to AUTHENTICATE against; can be to a separate database
  40         * @var object
  41         */
  42         var $authDb;
  43
  44         /**
  45         * The database connection to the BUGDAR database
  46         * @var object
  47         */
  48         var $db;
  49
  50         /**
  51         * Array of user data from the AUTHENTICATION database
  52         * @var array
  53         */
  54         var $authUser;
  55
  56         /**
  57         * Array of user data from the BUGDAR database
  58         * @var array
  59         */
  60         var $bugdarUser;
  61
  62         /**
  63         * Mapping of Bugdar fields to authentication database fields; these will be synced between databases upon login.
  64         * AT THE VERY MINIMUM, YOU MUST MAP THESE FIELDS:
  65         * @var array
  66         */
  67         var $fieldMap = array(
  68                 'authid'                => null,
  69                 'displayname'   => null,
  70                 'email'                 => null,
  71         );
  72
  73         // ###################################################################
  74         /**
  75         * Constructor
  76         */
  77         function __construct()
  78         {
  79                 $this->db = BSApp::$db;
  80
  81                 BSApp::debug('authentication system: ' . get_class($this));
  82
  83                 $this->_setupDatabase();
  84         }
  85
  86         // ###################################################################
  87         /**
  88         * (PHP 4) Constructor
  89         */
  90         function Authentication()
  91         {
  92                 $this->__construct();
  93         }
  94
  95         // ###################################################################
  96         /**
  97         * Returns the information array for the Bugdar user. This must be
  98         * called after an authentication method.
  99         */
 100         function fetchBugdarUser()
 101         {
 102                 return $this->bugdarUser;
 103         }
 104
 105         // ###################################################################
 106         /**
 107         * Sets up the database to authenticate against. You can create a new
 108         * database object here. Whatever you choose, you need to reference
 109         * Authentication->authDb to the object
 110         */
 111         function _setupDatabase() {}
 112
 113         // ###################################################################
 114         /**
 115         * Returns the sanitized value of the user ID or unique identifier
 116         * found in the cookie of an already-authenticated user.
 117         */
 118         function _fetchCookieUniqueId() {}
 119
 120         // ###################################################################
 121         /**
 122         * Returns the sanitized value of the authentication key or cookie-safe
 123         * password found in the cookies of an already-authenticated user.
 124         */
 125         function _fetchCookiePassword() {}
 126
 127         // ###################################################################
 128         /**
 129         * Returns an array of user data fetched using the user information
 130         * values found in cookies. It should NOT be responsible for verifying
 131         * the authentication information, but only fetching it.
 132         */
 133         function _fetchUserUsingCookies() {}
 134
 135         // ###################################################################
 136         /**
 137         * Returns TRUE if the cookie data values are valid in the data array
 138         * returned from _fetchUserUsingCookies(), and FALSE if they are not.
 139         */
 140         function _verifyCookieData() {}
 141
 142         // ###################################################################
 143         /**
 144         * Authenticates the user using cookie data. You shouldn't need to
 145         * customize this method if you implement all the helpers correctly.
 146         * Returns TRUE if the cookies are valid and the user is logged in.
 147         */
 148         function authenticateCookies()
 149         {
 150                 if (!$this->_fetchCookieUniqueId() OR !$this->_fetchCookiePassword())
 151                 {
 152                         return false;
 153                 }
 154
 155                 $this->authUser = $this->_fetchUserUsingCookies();
 156                 if (!$this->authUser)
 157                 {
 158                         $this->authUser = null;
 159                         return false;
 160                 }
 161
 162                 if ($this->_verifyCookieData())
 163                 {
 164                         $this->_setCookies(true);
 165                         $this->bugdarUser = $this->_fetchBugdarUserFromAuthUser();
 166                         if ($this->_syncBugdarUser())
 167                         {
 168                                 $this->bugdarUser = $this->_fetchBugdarUserFromAuthUser();
 169                         }
 170                         return true;
 171                 }
 172                 else
 173                 {
 174                         $this->authUser = null;
 175                         $this->clearCookies();
 176                         return false;
 177                 }
 178         }
 179
 180         // ###################################################################
 181         /**
 182         * Returns an array with the authentication user information, found
 183         * by the unique login identifier passed to the function.
 184         */
 185         function _fetchUserWithIdentifier($string) {}
 186
 187         // ###################################################################
 188         /**
 189         * Verifies that the authUser's password matches the plain-text password
 190         * passed to this function. This is basically the transformation of
 191         * the plaintext to the hashed password and the result of the comparison.
 192         */
 193         function _verifyLoginUser($password) {}
 194
 195         // ###################################################################
 196         /**
 197         * Authenticates a user at login from two keys: an identifier and
 198         * a password. In Bugdar, the identifier is an email, but it can be
 199         * any unique string found in the authentication database. Returns
 200         * TRUE if the authentication is successful, and FALSE if not. Also
 201         * determines if the cookies are sticky ("rememember me" login)
 202         */
 203         function authenticateLogin($string, $password, $sticky = false)
 204         {
 205                 $this->authUser = $this->_fetchUserWithIdentifier($string);
 206
 207                 if (!$this->authUser)
 208                 {
 209                         $this->authUser = null;
 210                         return false;
 211                 }
 212
 213                 if ($this->_verifyLoginUser($password))
 214                 {
 215                         $this->_setCookies($sticky);
 216                         $this->bugdarUser = $this->_fetchBugdarUserFromAuthUser();
 217                         $this->_syncBugdarUser();
 218                         return true;
 219                 }
 220                 else
 221                 {
 222                         $this->authUser = null;
 223                         return false;
 224                 }
 225         }
 226
 227         // ###################################################################
 228         /**
 229         * Returns the BUGDAR user array from the data in the AUTHENTICATION user
 230         * array. If the Bugdar user does not exist, call _createBugdarUser()
 231         * to add the user into the Bugdar database. This is necessary so Bugdar options
 232         * can be saved in the Bugdar database (and not in the auth one), however
 233         * authentication details will NOT be stored in the Bugdar database.
 234         */
 235         function _fetchBugdarUserFromAuthUser()
 236         {
 237                 $user = $this->db->queryFirst("SELECT * FROM " . TABLE_PREFIX . "user WHERE authid = '" . $this->authUser[ $this->fieldMap['authid'] ] . "'");
 238                 if (!$user)
 239                 {
 240                         return $this->_createBugdarUser();
 241                 }
 242                 return $user;
 243         }
 244
 245         // ###################################################################
 246         /**
 247         * Creates a Bugdar user with the authentication details specified in
 248         * the auth array and returns it. You need to call this in
 249         * _fetchBugdarUserFromAuthUser() and use the UserAPI to create the user.
 250         * This will create a new user in Bugdar with the data from the authentication DB
 251         * with the fields specified in fieldMap.
 252         */
 253         function _createBugdarUser()
 254         {
 255                 $user = new UserAPI($this->registry);
 256
 257                 // if the email already exists in the DB, it must be the same person so just hook up the authid
 258                 if ($check = $this->db->queryFirst("SELECT * FROM " . TABLE_PREFIX . "user WHERE email = '" . $this->db->escape_string($this->authUser[ $this->fieldMap['email'] ]) . "'"))
 259                 {
 260                         $user->set('userid', $check['userid']);
 261                         $user->set_condition();
 262                         $user->set('authid', $this->authUser[ $this->fieldMap['authid'] ]);
 263                         $user->update();
 264                         $user->fetch();
 265
 266                         return $user->record;
 267                 }
 268                 else
 269                 {
 270                         $user = new UserAPI($this->registry);
 271                         foreach ($this->fieldMap AS $bugdar => $authdb)
 272                         {
 273                                 $user->set($bugdar, $this->authUser["$authdb"]);
 274                         }
 275                         $user->set('usergroupid', 2);
 276                         $user->insert();
 277
 278                         return $user->values;
 279                 }
 280         }
 281
 282         // ###################################################################
 283         /**
 284         * Syncs a Bugdar user's fieldMap'ed values to the authentication DB's
 285         * values. This allows the users to stay mostly-in-sync for the most
 286         * basic of information (like email, timezone, etc.). Passwords are
 287         * NOT synced. Returns TRUE if the user data was changed.
 288         */
 289         function _syncBugdarUser()
 290         {
 291                 $fields = $this->fieldMap;
 292                 unset($fields['authid']);
 293                 unset($fields['password']);
 294
 295                 $change = false;
 296
 297                 $user = new UserAPI($this->registry);
 298                 $user->set('userid', $this->bugdarUser['userid']);
 299                 $user->set_condition();
 300                 foreach ($fields AS $bugdar => $auth)
 301                 {
 302                         if ($this->bugdarUser["$bugdar"] != $this->authUser["$auth"])
 303                         {
 304                                 $user->set($bugdar, $this->authUser["$auth"]);
 305                                 $change = true;
 306                         }
 307                 }
 308                 if ($change)
 309                 {
 310                         $user->update();
 311                 }
 312
 313                 return $change;
 314         }
 315
 316         // ###################################################################
 317         /**
 318         * Responsible for unsetting all authentication cookies because they
 319         * are invalid
 320         */
 321         function clearCookies() {}
 322
 323         // ###################################################################
 324         /**
 325         * Sets the authentication cookies; this is done both at login and
 326         * for renewing the cookies upon successful cookie validation. The
 327         * option it takes determines whether the cookies are sticky or not.
 328         */
 329         function _setCookies($permanent = false) {}
 330 }
 331
 332 /*=====================================================================*\
 333 || ###################################################################
 334 || # $HeadURL$
 335 || # $Id$
 336 || ###################################################################
 337 \*=====================================================================*/
 338 ?>