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
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * This module provides suitable callback functions for the params
24 * module. It builds the internal table of service details which is
25 * then used by the rest of the server.
29 * 1) add it to the global or service structure definition
30 * 2) add it to the parm_table
31 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
32 * 4) If it's a global then initialise it in init_globals. If a local
33 * (ie. service) parameter then initialise it in the sDefault structure
37 * The configuration file is processed sequentially for speed. It is NOT
38 * accessed randomly as happens in 'real' Windows. For this reason, there
39 * is a fair bit of sequence-dependent code here - ie., code which assumes
40 * that certain things happen before others. In particular, the code which
41 * happens at the boundary between sections is delicately poised, so be
47 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
48 #define strequal(a,b) (strcasecmp(a,b)==0)
49 #define BOOLSTR(b) ((b) ? "Yes" : "No")
50 typedef char pstring[1024];
51 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
53 /* the following are used by loadparm for option lists */
56 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
57 P_STRING,P_GSTRING,P_ENUM,P_SEP
62 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
76 struct enum_list *enum_list;
80 static BOOL bLoaded = False;
83 #define GLOBAL_NAME "global"
86 /* some helpful bits */
87 #define pSERVICE(i) ServicePtrs[i]
88 #define iSERVICE(i) (*pSERVICE(i))
89 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
92 * This structure describes global (ie., server-wide) parameters.
100 char *socket_options;
103 static global Globals;
108 * This structure describes a single service.
119 BOOL transfer_logging;
132 char *refuse_options;
139 /* This is a default service used to prime a services structure */
140 static service sDefault =
145 DEFAULT_LOCK_FILE, /* lock file */
146 True, /* read only */
148 True, /* use chroot */
149 False, /* transfer logging */
152 NULL, /* hosts allow */
153 NULL, /* hosts deny */
154 NULL, /* auth users */
155 NULL, /* secrets file */
156 True, /* strict modes */
158 NULL, /* exclude from */
160 NULL, /* include from */
161 "%o %h [%a] %m (%u) %f %l", /* log format */
162 NULL, /* refuse options */
163 "*.gz *.tgz *.zip *.z *.rpm *.deb", /* dont compress */
165 0 /* max connections */
170 /* local variables */
171 static service **ServicePtrs = NULL;
172 static int iNumServices = 0;
173 static int iServiceIndex = 0;
174 static BOOL bInGlobalSection = True;
176 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
178 static struct enum_list enum_facilities[] = {
180 { LOG_AUTH, "auth" },
183 { LOG_AUTHPRIV, "authpriv" },
186 { LOG_CRON, "cron" },
189 { LOG_DAEMON, "daemon" },
195 { LOG_KERN, "kern" },
201 { LOG_MAIL, "mail" },
204 { LOG_NEWS, "news" },
207 { LOG_AUTH, "security" },
210 { LOG_SYSLOG, "syslog" },
213 { LOG_USER, "user" },
216 { LOG_UUCP, "uucp" },
219 { LOG_LOCAL0, "local0" },
222 { LOG_LOCAL1, "local1" },
225 { LOG_LOCAL2, "local2" },
228 { LOG_LOCAL3, "local3" },
231 { LOG_LOCAL4, "local4" },
234 { LOG_LOCAL5, "local5" },
237 { LOG_LOCAL6, "local6" },
240 { LOG_LOCAL7, "local7" },
245 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
246 static struct parm_struct parm_table[] =
248 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
249 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
250 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
251 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
252 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
254 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
255 {"max connections", P_INTEGER, P_LOCAL, &sDefault.max_connections,NULL, 0},
256 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
257 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
258 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL, 0},
259 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
260 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
261 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
262 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
263 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
264 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
265 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
266 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
267 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
268 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
269 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes,NULL, 0},
270 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
271 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
272 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
273 {"include from", P_STRING, P_LOCAL, &sDefault.include_from,NULL, 0},
274 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
275 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
276 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
277 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
278 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
282 /***************************************************************************
283 Initialise the global parameter structure.
284 ***************************************************************************/
285 static void init_globals(void)
287 memset(&Globals, 0, sizeof(Globals));
289 Globals.syslog_facility = LOG_DAEMON;
293 /***************************************************************************
294 Initialise the sDefault parameter structure.
295 ***************************************************************************/
296 static void init_locals(void)
302 In this section all the functions that are used to access the
303 parameters from the rest of the program are defined
306 #define FN_GLOBAL_STRING(fn_name,ptr) \
307 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
308 #define FN_GLOBAL_BOOL(fn_name,ptr) \
309 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
310 #define FN_GLOBAL_CHAR(fn_name,ptr) \
311 char fn_name(void) {return(*(char *)(ptr));}
312 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
313 int fn_name(void) {return(*(int *)(ptr));}
315 #define FN_LOCAL_STRING(fn_name,val) \
316 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
317 #define FN_LOCAL_BOOL(fn_name,val) \
318 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
319 #define FN_LOCAL_CHAR(fn_name,val) \
320 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
321 #define FN_LOCAL_INTEGER(fn_name,val) \
322 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
325 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
326 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
327 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
328 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
329 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
331 FN_LOCAL_STRING(lp_name, name)
332 FN_LOCAL_STRING(lp_comment, comment)
333 FN_LOCAL_STRING(lp_path, path)
334 FN_LOCAL_STRING(lp_lock_file, lock_file)
335 FN_LOCAL_BOOL(lp_read_only, read_only)
336 FN_LOCAL_BOOL(lp_list, list)
337 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
338 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
339 FN_LOCAL_STRING(lp_uid, uid)
340 FN_LOCAL_STRING(lp_gid, gid)
341 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
342 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
343 FN_LOCAL_STRING(lp_auth_users, auth_users)
344 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
345 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
346 FN_LOCAL_STRING(lp_exclude, exclude)
347 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
348 FN_LOCAL_STRING(lp_include, include)
349 FN_LOCAL_STRING(lp_include_from, include_from)
350 FN_LOCAL_STRING(lp_log_format, log_format)
351 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
352 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
353 FN_LOCAL_INTEGER(lp_timeout, timeout)
354 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
356 /* local prototypes */
357 static int strwicmp( char *psz1, char *psz2 );
358 static int map_parameter( char *parmname);
359 static BOOL set_boolean( BOOL *pb, char *parmvalue );
360 static int getservicebyname(char *name, service *pserviceDest);
361 static void copy_service( service *pserviceDest,
362 service *pserviceSource);
363 static BOOL do_parameter(char *parmname, char *parmvalue);
364 static BOOL do_section(char *sectionname);
367 /***************************************************************************
368 initialise a service to the defaults
369 ***************************************************************************/
370 static void init_service(service *pservice)
372 memset((char *)pservice,0,sizeof(service));
373 copy_service(pservice,&sDefault);
376 static void string_set(char **s, char *v)
383 if (!*s) exit_cleanup(RERR_MALLOC);
387 /***************************************************************************
388 add a new service to the services array initialising it with the given
390 ***************************************************************************/
391 static int add_a_service(service *pservice, char *name)
395 int num_to_alloc = iNumServices+1;
397 tservice = *pservice;
399 /* it might already exist */
402 i = getservicebyname(name,NULL);
409 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
412 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
414 if (!ServicePtrs || !pSERVICE(iNumServices))
419 init_service(pSERVICE(i));
420 copy_service(pSERVICE(i),&tservice);
422 string_set(&iSERVICE(i).name,name);
427 /***************************************************************************
428 Do a case-insensitive, whitespace-ignoring string compare.
429 ***************************************************************************/
430 static int strwicmp(char *psz1, char *psz2)
432 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
433 /* appropriate value. */
443 /* sync the strings on first non-whitespace */
446 while (isspace(*psz1))
448 while (isspace(*psz2))
450 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
455 return (*psz1 - *psz2);
458 /***************************************************************************
459 Map a parameter's string representation to something we can use.
460 Returns False if the parameter string is not recognised, else TRUE.
461 ***************************************************************************/
462 static int map_parameter(char *parmname)
466 if (*parmname == '-')
469 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
470 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
473 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
478 /***************************************************************************
479 Set a boolean variable from the text value stored in the passed string.
480 Returns True in success, False if the passed string does not correctly
482 ***************************************************************************/
483 static BOOL set_boolean(BOOL *pb, char *parmvalue)
488 if (strwicmp(parmvalue, "yes") == 0 ||
489 strwicmp(parmvalue, "true") == 0 ||
490 strwicmp(parmvalue, "1") == 0)
493 if (strwicmp(parmvalue, "no") == 0 ||
494 strwicmp(parmvalue, "False") == 0 ||
495 strwicmp(parmvalue, "0") == 0)
499 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
506 /***************************************************************************
507 Find a service by name. Otherwise works like get_service.
508 ***************************************************************************/
509 static int getservicebyname(char *name, service *pserviceDest)
513 for (iService = iNumServices - 1; iService >= 0; iService--)
514 if (strwicmp(iSERVICE(iService).name, name) == 0)
516 if (pserviceDest != NULL)
517 copy_service(pserviceDest, pSERVICE(iService));
526 /***************************************************************************
527 Copy a service structure to another
529 ***************************************************************************/
530 static void copy_service(service *pserviceDest,
531 service *pserviceSource)
535 for (i=0;parm_table[i].label;i++)
536 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
537 void *def_ptr = parm_table[i].ptr;
539 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
541 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
543 switch (parm_table[i].type)
547 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
553 *(int *)dest_ptr = *(int *)src_ptr;
557 *(char *)dest_ptr = *(char *)src_ptr;
561 string_set(dest_ptr,*(char **)src_ptr);
571 /***************************************************************************
572 Process a parameter for a particular service number. If snum < 0
573 then assume we are in the globals
574 ***************************************************************************/
575 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
578 void *parm_ptr=NULL; /* where we are going to store the result */
581 parmnum = map_parameter(parmname);
585 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
589 def_ptr = parm_table[parmnum].ptr;
591 /* we might point at a service, the default service or a global */
595 if (parm_table[parmnum].class == P_GLOBAL) {
596 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
599 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
602 /* now switch on the type of variable it is */
603 switch (parm_table[parmnum].type)
606 set_boolean(parm_ptr,parmvalue);
610 set_boolean(parm_ptr,parmvalue);
611 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
615 *(int *)parm_ptr = atoi(parmvalue);
619 *(char *)parm_ptr = *parmvalue;
623 sscanf(parmvalue,"%o",(int *)parm_ptr);
627 string_set(parm_ptr,parmvalue);
631 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
635 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
636 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
637 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
641 if (!parm_table[parmnum].enum_list[i].name) {
642 if (atoi(parmvalue) > 0)
643 *(int *)parm_ptr = atoi(parmvalue);
653 /***************************************************************************
655 ***************************************************************************/
656 static BOOL do_parameter(char *parmname, char *parmvalue)
658 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
661 /***************************************************************************
662 Process a new section (service). At this stage all sections are services.
663 Later we'll have special sections that permit server parameters to be set.
664 Returns True on success, False on failure.
665 ***************************************************************************/
666 static BOOL do_section(char *sectionname)
669 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
672 /* if we were in a global section then do the local inits */
673 if (bInGlobalSection && !isglobal)
676 /* if we've just struck a global section, note the fact. */
677 bInGlobalSection = isglobal;
679 /* check for multiple global sections */
680 if (bInGlobalSection)
685 /* if we have a current service, tidy it up before moving on */
688 if (iServiceIndex >= 0)
691 /* if all is still well, move to the next record in the services array */
694 /* We put this here to avoid an odd message order if messages are */
695 /* issued by the post-processing of a previous section. */
697 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
699 rprintf(FERROR,"Failed to add a new service\n");
708 /***************************************************************************
709 Load the services array from the services file. Return True on success,
711 ***************************************************************************/
712 BOOL lp_load(char *pszFname, int globals_only)
719 bInGlobalSection = True;
723 pstrcpy(n2,pszFname);
725 /* We get sections first, so have to start 'behind' to make up */
727 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
735 /***************************************************************************
736 return the max number of services
737 ***************************************************************************/
738 int lp_numservices(void)
740 return(iNumServices);
743 /***************************************************************************
744 Return the number of the service with the given name, or -1 if it doesn't
745 exist. Note that this is a DIFFERENT ANIMAL from the internal function
746 getservicebyname()! This works ONLY if all services have been loaded, and
747 does not copy the found service.
748 ***************************************************************************/
749 int lp_number(char *name)
753 for (iService = iNumServices - 1; iService >= 0; iService--)
754 if (strequal(lp_name(iService), name))