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
50 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
51 #define strequal(a,b) (strcasecmp(a,b)==0)
52 #define BOOLSTR(b) ((b) ? "Yes" : "No")
53 typedef char pstring[1024];
54 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
56 /* the following are used by loadparm for option lists */
59 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
60 P_STRING,P_GSTRING,P_ENUM,P_SEP
65 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
79 struct enum_list *enum_list;
83 static BOOL bLoaded = False;
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;
134 char *refuse_options;
141 /* This is a default service used to prime a services structure */
142 static service sDefault =
147 DEFAULT_LOCK_FILE, /* lock file */
148 True, /* read only */
150 True, /* use chroot */
151 False, /* transfer logging */
154 NULL, /* hosts allow */
155 NULL, /* hosts deny */
156 NULL, /* auth users */
157 NULL, /* secrets file */
159 NULL, /* exclude from */
161 NULL, /* include from */
162 "%o %h [%a] %m (%u) %f %l", /* log format */
163 NULL, /* refuse options */
164 "*.gz *.tgz *.zip *.z *.rpm *.deb", /* dont compress */
166 0 /* max connections */
171 /* local variables */
172 static service **ServicePtrs = NULL;
173 static int iNumServices = 0;
174 static int iServiceIndex = 0;
175 static BOOL bInGlobalSection = True;
177 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
179 static struct enum_list enum_facilities[] = {
181 { LOG_AUTH, "auth" },
184 { LOG_AUTHPRIV, "authpriv" },
187 { LOG_CRON, "cron" },
190 { LOG_DAEMON, "daemon" },
196 { LOG_KERN, "kern" },
202 { LOG_MAIL, "mail" },
205 { LOG_NEWS, "news" },
208 { LOG_AUTH, "security" },
211 { LOG_SYSLOG, "syslog" },
214 { LOG_USER, "user" },
217 { LOG_UUCP, "uucp" },
220 { LOG_LOCAL0, "local0" },
223 { LOG_LOCAL1, "local1" },
226 { LOG_LOCAL2, "local2" },
229 { LOG_LOCAL3, "local3" },
232 { LOG_LOCAL4, "local4" },
235 { LOG_LOCAL5, "local5" },
238 { LOG_LOCAL6, "local6" },
241 { LOG_LOCAL7, "local7" },
246 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
247 static struct parm_struct parm_table[] =
249 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
250 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
251 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
252 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
253 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
255 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
256 {"max connections", P_INTEGER, P_LOCAL, &sDefault.max_connections,NULL, 0},
257 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
258 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
259 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL, 0},
260 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
261 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
262 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
263 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
264 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
265 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
266 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
267 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
268 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
269 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,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_STRING(lp_exclude, exclude)
346 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
347 FN_LOCAL_STRING(lp_include, include)
348 FN_LOCAL_STRING(lp_include_from, include_from)
349 FN_LOCAL_STRING(lp_log_format, log_format)
350 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
351 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
352 FN_LOCAL_INTEGER(lp_timeout, timeout)
353 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
355 /* local prototypes */
356 static int strwicmp( char *psz1, char *psz2 );
357 static int map_parameter( char *parmname);
358 static BOOL set_boolean( BOOL *pb, char *parmvalue );
359 static int getservicebyname(char *name, service *pserviceDest);
360 static void copy_service( service *pserviceDest,
361 service *pserviceSource);
362 static BOOL do_parameter(char *parmname, char *parmvalue);
363 static BOOL do_section(char *sectionname);
366 /***************************************************************************
367 initialise a service to the defaults
368 ***************************************************************************/
369 static void init_service(service *pservice)
371 memset((char *)pservice,0,sizeof(service));
372 copy_service(pservice,&sDefault);
375 static void string_set(char **s, char *v)
382 if (!*s) exit_cleanup(RERR_MALLOC);
386 /***************************************************************************
387 add a new service to the services array initialising it with the given
389 ***************************************************************************/
390 static int add_a_service(service *pservice, char *name)
394 int num_to_alloc = iNumServices+1;
396 tservice = *pservice;
398 /* it might already exist */
401 i = getservicebyname(name,NULL);
408 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
411 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
413 if (!ServicePtrs || !pSERVICE(iNumServices))
418 init_service(pSERVICE(i));
419 copy_service(pSERVICE(i),&tservice);
421 string_set(&iSERVICE(i).name,name);
426 /***************************************************************************
427 Do a case-insensitive, whitespace-ignoring string compare.
428 ***************************************************************************/
429 static int strwicmp(char *psz1, char *psz2)
431 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
432 /* appropriate value. */
442 /* sync the strings on first non-whitespace */
445 while (isspace(*psz1))
447 while (isspace(*psz2))
449 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
454 return (*psz1 - *psz2);
457 /***************************************************************************
458 Map a parameter's string representation to something we can use.
459 Returns False if the parameter string is not recognised, else TRUE.
460 ***************************************************************************/
461 static int map_parameter(char *parmname)
465 if (*parmname == '-')
468 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
469 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
472 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
477 /***************************************************************************
478 Set a boolean variable from the text value stored in the passed string.
479 Returns True in success, False if the passed string does not correctly
481 ***************************************************************************/
482 static BOOL set_boolean(BOOL *pb, char *parmvalue)
487 if (strwicmp(parmvalue, "yes") == 0 ||
488 strwicmp(parmvalue, "true") == 0 ||
489 strwicmp(parmvalue, "1") == 0)
492 if (strwicmp(parmvalue, "no") == 0 ||
493 strwicmp(parmvalue, "False") == 0 ||
494 strwicmp(parmvalue, "0") == 0)
498 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
505 /***************************************************************************
506 Find a service by name. Otherwise works like get_service.
507 ***************************************************************************/
508 static int getservicebyname(char *name, service *pserviceDest)
512 for (iService = iNumServices - 1; iService >= 0; iService--)
513 if (strwicmp(iSERVICE(iService).name, name) == 0)
515 if (pserviceDest != NULL)
516 copy_service(pserviceDest, pSERVICE(iService));
525 /***************************************************************************
526 Copy a service structure to another
528 ***************************************************************************/
529 static void copy_service(service *pserviceDest,
530 service *pserviceSource)
534 for (i=0;parm_table[i].label;i++)
535 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
536 void *def_ptr = parm_table[i].ptr;
538 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
540 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
542 switch (parm_table[i].type)
546 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
552 *(int *)dest_ptr = *(int *)src_ptr;
556 *(char *)dest_ptr = *(char *)src_ptr;
560 string_set(dest_ptr,*(char **)src_ptr);
570 /***************************************************************************
571 Process a parameter for a particular service number. If snum < 0
572 then assume we are in the globals
573 ***************************************************************************/
574 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
577 void *parm_ptr=NULL; /* where we are going to store the result */
580 parmnum = map_parameter(parmname);
584 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
588 def_ptr = parm_table[parmnum].ptr;
590 /* we might point at a service, the default service or a global */
594 if (parm_table[parmnum].class == P_GLOBAL) {
595 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
598 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
601 /* now switch on the type of variable it is */
602 switch (parm_table[parmnum].type)
605 set_boolean(parm_ptr,parmvalue);
609 set_boolean(parm_ptr,parmvalue);
610 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
614 *(int *)parm_ptr = atoi(parmvalue);
618 *(char *)parm_ptr = *parmvalue;
622 sscanf(parmvalue,"%o",(int *)parm_ptr);
626 string_set(parm_ptr,parmvalue);
630 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
634 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
635 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
636 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
640 if (!parm_table[parmnum].enum_list[i].name) {
641 if (atoi(parmvalue) > 0)
642 *(int *)parm_ptr = atoi(parmvalue);
652 /***************************************************************************
654 ***************************************************************************/
655 static BOOL do_parameter(char *parmname, char *parmvalue)
657 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
660 /***************************************************************************
661 Process a new section (service). At this stage all sections are services.
662 Later we'll have special sections that permit server parameters to be set.
663 Returns True on success, False on failure.
664 ***************************************************************************/
665 static BOOL do_section(char *sectionname)
668 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
671 /* if we were in a global section then do the local inits */
672 if (bInGlobalSection && !isglobal)
675 /* if we've just struck a global section, note the fact. */
676 bInGlobalSection = isglobal;
678 /* check for multiple global sections */
679 if (bInGlobalSection)
684 /* if we have a current service, tidy it up before moving on */
687 if (iServiceIndex >= 0)
690 /* if all is still well, move to the next record in the services array */
693 /* We put this here to avoid an odd message order if messages are */
694 /* issued by the post-processing of a previous section. */
696 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
698 rprintf(FERROR,"Failed to add a new service\n");
707 /***************************************************************************
708 Load the services array from the services file. Return True on success,
710 ***************************************************************************/
711 BOOL lp_load(char *pszFname, int globals_only)
718 bInGlobalSection = True;
722 pstrcpy(n2,pszFname);
724 /* We get sections first, so have to start 'behind' to make up */
726 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
734 /***************************************************************************
735 return the max number of services
736 ***************************************************************************/
737 int lp_numservices(void)
739 return(iNumServices);
742 /***************************************************************************
743 Return the number of the service with the given name, or -1 if it doesn't
744 exist. Note that this is a DIFFERENT ANIMAL from the internal function
745 getservicebyname()! This works ONLY if all services have been loaded, and
746 does not copy the found service.
747 ***************************************************************************/
748 int lp_number(char *name)
752 for (iService = iNumServices - 1; iService >= 0; iService--)
753 if (strequal(lp_name(iService), name))