Source for file auth.php

Documentation is available at auth.php

  1. <?php
  2. /**
  3. * User Authentication and Authorisation (Login and Permissions object)
  4. *
  5. * @author     Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage DBObjects
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /** inherit from basic auth module */
  18. require_once 'inc/bb/basicauth.php';
  19. /** sql manipulation routines */
  20. require_once 'inc/formslib/sql.php';
  21. /** type checking and data manipulation */
  22. require_once 'inc/typeinfo.php';
  23. /** permissions codes */
  24. require_once 'inc/permissions.php';
  25. /** logging functions */
  26. require_once 'inc/logging.php';
  27. /** system configuration */
  28. require_once 'inc/bb/configreader.php';
  29.  
  30. /**
  31. * User *authorisation* and *authentication* object
  32. *
  33. * @package    Bumblebee
  34. * @subpackage DBObjects
  35. * @todo //TODO: update permissions system
  36. * @todo //TODO: documentation
  37. */
  38. class BumblebeeAuth extends BasicAuth {
  39.   var $anonymous = false;
  40.   var $euid;            //permit user masquerading like su. Effective UID
  41.     var $ename;           //effective name
  42.     var $eusername;       //effective username
  43.     var $permissions = array();
  44.   var $system_permissions = 0;
  45.  
  46.   /**
  47.   *  Create the auth object
  48.   *
  49.   * @param array   $data    array containing keys 'username' and 'pass'
  50.   * @param boolean $recheck (optional) ignore session data and check anyway
  51.   * @param string  $table  (optional) db table from which login data should be taken
  52.   */
  53.   function BumblebeeAuth($data, $recheck = false, $table='users') {
  54.     $this->_checkAnonymous($data);
  55.  
  56.     parent::BasicAuth($data, $recheck || $this->_changeUser(), $table);
  57.  
  58.     if ($this->_loggedin) {
  59.       // set up Authorisation parts
  60.       $this->_loadPermissions();
  61.       $this->_checkMasq();
  62.     }
  63.   }
  64.  
  65.   function _changeUser() {
  66.     if (isset($_POST['changeuser']) || isset($_GET['changeuser'])) {
  67.       return true;
  68.     }
  69.   }
  70.  
  71.   function _checkAnonymous(&$data) {
  72.     $conf = ConfigReader::getInstance();
  73.     if ((isset($_POST['anonymous']) || isset($_GET['anonymous']))
  74.         && $conf->value('display', 'AnonymousAllowed', false)) {
  75.       $data['username'] = $conf->value('display', 'AnonymousUsername');
  76.       $data['pass']     = $conf->value('display', 'AnonymousPassword');
  77.     }
  78.   }
  79.  
  80.   /**
  81.    * Permit user masquerading -- the admin user can become another user for a period
  82.    * of time to make a bookings etc
  83.   **/
  84.  
  85.   function _checkMasq() {
  86.     if ($this->masqPermitted() && $this->_var_get('euid') != NULL) {
  87.       $this->euid      = $this->_var_get('euid');
  88.       $this->ename     = $this->_var_get('ename');
  89.       $this->eusername = $this->_var_get('eusername');
  90.     }
  91.   }
  92.  
  93.   function isSystemAdmin() {
  94.     if($this->system_permissions == -1 || $this->system_permissions >= BBROLE_ADMIN_BASE) {
  95.       return true;
  96.     } else {
  97.       return false;
  98.     }
  99.   }
  100.  
  101.   function isInstrumentAdmin($instr) {
  102.     trigger_error("using deprecated isInstrumentAdmin", E_USER_NOTICE);
  103.     $l = debug_backtrace();
  104.     print "file= ". $l[0]['file'] .", line=".$l[0]['line']."\n<br />";
  105.     return $this->isSystemAdmin() ||
  106.           ($this->instrument_permissions($instr) & BBPERM_INSTR_BOOK_FUTURE);
  107.   }
  108.  
  109.  
  110.   function instrument_permissions($instrument) {
  111.     $conf = ConfigReader::getInstance();
  112.  
  113.     if (isset($this->permissions[$instrument])) {
  114.       return $this->permissions[$instrument];
  115.     }
  116.     $permission = 0;
  117.     if ($instrument==0) {
  118.       // look for permissions across all instruments
  119.       $total = 0;
  120.       global $TABLEPREFIX;
  121.       $q = 'SELECT * '
  122.           .' FROM '.$TABLEPREFIX.'permissions'
  123.           .' WHERE userid=' . qw($this->uid);
  124.       $sql = db_get($q, false);
  125.       while ($row = db_fetch_array($sql)) {
  126.         if (isset($row['permissions']) && $conf->value('auth', 'permissionsModel', false)) {
  127.           $permission = $row['permissions'];
  128.         } else {
  129.           $permission = $this->_constructInstrumentPermission($row);
  130.         }
  131.         $this->permissions[$instrument] = $permission;
  132.         $total = ((int)$total) | ((int)$permission);
  133.       }
  134.       $permission = $total;
  135.     } else {
  136.       $row = quickSQLSelect('permissions',
  137.                               array('userid',   'instrid'),
  138.                               array($this->uid, $instrument)
  139.                            );
  140.       if (is_array($row)) {
  141.         if (isset($row['permissions']) && $conf->value('auth', 'permissionsModel', false)) {
  142.           $permission = $row['permissions'];
  143.         } else {
  144.           $permission = $this->_constructInstrumentPermission($row);
  145.         }
  146.       }
  147.     }
  148.     //save the permissions to speed this up later
  149.     $this->permissions[$instrument] = (int)$permission;
  150.     return $this->permissions[$instrument];
  151.   }
  152.  
  153.   /**
  154.   * make up the permissions for the instrument
  155.   *
  156.   * @param    array   $row   from the database
  157.   * @returns  integer        permissions
  158.   */
  159.   function _constructInstrumentPermission($row) {
  160.     logmsg(2, "Making up some permissions for instrument. Upgrade database format to get rid of this message.");
  161.     $permission = 0;
  162.     if (isset($row['isadmin']) && $row['isadmin']) {
  163.       $permission = BBPERM_INSTR_ALL;
  164.     } else {
  165.       $permission = BBPERM_INSTR_BASIC;
  166.     }
  167.     return $permission;
  168.   }
  169.  
  170.   function getEUID() {
  171.     return (isset($this->euid) ? $this->euid : $this->uid);
  172.   }
  173.  
  174.   function masqPermitted($instr=0) {
  175.     return $this->permitted(BBROLE_ADMIN_MASQ, $instr);
  176.   }
  177.  
  178.   function amMasqed() {
  179.     return (isset($this->euid) && $this->euid != $this->uid);
  180.   }
  181.  
  182.   /**
  183.   * start masquerading as another user
  184.   */
  185.   function assumeMasq($id) {
  186.     if ($this->masqPermitted()) {
  187.       //masquerade permitted
  188.       $row = $this->_retrieveUserInfo($id, 0);
  189.       $this->_var_put('euid',       $this->euid      = $row['id']);
  190.       $this->_var_put('eusername',  $this->eusername = $row['username']);
  191.       $this->_var_put('ename',      $this->ename     = $row['name']);
  192.       return $row;
  193.     } else {
  194.       // masquerade not permitted
  195.       echo "Couldn't assume masq";
  196.       return 0;
  197.     }
  198.   }
  199.  
  200.   /**
  201.   * stop masquerading as another user
  202.   */
  203.   function removeMasq() {
  204.     $this->_var_put('euid',        $this->euid      = null);
  205.     $this->_var_put('eusername',   $this->eusername = null);
  206.     $this->_var_put('ename',       $this->ename     = null);
  207.   }
  208.  
  209.   function permitted($operation, $instrument=NULL) {
  210.     //print "Requested: $operation and have permissions $this->system_permissions<br/>";
  211.     // NOTE: Must cast to int before using PHP's bitwise operators else you will get stupid results
  212.     // due to the loose typing mechanism switching the variables to float or string on you.
  213.     if ($operation == BBROLE_NONE) return true;
  214.     if ($instrument === NULL) {
  215.       // looking for system permissions
  216.       return ((int) $operation & (int) $this->system_permissions) == $operation;
  217.     } else {
  218.       if (is_array($instrument)) {
  219.         foreach ($instrument as $i) {
  220.           if (! $this->permitted($operation, $i)) return false;
  221.         }
  222.         return true;
  223.       } else {
  224.         #echo "op = ". $operation;
  225.         #echo "instr = " .(int) $this->instrument_permissions($instrument);
  226.         #echo "ok=". ((int) $this->instrument_permissions($instrument) & (int) $operation);
  227.         #echo "<br />";
  228.         return (((int) $operation)
  229.               & ( (int) $this->system_permissions | (int) $this->instrument_permissions($instrument) ))
  230.              == $operation;
  231.       }
  232.     }
  233.   }
  234.  
  235.   function _loadPermissions() {
  236.     $conf = ConfigReader::getInstance();
  237.  
  238.     if (! $this->isLoggedIn()) return;
  239.  
  240.     /// FIXME
  241.     if (isset($this->user_row['permissions']) && $conf->value('auth', 'permissionsModel', false)) {
  242.       $this->system_permissions = (int) $this->user_row['permissions'];
  243.     } else {
  244.       logmsg(2, "Making up some permissions for user. Upgrade database format to get rid of this message.");
  245.       $this->system_permissions = 0;
  246.       if (isset($this->user_row['isadmin']) && $this->user_row['isadmin']) {
  247.         $this->system_permissions |= BBPERM_ADMIN_ALL;
  248.       } else {
  249.         if ($this->localLogin) {
  250.           $this->system_permissions |= BBPERM_USER_BASIC | BBPERM_USER_PASSWD;
  251.         } else {
  252.           $this->system_permissions |= BBPERM_USER_BASIC;
  253.         }
  254.       }
  255.       if ($this->masqPermitted()) {
  256.         $this->system_permissions |= BBPERM_ADMIN_MASQ;
  257.       }
  258.     }
  259.     if (! $this->localLogin) {
  260.       $this->system_permissions = $this->system_permissions & (~ BBPERM_USER_PASSWD);
  261.     }
  262.   }
  263.  
  264. } //BumblebeeAuth
  265.  
  266. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:36 +0000 by phpDocumentor 1.3.0