1 <?php
2 /*
3 * This code is part of GOsa (http://www.gosa-project.org)
4 * Copyright (C) 2003-2008 GONICUS GmbH
5 *
6 * ID: $$Id$$
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
23 class userinfo
24 {
25 var $dn;
26 var $ip;
27 var $username;
28 var $cn;
29 var $uid;
30 var $gidNumber= -1;
31 var $language= "";
32 var $config;
33 var $gosaUnitTag= "";
34 var $subtreeACL= array();
35 var $ACL= array();
36 var $ocMapping= array();
37 var $groups= array();
38 var $result_cache =array();
40 /* get acl's an put them into the userinfo object
41 attr subtreeACL (userdn:components, userdn:component1#sub1#sub2,component2,...) */
42 function userinfo(&$config, $userdn){
43 $this->config= &$config;
44 $ldap= $this->config->get_ldap_link();
45 $ldap->cat($userdn,array('sn', 'givenName', 'uid', 'gidNumber', 'preferredLanguage', 'gosaUnitTag'));
46 $attrs= $ldap->fetch();
48 if (isset($attrs['givenName'][0]) && isset($attrs['sn'][0])){
49 $this->cn= $attrs['givenName'][0]." ".$attrs['sn'][0];
50 } else {
51 $this->cn= $attrs['uid'][0];
52 }
53 if (isset($attrs['gidNumber'][0])){
54 $this->gidNumber= $attrs['gidNumber'][0];
55 }
57 /* Assign user language */
58 if (isset($attrs['preferredLanguage'][0])){
59 $this->language= $attrs['preferredLanguage'][0];
60 }
62 if (isset($attrs['gosaUnitTag'][0])){
63 $this->gosaUnitTag= $attrs['gosaUnitTag'][0];
64 }
66 $this->dn= $userdn;
67 $this->uid= $attrs['uid'][0];
68 $this->ip= $_SERVER['REMOTE_ADDR'];
70 /* Initialize ACL_CACHE */
71 session::set('ACL_CACHE',array());
72 $this->reset_acl_cache();
73 }
76 public function reset_acl_cache()
77 {
78 /* Initialize ACL_CACHE */
79 session::set('ACL_CACHE',array());
80 }
82 function loadACL()
83 {
84 $this->ACL= array();
85 $this->groups= array();
86 $this->result_cache =array();
87 $this->reset_acl_cache();
88 $ldap= $this->config->get_ldap_link();
89 $ldap->cd($this->config->current['BASE']);
91 /* Get member groups... */
92 $ldap->search("(&(objectClass=posixGroup)(memberUid=".$this->uid."))", array('dn'));
93 while ($attrs= $ldap->fetch()){
94 $this->groups[$attrs['dn']]= $attrs['dn'];
95 }
97 /* Crawl through ACLs and move relevant to the tree */
98 $ldap->search("(objectClass=gosaACL)", array('dn', 'gosaAclEntry'));
99 $aclp= array();
100 $aclc= array();
101 while ($attrs= $ldap->fetch()){
103 /* Insert links in ACL array */
104 $aclp[$attrs['dn']]= substr_count($attrs['dn'], ',');
105 $aclc[$attrs['dn']]= array();
106 $ol= array();
107 for($i= 0; $i<$attrs['gosaAclEntry']['count']; $i++){
108 $ol= array_merge($ol, @acl::explodeAcl($attrs['gosaAclEntry'][$i]));
109 }
110 $aclc[$attrs['dn']]= $ol;
111 }
113 /* Resolve roles here.
114 */
115 foreach($aclc as $dn => $data){
116 foreach($data as $prio => $aclc_value) {
117 if($aclc_value['type'] == "role"){
119 unset($aclc[$dn][$prio]);
121 $ldap->cat($aclc_value['acl'],array("gosaAclTemplate"));
122 $attrs = $ldap->fetch();
124 if(isset($attrs['gosaAclTemplate'])){
125 for($i= 0; $i<$attrs['gosaAclTemplate']['count']; $i++){
126 $tmp = @acl::explodeAcl($attrs['gosaAclTemplate'][$i]);
128 foreach($tmp as $new_acl){
129 $new_acl['members'] = $aclc_value['members'];
130 $aclc[$dn][] =$new_acl;
131 }
132 }
133 }
134 }
135 }
136 }
138 /* ACL's read, sort for tree depth */
139 asort($aclp);
141 /* Sort in tree order */
142 foreach ($aclp as $dn => $acl){
143 /* Check if we need to keep this ACL */
144 foreach($aclc[$dn] as $idx => $type){
145 $interresting= FALSE;
147 /* No members? This is good for all users... */
148 if (!count($type['members'])){
149 $interresting= TRUE;
150 } else {
152 /* Inspect members... */
153 foreach ($type['members'] as $grp => $grpdsc){
154 /* Some group inside the members that is relevant for us? */
155 if (in_array_ics(preg_replace('/^G:/', '', $grp), $this->groups)){
156 $interresting= TRUE;
157 }
159 /* User inside the members? */
160 if (preg_replace('/^U:/', '', $grp) == $this->dn){
161 $interresting= TRUE;
162 }
163 }
164 }
166 if ($interresting){
167 if (!isset($this->ACL[$dn])){
168 $this->ACL[$dn]= array();
169 }
170 $this->ACL[$dn][$idx]= $type;
171 }
172 }
174 }
175 }
178 function get_category_permissions($dn, $category)
179 {
180 /* If we are forced to skip ACLs checks for the current user
181 then return all permissions.
182 */
183 if($this->ignore_acl_for_current_user()){
184 return("rwcdm");
185 }
187 /* Get list of objectClasses and get the permissions for it */
188 $acl= "";
189 if (isset($this->ocMapping[$category])){
190 foreach($this->ocMapping[$category] as $oc){
191 $acl.= $this->get_permissions($dn, $category."/".$oc);
192 }
193 }else{
194 trigger_error("ACL request for an invalid category (".$category.").");
195 }
197 return ($acl);
198 }
201 /*! \brief Check if the given object (dn) is copyable
202 @param String The object dn
203 @param String The acl category (e.g. users)
204 @param String The acl class (e.g. user)
205 @return Boolean TRUE if the given object is copyable else FALSE
206 */
207 function is_copyable($dn, $object, $class)
208 {
209 return(preg_match("/r/",$this->has_complete_category_acls($dn, $object)));
210 }
213 /*! \brief Check if the given object (dn) is cutable
214 @param String The object dn
215 @param String The acl category (e.g. users)
216 @param String The acl class (e.g. user)
217 @return Boolean TRUE if the given object is cutable else FALSE
218 */
219 function is_cutable($dn, $object, $class)
220 {
221 $remove = preg_match("/d/",$this->get_permissions($dn,$object."/".$class));
222 $read = preg_match("/r/",$this->has_complete_category_acls($dn, $object));
223 return($remove && $read);
224 }
227 /*! \brief Checks if we are allowed to paste an object to the given destination ($dn)
228 @param String The destination dn
229 @param String The acl category (e.g. users)
230 @param String The acl class (e.g. user)
231 @return Boolean TRUE if we are allowed to paste an object.
232 */
233 function is_pasteable($dn, $object)
234 {
235 return(preg_match("/w/",$this->has_complete_category_acls($dn, $object)));
236 }
239 /*! \brief Checks if we are allowed to restore a snapshot for the given dn.
240 @param String The destination dn
241 @param String The acl category (e.g. users)
242 @return Boolean TRUE if we are allowed to restore a snapshot.
243 */
244 function allow_snapshot_restore($dn, $object)
245 {
246 if(!is_array($object)){
247 $object = array($object);
248 }
249 $r = $w = $c = TRUE;
250 foreach($object as $category){
251 $w &= preg_match("/w/",$this->has_complete_category_acls($dn, $category));
252 $c &= preg_match("/c/",$this->has_complete_category_acls($dn, $category));
253 $r &= preg_match("/r/",$this->has_complete_category_acls($dn, $category));
254 # print_a(array($category => array($r.$w.$c)));
255 }
256 return($r && $w );
257 }
260 /*! \brief Checks if we are allowed to create a snapshot of the given dn.
261 @param String The source dn
262 @param String The acl category (e.g. users)
263 @return Boolean TRUE if we are allowed to restore a snapshot.
264 */
265 function allow_snapshot_create($dn, $object)
266 {
267 if(!is_array($object)){
268 $object = array($object);
269 }
270 $r = $w = $c = TRUE;
271 foreach($object as $category){
272 $w &= preg_match("/w/",$this->has_complete_category_acls($dn, $category));
273 $c &= preg_match("/c/",$this->has_complete_category_acls($dn, $category));
274 $r &= preg_match("/r/",$this->has_complete_category_acls($dn, $category));
275 # print_a(array($category => array($r.$w.$c)));
276 }
277 return($r) ;
278 }
281 function get_permissions($dn, $object, $attribute= "", $skip_write= FALSE)
282 {
283 /* If we are forced to skip ACLs checks for the current user
284 then return all permissions.
285 */
286 if($this->ignore_acl_for_current_user()){
287 return("rwcdm");
288 }
290 /* Push cache answer? */
291 $ACL_CACHE = &session::get('ACL_CACHE');
292 if (isset($ACL_CACHE["$dn+$object+$attribute"])){
294 /* Remove write if needed */
295 if ($skip_write){
296 $ret = preg_replace('/w/', '', $ACL_CACHE["$dn+$object+$attribute"]);
297 }else{
298 $ret = $ACL_CACHE["$dn+$object+$attribute"];
299 }
300 return($ret);
301 }
303 /* Get ldap object, for later filter checks
304 */
305 $ldap = $this->config->get_ldap_link();
307 $acl= array("r" => "", "w" => "", "c" => "", "d" => "", "m" => "", "a" => "");
309 /* Build dn array */
310 $path= split(',', $dn);
311 $path= array_reverse($path);
313 /* Walk along the path to evaluate the acl */
314 $cpath= "";
315 foreach ($path as $element){
317 /* Clean potential ACLs for each level */
318 if(in_array($cpath,$this->config->departments)){
319 $acl= $this->cleanACL($acl);
320 }
322 if ($cpath == ""){
323 $cpath= $element;
324 } else {
325 $cpath= $element.','.$cpath;
326 }
328 if (isset($this->ACL[$cpath])){
330 /* Inspect this ACL, place the result into ACL */
331 foreach ($this->ACL[$cpath] as $subacl){
333 /* Reset? Just clean the ACL and turn over to the next one... */
334 if ($subacl['type'] == 'reset'){
335 $acl= $this->cleanACL($acl, TRUE);
336 continue;
337 }
339 if($subacl['type'] == "role") {
340 echo "role skipped";
341 continue;
342 }
344 /* With user filter */
345 if (isset($subacl['filter']) && !empty($subacl['filter'])){
346 $sdn = preg_replace("/^[^,]*+,/","",$dn);
347 $ldap->cd($sdn);
348 $ldap->ls($subacl['filter'],$sdn);
349 if(!$ldap->count()){
350 continue;
351 }else{
352 $found = FALSE;
353 while($attrs = $ldap->fetch()){
354 if($attrs['dn'] == $dn){
355 $found = TRUE;
356 break;
357 }
358 }
359 if(!$found){
360 continue;
361 }
362 }
363 }
365 /* Per attribute ACL? */
366 if (isset($subacl['acl'][$object][$attribute])){
367 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl'][$object][$attribute]);
368 continue;
369 }
371 /* Per object ACL? */
372 if (isset($subacl['acl'][$object][0])){
373 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl'][$object][0]);
374 continue;
375 }
377 /* Global ACL? */
378 if (isset($subacl['acl']['all'][0])){
379 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl']['all'][0]);
380 continue;
381 }
383 /* If attribute is "", we want to know, if we've *any* permissions here... */
384 if ($attribute == "" && isset($subacl['acl'][$object])){
385 foreach($subacl['acl'][$object] as $attr => $dummy){
386 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl'][$object][$attr]);
387 }
388 continue;
389 }
391 }
392 }
393 }
395 /* Assemble string */
396 $ret= "";
397 foreach ($acl as $key => $value){
398 if ($value !== ""){
399 $ret.= $key;
400 }
401 }
403 $ACL_CACHE["$dn+$object+$attribute"]= $ret;
405 /* Remove write if needed */
406 if ($skip_write){
407 $ret= preg_replace('/w/', '', $ret);
408 }
409 return ($ret);
410 }
413 /* Extract all departments that are accessible (direct or 'on the way' to an
414 accessible department) */
415 function get_module_departments($module)
416 {
418 /* If we are forced to skip ACLs checks for the current user
419 then return all departments as valid.
420 */
421 if($this->ignore_acl_for_current_user()){
422 return(array_keys($this->config->idepartments));
423 }
425 /* Use cached results if possilbe */
426 $ACL_CACHE = session::get('ACL_CACHE');
427 if(isset($ACL_CACHE['MODULE_DEPARTMENTS'][serialize($module)])){
428 return($ACL_CACHE['MODULE_DEPARTMENTS'][serialize($module)]);
429 }
431 global $plist;
433 $objects= array();
434 $deps= array();
436 /* Extract all relevant objects for this module from plist */
437 foreach ($plist->info as $object => $info){
438 if (!isset($info['plCategory'])){
439 continue;
440 }
441 foreach ($info['plCategory'] as $idx => $data){
442 if (preg_match('/^[0-9]+$/', $idx)){
443 if ($data == $module){
444 $objects[$object]= $object;
445 }
446 } else {
447 if ($idx == $module){
448 $objects[$object]= $object;
449 }
450 }
451 }
452 }
456 /* Search for per object ACLs.
457 */
458 $this->config->get_departments();
459 $this->config->make_idepartments();
461 foreach($this->ACL as $dn => $infos){
462 foreach($infos as $info){
463 $found = FALSE;
464 foreach($info['acl'] as $cat => $data){
465 if(is_array($module)){
466 foreach($module as $mod){
467 if(preg_match("/^".normalizePreg($mod)."/",$cat)){
468 $found =TRUE;
469 break;
470 }
471 }
472 }else{
473 if(preg_match("/^".normalizePreg($module)."/",$cat)){
474 $found =TRUE;
475 break;
476 }
477 }
478 }
480 if($found && !isset($this->config->idepartments[$dn])){
481 while(!isset($this->config->idepartments[$dn]) && preg_match("/,/",$dn)){
482 $dn = preg_replace("/^[^,]+,/","",$dn);
483 }
484 if(isset($this->config->idepartments[$dn])){
485 $deps[] = $dn;
486 }
487 }
488 }
489 }
491 /* For all gosaDepartments */
492 foreach ($this->config->departments as $dn){
493 $acl= array("r" => "", "w" => "", "c" => "", "d" => "", "m" => "", "a" => "");
495 /* Build dn array */
496 $path= split(',', $dn);
497 $path= array_reverse($path);
499 /* Walk along the path to evaluate the acl */
500 $cpath= "";
501 foreach ($path as $element){
503 /* Clean potential ACLs for each level */
504 $acl= $this->cleanACL($acl);
506 if ($cpath == ""){
507 $cpath= $element;
508 } else {
509 $cpath= $element.','.$cpath;
510 }
511 if (isset($this->ACL[$cpath])){
513 /* Inspect this ACL, place the result into ACL */
514 foreach ($this->ACL[$cpath] as $subacl){
516 /* Reset? Just clean the ACL and turn over to the next one... */
517 if ($subacl['type'] == 'reset'){
518 $acl= $this->cleanACL($acl, TRUE);
519 continue;
520 }
522 if($subacl['type'] == 'role'){
523 echo "role skipped";
524 continue;
525 }
527 /* Per object ACL? */
528 foreach ($objects as $object){
529 if (isset($subacl['acl']["$module/$object"])){
530 foreach($subacl['acl']["$module/$object"] as $attribute => $dcl){
531 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl']["$module/$object"][$attribute]);
532 }
533 }
534 }
536 /* Global ACL? */
537 if (isset($subacl['acl']["$module/all"][0])){
538 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl']["$module/all"][0]);
539 continue;
540 }
542 /* Global ACL? */
543 if (isset($subacl['acl']["all"][0])){
544 $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl']["all"][0]);
545 continue;
546 }
547 }
548 }
549 }
551 /* Add department, if we have (some) permissions for the required module */
552 foreach ($acl as $val){
553 if ($val != ""){
554 $deps[]= $dn;
555 break;
556 }
557 }
558 }
560 $ACL_CACHE = &session::get('ACL_CACHE');
561 $ACL_CACHE['MODULE_DEPARTMENTS'][serialize($module)] = $deps;
562 return ($deps);
563 }
566 function mergeACL($acl, $type, $newACL)
567 {
568 if (strpos($newACL, 'w') !== FALSE && strpos($newACL, 'r') === FALSE){
569 $newACL .= "r";
570 }
572 foreach(str_split($newACL) as $char){
574 /* Ignore invalid characters */
575 if (!preg_match('/[rwcdm]/', $char)){
576 continue;
577 }
579 /* Skip permanent and subtree entries */
580 if (preg_match('/[sp]/', $acl[$char])){
581 continue;
582 }
584 switch ($type){
585 case 'psub':
586 $acl[$char]= 'p';
587 break;
589 case 'sub':
590 $acl[$char]= 's';
591 break;
593 case 'one':
594 $acl[$char]= 1;
595 break;
597 case 'base':
598 if ($acl[$char] != 1){
599 $acl[$char]= 0;
600 }
601 break;
602 }
603 }
605 return ($acl);
606 }
609 function cleanACL($acl, $reset= FALSE)
610 {
611 foreach ($acl as &$value){
613 /* Reset removes everything but 'p' */
614 if ($reset && $value != 'p'){
615 $value= "";
616 continue;
617 }
619 /* Decrease tree level */
620 if (is_int($value)){
621 if ($value){
622 $value--;
623 } else {
624 $value= "";
625 }
626 }
627 }
629 return ($acl);
630 }
633 /* #FIXME This could be logical wrong or could be optimized in the future
634 Return combined acls for a given category.
635 All acls will be combined like boolean AND
636 As example ('rwcdm' + 'rcd' + 'wrm'= 'r')
638 Results will be cached in $this->result_cache.
639 $this->result_cache will be resetted if load_acls is called.
640 */
641 function has_complete_category_acls($dn,$category)
642 {
643 $acl = "rwcdm";
644 $types = "rwcdm";
646 if(!is_string($category)){
647 trigger_error("category must be string");
648 $acl = "";
649 }else{
650 if(!isset($this->result_cache['has_complete_category_acls'][$dn][$category])) {
651 if (isset($this->ocMapping[$category])){
652 foreach($this->ocMapping[$category] as $oc){
654 /* Skip objectClass '0' (e.g. users/0) get_permissions will ever return '' ?? */
655 if($oc == "0") continue;
656 $tmp = $this->get_permissions($dn, $category."/".$oc);
657 for($i = 0 ; $i < strlen($types); $i++) {
658 if(!preg_match("/".$types[$i]."/",$tmp)){
659 $acl = preg_replace("/".$types[$i]."/","",$acl);
660 }
661 }
662 }
663 }else{
664 trigger_error("Invalid type of category ".$category);
665 $acl = "";
666 }
667 $this->result_cache['has_complete_category_acls'][$dn][$category] = $acl;
668 }else{
669 $acl = $this->result_cache['has_complete_category_acls'][$dn][$category];
670 }
671 }
672 return($acl);
673 }
676 /*! \brief Returns TRUE if the current user is configured in IGNORE_ACL=".." in your gosa.conf
677 @param Return Boolean TRUE if we have to skip ACL checks else FALSE.
678 */
679 function ignore_acl_for_current_user()
680 {
681 return(isset($this->config->current['IGNORE_ACL']) && $this->config->current['IGNORE_ACL'] == $this->dn);
682 }
684 }
686 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
687 ?>