1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
6 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 * This module provides suitable callback functions for the params
29 * module. It builds the internal table of service details which is
30 * then used by the rest of the server.
34 * 1) add it to the global or service structure definition
35 * 2) add it to the parm_table
36 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
37 * 4) If it's a global then initialise it in init_globals. If a local
38 * (ie. service) parameter then initialise it in the sDefault structure
42 * The configuration file is processed sequentially for speed. It is NOT
43 * accessed randomly as happens in 'real' Windows. For this reason, there
44 * is a fair bit of sequence-dependent code here - ie., code which assumes
45 * that certain things happen before others. In particular, the code which
46 * happens at the boundary between sections is delicately poised, so be
51 /* 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))
60 /* the following are used by loadparm for option lists */
63 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
64 P_PATH,P_STRING,P_GSTRING,P_ENUM,P_SEP
69 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
83 struct enum_list *enum_list;
88 #define GLOBAL_NAME "global"
91 /* some helpful bits */
92 #define pSERVICE(i) ServicePtrs[i]
93 #define iSERVICE(i) (*pSERVICE(i))
94 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
97 * This structure describes global (ie., server-wide) parameters.
105 char *socket_options;
111 static global Globals;
115 * This structure describes a single service. Their order must match the
116 * initializers below, which you can accomplish by keeping each sub-section
117 * sorted. (e.g. in vim, just visually select the subsection and use !sort.)
138 char *refuse_options;
147 BOOL ignore_nonreadable;
151 BOOL transfer_logging;
157 /* This is a default service used to prime a services structure */
158 static service sDefault =
160 /* auth users */ NULL,
162 /* dont compress */ "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz",
164 /* exclude from */ NULL,
166 /* gid */ NOBODY_GROUP,
167 /* hosts allow */ NULL,
168 /* hosts deny */ NULL,
170 /* include from */ NULL,
171 /* lock file */ DEFAULT_LOCK_FILE,
172 /* log format */ "%o %h [%a] %m (%u) %f %l",
175 /* postxfer_exec */ NULL,
176 /* prexfer_exec */ NULL,
177 /* refuse options */ NULL,
178 /* secrets file */ NULL,
179 /* uid */ NOBODY_USER,
181 /* max connections */ 0,
182 /* max verbosity */ 1,
185 /* ignore errors */ False,
186 /* ignore nonreadable */ False,
188 /* read only */ True,
189 /* strict modes */ True,
190 /* transfer logging */ False,
191 /* use chroot */ True,
192 /* write only */ False,
197 /* local variables */
198 static service **ServicePtrs = NULL;
199 static int iNumServices = 0;
200 static int iServiceIndex = 0;
201 static BOOL bInGlobalSection = True;
203 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
205 static struct enum_list enum_facilities[] = {
207 { LOG_AUTH, "auth" },
210 { LOG_AUTHPRIV, "authpriv" },
213 { LOG_CRON, "cron" },
216 { LOG_DAEMON, "daemon" },
222 { LOG_KERN, "kern" },
228 { LOG_MAIL, "mail" },
231 { LOG_NEWS, "news" },
234 { LOG_AUTH, "security" },
237 { LOG_SYSLOG, "syslog" },
240 { LOG_USER, "user" },
243 { LOG_UUCP, "uucp" },
246 { LOG_LOCAL0, "local0" },
249 { LOG_LOCAL1, "local1" },
252 { LOG_LOCAL2, "local2" },
255 { LOG_LOCAL3, "local3" },
258 { LOG_LOCAL4, "local4" },
261 { LOG_LOCAL5, "local5" },
264 { LOG_LOCAL6, "local6" },
267 { LOG_LOCAL7, "local7" },
272 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
273 static struct parm_struct parm_table[] =
275 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
276 {"log file", P_STRING, P_GLOBAL,&Globals.log_file, NULL,0},
277 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
278 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
279 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
280 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
281 {"syslog facility", P_ENUM, P_GLOBAL,&Globals.syslog_facility,enum_facilities,0},
283 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
284 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
285 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
286 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
287 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
288 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
289 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
290 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
291 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
292 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
293 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
294 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
295 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
296 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
297 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
298 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
299 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
300 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
301 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
302 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
304 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
305 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
307 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
308 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
309 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
310 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
311 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
312 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
313 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
314 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
315 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
316 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
320 /***************************************************************************
321 Initialise the global parameter structure.
322 ***************************************************************************/
323 static void init_globals(void)
325 memset(&Globals, 0, sizeof Globals);
327 Globals.syslog_facility = LOG_DAEMON;
331 /***************************************************************************
332 Initialise the sDefault parameter structure.
333 ***************************************************************************/
334 static void init_locals(void)
340 In this section all the functions that are used to access the
341 parameters from the rest of the program are defined
344 #define FN_GLOBAL_STRING(fn_name,ptr) \
345 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
346 #define FN_GLOBAL_BOOL(fn_name,ptr) \
347 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
348 #define FN_GLOBAL_CHAR(fn_name,ptr) \
349 char fn_name(void) {return(*(char *)(ptr));}
350 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
351 int fn_name(void) {return(*(int *)(ptr));}
353 #define FN_LOCAL_STRING(fn_name,val) \
354 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
355 #define FN_LOCAL_BOOL(fn_name,val) \
356 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
357 #define FN_LOCAL_CHAR(fn_name,val) \
358 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
359 #define FN_LOCAL_INTEGER(fn_name,val) \
360 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
363 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
364 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
365 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
366 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
367 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
369 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
370 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
372 FN_LOCAL_STRING(lp_auth_users, auth_users)
373 FN_LOCAL_STRING(lp_comment, comment)
374 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
375 FN_LOCAL_STRING(lp_exclude, exclude)
376 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
377 FN_LOCAL_STRING(lp_filter, filter)
378 FN_LOCAL_STRING(lp_gid, gid)
379 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
380 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
381 FN_LOCAL_STRING(lp_include, include)
382 FN_LOCAL_STRING(lp_include_from, include_from)
383 FN_LOCAL_STRING(lp_lock_file, lock_file)
384 FN_LOCAL_STRING(lp_log_format, log_format)
385 FN_LOCAL_STRING(lp_name, name)
386 FN_LOCAL_STRING(lp_path, path)
387 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
388 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
389 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
390 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
391 FN_LOCAL_STRING(lp_uid, uid)
393 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
394 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
395 FN_LOCAL_INTEGER(lp_timeout, timeout)
397 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
398 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
399 FN_LOCAL_BOOL(lp_list, list)
400 FN_LOCAL_BOOL(lp_read_only, read_only)
401 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
402 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
403 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
404 FN_LOCAL_BOOL(lp_write_only, write_only)
406 /* local prototypes */
407 static int strwicmp(char *psz1, char *psz2);
408 static int map_parameter(char *parmname);
409 static BOOL set_boolean(BOOL *pb, char *parmvalue);
410 static int getservicebyname(char *name, service *pserviceDest);
411 static void copy_service(service *pserviceDest, service *pserviceSource);
412 static BOOL do_parameter(char *parmname, char *parmvalue);
413 static BOOL do_section(char *sectionname);
416 /***************************************************************************
417 initialise a service to the defaults
418 ***************************************************************************/
419 static void init_service(service *pservice)
421 memset((char *)pservice,0,sizeof(service));
422 copy_service(pservice,&sDefault);
427 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
428 * be initialized when this is called, either to NULL or a malloc'd
431 * @fixme There is a small leak here in that sometimes the existing
432 * value will be dynamically allocated, and the old copy is lost.
433 * However, we can't always deallocate the old value, because in the
434 * case of sDefault, it points to a static string. It would be nice
435 * to have either all-strdup'd values, or to never need to free
438 static void string_set(char **s, const char *v)
446 exit_cleanup(RERR_MALLOC);
450 /***************************************************************************
451 add a new service to the services array initialising it with the given
453 ***************************************************************************/
454 static int add_a_service(service *pservice, char *name)
458 int num_to_alloc = iNumServices+1;
460 tservice = *pservice;
462 /* it might already exist */
465 i = getservicebyname(name,NULL);
472 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
475 pSERVICE(iNumServices) = new(service);
477 if (!ServicePtrs || !pSERVICE(iNumServices))
482 init_service(pSERVICE(i));
483 copy_service(pSERVICE(i),&tservice);
485 string_set(&iSERVICE(i).name,name);
490 /***************************************************************************
491 Do a case-insensitive, whitespace-ignoring string compare.
492 ***************************************************************************/
493 static int strwicmp(char *psz1, char *psz2)
495 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
496 /* appropriate value. */
506 /* sync the strings on first non-whitespace */
509 while (isspace(* (unsigned char *) psz1))
511 while (isspace(* (unsigned char *) psz2))
513 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
514 || *psz1 == '\0' || *psz2 == '\0')
519 return (*psz1 - *psz2);
522 /***************************************************************************
523 Map a parameter's string representation to something we can use.
524 Returns False if the parameter string is not recognised, else TRUE.
525 ***************************************************************************/
526 static int map_parameter(char *parmname)
530 if (*parmname == '-')
533 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
534 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
537 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
542 /***************************************************************************
543 Set a boolean variable from the text value stored in the passed string.
544 Returns True in success, False if the passed string does not correctly
546 ***************************************************************************/
547 static BOOL set_boolean(BOOL *pb, char *parmvalue)
552 if (strwicmp(parmvalue, "yes") == 0 ||
553 strwicmp(parmvalue, "true") == 0 ||
554 strwicmp(parmvalue, "1") == 0)
557 if (strwicmp(parmvalue, "no") == 0 ||
558 strwicmp(parmvalue, "False") == 0 ||
559 strwicmp(parmvalue, "0") == 0)
563 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
570 /***************************************************************************
571 Find a service by name. Otherwise works like get_service.
572 ***************************************************************************/
573 static int getservicebyname(char *name, service *pserviceDest)
577 for (iService = iNumServices - 1; iService >= 0; iService--)
578 if (strwicmp(iSERVICE(iService).name, name) == 0)
580 if (pserviceDest != NULL)
581 copy_service(pserviceDest, pSERVICE(iService));
590 /***************************************************************************
591 Copy a service structure to another
593 ***************************************************************************/
594 static void copy_service(service *pserviceDest,
595 service *pserviceSource)
599 for (i=0;parm_table[i].label;i++)
600 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
601 void *def_ptr = parm_table[i].ptr;
603 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
605 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
607 switch (parm_table[i].type)
611 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
617 *(int *)dest_ptr = *(int *)src_ptr;
621 *(char *)dest_ptr = *(char *)src_ptr;
626 string_set(dest_ptr,*(char **)src_ptr);
636 /***************************************************************************
637 Process a parameter for a particular service number. If snum < 0
638 then assume we are in the globals
639 ***************************************************************************/
640 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
643 void *parm_ptr=NULL; /* where we are going to store the result */
647 parmnum = map_parameter(parmname);
651 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
655 def_ptr = parm_table[parmnum].ptr;
657 /* we might point at a service, the default service or a global */
661 if (parm_table[parmnum].class == P_GLOBAL) {
662 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
665 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
668 /* now switch on the type of variable it is */
669 switch (parm_table[parmnum].type)
672 set_boolean(parm_ptr,parmvalue);
676 set_boolean(parm_ptr,parmvalue);
677 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
681 *(int *)parm_ptr = atoi(parmvalue);
685 *(char *)parm_ptr = *parmvalue;
689 sscanf(parmvalue,"%o",(int *)parm_ptr);
693 string_set(parm_ptr,parmvalue);
694 if ((cp = *(char**)parm_ptr) != NULL) {
695 int len = strlen(cp);
696 while (len > 1 && cp[len-1] == '/') len--;
702 string_set(parm_ptr,parmvalue);
706 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
710 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
711 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
712 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
716 if (!parm_table[parmnum].enum_list[i].name) {
717 if (atoi(parmvalue) > 0)
718 *(int *)parm_ptr = atoi(parmvalue);
728 /***************************************************************************
730 ***************************************************************************/
731 static BOOL do_parameter(char *parmname, char *parmvalue)
733 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
736 /***************************************************************************
737 Process a new section (service). At this stage all sections are services.
738 Later we'll have special sections that permit server parameters to be set.
739 Returns True on success, False on failure.
740 ***************************************************************************/
741 static BOOL do_section(char *sectionname)
744 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
747 /* if we were in a global section then do the local inits */
748 if (bInGlobalSection && !isglobal)
751 /* if we've just struck a global section, note the fact. */
752 bInGlobalSection = isglobal;
754 /* check for multiple global sections */
755 if (bInGlobalSection)
760 /* if we have a current service, tidy it up before moving on */
763 if (iServiceIndex >= 0)
766 /* if all is still well, move to the next record in the services array */
769 /* We put this here to avoid an odd message order if messages are */
770 /* issued by the post-processing of a previous section. */
772 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
774 rprintf(FERROR,"Failed to add a new service\n");
783 /***************************************************************************
784 Load the services array from the services file. Return True on success,
786 ***************************************************************************/
787 BOOL lp_load(char *pszFname, int globals_only)
789 extern int am_server;
790 extern int am_daemon;
797 bInGlobalSection = True;
802 pstrcpy(n2,pszFname);
803 else if (am_server && am_daemon && !am_root)
804 pstrcpy(n2,RSYNCD_USERCONF);
806 pstrcpy(n2,RSYNCD_SYSCONF);
808 /* We get sections first, so have to start 'behind' to make up */
810 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
816 /***************************************************************************
817 return the max number of services
818 ***************************************************************************/
819 int lp_numservices(void)
821 return(iNumServices);
824 /***************************************************************************
825 Return the number of the service with the given name, or -1 if it doesn't
826 exist. Note that this is a DIFFERENT ANIMAL from the internal function
827 getservicebyname()! This works ONLY if all services have been loaded, and
828 does not copy the found service.
829 ***************************************************************************/
830 int lp_number(char *name)
834 for (iService = iNumServices - 1; iService >= 0; iService--)
835 if (strcmp(lp_name(iService), name) == 0)