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
52 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
53 #define strequal(a,b) (strcasecmp(a,b)==0)
54 #define BOOLSTR(b) ((b) ? "Yes" : "No")
55 typedef char pstring[1024];
56 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
58 /* the following are used by loadparm for option lists */
61 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
62 P_STRING,P_GSTRING,P_ENUM,P_SEP
67 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
81 struct enum_list *enum_list;
86 #define GLOBAL_NAME "global"
89 /* some helpful bits */
90 #define pSERVICE(i) ServicePtrs[i]
91 #define iSERVICE(i) (*pSERVICE(i))
92 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
95 * This structure describes global (ie., server-wide) parameters.
103 char *socket_options;
106 static global Globals;
111 * This structure describes a single service.
122 BOOL transfer_logging;
136 char *refuse_options;
140 BOOL ignore_nonreadable;
144 /* This is a default service used to prime a services structure */
145 static service sDefault =
150 DEFAULT_LOCK_FILE, /* lock file */
151 True, /* read only */
153 True, /* use chroot */
154 False, /* transfer logging */
155 False, /* ignore errors */
158 /* TODO: This causes problems on Debian, where it is called
159 * "nogroup". Debian patch this in their version of the
160 * package, but it would be nice to be consistent. Possibly
161 * other systems are different again.
163 * What is the best behaviour? Perhaps always using (gid_t)
167 NULL, /* hosts allow */
168 NULL, /* hosts deny */
169 NULL, /* auth users */
170 NULL, /* secrets file */
171 True, /* strict modes */
173 NULL, /* exclude from */
175 NULL, /* include from */
176 "%o %h [%a] %m (%u) %f %l", /* log format */
177 NULL, /* refuse options */
178 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
180 0, /* max connections */
181 False /* ignore nonreadable */
186 /* local variables */
187 static service **ServicePtrs = NULL;
188 static int iNumServices = 0;
189 static int iServiceIndex = 0;
190 static BOOL bInGlobalSection = True;
192 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
194 static struct enum_list enum_facilities[] = {
196 { LOG_AUTH, "auth" },
199 { LOG_AUTHPRIV, "authpriv" },
202 { LOG_CRON, "cron" },
205 { LOG_DAEMON, "daemon" },
211 { LOG_KERN, "kern" },
217 { LOG_MAIL, "mail" },
220 { LOG_NEWS, "news" },
223 { LOG_AUTH, "security" },
226 { LOG_SYSLOG, "syslog" },
229 { LOG_USER, "user" },
232 { LOG_UUCP, "uucp" },
235 { LOG_LOCAL0, "local0" },
238 { LOG_LOCAL1, "local1" },
241 { LOG_LOCAL2, "local2" },
244 { LOG_LOCAL3, "local3" },
247 { LOG_LOCAL4, "local4" },
250 { LOG_LOCAL5, "local5" },
253 { LOG_LOCAL6, "local6" },
256 { LOG_LOCAL7, "local7" },
261 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
262 static struct parm_struct parm_table[] =
264 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
265 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
266 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
267 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
268 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
270 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
271 {"max connections", P_INTEGER, P_LOCAL, &sDefault.max_connections,NULL, 0},
272 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
273 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
274 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL, 0},
275 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
276 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
277 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
278 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
279 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable, NULL, 0},
280 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
281 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
282 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
283 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
284 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
285 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
286 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes,NULL, 0},
287 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
288 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
289 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
290 {"include from", P_STRING, P_LOCAL, &sDefault.include_from,NULL, 0},
291 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
292 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors,NULL,0},
293 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
294 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
295 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
296 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
300 /***************************************************************************
301 Initialise the global parameter structure.
302 ***************************************************************************/
303 static void init_globals(void)
305 memset(&Globals, 0, sizeof(Globals));
307 Globals.syslog_facility = LOG_DAEMON;
311 /***************************************************************************
312 Initialise the sDefault parameter structure.
313 ***************************************************************************/
314 static void init_locals(void)
320 In this section all the functions that are used to access the
321 parameters from the rest of the program are defined
324 #define FN_GLOBAL_STRING(fn_name,ptr) \
325 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
326 #define FN_GLOBAL_BOOL(fn_name,ptr) \
327 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
328 #define FN_GLOBAL_CHAR(fn_name,ptr) \
329 char fn_name(void) {return(*(char *)(ptr));}
330 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
331 int fn_name(void) {return(*(int *)(ptr));}
333 #define FN_LOCAL_STRING(fn_name,val) \
334 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
335 #define FN_LOCAL_BOOL(fn_name,val) \
336 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
337 #define FN_LOCAL_CHAR(fn_name,val) \
338 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
339 #define FN_LOCAL_INTEGER(fn_name,val) \
340 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
343 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
344 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
345 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
346 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
347 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
349 FN_LOCAL_STRING(lp_name, name)
350 FN_LOCAL_STRING(lp_comment, comment)
351 FN_LOCAL_STRING(lp_path, path)
352 FN_LOCAL_STRING(lp_lock_file, lock_file)
353 FN_LOCAL_BOOL(lp_read_only, read_only)
354 FN_LOCAL_BOOL(lp_list, list)
355 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
356 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
357 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
358 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
359 FN_LOCAL_STRING(lp_uid, uid)
360 FN_LOCAL_STRING(lp_gid, gid)
361 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
362 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
363 FN_LOCAL_STRING(lp_auth_users, auth_users)
364 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
365 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
366 FN_LOCAL_STRING(lp_exclude, exclude)
367 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
368 FN_LOCAL_STRING(lp_include, include)
369 FN_LOCAL_STRING(lp_include_from, include_from)
370 FN_LOCAL_STRING(lp_log_format, log_format)
371 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
372 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
373 FN_LOCAL_INTEGER(lp_timeout, timeout)
374 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
376 /* local prototypes */
377 static int strwicmp( char *psz1, char *psz2 );
378 static int map_parameter( char *parmname);
379 static BOOL set_boolean( BOOL *pb, char *parmvalue );
380 static int getservicebyname(char *name, service *pserviceDest);
381 static void copy_service( service *pserviceDest,
382 service *pserviceSource);
383 static BOOL do_parameter(char *parmname, char *parmvalue);
384 static BOOL do_section(char *sectionname);
387 /***************************************************************************
388 initialise a service to the defaults
389 ***************************************************************************/
390 static void init_service(service *pservice)
392 memset((char *)pservice,0,sizeof(service));
393 copy_service(pservice,&sDefault);
398 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
399 * be initialized when this is called, either to NULL or a malloc'd
402 * @fixme There is a small leak here in that sometimes the existing
403 * value will be dynamically allocated, and the old copy is lost.
404 * However, we can't always deallocate the old value, because in the
405 * case of sDefault, it points to a static string. It would be nice
406 * to have either all-strdup'd values, or to never need to free
409 static void string_set(char **s, const char *v)
417 exit_cleanup(RERR_MALLOC);
421 /***************************************************************************
422 add a new service to the services array initialising it with the given
424 ***************************************************************************/
425 static int add_a_service(service *pservice, char *name)
429 int num_to_alloc = iNumServices+1;
431 tservice = *pservice;
433 /* it might already exist */
436 i = getservicebyname(name,NULL);
443 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
446 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
448 if (!ServicePtrs || !pSERVICE(iNumServices))
453 init_service(pSERVICE(i));
454 copy_service(pSERVICE(i),&tservice);
456 string_set(&iSERVICE(i).name,name);
461 /***************************************************************************
462 Do a case-insensitive, whitespace-ignoring string compare.
463 ***************************************************************************/
464 static int strwicmp(char *psz1, char *psz2)
466 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
467 /* appropriate value. */
477 /* sync the strings on first non-whitespace */
480 while (isspace(*psz1))
482 while (isspace(*psz2))
484 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
489 return (*psz1 - *psz2);
492 /***************************************************************************
493 Map a parameter's string representation to something we can use.
494 Returns False if the parameter string is not recognised, else TRUE.
495 ***************************************************************************/
496 static int map_parameter(char *parmname)
500 if (*parmname == '-')
503 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
504 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
507 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
512 /***************************************************************************
513 Set a boolean variable from the text value stored in the passed string.
514 Returns True in success, False if the passed string does not correctly
516 ***************************************************************************/
517 static BOOL set_boolean(BOOL *pb, char *parmvalue)
522 if (strwicmp(parmvalue, "yes") == 0 ||
523 strwicmp(parmvalue, "true") == 0 ||
524 strwicmp(parmvalue, "1") == 0)
527 if (strwicmp(parmvalue, "no") == 0 ||
528 strwicmp(parmvalue, "False") == 0 ||
529 strwicmp(parmvalue, "0") == 0)
533 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
540 /***************************************************************************
541 Find a service by name. Otherwise works like get_service.
542 ***************************************************************************/
543 static int getservicebyname(char *name, service *pserviceDest)
547 for (iService = iNumServices - 1; iService >= 0; iService--)
548 if (strwicmp(iSERVICE(iService).name, name) == 0)
550 if (pserviceDest != NULL)
551 copy_service(pserviceDest, pSERVICE(iService));
560 /***************************************************************************
561 Copy a service structure to another
563 ***************************************************************************/
564 static void copy_service(service *pserviceDest,
565 service *pserviceSource)
569 for (i=0;parm_table[i].label;i++)
570 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
571 void *def_ptr = parm_table[i].ptr;
573 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
575 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
577 switch (parm_table[i].type)
581 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
587 *(int *)dest_ptr = *(int *)src_ptr;
591 *(char *)dest_ptr = *(char *)src_ptr;
595 string_set(dest_ptr,*(char **)src_ptr);
605 /***************************************************************************
606 Process a parameter for a particular service number. If snum < 0
607 then assume we are in the globals
608 ***************************************************************************/
609 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
612 void *parm_ptr=NULL; /* where we are going to store the result */
615 parmnum = map_parameter(parmname);
619 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
623 def_ptr = parm_table[parmnum].ptr;
625 /* we might point at a service, the default service or a global */
629 if (parm_table[parmnum].class == P_GLOBAL) {
630 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
633 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
636 /* now switch on the type of variable it is */
637 switch (parm_table[parmnum].type)
640 set_boolean(parm_ptr,parmvalue);
644 set_boolean(parm_ptr,parmvalue);
645 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
649 *(int *)parm_ptr = atoi(parmvalue);
653 *(char *)parm_ptr = *parmvalue;
657 sscanf(parmvalue,"%o",(int *)parm_ptr);
661 string_set(parm_ptr,parmvalue);
665 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
669 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
670 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
671 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
675 if (!parm_table[parmnum].enum_list[i].name) {
676 if (atoi(parmvalue) > 0)
677 *(int *)parm_ptr = atoi(parmvalue);
687 /***************************************************************************
689 ***************************************************************************/
690 static BOOL do_parameter(char *parmname, char *parmvalue)
692 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
695 /***************************************************************************
696 Process a new section (service). At this stage all sections are services.
697 Later we'll have special sections that permit server parameters to be set.
698 Returns True on success, False on failure.
699 ***************************************************************************/
700 static BOOL do_section(char *sectionname)
703 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
706 /* if we were in a global section then do the local inits */
707 if (bInGlobalSection && !isglobal)
710 /* if we've just struck a global section, note the fact. */
711 bInGlobalSection = isglobal;
713 /* check for multiple global sections */
714 if (bInGlobalSection)
719 /* if we have a current service, tidy it up before moving on */
722 if (iServiceIndex >= 0)
725 /* if all is still well, move to the next record in the services array */
728 /* We put this here to avoid an odd message order if messages are */
729 /* issued by the post-processing of a previous section. */
731 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
733 rprintf(FERROR,"Failed to add a new service\n");
742 /***************************************************************************
743 Load the services array from the services file. Return True on success,
745 ***************************************************************************/
746 BOOL lp_load(char *pszFname, int globals_only)
753 bInGlobalSection = True;
757 pstrcpy(n2,pszFname);
759 /* We get sections first, so have to start 'behind' to make up */
761 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
767 /***************************************************************************
768 return the max number of services
769 ***************************************************************************/
770 int lp_numservices(void)
772 return(iNumServices);
775 /***************************************************************************
776 Return the number of the service with the given name, or -1 if it doesn't
777 exist. Note that this is a DIFFERENT ANIMAL from the internal function
778 getservicebyname()! This works ONLY if all services have been loaded, and
779 does not copy the found service.
780 ***************************************************************************/
781 int lp_number(char *name)
785 for (iService = iNumServices - 1; iService >= 0; iService--)
786 if (strequal(lp_name(iService), name))