plugins/LdapAuthentication/LdapAuthenticationPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to enable LDAP Authentication
   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 Free Software Foundation, Inc http://www.fsf.org
  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 LdapAuthenticationPlugin extends AuthenticationPlugin
  35 {
  36     function onInitializePlugin(){
  37         parent::onInitializePlugin();
  38         if(!isset($this->attributes['nickname'])){
  39             // TRANS: Exception thrown when initialising the LDAP Auth plugin fails because of an incorrect configuration.
  40             throw new Exception(_m('You must specify a nickname attribute.'));
  41         }
  42         if($this->password_changeable && (! isset($this->attributes['password']) || !isset($this->password_encoding))){
  43             // TRANS: Exception thrown when initialising the LDAP Auth plugin fails because of an incorrect configuration.
  44             throw new Exception(_m('If password_changeable is set, the password attribute and password_encoding must also be specified.'));
  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     function onEndShowPageNotice($action)
  60     {
  61         $name = $action->trimmed('action');
  62         $instr = false;
  63
  64         switch ($name)
  65         {
  66          case 'register':
  67             if($this->autoregistration) {
  68                 // TRANS: Instructions for LDAP authentication.
  69                 $instr = _m('Do you have an LDAP account? Use your standard username and password.');
  70             }
  71             break;
  72          case 'login':
  73             // TRANS: Instructions for LDAP authentication.
  74             $instr = _m('Do you have an LDAP account? Use your standard username and password.');
  75             break;
  76          default:
  77             return true;
  78         }
  79
  80         if($instr) {
  81             $output = common_markup_to_html($instr);
  82             $action->raw($output);
  83         }
  84         return true;
  85     }
  86
  87     //---interface implementation---//
  88
  89     function checkPassword($username, $password)
  90     {
  91         return $this->ldapCommon->checkPassword($username,$password);
  92     }
  93
  94     function autoRegister($username, $nickname)
  95     {
  96         if(is_null($nickname)){
  97             $nickname = $username;
  98         }
  99         $entry = $this->ldapCommon->get_user($username,$this->attributes);
 100         if($entry){
 101             $registration_data = array();
 102             foreach($this->attributes as $sn_attribute=>$ldap_attribute){
 103                 //ldap won't let us read a user's password,
 104                 //and we're going to set the password to a random string later anyways,
 105                 //so don't bother trying to read it.
 106                 if($sn_attribute != 'password'){
 107                     $registration_data[$sn_attribute]=$entry->getValue($ldap_attribute,'single');
 108                 }
 109             }
 110             if(isset($registration_data['email']) && !empty($registration_data['email'])){
 111                 $registration_data['email_confirmed']=true;
 112             }
 113             $registration_data['nickname'] = $nickname;
 114             //set the database saved password to a random string.
 115             $registration_data['password']=common_good_rand(16);
 116             return User::register($registration_data);
 117         }else{
 118             //user isn't in ldap, so we cannot register him
 119             return false;
 120         }
 121     }
 122
 123     function changePassword($username,$oldpassword,$newpassword)
 124     {
 125         return $this->ldapCommon->changePassword($username,$oldpassword,$newpassword);
 126     }
 127
 128     function suggestNicknameForUsername($username)
 129     {
 130         $entry = $this->ldapCommon->get_user($username, $this->attributes);
 131         if(!$entry){
 132             //this really shouldn't happen
 133             $nickname = $username;
 134         }else{
 135             $nickname = $entry->getValue($this->attributes['nickname'],'single');
 136             if(!$nickname){
 137                 $nickname = $username;
 138             }
 139         }
 140         return common_nicknamize($nickname);
 141     }
 142
 143     function onPluginVersion(&$versions)
 144     {
 145         $versions[] = array('name' => 'LDAP Authentication',
 146                             'version' => STATUSNET_VERSION,
 147                             'author' => 'Craig Andrews',
 148                             'homepage' => 'http://status.net/wiki/Plugin:LdapAuthentication',
 149                             'rawdescription' =>
 150                             // TRANS: Plugin description.
 151                             _m('The LDAP Authentication plugin allows for StatusNet to handle authentication through LDAP.'));
 152         return true;
 153     }
 154 }