* * Security scheme based on ACL design * * Copyright (C) 2000, 2001 Dan Kuykendall * * -------------------------------------------------------------------------* * This library is part of the phpGroupWare API * * http://www.phpgroupware.org/api * * ------------------------------------------------------------------------ * * This library is free software; you can redistribute it and/or modify it * * under the terms of the GNU Lesser General Public License as published by * * the Free Software Foundation; either version 2.1 of the License, * * or any later version. * * This library is distributed in the hope that it will be useful, but * * WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * * See the GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * * along with this library; if not, write to the Free Software Foundation, * * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * \**************************************************************************/ /* $Id$ */ /*! @class acl @abstract Acces Control List Security System @discussion This class provides an ACL security scheme. This can manage rights to 'run' applications, and limit certain features within an application. It is also used for granting a user "membership" to a group, or making a user have the security equivilance of another user. It is also used for granting a user or group rights to various records, such as todo or calendar items of another user. @syntax CreateObject('phpgwapi.acl',int account_id); @example $acl = CreateObject('phpgwapi.acl',5); // 5 is the user id @example $acl = CreateObject('phpgwapi.acl',10); // 10 is the user id @author Seek3r @copyright LGPL @package phpgwapi @access public */ class acl { /*! @var $account_id */ var $account_id; /*! @var $account_type */ var $account_type; /*! @var $data */ var $data = Array(); /*! @var $db */ var $db; /*! @function acl @abstract ACL constructor for setting account id @discussion Author: Seek3r
Sets the ID for $acl->account_id. Can be used to change a current instances id as well.
Some functions are specific to this account, and others are generic.
Syntax: int acl(int account_id)
Example1: acl->acl(5); // 5 is the user id
@param account_id int-the user id */ function acl($account_id = '') { $this->db = $GLOBALS['phpgw']->db; if($account_id != '') { $this->account_id = get_account_id($account_id,$GLOBALS['phpgw_info']['user']['account_id']); } } /**************************************************************************\ * These are the standard $this->account_id specific functions * \**************************************************************************/ /*! @function read_repository @abstract Read acl records from reposity @discussion Author: Seek3r
Reads ACL records for $acl->account_id and returns array along with storing it in $acl->data.
Syntax: array read_repository()
Example1: acl->read_repository();
Should only be called within this class */ function read_repository() { $sql = 'select * from phpgw_acl where (acl_account in ('.$this->account_id.', 0'; $groups = $this->get_location_list_for_id('phpgw_group', 1, $this->account_id); while($groups && list($key,$value) = each($groups)) { $sql .= ','.$value; } $sql .= '))'; $this->db->query($sql ,__LINE__,__FILE__); $count = $this->db->num_rows(); $this->data = Array(); for ($idx = 0; $idx < $count; ++$idx) { //reset ($this->data); //while(list($idx,$value) = each($this->data)){ $this->db->next_record(); $this->data[] = array( 'appname' => $this->db->f('acl_appname'), 'location' => $this->db->f('acl_location'), 'account' => $this->db->f('acl_account'), 'rights' => $this->db->f('acl_rights') ); } reset ($this->data); return $this->data; } /*! @function read @abstract Read acl records from $acl->data @discussion Author: Seek3r
Returns ACL records from $acl->data.
Syntax: array read()
Example1: acl->read();
*/ function read() { if (count($this->data) == 0){ $this->read_repository(); } reset ($this->data); return $this->data; } /*! @function add @abstract Adds ACL record to $acl->data @discussion Adds ACL record to $acl->data.
Syntax: array add()
Example1: acl->add(); @param $appname default False derives value from $phpgw_info['flags']['currentapp'] @param $location location @param $rights rights */ function add($appname = False, $location, $rights) { if ($appname == False) { settype($appname,'string'); $appname = $GLOBALS['phpgw_info']['flags']['currentapp']; } $this->data[] = array('appname' => $appname, 'location' => $location, 'account' => $this->account_id, 'rights' => $rights); reset($this->data); return $this->data; } /*! @function delete @abstract Delete ACL record @discussion Syntax
Example:
@param $appname optional defaults to $phpgw_info['flags']['currentapp'] @param $location app location */ function delete($appname = False, $location) { if ($appname == False) { settype($appname,'string'); $appname = $GLOBALS['phpgw_info']['flags']['currentapp']; } $count = count($this->data); reset ($this->data); while(list($idx,$value) = each($this->data)) { if ($this->data[$idx]['appname'] == $appname && $this->data[$idx]['location'] == $location && $this->data[$idx]['account'] == $this->account_id) { $this->data[$idx] = Array(); } } reset($this->data); return $this->data; } /*! @function save_repostiory @abstract save repository @discussion save the repository
Syntax: save_repository()
example: acl->save_repository() */ function save_repository() { reset($this->data); $sql = 'delete from phpgw_acl where acl_account = '.$this->account_id; $this->db->query($sql ,__LINE__,__FILE__); $count = count($this->data); reset ($this->data); while(list($idx,$value) = each($this->data)) { if ($this->data[$idx]['account'] == $this->account_id) { $sql = 'insert into phpgw_acl (acl_appname, acl_location, acl_account, acl_rights)'; $sql .= " values('".$this->data[$idx]['appname']."', '" . $this->data[$idx]['location']."', ".$this->account_id.', '.$this->data[$idx]['rights'].')'; $this->db->query($sql ,__LINE__,__FILE__); } } reset($this->data); return $this->data; } /**************************************************************************\ * These are the non-standard $this->account_id specific functions * \**************************************************************************/ /*! @function get_rights @abstract get rights from the repository not specific to this->account_id (?) @discussion @param $location app location to get rights from @param $appname optional defaults to $phpgw_info['flags']['currentapp']; */ function get_rights($location,$appname = False) { if (count($this->data) == 0){ $this->read_repository(); } reset ($this->data); if ($appname == False) { settype($appname,'string'); $appname = $GLOBALS['phpgw_info']['flags']['currentapp']; } $count = count($this->data); if ($count == 0 && $GLOBALS['phpgw_info']['server']['acl_default'] != 'deny'){ return True; } $rights = 0; //for ($idx = 0; $idx < $count; ++$idx){ reset ($this->data); while(list($idx,$value) = each($this->data)) { if ($this->data[$idx]['appname'] == $appname) { if ($this->data[$idx]['location'] == $location || $this->data[$idx]['location'] == 'everywhere') { if ($this->data[$idx]['rights'] == 0){ return False; } $rights |= $this->data[$idx]['rights']; } } } return $rights; } /*! @function check @abstract check required rights (not specific to this->account_id?) @param $location app location @param $required required right to check against @param $appname optional defaults to currentapp */ function check($location, $required, $appname = False) { $rights = $this->get_rights($location,$appname); return !!($rights & $required); } /*! @function get_specific_rights @abstract get specific rights for this->account_id for an app location @param $location app location @param $appname optional defaults to currentapp @result $rights ? */ function get_specific_rights($location, $appname = False) { if ($appname == False) { settype($appname,'string'); $appname = $GLOBALS['phpgw_info']['flags']['currentapp']; } $count = count($this->data); if ($count == 0 && $GLOBALS['phpgw_info']['server']['acl_default'] != 'deny'){ return True; } $rights = 0; reset ($this->data); while(list($idx,$value) = each($this->data)) { if ($this->data[$idx]['appname'] == $appname && ($this->data[$idx]['location'] == $location || $this->data[$idx]['location'] == 'everywhere') && $this->data[$idx]['account'] == $this->account_id) { if ($this->data[$idx]['rights'] == 0){ return False; } $rights |= $this->data[$idx]['rights']; } } return $rights; } /*! @function check_specific @abstract check specific @param $location app location @param $required required rights @param $appname optional defaults to currentapp @result boolean */ function check_specific($location, $required, $appname = False) { $rights = $this->get_specific_rights($location,$appname); return !!($rights & $required); } /*! @function get_location_list @abstract ? @param $app appname @param $required ? */ function get_location_list($app, $required) { // User piece $sql = "select acl_location, acl_rights from phpgw_acl where acl_appname = '$app' "; $sql .= " and (acl_account in ('".$this->account_id."', 0"; // group 0 covers all users $equalto = $GLOBALS['phpgw']->accounts->security_equals($this->account_id); if (is_array($equalto) && count($equalto) > 0) { for ($idx = 0; $idx < count($equalto); ++$idx) { $sql .= ','.$equalto[$idx][0]; } } $sql .= ')))'; $this->db->query($sql ,__LINE__,__FILE__); $rights = 0; if ($this->db->num_rows() == 0 ){ return False; } while ($this->db->next_record()) { if ($this->db->f('acl_rights') == 0){ return False; } $rights |= $this->db->f('acl_rights'); if (!!($rights & $required) == True) { $locations[] = $this->db->f('acl_location'); } else { return False; } } return $locations; } /* This is kinda how the function SHOULD work, so that it doesnt need to do its own sql query. It should use the values in the $this->data function get_location_list($app, $required) { if ($appname == False) { $appname = $GLOBALS['phpgw_info']['flags']['currentapp']; } $count = count($this->data); if ($count == 0 && $GLOBALS['phpgw_info']['server']['acl_default'] != 'deny'){ return True; } $rights = 0; reset ($this->data); while(list($idx,$value) = each($this->data)) { if ($this->data[$idx]['appname'] == $appname && $this->data[$idx]['rights'] != 0) { $location_rights[$this->data[$idx]['location']] |= $this->data[$idx]['rights']; } } reset($location_rights); for ($idx = 0; $idx < count($location_rights); ++$idx) { if (!!($location_rights[$idx] & $required) == True) { $location_rights[] = $this->data[$idx]['location']; } } return $locations; } */ /**************************************************************************\ * These are the generic functions. Not specific to $this->account_id * \**************************************************************************/ /*! @function add_repository @abstract add repository information for an app @param $app appname @param $location location @param $account_id account id @param $rights rights */ function add_repository($app, $location, $account_id, $rights) { $this->delete_repository($app, $location, $account_id); $sql = 'insert into phpgw_acl (acl_appname, acl_location, acl_account, acl_rights)'; $sql .= " values ('" . $app . "','" . $location . "','" . $account_id . "','" . $rights . "')"; $this->db->query($sql ,__LINE__,__FILE__); return True; } /*! @function delete_repository @abstract delete repository information for an app @param $app appname @param $location location @param $account_id account id */ function delete_repository($app, $location, $accountid = '') { static $cache_accountid; if(isset($cache_accountid[$accountid]) && $cache_accountid[$accountid]) { $account_id = $cache_accountid[$accountid]; } else { $account_id = get_account_id($accountid,$this->account_id); $cache_accountid[$accountid] = $account_id; } $sql = "delete from phpgw_acl where acl_appname like '".$app."'" . " and acl_location like '".$location."' and " . " acl_account = ".$account_id; $this->db->query($sql ,__LINE__,__FILE__); return $this->db->num_rows(); } /*! @function get_app_list_for_id @abstract get application list for an account id @param $location location @param $required ? @param $account_id account id defaults to $phpgw_info['user']['account_id']; */ function get_app_list_for_id($location, $required, $accountid = '') { static $cache_accountid; if($cache_accountid[$accountid]) { $account_id = $cache_accountid[$accountid]; } else { $account_id = get_account_id($accountid,$this->account_id); $cache_accountid[$accountid] = $account_id; } $sql = "select acl_appname, acl_rights from phpgw_acl where acl_location = '$location' and "; $sql .= 'acl_account = '.$account_id; $this->db->query($sql ,__LINE__,__FILE__); $rights = 0; if ($this->db->num_rows() == 0 ){ return False; } while ($this->db->next_record()) { if ($this->db->f('acl_rights') == 0){ return False; } $rights |= $this->db->f('acl_rights'); if (!!($rights & $required) == True) { $apps[] = $this->db->f('acl_appname'); } } return $apps; } /*! @function get_location_list_for_id @abstract get location list for id @discussion ? @param $app app @param $required required @param $account_id optional defaults to $phpgw_info['user']['account_id']; */ function get_location_list_for_id($app, $required, $accountid = '') { static $cache_accountid; if($cache_accountid[$accountid]) { $account_id = $cache_accountid[$accountid]; } else { $account_id = get_account_id($accountid,$this->account_id); $cache_accountid[$accountid] = $account_id; } $sql = "select acl_location, acl_rights from phpgw_acl where acl_appname = '$app' and "; $sql .= "acl_account = ".$account_id; $this->db->query($sql ,__LINE__,__FILE__); $rights = 0; if ($this->db->num_rows() == 0 ){ return False; } while ($this->db->next_record()) { if ($this->db->f('acl_rights')) { $rights |= $this->db->f('acl_rights'); if (!!($rights & $required) == True) { $locations[] = $this->db->f('acl_location'); } } } return $locations; } /*! @function get_ids_for_location @abstract get ids for location @param $location location @param $required required @param $app app optional defaults to $phpgw_info['flags']['currentapp']; */ function get_ids_for_location($location, $required, $app = False) { if ($app == False) { $app = $GLOBALS['phpgw_info']['flags']['currentapp']; } $sql = "select acl_account, acl_rights from phpgw_acl where acl_appname = '$app' and "; $sql .= "acl_location = '".$location."'"; $this->db->query($sql ,__LINE__,__FILE__); $rights = 0; if ($this->db->num_rows() == 0 ){ return False; } while ($this->db->next_record()) { $rights = 0; $rights |= $this->db->f('acl_rights'); if (!!($rights & $required) == True) { $accounts[] = intval($this->db->f('acl_account')); } } @reset($accounts); return $accounts; } /*! @function get_user_applications @abstract get a list of applications a user has rights to @param $account_id optional defaults to $phpgw_info['user']['account_id']; @result $apps array containing list of apps */ function get_user_applications($accountid = '') { static $cache_accountid; if($cache_accountid[$accountid]) { $account_id = $cache_accountid[$accountid]; } else { $account_id = get_account_id($accountid,$this->account_id); $cache_accountid[$accountid] = $account_id; } $db2 = $this->db; $memberships = $GLOBALS['phpgw']->accounts->membership($account_id); $sql = "select acl_appname, acl_rights from phpgw_acl where acl_location = 'run' and " . 'acl_account in '; $security = '('.$account_id; while($groups = @each($memberships)) { $group = each($groups); $security .= ','.$group[1]['account_id']; } $security .= ')'; $db2->query($sql . $security ,__LINE__,__FILE__); if ($db2->num_rows() == 0){ return False; } while ($db2->next_record()) { if(isset($apps[$db2->f('acl_appname')])) { $rights = $apps[$db2->f('acl_appname')]; } else { $rights = 0; $apps[$db2->f('acl_appname')] = 0; } $rights |= $db2->f('acl_rights'); $apps[$db2->f('acl_appname')] |= $rights; } return $apps; } /*! @function get_grants @abstract ? @param $app optional defaults to $phpgw_info['flags']['currentapp']; */ function get_grants($app='') { $db2 = $this->db; if ($app=='') { $app = $GLOBALS['phpgw_info']['flags']['currentapp']; } $sql = "select acl_account, acl_rights from phpgw_acl where acl_appname = '$app' and " . "acl_location in "; $security = "('". $this->account_id ."'"; $myaccounts = CreateObject('phpgwapi.accounts'); $my_memberships = $myaccounts->membership($this->account_id); unset($myaccounts); @reset($my_memberships); while($my_memberships && list($key,$group) = each($my_memberships)) { $security .= ",'" . $group['account_id'] . "'"; } $security .= ')'; $db2->query($sql . $security ,__LINE__,__FILE__); $rights = 0; $accounts = Array(); if ($db2->num_rows() == 0) { $grants[$GLOBALS['phpgw_info']['user']['account_id']] = (~ 0); return $grants; } while ($db2->next_record()) { $grantor = $db2->f('acl_account'); $rights = $db2->f('acl_rights'); if(!isset($accounts[$grantor])) // cache the group-members for performance { // if $grantor is a group, get its members $members = $this->get_ids_for_location($grantor,1,'phpgw_group'); if(!$members) { $accounts[$grantor] = Array($grantor); $is_group[$grantor] = False; } else { $accounts[$grantor] = $members; $is_group[$grantor] = True; } } if(@$is_group[$grantor]) { // Don't allow to override private! $rights &= (~ PHPGW_ACL_PRIVATE); } while(list($nul,$grantors) = each($accounts[$grantor])) { if(!isset($grants[$grantors])) { $grants[$grantors] = 0; } $grants[$grantors] |= $rights; } reset($accounts[$grantor]); } $grants[$GLOBALS['phpgw_info']['user']['account_id']] = (~ 0); return $grants; } } //end of acl class ?>