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