1<?php 2// must be run within Dokuwiki 3if(!defined('DOKU_INC')) die(); 4 5/** 6 * LDAP authentication backend 7 * 8 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 9 * @author Andreas Gohr <andi@splitbrain.org> 10 * @author Chris Smith <chris@jalakaic.co.uk> 11 * @author Jan Schumann <js@schumann-it.com> 12 */ 13class auth_plugin_authldap extends DokuWiki_Auth_Plugin { 14 /* @var resource $con holds the LDAP connection*/ 15 protected $con = null; 16 17 /* @var int $bound What type of connection does already exist? */ 18 protected $bound = 0; // 0: anonymous, 1: user, 2: superuser 19 20 /* @var array $users User data cache */ 21 protected $users = null; 22 23 /* @var array $_pattern User filter pattern */ 24 protected $_pattern = null; 25 26 /** 27 * Constructor 28 */ 29 public function __construct() { 30 parent::__construct(); 31 32 // ldap extension is needed 33 if(!function_exists('ldap_connect')) { 34 $this->_debug("LDAP err: PHP LDAP extension not found.", -1, __LINE__, __FILE__); 35 $this->success = false; 36 return; 37 } 38 39 // auth_ldap currently just handles authentication, so no 40 // capabilities are set 41 } 42 43 /** 44 * Check user+password 45 * 46 * Checks if the given user exists and the given 47 * plaintext password is correct by trying to bind 48 * to the LDAP server 49 * 50 * @author Andreas Gohr <andi@splitbrain.org> 51 * @param string $user 52 * @param string $pass 53 * @return bool 54 */ 55 public function checkPass($user, $pass) { 56 // reject empty password 57 if(empty($pass)) return false; 58 if(!$this->_openLDAP()) return false; 59 60 // indirect user bind 61 if($this->getConf('binddn') && $this->getConf('bindpw')) { 62 // use superuser credentials 63 if(!@ldap_bind($this->con, $this->getConf('binddn'), $this->getConf('bindpw'))) { 64 $this->_debug('LDAP bind as superuser: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 65 return false; 66 } 67 $this->bound = 2; 68 } else if($this->getConf('binddn') && 69 $this->getConf('usertree') && 70 $this->getConf('userfilter') 71 ) { 72 // special bind string 73 $dn = $this->_makeFilter( 74 $this->getConf('binddn'), 75 array('user'=> $user, 'server'=> $this->getConf('server')) 76 ); 77 78 } else if(strpos($this->getConf('usertree'), '%{user}')) { 79 // direct user bind 80 $dn = $this->_makeFilter( 81 $this->getConf('usertree'), 82 array('user'=> $user, 'server'=> $this->getConf('server')) 83 ); 84 85 } else { 86 // Anonymous bind 87 if(!@ldap_bind($this->con)) { 88 msg("LDAP: can not bind anonymously", -1); 89 $this->_debug('LDAP anonymous bind: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 90 return false; 91 } 92 } 93 94 // Try to bind to with the dn if we have one. 95 if(!empty($dn)) { 96 // User/Password bind 97 if(!@ldap_bind($this->con, $dn, $pass)) { 98 $this->_debug("LDAP: bind with $dn failed", -1, __LINE__, __FILE__); 99 $this->_debug('LDAP user dn bind: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 100 return false; 101 } 102 $this->bound = 1; 103 return true; 104 } else { 105 // See if we can find the user 106 $info = $this->_getUserData($user, true); 107 if(empty($info['dn'])) { 108 return false; 109 } else { 110 $dn = $info['dn']; 111 } 112 113 // Try to bind with the dn provided 114 if(!@ldap_bind($this->con, $dn, $pass)) { 115 $this->_debug("LDAP: bind with $dn failed", -1, __LINE__, __FILE__); 116 $this->_debug('LDAP user bind: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 117 return false; 118 } 119 $this->bound = 1; 120 return true; 121 } 122 } 123 124 /** 125 * Return user info 126 * 127 * Returns info about the given user needs to contain 128 * at least these fields: 129 * 130 * name string full name of the user 131 * mail string email addres of the user 132 * grps array list of groups the user is in 133 * 134 * This LDAP specific function returns the following 135 * addional fields: 136 * 137 * dn string distinguished name (DN) 138 * uid string Posix User ID 139 * inbind bool for internal use - avoid loop in binding 140 * 141 * @author Andreas Gohr <andi@splitbrain.org> 142 * @author Trouble 143 * @author Dan Allen <dan.j.allen@gmail.com> 144 * @author <evaldas.auryla@pheur.org> 145 * @author Stephane Chazelas <stephane.chazelas@emerson.com> 146 * @author Steffen Schoch <schoch@dsb.net> 147 * 148 * @param string $user 149 * @param bool $requireGroups (optional) - ignored, groups are always supplied by this plugin 150 * @return array containing user data or false 151 */ 152 public function getUserData($user, $requireGroups=true) { 153 return $this->_getUserData($user); 154 } 155 156 /** 157 * @param string $user 158 * @param bool $inbind authldap specific, true if in bind phase 159 * @return array containing user data or false 160 */ 161 protected function _getUserData($user, $inbind = false) { 162 global $conf; 163 if(!$this->_openLDAP()) return false; 164 165 // force superuser bind if wanted and not bound as superuser yet 166 if($this->getConf('binddn') && $this->getConf('bindpw') && $this->bound < 2) { 167 // use superuser credentials 168 if(!@ldap_bind($this->con, $this->getConf('binddn'), $this->getConf('bindpw'))) { 169 $this->_debug('LDAP bind as superuser: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 170 return false; 171 } 172 $this->bound = 2; 173 } elseif($this->bound == 0 && !$inbind) { 174 // in some cases getUserData is called outside the authentication workflow 175 // eg. for sending email notification on subscribed pages. This data might not 176 // be accessible anonymously, so we try to rebind the current user here 177 list($loginuser, $loginsticky, $loginpass) = auth_getCookie(); 178 if($loginuser && $loginpass) { 179 $loginpass = auth_decrypt($loginpass, auth_cookiesalt(!$loginsticky, true)); 180 $this->checkPass($loginuser, $loginpass); 181 } 182 } 183 184 $info['user'] = $user; 185 $info['server'] = $this->getConf('server'); 186 187 //get info for given user 188 $base = $this->_makeFilter($this->getConf('usertree'), $info); 189 if($this->getConf('userfilter')) { 190 $filter = $this->_makeFilter($this->getConf('userfilter'), $info); 191 } else { 192 $filter = "(ObjectClass=*)"; 193 } 194 195 $sr = $this->_ldapsearch($this->con, $base, $filter, $this->getConf('userscope')); 196 $result = @ldap_get_entries($this->con, $sr); 197 $this->_debug('LDAP user search: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 198 $this->_debug('LDAP search at: '.htmlspecialchars($base.' '.$filter), 0, __LINE__, __FILE__); 199 200 // Don't accept more or less than one response 201 if(!is_array($result) || $result['count'] != 1) { 202 return false; //user not found 203 } 204 205 $user_result = $result[0]; 206 ldap_free_result($sr); 207 208 // general user info 209 $info['dn'] = $user_result['dn']; 210 $info['gid'] = $user_result['gidnumber'][0]; 211 $info['mail'] = $user_result['mail'][0]; 212 $info['name'] = $user_result['cn'][0]; 213 $info['grps'] = array(); 214 215 // overwrite if other attribs are specified. 216 if(is_array($this->getConf('mapping'))) { 217 foreach($this->getConf('mapping') as $localkey => $key) { 218 if(is_array($key)) { 219 // use regexp to clean up user_result 220 list($key, $regexp) = each($key); 221 if($user_result[$key]) foreach($user_result[$key] as $grpkey => $grp) { 222 if($grpkey !== 'count' && preg_match($regexp, $grp, $match)) { 223 if($localkey == 'grps') { 224 $info[$localkey][] = $match[1]; 225 } else { 226 $info[$localkey] = $match[1]; 227 } 228 } 229 } 230 } else { 231 $info[$localkey] = $user_result[$key][0]; 232 } 233 } 234 } 235 $user_result = array_merge($info, $user_result); 236 237 //get groups for given user if grouptree is given 238 if($this->getConf('grouptree') || $this->getConf('groupfilter')) { 239 $base = $this->_makeFilter($this->getConf('grouptree'), $user_result); 240 $filter = $this->_makeFilter($this->getConf('groupfilter'), $user_result); 241 $sr = $this->_ldapsearch($this->con, $base, $filter, $this->getConf('groupscope'), array($this->getConf('groupkey'))); 242 $this->_debug('LDAP group search: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 243 $this->_debug('LDAP search at: '.htmlspecialchars($base.' '.$filter), 0, __LINE__, __FILE__); 244 245 if(!$sr) { 246 msg("LDAP: Reading group memberships failed", -1); 247 return false; 248 } 249 $result = ldap_get_entries($this->con, $sr); 250 ldap_free_result($sr); 251 252 if(is_array($result)) foreach($result as $grp) { 253 if(!empty($grp[$this->getConf('groupkey')])) { 254 $group = $grp[$this->getConf('groupkey')]; 255 if(is_array($group)){ 256 $group = $group[0]; 257 } else { 258 $this->_debug('groupkey did not return a detailled result', 0, __LINE__, __FILE__); 259 } 260 if($group === '') continue; 261 262 $this->_debug('LDAP usergroup: '.htmlspecialchars($group), 0, __LINE__, __FILE__); 263 $info['grps'][] = $group; 264 } 265 } 266 } 267 268 // always add the default group to the list of groups 269 if(!$info['grps'] or !in_array($conf['defaultgroup'], $info['grps'])) { 270 $info['grps'][] = $conf['defaultgroup']; 271 } 272 return $info; 273 } 274 275 /** 276 * Most values in LDAP are case-insensitive 277 * 278 * @return bool 279 */ 280 public function isCaseSensitive() { 281 return false; 282 } 283 284 /** 285 * Bulk retrieval of user data 286 * 287 * @author Dominik Eckelmann <dokuwiki@cosmocode.de> 288 * @param int $start index of first user to be returned 289 * @param int $limit max number of users to be returned 290 * @param array $filter array of field/pattern pairs, null for no filter 291 * @return array of userinfo (refer getUserData for internal userinfo details) 292 */ 293 function retrieveUsers($start = 0, $limit = 0, $filter = array()) { 294 if(!$this->_openLDAP()) return false; 295 296 if(is_null($this->users)) { 297 // Perform the search and grab all their details 298 if($this->getConf('userfilter')) { 299 $all_filter = str_replace('%{user}', '*', $this->getConf('userfilter')); 300 } else { 301 $all_filter = "(ObjectClass=*)"; 302 } 303 $sr = ldap_search($this->con, $this->getConf('usertree'), $all_filter); 304 $entries = ldap_get_entries($this->con, $sr); 305 $users_array = array(); 306 for($i = 0; $i < $entries["count"]; $i++) { 307 array_push($users_array, $entries[$i]["uid"][0]); 308 } 309 asort($users_array); 310 $result = $users_array; 311 if(!$result) return array(); 312 $this->users = array_fill_keys($result, false); 313 } 314 $i = 0; 315 $count = 0; 316 $this->_constructPattern($filter); 317 $result = array(); 318 319 foreach($this->users as $user => &$info) { 320 if($i++ < $start) { 321 continue; 322 } 323 if($info === false) { 324 $info = $this->getUserData($user); 325 } 326 if($this->_filter($user, $info)) { 327 $result[$user] = $info; 328 if(($limit > 0) && (++$count >= $limit)) break; 329 } 330 } 331 return $result; 332 } 333 334 /** 335 * Make LDAP filter strings. 336 * 337 * Used by auth_getUserData to make the filter 338 * strings for grouptree and groupfilter 339 * 340 * @author Troels Liebe Bentsen <tlb@rapanden.dk> 341 * @param string $filter ldap search filter with placeholders 342 * @param array $placeholders placeholders to fill in 343 * @return string 344 */ 345 protected function _makeFilter($filter, $placeholders) { 346 preg_match_all("/%{([^}]+)/", $filter, $matches, PREG_PATTERN_ORDER); 347 //replace each match 348 foreach($matches[1] as $match) { 349 //take first element if array 350 if(is_array($placeholders[$match])) { 351 $value = $placeholders[$match][0]; 352 } else { 353 $value = $placeholders[$match]; 354 } 355 $value = $this->_filterEscape($value); 356 $filter = str_replace('%{'.$match.'}', $value, $filter); 357 } 358 return $filter; 359 } 360 361 /** 362 * return true if $user + $info match $filter criteria, false otherwise 363 * 364 * @author Chris Smith <chris@jalakai.co.uk> 365 * 366 * @param string $user the user's login name 367 * @param array $info the user's userinfo array 368 * @return bool 369 */ 370 protected function _filter($user, $info) { 371 foreach($this->_pattern as $item => $pattern) { 372 if($item == 'user') { 373 if(!preg_match($pattern, $user)) return false; 374 } else if($item == 'grps') { 375 if(!count(preg_grep($pattern, $info['grps']))) return false; 376 } else { 377 if(!preg_match($pattern, $info[$item])) return false; 378 } 379 } 380 return true; 381 } 382 383 /** 384 * Set the filter pattern 385 * 386 * @author Chris Smith <chris@jalakai.co.uk> 387 * 388 * @param $filter 389 * @return void 390 */ 391 protected function _constructPattern($filter) { 392 $this->_pattern = array(); 393 foreach($filter as $item => $pattern) { 394 $this->_pattern[$item] = '/'.str_replace('/', '\/', $pattern).'/i'; // allow regex characters 395 } 396 } 397 398 /** 399 * Escape a string to be used in a LDAP filter 400 * 401 * Ported from Perl's Net::LDAP::Util escape_filter_value 402 * 403 * @author Andreas Gohr 404 * @param string $string 405 * @return string 406 */ 407 protected function _filterEscape($string) { 408 return preg_replace( 409 '/([\x00-\x1F\*\(\)\\\\])/e', 410 '"\\\\\".join("",unpack("H2","$1"))', 411 $string 412 ); 413 } 414 415 /** 416 * Opens a connection to the configured LDAP server and sets the wanted 417 * option on the connection 418 * 419 * @author Andreas Gohr <andi@splitbrain.org> 420 */ 421 protected function _openLDAP() { 422 if($this->con) return true; // connection already established 423 424 $this->bound = 0; 425 426 $port = $this->getConf('port'); 427 $bound = false; 428 $servers = explode(',', $this->getConf('server')); 429 foreach($servers as $server) { 430 $server = trim($server); 431 $this->con = @ldap_connect($server, $port); 432 if(!$this->con) { 433 continue; 434 } 435 436 /* 437 * When OpenLDAP 2.x.x is used, ldap_connect() will always return a resource as it does 438 * not actually connect but just initializes the connecting parameters. The actual 439 * connect happens with the next calls to ldap_* funcs, usually with ldap_bind(). 440 * 441 * So we should try to bind to server in order to check its availability. 442 */ 443 444 //set protocol version and dependend options 445 if($this->getConf('version')) { 446 if(!@ldap_set_option( 447 $this->con, LDAP_OPT_PROTOCOL_VERSION, 448 $this->getConf('version') 449 ) 450 ) { 451 msg('Setting LDAP Protocol version '.$this->getConf('version').' failed', -1); 452 $this->_debug('LDAP version set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 453 } else { 454 //use TLS (needs version 3) 455 if($this->getConf('starttls')) { 456 if(!@ldap_start_tls($this->con)) { 457 msg('Starting TLS failed', -1); 458 $this->_debug('LDAP TLS set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 459 } 460 } 461 // needs version 3 462 if($this->getConf('referrals')) { 463 if(!@ldap_set_option( 464 $this->con, LDAP_OPT_REFERRALS, 465 $this->getConf('referrals') 466 ) 467 ) { 468 msg('Setting LDAP referrals to off failed', -1); 469 $this->_debug('LDAP referal set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 470 } 471 } 472 } 473 } 474 475 //set deref mode 476 if($this->getConf('deref')) { 477 if(!@ldap_set_option($this->con, LDAP_OPT_DEREF, $this->getConf('deref'))) { 478 msg('Setting LDAP Deref mode '.$this->getConf('deref').' failed', -1); 479 $this->_debug('LDAP deref set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 480 } 481 } 482 /* As of PHP 5.3.0 we can set timeout to speedup skipping of invalid servers */ 483 if(defined('LDAP_OPT_NETWORK_TIMEOUT')) { 484 ldap_set_option($this->con, LDAP_OPT_NETWORK_TIMEOUT, 1); 485 } 486 487 if($this->getConf('binddn') && $this->getConf('bindpw')) { 488 $bound = @ldap_bind($this->con, $this->getConf('binddn'), $this->getConf('bindpw')); 489 $this->bound = 2; 490 } else { 491 $bound = @ldap_bind($this->con); 492 } 493 if($bound) { 494 break; 495 } 496 } 497 498 if(!$bound) { 499 msg("LDAP: couldn't connect to LDAP server", -1); 500 return false; 501 } 502 503 $this->cando['getUsers'] = true; 504 return true; 505 } 506 507 /** 508 * Wraps around ldap_search, ldap_list or ldap_read depending on $scope 509 * 510 * @author Andreas Gohr <andi@splitbrain.org> 511 * @param resource $link_identifier 512 * @param string $base_dn 513 * @param string $filter 514 * @param string $scope can be 'base', 'one' or 'sub' 515 * @param null $attributes 516 * @param int $attrsonly 517 * @param int $sizelimit 518 * @param int $timelimit 519 * @param int $deref 520 * @return resource 521 */ 522 protected function _ldapsearch($link_identifier, $base_dn, $filter, $scope = 'sub', $attributes = null, 523 $attrsonly = 0, $sizelimit = 0) { 524 if(is_null($attributes)) $attributes = array(); 525 526 if($scope == 'base') { 527 return @ldap_read( 528 $link_identifier, $base_dn, $filter, $attributes, 529 $attrsonly, $sizelimit 530 ); 531 } elseif($scope == 'one') { 532 return @ldap_list( 533 $link_identifier, $base_dn, $filter, $attributes, 534 $attrsonly, $sizelimit 535 ); 536 } else { 537 return @ldap_search( 538 $link_identifier, $base_dn, $filter, $attributes, 539 $attrsonly, $sizelimit 540 ); 541 } 542 } 543 544 /** 545 * Wrapper around msg() but outputs only when debug is enabled 546 * 547 * @param string $message 548 * @param int $err 549 * @param int $line 550 * @param string $file 551 * @return void 552 */ 553 protected function _debug($message, $err, $line, $file) { 554 if(!$this->getConf('debug')) return; 555 msg($message, $err, $line, $file); 556 } 557 558} 559