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
;
133 char *refuse_options
;
137 BOOL ignore_nonreadable
;
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 */
152 False
, /* ignore errors */
155 NULL
, /* hosts allow */
156 NULL
, /* hosts deny */
157 NULL
, /* auth users */
158 NULL
, /* secrets file */
159 True
, /* strict modes */
161 NULL
, /* exclude from */
163 NULL
, /* include from */
164 "%o %h [%a] %m (%u) %f %l", /* log format */
165 NULL
, /* refuse options */
166 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
168 0, /* max connections */
169 False
/* ignore nonreadable */
174 /* local variables */
175 static service
**ServicePtrs
= NULL
;
176 static int iNumServices
= 0;
177 static int iServiceIndex
= 0;
178 static BOOL bInGlobalSection
= True
;
180 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
182 static struct enum_list enum_facilities
[] = {
184 { LOG_AUTH
, "auth" },
187 { LOG_AUTHPRIV
, "authpriv" },
190 { LOG_CRON
, "cron" },
193 { LOG_DAEMON
, "daemon" },
199 { LOG_KERN
, "kern" },
205 { LOG_MAIL
, "mail" },
208 { LOG_NEWS
, "news" },
211 { LOG_AUTH
, "security" },
214 { LOG_SYSLOG
, "syslog" },
217 { LOG_USER
, "user" },
220 { LOG_UUCP
, "uucp" },
223 { LOG_LOCAL0
, "local0" },
226 { LOG_LOCAL1
, "local1" },
229 { LOG_LOCAL2
, "local2" },
232 { LOG_LOCAL3
, "local3" },
235 { LOG_LOCAL4
, "local4" },
238 { LOG_LOCAL5
, "local5" },
241 { LOG_LOCAL6
, "local6" },
244 { LOG_LOCAL7
, "local7" },
249 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
250 static struct parm_struct parm_table
[] =
252 {"motd file", P_STRING
, P_GLOBAL
, &Globals
.motd_file
, NULL
, 0},
253 {"syslog facility", P_ENUM
, P_GLOBAL
, &Globals
.syslog_facility
, enum_facilities
,0},
254 {"socket options", P_STRING
, P_GLOBAL
, &Globals
.socket_options
,NULL
, 0},
255 {"log file", P_STRING
, P_GLOBAL
, &Globals
.log_file
, NULL
, 0},
256 {"pid file", P_STRING
, P_GLOBAL
, &Globals
.pid_file
, NULL
, 0},
258 {"timeout", P_INTEGER
, P_LOCAL
, &sDefault
.timeout
, NULL
, 0},
259 {"max connections", P_INTEGER
, P_LOCAL
, &sDefault
.max_connections
,NULL
, 0},
260 {"name", P_STRING
, P_LOCAL
, &sDefault
.name
, NULL
, 0},
261 {"comment", P_STRING
, P_LOCAL
, &sDefault
.comment
, NULL
, 0},
262 {"lock file", P_STRING
, P_LOCAL
, &sDefault
.lock_file
, NULL
, 0},
263 {"path", P_STRING
, P_LOCAL
, &sDefault
.path
, NULL
, 0},
264 {"read only", P_BOOL
, P_LOCAL
, &sDefault
.read_only
, NULL
, 0},
265 {"list", P_BOOL
, P_LOCAL
, &sDefault
.list
, NULL
, 0},
266 {"use chroot", P_BOOL
, P_LOCAL
, &sDefault
.use_chroot
, NULL
, 0},
267 {"ignore nonreadable",P_BOOL
, P_LOCAL
, &sDefault
.ignore_nonreadable
, NULL
, 0},
268 {"uid", P_STRING
, P_LOCAL
, &sDefault
.uid
, NULL
, 0},
269 {"gid", P_STRING
, P_LOCAL
, &sDefault
.gid
, NULL
, 0},
270 {"hosts allow", P_STRING
, P_LOCAL
, &sDefault
.hosts_allow
, NULL
, 0},
271 {"hosts deny", P_STRING
, P_LOCAL
, &sDefault
.hosts_deny
, NULL
, 0},
272 {"auth users", P_STRING
, P_LOCAL
, &sDefault
.auth_users
, NULL
, 0},
273 {"secrets file", P_STRING
, P_LOCAL
, &sDefault
.secrets_file
,NULL
, 0},
274 {"strict modes", P_BOOL
, P_LOCAL
, &sDefault
.strict_modes
,NULL
, 0},
275 {"exclude", P_STRING
, P_LOCAL
, &sDefault
.exclude
, NULL
, 0},
276 {"exclude from", P_STRING
, P_LOCAL
, &sDefault
.exclude_from
,NULL
, 0},
277 {"include", P_STRING
, P_LOCAL
, &sDefault
.include
, NULL
, 0},
278 {"include from", P_STRING
, P_LOCAL
, &sDefault
.include_from
,NULL
, 0},
279 {"transfer logging", P_BOOL
, P_LOCAL
, &sDefault
.transfer_logging
,NULL
,0},
280 {"ignore errors", P_BOOL
, P_LOCAL
, &sDefault
.ignore_errors
,NULL
,0},
281 {"log format", P_STRING
, P_LOCAL
, &sDefault
.log_format
, NULL
, 0},
282 {"refuse options", P_STRING
, P_LOCAL
, &sDefault
.refuse_options
,NULL
, 0},
283 {"dont compress", P_STRING
, P_LOCAL
, &sDefault
.dont_compress
,NULL
, 0},
284 {NULL
, P_BOOL
, P_NONE
, NULL
, NULL
, 0}
288 /***************************************************************************
289 Initialise the global parameter structure.
290 ***************************************************************************/
291 static void init_globals(void)
293 memset(&Globals
, 0, sizeof(Globals
));
295 Globals
.syslog_facility
= LOG_DAEMON
;
299 /***************************************************************************
300 Initialise the sDefault parameter structure.
301 ***************************************************************************/
302 static void init_locals(void)
308 In this section all the functions that are used to access the
309 parameters from the rest of the program are defined
312 #define FN_GLOBAL_STRING(fn_name,ptr) \
313 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
314 #define FN_GLOBAL_BOOL(fn_name,ptr) \
315 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
316 #define FN_GLOBAL_CHAR(fn_name,ptr) \
317 char fn_name(void) {return(*(char *)(ptr));}
318 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
319 int fn_name(void) {return(*(int *)(ptr));}
321 #define FN_LOCAL_STRING(fn_name,val) \
322 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
323 #define FN_LOCAL_BOOL(fn_name,val) \
324 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
325 #define FN_LOCAL_CHAR(fn_name,val) \
326 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
327 #define FN_LOCAL_INTEGER(fn_name,val) \
328 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
331 FN_GLOBAL_STRING(lp_motd_file
, &Globals
.motd_file
)
332 FN_GLOBAL_STRING(lp_log_file
, &Globals
.log_file
)
333 FN_GLOBAL_STRING(lp_pid_file
, &Globals
.pid_file
)
334 FN_GLOBAL_STRING(lp_socket_options
, &Globals
.socket_options
)
335 FN_GLOBAL_INTEGER(lp_syslog_facility
, &Globals
.syslog_facility
)
337 FN_LOCAL_STRING(lp_name
, name
)
338 FN_LOCAL_STRING(lp_comment
, comment
)
339 FN_LOCAL_STRING(lp_path
, path
)
340 FN_LOCAL_STRING(lp_lock_file
, lock_file
)
341 FN_LOCAL_BOOL(lp_read_only
, read_only
)
342 FN_LOCAL_BOOL(lp_list
, list
)
343 FN_LOCAL_BOOL(lp_use_chroot
, use_chroot
)
344 FN_LOCAL_BOOL(lp_transfer_logging
, transfer_logging
)
345 FN_LOCAL_BOOL(lp_ignore_errors
, ignore_errors
)
346 FN_LOCAL_BOOL(lp_ignore_nonreadable
, ignore_nonreadable
)
347 FN_LOCAL_STRING(lp_uid
, uid
)
348 FN_LOCAL_STRING(lp_gid
, gid
)
349 FN_LOCAL_STRING(lp_hosts_allow
, hosts_allow
)
350 FN_LOCAL_STRING(lp_hosts_deny
, hosts_deny
)
351 FN_LOCAL_STRING(lp_auth_users
, auth_users
)
352 FN_LOCAL_STRING(lp_secrets_file
, secrets_file
)
353 FN_LOCAL_BOOL(lp_strict_modes
, strict_modes
)
354 FN_LOCAL_STRING(lp_exclude
, exclude
)
355 FN_LOCAL_STRING(lp_exclude_from
, exclude_from
)
356 FN_LOCAL_STRING(lp_include
, include
)
357 FN_LOCAL_STRING(lp_include_from
, include_from
)
358 FN_LOCAL_STRING(lp_log_format
, log_format
)
359 FN_LOCAL_STRING(lp_refuse_options
, refuse_options
)
360 FN_LOCAL_STRING(lp_dont_compress
, dont_compress
)
361 FN_LOCAL_INTEGER(lp_timeout
, timeout
)
362 FN_LOCAL_INTEGER(lp_max_connections
, max_connections
)
364 /* local prototypes */
365 static int strwicmp( char *psz1
, char *psz2
);
366 static int map_parameter( char *parmname
);
367 static BOOL
set_boolean( BOOL
*pb
, char *parmvalue
);
368 static int getservicebyname(char *name
, service
*pserviceDest
);
369 static void copy_service( service
*pserviceDest
,
370 service
*pserviceSource
);
371 static BOOL
do_parameter(char *parmname
, char *parmvalue
);
372 static BOOL
do_section(char *sectionname
);
375 /***************************************************************************
376 initialise a service to the defaults
377 ***************************************************************************/
378 static void init_service(service
*pservice
)
380 memset((char *)pservice
,0,sizeof(service
));
381 copy_service(pservice
,&sDefault
);
384 static void string_set(char **s
, char *v
)
391 if (!*s
) exit_cleanup(RERR_MALLOC
);
395 /***************************************************************************
396 add a new service to the services array initialising it with the given
398 ***************************************************************************/
399 static int add_a_service(service
*pservice
, char *name
)
403 int num_to_alloc
= iNumServices
+1;
405 tservice
= *pservice
;
407 /* it might already exist */
410 i
= getservicebyname(name
,NULL
);
417 ServicePtrs
= (service
**)Realloc(ServicePtrs
,sizeof(service
*)*num_to_alloc
);
420 pSERVICE(iNumServices
) = (service
*)malloc(sizeof(service
));
422 if (!ServicePtrs
|| !pSERVICE(iNumServices
))
427 init_service(pSERVICE(i
));
428 copy_service(pSERVICE(i
),&tservice
);
430 string_set(&iSERVICE(i
).name
,name
);
435 /***************************************************************************
436 Do a case-insensitive, whitespace-ignoring string compare.
437 ***************************************************************************/
438 static int strwicmp(char *psz1
, char *psz2
)
440 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
441 /* appropriate value. */
451 /* sync the strings on first non-whitespace */
454 while (isspace(*psz1
))
456 while (isspace(*psz2
))
458 if (toupper(*psz1
) != toupper(*psz2
) || *psz1
== '\0' || *psz2
== '\0')
463 return (*psz1
- *psz2
);
466 /***************************************************************************
467 Map a parameter's string representation to something we can use.
468 Returns False if the parameter string is not recognised, else TRUE.
469 ***************************************************************************/
470 static int map_parameter(char *parmname
)
474 if (*parmname
== '-')
477 for (iIndex
= 0; parm_table
[iIndex
].label
; iIndex
++)
478 if (strwicmp(parm_table
[iIndex
].label
, parmname
) == 0)
481 rprintf(FERROR
, "Unknown Parameter encountered: \"%s\"\n", parmname
);
486 /***************************************************************************
487 Set a boolean variable from the text value stored in the passed string.
488 Returns True in success, False if the passed string does not correctly
490 ***************************************************************************/
491 static BOOL
set_boolean(BOOL
*pb
, char *parmvalue
)
496 if (strwicmp(parmvalue
, "yes") == 0 ||
497 strwicmp(parmvalue
, "true") == 0 ||
498 strwicmp(parmvalue
, "1") == 0)
501 if (strwicmp(parmvalue
, "no") == 0 ||
502 strwicmp(parmvalue
, "False") == 0 ||
503 strwicmp(parmvalue
, "0") == 0)
507 rprintf(FERROR
, "Badly formed boolean in configuration file: \"%s\".\n",
514 /***************************************************************************
515 Find a service by name. Otherwise works like get_service.
516 ***************************************************************************/
517 static int getservicebyname(char *name
, service
*pserviceDest
)
521 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
522 if (strwicmp(iSERVICE(iService
).name
, name
) == 0)
524 if (pserviceDest
!= NULL
)
525 copy_service(pserviceDest
, pSERVICE(iService
));
534 /***************************************************************************
535 Copy a service structure to another
537 ***************************************************************************/
538 static void copy_service(service
*pserviceDest
,
539 service
*pserviceSource
)
543 for (i
=0;parm_table
[i
].label
;i
++)
544 if (parm_table
[i
].ptr
&& parm_table
[i
].class == P_LOCAL
) {
545 void *def_ptr
= parm_table
[i
].ptr
;
547 ((char *)pserviceSource
) + PTR_DIFF(def_ptr
,&sDefault
);
549 ((char *)pserviceDest
) + PTR_DIFF(def_ptr
,&sDefault
);
551 switch (parm_table
[i
].type
)
555 *(BOOL
*)dest_ptr
= *(BOOL
*)src_ptr
;
561 *(int *)dest_ptr
= *(int *)src_ptr
;
565 *(char *)dest_ptr
= *(char *)src_ptr
;
569 string_set(dest_ptr
,*(char **)src_ptr
);
579 /***************************************************************************
580 Process a parameter for a particular service number. If snum < 0
581 then assume we are in the globals
582 ***************************************************************************/
583 static BOOL
lp_do_parameter(int snum
, char *parmname
, char *parmvalue
)
586 void *parm_ptr
=NULL
; /* where we are going to store the result */
589 parmnum
= map_parameter(parmname
);
593 rprintf(FERROR
, "IGNORING unknown parameter \"%s\"\n", parmname
);
597 def_ptr
= parm_table
[parmnum
].ptr
;
599 /* we might point at a service, the default service or a global */
603 if (parm_table
[parmnum
].class == P_GLOBAL
) {
604 rprintf(FERROR
, "Global parameter %s found in service section!\n",parmname
);
607 parm_ptr
= ((char *)pSERVICE(snum
)) + PTR_DIFF(def_ptr
,&sDefault
);
610 /* now switch on the type of variable it is */
611 switch (parm_table
[parmnum
].type
)
614 set_boolean(parm_ptr
,parmvalue
);
618 set_boolean(parm_ptr
,parmvalue
);
619 *(BOOL
*)parm_ptr
= ! *(BOOL
*)parm_ptr
;
623 *(int *)parm_ptr
= atoi(parmvalue
);
627 *(char *)parm_ptr
= *parmvalue
;
631 sscanf(parmvalue
,"%o",(int *)parm_ptr
);
635 string_set(parm_ptr
,parmvalue
);
639 strlcpy((char *)parm_ptr
,parmvalue
,sizeof(pstring
));
643 for (i
=0;parm_table
[parmnum
].enum_list
[i
].name
;i
++) {
644 if (strequal(parmvalue
, parm_table
[parmnum
].enum_list
[i
].name
)) {
645 *(int *)parm_ptr
= parm_table
[parmnum
].enum_list
[i
].value
;
649 if (!parm_table
[parmnum
].enum_list
[i
].name
) {
650 if (atoi(parmvalue
) > 0)
651 *(int *)parm_ptr
= atoi(parmvalue
);
661 /***************************************************************************
663 ***************************************************************************/
664 static BOOL
do_parameter(char *parmname
, char *parmvalue
)
666 return lp_do_parameter(bInGlobalSection
?-2:iServiceIndex
, parmname
, parmvalue
);
669 /***************************************************************************
670 Process a new section (service). At this stage all sections are services.
671 Later we'll have special sections that permit server parameters to be set.
672 Returns True on success, False on failure.
673 ***************************************************************************/
674 static BOOL
do_section(char *sectionname
)
677 BOOL isglobal
= (strwicmp(sectionname
, GLOBAL_NAME
) == 0);
680 /* if we were in a global section then do the local inits */
681 if (bInGlobalSection
&& !isglobal
)
684 /* if we've just struck a global section, note the fact. */
685 bInGlobalSection
= isglobal
;
687 /* check for multiple global sections */
688 if (bInGlobalSection
)
693 /* if we have a current service, tidy it up before moving on */
696 if (iServiceIndex
>= 0)
699 /* if all is still well, move to the next record in the services array */
702 /* We put this here to avoid an odd message order if messages are */
703 /* issued by the post-processing of a previous section. */
705 if ((iServiceIndex
=add_a_service(&sDefault
,sectionname
)) < 0)
707 rprintf(FERROR
,"Failed to add a new service\n");
716 /***************************************************************************
717 Load the services array from the services file. Return True on success,
719 ***************************************************************************/
720 BOOL
lp_load(char *pszFname
, int globals_only
)
727 bInGlobalSection
= True
;
731 pstrcpy(n2
,pszFname
);
733 /* We get sections first, so have to start 'behind' to make up */
735 bRetval
= pm_process(n2
, globals_only
?NULL
:do_section
, do_parameter
);
743 /***************************************************************************
744 return the max number of services
745 ***************************************************************************/
746 int lp_numservices(void)
748 return(iNumServices
);
751 /***************************************************************************
752 Return the number of the service with the given name, or -1 if it doesn't
753 exist. Note that this is a DIFFERENT ANIMAL from the internal function
754 getservicebyname()! This works ONLY if all services have been loaded, and
755 does not copy the found service.
756 ***************************************************************************/
757 int lp_number(char *name
)
761 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
762 if (strequal(lp_name(iService
), name
))