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 2 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, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
22 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
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))
64 /* the following are used by loadparm for option lists */
67 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
68 P_PATH,P_STRING,P_GSTRING,P_ENUM,P_SEP
73 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
87 struct enum_list *enum_list;
92 #define GLOBAL_NAME "global"
95 /* some helpful bits */
96 #define pSERVICE(i) ServicePtrs[i]
97 #define iSERVICE(i) (*pSERVICE(i))
98 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
101 * This structure describes global (ie., server-wide) parameters.
108 char *socket_options;
113 static global Globals;
117 * This structure describes a single service. Their order must match the
118 * initializers below, which you can accomplish by keeping each sub-section
119 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
134 char *incoming_chmod;
139 char *outgoing_chmod;
143 char *refuse_options;
154 BOOL ignore_nonreadable;
159 BOOL transfer_logging;
165 /* This is a default service used to prime a services structure. In order
166 * to make these easy to keep sorted in the same way as the variables
167 * above, use the variable name in the leading comment, including a
168 * trailing ';' (to avoid a sorting problem with trailing digits). */
169 static service sDefault =
171 /* auth_users; */ NULL,
173 /* dont_compress; */ "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz",
175 /* exclude_from; */ NULL,
177 /* gid; */ NOBODY_GROUP,
178 /* hosts_allow; */ NULL,
179 /* hosts_deny; */ NULL,
181 /* include_from; */ NULL,
182 /* incoming_chmod; */ NULL,
183 /* lock_file; */ DEFAULT_LOCK_FILE,
184 /* log_file; */ NULL,
185 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
187 /* outgoing_chmod; */ NULL,
189 /* postxfer_exec; */ NULL,
190 /* prexfer_exec; */ NULL,
191 /* refuse_options; */ NULL,
192 /* secrets_file; */ NULL,
193 /* temp_dir; */ NULL,
194 /* uid; */ NOBODY_USER,
196 /* max_connections; */ 0,
197 /* max_verbosity; */ 1,
198 /* syslog_facility; */ LOG_DAEMON,
201 /* ignore_errors; */ False,
202 /* ignore_nonreadable; */ False,
204 /* munge_symlinks; */ False,
205 /* read_only; */ True,
206 /* strict_modes; */ True,
207 /* transfer_logging; */ False,
208 /* use_chroot; */ True,
209 /* write_only; */ False,
214 /* local variables */
215 static service **ServicePtrs = NULL;
216 static int iNumServices = 0;
217 static int iServiceIndex = 0;
218 static BOOL bInGlobalSection = True;
220 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
222 static struct enum_list enum_facilities[] = {
224 { LOG_AUTH, "auth" },
227 { LOG_AUTHPRIV, "authpriv" },
230 { LOG_CRON, "cron" },
233 { LOG_DAEMON, "daemon" },
239 { LOG_KERN, "kern" },
245 { LOG_MAIL, "mail" },
248 { LOG_NEWS, "news" },
251 { LOG_AUTH, "security" },
254 { LOG_SYSLOG, "syslog" },
257 { LOG_USER, "user" },
260 { LOG_UUCP, "uucp" },
263 { LOG_LOCAL0, "local0" },
266 { LOG_LOCAL1, "local1" },
269 { LOG_LOCAL2, "local2" },
272 { LOG_LOCAL3, "local3" },
275 { LOG_LOCAL4, "local4" },
278 { LOG_LOCAL5, "local5" },
281 { LOG_LOCAL6, "local6" },
284 { LOG_LOCAL7, "local7" },
289 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
290 static struct parm_struct parm_table[] =
292 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
293 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
294 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
295 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
296 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
298 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
299 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
300 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
301 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
302 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
303 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
304 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
305 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
306 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
307 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
308 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
309 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
310 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
311 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
312 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
313 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
314 {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
315 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
316 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
317 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
318 {"munge symlinks", P_BOOL, P_LOCAL, &sDefault.munge_symlinks, NULL,0},
319 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
320 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
321 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
323 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
324 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
326 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
327 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
328 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
329 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
330 {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
331 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
332 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
333 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
334 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
335 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
336 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
337 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
341 /***************************************************************************
342 Initialise the global parameter structure.
343 ***************************************************************************/
344 static void init_globals(void)
346 memset(&Globals, 0, sizeof Globals);
349 /***************************************************************************
350 Initialise the sDefault parameter structure.
351 ***************************************************************************/
352 static void init_locals(void)
358 In this section all the functions that are used to access the
359 parameters from the rest of the program are defined
362 #define FN_GLOBAL_STRING(fn_name,ptr) \
363 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
364 #define FN_GLOBAL_BOOL(fn_name,ptr) \
365 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
366 #define FN_GLOBAL_CHAR(fn_name,ptr) \
367 char fn_name(void) {return(*(char *)(ptr));}
368 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
369 int fn_name(void) {return(*(int *)(ptr));}
371 #define FN_LOCAL_STRING(fn_name,val) \
372 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
373 #define FN_LOCAL_BOOL(fn_name,val) \
374 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
375 #define FN_LOCAL_CHAR(fn_name,val) \
376 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
377 #define FN_LOCAL_INTEGER(fn_name,val) \
378 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
381 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
382 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
383 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
384 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
386 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
388 FN_LOCAL_STRING(lp_auth_users, auth_users)
389 FN_LOCAL_STRING(lp_comment, comment)
390 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
391 FN_LOCAL_STRING(lp_exclude, exclude)
392 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
393 FN_LOCAL_STRING(lp_filter, filter)
394 FN_LOCAL_STRING(lp_gid, gid)
395 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
396 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
397 FN_LOCAL_STRING(lp_include, include)
398 FN_LOCAL_STRING(lp_include_from, include_from)
399 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
400 FN_LOCAL_STRING(lp_lock_file, lock_file)
401 FN_LOCAL_STRING(lp_log_file, log_file)
402 FN_LOCAL_STRING(lp_log_format, log_format)
403 FN_LOCAL_STRING(lp_name, name)
404 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
405 FN_LOCAL_STRING(lp_path, path)
406 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
407 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
408 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
409 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
410 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
411 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
412 FN_LOCAL_STRING(lp_uid, uid)
414 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
415 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
416 FN_LOCAL_INTEGER(lp_timeout, timeout)
418 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
419 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
420 FN_LOCAL_BOOL(lp_list, list)
421 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
422 FN_LOCAL_BOOL(lp_read_only, read_only)
423 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
424 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
425 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
426 FN_LOCAL_BOOL(lp_write_only, write_only)
428 /* local prototypes */
429 static int strwicmp(char *psz1, char *psz2);
430 static int map_parameter(char *parmname);
431 static BOOL set_boolean(BOOL *pb, char *parmvalue);
432 static int getservicebyname(char *name, service *pserviceDest);
433 static void copy_service(service *pserviceDest, service *pserviceSource);
434 static BOOL do_parameter(char *parmname, char *parmvalue);
435 static BOOL do_section(char *sectionname);
438 /***************************************************************************
439 initialise a service to the defaults
440 ***************************************************************************/
441 static void init_service(service *pservice)
443 memset((char *)pservice,0,sizeof(service));
444 copy_service(pservice,&sDefault);
449 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
450 * be initialized when this is called, either to NULL or a malloc'd
453 * @fixme There is a small leak here in that sometimes the existing
454 * value will be dynamically allocated, and the old copy is lost.
455 * However, we can't always deallocate the old value, because in the
456 * case of sDefault, it points to a static string. It would be nice
457 * to have either all-strdup'd values, or to never need to free
460 static void string_set(char **s, const char *v)
468 exit_cleanup(RERR_MALLOC);
472 /***************************************************************************
473 add a new service to the services array initialising it with the given
475 ***************************************************************************/
476 static int add_a_service(service *pservice, char *name)
480 int num_to_alloc = iNumServices+1;
482 tservice = *pservice;
484 /* it might already exist */
487 i = getservicebyname(name,NULL);
494 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
497 pSERVICE(iNumServices) = new(service);
499 if (!ServicePtrs || !pSERVICE(iNumServices))
504 init_service(pSERVICE(i));
505 copy_service(pSERVICE(i),&tservice);
507 string_set(&iSERVICE(i).name,name);
512 /***************************************************************************
513 Do a case-insensitive, whitespace-ignoring string compare.
514 ***************************************************************************/
515 static int strwicmp(char *psz1, char *psz2)
517 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
518 /* appropriate value. */
528 /* sync the strings on first non-whitespace */
531 while (isspace(* (unsigned char *) psz1))
533 while (isspace(* (unsigned char *) psz2))
535 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
536 || *psz1 == '\0' || *psz2 == '\0')
541 return (*psz1 - *psz2);
544 /***************************************************************************
545 Map a parameter's string representation to something we can use.
546 Returns False if the parameter string is not recognised, else TRUE.
547 ***************************************************************************/
548 static int map_parameter(char *parmname)
552 if (*parmname == '-')
555 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
556 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
559 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
564 /***************************************************************************
565 Set a boolean variable from the text value stored in the passed string.
566 Returns True in success, False if the passed string does not correctly
568 ***************************************************************************/
569 static BOOL set_boolean(BOOL *pb, char *parmvalue)
574 if (strwicmp(parmvalue, "yes") == 0 ||
575 strwicmp(parmvalue, "true") == 0 ||
576 strwicmp(parmvalue, "1") == 0)
579 if (strwicmp(parmvalue, "no") == 0 ||
580 strwicmp(parmvalue, "False") == 0 ||
581 strwicmp(parmvalue, "0") == 0)
585 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
592 /***************************************************************************
593 Find a service by name. Otherwise works like get_service.
594 ***************************************************************************/
595 static int getservicebyname(char *name, service *pserviceDest)
599 for (iService = iNumServices - 1; iService >= 0; iService--)
600 if (strwicmp(iSERVICE(iService).name, name) == 0)
602 if (pserviceDest != NULL)
603 copy_service(pserviceDest, pSERVICE(iService));
612 /***************************************************************************
613 Copy a service structure to another
615 ***************************************************************************/
616 static void copy_service(service *pserviceDest,
617 service *pserviceSource)
621 for (i=0;parm_table[i].label;i++)
622 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
623 void *def_ptr = parm_table[i].ptr;
625 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
627 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
629 switch (parm_table[i].type)
633 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
639 *(int *)dest_ptr = *(int *)src_ptr;
643 *(char *)dest_ptr = *(char *)src_ptr;
648 string_set(dest_ptr,*(char **)src_ptr);
658 /***************************************************************************
659 Process a parameter for a particular service number. If snum < 0
660 then assume we are in the globals
661 ***************************************************************************/
662 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
665 void *parm_ptr=NULL; /* where we are going to store the result */
669 parmnum = map_parameter(parmname);
673 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
677 def_ptr = parm_table[parmnum].ptr;
679 /* we might point at a service, the default service or a global */
683 if (parm_table[parmnum].class == P_GLOBAL) {
684 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
687 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
690 /* now switch on the type of variable it is */
691 switch (parm_table[parmnum].type)
694 set_boolean(parm_ptr,parmvalue);
698 set_boolean(parm_ptr,parmvalue);
699 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
703 *(int *)parm_ptr = atoi(parmvalue);
707 *(char *)parm_ptr = *parmvalue;
711 sscanf(parmvalue,"%o",(int *)parm_ptr);
715 string_set(parm_ptr,parmvalue);
716 if ((cp = *(char**)parm_ptr) != NULL) {
717 int len = strlen(cp);
718 while (len > 1 && cp[len-1] == '/') len--;
724 string_set(parm_ptr,parmvalue);
728 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
732 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
733 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
734 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
738 if (!parm_table[parmnum].enum_list[i].name) {
739 if (atoi(parmvalue) > 0)
740 *(int *)parm_ptr = atoi(parmvalue);
750 /***************************************************************************
752 ***************************************************************************/
753 static BOOL do_parameter(char *parmname, char *parmvalue)
755 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
758 /***************************************************************************
759 Process a new section (service). At this stage all sections are services.
760 Later we'll have special sections that permit server parameters to be set.
761 Returns True on success, False on failure.
762 ***************************************************************************/
763 static BOOL do_section(char *sectionname)
766 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
769 /* if we were in a global section then do the local inits */
770 if (bInGlobalSection && !isglobal)
773 /* if we've just struck a global section, note the fact. */
774 bInGlobalSection = isglobal;
776 /* check for multiple global sections */
777 if (bInGlobalSection)
782 /* if we have a current service, tidy it up before moving on */
785 if (iServiceIndex >= 0)
788 /* if all is still well, move to the next record in the services array */
791 /* We put this here to avoid an odd message order if messages are */
792 /* issued by the post-processing of a previous section. */
794 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
796 rprintf(FERROR,"Failed to add a new service\n");
805 /***************************************************************************
806 Load the services array from the services file. Return True on success,
808 ***************************************************************************/
809 BOOL lp_load(char *pszFname, int globals_only)
811 extern int am_server;
818 bInGlobalSection = True;
823 pstrcpy(n2,pszFname);
824 else if (am_server && !am_root)
825 pstrcpy(n2,RSYNCD_USERCONF);
827 pstrcpy(n2,RSYNCD_SYSCONF);
829 /* We get sections first, so have to start 'behind' to make up */
831 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
837 /***************************************************************************
838 return the max number of services
839 ***************************************************************************/
840 int lp_numservices(void)
842 return(iNumServices);
845 /***************************************************************************
846 Return the number of the service with the given name, or -1 if it doesn't
847 exist. Note that this is a DIFFERENT ANIMAL from the internal function
848 getservicebyname()! This works ONLY if all services have been loaded, and
849 does not copy the found service.
850 ***************************************************************************/
851 int lp_number(char *name)
855 for (iService = iNumServices - 1; iService >= 0; iService--)
856 if (strcmp(lp_name(iService), name) == 0)