plugins/LdapAuthorization/LdapAuthorizationPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to enable LDAP Authorization
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @copyright 2009 Craig Andrews http://candrews.integralblue.com
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 class LdapAuthorizationPlugin extends AuthorizationPlugin
  35 {
  36     public $roles_to_groups = array();
  37     public $login_group = null;
  38
  39     function onInitializePlugin(){
  40         if(!isset($this->provider_name)){
  41             throw new Exception("provider_name must be set. Use the provider_name from the LDAP Authentication plugin.");
  42         }
  43         if(!isset($this->uniqueMember_attribute)){
  44             throw new Exception("uniqueMember_attribute must be set.");
  45         }
  46         $this->ldapCommon = new LdapCommon(get_object_vars($this));
  47     }
  48
  49     function onAutoload($cls)
  50     {
  51         switch ($cls)
  52         {
  53          case 'LdapCommon':
  54             require_once(INSTALLDIR.'/plugins/LdapCommon/LdapCommon.php');
  55             return false;
  56         }
  57     }
  58
  59     //---interface implementation---//
  60     function loginAllowed($user) {
  61         $user_username = new User_username();
  62         $user_username->user_id=$user->id;
  63         $user_username->provider_name=$this->provider_name;
  64         if($user_username->find() && $user_username->fetch()){
  65             $entry = $this->ldapCommon->get_user($user_username->username);
  66             if($entry){
  67                 if(isset($this->login_group)){
  68                     if(is_array($this->login_group)){
  69                         foreach($this->login_group as $group){
  70                             if($this->ldapCommon->is_dn_member_of_group($entry->dn(),$group)){
  71                                 return true;
  72                             }
  73                         }
  74                     }else{
  75                         if($this->ldapCommon->is_dn_member_of_group($entry->dn(),$this->login_group)){
  76                             return true;
  77                         }
  78                     }
  79                     return null;
  80                 }else{
  81                     //if a user exists, we can assume he's allowed to login
  82                     return true;
  83                 }
  84             }else{
  85                 return null;
  86             }
  87         }else{
  88             return null;
  89         }
  90     }
  91
  92     function hasRole($profile, $name) {
  93         $user_username = new User_username();
  94         $user_username->user_id=$profile->id;
  95         $user_username->provider_name=$this->provider_name;
  96         if($user_username->find() && $user_username->fetch()){
  97             $entry = $this->ldapCommon->get_user($user_username->username);
  98             if($entry){
  99                 if(isset($this->roles_to_groups[$name])){
 100                     if(is_array($this->roles_to_groups[$name])){
 101                         foreach($this->roles_to_groups[$name] as $group){
 102                             if($this->ldapCommon->is_dn_member_of_group($entry->dn(),$group)){
 103                                 return true;
 104                             }
 105                         }
 106                     }else{
 107                         if($this->ldapCommon->is_dn_member_of_group($entry->dn(),$this->roles_to_groups[$name])){
 108                             return true;
 109                         }
 110                     }
 111                 }
 112             }
 113         }
 114         return false;
 115     }
 116
 117     function onPluginVersion(&$versions)
 118     {
 119         $versions[] = array('name' => 'LDAP Authorization',
 120                             'version' => STATUSNET_VERSION,
 121                             'author' => 'Craig Andrews',
 122                             'homepage' => 'http://status.net/wiki/Plugin:LdapAuthorization',
 123                             'rawdescription' =>
 124                             _m('The LDAP Authorization plugin allows for StatusNet to handle authorization through LDAP.'));
 125         return true;
 126     }
 127 }