3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin to enable LDAP Authorization
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.
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.
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/>.
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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 require_once 'Net/LDAP2.php';
36 class LdapAuthorizationPlugin extends AuthorizationPlugin
41 public $starttls=null;
48 public $provider_name = null;
49 public $uniqueMember_attribute = null;
50 public $roles_to_groups = array();
51 public $login_group = null;
52 public $attributes = array();
54 function onInitializePlugin(){
55 if(!isset($this->host)){
56 throw new Exception("must specify a host");
58 if(!isset($this->basedn)){
59 throw new Exception("must specify a basedn");
61 if(!isset($this->provider_name)){
62 throw new Exception("provider_name must be set. Use the provider_name from the LDAP Authentication plugin.");
64 if(!isset($this->uniqueMember_attribute)){
65 throw new Exception("uniqueMember_attribute must be set.");
67 if(!isset($this->attributes['username'])){
68 throw new Exception("username attribute must be set.");
72 //---interface implementation---//
73 function loginAllowed($user) {
74 $user_username = new User_username();
75 $user_username->user_id=$user->id;
76 $user_username->provider_name=$this->provider_name;
77 if($user_username->find() && $user_username->fetch()){
78 $entry = $this->ldap_get_user($user_username->username);
80 if(isset($this->login_group)){
81 if(is_array($this->login_group)){
82 foreach($this->login_group as $group){
83 if($this->ldap_is_dn_member_of_group($entry->dn(),$group)){
88 if($this->ldap_is_dn_member_of_group($entry->dn(),$this->login_group)){
94 //if a user exists, we can assume he's allowed to login
105 function hasRole($profile, $name) {
106 $user_username = new User_username();
107 $user_username->user_id=$profile->id;
108 $user_username->provider_name=$this->provider_name;
109 if($user_username->find() && $user_username->fetch()){
110 $entry = $this->ldap_get_user($user_username->username);
112 if(isset($this->roles_to_groups[$name])){
113 if(is_array($this->roles_to_groups[$name])){
114 foreach($this->roles_to_groups[$name] as $group){
115 if($this->ldap_is_dn_member_of_group($entry->dn(),$group)){
120 if($this->ldap_is_dn_member_of_group($entry->dn(),$this->roles_to_groups[$name])){
130 function ldap_is_dn_member_of_group($userDn, $groupDn)
132 $ldap = $this->ldap_get_connection();
133 $link = $ldap->getLink();
134 $r = ldap_compare($link, $groupDn, $this->uniqueMember_attribute, $userDn);
137 }else if($r === false){
140 common_log(LOG_ERR, ldap_error($r));
145 function ldap_get_config(){
147 $keys = array('host','port','version','starttls','binddn','bindpw','basedn','options','filter','scope');
148 foreach($keys as $key){
149 $value = $this->$key;
151 $config[$key]=$value;
157 //-----the below function were copied from LDAPAuthenticationPlugin. They will be moved to a utility class soon.----\\
158 function ldap_get_connection($config = null){
159 if($config == null && isset($this->default_ldap)){
160 return $this->default_ldap;
163 //cannot use Net_LDAP2::connect() as StatusNet uses
164 //PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'handleError');
165 //PEAR handling can be overridden on instance objects, so we do that.
166 $ldap = new Net_LDAP2(isset($config)?$config:$this->ldap_get_config());
167 $ldap->setErrorHandling(PEAR_ERROR_RETURN);
169 if (Net_LDAP2::isError($err)) {
170 common_log(LOG_WARNING, 'Could not connect to LDAP server: '.$err->getMessage());
173 if($config == null) $this->default_ldap=$ldap;
178 * get an LDAP entry for a user with a given username
180 * @param string $username
181 * $param array $attributes LDAP attributes to retrieve
184 function ldap_get_user($username,$attributes=array(),$ldap=null){
186 $ldap = $this->ldap_get_connection();
188 $filter = Net_LDAP2_Filter::create($this->attributes['username'], 'equals', $username);
190 'attributes' => $attributes
192 $search = $ldap->search(null,$filter,$options);
194 if (PEAR::isError($search)) {
195 common_log(LOG_WARNING, 'Error while getting DN for user: '.$search->getMessage());
199 if($search->count()==0){
201 }else if($search->count()==1){
202 $entry = $search->shiftEntry();
205 common_log(LOG_WARNING, 'Found ' . $search->count() . ' ldap user with the username: ' . $username);
210 function onPluginVersion(&$versions)
212 $versions[] = array('name' => 'LDAP Authorization',
213 'version' => STATUSNET_VERSION,
214 'author' => 'Craig Andrews',
215 'homepage' => 'http://status.net/wiki/Plugin:LdapAuthorization',
217 _m('The LDAP Authorization plugin allows for StatusNet to handle authorization through LDAP.'));