1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, visit the http://fsf.org website.
21 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
27 * This module provides suitable callback functions for the params
28 * module. It builds the internal table of service details which is
29 * then used by the rest of the server.
33 * 1) add it to the global or service structure definition
34 * 2) add it to the parm_table
35 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
36 * 4) If it's a global then initialise it in init_globals. If a local
37 * (ie. service) parameter then initialise it in the sDefault structure
41 * The configuration file is processed sequentially for speed. It is NOT
42 * accessed randomly as happens in 'real' Windows. For this reason, there
43 * is a fair bit of sequence-dependent code here - ie., code which assumes
44 * that certain things happen before others. In particular, the code which
45 * happens at the boundary between sections is delicately poised, so be
50 /* TODO: Parameter to set debug level on server. */
54 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
55 #define strequal(a,b) (strcasecmp(a,b)==0)
56 #define BOOLSTR(b) ((b) ? "Yes" : "No")
57 typedef char pstring[1024];
58 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
64 #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \
65 " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg"
67 /* the following are used by loadparm for option lists */
70 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
71 P_PATH,P_STRING,P_GSTRING,P_ENUM,P_SEP
76 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
90 struct enum_list *enum_list;
95 #define GLOBAL_NAME "global"
98 /* some helpful bits */
99 #define pSERVICE(i) ServicePtrs[i]
100 #define iSERVICE(i) (*pSERVICE(i))
101 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
104 * This structure describes global (ie., server-wide) parameters.
111 char *socket_options;
116 static global Globals;
120 * This structure describes a single service. Their order must match the
121 * initializers below, which you can accomplish by keeping each sub-section
122 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
137 char *incoming_chmod;
142 char *outgoing_chmod;
146 char *refuse_options;
158 BOOL ignore_nonreadable;
162 BOOL transfer_logging;
168 /* This is a default service used to prime a services structure. In order
169 * to make these easy to keep sorted in the same way as the variables
170 * above, use the variable name in the leading comment, including a
171 * trailing ';' (to avoid a sorting problem with trailing digits). */
172 static service sDefault =
174 /* auth_users; */ NULL,
176 /* dont_compress; */ DEFAULT_DONT_COMPRESS,
178 /* exclude_from; */ NULL,
180 /* gid; */ NOBODY_GROUP,
181 /* hosts_allow; */ NULL,
182 /* hosts_deny; */ NULL,
184 /* include_from; */ NULL,
185 /* incoming_chmod; */ NULL,
186 /* lock_file; */ DEFAULT_LOCK_FILE,
187 /* log_file; */ NULL,
188 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
190 /* outgoing_chmod; */ NULL,
192 /* postxfer_exec; */ NULL,
193 /* prexfer_exec; */ NULL,
194 /* refuse_options; */ NULL,
195 /* secrets_file; */ NULL,
196 /* temp_dir; */ NULL,
197 /* uid; */ NOBODY_USER,
199 /* max_connections; */ 0,
200 /* max_verbosity; */ 1,
201 /* syslog_facility; */ LOG_DAEMON,
204 /* fake_super; */ False,
205 /* ignore_errors; */ False,
206 /* ignore_nonreadable; */ False,
208 /* read_only; */ True,
209 /* strict_modes; */ True,
210 /* transfer_logging; */ False,
211 /* use_chroot; */ True,
212 /* write_only; */ False,
217 /* local variables */
218 static service **ServicePtrs = NULL;
219 static int iNumServices = 0;
220 static int iServiceIndex = 0;
221 static BOOL bInGlobalSection = True;
223 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
225 static struct enum_list enum_facilities[] = {
227 { LOG_AUTH, "auth" },
230 { LOG_AUTHPRIV, "authpriv" },
233 { LOG_CRON, "cron" },
236 { LOG_DAEMON, "daemon" },
242 { LOG_KERN, "kern" },
248 { LOG_MAIL, "mail" },
251 { LOG_NEWS, "news" },
254 { LOG_AUTH, "security" },
257 { LOG_SYSLOG, "syslog" },
260 { LOG_USER, "user" },
263 { LOG_UUCP, "uucp" },
266 { LOG_LOCAL0, "local0" },
269 { LOG_LOCAL1, "local1" },
272 { LOG_LOCAL2, "local2" },
275 { LOG_LOCAL3, "local3" },
278 { LOG_LOCAL4, "local4" },
281 { LOG_LOCAL5, "local5" },
284 { LOG_LOCAL6, "local6" },
287 { LOG_LOCAL7, "local7" },
292 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
293 static struct parm_struct parm_table[] =
295 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
296 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
297 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
298 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
299 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
301 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
302 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
303 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
304 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
305 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
306 {"fake super", P_BOOL, P_LOCAL, &sDefault.fake_super, NULL,0},
307 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
308 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
309 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
310 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
311 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
312 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
313 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
314 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
315 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
316 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
317 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
318 {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
319 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
320 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
321 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
322 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
323 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
324 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
326 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
327 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
329 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
330 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
331 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
332 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
333 {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
334 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
335 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
336 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
337 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
338 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
339 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
340 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
344 /***************************************************************************
345 * Initialise the global parameter structure.
346 ***************************************************************************/
347 static void init_globals(void)
349 memset(&Globals, 0, sizeof Globals);
352 /***************************************************************************
353 * Initialise the sDefault parameter structure.
354 ***************************************************************************/
355 static void init_locals(void)
361 In this section all the functions that are used to access the
362 parameters from the rest of the program are defined
365 #define FN_GLOBAL_STRING(fn_name,ptr) \
366 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
367 #define FN_GLOBAL_BOOL(fn_name,ptr) \
368 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
369 #define FN_GLOBAL_CHAR(fn_name,ptr) \
370 char fn_name(void) {return(*(char *)(ptr));}
371 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
372 int fn_name(void) {return(*(int *)(ptr));}
374 #define FN_LOCAL_STRING(fn_name,val) \
375 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
376 #define FN_LOCAL_BOOL(fn_name,val) \
377 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
378 #define FN_LOCAL_CHAR(fn_name,val) \
379 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
380 #define FN_LOCAL_INTEGER(fn_name,val) \
381 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
384 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
385 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
386 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
387 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
389 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
391 FN_LOCAL_STRING(lp_auth_users, auth_users)
392 FN_LOCAL_STRING(lp_comment, comment)
393 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
394 FN_LOCAL_STRING(lp_exclude, exclude)
395 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
396 FN_LOCAL_STRING(lp_filter, filter)
397 FN_LOCAL_STRING(lp_gid, gid)
398 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
399 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
400 FN_LOCAL_STRING(lp_include, include)
401 FN_LOCAL_STRING(lp_include_from, include_from)
402 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
403 FN_LOCAL_STRING(lp_lock_file, lock_file)
404 FN_LOCAL_STRING(lp_log_file, log_file)
405 FN_LOCAL_STRING(lp_log_format, log_format)
406 FN_LOCAL_STRING(lp_name, name)
407 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
408 FN_LOCAL_STRING(lp_path, path)
409 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
410 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
411 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
412 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
413 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
414 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
415 FN_LOCAL_STRING(lp_uid, uid)
417 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
418 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
419 FN_LOCAL_INTEGER(lp_timeout, timeout)
421 FN_LOCAL_BOOL(lp_fake_super, fake_super)
422 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
423 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
424 FN_LOCAL_BOOL(lp_list, list)
425 FN_LOCAL_BOOL(lp_read_only, read_only)
426 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
427 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
428 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
429 FN_LOCAL_BOOL(lp_write_only, write_only)
431 /* local prototypes */
432 static int strwicmp(char *psz1, char *psz2);
433 static int map_parameter(char *parmname);
434 static BOOL set_boolean(BOOL *pb, char *parmvalue);
435 static int getservicebyname(char *name, service *pserviceDest);
436 static void copy_service(service *pserviceDest, service *pserviceSource);
437 static BOOL do_parameter(char *parmname, char *parmvalue);
438 static BOOL do_section(char *sectionname);
441 /***************************************************************************
442 * initialise a service to the defaults
443 ***************************************************************************/
444 static void init_service(service *pservice)
446 memset((char *)pservice,0,sizeof(service));
447 copy_service(pservice,&sDefault);
452 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
453 * be initialized when this is called, either to NULL or a malloc'd
456 * @fixme There is a small leak here in that sometimes the existing
457 * value will be dynamically allocated, and the old copy is lost.
458 * However, we can't always deallocate the old value, because in the
459 * case of sDefault, it points to a static string. It would be nice
460 * to have either all-strdup'd values, or to never need to free
463 static void string_set(char **s, const char *v)
471 exit_cleanup(RERR_MALLOC);
475 /***************************************************************************
476 * add a new service to the services array initialising it with the given
478 ***************************************************************************/
479 static int add_a_service(service *pservice, char *name)
483 int num_to_alloc = iNumServices+1;
485 tservice = *pservice;
487 /* it might already exist */
490 i = getservicebyname(name,NULL);
497 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
500 pSERVICE(iNumServices) = new(service);
502 if (!ServicePtrs || !pSERVICE(iNumServices))
507 init_service(pSERVICE(i));
508 copy_service(pSERVICE(i),&tservice);
510 string_set(&iSERVICE(i).name,name);
515 /***************************************************************************
516 * Do a case-insensitive, whitespace-ignoring string compare.
517 ***************************************************************************/
518 static int strwicmp(char *psz1, char *psz2)
520 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
521 /* appropriate value. */
531 /* sync the strings on first non-whitespace */
534 while (isSpace(psz1))
536 while (isSpace(psz2))
538 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
543 return (*psz1 - *psz2);
546 /***************************************************************************
547 * Map a parameter's string representation to something we can use.
548 * Returns False if the parameter string is not recognised, else TRUE.
549 ***************************************************************************/
550 static int map_parameter(char *parmname)
554 if (*parmname == '-')
557 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
558 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
561 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
566 /***************************************************************************
567 * Set a boolean variable from the text value stored in the passed string.
568 * Returns True in success, False if the passed string does not correctly
569 * represent a boolean.
570 ***************************************************************************/
571 static BOOL set_boolean(BOOL *pb, char *parmvalue)
576 if (strwicmp(parmvalue, "yes") == 0 ||
577 strwicmp(parmvalue, "true") == 0 ||
578 strwicmp(parmvalue, "1") == 0)
581 if (strwicmp(parmvalue, "no") == 0 ||
582 strwicmp(parmvalue, "False") == 0 ||
583 strwicmp(parmvalue, "0") == 0)
587 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
594 /***************************************************************************
595 * Find a service by name. Otherwise works like get_service.
596 ***************************************************************************/
597 static int getservicebyname(char *name, service *pserviceDest)
601 for (iService = iNumServices - 1; iService >= 0; iService--)
602 if (strwicmp(iSERVICE(iService).name, name) == 0)
604 if (pserviceDest != NULL)
605 copy_service(pserviceDest, pSERVICE(iService));
614 /***************************************************************************
615 * Copy a service structure to another
616 ***************************************************************************/
617 static void copy_service(service *pserviceDest,
618 service *pserviceSource)
622 for (i=0;parm_table[i].label;i++)
623 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
624 void *def_ptr = parm_table[i].ptr;
626 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
628 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
630 switch (parm_table[i].type)
634 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
640 *(int *)dest_ptr = *(int *)src_ptr;
644 *(char *)dest_ptr = *(char *)src_ptr;
649 string_set(dest_ptr,*(char **)src_ptr);
659 /***************************************************************************
660 * Process a parameter for a particular service number. If snum < 0
661 * then assume we are in the globals
662 ***************************************************************************/
663 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
666 void *parm_ptr=NULL; /* where we are going to store the result */
670 parmnum = map_parameter(parmname);
674 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
678 def_ptr = parm_table[parmnum].ptr;
680 /* we might point at a service, the default service or a global */
684 if (parm_table[parmnum].class == P_GLOBAL) {
685 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
688 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
691 /* now switch on the type of variable it is */
692 switch (parm_table[parmnum].type)
695 set_boolean(parm_ptr,parmvalue);
699 set_boolean(parm_ptr,parmvalue);
700 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
704 *(int *)parm_ptr = atoi(parmvalue);
708 *(char *)parm_ptr = *parmvalue;
712 sscanf(parmvalue,"%o",(int *)parm_ptr);
716 string_set(parm_ptr,parmvalue);
717 if ((cp = *(char**)parm_ptr) != NULL) {
718 int len = strlen(cp);
719 while (len > 1 && cp[len-1] == '/') len--;
725 string_set(parm_ptr,parmvalue);
729 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
733 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
734 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
735 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
739 if (!parm_table[parmnum].enum_list[i].name) {
740 if (atoi(parmvalue) > 0)
741 *(int *)parm_ptr = atoi(parmvalue);
751 /***************************************************************************
752 * Process a parameter.
753 ***************************************************************************/
754 static BOOL do_parameter(char *parmname, char *parmvalue)
756 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
759 /***************************************************************************
760 * Process a new section (service). At this stage all sections are services.
761 * Later we'll have special sections that permit server parameters to be set.
762 * Returns True on success, False on failure.
763 ***************************************************************************/
764 static BOOL do_section(char *sectionname)
767 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
770 /* if we were in a global section then do the local inits */
771 if (bInGlobalSection && !isglobal)
774 /* if we've just struck a global section, note the fact. */
775 bInGlobalSection = isglobal;
777 /* check for multiple global sections */
778 if (bInGlobalSection)
783 /* if we have a current service, tidy it up before moving on */
786 if (iServiceIndex >= 0)
789 /* if all is still well, move to the next record in the services array */
792 /* We put this here to avoid an odd message order if messages are */
793 /* issued by the post-processing of a previous section. */
795 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
797 rprintf(FERROR,"Failed to add a new service\n");
806 /***************************************************************************
807 * Load the services array from the services file. Return True on success,
809 ***************************************************************************/
810 BOOL lp_load(char *pszFname, int globals_only)
817 bInGlobalSection = True;
821 pstrcpy(n2, pszFname);
823 /* We get sections first, so have to start 'behind' to make up */
825 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
831 /***************************************************************************
832 * return the max number of services
833 ***************************************************************************/
834 int lp_numservices(void)
836 return(iNumServices);
839 /***************************************************************************
840 * Return the number of the service with the given name, or -1 if it doesn't
841 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
842 * getservicebyname()! This works ONLY if all services have been loaded, and
843 * does not copy the found service.
844 ***************************************************************************/
845 int lp_number(char *name)
849 for (iService = iNumServices - 1; iService >= 0; iService--)
850 if (strcmp(lp_name(iService), name) == 0)