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;
65 * Temporary local variables for parsing the configuration
68 static uid_t server_uid;
69 static gid_t server_gid;
70 static const char *uid_name = NULL;
71 static const char *gid_name = NULL;
72 static const char *chroot_dir = NULL;
73 static int allow_core_dumps = 0;
74 static const char *radlog_dest = NULL;
77 * These are not used anywhere else..
79 static const char *localstatedir = NULL;
80 static const char *prefix = NULL;
81 static char *syslog_facility = NULL;
82 static const FR_NAME_NUMBER str2fac[] = {
93 { "daemon", LOG_DAEMON },
102 { "news", LOG_NEWS },
105 { "uucp", LOG_UUCP },
108 { "cron", LOG_CRON },
111 { "authpriv", LOG_AUTHPRIV },
117 { "local0", LOG_LOCAL0 },
120 { "local1", LOG_LOCAL1 },
123 { "local2", LOG_LOCAL2 },
126 { "local3", LOG_LOCAL3 },
129 { "local4", LOG_LOCAL4 },
132 { "local5", LOG_LOCAL5 },
135 { "local6", LOG_LOCAL6 },
138 { "local7", LOG_LOCAL7 },
144 * Security configuration for the server.
146 static const CONF_PARSER security_config[] = {
147 { "max_attributes", PW_TYPE_INTEGER, 0, &librad_max_attributes, Stringify(0) },
148 { "reject_delay", PW_TYPE_INTEGER, 0, &mainconfig.reject_delay, Stringify(0) },
149 { "status_server", PW_TYPE_BOOLEAN, 0, &mainconfig.status_server, "no"},
150 { NULL, -1, 0, NULL, NULL }
155 * Logging configuration for the server.
157 static const CONF_PARSER logdest_config[] = {
158 { "destination", PW_TYPE_STRING_PTR, 0, &radlog_dest, "files" },
159 { "syslog_facility", PW_TYPE_STRING_PTR, 0, &syslog_facility, Stringify(0) },
161 { "file", PW_TYPE_STRING_PTR, -1, &mainconfig.log_file, "${logdir}/radius.log" },
162 { "requests", PW_TYPE_STRING_PTR, -1, &request_log_file, NULL },
163 { NULL, -1, 0, NULL, NULL }
167 static const CONF_PARSER serverdest_config[] = {
168 { "log", PW_TYPE_SUBSECTION, 0, NULL, (const void *) logdest_config },
169 { "log_file", PW_TYPE_STRING_PTR, -1, &mainconfig.log_file, NULL },
170 { "log_destination", PW_TYPE_STRING_PTR, -1, &radlog_dest, NULL },
171 { NULL, -1, 0, NULL, NULL }
175 static const CONF_PARSER log_config_nodest[] = {
176 { "stripped_names", PW_TYPE_BOOLEAN, 0, &log_stripped_names,"no" },
178 { "auth", PW_TYPE_BOOLEAN, -1, &mainconfig.log_auth, "no" },
179 { "auth_badpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_badpass, "no" },
180 { "auth_goodpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_goodpass, "no" },
182 { NULL, -1, 0, NULL, NULL }
187 * A mapping of configuration file names to internal variables
189 static const CONF_PARSER server_config[] = {
191 * FIXME: 'prefix' is the ONLY one which should be
192 * configured at compile time. Hard-coding it here is
193 * bad. It will be cleaned up once we clean up the
194 * hard-coded defines for the locations of the various
197 { "prefix", PW_TYPE_STRING_PTR, 0, &prefix, "/usr/local"},
198 { "localstatedir", PW_TYPE_STRING_PTR, 0, &localstatedir, "${prefix}/var"},
199 { "logdir", PW_TYPE_STRING_PTR, 0, &radlog_dir, "${localstatedir}/log"},
200 { "libdir", PW_TYPE_STRING_PTR, 0, &radlib_dir, "${prefix}/lib"},
201 { "radacctdir", PW_TYPE_STRING_PTR, 0, &radacct_dir, "${logdir}/radacct" },
202 { "hostname_lookups", PW_TYPE_BOOLEAN, 0, &librad_dodns, "no" },
203 { "max_request_time", PW_TYPE_INTEGER, 0, &mainconfig.max_request_time, Stringify(MAX_REQUEST_TIME) },
204 { "cleanup_delay", PW_TYPE_INTEGER, 0, &mainconfig.cleanup_delay, Stringify(CLEANUP_DELAY) },
205 { "max_requests", PW_TYPE_INTEGER, 0, &mainconfig.max_requests, Stringify(MAX_REQUESTS) },
206 #ifdef DELETE_BLOCKED_REQUESTS
207 { "delete_blocked_requests", PW_TYPE_INTEGER, 0, &mainconfig.kill_unresponsive_children, Stringify(FALSE) },
209 { "allow_core_dumps", PW_TYPE_BOOLEAN, 0, &allow_core_dumps, "no" },
211 { "pidfile", PW_TYPE_STRING_PTR, 0, &mainconfig.pid_file, "${run_dir}/radiusd.pid"},
212 { "checkrad", PW_TYPE_STRING_PTR, 0, &mainconfig.checkrad, "${sbindir}/checkrad" },
214 { "debug_level", PW_TYPE_INTEGER, 0, &mainconfig.debug_level, "0"},
217 { "proxy_requests", PW_TYPE_BOOLEAN, 0, &mainconfig.proxy_requests, "yes" },
219 { "log", PW_TYPE_SUBSECTION, 0, NULL, (const void *) log_config_nodest },
222 * People with old configs will have these. They are listed
223 * AFTER the "log" section, so if they exist in radiusd.conf,
224 * it will prefer "log_foo = bar" to "log { foo = bar }".
225 * They're listed with default values of NULL, so that if they
226 * DON'T exist in radiusd.conf, then the previously parsed
227 * values for "log { foo = bar}" will be used.
229 { "log_auth", PW_TYPE_BOOLEAN, -1, &mainconfig.log_auth, NULL },
230 { "log_auth_badpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_badpass, NULL },
231 { "log_auth_goodpass", PW_TYPE_BOOLEAN, 0, &mainconfig.log_auth_goodpass, NULL },
232 { "log_stripped_names", PW_TYPE_BOOLEAN, 0, &log_stripped_names, NULL },
234 { "security", PW_TYPE_SUBSECTION, 0, NULL, (const void *) security_config },
236 { NULL, -1, 0, NULL, NULL }
239 #define MAX_ARGV (256)
242 static size_t config_escape_func(char *out, size_t outlen, const char *in)
245 static const char *disallowed = "%{}\\'\"`";
249 * Non-printable characters get replaced with their
250 * mime-encoded equivalents.
253 if (outlen <= 3) break;
255 snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
262 } else if (strchr(disallowed, *in) != NULL) {
263 if (outlen <= 2) break;
275 * Only one byte left.
295 * Xlat for %{config:section.subsection.attribute}
297 static size_t xlat_config(void *instance, REQUEST *request,
298 char *fmt, char *out,
300 RADIUS_ESCAPE_STRING func)
307 request = request; /* -Wunused */
308 instance = instance; /* -Wunused */
313 if (!radius_xlat(buffer, sizeof(buffer), fmt, request, config_escape_func)) {
317 ci = cf_reference_item(request->root->config,
318 request->root->config, buffer);
319 if (!ci || !cf_item_is_pair(ci)) {
324 cp = cf_itemtopair(ci);
327 * Ensure that we only copy what's necessary.
329 * If 'outlen' is too small, then the output is chopped to fit.
331 value = cf_pair_value(cp);
333 if (outlen > strlen(value)) {
334 outlen = strlen(value) + 1;
338 return func(out, outlen, value);
343 * Xlat for %{client:foo}
345 static size_t xlat_client(UNUSED void *instance, REQUEST *request,
346 char *fmt, char *out,
348 UNUSED RADIUS_ESCAPE_STRING func)
350 const char *value = NULL;
353 if (!fmt || !out || (outlen < 1)) return 0;
355 if (!request || !request->client) {
360 cp = cf_pair_find(request->client->cs, fmt);
361 if (!cp || !(value = cf_pair_value(cp))) {
366 strlcpy(out, value, outlen);
372 * Recursively make directories.
374 static int r_mkdir(const char *part)
376 char *ptr, parentdir[500];
379 if (stat(part, &st) == 0)
382 ptr = strrchr(part, FR_DIR_SEP);
387 snprintf(parentdir, (ptr - part)+1, "%s", part);
389 if (r_mkdir(parentdir) != 0)
392 if (mkdir(part, 0770) != 0) {
393 radlog(L_ERR, "mkdir(%s) error: %s\n", part, strerror(errno));
402 * Do chroot, if requested.
404 * Switch UID and GID to what is specified in the config file
406 static int switch_users(CONF_SECTION *cs)
408 int did_setuid = FALSE;
411 #ifdef HAVE_SYS_RESOURCE_H
412 struct rlimit core_limits;
416 * Don't do chroot/setuid/setgid if we're in debugging
419 if (debug_flag && (getuid() != 0)) return 1;
423 cp = cf_pair_find(cs, "group");
424 if (cp) gid_name = cf_pair_value(cp);
428 DEBUG2("group = %s", gid_name);
429 gr = getgrnam(gid_name);
431 fprintf(stderr, "%s: Cannot get ID for group %s: %s\n",
432 progname, gid_name, strerror(errno));
435 server_gid = gr->gr_gid;
437 server_gid = getgid();
443 cp = cf_pair_find(cs, "user");
444 if (cp) uid_name = cf_pair_value(cp);
448 DEBUG2("user = %s", uid_name);
449 pw = getpwnam(uid_name);
451 fprintf(stderr, "%s: Cannot get passwd entry for user %s: %s\n",
452 progname, uid_name, strerror(errno));
455 server_uid = pw->pw_uid;
456 #ifdef HAVE_INITGROUPS
457 if (initgroups(uid_name, server_gid) < 0) {
458 fprintf(stderr, "%s: Cannot initialize supplementary group list for user %s: %s\n",
459 progname, uid_name, strerror(errno));
464 server_uid = getuid();
468 cp = cf_pair_find(cs, "chroot");
469 if (cp) chroot_dir = cf_pair_value(cp);
471 DEBUG2("chroot = %s", chroot_dir);
472 if (chroot(chroot_dir) < 0) {
473 fprintf(stderr, "%s: Failed to perform chroot %s: %s",
474 progname, chroot_dir, strerror(errno));
479 * Note that we leave chdir alone. It may be
480 * OUTSIDE of the root. This allows us to read
481 * the configuration from "-d ./etc/raddb", with
482 * the chroot as "./chroot/" for example. After
483 * the server has been loaded, it does a "cd
484 * ${logdir}" below, so that core files (if any)
485 * go to a logging directory.
487 * This also allows the configuration of the
488 * server to be outside of the chroot. If the
489 * server is statically linked, then the only
490 * things needed inside of the chroot are the
491 * logging directories.
493 radlog(L_INFO, "performing chroot to %s\n", chroot_dir);
498 if (gid_name && (setgid(server_gid) < 0)) {
499 fprintf(stderr, "%s: Failed setting group to %s: %s",
500 progname, gid_name, strerror(errno));
506 if (uid_name && (setuid(server_uid) < 0)) {
507 fprintf(stderr, "%s: Failed setting user to %s: %s",
508 progname, uid_name, strerror(errno));
513 * Now core dumps are disabled on most secure systems.
519 * Double check that we can write to the log directory.
521 * If we can't, don't start, as we can't log any errors!
523 if ((mainconfig.radlog_dest == RADLOG_FILES) &&
524 (mainconfig.log_file != NULL)) {
525 int fd = open(mainconfig.log_file,
526 O_WRONLY | O_APPEND | O_CREAT, 0640);
528 fprintf(stderr, "%s: Cannot write to log file %s: %s\n",
529 progname, mainconfig.log_file, strerror(errno));
535 * After this it's safe to call radlog(), as it's going
536 * to the right place.
540 #ifdef HAVE_SYS_RESOURCE_H
541 /* Get the current maximum for core files. */
542 if (getrlimit(RLIMIT_CORE, &core_limits) < 0) {
543 radlog(L_ERR, "Failed to get current core limit: %s", strerror(errno));
549 * Core dumps are allowed if we're in debug mode, OR
550 * we've allowed them, OR we did a setuid (which turns
553 * Otherwise, disable core dumps for security.
556 if (!(debug_flag || allow_core_dumps || did_setuid)) {
557 #ifdef HAVE_SYS_RESOURCE_H
558 struct rlimit no_core;
560 no_core.rlim_cur = 0;
561 no_core.rlim_max = 0;
563 if (setrlimit(RLIMIT_CORE, &no_core) < 0) {
564 radlog(L_ERR, "Failed disabling core dumps: %s",
571 * Otherwise, re-enable core dumps if we're
572 * running as a daemon, AND core dumps are
573 * allowed, AND we changed UID's.
575 } else if ((debug_flag == 0) && allow_core_dumps && did_setuid) {
577 * Set the dumpable flag.
579 #ifdef HAVE_SYS_PRCTL_H
580 #ifdef PR_SET_DUMPABLE
581 if (prctl(PR_SET_DUMPABLE, 1) < 0) {
582 radlog(L_ERR,"Cannot enable core dumps: prctl(PR_SET_DUMPABLE) failed: '%s'",
589 * Reset the core dump limits again, just to
590 * double check that they haven't changed.
592 #ifdef HAVE_SYS_RESOURCE_H
593 if (setrlimit(RLIMIT_CORE, &core_limits) < 0) {
594 radlog(L_ERR, "Cannot update core dump limit: %s",
600 radlog(L_INFO, "Core dumps are enabled.");
603 * Else we're debugging (so core dumps are enabled)
604 * OR we're not debugging, AND "allow_core_dumps == FALSE",
605 * OR we're not debugging, AND core dumps are allowed,
606 * BUT we didn't call setuid, so we haven't changed the
607 * core dump capabilities inherited from the parent shell.
614 static const FR_NAME_NUMBER str2dest[] = {
615 { "null", RADLOG_NULL },
616 { "files", RADLOG_FILES },
617 { "syslog", RADLOG_SYSLOG },
618 { "stdout", RADLOG_STDOUT },
619 { "stderr", RADLOG_STDERR },
620 { NULL, RADLOG_NUM_DEST }
627 * This function can ONLY be called from the main server process.
629 int read_mainconfig(int reload)
631 const char *p = NULL;
632 static int old_debug_level = -1;
638 if (stat(radius_dir, &statbuf) < 0) {
639 radlog(L_ERR, "Errors reading %s: %s",
640 radius_dir, strerror(errno));
645 if ((statbuf.st_mode & S_IWOTH) != 0) {
646 radlog(L_ERR, "Configuration directory %s is globally writable. Refusing to start due to insecure configuration.",
653 if (0 && (statbuf.st_mode & S_IROTH) != 0) {
654 radlog(L_ERR, "Configuration directory %s is globally readable. Refusing to start due to insecure configuration.",
661 radlog(L_INFO, "Starting - reading configuration files ...");
663 radlog(L_INFO, "Reloading - reading configuration files...");
666 /* Read the configuration file */
667 snprintf(buffer, sizeof(buffer), "%.200s/%.50s.conf",
668 radius_dir, mainconfig.name);
669 if ((cs = cf_file_read(buffer)) == NULL) {
670 radlog(L_ERR, "Errors reading %s", buffer);
675 * If there was no log destination set on the command line,
678 if (mainconfig.radlog_dest == RADLOG_NULL) {
679 if (cf_section_parse(cs, NULL, serverdest_config) < 0) {
680 fprintf(stderr, "radiusd: Error: Failed to parse log{} section.\n");
681 cf_section_free(&cs);
686 fprintf(stderr, "radiusd: Error: No log destination specified.\n");
687 cf_section_free(&cs);
691 mainconfig.radlog_dest = fr_str2int(str2dest, radlog_dest,
693 if (mainconfig.radlog_dest == RADLOG_NUM_DEST) {
694 fprintf(stderr, "radiusd: Error: Unknown log_destination %s\n",
696 cf_section_free(&cs);
700 if (mainconfig.radlog_dest == RADLOG_SYSLOG) {
702 * Make sure syslog_facility isn't NULL
705 if (!syslog_facility) {
706 fprintf(stderr, "radiusd: Error: Syslog chosen but no facility was specified\n");
707 cf_section_free(&cs);
710 mainconfig.syslog_facility = fr_str2int(str2fac, syslog_facility, -1);
711 if (mainconfig.syslog_facility < 0) {
712 fprintf(stderr, "radiusd: Error: Unknown syslog_facility %s\n",
714 cf_section_free(&cs);
721 * We should really switch users earlier in the process.
723 if (!switch_users(cs)) exit(1);
725 /* Initialize the dictionary */
726 cp = cf_pair_find(cs, "dictionary");
727 if (cp) p = cf_pair_value(cp);
728 if (!p) p = radius_dir;
729 DEBUG2("including dictionary file %s/%s", p, RADIUS_DICTIONARY);
730 if (dict_init(p, RADIUS_DICTIONARY) != 0) {
731 radlog(L_ERR, "Errors reading dictionary: %s",
737 * This allows us to figure out where, relative to
738 * radiusd.conf, the other configuration files exist.
740 cf_section_parse(cs, NULL, server_config);
743 * Free the old configuration items, and replace them
746 * Note that where possible, we do atomic switch-overs,
747 * to ensure that the pointers are always valid.
749 cf_section_free(&mainconfig.config);
750 mainconfig.config = cs;
752 clients_parse_section(cs);
754 DEBUG2("%s: #### Loading Realms and Home Servers ####", mainconfig.name);
756 if (!realms_init(cs)) {
761 * Register the %{config:section.subsection} xlat function.
763 xlat_register("config", xlat_config, NULL);
764 xlat_register("client", xlat_client, NULL);
767 * Reload: change debug flag if it's changed in the
768 * configuration file.
771 if (mainconfig.debug_level != old_debug_level) {
772 debug_flag = mainconfig.debug_level;
775 } else if (debug_flag == 0) {
778 * Starting the server, WITHOUT "-x" on the
779 * command-line: use whatever's in the config
782 debug_flag = mainconfig.debug_level;
784 librad_debug = debug_flag;
785 old_debug_level = mainconfig.debug_level;
788 * Go update our behaviour, based on the configuration
793 * Sanity check the configuration for internal
796 if (mainconfig.reject_delay > mainconfig.cleanup_delay) {
797 mainconfig.reject_delay = mainconfig.cleanup_delay;
799 if (mainconfig.reject_delay < 0) mainconfig.reject_delay = 0;
801 /* Reload the modules. */
802 if (setup_modules(reload, mainconfig.config) < 0) {
803 radlog(L_ERR, "Errors initializing modules");
808 if (chdir(radlog_dir) < 0) {
809 radlog(L_ERR, "Failed to 'chdir %s' after chroot: %s",
810 radlog_dir, strerror(errno));
819 * Free the configuration. Called only when the server is exiting.
821 int free_mainconfig(void)
824 * Clean up the configuration data
827 cf_section_free(&mainconfig.config);
829 listen_free(&mainconfig.listen);