plugins/LdapCommon/LdapCommon.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Utility class of LDAP functions
   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 // We bundle the Net/LDAP2 library...
  35 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib');
  36
  37 class LdapCommon
  38 {
  39     protected static $ldap_connections = array();
  40     public $host=null;
  41     public $port=null;
  42     public $version=null;
  43     public $starttls=null;
  44     public $binddn=null;
  45     public $bindpw=null;
  46     public $basedn=null;
  47     public $options=null;
  48     public $filter=null;
  49     public $scope=null;
  50     public $uniqueMember_attribute = null;
  51     public $attributes=array();
  52     public $password_encoding=null;
  53
  54     public function __construct($config)
  55     {
  56         Event::addHandler('Autoload',array($this,'onAutoload'));
  57         foreach($config as $key=>$value) {
  58             $this->$key = $value;
  59         }
  60         $this->ldap_config = $this->get_ldap_config();
  61
  62         if(!isset($this->host)){
  63             // TRANS: Exception thrown when initialising the LDAP Common plugin fails because of an incorrect configuration.
  64             throw new Exception(_m('A host must be specified.'));
  65         }
  66         if(!isset($this->basedn)){
  67             // TRANS: Exception thrown when initialising the LDAP Common plugin fails because of an incorrect configuration.
  68             throw new Exception(_m('"basedn" must be specified.'));
  69         }
  70         if(!isset($this->attributes['username'])){
  71             // TRANS: Exception thrown when initialising the LDAP Common plugin fails because of an incorrect configuration.
  72             throw new Exception(_m('The username attribute must be set.'));
  73         }
  74     }
  75
  76     function onAutoload($cls)
  77     {
  78         switch ($cls)
  79         {
  80          case 'MemcacheSchemaCache':
  81             require_once(INSTALLDIR.'/plugins/LdapCommon/MemcacheSchemaCache.php');
  82             return false;
  83          case 'Net_LDAP2':
  84             require_once 'Net/LDAP2.php';
  85             return false;
  86          case 'Net_LDAP2_Filter':
  87             require_once 'Net/LDAP2/Filter.php';
  88             return false;
  89          case 'Net_LDAP2_Filter':
  90             require_once 'Net/LDAP2/Filter.php';
  91             return false;
  92          case 'Net_LDAP2_Entry':
  93             require_once 'Net/LDAP2/Entry.php';
  94             return false;
  95         }
  96     }
  97
  98     function get_ldap_config(){
  99         $config = array();
 100         $keys = array('host','port','version','starttls','binddn','bindpw','basedn','options','filter','scope');
 101         foreach($keys as $key){
 102             $value = $this->$key;
 103             if($value!==null){
 104                 $config[$key]=$value;
 105             }
 106         }
 107         return $config;
 108     }
 109
 110     function get_ldap_connection($config = null){
 111         if($config == null) {
 112             $config = $this->ldap_config;
 113         }
 114         $config_id = crc32(serialize($config));
 115         if(array_key_exists($config_id,self::$ldap_connections)) {
 116             $ldap = self::$ldap_connections[$config_id];
 117         } else {
 118             //cannot use Net_LDAP2::connect() as StatusNet uses
 119             //PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'handleError');
 120             //PEAR handling can be overridden on instance objects, so we do that.
 121             $ldap = new Net_LDAP2($config);
 122             $ldap->setErrorHandling(PEAR_ERROR_RETURN);
 123             $err=$ldap->bind();
 124             if (Net_LDAP2::isError($err)) {
 125                 // if we were called with a config, assume caller will handle
 126                 // incorrect username/password (LDAP_INVALID_CREDENTIALS)
 127                 if (isset($config) && $err->getCode() == 0x31) {
 128                     // TRANS: Exception thrown in the LDAP Common plugin when LDAP server is not available.
 129                     // TRANS: %s is the error message.
 130                     throw new LdapInvalidCredentialsException(sprintf(_m('Could not connect to LDAP server: %s'),$err->getMessage()));
 131                 }
 132                 // TRANS: Exception thrown in the LDAP Common plugin when LDAP server is not available.
 133                 // TRANS: %s is the error message.
 134                 throw new Exception(sprintf(_m('Could not connect to LDAP server: %s.'),$err->getMessage()));
 135             }
 136             $c = Cache::instance();
 137             if (!empty($c)) {
 138                 $cacheObj = new MemcacheSchemaCache(
 139                     array('c'=>$c,
 140                        'cacheKey' => Cache::key('ldap_schema:' . $config_id)));
 141                 $ldap->registerSchemaCache($cacheObj);
 142             }
 143             self::$ldap_connections[$config_id] = $ldap;
 144         }
 145         return $ldap;
 146     }
 147
 148     function checkPassword($username, $password)
 149     {
 150         $entry = $this->get_user($username,array('dn' => 'dn'));
 151         if(!$entry){
 152             return false;
 153         }else{
 154             if(empty($password)) {
 155                 //NET_LDAP2 will do an anonymous bind if bindpw is not set / empty string
 156                 //which causes all login attempts that involve a blank password to appear
 157                 //to succeed. Which is obviously not good.
 158                 return false;
 159             }
 160             $config = $this->get_ldap_config();
 161             $config['binddn']=$entry->dn();
 162             $config['bindpw']=$password;
 163             try {
 164                 $this->get_ldap_connection($config);
 165             } catch (LdapInvalidCredentialsException $e) {
 166                 return false;
 167             }
 168             return true;
 169         }
 170     }
 171
 172     function changePassword($username,$oldpassword,$newpassword)
 173     {
 174         if(! isset($this->attributes['password']) || !isset($this->password_encoding)){
 175             //throw new Exception(_m('Sorry, changing LDAP passwords is not supported at this time.'));
 176             return false;
 177         }
 178         $entry = $this->get_user($username,array('dn' => 'dn'));
 179         if(!$entry){
 180             return false;
 181         }else{
 182             $config = $this->get_ldap_config();
 183             $config['binddn']=$entry->dn();
 184             $config['bindpw']=$oldpassword;
 185             try {
 186                 $ldap = $this->get_ldap_connection($config);
 187
 188                 $entry = $this->get_user($username,array(),$ldap);
 189
 190                 $newCryptedPassword = $this->hashPassword($newpassword, $this->password_encoding);
 191                 if ($newCryptedPassword===false) {
 192                     return false;
 193                 }
 194                 if($this->password_encoding=='ad') {
 195                     //TODO I believe this code will work once this bug is fixed: http://pear.php.net/bugs/bug.php?id=16796
 196                     $oldCryptedPassword = $this->hashPassword($oldpassword, $this->password_encoding);
 197                     $entry->delete( array($this->attributes['password'] => $oldCryptedPassword ));
 198                 }
 199                 $entry->replace( array($this->attributes['password'] => $newCryptedPassword ), true);
 200                 if( Net_LDAP2::isError($entry->upate()) ) {
 201                     return false;
 202                 }
 203                 return true;
 204             } catch (LdapInvalidCredentialsException $e) {
 205                 return false;
 206             }
 207         }
 208
 209         return false;
 210     }
 211
 212     function is_dn_member_of_group($userDn, $groupDn)
 213     {
 214         $ldap = $this->get_ldap_connection();
 215         $link = $ldap->getLink();
 216         $r = @ldap_compare($link, $groupDn, $this->uniqueMember_attribute, $userDn);
 217         if ($r === true){
 218             return true;
 219         }else if($r === false){
 220             return false;
 221         }else{
 222             common_log(LOG_ERR, "LDAP error determining if userDn=$userDn is a member of groupDn=$groupDn using uniqueMember_attribute=$this->uniqueMember_attribute error: ".ldap_error($link));
 223             return false;
 224         }
 225     }
 226
 227     /**
 228      * get an LDAP entry for a user with a given username
 229      *
 230      * @param string $username
 231      * $param array $attributes LDAP attributes to retrieve
 232      * @return string DN
 233      */
 234     function get_user($username,$attributes=array()){
 235         $ldap = $this->get_ldap_connection();
 236         $filter = Net_LDAP2_Filter::create($this->attributes['username'], 'equals',  $username);
 237         $options = array(
 238             'attributes' => $attributes
 239         );
 240         $search = $ldap->search(null,$filter,$options);
 241
 242         if (PEAR::isError($search)) {
 243             common_log(LOG_WARNING, 'Error while getting DN for user: '.$search->getMessage());
 244             return false;
 245         }
 246
 247         if($search->count()==0){
 248             return false;
 249         }else if($search->count()==1){
 250             $entry = $search->shiftEntry();
 251             return $entry;
 252         }else{
 253             common_log(LOG_WARNING, 'Found ' . $search->count() . ' ldap user with the username: ' . $username);
 254             return false;
 255         }
 256     }
 257
 258     /**
 259      * Code originaly from the phpLDAPadmin development team
 260      * http://phpldapadmin.sourceforge.net/
 261      *
 262      * Hashes a password and returns the hash based on the specified enc_type.
 263      *
 264      * @param string $passwordClear The password to hash in clear text.
 265      * @param string $encodageType Standard LDAP encryption type which must be one of
 266      *        crypt, ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear.
 267      * @return string The hashed password.
 268      *
 269      */
 270     function hashPassword( $passwordClear, $encodageType )
 271     {
 272         $encodageType = strtolower( $encodageType );
 273         switch( $encodageType ) {
 274             case 'crypt':
 275                 $cryptedPassword = '{CRYPT}' . crypt($passwordClear,$this->randomSalt(2));
 276                 break;
 277
 278             case 'ext_des':
 279                 // extended des crypt. see OpenBSD crypt man page.
 280                 if ( ! defined( 'CRYPT_EXT_DES' ) || CRYPT_EXT_DES == 0 ) {return FALSE;} //Your system crypt library does not support extended DES encryption.
 281                 $cryptedPassword = '{CRYPT}' . crypt( $passwordClear, '_' . $this->randomSalt(8) );
 282                 break;
 283
 284             case 'md5crypt':
 285                 if( ! defined( 'CRYPT_MD5' ) || CRYPT_MD5 == 0 ) {return FALSE;} //Your system crypt library does not support md5crypt encryption.
 286                 $cryptedPassword = '{CRYPT}' . crypt( $passwordClear , '$1$' . $this->randomSalt(9) );
 287                 break;
 288
 289             case 'blowfish':
 290                 if( ! defined( 'CRYPT_BLOWFISH' ) || CRYPT_BLOWFISH == 0 ) {return FALSE;} //Your system crypt library does not support blowfish encryption.
 291                 $cryptedPassword = '{CRYPT}' . crypt( $passwordClear , '$2a$12$' . $this->randomSalt(13) ); // hardcoded to second blowfish version and set number of rounds
 292                 break;
 293
 294             case 'md5':
 295                 $cryptedPassword = '{MD5}' . base64_encode( pack( 'H*' , md5( $passwordClear) ) );
 296                 break;
 297
 298             case 'sha':
 299                 if( function_exists('sha1') ) {
 300                     // use php 4.3.0+ sha1 function, if it is available.
 301                     $cryptedPassword = '{SHA}' . base64_encode( pack( 'H*' , sha1( $passwordClear) ) );
 302                 } elseif( function_exists( 'mhash' ) ) {
 303                     $cryptedPassword = '{SHA}' . base64_encode( mhash( MHASH_SHA1, $passwordClear) );
 304                 } else {
 305                     return FALSE; //Your PHP install does not have the mhash() function. Cannot do SHA hashes.
 306                 }
 307                 break;
 308
 309             case 'ssha':
 310                 if( function_exists( 'mhash' ) && function_exists( 'mhash_keygen_s2k' ) ) {
 311                     mt_srand( (double) microtime() * 1000000 );
 312                     $salt = mhash_keygen_s2k( MHASH_SHA1, $passwordClear, substr( pack( "h*", md5( mt_rand() ) ), 0, 8 ), 4 );
 313                     $cryptedPassword = "{SSHA}".base64_encode( mhash( MHASH_SHA1, $passwordClear.$salt ).$salt );
 314                 } else {
 315                     return FALSE; //Your PHP install does not have the mhash() function. Cannot do SHA hashes.
 316                 }
 317                 break;
 318
 319             case 'smd5':
 320                 if( function_exists( 'mhash' ) && function_exists( 'mhash_keygen_s2k' ) ) {
 321                     mt_srand( (double) microtime() * 1000000 );
 322                     $salt = mhash_keygen_s2k( MHASH_MD5, $passwordClear, substr( pack( "h*", md5( mt_rand() ) ), 0, 8 ), 4 );
 323                     $cryptedPassword = "{SMD5}".base64_encode( mhash( MHASH_MD5, $passwordClear.$salt ).$salt );
 324                 } else {
 325                     return FALSE; //Your PHP install does not have the mhash() function. Cannot do SHA hashes.
 326                 }
 327                 break;
 328
 329             case 'ad':
 330                 $cryptedPassword = '';
 331                 $passwordClear = "\"" . $passwordClear . "\"";
 332                 $len = strlen($passwordClear);
 333                 for ($i = 0; $i < $len; $i++) {
 334                     $cryptedPassword .= "{$passwordClear{$i}}\000";
 335                 }
 336
 337             case 'clear':
 338             default:
 339                 $cryptedPassword = $passwordClear;
 340         }
 341
 342         return $cryptedPassword;
 343     }
 344
 345     /**
 346      * Code originaly from the phpLDAPadmin development team
 347      * http://phpldapadmin.sourceforge.net/
 348      *
 349      * Used to generate a random salt for crypt-style passwords. Salt strings are used
 350      * to make pre-built hash cracking dictionaries difficult to use as the hash algorithm uses
 351      * not only the user's password but also a randomly generated string. The string is
 352      * stored as the first N characters of the hash for reference of hashing algorithms later.
 353      *
 354      * --- added 20021125 by bayu irawan <bayuir@divnet.telkom.co.id> ---
 355      * --- ammended 20030625 by S C Rigler <srigler@houston.rr.com> ---
 356      *
 357      * @param int $length The length of the salt string to generate.
 358      * @return string The generated salt string.
 359      */
 360     function randomSalt( $length )
 361     {
 362         $possible = '0123456789'.
 363             'abcdefghijklmnopqrstuvwxyz'.
 364             'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.
 365             './';
 366         $str = "";
 367         mt_srand((double)microtime() * 1000000);
 368
 369         while( strlen( $str ) < $length )
 370             $str .= substr( $possible, ( rand() % strlen( $possible ) ), 1 );
 371
 372         return $str;
 373     }
 374 }
 375
 376 class LdapInvalidCredentialsException extends Exception
 377 {
 378 }