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;
163 BOOL transfer_logging;
169 /* This is a default service used to prime a services structure. In order
170 * to make these easy to keep sorted in the same way as the variables
171 * above, use the variable name in the leading comment, including a
172 * trailing ';' (to avoid a sorting problem with trailing digits). */
173 static service sDefault =
175 /* auth_users; */ NULL,
177 /* dont_compress; */ DEFAULT_DONT_COMPRESS,
179 /* exclude_from; */ NULL,
181 /* gid; */ NOBODY_GROUP,
182 /* hosts_allow; */ NULL,
183 /* hosts_deny; */ NULL,
185 /* include_from; */ NULL,
186 /* incoming_chmod; */ NULL,
187 /* lock_file; */ DEFAULT_LOCK_FILE,
188 /* log_file; */ NULL,
189 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
191 /* outgoing_chmod; */ NULL,
193 /* postxfer_exec; */ NULL,
194 /* prexfer_exec; */ NULL,
195 /* refuse_options; */ NULL,
196 /* secrets_file; */ NULL,
197 /* temp_dir; */ NULL,
198 /* uid; */ NOBODY_USER,
200 /* max_connections; */ 0,
201 /* max_verbosity; */ 1,
202 /* syslog_facility; */ LOG_DAEMON,
205 /* fake_super; */ False,
206 /* ignore_errors; */ False,
207 /* ignore_nonreadable; */ False,
209 /* munge_symlinks; */ (BOOL)-1,
210 /* read_only; */ True,
211 /* strict_modes; */ True,
212 /* transfer_logging; */ False,
213 /* use_chroot; */ True,
214 /* write_only; */ False,
219 /* local variables */
220 static service **ServicePtrs = NULL;
221 static int iNumServices = 0;
222 static int iServiceIndex = 0;
223 static BOOL bInGlobalSection = True;
225 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
227 static struct enum_list enum_facilities[] = {
229 { LOG_AUTH, "auth" },
232 { LOG_AUTHPRIV, "authpriv" },
235 { LOG_CRON, "cron" },
238 { LOG_DAEMON, "daemon" },
244 { LOG_KERN, "kern" },
250 { LOG_MAIL, "mail" },
253 { LOG_NEWS, "news" },
256 { LOG_AUTH, "security" },
259 { LOG_SYSLOG, "syslog" },
262 { LOG_USER, "user" },
265 { LOG_UUCP, "uucp" },
268 { LOG_LOCAL0, "local0" },
271 { LOG_LOCAL1, "local1" },
274 { LOG_LOCAL2, "local2" },
277 { LOG_LOCAL3, "local3" },
280 { LOG_LOCAL4, "local4" },
283 { LOG_LOCAL5, "local5" },
286 { LOG_LOCAL6, "local6" },
289 { LOG_LOCAL7, "local7" },
294 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
295 static struct parm_struct parm_table[] =
297 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
298 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
299 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
300 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
301 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
303 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
304 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
305 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
306 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
307 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
308 {"fake super", P_BOOL, P_LOCAL, &sDefault.fake_super, NULL,0},
309 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
310 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
311 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
312 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
313 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
314 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
315 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
316 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
317 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
318 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
319 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
320 {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
321 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
322 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
323 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
324 {"munge symlinks", P_BOOL, P_LOCAL, &sDefault.munge_symlinks, NULL,0},
325 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
326 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
327 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
329 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
330 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
332 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
333 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
334 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
335 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
336 {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
337 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
338 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
339 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
340 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
341 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
342 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
343 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
347 /***************************************************************************
348 * Initialise the global parameter structure.
349 ***************************************************************************/
350 static void init_globals(void)
352 memset(&Globals, 0, sizeof Globals);
355 /***************************************************************************
356 * Initialise the sDefault parameter structure.
357 ***************************************************************************/
358 static void init_locals(void)
364 In this section all the functions that are used to access the
365 parameters from the rest of the program are defined
368 #define FN_GLOBAL_STRING(fn_name,ptr) \
369 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
370 #define FN_GLOBAL_BOOL(fn_name,ptr) \
371 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
372 #define FN_GLOBAL_CHAR(fn_name,ptr) \
373 char fn_name(void) {return(*(char *)(ptr));}
374 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
375 int fn_name(void) {return(*(int *)(ptr));}
377 #define FN_LOCAL_STRING(fn_name,val) \
378 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
379 #define FN_LOCAL_BOOL(fn_name,val) \
380 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
381 #define FN_LOCAL_CHAR(fn_name,val) \
382 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
383 #define FN_LOCAL_INTEGER(fn_name,val) \
384 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
387 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
388 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
389 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
390 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
392 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
394 FN_LOCAL_STRING(lp_auth_users, auth_users)
395 FN_LOCAL_STRING(lp_comment, comment)
396 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
397 FN_LOCAL_STRING(lp_exclude, exclude)
398 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
399 FN_LOCAL_STRING(lp_filter, filter)
400 FN_LOCAL_STRING(lp_gid, gid)
401 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
402 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
403 FN_LOCAL_STRING(lp_include, include)
404 FN_LOCAL_STRING(lp_include_from, include_from)
405 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
406 FN_LOCAL_STRING(lp_lock_file, lock_file)
407 FN_LOCAL_STRING(lp_log_file, log_file)
408 FN_LOCAL_STRING(lp_log_format, log_format)
409 FN_LOCAL_STRING(lp_name, name)
410 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
411 FN_LOCAL_STRING(lp_path, path)
412 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
413 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
414 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
415 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
416 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
417 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
418 FN_LOCAL_STRING(lp_uid, uid)
420 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
421 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
422 FN_LOCAL_INTEGER(lp_timeout, timeout)
424 FN_LOCAL_BOOL(lp_fake_super, fake_super)
425 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
426 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
427 FN_LOCAL_BOOL(lp_list, list)
428 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
429 FN_LOCAL_BOOL(lp_read_only, read_only)
430 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
431 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
432 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
433 FN_LOCAL_BOOL(lp_write_only, write_only)
435 /* local prototypes */
436 static int strwicmp(char *psz1, char *psz2);
437 static int map_parameter(char *parmname);
438 static BOOL set_boolean(BOOL *pb, char *parmvalue);
439 static int getservicebyname(char *name, service *pserviceDest);
440 static void copy_service(service *pserviceDest, service *pserviceSource);
441 static BOOL do_parameter(char *parmname, char *parmvalue);
442 static BOOL do_section(char *sectionname);
445 /***************************************************************************
446 * initialise a service to the defaults
447 ***************************************************************************/
448 static void init_service(service *pservice)
450 memset((char *)pservice,0,sizeof(service));
451 copy_service(pservice,&sDefault);
456 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
457 * be initialized when this is called, either to NULL or a malloc'd
460 * @fixme There is a small leak here in that sometimes the existing
461 * value will be dynamically allocated, and the old copy is lost.
462 * However, we can't always deallocate the old value, because in the
463 * case of sDefault, it points to a static string. It would be nice
464 * to have either all-strdup'd values, or to never need to free
467 static void string_set(char **s, const char *v)
475 exit_cleanup(RERR_MALLOC);
479 /***************************************************************************
480 * add a new service to the services array initialising it with the given
482 ***************************************************************************/
483 static int add_a_service(service *pservice, char *name)
487 int num_to_alloc = iNumServices+1;
489 tservice = *pservice;
491 /* it might already exist */
494 i = getservicebyname(name,NULL);
501 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
504 pSERVICE(iNumServices) = new(service);
506 if (!ServicePtrs || !pSERVICE(iNumServices))
511 init_service(pSERVICE(i));
512 copy_service(pSERVICE(i),&tservice);
514 string_set(&iSERVICE(i).name,name);
519 /***************************************************************************
520 * Do a case-insensitive, whitespace-ignoring string compare.
521 ***************************************************************************/
522 static int strwicmp(char *psz1, char *psz2)
524 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
525 /* appropriate value. */
535 /* sync the strings on first non-whitespace */
538 while (isSpace(psz1))
540 while (isSpace(psz2))
542 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
547 return (*psz1 - *psz2);
550 /***************************************************************************
551 * Map a parameter's string representation to something we can use.
552 * Returns False if the parameter string is not recognised, else TRUE.
553 ***************************************************************************/
554 static int map_parameter(char *parmname)
558 if (*parmname == '-')
561 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
562 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
565 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
570 /***************************************************************************
571 * Set a boolean variable from the text value stored in the passed string.
572 * Returns True in success, False if the passed string does not correctly
573 * represent a boolean.
574 ***************************************************************************/
575 static BOOL set_boolean(BOOL *pb, char *parmvalue)
580 if (strwicmp(parmvalue, "yes") == 0 ||
581 strwicmp(parmvalue, "true") == 0 ||
582 strwicmp(parmvalue, "1") == 0)
585 if (strwicmp(parmvalue, "no") == 0 ||
586 strwicmp(parmvalue, "False") == 0 ||
587 strwicmp(parmvalue, "0") == 0)
591 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n",
598 /***************************************************************************
599 * Find a service by name. Otherwise works like get_service.
600 ***************************************************************************/
601 static int getservicebyname(char *name, service *pserviceDest)
605 for (iService = iNumServices - 1; iService >= 0; iService--)
606 if (strwicmp(iSERVICE(iService).name, name) == 0)
608 if (pserviceDest != NULL)
609 copy_service(pserviceDest, pSERVICE(iService));
618 /***************************************************************************
619 * Copy a service structure to another
620 ***************************************************************************/
621 static void copy_service(service *pserviceDest,
622 service *pserviceSource)
626 for (i=0;parm_table[i].label;i++)
627 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
628 void *def_ptr = parm_table[i].ptr;
630 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
632 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
634 switch (parm_table[i].type)
638 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
644 *(int *)dest_ptr = *(int *)src_ptr;
648 *(char *)dest_ptr = *(char *)src_ptr;
653 string_set(dest_ptr,*(char **)src_ptr);
663 /***************************************************************************
664 * Process a parameter for a particular service number. If snum < 0
665 * then assume we are in the globals
666 ***************************************************************************/
667 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
670 void *parm_ptr=NULL; /* where we are going to store the result */
674 parmnum = map_parameter(parmname);
678 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
682 def_ptr = parm_table[parmnum].ptr;
684 /* we might point at a service, the default service or a global */
688 if (parm_table[parmnum].class == P_GLOBAL) {
689 rprintf(FLOG, "Global parameter %s found in service section!\n",parmname);
692 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
695 /* now switch on the type of variable it is */
696 switch (parm_table[parmnum].type)
699 set_boolean(parm_ptr,parmvalue);
703 set_boolean(parm_ptr,parmvalue);
704 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
708 *(int *)parm_ptr = atoi(parmvalue);
712 *(char *)parm_ptr = *parmvalue;
716 sscanf(parmvalue,"%o",(int *)parm_ptr);
720 string_set(parm_ptr,parmvalue);
721 if ((cp = *(char**)parm_ptr) != NULL) {
722 int len = strlen(cp);
723 while (len > 1 && cp[len-1] == '/') len--;
729 string_set(parm_ptr,parmvalue);
733 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
737 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
738 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
739 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
743 if (!parm_table[parmnum].enum_list[i].name) {
744 if (atoi(parmvalue) > 0)
745 *(int *)parm_ptr = atoi(parmvalue);
755 /***************************************************************************
756 * Process a parameter.
757 ***************************************************************************/
758 static BOOL do_parameter(char *parmname, char *parmvalue)
760 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
763 /***************************************************************************
764 * Process a new section (service). At this stage all sections are services.
765 * Later we'll have special sections that permit server parameters to be set.
766 * Returns True on success, False on failure.
767 ***************************************************************************/
768 static BOOL do_section(char *sectionname)
771 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
774 /* if we were in a global section then do the local inits */
775 if (bInGlobalSection && !isglobal)
778 /* if we've just struck a global section, note the fact. */
779 bInGlobalSection = isglobal;
781 /* check for multiple global sections */
782 if (bInGlobalSection)
787 if (strchr(sectionname, '/') != NULL) {
788 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
792 /* if we have a current service, tidy it up before moving on */
795 if (iServiceIndex >= 0)
798 /* if all is still well, move to the next record in the services array */
801 /* We put this here to avoid an odd message order if messages are */
802 /* issued by the post-processing of a previous section. */
804 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
806 rprintf(FLOG, "Failed to add a new service\n");
815 /***************************************************************************
816 * Load the services array from the services file. Return True on success,
818 ***************************************************************************/
819 BOOL lp_load(char *pszFname, int globals_only)
826 bInGlobalSection = True;
830 pstrcpy(n2, pszFname);
832 /* We get sections first, so have to start 'behind' to make up */
834 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
840 /***************************************************************************
841 * return the max number of services
842 ***************************************************************************/
843 int lp_numservices(void)
845 return(iNumServices);
848 /***************************************************************************
849 * Return the number of the service with the given name, or -1 if it doesn't
850 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
851 * getservicebyname()! This works ONLY if all services have been loaded, and
852 * does not copy the found service.
853 ***************************************************************************/
854 int lp_number(char *name)
858 for (iService = iNumServices - 1; iService >= 0; iService--)
859 if (strcmp(lp_name(iService), name) == 0)