git.sur5r.net Git - contagged/blob - inc/functions.php

   1 <?php
   2
   3 /**
   4  * assigns some standard variables to smarty templates
   5  */
   6 function smarty_std(){
   7   global $smarty;
   8   $smarty->assign('USER',$_SESSION['ldapab']['username']);
   9 }
  10
  11 /**
  12  * Uses Username and Password from Session to initialize the LDAP handle
  13  * If it fails it redirects to login.php
  14  */
  15 function ldap_login(){
  16   global $conf;
  17   if(!empty($_SESSION['ldapab']['username'])){
  18     // existing session! Check if valid
  19     if($_SESSION['ldapab']['browserid'] != auth_browseruid()){
  20       //session hijacking detected
  21       header('Location: login.php?username=');
  22       exit;
  23     }
  24   } elseif ($conf['httpd_auth'] && !empty($_SERVER['PHP_AUTH_USER'])) {
  25     // use HTTP auth if wanted and possible
  26     $_SESSION['ldapab']['username'] = $_SERVER['PHP_AUTH_USER'];
  27     $_SESSION['ldapab']['password'] = $_SERVER['PHP_AUTH_PW'];
  28   } elseif (!empty($_COOKIE['ldapabauth'])) {
  29     // check persistent cookie
  30     $cookie = base64_decode($_COOKIE['ldapabauth']);
  31     $cookie = x_Decrypt($cookie,get_cookie_secret());
  32     list($u,$p) = unserialize($cookie);
  33     $_SESSION['ldapab']['username'] = $u;
  34     $_SESSION['ldapab']['password'] = $p;
  35   }
  36
  37   if(empty($_SESSION['ldapab']) ||
  38      !do_ldap_bind($_SESSION['ldapab']['username'],
  39                    $_SESSION['ldapab']['password'],
  40                    $_SESSION['ldapab']['binddn'])){
  41     header('Location: login.php?username=');
  42     exit;
  43   }
  44 }
  45
  46 /**
  47  * Creates a global LDAP connection handle called $LDAP_CON
  48  */
  49 function do_ldap_bind($user,$pass,$dn=""){
  50   global $conf;
  51   global $LDAP_CON;
  52
  53   //create global connection to LDAP if necessary
  54   if(!$LDAP_CON){
  55     if (!empty($conf['ldapurl'])){
  56       $LDAP_CON = ldap_connect($conf['ldapurl']);
  57     }else{
  58       $LDAP_CON = ldap_connect($conf['ldapserver'],$conf['ldapport']);
  59     }
  60     if(!$LDAP_CON){
  61       die("couldn't connect to LDAP server");
  62     }
  63   }
  64
  65   if($conf['ldapv3']) ldap_set_option($LDAP_CON, LDAP_OPT_PROTOCOL_VERSION, 3);
  66
  67   if(empty($dn)){
  68     //anonymous bind to lookup users
  69     //blank binddn or blank bindpw will result in anonymous bind
  70     if(!ldap_bind($LDAP_CON,$conf['anonbinddn'],$conf['anonbindpw'])){
  71       die("can not bind for user lookup");
  72     }
  73
  74     //when no user was given stay connected anonymous
  75     if(empty($user)){
  76       set_session('','','');
  77       return true;
  78     }
  79
  80     //get dn for given user
  81     $filter = str_replace('%u',$user,$conf['userfilter']);
  82     $sr = ldap_search($LDAP_CON, $conf['usertree'], $filter);;
  83     $result = ldap_get_entries($LDAP_CON, $sr);
  84     if($result['count'] != 1){
  85       set_session('','','');
  86       return false;
  87     }
  88     $dn = $result[0]['dn'];
  89   }
  90
  91   //bind with dn
  92   if(ldap_bind($LDAP_CON,$dn,$pass)){
  93     //bind successful -> set up session
  94     set_session($user,$pass,$dn);
  95     return true;
  96   }
  97   //bind failed -> remove session
  98   set_session('','','');
  99   return false;
 100 }
 101
 102 /**
 103  * Builds a pseudo UID from browser and IP data
 104  *
 105  * This is neither unique nor unfakable - still it adds some
 106  * security. Using the first part of the IP makes sure
 107  * proxy farms like AOLs are stil okay.
 108  *
 109  * @author  Andreas Gohr <andi@splitbrain.org>
 110  *
 111  * @return  string  a MD5 sum of various browser headers
 112  */
 113 function auth_browseruid(){
 114   $uid  = '';
 115   if (empty($_SERVER['HTTP_USER_AGENT']))      { $_SERVER['HTTP_USER_AGENT']='USER_AGENT'; }
 116   if (empty($_SERVER['HTTP_ACCEPT_ENCODING'])) { $_SERVER['HTTP_ACCEPT_ENCODING']='ACCEPT_ENCODING'; }
 117   if (empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) { $_SERVER['HTTP_ACCEPT_LANGUAGE']='ACCEPT_LANGUAGE'; }
 118   if (empty($_SERVER['HTTP_ACCEPT_CHARSET']))  { $_SERVER['HTTP_ACCEPT_CHARSET']='ACCEPT_CHARSET'; }
 119   $uid .= $_SERVER['HTTP_USER_AGENT'];
 120   $uid .= $_SERVER['HTTP_ACCEPT_ENCODING'];
 121   $uid .= $_SERVER['HTTP_ACCEPT_LANGUAGE'];
 122   $uid .= $_SERVER['HTTP_ACCEPT_CHARSET'];
 123   $uid .= substr($_SERVER['REMOTE_ADDR'],0,strpos($_SERVER['REMOTE_ADDR'],'.'));
 124   return md5($uid);
 125 }
 126
 127
 128 /**
 129  * saves user data to Session and cookies
 130  */
 131 function set_session($user,$pass,$dn){
 132   global $conf;
 133
 134   $rand = rand();
 135   $_SESSION['ldapab']['username']  = $user;
 136   $_SESSION['ldapab']['binddn']    = $dn;
 137   $_SESSION['ldapab']['password']  = $pass;
 138   $_SESSION['ldapab']['browserid'] = auth_browseruid();
 139
 140   // (re)set the persistent auth cookie
 141   if($user == ''){
 142     setcookie('ldapabauth','',time()+60*60*24*365);
 143   }elseif(!empty($_REQUEST['remember'])){
 144     $cookie = serialize(array($user,$pass));
 145     $cookie = x_Encrypt($cookie,get_cookie_secret());
 146     $cookie = base64_encode($cookie);
 147     setcookie('ldapabauth',$cookie,time()+60*60*24*365);
 148   }
 149 }
 150
 151 /**
 152  * Creates a random string to encrypt persistent auth
 153  * cookies; the string is stored inside the cache dir
 154  */
 155 function get_cookie_secret(){
 156   $file = dirname(__FILE__).'/../cache/.htcookiesecret.php';
 157   if(@file_exists($file)){
 158     return md5(trim(file($file)));
 159   }
 160
 161   $secret = '<?php #'.(rand()*time()).'?>';
 162   if(!$fh = fopen($file,'w')) die("Couldn't write to $file");
 163   if(fwrite($fh, $secret) === FALSE) die("Couldn't write to $file");
 164   fclose($fh);
 165
 166   return md5($secret);
 167 }
 168
 169 /**
 170  * binary safe function to get all search result data.
 171  * It will use ldap_get_values_len() instead and build the array
 172  * note: it's similar with the array returned by ldap_get_entries()
 173  * except it has no "count" elements
 174  *
 175  * @author: Original code by Ovidiu Geaboc <ogeaboc@rdanet.com>
 176  */
 177 function ldap_get_binentries($conn,$srchRslt){
 178   if(!@ldap_count_entries($conn,$srchRslt)){
 179     return null;
 180   }
 181   $entry = ldap_first_entry($conn, $srchRslt);
 182   $i=0;
 183   do {
 184     $dn = ldap_get_dn($conn,$entry);
 185     $attrs = ldap_get_attributes($conn, $entry);
 186     for($j=0; $j<$attrs['count']; $j++) {
 187       $vals = ldap_get_values_len($conn, $entry,$attrs[$j]);
 188       for($k=0; $k<$vals['count']; $k++){
 189         $data[$i][$attrs[$j]][$k]=$vals[$k];
 190       }
 191     }
 192     $data[$i]['dn']=$dn;
 193     $i++;
 194   }while ($entry = ldap_next_entry($conn, $entry));
 195
 196   return $data;
 197 }
 198
 199
 200 /**
 201  * loads ldap names and their cleartext meanings from
 202  * entries.conf file and returns it as hash
 203  */
 204 function namedentries($flip=false){
 205     trigger_error('deprecated namedentries called',E_USER_WARNING);
 206 }
 207
 208 /**
 209  * Creates an array for submission to ldap from websitedata
 210  */
 211 function prepare_ldap_entry($in){
 212   global $conf;
 213   global $FIELDS;
 214   global $OCLASSES;
 215
 216   //check dateformats
 217   if(!preg_match('/\d\d\d\d-\d\d-\d\d/',$in['anniversary'])) $in['anniversary']='';
 218   if(!preg_match('/\d\d\d\d-\d\d-\d\d/',$in['birthday'])) $in['birthday']='';
 219
 220   // we map all internal names to the configured LDAP attributes here
 221   foreach($in as $key => $value){
 222     if($FIELDS[$key]){
 223         // normal mapped field
 224         $out[$FIELDS[$key]][] = $value;
 225     }elseif($FIELDS["_$key"]){
 226         // mapped multi field
 227         if(is_array($value)){
 228             $out[$FIELDS["_$key"]] = $value;
 229         }else{
 230             $out[$FIELDS["_$key"]][] = $value; //shouldn't happen, but to be sure
 231         }
 232     }else{
 233         // no mapping found we ignore it
 234     }
 235   }
 236
 237   // add the Objectclasses
 238   $out['objectclass'] = $OCLASSES;
 239
 240   return clear_array($out);
 241 }
 242
 243 /**
 244  * remove empty element from arrays recursively
 245  *
 246  * @author Original by <xntx@msn.com>
 247  */
 248 function clear_array ( $a ) {
 249   if ($a !== array()) {
 250     $b = array();
 251     foreach ( $a as $key => $value ) {
 252         if (is_array($value)) {
 253           if (clear_array($value) !== false) {
 254             $b[$key] = clear_array ( $value );
 255           }
 256         } elseif ($value !== '') {
 257           $b[$key] = $value;
 258         }
 259     }
 260     if ($b !== array()) {
 261         return $b;
 262     } else {
 263         return false;
 264     }
 265   } else {
 266     return false;
 267   }
 268 }
 269
 270 /**
 271  * deletes an entryfrom ldap - optional with recursion
 272  *
 273  * @author Original by <gabriel@hrz.uni-marburg.de>
 274  */
 275 function ldap_full_delete($ds,$dn,$recursive=false){
 276   if($recursive == false){
 277     return(ldap_delete($ds,$dn));
 278   }else{
 279     //searching for sub entries
 280     $sr=ldap_list($ds,$dn,"ObjectClass=*",array(""));
 281     $info = ldap_get_entries($ds, $sr);
 282     for($i=0;$i<$info['count'];$i++){
 283       //deleting recursively sub entries
 284       $result=myldap_delete($ds,$info[$i]['dn'],$recursive);
 285       if(!$result){
 286         //return result code, if delete fails
 287         return($result);
 288       }
 289     }
 290     return(ldap_delete($ds,$dn));
 291   }
 292 }
 293
 294 /**
 295  * Returns all User Accounts as assoziative array
 296  */
 297 function get_users(){
 298   global $conf;
 299   global $LDAP_CON;
 300
 301   $sr = ldap_list($LDAP_CON,$conf['usertree'],"ObjectClass=inetOrgPerson");
 302   $result = ldap_get_binentries($LDAP_CON, $sr);
 303   $users = array();
 304   if(count($result)){
 305     foreach ($result as $entry){
 306       if(!empty($entry['sn'][0])){
 307         $users[$entry['dn']] = $entry['givenName'][0]." ".$entry['sn'][0];
 308       }
 309     }
 310   }
 311   return $users;
 312 }
 313
 314 /**
 315  * makes sure the given DN contains exactly one space
 316  * after each ,
 317  */
 318 function normalize_dn($dn){
 319   $dn = preg_replace('/,/',', ',$dn);
 320   $dn = preg_replace('/,\s+/',', ',$dn);
 321   return $dn;
 322 }
 323
 324 /**
 325  * Merges the given classes with the existing ones
 326  */
 327 function ldap_store_objectclasses($dn,$classes){
 328   global $conf;
 329   global $LDAP_CON;
 330
 331   $sr     = ldap_search($LDAP_CON,$dn,"objectClass=*",array('objectClass'));
 332   $result = ldap_get_binentries($LDAP_CON, $sr);
 333   $set    = $result[0]['objectClass'];
 334   $set    = array_unique_renumber(array_merge((array)$set,(array)$classes));
 335   $add['objectClass'] = $set;
 336
 337   $r = @ldap_mod_replace($LDAP_CON,$dn,$add);
 338   tpl_ldaperror();
 339
 340 /*  print '<pre>';
 341   print_r($set);
 342   print '</pre>';*/
 343 }
 344
 345 /**
 346  * Escape a string to be used in a LDAP filter
 347  *
 348  * Ported from Perl's Net::LDAP::Util escape_filter_value
 349  *
 350  * @author Andreas Gohr <andi@splitbrain.org>
 351  */
 352 function ldap_filterescape($string){
 353   return preg_replace('/([\x00-\x1F\*\(\)\\\\])/e',
 354                             '"\\\\\".join("",unpack("H2","$1"))',
 355                             $string);
 356 }
 357
 358 /**
 359  * Queries public and private addressbooks, combining the
 360  * results
 361  *
 362  * @todo This function should be used where ever possible, replacing
 363  *       lots of duplicate code
 364  */
 365 function ldap_queryabooks($filter,$types){
 366   global $conf;
 367   global $LDAP_CON;
 368
 369   // make sure $types is an array
 370   if(!is_array($types)){
 371     $types = explode(',',$types);
 372     $types = array_map('trim',$types);
 373   }
 374
 375   $results = array();
 376   $result1 = array();
 377   $result2 = array();
 378
 379   // public addressbook
 380   $sr      = ldap_list($LDAP_CON,$conf['publicbook'],
 381                        $filter,$types);
 382   $result1 = ldap_get_binentries($LDAP_CON, $sr);
 383   ldap_free_result($sr);
 384
 385   // private addressbook
 386   if(!empty($_SESSION['ldapab']['binddn'])){
 387     $sr      = @ldap_list($LDAP_CON,$conf['privatebook'].
 388                           ','.$_SESSION['ldapab']['binddn'],
 389                           $filter,$types);
 390     $result2 = ldap_get_binentries($LDAP_CON, $sr);
 391   }
 392
 393   // return merged results
 394   return array_merge((array)$result1,(array)$result2);
 395 }
 396
 397 /**
 398  * Makes array unique and renumbers the entries
 399  *
 400  * @author <kay_rules@yahoo.com>
 401  */
 402 function array_unique_renumber($somearray){
 403    $tmparr = array_unique($somearray);
 404    $i=0;
 405    foreach ($tmparr as $v) {
 406        $newarr[$i] = $v;
 407        $i++;
 408    }
 409    return $newarr;
 410 }
 411
 412 /**
 413  * Simple XOR encryption
 414  *
 415  * @author Dustin Schneider
 416  * @link http://www.phpbuilder.com/tips/item.php?id=68
 417  */
 418 function x_Encrypt($string, $key){
 419     for($i=0; $i<strlen($string); $i++){
 420         for($j=0; $j<strlen($key); $j++){
 421             $string[$i] = $string[$i]^$key[$j];
 422         }
 423     }
 424     return $string;
 425 }
 426
 427 /**
 428  * Simple XOR decryption
 429  *
 430  * @author Dustin Schneider
 431  * @link http://www.phpbuilder.com/tips/item.php?id=68
 432  */
 433 function x_Decrypt($string, $key){
 434     for($i=0; $i<strlen($string); $i++){
 435         for($j=0; $j<strlen($key); $j++){
 436             $string[$i] = $key[$j]^$string[$i];
 437         }
 438     }
 439     return $string;
 440 }
 441
 442 /**
 443  * Decodes UTF8 recursivly for the given array
 444  *
 445  * @deprecated
 446  */
 447 function utf8_decode_array(&$array) {
 448   trigger_error('deprecated utf8_decode_array called',E_USER_WARNING);
 449
 450   foreach (array_keys($array) as $key) {
 451     if($key === 'dn') continue;
 452     if($key === 'jpegPhoto') continue;
 453     if (is_array($array[$key])) {
 454       utf8_decode_array($array[$key]);
 455     }else {
 456       $array[$key] = utf8_decode($array[$key]);
 457     }
 458   }
 459 }
 460
 461 /**
 462  * Encodes the given array to UTF8 recursively
 463  *
 464  * @deprecated
 465  */
 466 function utf8_encode_array(&$array) {
 467   trigger_error('deprecated utf8_encode_array called',E_USER_WARNING);
 468
 469   foreach (array_keys($array) as $key) {
 470     if($key === 'dn') continue;
 471     if($key === 'jpegPhoto') continue;
 472     if (is_array($array[$key])) {
 473       utf8_encode_array($array[$key]);
 474     }else {
 475       $array[$key] = utf8_encode($array[$key]);
 476     }
 477   }
 478 }
 479
 480 /**
 481  * Returns all the fields used in the template
 482  *
 483  * Returned fields are already decoded to LDAP internals
 484  */
 485 function get_fields_from_template($tpl){
 486     global $smarty;
 487     global $FIELDS;
 488     $tpl  = $smarty->template_dir.'/'.$tpl;
 489     $data = @file_get_contents($tpl);
 490     $matches = array();
 491     preg_match_all('/\$entry\.(\w+)/',$data,$matches);
 492     $matches = array_unique((array) $matches[1]);
 493     $return  = array();
 494     foreach($matches as $f){
 495         if($FIELDS[$f]){
 496             $return[] = $FIELDS[$f];
 497         }elseif($FIELDS["_$f"]){
 498             $return[] = $FIELDS["_$f"];
 499         }
 500     }
 501     return $return;
 502 }
 503
 504 ?>