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