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
;
81 #define GLOBAL_NAME "global"
84 /* some helpful bits */
85 #define pSERVICE(i) ServicePtrs[i]
86 #define iSERVICE(i) (*pSERVICE(i))
87 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
90 * This structure describes global (ie., server-wide) parameters.
101 static global Globals
;
106 * This structure describes a single service.
117 BOOL transfer_logging
;
131 char *refuse_options
;
135 BOOL ignore_nonreadable
;
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 */
150 False
, /* ignore errors */
153 NULL
, /* hosts allow */
154 NULL
, /* hosts deny */
155 NULL
, /* auth users */
156 NULL
, /* secrets file */
157 True
, /* strict modes */
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 *.iso *.bz2 *.tbz", /* dont compress */
166 0, /* max connections */
167 False
/* ignore nonreadable */
172 /* local variables */
173 static service
**ServicePtrs
= NULL
;
174 static int iNumServices
= 0;
175 static int iServiceIndex
= 0;
176 static BOOL bInGlobalSection
= True
;
178 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
180 static struct enum_list enum_facilities
[] = {
182 { LOG_AUTH
, "auth" },
185 { LOG_AUTHPRIV
, "authpriv" },
188 { LOG_CRON
, "cron" },
191 { LOG_DAEMON
, "daemon" },
197 { LOG_KERN
, "kern" },
203 { LOG_MAIL
, "mail" },
206 { LOG_NEWS
, "news" },
209 { LOG_AUTH
, "security" },
212 { LOG_SYSLOG
, "syslog" },
215 { LOG_USER
, "user" },
218 { LOG_UUCP
, "uucp" },
221 { LOG_LOCAL0
, "local0" },
224 { LOG_LOCAL1
, "local1" },
227 { LOG_LOCAL2
, "local2" },
230 { LOG_LOCAL3
, "local3" },
233 { LOG_LOCAL4
, "local4" },
236 { LOG_LOCAL5
, "local5" },
239 { LOG_LOCAL6
, "local6" },
242 { LOG_LOCAL7
, "local7" },
247 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
248 static struct parm_struct parm_table
[] =
250 {"motd file", P_STRING
, P_GLOBAL
, &Globals
.motd_file
, NULL
, 0},
251 {"syslog facility", P_ENUM
, P_GLOBAL
, &Globals
.syslog_facility
, enum_facilities
,0},
252 {"socket options", P_STRING
, P_GLOBAL
, &Globals
.socket_options
,NULL
, 0},
253 {"log file", P_STRING
, P_GLOBAL
, &Globals
.log_file
, NULL
, 0},
254 {"pid file", P_STRING
, P_GLOBAL
, &Globals
.pid_file
, NULL
, 0},
256 {"timeout", P_INTEGER
, P_LOCAL
, &sDefault
.timeout
, NULL
, 0},
257 {"max connections", P_INTEGER
, P_LOCAL
, &sDefault
.max_connections
,NULL
, 0},
258 {"name", P_STRING
, P_LOCAL
, &sDefault
.name
, NULL
, 0},
259 {"comment", P_STRING
, P_LOCAL
, &sDefault
.comment
, NULL
, 0},
260 {"lock file", P_STRING
, P_LOCAL
, &sDefault
.lock_file
, NULL
, 0},
261 {"path", P_STRING
, P_LOCAL
, &sDefault
.path
, NULL
, 0},
262 {"read only", P_BOOL
, P_LOCAL
, &sDefault
.read_only
, NULL
, 0},
263 {"list", P_BOOL
, P_LOCAL
, &sDefault
.list
, NULL
, 0},
264 {"use chroot", P_BOOL
, P_LOCAL
, &sDefault
.use_chroot
, NULL
, 0},
265 {"ignore nonreadable",P_BOOL
, P_LOCAL
, &sDefault
.ignore_nonreadable
, NULL
, 0},
266 {"uid", P_STRING
, P_LOCAL
, &sDefault
.uid
, NULL
, 0},
267 {"gid", P_STRING
, P_LOCAL
, &sDefault
.gid
, NULL
, 0},
268 {"hosts allow", P_STRING
, P_LOCAL
, &sDefault
.hosts_allow
, NULL
, 0},
269 {"hosts deny", P_STRING
, P_LOCAL
, &sDefault
.hosts_deny
, NULL
, 0},
270 {"auth users", P_STRING
, P_LOCAL
, &sDefault
.auth_users
, NULL
, 0},
271 {"secrets file", P_STRING
, P_LOCAL
, &sDefault
.secrets_file
,NULL
, 0},
272 {"strict modes", P_BOOL
, P_LOCAL
, &sDefault
.strict_modes
,NULL
, 0},
273 {"exclude", P_STRING
, P_LOCAL
, &sDefault
.exclude
, NULL
, 0},
274 {"exclude from", P_STRING
, P_LOCAL
, &sDefault
.exclude_from
,NULL
, 0},
275 {"include", P_STRING
, P_LOCAL
, &sDefault
.include
, NULL
, 0},
276 {"include from", P_STRING
, P_LOCAL
, &sDefault
.include_from
,NULL
, 0},
277 {"transfer logging", P_BOOL
, P_LOCAL
, &sDefault
.transfer_logging
,NULL
,0},
278 {"ignore errors", P_BOOL
, P_LOCAL
, &sDefault
.ignore_errors
,NULL
,0},
279 {"log format", P_STRING
, P_LOCAL
, &sDefault
.log_format
, NULL
, 0},
280 {"refuse options", P_STRING
, P_LOCAL
, &sDefault
.refuse_options
,NULL
, 0},
281 {"dont compress", P_STRING
, P_LOCAL
, &sDefault
.dont_compress
,NULL
, 0},
282 {NULL
, P_BOOL
, P_NONE
, NULL
, NULL
, 0}
286 /***************************************************************************
287 Initialise the global parameter structure.
288 ***************************************************************************/
289 static void init_globals(void)
291 memset(&Globals
, 0, sizeof(Globals
));
293 Globals
.syslog_facility
= LOG_DAEMON
;
297 /***************************************************************************
298 Initialise the sDefault parameter structure.
299 ***************************************************************************/
300 static void init_locals(void)
306 In this section all the functions that are used to access the
307 parameters from the rest of the program are defined
310 #define FN_GLOBAL_STRING(fn_name,ptr) \
311 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
312 #define FN_GLOBAL_BOOL(fn_name,ptr) \
313 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
314 #define FN_GLOBAL_CHAR(fn_name,ptr) \
315 char fn_name(void) {return(*(char *)(ptr));}
316 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
317 int fn_name(void) {return(*(int *)(ptr));}
319 #define FN_LOCAL_STRING(fn_name,val) \
320 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
321 #define FN_LOCAL_BOOL(fn_name,val) \
322 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
323 #define FN_LOCAL_CHAR(fn_name,val) \
324 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
325 #define FN_LOCAL_INTEGER(fn_name,val) \
326 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
329 FN_GLOBAL_STRING(lp_motd_file
, &Globals
.motd_file
)
330 FN_GLOBAL_STRING(lp_log_file
, &Globals
.log_file
)
331 FN_GLOBAL_STRING(lp_pid_file
, &Globals
.pid_file
)
332 FN_GLOBAL_STRING(lp_socket_options
, &Globals
.socket_options
)
333 FN_GLOBAL_INTEGER(lp_syslog_facility
, &Globals
.syslog_facility
)
335 FN_LOCAL_STRING(lp_name
, name
)
336 FN_LOCAL_STRING(lp_comment
, comment
)
337 FN_LOCAL_STRING(lp_path
, path
)
338 FN_LOCAL_STRING(lp_lock_file
, lock_file
)
339 FN_LOCAL_BOOL(lp_read_only
, read_only
)
340 FN_LOCAL_BOOL(lp_list
, list
)
341 FN_LOCAL_BOOL(lp_use_chroot
, use_chroot
)
342 FN_LOCAL_BOOL(lp_transfer_logging
, transfer_logging
)
343 FN_LOCAL_BOOL(lp_ignore_errors
, ignore_errors
)
344 FN_LOCAL_BOOL(lp_ignore_nonreadable
, ignore_nonreadable
)
345 FN_LOCAL_STRING(lp_uid
, uid
)
346 FN_LOCAL_STRING(lp_gid
, gid
)
347 FN_LOCAL_STRING(lp_hosts_allow
, hosts_allow
)
348 FN_LOCAL_STRING(lp_hosts_deny
, hosts_deny
)
349 FN_LOCAL_STRING(lp_auth_users
, auth_users
)
350 FN_LOCAL_STRING(lp_secrets_file
, secrets_file
)
351 FN_LOCAL_BOOL(lp_strict_modes
, strict_modes
)
352 FN_LOCAL_STRING(lp_exclude
, exclude
)
353 FN_LOCAL_STRING(lp_exclude_from
, exclude_from
)
354 FN_LOCAL_STRING(lp_include
, include
)
355 FN_LOCAL_STRING(lp_include_from
, include_from
)
356 FN_LOCAL_STRING(lp_log_format
, log_format
)
357 FN_LOCAL_STRING(lp_refuse_options
, refuse_options
)
358 FN_LOCAL_STRING(lp_dont_compress
, dont_compress
)
359 FN_LOCAL_INTEGER(lp_timeout
, timeout
)
360 FN_LOCAL_INTEGER(lp_max_connections
, max_connections
)
362 /* local prototypes */
363 static int strwicmp( char *psz1
, char *psz2
);
364 static int map_parameter( char *parmname
);
365 static BOOL
set_boolean( BOOL
*pb
, char *parmvalue
);
366 static int getservicebyname(char *name
, service
*pserviceDest
);
367 static void copy_service( service
*pserviceDest
,
368 service
*pserviceSource
);
369 static BOOL
do_parameter(char *parmname
, char *parmvalue
);
370 static BOOL
do_section(char *sectionname
);
373 /***************************************************************************
374 initialise a service to the defaults
375 ***************************************************************************/
376 static void init_service(service
*pservice
)
378 memset((char *)pservice
,0,sizeof(service
));
379 copy_service(pservice
,&sDefault
);
382 static void string_set(char **s
, char *v
)
389 if (!*s
) exit_cleanup(RERR_MALLOC
);
393 /***************************************************************************
394 add a new service to the services array initialising it with the given
396 ***************************************************************************/
397 static int add_a_service(service
*pservice
, char *name
)
401 int num_to_alloc
= iNumServices
+1;
403 tservice
= *pservice
;
405 /* it might already exist */
408 i
= getservicebyname(name
,NULL
);
415 ServicePtrs
= (service
**)Realloc(ServicePtrs
,sizeof(service
*)*num_to_alloc
);
418 pSERVICE(iNumServices
) = (service
*)malloc(sizeof(service
));
420 if (!ServicePtrs
|| !pSERVICE(iNumServices
))
425 init_service(pSERVICE(i
));
426 copy_service(pSERVICE(i
),&tservice
);
428 string_set(&iSERVICE(i
).name
,name
);
433 /***************************************************************************
434 Do a case-insensitive, whitespace-ignoring string compare.
435 ***************************************************************************/
436 static int strwicmp(char *psz1
, char *psz2
)
438 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
439 /* appropriate value. */
449 /* sync the strings on first non-whitespace */
452 while (isspace(*psz1
))
454 while (isspace(*psz2
))
456 if (toupper(*psz1
) != toupper(*psz2
) || *psz1
== '\0' || *psz2
== '\0')
461 return (*psz1
- *psz2
);
464 /***************************************************************************
465 Map a parameter's string representation to something we can use.
466 Returns False if the parameter string is not recognised, else TRUE.
467 ***************************************************************************/
468 static int map_parameter(char *parmname
)
472 if (*parmname
== '-')
475 for (iIndex
= 0; parm_table
[iIndex
].label
; iIndex
++)
476 if (strwicmp(parm_table
[iIndex
].label
, parmname
) == 0)
479 rprintf(FERROR
, "Unknown Parameter encountered: \"%s\"\n", parmname
);
484 /***************************************************************************
485 Set a boolean variable from the text value stored in the passed string.
486 Returns True in success, False if the passed string does not correctly
488 ***************************************************************************/
489 static BOOL
set_boolean(BOOL
*pb
, char *parmvalue
)
494 if (strwicmp(parmvalue
, "yes") == 0 ||
495 strwicmp(parmvalue
, "true") == 0 ||
496 strwicmp(parmvalue
, "1") == 0)
499 if (strwicmp(parmvalue
, "no") == 0 ||
500 strwicmp(parmvalue
, "False") == 0 ||
501 strwicmp(parmvalue
, "0") == 0)
505 rprintf(FERROR
, "Badly formed boolean in configuration file: \"%s\".\n",
512 /***************************************************************************
513 Find a service by name. Otherwise works like get_service.
514 ***************************************************************************/
515 static int getservicebyname(char *name
, service
*pserviceDest
)
519 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
520 if (strwicmp(iSERVICE(iService
).name
, name
) == 0)
522 if (pserviceDest
!= NULL
)
523 copy_service(pserviceDest
, pSERVICE(iService
));
532 /***************************************************************************
533 Copy a service structure to another
535 ***************************************************************************/
536 static void copy_service(service
*pserviceDest
,
537 service
*pserviceSource
)
541 for (i
=0;parm_table
[i
].label
;i
++)
542 if (parm_table
[i
].ptr
&& parm_table
[i
].class == P_LOCAL
) {
543 void *def_ptr
= parm_table
[i
].ptr
;
545 ((char *)pserviceSource
) + PTR_DIFF(def_ptr
,&sDefault
);
547 ((char *)pserviceDest
) + PTR_DIFF(def_ptr
,&sDefault
);
549 switch (parm_table
[i
].type
)
553 *(BOOL
*)dest_ptr
= *(BOOL
*)src_ptr
;
559 *(int *)dest_ptr
= *(int *)src_ptr
;
563 *(char *)dest_ptr
= *(char *)src_ptr
;
567 string_set(dest_ptr
,*(char **)src_ptr
);
577 /***************************************************************************
578 Process a parameter for a particular service number. If snum < 0
579 then assume we are in the globals
580 ***************************************************************************/
581 static BOOL
lp_do_parameter(int snum
, char *parmname
, char *parmvalue
)
584 void *parm_ptr
=NULL
; /* where we are going to store the result */
587 parmnum
= map_parameter(parmname
);
591 rprintf(FERROR
, "IGNORING unknown parameter \"%s\"\n", parmname
);
595 def_ptr
= parm_table
[parmnum
].ptr
;
597 /* we might point at a service, the default service or a global */
601 if (parm_table
[parmnum
].class == P_GLOBAL
) {
602 rprintf(FERROR
, "Global parameter %s found in service section!\n",parmname
);
605 parm_ptr
= ((char *)pSERVICE(snum
)) + PTR_DIFF(def_ptr
,&sDefault
);
608 /* now switch on the type of variable it is */
609 switch (parm_table
[parmnum
].type
)
612 set_boolean(parm_ptr
,parmvalue
);
616 set_boolean(parm_ptr
,parmvalue
);
617 *(BOOL
*)parm_ptr
= ! *(BOOL
*)parm_ptr
;
621 *(int *)parm_ptr
= atoi(parmvalue
);
625 *(char *)parm_ptr
= *parmvalue
;
629 sscanf(parmvalue
,"%o",(int *)parm_ptr
);
633 string_set(parm_ptr
,parmvalue
);
637 strlcpy((char *)parm_ptr
,parmvalue
,sizeof(pstring
));
641 for (i
=0;parm_table
[parmnum
].enum_list
[i
].name
;i
++) {
642 if (strequal(parmvalue
, parm_table
[parmnum
].enum_list
[i
].name
)) {
643 *(int *)parm_ptr
= parm_table
[parmnum
].enum_list
[i
].value
;
647 if (!parm_table
[parmnum
].enum_list
[i
].name
) {
648 if (atoi(parmvalue
) > 0)
649 *(int *)parm_ptr
= atoi(parmvalue
);
659 /***************************************************************************
661 ***************************************************************************/
662 static BOOL
do_parameter(char *parmname
, char *parmvalue
)
664 return lp_do_parameter(bInGlobalSection
?-2:iServiceIndex
, parmname
, parmvalue
);
667 /***************************************************************************
668 Process a new section (service). At this stage all sections are services.
669 Later we'll have special sections that permit server parameters to be set.
670 Returns True on success, False on failure.
671 ***************************************************************************/
672 static BOOL
do_section(char *sectionname
)
675 BOOL isglobal
= (strwicmp(sectionname
, GLOBAL_NAME
) == 0);
678 /* if we were in a global section then do the local inits */
679 if (bInGlobalSection
&& !isglobal
)
682 /* if we've just struck a global section, note the fact. */
683 bInGlobalSection
= isglobal
;
685 /* check for multiple global sections */
686 if (bInGlobalSection
)
691 /* if we have a current service, tidy it up before moving on */
694 if (iServiceIndex
>= 0)
697 /* if all is still well, move to the next record in the services array */
700 /* We put this here to avoid an odd message order if messages are */
701 /* issued by the post-processing of a previous section. */
703 if ((iServiceIndex
=add_a_service(&sDefault
,sectionname
)) < 0)
705 rprintf(FERROR
,"Failed to add a new service\n");
714 /***************************************************************************
715 Load the services array from the services file. Return True on success,
717 ***************************************************************************/
718 BOOL
lp_load(char *pszFname
, int globals_only
)
725 bInGlobalSection
= True
;
729 pstrcpy(n2
,pszFname
);
731 /* We get sections first, so have to start 'behind' to make up */
733 bRetval
= pm_process(n2
, globals_only
?NULL
:do_section
, do_parameter
);
739 /***************************************************************************
740 return the max number of services
741 ***************************************************************************/
742 int lp_numservices(void)
744 return(iNumServices
);
747 /***************************************************************************
748 Return the number of the service with the given name, or -1 if it doesn't
749 exist. Note that this is a DIFFERENT ANIMAL from the internal function
750 getservicebyname()! This works ONLY if all services have been loaded, and
751 does not copy the found service.
752 ***************************************************************************/
753 int lp_number(char *name
)
757 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
758 if (strequal(lp_name(iService
), name
))