1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
6 * Copyright (C) 2001 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 NULL
, /* hosts allow */
159 NULL
, /* hosts deny */
160 NULL
, /* auth users */
161 NULL
, /* secrets file */
162 True
, /* strict modes */
164 NULL
, /* exclude from */
166 NULL
, /* include from */
167 "%o %h [%a] %m (%u) %f %l", /* log format */
168 NULL
, /* refuse options */
169 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
171 0, /* max connections */
172 False
/* ignore nonreadable */
177 /* local variables */
178 static service
**ServicePtrs
= NULL
;
179 static int iNumServices
= 0;
180 static int iServiceIndex
= 0;
181 static BOOL bInGlobalSection
= True
;
183 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
185 static struct enum_list enum_facilities
[] = {
187 { LOG_AUTH
, "auth" },
190 { LOG_AUTHPRIV
, "authpriv" },
193 { LOG_CRON
, "cron" },
196 { LOG_DAEMON
, "daemon" },
202 { LOG_KERN
, "kern" },
208 { LOG_MAIL
, "mail" },
211 { LOG_NEWS
, "news" },
214 { LOG_AUTH
, "security" },
217 { LOG_SYSLOG
, "syslog" },
220 { LOG_USER
, "user" },
223 { LOG_UUCP
, "uucp" },
226 { LOG_LOCAL0
, "local0" },
229 { LOG_LOCAL1
, "local1" },
232 { LOG_LOCAL2
, "local2" },
235 { LOG_LOCAL3
, "local3" },
238 { LOG_LOCAL4
, "local4" },
241 { LOG_LOCAL5
, "local5" },
244 { LOG_LOCAL6
, "local6" },
247 { LOG_LOCAL7
, "local7" },
252 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
253 static struct parm_struct parm_table
[] =
255 {"motd file", P_STRING
, P_GLOBAL
, &Globals
.motd_file
, NULL
, 0},
256 {"syslog facility", P_ENUM
, P_GLOBAL
, &Globals
.syslog_facility
, enum_facilities
,0},
257 {"socket options", P_STRING
, P_GLOBAL
, &Globals
.socket_options
,NULL
, 0},
258 {"log file", P_STRING
, P_GLOBAL
, &Globals
.log_file
, NULL
, 0},
259 {"pid file", P_STRING
, P_GLOBAL
, &Globals
.pid_file
, NULL
, 0},
261 {"timeout", P_INTEGER
, P_LOCAL
, &sDefault
.timeout
, NULL
, 0},
262 {"max connections", P_INTEGER
, P_LOCAL
, &sDefault
.max_connections
,NULL
, 0},
263 {"name", P_STRING
, P_LOCAL
, &sDefault
.name
, NULL
, 0},
264 {"comment", P_STRING
, P_LOCAL
, &sDefault
.comment
, NULL
, 0},
265 {"lock file", P_STRING
, P_LOCAL
, &sDefault
.lock_file
, NULL
, 0},
266 {"path", P_STRING
, P_LOCAL
, &sDefault
.path
, NULL
, 0},
267 {"read only", P_BOOL
, P_LOCAL
, &sDefault
.read_only
, NULL
, 0},
268 {"list", P_BOOL
, P_LOCAL
, &sDefault
.list
, NULL
, 0},
269 {"use chroot", P_BOOL
, P_LOCAL
, &sDefault
.use_chroot
, NULL
, 0},
270 {"ignore nonreadable",P_BOOL
, P_LOCAL
, &sDefault
.ignore_nonreadable
, NULL
, 0},
271 {"uid", P_STRING
, P_LOCAL
, &sDefault
.uid
, NULL
, 0},
272 {"gid", P_STRING
, P_LOCAL
, &sDefault
.gid
, NULL
, 0},
273 {"hosts allow", P_STRING
, P_LOCAL
, &sDefault
.hosts_allow
, NULL
, 0},
274 {"hosts deny", P_STRING
, P_LOCAL
, &sDefault
.hosts_deny
, NULL
, 0},
275 {"auth users", P_STRING
, P_LOCAL
, &sDefault
.auth_users
, NULL
, 0},
276 {"secrets file", P_STRING
, P_LOCAL
, &sDefault
.secrets_file
,NULL
, 0},
277 {"strict modes", P_BOOL
, P_LOCAL
, &sDefault
.strict_modes
,NULL
, 0},
278 {"exclude", P_STRING
, P_LOCAL
, &sDefault
.exclude
, NULL
, 0},
279 {"exclude from", P_STRING
, P_LOCAL
, &sDefault
.exclude_from
,NULL
, 0},
280 {"include", P_STRING
, P_LOCAL
, &sDefault
.include
, NULL
, 0},
281 {"include from", P_STRING
, P_LOCAL
, &sDefault
.include_from
,NULL
, 0},
282 {"transfer logging", P_BOOL
, P_LOCAL
, &sDefault
.transfer_logging
,NULL
,0},
283 {"ignore errors", P_BOOL
, P_LOCAL
, &sDefault
.ignore_errors
,NULL
,0},
284 {"log format", P_STRING
, P_LOCAL
, &sDefault
.log_format
, NULL
, 0},
285 {"refuse options", P_STRING
, P_LOCAL
, &sDefault
.refuse_options
,NULL
, 0},
286 {"dont compress", P_STRING
, P_LOCAL
, &sDefault
.dont_compress
,NULL
, 0},
287 {NULL
, P_BOOL
, P_NONE
, NULL
, NULL
, 0}
291 /***************************************************************************
292 Initialise the global parameter structure.
293 ***************************************************************************/
294 static void init_globals(void)
296 memset(&Globals
, 0, sizeof(Globals
));
298 Globals
.syslog_facility
= LOG_DAEMON
;
302 /***************************************************************************
303 Initialise the sDefault parameter structure.
304 ***************************************************************************/
305 static void init_locals(void)
311 In this section all the functions that are used to access the
312 parameters from the rest of the program are defined
315 #define FN_GLOBAL_STRING(fn_name,ptr) \
316 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
317 #define FN_GLOBAL_BOOL(fn_name,ptr) \
318 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
319 #define FN_GLOBAL_CHAR(fn_name,ptr) \
320 char fn_name(void) {return(*(char *)(ptr));}
321 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
322 int fn_name(void) {return(*(int *)(ptr));}
324 #define FN_LOCAL_STRING(fn_name,val) \
325 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
326 #define FN_LOCAL_BOOL(fn_name,val) \
327 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
328 #define FN_LOCAL_CHAR(fn_name,val) \
329 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
330 #define FN_LOCAL_INTEGER(fn_name,val) \
331 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
334 FN_GLOBAL_STRING(lp_motd_file
, &Globals
.motd_file
)
335 FN_GLOBAL_STRING(lp_log_file
, &Globals
.log_file
)
336 FN_GLOBAL_STRING(lp_pid_file
, &Globals
.pid_file
)
337 FN_GLOBAL_STRING(lp_socket_options
, &Globals
.socket_options
)
338 FN_GLOBAL_INTEGER(lp_syslog_facility
, &Globals
.syslog_facility
)
340 FN_LOCAL_STRING(lp_name
, name
)
341 FN_LOCAL_STRING(lp_comment
, comment
)
342 FN_LOCAL_STRING(lp_path
, path
)
343 FN_LOCAL_STRING(lp_lock_file
, lock_file
)
344 FN_LOCAL_BOOL(lp_read_only
, read_only
)
345 FN_LOCAL_BOOL(lp_list
, list
)
346 FN_LOCAL_BOOL(lp_use_chroot
, use_chroot
)
347 FN_LOCAL_BOOL(lp_transfer_logging
, transfer_logging
)
348 FN_LOCAL_BOOL(lp_ignore_errors
, ignore_errors
)
349 FN_LOCAL_BOOL(lp_ignore_nonreadable
, ignore_nonreadable
)
350 FN_LOCAL_STRING(lp_uid
, uid
)
351 FN_LOCAL_STRING(lp_gid
, gid
)
352 FN_LOCAL_STRING(lp_hosts_allow
, hosts_allow
)
353 FN_LOCAL_STRING(lp_hosts_deny
, hosts_deny
)
354 FN_LOCAL_STRING(lp_auth_users
, auth_users
)
355 FN_LOCAL_STRING(lp_secrets_file
, secrets_file
)
356 FN_LOCAL_BOOL(lp_strict_modes
, strict_modes
)
357 FN_LOCAL_STRING(lp_exclude
, exclude
)
358 FN_LOCAL_STRING(lp_exclude_from
, exclude_from
)
359 FN_LOCAL_STRING(lp_include
, include
)
360 FN_LOCAL_STRING(lp_include_from
, include_from
)
361 FN_LOCAL_STRING(lp_log_format
, log_format
)
362 FN_LOCAL_STRING(lp_refuse_options
, refuse_options
)
363 FN_LOCAL_STRING(lp_dont_compress
, dont_compress
)
364 FN_LOCAL_INTEGER(lp_timeout
, timeout
)
365 FN_LOCAL_INTEGER(lp_max_connections
, max_connections
)
367 /* local prototypes */
368 static int strwicmp( char *psz1
, char *psz2
);
369 static int map_parameter( char *parmname
);
370 static BOOL
set_boolean( BOOL
*pb
, char *parmvalue
);
371 static int getservicebyname(char *name
, service
*pserviceDest
);
372 static void copy_service( service
*pserviceDest
,
373 service
*pserviceSource
);
374 static BOOL
do_parameter(char *parmname
, char *parmvalue
);
375 static BOOL
do_section(char *sectionname
);
378 /***************************************************************************
379 initialise a service to the defaults
380 ***************************************************************************/
381 static void init_service(service
*pservice
)
383 memset((char *)pservice
,0,sizeof(service
));
384 copy_service(pservice
,&sDefault
);
389 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
390 * be initialized when this is called, either to NULL or a malloc'd
393 * @fixme There is a small leak here in that sometimes the existing
394 * value will be dynamically allocated, and the old copy is lost.
395 * However, we can't always deallocate the old value, because in the
396 * case of sDefault, it points to a static string. It would be nice
397 * to have either all-strdup'd values, or to never need to free
400 static void string_set(char **s
, const char *v
)
408 exit_cleanup(RERR_MALLOC
);
412 /***************************************************************************
413 add a new service to the services array initialising it with the given
415 ***************************************************************************/
416 static int add_a_service(service
*pservice
, char *name
)
420 int num_to_alloc
= iNumServices
+1;
422 tservice
= *pservice
;
424 /* it might already exist */
427 i
= getservicebyname(name
,NULL
);
434 ServicePtrs
= (service
**)Realloc(ServicePtrs
,sizeof(service
*)*num_to_alloc
);
437 pSERVICE(iNumServices
) = (service
*)malloc(sizeof(service
));
439 if (!ServicePtrs
|| !pSERVICE(iNumServices
))
444 init_service(pSERVICE(i
));
445 copy_service(pSERVICE(i
),&tservice
);
447 string_set(&iSERVICE(i
).name
,name
);
452 /***************************************************************************
453 Do a case-insensitive, whitespace-ignoring string compare.
454 ***************************************************************************/
455 static int strwicmp(char *psz1
, char *psz2
)
457 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
458 /* appropriate value. */
468 /* sync the strings on first non-whitespace */
471 while (isspace(*psz1
))
473 while (isspace(*psz2
))
475 if (toupper(*psz1
) != toupper(*psz2
) || *psz1
== '\0' || *psz2
== '\0')
480 return (*psz1
- *psz2
);
483 /***************************************************************************
484 Map a parameter's string representation to something we can use.
485 Returns False if the parameter string is not recognised, else TRUE.
486 ***************************************************************************/
487 static int map_parameter(char *parmname
)
491 if (*parmname
== '-')
494 for (iIndex
= 0; parm_table
[iIndex
].label
; iIndex
++)
495 if (strwicmp(parm_table
[iIndex
].label
, parmname
) == 0)
498 rprintf(FERROR
, "Unknown Parameter encountered: \"%s\"\n", parmname
);
503 /***************************************************************************
504 Set a boolean variable from the text value stored in the passed string.
505 Returns True in success, False if the passed string does not correctly
507 ***************************************************************************/
508 static BOOL
set_boolean(BOOL
*pb
, char *parmvalue
)
513 if (strwicmp(parmvalue
, "yes") == 0 ||
514 strwicmp(parmvalue
, "true") == 0 ||
515 strwicmp(parmvalue
, "1") == 0)
518 if (strwicmp(parmvalue
, "no") == 0 ||
519 strwicmp(parmvalue
, "False") == 0 ||
520 strwicmp(parmvalue
, "0") == 0)
524 rprintf(FERROR
, "Badly formed boolean in configuration file: \"%s\".\n",
531 /***************************************************************************
532 Find a service by name. Otherwise works like get_service.
533 ***************************************************************************/
534 static int getservicebyname(char *name
, service
*pserviceDest
)
538 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
539 if (strwicmp(iSERVICE(iService
).name
, name
) == 0)
541 if (pserviceDest
!= NULL
)
542 copy_service(pserviceDest
, pSERVICE(iService
));
551 /***************************************************************************
552 Copy a service structure to another
554 ***************************************************************************/
555 static void copy_service(service
*pserviceDest
,
556 service
*pserviceSource
)
560 for (i
=0;parm_table
[i
].label
;i
++)
561 if (parm_table
[i
].ptr
&& parm_table
[i
].class == P_LOCAL
) {
562 void *def_ptr
= parm_table
[i
].ptr
;
564 ((char *)pserviceSource
) + PTR_DIFF(def_ptr
,&sDefault
);
566 ((char *)pserviceDest
) + PTR_DIFF(def_ptr
,&sDefault
);
568 switch (parm_table
[i
].type
)
572 *(BOOL
*)dest_ptr
= *(BOOL
*)src_ptr
;
578 *(int *)dest_ptr
= *(int *)src_ptr
;
582 *(char *)dest_ptr
= *(char *)src_ptr
;
586 string_set(dest_ptr
,*(char **)src_ptr
);
596 /***************************************************************************
597 Process a parameter for a particular service number. If snum < 0
598 then assume we are in the globals
599 ***************************************************************************/
600 static BOOL
lp_do_parameter(int snum
, char *parmname
, char *parmvalue
)
603 void *parm_ptr
=NULL
; /* where we are going to store the result */
606 parmnum
= map_parameter(parmname
);
610 rprintf(FERROR
, "IGNORING unknown parameter \"%s\"\n", parmname
);
614 def_ptr
= parm_table
[parmnum
].ptr
;
616 /* we might point at a service, the default service or a global */
620 if (parm_table
[parmnum
].class == P_GLOBAL
) {
621 rprintf(FERROR
, "Global parameter %s found in service section!\n",parmname
);
624 parm_ptr
= ((char *)pSERVICE(snum
)) + PTR_DIFF(def_ptr
,&sDefault
);
627 /* now switch on the type of variable it is */
628 switch (parm_table
[parmnum
].type
)
631 set_boolean(parm_ptr
,parmvalue
);
635 set_boolean(parm_ptr
,parmvalue
);
636 *(BOOL
*)parm_ptr
= ! *(BOOL
*)parm_ptr
;
640 *(int *)parm_ptr
= atoi(parmvalue
);
644 *(char *)parm_ptr
= *parmvalue
;
648 sscanf(parmvalue
,"%o",(int *)parm_ptr
);
652 string_set(parm_ptr
,parmvalue
);
656 strlcpy((char *)parm_ptr
,parmvalue
,sizeof(pstring
));
660 for (i
=0;parm_table
[parmnum
].enum_list
[i
].name
;i
++) {
661 if (strequal(parmvalue
, parm_table
[parmnum
].enum_list
[i
].name
)) {
662 *(int *)parm_ptr
= parm_table
[parmnum
].enum_list
[i
].value
;
666 if (!parm_table
[parmnum
].enum_list
[i
].name
) {
667 if (atoi(parmvalue
) > 0)
668 *(int *)parm_ptr
= atoi(parmvalue
);
678 /***************************************************************************
680 ***************************************************************************/
681 static BOOL
do_parameter(char *parmname
, char *parmvalue
)
683 return lp_do_parameter(bInGlobalSection
?-2:iServiceIndex
, parmname
, parmvalue
);
686 /***************************************************************************
687 Process a new section (service). At this stage all sections are services.
688 Later we'll have special sections that permit server parameters to be set.
689 Returns True on success, False on failure.
690 ***************************************************************************/
691 static BOOL
do_section(char *sectionname
)
694 BOOL isglobal
= (strwicmp(sectionname
, GLOBAL_NAME
) == 0);
697 /* if we were in a global section then do the local inits */
698 if (bInGlobalSection
&& !isglobal
)
701 /* if we've just struck a global section, note the fact. */
702 bInGlobalSection
= isglobal
;
704 /* check for multiple global sections */
705 if (bInGlobalSection
)
710 /* if we have a current service, tidy it up before moving on */
713 if (iServiceIndex
>= 0)
716 /* if all is still well, move to the next record in the services array */
719 /* We put this here to avoid an odd message order if messages are */
720 /* issued by the post-processing of a previous section. */
722 if ((iServiceIndex
=add_a_service(&sDefault
,sectionname
)) < 0)
724 rprintf(FERROR
,"Failed to add a new service\n");
733 /***************************************************************************
734 Load the services array from the services file. Return True on success,
736 ***************************************************************************/
737 BOOL
lp_load(char *pszFname
, int globals_only
)
744 bInGlobalSection
= True
;
748 pstrcpy(n2
,pszFname
);
750 /* We get sections first, so have to start 'behind' to make up */
752 bRetval
= pm_process(n2
, globals_only
?NULL
:do_section
, do_parameter
);
758 /***************************************************************************
759 return the max number of services
760 ***************************************************************************/
761 int lp_numservices(void)
763 return(iNumServices
);
766 /***************************************************************************
767 Return the number of the service with the given name, or -1 if it doesn't
768 exist. Note that this is a DIFFERENT ANIMAL from the internal function
769 getservicebyname()! This works ONLY if all services have been loaded, and
770 does not copy the found service.
771 ***************************************************************************/
772 int lp_number(char *name
)
776 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
777 if (strequal(lp_name(iService
), name
))