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 $inbind authldap specific, true if in bind phase 150 * @return array containing user data or false 151 */ 152 public function getUserData($user, $inbind = false) { 153 global $conf; 154 if(!$this->_openLDAP()) return false; 155 156 // force superuser bind if wanted and not bound as superuser yet 157 if($this->getConf('binddn') && $this->getConf('bindpw') && $this->bound < 2) { 158 // use superuser credentials 159 if(!@ldap_bind($this->con, $this->getConf('binddn'), $this->getConf('bindpw'))) { 160 $this->_debug('LDAP bind as superuser: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 161 return false; 162 } 163 $this->bound = 2; 164 } elseif($this->bound == 0 && !$inbind) { 165 // in some cases getUserData is called outside the authentication workflow 166 // eg. for sending email notification on subscribed pages. This data might not 167 // be accessible anonymously, so we try to rebind the current user here 168 list($loginuser, $loginsticky, $loginpass) = auth_getCookie(); 169 if($loginuser && $loginpass) { 170 $loginpass = auth_decrypt($loginpass, auth_cookiesalt(!$loginsticky, true)); 171 $this->checkPass($loginuser, $loginpass); 172 } 173 } 174 175 $info['user'] = $user; 176 $info['server'] = $this->getConf('server'); 177 178 //get info for given user 179 $base = $this->_makeFilter($this->getConf('usertree'), $info); 180 if($this->getConf('userfilter')) { 181 $filter = $this->_makeFilter($this->getConf('userfilter'), $info); 182 } else { 183 $filter = "(ObjectClass=*)"; 184 } 185 186 $sr = $this->_ldapsearch($this->con, $base, $filter, $this->getConf('userscope')); 187 $result = @ldap_get_entries($this->con, $sr); 188 $this->_debug('LDAP user search: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 189 $this->_debug('LDAP search at: '.htmlspecialchars($base.' '.$filter), 0, __LINE__, __FILE__); 190 191 // Don't accept more or less than one response 192 if(!is_array($result) || $result['count'] != 1) { 193 return false; //user not found 194 } 195 196 $user_result = $result[0]; 197 ldap_free_result($sr); 198 199 // general user info 200 $info['dn'] = $user_result['dn']; 201 $info['gid'] = $user_result['gidnumber'][0]; 202 $info['mail'] = $user_result['mail'][0]; 203 $info['name'] = $user_result['cn'][0]; 204 $info['grps'] = array(); 205 206 // overwrite if other attribs are specified. 207 if(is_array($this->getConf('mapping'))) { 208 foreach($this->getConf('mapping') as $localkey => $key) { 209 if(is_array($key)) { 210 // use regexp to clean up user_result 211 list($key, $regexp) = each($key); 212 if($user_result[$key]) foreach($user_result[$key] as $grpkey => $grp) { 213 if($grpkey !== 'count' && preg_match($regexp, $grp, $match)) { 214 if($localkey == 'grps') { 215 $info[$localkey][] = $match[1]; 216 } else { 217 $info[$localkey] = $match[1]; 218 } 219 } 220 } 221 } else { 222 $info[$localkey] = $user_result[$key][0]; 223 } 224 } 225 } 226 $user_result = array_merge($info, $user_result); 227 228 //get groups for given user if grouptree is given 229 if($this->getConf('grouptree') || $this->getConf('groupfilter')) { 230 $base = $this->_makeFilter($this->getConf('grouptree'), $user_result); 231 $filter = $this->_makeFilter($this->getConf('groupfilter'), $user_result); 232 $sr = $this->_ldapsearch($this->con, $base, $filter, $this->getConf('groupscope'), array($this->getConf('groupkey'))); 233 $this->_debug('LDAP group search: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 234 $this->_debug('LDAP search at: '.htmlspecialchars($base.' '.$filter), 0, __LINE__, __FILE__); 235 236 if(!$sr) { 237 msg("LDAP: Reading group memberships failed", -1); 238 return false; 239 } 240 $result = ldap_get_entries($this->con, $sr); 241 ldap_free_result($sr); 242 243 if(is_array($result)) foreach($result as $grp) { 244 if(!empty($grp[$this->getConf('groupkey')])) { 245 $group = $grp[$this->getConf('groupkey')]; 246 if(is_array($group)){ 247 $group = $group[0]; 248 } else { 249 $this->_debug('groupkey did not return a detailled result', 0, __LINE__, __FILE__); 250 } 251 if($group === '') continue; 252 253 $this->_debug('LDAP usergroup: '.htmlspecialchars($group), 0, __LINE__, __FILE__); 254 $info['grps'][] = $group; 255 } 256 } 257 } 258 259 // always add the default group to the list of groups 260 if(!$info['grps'] or !in_array($conf['defaultgroup'], $info['grps'])) { 261 $info['grps'][] = $conf['defaultgroup']; 262 } 263 return $info; 264 } 265 266 /** 267 * Most values in LDAP are case-insensitive 268 * 269 * @return bool 270 */ 271 public function isCaseSensitive() { 272 return false; 273 } 274 275 /** 276 * Bulk retrieval of user data 277 * 278 * @author Dominik Eckelmann <dokuwiki@cosmocode.de> 279 * @param int $start index of first user to be returned 280 * @param int $limit max number of users to be returned 281 * @param array $filter array of field/pattern pairs, null for no filter 282 * @return array of userinfo (refer getUserData for internal userinfo details) 283 */ 284 function retrieveUsers($start = 0, $limit = 0, $filter = array()) { 285 if(!$this->_openLDAP()) return false; 286 287 if(is_null($this->users)) { 288 // Perform the search and grab all their details 289 if($this->getConf('userfilter')) { 290 $all_filter = str_replace('%{user}', '*', $this->getConf('userfilter')); 291 } else { 292 $all_filter = "(ObjectClass=*)"; 293 } 294 $sr = ldap_search($this->con, $this->getConf('usertree'), $all_filter); 295 $entries = ldap_get_entries($this->con, $sr); 296 $users_array = array(); 297 for($i = 0; $i < $entries["count"]; $i++) { 298 array_push($users_array, $entries[$i]["uid"][0]); 299 } 300 asort($users_array); 301 $result = $users_array; 302 if(!$result) return array(); 303 $this->users = array_fill_keys($result, false); 304 } 305 $i = 0; 306 $count = 0; 307 $this->_constructPattern($filter); 308 $result = array(); 309 310 foreach($this->users as $user => &$info) { 311 if($i++ < $start) { 312 continue; 313 } 314 if($info === false) { 315 $info = $this->getUserData($user); 316 } 317 if($this->_filter($user, $info)) { 318 $result[$user] = $info; 319 if(($limit > 0) && (++$count >= $limit)) break; 320 } 321 } 322 return $result; 323 } 324 325 /** 326 * Make LDAP filter strings. 327 * 328 * Used by auth_getUserData to make the filter 329 * strings for grouptree and groupfilter 330 * 331 * @author Troels Liebe Bentsen <tlb@rapanden.dk> 332 * @param string $filter ldap search filter with placeholders 333 * @param array $placeholders placeholders to fill in 334 * @return string 335 */ 336 protected function _makeFilter($filter, $placeholders) { 337 preg_match_all("/%{([^}]+)/", $filter, $matches, PREG_PATTERN_ORDER); 338 //replace each match 339 foreach($matches[1] as $match) { 340 //take first element if array 341 if(is_array($placeholders[$match])) { 342 $value = $placeholders[$match][0]; 343 } else { 344 $value = $placeholders[$match]; 345 } 346 $value = $this->_filterEscape($value); 347 $filter = str_replace('%{'.$match.'}', $value, $filter); 348 } 349 return $filter; 350 } 351 352 /** 353 * return true if $user + $info match $filter criteria, false otherwise 354 * 355 * @author Chris Smith <chris@jalakai.co.uk> 356 * 357 * @param string $user the user's login name 358 * @param array $info the user's userinfo array 359 * @return bool 360 */ 361 protected function _filter($user, $info) { 362 foreach($this->_pattern as $item => $pattern) { 363 if($item == 'user') { 364 if(!preg_match($pattern, $user)) return false; 365 } else if($item == 'grps') { 366 if(!count(preg_grep($pattern, $info['grps']))) return false; 367 } else { 368 if(!preg_match($pattern, $info[$item])) return false; 369 } 370 } 371 return true; 372 } 373 374 /** 375 * Set the filter pattern 376 * 377 * @author Chris Smith <chris@jalakai.co.uk> 378 * 379 * @param $filter 380 * @return void 381 */ 382 protected function _constructPattern($filter) { 383 $this->_pattern = array(); 384 foreach($filter as $item => $pattern) { 385 $this->_pattern[$item] = '/'.str_replace('/', '\/', $pattern).'/i'; // allow regex characters 386 } 387 } 388 389 /** 390 * Escape a string to be used in a LDAP filter 391 * 392 * Ported from Perl's Net::LDAP::Util escape_filter_value 393 * 394 * @author Andreas Gohr 395 * @param string $string 396 * @return string 397 */ 398 protected function _filterEscape($string) { 399 return preg_replace( 400 '/([\x00-\x1F\*\(\)\\\\])/e', 401 '"\\\\\".join("",unpack("H2","$1"))', 402 $string 403 ); 404 } 405 406 /** 407 * Opens a connection to the configured LDAP server and sets the wanted 408 * option on the connection 409 * 410 * @author Andreas Gohr <andi@splitbrain.org> 411 */ 412 protected function _openLDAP() { 413 if($this->con) return true; // connection already established 414 415 $this->bound = 0; 416 417 $port = $this->getConf('port'); 418 $bound = false; 419 $servers = explode(',', $this->getConf('server')); 420 foreach($servers as $server) { 421 $server = trim($server); 422 $this->con = @ldap_connect($server, $port); 423 if(!$this->con) { 424 continue; 425 } 426 427 /* 428 * When OpenLDAP 2.x.x is used, ldap_connect() will always return a resource as it does 429 * not actually connect but just initializes the connecting parameters. The actual 430 * connect happens with the next calls to ldap_* funcs, usually with ldap_bind(). 431 * 432 * So we should try to bind to server in order to check its availability. 433 */ 434 435 //set protocol version and dependend options 436 if($this->getConf('version')) { 437 if(!@ldap_set_option( 438 $this->con, LDAP_OPT_PROTOCOL_VERSION, 439 $this->getConf('version') 440 ) 441 ) { 442 msg('Setting LDAP Protocol version '.$this->getConf('version').' failed', -1); 443 $this->_debug('LDAP version set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 444 } else { 445 //use TLS (needs version 3) 446 if($this->getConf('starttls')) { 447 if(!@ldap_start_tls($this->con)) { 448 msg('Starting TLS failed', -1); 449 $this->_debug('LDAP TLS set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 450 } 451 } 452 // needs version 3 453 if($this->getConf('referrals')) { 454 if(!@ldap_set_option( 455 $this->con, LDAP_OPT_REFERRALS, 456 $this->getConf('referrals') 457 ) 458 ) { 459 msg('Setting LDAP referrals to off failed', -1); 460 $this->_debug('LDAP referal set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 461 } 462 } 463 } 464 } 465 466 //set deref mode 467 if($this->getConf('deref')) { 468 if(!@ldap_set_option($this->con, LDAP_OPT_DEREF, $this->getConf('deref'))) { 469 msg('Setting LDAP Deref mode '.$this->getConf('deref').' failed', -1); 470 $this->_debug('LDAP deref set: '.htmlspecialchars(ldap_error($this->con)), 0, __LINE__, __FILE__); 471 } 472 } 473 /* As of PHP 5.3.0 we can set timeout to speedup skipping of invalid servers */ 474 if(defined('LDAP_OPT_NETWORK_TIMEOUT')) { 475 ldap_set_option($this->con, LDAP_OPT_NETWORK_TIMEOUT, 1); 476 } 477 478 if($this->getConf('binddn') && $this->getConf('bindpw')) { 479 $bound = @ldap_bind($this->con, $this->getConf('binddn'), $this->getConf('bindpw')); 480 $this->bound = 2; 481 } else { 482 $bound = @ldap_bind($this->con); 483 } 484 if($bound) { 485 break; 486 } 487 } 488 489 if(!$bound) { 490 msg("LDAP: couldn't connect to LDAP server", -1); 491 return false; 492 } 493 494 $this->cando['getUsers'] = true; 495 return true; 496 } 497 498 /** 499 * Wraps around ldap_search, ldap_list or ldap_read depending on $scope 500 * 501 * @author Andreas Gohr <andi@splitbrain.org> 502 * @param resource $link_identifier 503 * @param string $base_dn 504 * @param string $filter 505 * @param string $scope can be 'base', 'one' or 'sub' 506 * @param null $attributes 507 * @param int $attrsonly 508 * @param int $sizelimit 509 * @param int $timelimit 510 * @param int $deref 511 * @return resource 512 */ 513 protected function _ldapsearch($link_identifier, $base_dn, $filter, $scope = 'sub', $attributes = null, 514 $attrsonly = 0, $sizelimit = 0) { 515 if(is_null($attributes)) $attributes = array(); 516 517 if($scope == 'base') { 518 return @ldap_read( 519 $link_identifier, $base_dn, $filter, $attributes, 520 $attrsonly, $sizelimit 521 ); 522 } elseif($scope == 'one') { 523 return @ldap_list( 524 $link_identifier, $base_dn, $filter, $attributes, 525 $attrsonly, $sizelimit 526 ); 527 } else { 528 return @ldap_search( 529 $link_identifier, $base_dn, $filter, $attributes, 530 $attrsonly, $sizelimit 531 ); 532 } 533 } 534 535 /** 536 * Wrapper around msg() but outputs only when debug is enabled 537 * 538 * @param string $message 539 * @param int $err 540 * @param int $line 541 * @param string $file 542 * @return void 543 */ 544 protected function _debug($message, $err, $line, $file) { 545 if(!$this->getConf('debug')) return; 546 msg($message, $err, $line, $file); 547 } 548 549} 550