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   // special tag handling for Thunderbird
 238   if($conf['tbtaghack'] && in_array('contactPerson',$OCLASSES)){
 239     if($in['marker'][0]) $out['custom1'][] = $in['marker'][0];
 240     if($in['marker'][1]) $out['custom2'][] = $in['marker'][1];
 241     if($in['marker'][2]) $out['custom3'][] = $in['marker'][2];
 242     if($in['marker'][3]) $out['custom4'][] = $in['marker'][3];
 243   }
 244
 245
 246   // add the Objectclasses
 247   $out['objectclass'] = $OCLASSES;
 248
 249   return clear_array($out);
 250 }
 251
 252 /**
 253  * remove empty element from arrays recursively
 254  *
 255  * @author Original by <xntx@msn.com>
 256  */
 257 function clear_array ( $a ) {
 258   if ($a !== array()) {
 259     $b = array();
 260     foreach ( $a as $key => $value ) {
 261         if (is_array($value)) {
 262           if (clear_array($value) !== false) {
 263             $b[$key] = clear_array ( $value );
 264           }
 265         } elseif ($value !== '') {
 266           $b[$key] = $value;
 267         }
 268     }
 269     if ($b !== array()) {
 270         return $b;
 271     } else {
 272         return false;
 273     }
 274   } else {
 275     return false;
 276   }
 277 }
 278
 279 /**
 280  * deletes an entryfrom ldap - optional with recursion
 281  *
 282  * @author Original by <gabriel@hrz.uni-marburg.de>
 283  */
 284 function ldap_full_delete($ds,$dn,$recursive=false){
 285   if($recursive == false){
 286     return(ldap_delete($ds,$dn));
 287   }else{
 288     //searching for sub entries
 289     $sr=ldap_list($ds,$dn,"ObjectClass=*",array(""));
 290     $info = ldap_get_entries($ds, $sr);
 291     for($i=0;$i<$info['count'];$i++){
 292       //deleting recursively sub entries
 293       $result=myldap_delete($ds,$info[$i]['dn'],$recursive);
 294       if(!$result){
 295         //return result code, if delete fails
 296         return($result);
 297       }
 298     }
 299     return(ldap_delete($ds,$dn));
 300   }
 301 }
 302
 303 /**
 304  * Returns all User Accounts as assoziative array
 305  */
 306 function get_users(){
 307   global $conf;
 308   global $LDAP_CON;
 309
 310   $sr = ldap_list($LDAP_CON,$conf['usertree'],"ObjectClass=inetOrgPerson");
 311   $result = ldap_get_binentries($LDAP_CON, $sr);
 312   $users = array();
 313   if(count($result)){
 314     foreach ($result as $entry){
 315       if(!empty($entry['sn'][0])){
 316         $users[$entry['dn']] = $entry['givenName'][0]." ".$entry['sn'][0];
 317       }
 318     }
 319   }
 320   return $users;
 321 }
 322
 323 /**
 324  * makes sure the given DN contains exactly one space
 325  * after each ,
 326  */
 327 function normalize_dn($dn){
 328   $dn = preg_replace('/,/',', ',$dn);
 329   $dn = preg_replace('/,\s+/',', ',$dn);
 330   return $dn;
 331 }
 332
 333 /**
 334  * Merges the given classes with the existing ones
 335  */
 336 function ldap_store_objectclasses($dn,$classes){
 337   global $conf;
 338   global $LDAP_CON;
 339
 340   $sr     = ldap_search($LDAP_CON,$dn,"objectClass=*",array('objectClass'));
 341   $result = ldap_get_binentries($LDAP_CON, $sr);
 342   $set    = $result[0]['objectClass'];
 343   $set    = array_unique_renumber(array_merge((array)$set,(array)$classes));
 344   $add['objectClass'] = $set;
 345
 346   $r = @ldap_mod_replace($LDAP_CON,$dn,$add);
 347   tpl_ldaperror();
 348
 349 /*  print '<pre>';
 350   print_r($set);
 351   print '</pre>';*/
 352 }
 353
 354 /**
 355  * Escape a string to be used in a LDAP filter
 356  *
 357  * Ported from Perl's Net::LDAP::Util escape_filter_value
 358  *
 359  * @author Andreas Gohr <andi@splitbrain.org>
 360  */
 361 function ldap_filterescape($string){
 362   return preg_replace('/([\x00-\x1F\*\(\)\\\\])/e',
 363                             '"\\\\\".join("",unpack("H2","$1"))',
 364                             $string);
 365 }
 366
 367 /**
 368  * Queries public and private addressbooks, combining the
 369  * results
 370  *
 371  * @todo This function should be used where ever possible, replacing
 372  *       lots of duplicate code
 373  */
 374 function ldap_queryabooks($filter,$types){
 375   global $conf;
 376   global $LDAP_CON;
 377
 378   // make sure $types is an array
 379   if(!is_array($types)){
 380     $types = explode(',',$types);
 381     $types = array_map('trim',$types);
 382   }
 383
 384   $results = array();
 385   $result1 = array();
 386   $result2 = array();
 387
 388   // public addressbook
 389   $sr      = ldap_list($LDAP_CON,$conf['publicbook'],
 390                        $filter,$types);
 391   $result1 = ldap_get_binentries($LDAP_CON, $sr);
 392   ldap_free_result($sr);
 393
 394   // private addressbook
 395   if(!empty($_SESSION['ldapab']['binddn'])){
 396     $sr      = @ldap_list($LDAP_CON,$conf['privatebook'].
 397                           ','.$_SESSION['ldapab']['binddn'],
 398                           $filter,$types);
 399     $result2 = ldap_get_binentries($LDAP_CON, $sr);
 400   }
 401
 402   // return merged results
 403   return array_merge((array)$result1,(array)$result2);
 404 }
 405
 406 /**
 407  * Makes array unique and renumbers the entries
 408  *
 409  * @author <kay_rules@yahoo.com>
 410  */
 411 function array_unique_renumber($somearray){
 412    $tmparr = array_unique($somearray);
 413    $i=0;
 414    foreach ($tmparr as $v) {
 415        $newarr[$i] = $v;
 416        $i++;
 417    }
 418    return $newarr;
 419 }
 420
 421 /**
 422  * Simple XOR encryption
 423  *
 424  * @author Dustin Schneider
 425  * @link http://www.phpbuilder.com/tips/item.php?id=68
 426  */
 427 function x_Encrypt($string, $key){
 428     for($i=0; $i<strlen($string); $i++){
 429         for($j=0; $j<strlen($key); $j++){
 430             $string[$i] = $string[$i]^$key[$j];
 431         }
 432     }
 433     return $string;
 434 }
 435
 436 /**
 437  * Simple XOR decryption
 438  *
 439  * @author Dustin Schneider
 440  * @link http://www.phpbuilder.com/tips/item.php?id=68
 441  */
 442 function x_Decrypt($string, $key){
 443     for($i=0; $i<strlen($string); $i++){
 444         for($j=0; $j<strlen($key); $j++){
 445             $string[$i] = $key[$j]^$string[$i];
 446         }
 447     }
 448     return $string;
 449 }
 450
 451 /**
 452  * Decodes UTF8 recursivly for the given array
 453  *
 454  * @deprecated
 455  */
 456 function utf8_decode_array(&$array) {
 457   trigger_error('deprecated utf8_decode_array called',E_USER_WARNING);
 458
 459   foreach (array_keys($array) as $key) {
 460     if($key === 'dn') continue;
 461     if($key === 'jpegPhoto') continue;
 462     if (is_array($array[$key])) {
 463       utf8_decode_array($array[$key]);
 464     }else {
 465       $array[$key] = utf8_decode($array[$key]);
 466     }
 467   }
 468 }
 469
 470 /**
 471  * Encodes the given array to UTF8 recursively
 472  *
 473  * @deprecated
 474  */
 475 function utf8_encode_array(&$array) {
 476   trigger_error('deprecated utf8_encode_array called',E_USER_WARNING);
 477
 478   foreach (array_keys($array) as $key) {
 479     if($key === 'dn') continue;
 480     if($key === 'jpegPhoto') continue;
 481     if (is_array($array[$key])) {
 482       utf8_encode_array($array[$key]);
 483     }else {
 484       $array[$key] = utf8_encode($array[$key]);
 485     }
 486   }
 487 }
 488
 489 /**
 490  * Returns all the fields used in the template
 491  *
 492  * Returned fields are already decoded to LDAP internals
 493  */
 494 function get_fields_from_template($tpl){
 495     global $smarty;
 496     global $FIELDS;
 497     $tpl  = $smarty->template_dir.'/'.$tpl;
 498     $data = @file_get_contents($tpl);
 499     $matches = array();
 500     preg_match_all('/\$entry\.(\w+)/',$data,$matches);
 501     $matches = array_unique((array) $matches[1]);
 502     $return  = array();
 503     foreach($matches as $f){
 504         if($FIELDS[$f]){
 505             $return[] = $FIELDS[$f];
 506         }elseif($FIELDS["_$f"]){
 507             $return[] = $FIELDS["_$f"];
 508         }
 509     }
 510     return $return;
 511 }
 512
 513 ?>