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;
64 char *debug_condition = NULL;
67 * Temporary local variables for parsing the configuration
72 static gid_t server_gid;
73 static const char *uid_name = NULL;
74 static const char *gid_name = NULL;
76 static const char *chroot_dir = NULL;
77 static int allow_core_dumps = 0;
78 static const char *radlog_dest = NULL;
81 * These are not used anywhere else..
83 static const char *localstatedir = NULL;
84 static const char *prefix = NULL;
85 static char *syslog_facility = NULL;
86 static const FR_NAME_NUMBER str2fac[] = {
97 { "daemon", LOG_DAEMON },
100 { "auth", LOG_AUTH },
106 { "news", LOG_NEWS },
109 { "uucp", LOG_UUCP },
112 { "cron", LOG_CRON },
115 { "authpriv", LOG_AUTHPRIV },
121 { "local0", LOG_LOCAL0 },
124 { "local1", LOG_LOCAL1 },
127 { "local2", LOG_LOCAL2 },
130 { "local3", LOG_LOCAL3 },
133 { "local4", LOG_LOCAL4 },
136 { "local5", LOG_LOCAL5 },
139 { "local6", LOG_LOCAL6 },
142 { "local7", LOG_LOCAL7 },
148 * Security configuration for the server.
150 static const CONF_PARSER security_config[] = {
151 { "max_attributes", PW_TYPE_INTEGER, 0, &fr_max_attributes, Stringify(0) },
152 { "reject_delay", PW_TYPE_INTEGER, 0, &mainconfig.reject_delay, Stringify(0) },
153 { "status_server", PW_TYPE_BOOLEAN, 0, &mainconfig.status_server, "no"},
154 { NULL, -1, 0, NULL, NULL }
159 * Logging configuration for the server.
161 static const CONF_PARSER logdest_config[] = {
162 { "destination", PW_TYPE_STRING_PTR, 0, &radlog_dest, "files" },
163 { "syslog_facility", PW_TYPE_STRING_PTR, 0, &syslog_facility, Stringify(0) },
165 { "file", PW_TYPE_STRING_PTR, -1, &mainconfig.log_file, "${logdir}/radius.log" },
166 { "requests", PW_TYPE_STRING_PTR, -1, &request_log_file, NULL },
167 { "debug_file", PW_TYPE_STRING_PTR, -1, &debug_log_file, NULL },
168 { NULL, -1, 0, NULL, NULL }
172 static const CONF_PARSER serverdest_config[] = {
173 { "log", PW_TYPE_SUBSECTION, 0, NULL, (const void *) logdest_config },
174 { "log_file", PW_TYPE_STRING_PTR, -1, &mainconfig.log_file, NULL },
175 { "log_destination", PW_TYPE_STRING_PTR, -1, &radlog_dest, NULL },
176 { NULL, -1, 0, NULL, NULL }
180 static const CONF_PARSER log_config_nodest[] = {
181 { "stripped_names", PW_TYPE_BOOLEAN, 0, &log_stripped_names,"no" },
183 { "auth", PW_TYPE_BOOLEAN, -1, &mainconfig.log_auth, "no" },
184 { "auth_badpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_badpass, "no" },
185 { "auth_goodpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_goodpass, "no" },
187 { NULL, -1, 0, NULL, NULL }
192 * A mapping of configuration file names to internal variables
194 static const CONF_PARSER server_config[] = {
196 * FIXME: 'prefix' is the ONLY one which should be
197 * configured at compile time. Hard-coding it here is
198 * bad. It will be cleaned up once we clean up the
199 * hard-coded defines for the locations of the various
202 { "prefix", PW_TYPE_STRING_PTR, 0, &prefix, "/usr/local"},
203 { "localstatedir", PW_TYPE_STRING_PTR, 0, &localstatedir, "${prefix}/var"},
204 { "logdir", PW_TYPE_STRING_PTR, 0, &radlog_dir, "${localstatedir}/log"},
205 { "libdir", PW_TYPE_STRING_PTR, 0, &radlib_dir, "${prefix}/lib"},
206 { "radacctdir", PW_TYPE_STRING_PTR, 0, &radacct_dir, "${logdir}/radacct" },
207 { "hostname_lookups", PW_TYPE_BOOLEAN, 0, &fr_dns_lookups, "no" },
208 { "max_request_time", PW_TYPE_INTEGER, 0, &mainconfig.max_request_time, Stringify(MAX_REQUEST_TIME) },
209 { "cleanup_delay", PW_TYPE_INTEGER, 0, &mainconfig.cleanup_delay, Stringify(CLEANUP_DELAY) },
210 { "max_requests", PW_TYPE_INTEGER, 0, &mainconfig.max_requests, Stringify(MAX_REQUESTS) },
211 #ifdef DELETE_BLOCKED_REQUESTS
212 { "delete_blocked_requests", PW_TYPE_INTEGER, 0, &mainconfig.kill_unresponsive_children, Stringify(FALSE) },
214 { "allow_core_dumps", PW_TYPE_BOOLEAN, 0, &allow_core_dumps, "no" },
216 { "pidfile", PW_TYPE_STRING_PTR, 0, &mainconfig.pid_file, "${run_dir}/radiusd.pid"},
217 { "checkrad", PW_TYPE_STRING_PTR, 0, &mainconfig.checkrad, "${sbindir}/checkrad" },
219 { "debug_level", PW_TYPE_INTEGER, 0, &mainconfig.debug_level, "0"},
222 { "proxy_requests", PW_TYPE_BOOLEAN, 0, &mainconfig.proxy_requests, "yes" },
224 { "log", PW_TYPE_SUBSECTION, 0, NULL, (const void *) log_config_nodest },
227 * People with old configs will have these. They are listed
228 * AFTER the "log" section, so if they exist in radiusd.conf,
229 * it will prefer "log_foo = bar" to "log { foo = bar }".
230 * They're listed with default values of NULL, so that if they
231 * DON'T exist in radiusd.conf, then the previously parsed
232 * values for "log { foo = bar}" will be used.
234 { "log_auth", PW_TYPE_BOOLEAN, -1, &mainconfig.log_auth, NULL },
235 { "log_auth_badpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_badpass, NULL },
236 { "log_auth_goodpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_goodpass, NULL },
237 { "log_stripped_names", PW_TYPE_BOOLEAN, 0, &log_stripped_names, NULL },
239 { "security", PW_TYPE_SUBSECTION, 0, NULL, (const void *) security_config },
241 { NULL, -1, 0, NULL, NULL }
244 #define MAX_ARGV (256)
247 static size_t config_escape_func(char *out, size_t outlen, const char *in)
250 static const char *disallowed = "%{}\\'\"`";
254 * Non-printable characters get replaced with their
255 * mime-encoded equivalents.
258 if (outlen <= 3) break;
260 snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
267 } else if (strchr(disallowed, *in) != NULL) {
268 if (outlen <= 2) break;
280 * Only one byte left.
300 * Xlat for %{config:section.subsection.attribute}
302 static size_t xlat_config(void *instance, REQUEST *request,
303 char *fmt, char *out,
305 RADIUS_ESCAPE_STRING func)
312 request = request; /* -Wunused */
313 instance = instance; /* -Wunused */
318 if (!radius_xlat(buffer, sizeof(buffer), fmt, request, config_escape_func)) {
322 ci = cf_reference_item(request->root->config,
323 request->root->config, buffer);
324 if (!ci || !cf_item_is_pair(ci)) {
329 cp = cf_itemtopair(ci);
332 * Ensure that we only copy what's necessary.
334 * If 'outlen' is too small, then the output is chopped to fit.
336 value = cf_pair_value(cp);
338 if (outlen > strlen(value)) {
339 outlen = strlen(value) + 1;
343 return func(out, outlen, value);
348 * Xlat for %{client:foo}
350 static size_t xlat_client(UNUSED void *instance, REQUEST *request,
351 char *fmt, char *out,
353 UNUSED RADIUS_ESCAPE_STRING func)
355 const char *value = NULL;
358 if (!fmt || !out || (outlen < 1)) return 0;
360 if (!request || !request->client) {
365 cp = cf_pair_find(request->client->cs, fmt);
366 if (!cp || !(value = cf_pair_value(cp))) {
371 strlcpy(out, value, outlen);
377 * Recursively make directories.
379 static int r_mkdir(const char *part)
381 char *ptr, parentdir[500];
384 if (stat(part, &st) == 0)
387 ptr = strrchr(part, FR_DIR_SEP);
392 snprintf(parentdir, (ptr - part)+1, "%s", part);
394 if (r_mkdir(parentdir) != 0)
397 if (mkdir(part, 0770) != 0) {
398 radlog(L_ERR, "mkdir(%s) error: %s\n", part, strerror(errno));
408 * Do chroot, if requested.
410 * Switch UID and GID to what is specified in the config file
412 static int switch_users(CONF_SECTION *cs)
414 int did_setuid = FALSE;
417 #ifdef HAVE_SYS_RESOURCE_H
418 struct rlimit core_limits;
422 * Don't do chroot/setuid/setgid if we're in debugging
425 if (debug_flag && (getuid() != 0)) return 1;
429 cp = cf_pair_find(cs, "group");
430 if (cp) gid_name = cf_pair_value(cp);
434 DEBUG2("group = %s", gid_name);
435 gr = getgrnam(gid_name);
437 fprintf(stderr, "%s: Cannot get ID for group %s: %s\n",
438 progname, gid_name, strerror(errno));
441 server_gid = gr->gr_gid;
443 server_gid = getgid();
449 cp = cf_pair_find(cs, "user");
450 if (cp) uid_name = cf_pair_value(cp);
454 DEBUG2("user = %s", uid_name);
455 pw = getpwnam(uid_name);
457 fprintf(stderr, "%s: Cannot get passwd entry for user %s: %s\n",
458 progname, uid_name, strerror(errno));
461 server_uid = pw->pw_uid;
462 #ifdef HAVE_INITGROUPS
463 if (initgroups(uid_name, server_gid) < 0) {
464 fprintf(stderr, "%s: Cannot initialize supplementary group list for user %s: %s\n",
465 progname, uid_name, strerror(errno));
470 server_uid = getuid();
474 cp = cf_pair_find(cs, "chroot");
475 if (cp) chroot_dir = cf_pair_value(cp);
477 DEBUG2("chroot = %s", chroot_dir);
478 if (chroot(chroot_dir) < 0) {
479 fprintf(stderr, "%s: Failed to perform chroot %s: %s",
480 progname, chroot_dir, strerror(errno));
485 * Note that we leave chdir alone. It may be
486 * OUTSIDE of the root. This allows us to read
487 * the configuration from "-d ./etc/raddb", with
488 * the chroot as "./chroot/" for example. After
489 * the server has been loaded, it does a "cd
490 * ${logdir}" below, so that core files (if any)
491 * go to a logging directory.
493 * This also allows the configuration of the
494 * server to be outside of the chroot. If the
495 * server is statically linked, then the only
496 * things needed inside of the chroot are the
497 * logging directories.
499 radlog(L_INFO, "performing chroot to %s\n", chroot_dir);
504 if (gid_name && (setgid(server_gid) < 0)) {
505 fprintf(stderr, "%s: Failed setting group to %s: %s",
506 progname, gid_name, strerror(errno));
514 #ifndef HAVE_SETRESUID
516 * Fake out setresuid with something that's close.
518 #define setresuid(_a, _b, _c) setuid(_b)
521 if (setresuid(-1, server_uid, geteuid()) < 0) {
522 fprintf(stderr, "%s: Failed switching uid: %s\n",
523 progname, strerror(errno));
527 if (geteuid() != server_uid) {
528 fprintf(stderr, "%s: Failed switching uid: UID is incorrect\n",
535 * Now core dumps are disabled on most secure systems.
541 * Double check that we can write to the log directory.
543 * If we can't, don't start, as we can't log any errors!
545 if ((mainconfig.radlog_dest == RADLOG_FILES) &&
546 (mainconfig.log_file != NULL)) {
547 int fd = open(mainconfig.log_file,
548 O_WRONLY | O_APPEND | O_CREAT, 0640);
550 fprintf(stderr, "%s: Cannot write to log file %s: %s\n",
551 progname, mainconfig.log_file, strerror(errno));
557 * After this it's safe to call radlog(), as it's going
558 * to the right place.
562 #ifdef HAVE_SYS_RESOURCE_H
563 /* Get the current maximum for core files. */
564 if (getrlimit(RLIMIT_CORE, &core_limits) < 0) {
565 radlog(L_ERR, "Failed to get current core limit: %s", strerror(errno));
571 * Core dumps are allowed if we're in debug mode, OR
572 * we've allowed them, OR we did a setuid (which turns
575 * Otherwise, disable core dumps for security.
578 if (!(debug_flag || allow_core_dumps || did_setuid)) {
579 #ifdef HAVE_SYS_RESOURCE_H
580 struct rlimit no_core;
582 no_core.rlim_cur = 0;
583 no_core.rlim_max = 0;
585 if (setrlimit(RLIMIT_CORE, &no_core) < 0) {
586 radlog(L_ERR, "Failed disabling core dumps: %s",
593 * Otherwise, re-enable core dumps if we're
594 * running as a daemon, AND core dumps are
595 * allowed, AND we changed UID's.
597 } else if ((debug_flag == 0) && allow_core_dumps && did_setuid) {
599 * Set the dumpable flag.
601 #ifdef HAVE_SYS_PRCTL_H
602 #ifdef PR_SET_DUMPABLE
603 if (prctl(PR_SET_DUMPABLE, 1) < 0) {
604 radlog(L_ERR,"Cannot enable core dumps: prctl(PR_SET_DUMPABLE) failed: '%s'",
611 * Reset the core dump limits again, just to
612 * double check that they haven't changed.
614 #ifdef HAVE_SYS_RESOURCE_H
615 if (setrlimit(RLIMIT_CORE, &core_limits) < 0) {
616 radlog(L_ERR, "Cannot update core dump limit: %s",
622 radlog(L_INFO, "Core dumps are enabled.");
625 * Else we're debugging (so core dumps are enabled)
626 * OR we're not debugging, AND "allow_core_dumps == FALSE",
627 * OR we're not debugging, AND core dumps are allowed,
628 * BUT we didn't call setuid, so we haven't changed the
629 * core dump capabilities inherited from the parent shell.
637 static const FR_NAME_NUMBER str2dest[] = {
638 { "null", RADLOG_NULL },
639 { "files", RADLOG_FILES },
640 { "syslog", RADLOG_SYSLOG },
641 { "stdout", RADLOG_STDOUT },
642 { "stderr", RADLOG_STDERR },
643 { NULL, RADLOG_NUM_DEST }
650 * This function can ONLY be called from the main server process.
652 int read_mainconfig(int reload)
654 const char *p = NULL;
655 static int old_debug_level = -1;
661 if (stat(radius_dir, &statbuf) < 0) {
662 radlog(L_ERR, "Errors reading %s: %s",
663 radius_dir, strerror(errno));
668 if ((statbuf.st_mode & S_IWOTH) != 0) {
669 radlog(L_ERR, "Configuration directory %s is globally writable. Refusing to start due to insecure configuration.",
676 if (0 && (statbuf.st_mode & S_IROTH) != 0) {
677 radlog(L_ERR, "Configuration directory %s is globally readable. Refusing to start due to insecure configuration.",
684 radlog(L_INFO, "Starting - reading configuration files ...");
686 radlog(L_INFO, "Reloading - reading configuration files...");
689 /* Read the configuration file */
690 snprintf(buffer, sizeof(buffer), "%.200s/%.50s.conf",
691 radius_dir, mainconfig.name);
692 if ((cs = cf_file_read(buffer)) == NULL) {
693 radlog(L_ERR, "Errors reading %s", buffer);
698 * If there was no log destination set on the command line,
701 if (mainconfig.radlog_dest == RADLOG_NULL) {
702 if (cf_section_parse(cs, NULL, serverdest_config) < 0) {
703 fprintf(stderr, "radiusd: Error: Failed to parse log{} section.\n");
704 cf_section_free(&cs);
709 fprintf(stderr, "radiusd: Error: No log destination specified.\n");
710 cf_section_free(&cs);
714 mainconfig.radlog_dest = fr_str2int(str2dest, radlog_dest,
716 if (mainconfig.radlog_dest == RADLOG_NUM_DEST) {
717 fprintf(stderr, "radiusd: Error: Unknown log_destination %s\n",
719 cf_section_free(&cs);
723 if (mainconfig.radlog_dest == RADLOG_SYSLOG) {
725 * Make sure syslog_facility isn't NULL
728 if (!syslog_facility) {
729 fprintf(stderr, "radiusd: Error: Syslog chosen but no facility was specified\n");
730 cf_section_free(&cs);
733 mainconfig.syslog_facility = fr_str2int(str2fac, syslog_facility, -1);
734 if (mainconfig.syslog_facility < 0) {
735 fprintf(stderr, "radiusd: Error: Unknown syslog_facility %s\n",
737 cf_section_free(&cs);
745 * We should really switch users earlier in the process.
747 if (!switch_users(cs)) exit(1);
750 /* Initialize the dictionary */
751 cp = cf_pair_find(cs, "dictionary");
752 if (cp) p = cf_pair_value(cp);
753 if (!p) p = radius_dir;
754 DEBUG2("including dictionary file %s/%s", p, RADIUS_DICTIONARY);
755 if (dict_init(p, RADIUS_DICTIONARY) != 0) {
756 radlog(L_ERR, "Errors reading dictionary: %s",
762 * This allows us to figure out where, relative to
763 * radiusd.conf, the other configuration files exist.
765 cf_section_parse(cs, NULL, server_config);
768 * Free the old configuration items, and replace them
771 * Note that where possible, we do atomic switch-overs,
772 * to ensure that the pointers are always valid.
774 cf_section_free(&mainconfig.config);
775 mainconfig.config = cs;
777 if (!clients_parse_section(cs)) {
781 DEBUG2("%s: #### Loading Realms and Home Servers ####", mainconfig.name);
783 if (!realms_init(cs)) {
788 * Register the %{config:section.subsection} xlat function.
790 xlat_register("config", xlat_config, NULL);
791 xlat_register("client", xlat_client, NULL);
794 * Reload: change debug flag if it's changed in the
795 * configuration file.
798 if (mainconfig.debug_level != old_debug_level) {
799 debug_flag = mainconfig.debug_level;
802 } else if (debug_flag == 0) {
805 * Starting the server, WITHOUT "-x" on the
806 * command-line: use whatever's in the config
809 debug_flag = mainconfig.debug_level;
811 fr_debug_flag = debug_flag;
812 old_debug_level = mainconfig.debug_level;
815 * Go update our behaviour, based on the configuration
820 * Sanity check the configuration for internal
823 if (mainconfig.reject_delay > mainconfig.cleanup_delay) {
824 mainconfig.reject_delay = mainconfig.cleanup_delay;
826 if (mainconfig.reject_delay < 0) mainconfig.reject_delay = 0;
828 /* Reload the modules. */
829 if (setup_modules(reload, mainconfig.config) < 0) {
830 radlog(L_ERR, "Errors initializing modules");
835 if (chdir(radlog_dir) < 0) {
836 radlog(L_ERR, "Failed to 'chdir %s' after chroot: %s",
837 radlog_dir, strerror(errno));
846 * Free the configuration. Called only when the server is exiting.
848 int free_mainconfig(void)
851 * Clean up the configuration data
854 cf_section_free(&mainconfig.config);
856 listen_free(&mainconfig.listen);