2 * mainconf.c Handle the server's configuration.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2002,2006-2007 The FreeRADIUS server project
21 * Copyright 2002 Alan DeKok <aland@ox.org>
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
29 #include <freeradius-devel/rad_assert.h>
33 #ifdef HAVE_SYS_RESOURCE_H
34 #include <sys/resource.h>
45 #ifdef HAVE_SYS_PRCTL_H
46 #include <sys/prctl.h>
53 #ifdef HAVE_SYS_STAT_H
61 struct main_config_t mainconfig;
62 char *request_log_file = NULL;
63 char *debug_log_file = NULL;
66 * Temporary local variables for parsing the configuration
69 static uid_t server_uid;
70 static gid_t server_gid;
71 static const char *uid_name = NULL;
72 static const char *gid_name = NULL;
73 static const char *chroot_dir = NULL;
74 static int allow_core_dumps = 0;
75 static const char *radlog_dest = NULL;
78 * These are not used anywhere else..
80 static const char *localstatedir = NULL;
81 static const char *prefix = NULL;
82 static char *syslog_facility = NULL;
83 static const FR_NAME_NUMBER str2fac[] = {
94 { "daemon", LOG_DAEMON },
103 { "news", LOG_NEWS },
106 { "uucp", LOG_UUCP },
109 { "cron", LOG_CRON },
112 { "authpriv", LOG_AUTHPRIV },
118 { "local0", LOG_LOCAL0 },
121 { "local1", LOG_LOCAL1 },
124 { "local2", LOG_LOCAL2 },
127 { "local3", LOG_LOCAL3 },
130 { "local4", LOG_LOCAL4 },
133 { "local5", LOG_LOCAL5 },
136 { "local6", LOG_LOCAL6 },
139 { "local7", LOG_LOCAL7 },
145 * Security configuration for the server.
147 static const CONF_PARSER security_config[] = {
148 { "max_attributes", PW_TYPE_INTEGER, 0, &fr_max_attributes, Stringify(0) },
149 { "reject_delay", PW_TYPE_INTEGER, 0, &mainconfig.reject_delay, Stringify(0) },
150 { "status_server", PW_TYPE_BOOLEAN, 0, &mainconfig.status_server, "no"},
151 { NULL, -1, 0, NULL, NULL }
156 * Logging configuration for the server.
158 static const CONF_PARSER logdest_config[] = {
159 { "destination", PW_TYPE_STRING_PTR, 0, &radlog_dest, "files" },
160 { "syslog_facility", PW_TYPE_STRING_PTR, 0, &syslog_facility, Stringify(0) },
162 { "file", PW_TYPE_STRING_PTR, -1, &mainconfig.log_file, "${logdir}/radius.log" },
163 { "requests", PW_TYPE_STRING_PTR, -1, &request_log_file, NULL },
164 { "debug_file", PW_TYPE_STRING_PTR, -1, &debug_log_file, NULL },
165 { NULL, -1, 0, NULL, NULL }
169 static const CONF_PARSER serverdest_config[] = {
170 { "log", PW_TYPE_SUBSECTION, 0, NULL, (const void *) logdest_config },
171 { "log_file", PW_TYPE_STRING_PTR, -1, &mainconfig.log_file, NULL },
172 { "log_destination", PW_TYPE_STRING_PTR, -1, &radlog_dest, NULL },
173 { NULL, -1, 0, NULL, NULL }
177 static const CONF_PARSER log_config_nodest[] = {
178 { "stripped_names", PW_TYPE_BOOLEAN, 0, &log_stripped_names,"no" },
180 { "auth", PW_TYPE_BOOLEAN, -1, &mainconfig.log_auth, "no" },
181 { "auth_badpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_badpass, "no" },
182 { "auth_goodpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_goodpass, "no" },
184 { NULL, -1, 0, NULL, NULL }
189 * A mapping of configuration file names to internal variables
191 static const CONF_PARSER server_config[] = {
193 * FIXME: 'prefix' is the ONLY one which should be
194 * configured at compile time. Hard-coding it here is
195 * bad. It will be cleaned up once we clean up the
196 * hard-coded defines for the locations of the various
199 { "prefix", PW_TYPE_STRING_PTR, 0, &prefix, "/usr/local"},
200 { "localstatedir", PW_TYPE_STRING_PTR, 0, &localstatedir, "${prefix}/var"},
201 { "logdir", PW_TYPE_STRING_PTR, 0, &radlog_dir, "${localstatedir}/log"},
202 { "libdir", PW_TYPE_STRING_PTR, 0, &radlib_dir, "${prefix}/lib"},
203 { "radacctdir", PW_TYPE_STRING_PTR, 0, &radacct_dir, "${logdir}/radacct" },
204 { "hostname_lookups", PW_TYPE_BOOLEAN, 0, &fr_dns_lookups, "no" },
205 { "max_request_time", PW_TYPE_INTEGER, 0, &mainconfig.max_request_time, Stringify(MAX_REQUEST_TIME) },
206 { "cleanup_delay", PW_TYPE_INTEGER, 0, &mainconfig.cleanup_delay, Stringify(CLEANUP_DELAY) },
207 { "max_requests", PW_TYPE_INTEGER, 0, &mainconfig.max_requests, Stringify(MAX_REQUESTS) },
208 #ifdef DELETE_BLOCKED_REQUESTS
209 { "delete_blocked_requests", PW_TYPE_INTEGER, 0, &mainconfig.kill_unresponsive_children, Stringify(FALSE) },
211 { "allow_core_dumps", PW_TYPE_BOOLEAN, 0, &allow_core_dumps, "no" },
213 { "pidfile", PW_TYPE_STRING_PTR, 0, &mainconfig.pid_file, "${run_dir}/radiusd.pid"},
214 { "checkrad", PW_TYPE_STRING_PTR, 0, &mainconfig.checkrad, "${sbindir}/checkrad" },
216 { "debug_level", PW_TYPE_INTEGER, 0, &mainconfig.debug_level, "0"},
219 { "proxy_requests", PW_TYPE_BOOLEAN, 0, &mainconfig.proxy_requests, "yes" },
221 { "log", PW_TYPE_SUBSECTION, 0, NULL, (const void *) log_config_nodest },
224 * People with old configs will have these. They are listed
225 * AFTER the "log" section, so if they exist in radiusd.conf,
226 * it will prefer "log_foo = bar" to "log { foo = bar }".
227 * They're listed with default values of NULL, so that if they
228 * DON'T exist in radiusd.conf, then the previously parsed
229 * values for "log { foo = bar}" will be used.
231 { "log_auth", PW_TYPE_BOOLEAN, -1, &mainconfig.log_auth, NULL },
232 { "log_auth_badpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_badpass, NULL },
233 { "log_auth_goodpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_goodpass, NULL },
234 { "log_stripped_names", PW_TYPE_BOOLEAN, 0, &log_stripped_names, NULL },
236 { "security", PW_TYPE_SUBSECTION, 0, NULL, (const void *) security_config },
238 { NULL, -1, 0, NULL, NULL }
241 #define MAX_ARGV (256)
244 static size_t config_escape_func(char *out, size_t outlen, const char *in)
247 static const char *disallowed = "%{}\\'\"`";
251 * Non-printable characters get replaced with their
252 * mime-encoded equivalents.
255 if (outlen <= 3) break;
257 snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
264 } else if (strchr(disallowed, *in) != NULL) {
265 if (outlen <= 2) break;
277 * Only one byte left.
297 * Xlat for %{config:section.subsection.attribute}
299 static size_t xlat_config(void *instance, REQUEST *request,
300 char *fmt, char *out,
302 RADIUS_ESCAPE_STRING func)
309 request = request; /* -Wunused */
310 instance = instance; /* -Wunused */
315 if (!radius_xlat(buffer, sizeof(buffer), fmt, request, config_escape_func)) {
319 ci = cf_reference_item(request->root->config,
320 request->root->config, buffer);
321 if (!ci || !cf_item_is_pair(ci)) {
326 cp = cf_itemtopair(ci);
329 * Ensure that we only copy what's necessary.
331 * If 'outlen' is too small, then the output is chopped to fit.
333 value = cf_pair_value(cp);
335 if (outlen > strlen(value)) {
336 outlen = strlen(value) + 1;
340 return func(out, outlen, value);
345 * Xlat for %{client:foo}
347 static size_t xlat_client(UNUSED void *instance, REQUEST *request,
348 char *fmt, char *out,
350 UNUSED RADIUS_ESCAPE_STRING func)
352 const char *value = NULL;
355 if (!fmt || !out || (outlen < 1)) return 0;
357 if (!request || !request->client) {
362 cp = cf_pair_find(request->client->cs, fmt);
363 if (!cp || !(value = cf_pair_value(cp))) {
368 strlcpy(out, value, outlen);
374 * Recursively make directories.
376 static int r_mkdir(const char *part)
378 char *ptr, parentdir[500];
381 if (stat(part, &st) == 0)
384 ptr = strrchr(part, FR_DIR_SEP);
389 snprintf(parentdir, (ptr - part)+1, "%s", part);
391 if (r_mkdir(parentdir) != 0)
394 if (mkdir(part, 0770) != 0) {
395 radlog(L_ERR, "mkdir(%s) error: %s\n", part, strerror(errno));
404 * Do chroot, if requested.
406 * Switch UID and GID to what is specified in the config file
408 static int switch_users(CONF_SECTION *cs)
410 int did_setuid = FALSE;
413 #ifdef HAVE_SYS_RESOURCE_H
414 struct rlimit core_limits;
418 * Don't do chroot/setuid/setgid if we're in debugging
421 if (debug_flag && (getuid() != 0)) return 1;
425 cp = cf_pair_find(cs, "group");
426 if (cp) gid_name = cf_pair_value(cp);
430 DEBUG2("group = %s", gid_name);
431 gr = getgrnam(gid_name);
433 fprintf(stderr, "%s: Cannot get ID for group %s: %s\n",
434 progname, gid_name, strerror(errno));
437 server_gid = gr->gr_gid;
439 server_gid = getgid();
445 cp = cf_pair_find(cs, "user");
446 if (cp) uid_name = cf_pair_value(cp);
450 DEBUG2("user = %s", uid_name);
451 pw = getpwnam(uid_name);
453 fprintf(stderr, "%s: Cannot get passwd entry for user %s: %s\n",
454 progname, uid_name, strerror(errno));
457 server_uid = pw->pw_uid;
458 #ifdef HAVE_INITGROUPS
459 if (initgroups(uid_name, server_gid) < 0) {
460 fprintf(stderr, "%s: Cannot initialize supplementary group list for user %s: %s\n",
461 progname, uid_name, strerror(errno));
466 server_uid = getuid();
470 cp = cf_pair_find(cs, "chroot");
471 if (cp) chroot_dir = cf_pair_value(cp);
473 DEBUG2("chroot = %s", chroot_dir);
474 if (chroot(chroot_dir) < 0) {
475 fprintf(stderr, "%s: Failed to perform chroot %s: %s",
476 progname, chroot_dir, strerror(errno));
481 * Note that we leave chdir alone. It may be
482 * OUTSIDE of the root. This allows us to read
483 * the configuration from "-d ./etc/raddb", with
484 * the chroot as "./chroot/" for example. After
485 * the server has been loaded, it does a "cd
486 * ${logdir}" below, so that core files (if any)
487 * go to a logging directory.
489 * This also allows the configuration of the
490 * server to be outside of the chroot. If the
491 * server is statically linked, then the only
492 * things needed inside of the chroot are the
493 * logging directories.
495 radlog(L_INFO, "performing chroot to %s\n", chroot_dir);
500 if (gid_name && (setgid(server_gid) < 0)) {
501 fprintf(stderr, "%s: Failed setting group to %s: %s",
502 progname, gid_name, strerror(errno));
508 if (uid_name && (setuid(server_uid) < 0)) {
509 fprintf(stderr, "%s: Failed setting user to %s: %s",
510 progname, uid_name, strerror(errno));
515 * Now core dumps are disabled on most secure systems.
521 * Double check that we can write to the log directory.
523 * If we can't, don't start, as we can't log any errors!
525 if ((mainconfig.radlog_dest == RADLOG_FILES) &&
526 (mainconfig.log_file != NULL)) {
527 int fd = open(mainconfig.log_file,
528 O_WRONLY | O_APPEND | O_CREAT, 0640);
530 fprintf(stderr, "%s: Cannot write to log file %s: %s\n",
531 progname, mainconfig.log_file, strerror(errno));
537 * After this it's safe to call radlog(), as it's going
538 * to the right place.
542 #ifdef HAVE_SYS_RESOURCE_H
543 /* Get the current maximum for core files. */
544 if (getrlimit(RLIMIT_CORE, &core_limits) < 0) {
545 radlog(L_ERR, "Failed to get current core limit: %s", strerror(errno));
551 * Core dumps are allowed if we're in debug mode, OR
552 * we've allowed them, OR we did a setuid (which turns
555 * Otherwise, disable core dumps for security.
558 if (!(debug_flag || allow_core_dumps || did_setuid)) {
559 #ifdef HAVE_SYS_RESOURCE_H
560 struct rlimit no_core;
562 no_core.rlim_cur = 0;
563 no_core.rlim_max = 0;
565 if (setrlimit(RLIMIT_CORE, &no_core) < 0) {
566 radlog(L_ERR, "Failed disabling core dumps: %s",
573 * Otherwise, re-enable core dumps if we're
574 * running as a daemon, AND core dumps are
575 * allowed, AND we changed UID's.
577 } else if ((debug_flag == 0) && allow_core_dumps && did_setuid) {
579 * Set the dumpable flag.
581 #ifdef HAVE_SYS_PRCTL_H
582 #ifdef PR_SET_DUMPABLE
583 if (prctl(PR_SET_DUMPABLE, 1) < 0) {
584 radlog(L_ERR,"Cannot enable core dumps: prctl(PR_SET_DUMPABLE) failed: '%s'",
591 * Reset the core dump limits again, just to
592 * double check that they haven't changed.
594 #ifdef HAVE_SYS_RESOURCE_H
595 if (setrlimit(RLIMIT_CORE, &core_limits) < 0) {
596 radlog(L_ERR, "Cannot update core dump limit: %s",
602 radlog(L_INFO, "Core dumps are enabled.");
605 * Else we're debugging (so core dumps are enabled)
606 * OR we're not debugging, AND "allow_core_dumps == FALSE",
607 * OR we're not debugging, AND core dumps are allowed,
608 * BUT we didn't call setuid, so we haven't changed the
609 * core dump capabilities inherited from the parent shell.
616 static const FR_NAME_NUMBER str2dest[] = {
617 { "null", RADLOG_NULL },
618 { "files", RADLOG_FILES },
619 { "syslog", RADLOG_SYSLOG },
620 { "stdout", RADLOG_STDOUT },
621 { "stderr", RADLOG_STDERR },
622 { NULL, RADLOG_NUM_DEST }
629 * This function can ONLY be called from the main server process.
631 int read_mainconfig(int reload)
633 const char *p = NULL;
634 static int old_debug_level = -1;
640 if (stat(radius_dir, &statbuf) < 0) {
641 radlog(L_ERR, "Errors reading %s: %s",
642 radius_dir, strerror(errno));
647 if ((statbuf.st_mode & S_IWOTH) != 0) {
648 radlog(L_ERR, "Configuration directory %s is globally writable. Refusing to start due to insecure configuration.",
655 if (0 && (statbuf.st_mode & S_IROTH) != 0) {
656 radlog(L_ERR, "Configuration directory %s is globally readable. Refusing to start due to insecure configuration.",
663 radlog(L_INFO, "Starting - reading configuration files ...");
665 radlog(L_INFO, "Reloading - reading configuration files...");
668 /* Read the configuration file */
669 snprintf(buffer, sizeof(buffer), "%.200s/%.50s.conf",
670 radius_dir, mainconfig.name);
671 if ((cs = cf_file_read(buffer)) == NULL) {
672 radlog(L_ERR, "Errors reading %s", buffer);
677 * If there was no log destination set on the command line,
680 if (mainconfig.radlog_dest == RADLOG_NULL) {
681 if (cf_section_parse(cs, NULL, serverdest_config) < 0) {
682 fprintf(stderr, "radiusd: Error: Failed to parse log{} section.\n");
683 cf_section_free(&cs);
688 fprintf(stderr, "radiusd: Error: No log destination specified.\n");
689 cf_section_free(&cs);
693 mainconfig.radlog_dest = fr_str2int(str2dest, radlog_dest,
695 if (mainconfig.radlog_dest == RADLOG_NUM_DEST) {
696 fprintf(stderr, "radiusd: Error: Unknown log_destination %s\n",
698 cf_section_free(&cs);
702 if (mainconfig.radlog_dest == RADLOG_SYSLOG) {
704 * Make sure syslog_facility isn't NULL
707 if (!syslog_facility) {
708 fprintf(stderr, "radiusd: Error: Syslog chosen but no facility was specified\n");
709 cf_section_free(&cs);
712 mainconfig.syslog_facility = fr_str2int(str2fac, syslog_facility, -1);
713 if (mainconfig.syslog_facility < 0) {
714 fprintf(stderr, "radiusd: Error: Unknown syslog_facility %s\n",
716 cf_section_free(&cs);
723 * We should really switch users earlier in the process.
725 if (!switch_users(cs)) exit(1);
727 /* Initialize the dictionary */
728 cp = cf_pair_find(cs, "dictionary");
729 if (cp) p = cf_pair_value(cp);
730 if (!p) p = radius_dir;
731 DEBUG2("including dictionary file %s/%s", p, RADIUS_DICTIONARY);
732 if (dict_init(p, RADIUS_DICTIONARY) != 0) {
733 radlog(L_ERR, "Errors reading dictionary: %s",
739 * This allows us to figure out where, relative to
740 * radiusd.conf, the other configuration files exist.
742 cf_section_parse(cs, NULL, server_config);
745 * Free the old configuration items, and replace them
748 * Note that where possible, we do atomic switch-overs,
749 * to ensure that the pointers are always valid.
751 cf_section_free(&mainconfig.config);
752 mainconfig.config = cs;
754 if (!clients_parse_section(cs)) {
758 DEBUG2("%s: #### Loading Realms and Home Servers ####", mainconfig.name);
760 if (!realms_init(cs)) {
765 * Register the %{config:section.subsection} xlat function.
767 xlat_register("config", xlat_config, NULL);
768 xlat_register("client", xlat_client, NULL);
771 * Reload: change debug flag if it's changed in the
772 * configuration file.
775 if (mainconfig.debug_level != old_debug_level) {
776 debug_flag = mainconfig.debug_level;
779 } else if (debug_flag == 0) {
782 * Starting the server, WITHOUT "-x" on the
783 * command-line: use whatever's in the config
786 debug_flag = mainconfig.debug_level;
788 fr_debug_flag = debug_flag;
789 old_debug_level = mainconfig.debug_level;
792 * Go update our behaviour, based on the configuration
797 * Sanity check the configuration for internal
800 if (mainconfig.reject_delay > mainconfig.cleanup_delay) {
801 mainconfig.reject_delay = mainconfig.cleanup_delay;
803 if (mainconfig.reject_delay < 0) mainconfig.reject_delay = 0;
805 /* Reload the modules. */
806 if (setup_modules(reload, mainconfig.config) < 0) {
807 radlog(L_ERR, "Errors initializing modules");
812 if (chdir(radlog_dir) < 0) {
813 radlog(L_ERR, "Failed to 'chdir %s' after chroot: %s",
814 radlog_dir, strerror(errno));
823 * Free the configuration. Called only when the server is exiting.
825 int free_mainconfig(void)
828 * Clean up the configuration data
831 cf_section_free(&mainconfig.config);
833 listen_free(&mainconfig.listen);