![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
1 <?php
3 /*
4 * How to use plugin::plInfo()
5 * ===================
6 *
7 * The function returns a descriptive array of the plugin,
8 * which will then be used by GOsa to populate the plugin, its ACLs,
9 * its properties, its schema requirements aso.
10 *
11 *
12 * The following values can be set:
13 * ================================
14 *
15 * plShortName |-> The name of the plugin in short (e.g. Posix)
16 * | This short-name will be shown for example in the ACL definitions.
17 * |
18 * |
19 * plDescription |-> A descriptive text for the plugin (e.g. User posix account extension)
20 * | This will be shown in the ACL definitions.
21 * |
22 * |
23 * plSelfModify |-> If set to true this plugin allows to set 'self' ACLs.
24 * | For exampe to allow to change the users own password, but not the others.
25 * |
26 * |
27 * plDepends |-> The plugins dependencies to other classes (e.g. sambaAccount requires posixAccount)
28 * |
29 * |
30 * plPriority |-> The priority of the plugin, this influences the ACL listings only.
31 * |
32 * |
33 * plSection |-> The section of this plugin 'administration', 'personal', 'addons'
34 * |
35 * |
36 * plCategory |-> The plugin category this plugins belongs to (e.g. users, groups, departments)
37 * |
38 * |
39 * plRequirements |-> Plugin requirements.
40 * | |
41 * | |-> [activePlugin] The schame checks will only be performed if the given plugin is enabled
42 * | | in the gosa.conf definitions.
43 * | | Defaults to the current class name if empty.
44 * | |
45 * | |-> [ldapSchema] An array of objectClass requirements.
46 * | | Syntax [[objectClass => 'version'], ... ]
47 * | | Version can be emtpy which just checks for the existence of the class.
48 * | |
49 * | |-> [onFailureDisablePlugin] A list of plugins that which will be disabled if the
50 * | requirements couldn't be fillfulled.
51 * |
52 * | ---------------------------------------------
53 * | EXAMPLE:
54 * | ---------------------------------------------
55 * | "plRequirements"=> array(
56 * | 'activePlugin' => 'applicationManagement',
57 * | 'ldapSchema' => array(
58 * | 'gosaObject' => '',
59 * | 'gosaAccount' => '>=2.7',
60 * | 'gosaLockEntry' => '>=2.7',
61 * | 'gosaDepartment' => '>=2.7',
62 * | 'gosaCacheEntry' => '>=2.7',
63 * | 'gosaProperties' => '>=2.7',
64 * | 'gosaConfig' => '>=2.7'
65 * | ),
66 * | 'onFailureDisablePlugin' => array(get_class(), 'someClassName')
67 * | ),
68 * | ---------------------------------------------
69 * |
70 * |
71 * |
72 * plProvidedAcls |-> The ACLs provided by this plugin
73 * |
74 * | ---------------------------------------------
75 * | EXAMPLE:
76 * | ---------------------------------------------
77 * | "plProvidedAcls"=> array(
78 * | 'cn' => _('Name'),
79 * | 'uid' => _('Uid'),
80 * | 'phoneNumber' => _('Phone number')
81 * | ),
82 * | ---------------------------------------------
83 * |
84 * |
85 * |
86 * plProperties |-> Properties used by the plugin.
87 * | Properties which are defined here will be modifyable using the property editor.
88 * | To read properties you can use $config->get_cfg_value(className, propertyName)
89 * |
90 * | ---------------------------------------------
91 * | EXAMPLE:
92 * | ---------------------------------------------
93 * | "plProperties"=> array(
94 * | array(
95 * | "name" => "htaccessAuthentication",
96 * | "type" => "bool",
97 * | "default" => "false",
98 * | "description" => _("A description..."),
99 * | "check" => "gosaProperty::isBool",
100 * | "migrate" => "",
101 * | "group" => "authentification",
102 * | "mandatory" => TRUE
103 * | ),
104 * | ),
105 * | See class_core.inc for a huge amount of examples.
106 */
109 class all extends plugin {
110 static function plInfo()
111 {
112 return (array(
113 "plShortName" => _("All"),
114 "plDescription" => _("All objects"),
115 "plSelfModify" => TRUE,
116 "plDepends" => array(),
117 "plPriority" => 0,
118 "plSection" => array("administration"),
119 "plCategory" => array("all" => array("description" => '* '._("All"))),
120 "plProvidedAcls" => array())
121 );
122 }
123 }
125 class core extends plugin {
127 static function getPropertyValues($class,$name,$value,$type)
128 {
129 $list = array();
130 switch($name){
131 case 'idAllocationMethod':
132 $list = array('traditional' => _('Traditional'), 'pool' => _('Use samba pool'));
133 break;
134 case 'passwordDefaultHash':
135 $tmp = passwordMethod::get_available_methods();
136 foreach($tmp['name'] as $id => $method){
137 $desc = $tmp[$id]['name'];
138 $list[$method] = $desc;
139 }
140 break;
141 case 'theme':
142 $cmd = "cd ../ihtml/themes; find . -name 'img.styles' | sed s/'^[^\/]*\/\([^\/]*\).*'/'\\1'/g";
143 $res = `$cmd` ;
144 $list = array();
145 foreach(preg_split("/\n/",$res) as $entry){
146 if(!empty($entry)){
147 $list[$entry] = $entry;
148 }
149 }
150 break;
151 case 'accountPrimaryAttribute':
152 $list = array('uid' => 'uid', 'cn' => 'cn');
153 break;
154 case 'loginAttribute':
155 $list = array(
156 'uid' => 'uid',
157 'mail' => 'mail',
158 'both' => 'uid & mail');
159 break;
160 case 'timezone':
161 $tmp = timezone::_get_tz_zones();
162 foreach($tmp['TIMEZONES'] as $name => $offset){
163 if($offset >= 0){
164 $list[$name] = $name." ( + ".sprintf("%0.2f",$offset/(60*60))." "._("hours").")";
165 }else{
166 $offset = $offset * -1;
167 $list[$name] = $name." ( - ".sprintf("%0.2f",($offset/(60*60)))." "._("hours").")";
168 }
169 }
170 break;
171 case 'mailAttribute':
172 $list = array('mail' => 'mail','uid' => 'uid');
173 break;
174 case 'mailMethod':
175 $tmp = array();
176 if(class_available('mailMethod')){
177 $tmp = mailMethod::get_methods();
178 }
179 $list =array();
180 foreach($tmp as $name => $value){
181 $name = preg_replace('/^mailMethod/','', $name);
182 $list[$name] = $value;
183 }
184 $list[''] = _("None");
185 break;
186 case 'language':
187 $tmp = get_languages(TRUE);
188 $list[""] = _("Automatic");
189 foreach($tmp as $key => $desc){
190 $list[$key] = $desc;
191 }
192 break;
193 case 'modificationDetectionAttribute':
194 $list = array('entryCSN' => 'entryCSN (OpenLdap)','textCSN'=>'textCSN (Sun DS)');
195 break;
196 default: echo $name." ";$list = array();
197 }
199 if(!isset($list[$value])){
200 $list[$value] = $value." ("._("User value").")";
201 }
203 return($list);
204 }
206 static function plInfo()
207 {
208 return (array(
209 "plShortName" => _("Core"),
210 "plDescription" => _("GOsa core plugin"),
211 "plSelfModify" => FALSE,
212 "plDepends" => array(),
213 "plPriority" => 0,
214 "plSection" => array("administration"),
216 "plRequirements"=> array(
217 'ldapSchema' => array(
218 'gosaObject' => '>=2.7',
219 'gosaAccount' => '>=2.7',
220 'gosaLockEntry' => '>=2.7',
221 'gosaDepartment' => '>=2.7',
222 'gosaCacheEntry' => '>=2.7',
223 'gosaProperties' => '>=2.7',
224 'gosaConfig' => '>=2.7'
225 ),
226 'onFailureDisablePlugin' => array(get_class())
227 ),
231 "plCategory" => array("all"),
232 "plProperties" => array(
234 array(
235 "name" => "htaccessAuthentication",
236 "type" => "bool",
237 "default" => "false",
238 "description" => _("The 'htaccessAuthentication' variable tells GOsa to use either htaccess authentication or LDAP authentication. This can be used if you want to use i.e. Kerberos to authenticate the users."),
239 "check" => "gosaProperty::isBool",
240 "migrate" => "",
241 "group" => "authentification",
242 "mandatory" => TRUE),
244 array(
245 "name" => "statsDatabaseEnabled",
246 "type" => "bool",
247 "default" => "false",
248 "description" => _("Enables/Disables GOsa usage statistics moduls."),
249 "check" => "gosaProperty::isBool",
250 "migrate" => "",
251 "group" => "core",
252 "mandatory" => TRUE),
254 array(
255 "name" => "statsDatabaseDirectory",
256 "type" => "path",
257 "default" => "/var/spool/gosa/stats",
258 "description" => _("The database file for GOSa usage statistics."),
259 "check" => "gosaProperty::isWriteablePath",
260 "migrate" => "",
261 "group" => "core",
262 "mandatory" => TRUE),
264 array(
265 "name" => "logging",
266 "type" => "bool",
267 "default" => "true",
268 "description" => _("The 'logging' statement enables event logging on GOsa side. Setting it to 'true' GOsa will log every action a user performs via syslog. If you use rsyslog and configure it to mysql logging, you can browse all events within GOsa. GOsa will not log anything, if the logging value is empty or set to 'false'."),
270 "check" => "gosaProperty::isBool",
271 "migrate" => "",
272 "group" => "core",
273 "mandatory" => TRUE),
275 array(
276 "name" => "listSummary",
277 "type" => "bool",
278 "default" => "true",
279 "description" => _("The 'listSummary' statement determines whether a status bar will be shown on the bottom of GOsa generated lists, displaying a short summary of type and number of elements in the list."),
280 "check" => "gosaProperty::isBool",
281 "migrate" => "",
282 "group" => "visual",
283 "mandatory" => FALSE),
285 array(
286 "name" => "passwordMinLength",
287 "type" => "integer",
288 "default" => "",
289 "description" => _("The 'passwordMinLength' statement determines whether a newly entered password has to be of a minimum length."),
290 "check" => "gosaProperty::isInteger",
291 "migrate" => "",
292 "group" => "password",
293 "mandatory" => FALSE),
295 array(
296 "name" => "passwordMinDiffer",
297 "type" => "integer",
298 "default" => "",
299 "description" => _("The 'passwordMinDiffer' statement determines whether a newly entered password has to be checked to have at least n different characters."),
300 "check" => "gosaProperty::isInteger",
301 "migrate" => "",
302 "group" => "password",
303 "mandatory" => FALSE),
305 array(
306 "name" => "passwordProposalHook",
307 "type" => "command",
308 "default" => "",
309 "description" => _("The 'passwordProposalHook' can be used to let GOsa generate password proposals for you. Whenever you change a password, you can then decide whether to use the proposal or to manually specify a password.")." "._("Here is an example command:")." /usr/bin/apg -n1",
310 "check" => "gosaProperty::isCommand",
311 "migrate" => "",
312 "group" => "password",
313 "mandatory" => FALSE),
315 array(
316 "name" => "displayErrors",
317 "type" => "bool",
318 "default" => "false",
319 "description" => _("The 'displayErrors' statement tells GOsa to show PHP errors in the upper part of the screen. This should be disabled in productive deployments, because there might be some important passwords arround.")." ".sprintf(_("The property '%s' may be interesting too."),'developmentMode'),
320 "check" => "gosaProperty::isBool",
321 "migrate" => "",
322 "group" => "debug",
323 "mandatory" => TRUE),
325 array(
326 "name" => "developmentMode",
327 "type" => "bool",
328 "default" => "false",
329 "description" => _("The 'developmentMode' statement tells GOsa to show development related error messages, for example messages about missing ACL configuration or classes. Due to the fact that enabling this flag will result in a lot of false error messages it should only be enabled while developing or debugging plugins!"),
330 "check" => "gosaProperty::isBool",
331 "migrate" => "",
332 "group" => "debug",
333 "mandatory" => TRUE),
336 array(
337 "name" => "schemaCheck",
338 "type" => "bool",
339 "default" => "true",
340 "description" => _("The 'schemaCheck' statement enables or disables schema checking during login. It is recommended to switch this on in order to let GOsa handle object creation more efficient."),
341 "check" => "gosaProperty::isBool",
342 "migrate" => "",
343 "group" => "debug",
344 "mandatory" => TRUE),
346 array(
347 "name" => "copyPaste",
348 "type" => "bool",
349 "default" => "false",
350 "description" => _("The 'copyPaste' statement enables copy and paste for LDAP entries managed with GOsa."),
351 "check" => "gosaProperty::isBool",
352 "migrate" => "",
353 "group" => "copyPaste",
354 "mandatory" => TRUE),
356 array(
357 "name" => "forceGlobals",
358 "type" => "noLdap",
359 "default" => "false",
360 "description" => _("The 'forceGlobals' statement enables PHP security checks to force register_global settings to be switched off."),
361 "check" => "gosaProperty::isBool",
362 "migrate" => "",
363 "group" => "security",
364 "mandatory" => TRUE),
366 array(
367 "name" => "forceSSL",
368 "type" => "noLdap",
369 "default" => "false",
370 "description" => _("The 'forceSSL' statement enables PHP security checks to force encrypted access to the web interface. GOsa will try to redirect to the same URL - just with https://"),
371 "check" => "gosaProperty::isBool",
372 "migrate" => "",
373 "group" => "security",
374 "mandatory" => TRUE),
376 array(
377 "name" => "ldapStats",
378 "type" => "bool",
379 "default" => "false",
380 "description" => _("Logs information about triggered ldap operations, duration, filter, aso. into syslog."),
381 "check" => "gosaProperty::isBool",
382 "migrate" => "",
383 "group" => "debug",
384 "mandatory" => FALSE),
386 array(
387 "name" => "ldapFollowReferrals",
388 "type" => "bool",
389 "default" => "false",
390 "description" => _("The 'ldapFollowReferrals' statement tells GOsa to follow LDAP referrals."),
391 "check" => "gosaProperty::isBool",
392 "migrate" => "",
393 "group" => "ldap",
394 "mandatory" => TRUE),
396 array(
397 "name" => "ldapFilterNestingLimit",
398 "type" => "integer",
399 "default" => 200,
400 "description" => _("The 'ldapFilterNestingLimit' statement can be used to speed up group handling for groups with several hundreds of members. The default behaviour is, that GOsa will resolv the memberUid values in a group to real names. To achieve this, it writes a single filter to minimize searches. Some LDAP servers (namely Sun DS) simply crash when the filter gets too big. You can set a member limit, where GOsa will stop to do these lookups."),
401 "check" => "gosaProperty::isInteger",
402 "migrate" => "",
403 "group" => "ldap",
404 "mandatory" => TRUE),
406 array(
407 "name" => "ldapSizelimit",
408 "type" => "integer",
409 "default" => 200,
410 "description" => _("The ldapSizelimit statement tells GOsa to retrieve the specified maximum number of results. The user will get a warning, that not all entries were shown."),
411 "check" => "gosaProperty::isInteger",
412 "migrate" => "",
413 "group" => "core",
414 "mandatory" => TRUE),
416 array(
417 "name" => "ldapSizeIgnore",
418 "type" => "bool",
419 "default" => "false",
420 "description" => _("Disables sizelimit checks, only the configured amount of results will be shown!"),
421 "check" => "gosaProperty::isBool",
422 "migrate" => "",
423 "group" => "core",
424 "mandatory" => FALSE),
426 array(
427 "name" => "warnSSL",
428 "type" => "noLdap",
429 "default" => "true",
430 "description" => _("The 'warnSSL' statement enables PHP security checks to detect non encrypted access to the web interface. GOsa will display a warning in this case."),
431 "check" => "gosaProperty::isBool",
432 "migrate" => "",
433 "group" => "security",
434 "mandatory" => TRUE),
436 array(
437 "name" => "ppdGzip",
438 "type" => "bool",
439 "default" => "true",
440 "description" => _("The 'ppdGzip' variable enables PPD file compression."),
441 "check" => "gosaProperty::isBool",
442 "migrate" => "",
443 "group" => "ppd",
444 "mandatory" => FALSE),
447 array(
448 "name" => "ignoreAcl",
449 "type" => "dn",
450 "default" => "",
451 "description" => _("The 'ignoreAcl' value tells GOsa to ignore complete ACL sets for the given DN. Add your DN here and you'll be able to restore accidently dropped ACLs."),
452 "check" => "gosaProperty::isDN",
453 "migrate" => "",
454 "group" => "debug",
455 "mandatory" => FALSE),
458 array(
459 "name" => "ppdPath",
460 "type" => "path",
461 "default" => "/var/spool/ppd",
462 "description" => _("The 'ppdPath' variable defines where to store PPD files for the GOto environment plugins."),
463 "check" => "gosaProperty::isPath",
464 "migrate" => "",
465 "group" => "ppd",
466 "mandatory" => FALSE),
468 array(
469 "name" => "ldapMaxQueryTime",
470 "type" => "integer",
471 "default" => "",
472 "description" => _("The 'ldapMaxQueryTime' statement tells GOsa to stop LDAP actions if there is no answer within the specified number of seconds."),
473 "check" => "gosaProperty::isInteger",
474 "migrate" => "",
475 "group" => "debug",
476 "mandatory" => FALSE),
478 array(
479 "name" => "storeFilterSettings",
480 "type" => "bool",
481 "default" => "true",
482 "description" => _("The 'storeFilterSettings' statement determines whether GOsa should store filter and plugin settings inside of a cookie."),
483 "check" => "gosaProperty::isBool",
484 "migrate" => "",
485 "group" => "core",
486 "mandatory" => FALSE),
488 array(
489 "name" => "sendCompressedOutput",
490 "type" => "bool",
491 "default" => "true",
492 "description" => _("The 'sendCompressedOutput' statement determines whether PHP should send compressed HTML pages to browsers or not. This may increase or decrease the performance, depending on your network."),
493 "check" => "gosaProperty::isBool",
494 "migrate" => "",
495 "group" => "core",
496 "mandatory" => FALSE),
498 array(
499 "name" => "modificationDetectionAttribute",
500 "type" => "switch",
501 "default" => "entryCSN",
502 "defaults" => "core::getPropertyValues",
503 "description" => _("The 'modificationDetectionAttribute' statement enables GOsa to check if a entry currently being edited has been modified from someone else outside GOsa in the meantime. It will display an informative dialog then. It can be set to 'entryCSN' for OpenLDAP based systems or 'contextCSN' for Sun DS based systems."),
504 "check" => "",
505 "migrate" => "",
506 "group" => "core",
507 "mandatory" => TRUE),
509 array(
510 "name" => "language",
511 "type" => "switch",
512 "default" => "",
513 "defaults" => "core::getPropertyValues",
514 "description" => _("The 'language' statement defines the default language used by GOsa. Normally GOsa autodetects the language from the browser settings. If this is not working or you want to force the language, just add the language code (i.e. de for german) here."),
515 "check" => "",
516 "migrate" => "",
517 "group" => "core",
518 "mandatory" => FALSE),
520 array(
521 "name" => "theme",
522 "type" => "switch",
523 "default" => "default",
524 "defaults" => "core::getPropertyValues",
525 "description" => _("The 'theme' statement defines what theme is used to display GOsa pages. You can install some corporate identity like theme and/or modify certain templates to fit your needs within themes. Take a look at the GOsa FAQ for more information."),
526 "check" => "",
527 "migrate" => "",
528 "group" => "visual",
529 "mandatory" => TRUE),
531 array(
532 "name" => "sessionLifetime",
533 "type" => "integer",
534 "default" => 600,
535 "description" => _("The 'sessionLifetime' value defines when a session will expire in seconds. For Debian systems, this will not work because the sessions will be removed by a cron job instead. Please modify the value inside of your php.ini instead."),
536 "check" => "gosaProperty::isInteger",
537 "migrate" => "",
538 "group" => "security",
539 "mandatory" => FALSE),
541 array(
542 "name" => "templateCompileDirectory",
543 "type" => "path",
544 "default" => "/var/spool/gosa",
545 "description" => _("The 'templateCompileDirectory' statements defines the path, where the PHP templating engins 'smarty' should store its compiled GOsa templates for improved speed. This path needs to be writeable by the user your webserver is running with."),
546 "check" => "gosaProperty::isWriteablePath",
547 "migrate" => "",
548 "group" => "core",
549 "mandatory" => TRUE),
551 array(
552 "name" => "debugLevel",
553 "type" => "integer",
554 "default" => 0,
555 "description" => sprintf(_("The 'debugLevel' value tells GOsa to display certain information on each page load. Value is an AND combination of the following byte values: %s"),
556 "
557 DEBUG_TRACE = 1
558 DEBUG_LDAP = 2
559 DEBUG_MYSQL = 4
560 DEBUG_SHELL = 8
561 DEBUG_POST = 16
562 DEBUG_SESSION = 32
563 DEBUG_CONFIG = 64
564 DEBUG_ACL = 128
565 DEBUG_SI = 256"),
566 "check" => "gosaProperty::isInteger",
567 "migrate" => "",
568 "group" => "debug",
569 "mandatory" => FALSE),
571 array(
572 "name" => "sambaHashHook",
573 "type" => "command",
574 "default" => "perl -MCrypt::SmbHash -e \"print join(q[:], ntlmgen \\\$ARGV[0]), $/;\"",
575 "description" => sprintf(_("The 'sambaHashHook' statement contains an executable to generate samba hash values. This is required for password synchronization, but not required if you apply gosa-si services. If you don't have mkntpasswd from the samba distribution installed, you can use perl to generate the hash: %s"),"perl -MCrypt::SmbHash -e \"print join(q[:], ntlmgen \\\$ARGV[0]), $/;\""),
576 "check" => "gosaProperty::isCommand",
577 "migrate" => "",
578 "group" => "samba",
579 "mandatory" => FALSE),
581 array(
582 "name" => "passwordDefaultHash",
583 "type" => "switch",
584 "default" => "crypt/md5",
585 "defaults" => "core::getPropertyValues",
586 "description" => _("The 'passwordDefaultHash' statement defines the default password hash to choose for new accounts."),
587 "check" => "",
588 "migrate" => "",
589 "group" => "password",
590 "mandatory" => FALSE),
591 array(
592 "name" => "strictPasswordRules",
593 "type" => "bool",
594 "default" => "true",
595 "description" => _("The 'strictPasswordRules' tells GOsa to check for UTF-8 characters in the supplied password. These Characters can lead to non working authentications if UTF-8 and none UTF-8 systems locales get mixed. The default is 'true'."),
596 "check" => "gosaProperty::isBool",
597 "migrate" => "",
598 "group" => "password",
599 "mandatory" => FALSE),
601 array(
602 "name" => "accountPrimaryAttribute",
603 "type" => "switch",
604 "default" => "cn",
605 "defaults" => "core::getPropertyValues",
606 "description" => _("The 'accountPrimaryAttribute' option tells GOsa how to create new accounts. Possible values are 'uid' and 'cn'. In the first case GOsa creates uid style DN entries: 'uid=superuser,ou=staff,dc=example,dc=net'. In the second case, GOsa creates cn style DN entries: 'cn=Foo Bar,ou=staff,dc=example,dc=net'. If you choose \"cn\" to be your 'accountPrimaryAttribute' you can decide whether to include the personal title in your dn by selecting 'personalTitleInDN'."),
607 "check" => "",
608 "migrate" => "",
609 "group" => "security",
610 "mandatory" => TRUE),
612 array(
613 "name" => "userRDN",
614 "type" => "rdn",
615 "default" => "ou=people,",
616 "description" => _("The 'userRDN' statement defines the location where new accounts will be created inside of defined departments. The default is 'ou=people'."),
617 "check" => "gosaProperty::isRdn",
618 "migrate" => "migrate_userRDN",
619 "group" => "user",
620 "mandatory" => FALSE),
622 array(
623 "name" => "groupRDN",
624 "type" => "rdn",
625 "default" => "ou=groups,",
626 "description" => _("The 'groupsRDN' statement defines the location where new groups will be created inside of defined departments. The default is 'ou=groups'."),
627 "check" => "gosaProperty::isRdn",
628 "migrate" => "migrate_groupRDN",
629 "group" => "group",
630 "mandatory" => FALSE),
632 array(
633 "name" => "gidNumberBase",
634 "type" => "integer",
635 "default" => "1000",
636 "description" => _("The 'gidNumberBase' statement defines where to start looking for a new free group id. This should be synced with your 'adduser.conf' to avoid overlapping gidNumber values between local and LDAP based lookups. The gidNumberBase can even be dynamic. Take a look at the 'nextIdHook' definition."),
637 "check" => "gosaProperty::isInteger",
638 "migrate" => "",
639 "group" => "id",
640 "mandatory" => TRUE),
642 array(
643 "name" => "baseIdHook",
644 "type" => "command",
645 "default" => "",
646 "description" => _("The 'baseIdHook' statement allows to hook into the id generation method (traditional mode), to define the starting range for new generated ids"),
647 "check" => "gosaProperty::isCommand",
648 "migrate" => "",
649 "group" => "id",
650 "mandatory" => FALSE),
652 array(
653 "name" => "gidNumberPoolMin",
654 "type" => "integer",
655 "default" => 10000,
656 "description" => _("The 'uidNumberPoolMin/gidNumberPoolMin' statement defines the lowest assignable user/group id for use with the 'idAllocationMethod = pool'."),
657 "check" => "gosaProperty::isInteger",
658 "migrate" => "",
659 "group" => "id",
660 "mandatory" => FALSE),
662 array(
663 "name" => "gidNumberPoolMax",
664 "type" => "integer",
665 "default" => 40000,
666 "description" => _("The 'uidNumberPoolMax/gidNumberPoolMax' statement defines the highest assignable user/group id for use with the 'idAllocationMethod = pool'."),
667 "check" => "gosaProperty::isInteger",
668 "migrate" => "",
669 "group" => "id",
670 "mandatory" => FALSE),
672 array(
673 "name" => "uidNumberPoolMin",
674 "type" => "integer",
675 "default" => 10000,
676 "description" => _("The 'uidNumberPoolMin/gidNumberPoolMin' statement defines the lowest assignable user/group id for use with the 'idAllocationMethod = pool'."),
677 "check" => "gosaProperty::isInteger",
678 "migrate" => "",
679 "group" => "id",
680 "mandatory" => FALSE),
682 array(
683 "name" => "uidNumberPoolMax",
684 "type" => "integer",
685 "default" => 40000,
686 "description" => _("The 'uidNumberPoolMax/gidNumberPoolMax' statement defines the highest assignable user/group id for use with the 'idAllocationMethod = pool'."),
687 "check" => "gosaProperty::isInteger",
688 "migrate" => "",
689 "group" => "id",
690 "mandatory" => FALSE),
692 array(
693 "name" => "uidNumberBase",
694 "type" => "integer",
695 "default" => "1000",
696 "description" => _("The 'uidNumberBase' statement defines where to start looking for a new free user id. This should be synced with your 'adduser.conf' to avoid overlapping uidNumber values between local and LDAP based lookups. The uidNumberBase can even be dynamic. Take a look at the 'baseIdHook' definition."),
697 "check" => "gosaProperty::isInteger",
698 "migrate" => "",
699 "group" => "id",
700 "mandatory" => FALSE),
702 array(
703 "name" => "gosaRpcServer",
704 "type" => "string",
705 "default" => "",
706 "description" => "The server to use for RPC connections! (http://localhost:8080/rpc), Future GOsa-ng service! If this value is set and not empty GOsa will try to establish a connection!",
707 "check" => "jsonRPC::testConnectionProperties",
708 "migrate" => "",
709 "group" => "rpc",
710 "mandatory" => FALSE),
712 array(
713 "name" => "gosaRpcUser",
714 "type" => "string",
715 "default" => "admin",
716 "description" => "Ther username to use for RPC connections! Future GOsa-ng service!",
717 "check" => "",
718 "migrate" => "",
719 "group" => "rpc",
720 "mandatory" => FALSE),
722 array(
723 "name" => "gosaRpcPassword",
724 "type" => "string",
725 "default" => "tester",
726 "description" => "Ther password to use for RPC connections! Future GOsa-ng service!",
727 "check" => "",
728 "migrate" => "",
729 "group" => "rpc",
730 "mandatory" => FALSE),
732 array(
733 "name" => "gosaSupportURI",
734 "type" => "string",
735 "default" => "",
736 "description" => _("The 'gosaSupportURI' defines the major gosa-si server host and the password for GOsa to connect to it. It can be used if you want to use i.e. kerberos to authenticate the users. The format is: credentials@host:port"),
737 "check" => "",
738 "migrate" => "",
739 "group" => "gosa-si",
740 "mandatory" => FALSE),
742 array(
743 "name" => "gosaSupportTimeout",
744 "type" => "integer",
745 "default" => 15,
746 "description" => _("The 'gosaSupportTimeout' sets a connection timeout for all gosa-si actions. See 'gosaSupportURI' for details."),
747 "check" => "gosaProperty::isInteger",
748 "migrate" => "",
749 "group" => "gosa-si",
750 "mandatory" => FALSE),
752 array(
753 "name" => "loginAttribute",
754 "type" => "switch",
755 "default" => "uid",
756 "defaults" => "core::getPropertyValues",
757 "description" => _("The 'loginAttribute' statement tells GOsa which LDAP attribute is used as the login name during login. It can be set to 'uid', 'mail' or 'both'"),
758 "check" => "",
759 "migrate" => "",
760 "group" => "security",
761 "mandatory" => TRUE),
763 array(
764 "name" => "timezone",
765 "type" => "switch",
766 "default" => "",
767 "defaults" => "core::getPropertyValues",
768 "description" => _("The 'timezone' statements defines the timezone used inside of GOsa to handle date related tasks, such as password expiery, vacation messages, etc. The 'timezone' value should be a unix conform timezone value like in /etc/timezone."),
769 "check" => "",
770 "migrate" => "",
771 "group" => "core",
772 "mandatory" => FALSE),
774 array(
775 "name" => "honourUnitTags",
776 "type" => "bool",
777 "default" => "false",
778 "description" => _("The 'honourUnitTags' statement enables checking of 'unitTag' attributes when using administrative units. If this is set to 'true' GOsa can only see objects inside the administrative unit a user is logged into."),
779 "check" => "",
780 "migrate" => "",
781 "group" => "core",
782 "mandatory" => FALSE),
784 array(
785 "name" => "useSaslForKerberos",
786 "type" => "bool",
787 "default" => "false",
788 "description" => _("The 'useSaslForKerberos' statement defines the way the kerberos realm is stored in the #userPassword' attribute. Set it to 'true' in order to get {sasl}user@REALM.NET, or to 'false' to get {kerberos}user@REALM.NET. The latter is outdated, but may be needed from time to time."),
789 "check" => "gosaProperty::isBool",
790 "migrate" => "",
791 "group" => "password",
792 "mandatory" => FALSE),
794 array(
795 "name" => "rfc2307bis",
796 "type" => "bool",
797 "default" => "false",
798 "description" => _("The 'rfc2307bis' statement enables rfc2307bis style groups in GOsa. You can use 'member' attributes instead of memberUid in this case. To make it work on unix systems, you've to adjust your NSS configuration to use rfc2307bis style groups, too"),
799 "check" => "gosaProperty::isBool",
800 "migrate" => "",
801 "group" => "core",
802 "mandatory" => FALSE),
804 array(
805 "name" => "personalTitleInDN",
806 "type" => "bool",
807 "default" => "false",
808 "description" => _("The 'personalTitleInDN' option tells GOsa to include the personal title in user DNs when #accountPrimaryAttribute' is set to \"cn\"."),
809 "check" => "gosaProperty::isBool",
810 "migrate" => "",
811 "group" => "storage location",
812 "mandatory" => FALSE),
814 array(
815 "name" => "nextIdHook",
816 "type" => "command",
817 "default" => "",
818 "description" => _("The 'nextIdHook' statement defines a script to be called for finding the next free id for users or groups externaly. It gets called with the current entry \"dn\" and the attribute to be ID'd. It should return an integer value."),
819 "check" => "gosaProperty::isCommand",
820 "migrate" => "",
821 "group" => "id",
822 "mandatory" => FALSE),
824 array(
825 "name" => "idGenerator",
826 "type" => "string",
827 "default" => "{%sn}-{%givenName[2-4]}",
828 "description" => _("The 'idGenerator' statement describes an automatic way to generate new user ids. There are two basic functions supported - which can be combined:
830 a) using attributes
832 You can specify LDAP attributes (currently only sn and givenName) in
833 braces {} and add a percent sign befor it. Optionally you can strip it
834 down to a number of characters, specified in []. I.e.
836 idGenerator=\"{%sn}-{%givenName[2-4]}\"
838 will generate an ID using the full surname, adding a dash, and adding at
839 least the first two characters of givenName. If this ID is used, it'll
840 use up to four characters. If no automatic generation is possible, a
841 input box is shown.
843 b) using automatic id's
845 I.e. specifying
847 idGenerator=\"acct{id:3}\"
849 will generate a three digits id with the next free entry appended to \"acct\".
851 idGenerator=\"acct{id!1}\"
853 will generate a one digit id with the next free entry appended to \"acct\" - if needed.
855 idGenerator=\"ext{id#3}\"
857 will generate a three digits random number appended to \"ext\".
858 "),
859 "check" => "",
860 "migrate" => "",
861 "group" => "core",
862 "mandatory" => FALSE),
864 array(
865 "name" => "strictNamingRules",
866 "type" => "bool",
867 "default" => "true",
868 "description" => _("The 'strictNamingRules' statement enables strict checking of uids and group names. If you need characters like . or - inside of your accounts, set this to 'false'."),
869 "check" => "gosaProperty::isBool",
870 "migrate" => "",
871 "group" => "core",
872 "mandatory" => FALSE),
874 array(
875 "name" => "minId",
876 "type" => "integer",
877 "default" => 40,
878 "description" => _("The 'minId' statement defines the minimum assignable user or group id to avoid security leaks with uid 0 accounts. This is used for the 'traditional' method."),
879 "check" => "gosaProperty::isInteger",
880 "migrate" => "",
881 "group" => "id",
882 "mandatory" => FALSE),
884 array(
885 "name" => "mailAttribute",
886 "type" => "switch",
887 "default" => "mail",
888 "defaults" => "core::getPropertyValues",
889 "description" => _("The 'mailAttribute' statement determines which attribute GOsa will use to create accounts. Valid values are 'mail' and 'uid'."),
890 "check" => "",
891 "migrate" => "",
892 "group" => "mail",
893 "mandatory" => FALSE),
895 array(
896 "name" => "gosaSharedPrefix",
897 "type" => "string",
898 "default" => "",
899 "description" => _("This attribute allows to override the prefix used to create shared folders."),
900 "check" => "",
901 "migrate" => "",
902 "group" => "mail",
903 "mandatory" => FALSE),
905 array(
906 "name" => "mailUserCreation",
907 "type" => "string",
908 "default" => "",
909 "description" => _("This attribute allows to override the user account creation syntax, see the 'mailFolderCreation' description for more details.
911 Examples
912 mailUserCreation=\"%prefix%%uid%\" => \"user.foobar\"
913 mailUserCreation=\"my-prefix.%uid%%domain%\" => \"my-prefix.foobar@example.com\"
914 "),
915 "check" => "",
916 "migrate" => "",
917 "group" => "mail",
918 "mandatory" => FALSE),
920 array(
921 "name" => "mailFolderCreation",
922 "type" => "string",
923 "default" => "",
924 "description" => _("Every mail method has its own way to create mail accounts like 'share/development' or 'shared.development@example.com' which is used to identify the accounts, set quotas or add acls.
926 To override the methods default account creation syntax, you can set the 'mailFolderCreation' option.
928 Examples
930 mailFolderCreation=\"%prefix%%cn%\" => \"shared.development\"
931 mailFolderCreation=\"my-prefix.%cn%%domain%\" => \"my-prefix.development@example.com\"
933 %prefix% The methods default prefix. (Depends on cyrusUseSlashes=FALSE/TRUE)
934 %cn% The groups/users cn.
935 %uid% The users uid.
936 %mail% The objects mail attribute.
937 %domain% The domain part of the objects mail attribute.
938 %mailpart% The user address part of the mail address.
939 %uattrib% Depends on mailAttribute=\"uid/mail\".
940 "),
941 "check" => "",
942 "migrate" => "",
943 "group" => "mail",
944 "mandatory" => FALSE),
946 array(
947 "name" => "imapTimeout",
948 "type" => "integer",
949 "default" => 10,
950 "description" => _("The 'imapTimeout' statement sets the connection timeout for imap actions."),
951 "check" => "gosaProperty::isInteger",
952 "migrate" => "",
953 "group" => "mail",
954 "mandatory" => FALSE),
956 array(
957 "name" => "mailMethod",
958 "type" => "switch",
959 "default" => "",
960 "defaults" => "core::getPropertyValues",
961 "description" => _("The 'mailMethod' statement tells GOsa which mail method the setup should use to communicate with a possible mail server. Leave this undefined if your mail method does not match the predefined ones."),
962 "check" => "",
963 "migrate" => "",
964 "group" => "mail",
965 "mandatory" => FALSE),
967 array(
968 "name" => "cyrusUseSlashes",
969 "type" => "bool",
970 "default" => "true",
971 "description" => _("The 'cyrusUseSlashes' statement determines if GOsa should use \"foo/bar\" or \"foo.bar\" namespaces in IMAP. Unix style is with slashes."),
972 "check" => "gosaProperty::isBool",
973 "migrate" => "",
974 "group" => "mail",
975 "mandatory" => FALSE),
977 array(
978 "name" => "vacationTemplateDirectory",
979 "type" => "path",
980 "default" => "/etc/gosa/vacation",
981 "description" => _("The 'vacationTemplateDirectory' statement sets the path where GOsa will look for vacation message templates. Default is /etc/gosa/vacation.
983 Example template /etc/gosa/vacation/business.txt:
985 DESC:Away from desk
986 Hi, I'm currently away from my desk. You can contact me on
987 my cell phone via %mobile.
989 Greetings,
990 %givenName %sn
992 "),
993 "check" => "gosaProperty::isWriteablePath",
994 "migrate" => "",
995 "group" => "mail",
996 "mandatory" => FALSE),
998 array(
999 "name" => "ldapTLS",
1000 "type" => "bool",
1001 "default" => "false",
1002 "description" => _("The 'ldapTLS' statement enables or disables TLS operating on LDAP connections."),
1003 "check" => "gosaProperty::isBool",
1004 "migrate" => "",
1005 "group" => "security",
1006 "mandatory" => TRUE),
1008 array(
1009 "name" => "honourIvbbAttributes",
1010 "type" => "bool",
1011 "default" => "false",
1012 "description" => _("The 'honourIvbbAttributes' statement enables the IVBB mode inside of GOsa. You need the ivbb.schema file from used by german authorities."),
1013 "check" => "gosaProperty::isBool",
1014 "migrate" => "",
1015 "group" => "core",
1016 "mandatory" => FALSE),
1018 array(
1019 "name" => "sambaIdMapping",
1020 "type" => "bool",
1021 "default" => "false",
1022 "description" => _("The 'sambaIdMapping' statement tells GOsa to maintain sambaIdmapEntry objects. Depending on your setup this can drastically improve the windows login performance."),
1023 "check" => "gosaProperty::isBool",
1024 "migrate" => "",
1025 "group" => "samba",
1026 "mandatory" => FALSE),
1028 array(
1029 "name" => "handleExpiredAccounts",
1030 "type" => "bool",
1031 "default" => "true",
1032 "description" => _("The 'handleExpiredAccounts' statement enables shadow attribute tests during the login to the GOsa web interface and forces password renewal or account lockout."),
1033 "check" => "gosaProperty::isBool",
1034 "migrate" => "",
1035 "group" => "core",
1036 "mandatory" => FALSE),
1038 array(
1039 "name" => "sambaSID",
1040 "type" => "string",
1041 "default" => "",
1042 "description" => _("The 'sambaSID' statement defines a samba SID if not available inside of the LDAP. You can retrieve the current sid by net getlocalsid."),
1043 "check" => "",
1044 "migrate" => "",
1045 "group" => "samba",
1046 "mandatory" => FALSE),
1048 array(
1049 "name" => "sambaRidBase",
1050 "type" => "integer",
1051 "default" => "",
1052 "description" => _("The 'sambaRidBase' statement defines the base id to add to ordinary sid calculations - if not available inside of the LDAP."),
1053 "check" => "gosaProperty::isInteger",
1054 "migrate" => "",
1055 "group" => "samba",
1056 "mandatory" => FALSE),
1058 array(
1059 "name" => "enableSnapshots",
1060 "type" => "bool",
1061 "default" => "false",
1062 "description" => _("The 'enableSnapshots' statement enables a snapshot mechaism in GOsa. This enables you to save certain states of entries and restore them later on."),
1063 "check" => "gosaProperty::isBool",
1064 "migrate" => "",
1065 "group" => "snapshot",
1066 "mandatory" => TRUE),
1068 array(
1069 "name" => "snapshotBase",
1070 "type" => "dn",
1071 "default" => "ou=snapshots,dc=localhost,dc=de",
1072 "description" => _("The 'snapshotBase' statement defines the base where snapshots should be stored inside of the LDAP."),
1073 "check" => "gosaProperty::isDn",
1074 "migrate" => "",
1075 "group" => "snapshot",
1076 "mandatory" => FALSE),
1078 array(
1079 "name" => "snapshotAdminDn",
1080 "type" => "dn",
1081 "default" => "cn=admin,dc=localhost,dc=de",
1082 "description" => _("The 'snapshotAdminDn' variable defines the user which is used to authenticate when connecting to 'snapshotURI'."),
1083 "check" => "gosaProperty::isDn",
1084 "migrate" => "",
1085 "group" => "snapshot",
1086 "mandatory" => FALSE),
1088 array(
1089 "name" => "snapshotAdminPassword",
1090 "type" => "string",
1091 "default" => "secret",
1092 "description" => _("The 'snapshotAdminPassword' variable defines the credentials which are used in combination with 'snapshotAdminDn' and 'snapshotURI' in order to authenticate."),
1093 "check" => "",
1094 "migrate" => "",
1095 "group" => "snapshot",
1096 "mandatory" => FALSE),
1098 array(
1099 "name" => "idAllocationMethod",
1100 "type" => "switch",
1101 "default" => "traditional",
1102 "defaults" => "core::getPropertyValues",
1103 "description" => _("The 'idAllocationMethod' statement defines how GOsa generates numeric user and group id values. If it is set to 'traditional' GOsa will do create a lock and perform a search for the next free ID. The lock will be removed after the procedure completes. 'pool' will use the sambaUnixIdPool objectclass settings inside your LDAP. This one is unsafe, because it does not check for concurrent LDAP access and already used IDs in this range. On the other hand it is much faster."),
1104 "check" => "",
1105 "migrate" => "",
1106 "group" => "id",
1107 "mandatory" => TRUE),
1108 array(
1109 "name" => "snapshotURI",
1110 "type" => "uri",
1111 "default" => "ldap://localhost:389",
1112 "description" => _("The 'snapshotURI' variable defines the LDAP URI for the server which is used to do object snapshots."),
1113 "check" => "",
1114 "migrate" => "",
1115 "group" => "snapshot",
1116 "mandatory" => FALSE)
1117 )));
1118 }
1119 }
1120 ?>