The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
radiusd.c
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
15 */
16
17/**
18 * $Id: db3870349b6c67a65d4bcc590f3156bbdfb8a108 $
19 *
20 * @file radiusd.c
21 * @brief Main loop of the radius server.
22 *
23 * @copyright 2000-2018 The FreeRADIUS server project
24 * @copyright 1999,2000 Miquel van Smoorenburg (miquels@cistron.nl)
25 * @copyright 2000 Alan DeKok (aland@freeradius.org)
26 * @copyright 2000 Alan Curry (pacman-radius@cqc.com)
27 * @copyright 2000 Jeff Carneal (jeff@apex.net)
28 * @copyright 2000 Chad Miller (cmiller@surfsouth.com)
29 */
30RCSID("$Id: db3870349b6c67a65d4bcc590f3156bbdfb8a108 $")
31
32#include <freeradius-devel/server/base.h>
33#include <freeradius-devel/server/dependency.h>
34#include <freeradius-devel/server/map_proc.h>
35#include <freeradius-devel/server/module.h>
36#include <freeradius-devel/server/radmin.h>
37#include <freeradius-devel/server/snmp.h>
38#include <freeradius-devel/server/state.h>
39#include <freeradius-devel/server/virtual_servers.h>
40#include <freeradius-devel/util/debug.h>
41#include <freeradius-devel/util/size.h>
42#include <freeradius-devel/util/strerror.h>
43
44#include <freeradius-devel/tls/base.h>
45#include <freeradius-devel/tls/log.h>
46
47#include <freeradius-devel/unlang/base.h>
48
49#include <freeradius-devel/util/misc.h>
50#include <freeradius-devel/util/syserror.h>
51
52#ifdef HAVE_CAPABILITY_H
53#include <freeradius-devel/util/cap.h>
54#endif
55
56#include <fcntl.h>
57#include <signal.h>
58#include <sys/file.h>
59#include <sys/mman.h>
60
61#ifdef HAVE_GETOPT_H
62# include <getopt.h>
63#endif
64
65#ifdef HAVE_SYS_WAIT_H
66# include <sys/wait.h>
67#endif
68#ifndef WEXITSTATUS
69# define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8)
70#endif
71#ifndef WIFEXITED
72# define WIFEXITED(stat_val) (((stat_val) & 255) == 0)
73#endif
74
75#ifdef HAVE_SYSTEMD
76# include <systemd/sd-daemon.h>
77#endif
78
79#ifdef WITH_TLS
80# include <freeradius-devel/tls/version.h>
81#endif
82
83char const *radiusd_version = RADIUSD_VERSION_BUILD("FreeRADIUS");
84static pid_t radius_pid;
85
86/*
87 * Configuration items.
88 */
89
90/*
91 * Static functions.
92 */
93static void usage(main_config_t const *config, int status);
94
95static void sig_fatal (int);
96#ifdef SIGHUP
97static void sig_hup (int);
98#endif
99
100/** Configure talloc debugging features
101 *
102 * @param[in] config The main config.
103 * @return
104 * - 1 on config conflict.
105 * - 0 on success.
106 * - -1 on error.
107 */
109{
110 if (config->spawn_workers) {
111 if (config->talloc_memory_report) {
112 fr_strerror_printf("talloc_memory_report requires single threaded mode (-s | -X)");
113 return 1;
114 }
115 return 0;
116 }
117
118 if (!config->talloc_memory_report) {
119 talloc_disable_null_tracking();
120 return 0;
121 }
122
123 talloc_enable_null_tracking();
124
125 return 0;
126}
127
128
129/** Create module and xlat per-thread instances
130 *
131 */
132static int thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el, UNUSED void *uctx)
133{
134 if (modules_rlm_thread_instantiate(ctx, el) < 0) return -1;
135
136 if (virtual_servers_thread_instantiate(ctx, el) < 0) return -1;
137
138 if (xlat_thread_instantiate(ctx, el) < 0) return -1;
139#ifdef WITH_TLS
140 if (fr_openssl_thread_init(main_config->openssl_async_pool_init,
141 main_config->openssl_async_pool_max) < 0) return -1;
142#endif
143 return 0;
144}
145
146/** Explicitly cleanup module/xlat resources
147 *
148 */
149static void thread_detach(UNUSED void *uctx)
150{
152
154
156}
157
158#define EXIT_WITH_FAILURE \
159do { \
160 ret = EXIT_FAILURE; \
161 goto cleanup; \
162} while (0)
163
164#define EXIT_WITH_SUCCESS \
165do { \
166 ret = EXIT_SUCCESS; \
167 goto cleanup; \
168} while (0)
169
171
173{
175
177 (void) fr_time_sync();
178}
179
180#ifndef NDEBUG
181/** Encourage the server to exit after a period of time
182 *
183 * @param[in] el The main loop.
184 * @param[in] now Current time. Should be 0, when adding the event.
185 * @param[in] uctx Pointer to a fr_time_delta_t indicating how long
186 * the server should run before exit.
187 */
188static void fr_exit_after(fr_event_list_t *el, fr_time_t now, void *uctx)
189{
190 static fr_event_timer_t const *ev;
191
192 fr_time_delta_t exit_after = *(fr_time_delta_t *)uctx;
193
194 if (fr_time_eq(now, fr_time_wrap(0))) {
195 if (fr_event_timer_in(el, el, &ev, exit_after, fr_exit_after, uctx) < 0) {
196 PERROR("Failed inserting exit event");
197 }
198 return;
199 }
200
202}
203#endif
204
205#ifdef HAVE_CAPABILITY_H
206#define DUMP_CAPABILITIES(_phase) \
207{ \
208 char *cap_str; \
209 if (fr_cap_set_to_str(talloc_autofree_context(), &cap_str) < 0) { \
210 PWARN("Failed retrieving %s capabilities", _phase); \
211 } else { \
212 INFO("%s capabilities: %s", _phase, cap_str); \
213 talloc_free(cap_str); \
214 } \
215}
216#else
217#define DUMP_CAPABILITIES(_phase)
218#endif
219
220/** Entry point for the daemon
221 *
222 * @hidecallgraph
223 */
224int main(int argc, char *argv[])
225{
226 int status;
227 int c;
228 bool display_version = false;
229 bool radmin = false;
230 int from_child[2] = {-1, -1};
231 char const *program;
232 fr_schedule_t *sc = NULL;
233 int ret = EXIT_SUCCESS;
234
235 TALLOC_CTX *global_ctx = NULL;
236 main_config_t *config = NULL;
237 bool talloc_memory_report = false;
238
239 bool raddb_dir_set = false;
240
241 size_t pool_size = 0;
242 void *pool_page_start = NULL;
243 size_t pool_page_len = 0;
244 bool do_mprotect;
245
246#ifndef NDEBUG
247 fr_time_delta_t exit_after = fr_time_delta_wrap(0);
248#endif
249 /*
250 * Must be called first, so the handler is called last
251 */
253
254 /*
255 * Setup talloc callbacks so we get useful errors
256 */
257 (void) fr_talloc_fault_setup();
258
259 /*
260 * We probably don't want to free the talloc global_ctx context
261 * directly, so we'll allocate a new context beneath it, and
262 * free that before any leak reports.
263 */
264 {
265 char *env;
266
267 /*
268 * If a FR_GLOBAL_POOL value is provided and
269 * is of a valid size, we pre-allocate a global
270 * memory pool, and mprotect() it once we're done
271 * parsing the global config.
272 *
273 * This lets us catch stray writes into global
274 * memory.
275 */
276 env = getenv("FR_GLOBAL_POOL");
277 if (env) {
278 if (fr_size_from_str(&pool_size, &FR_SBUFF_IN(env, strlen(env))) < 0) {
279 fr_perror("Invalid pool size string \"%s\"", env);
281 }
282
283 /*
284 * Pre-allocate a global memory pool for the static
285 * config to exist in. We mprotect() this later to
286 * catch any stray writes.
287 */
289 &pool_page_start, &pool_page_len, 0, pool_size);
290 do_mprotect = true;
291 } else {
292 global_ctx = talloc_new(talloc_autofree_context());
293 do_mprotect = false;
294 }
295
296 if (!global_ctx) {
297 fprintf(stderr, "Failed allocating global context\n");
299 }
300 }
301
302 /*
303 * Allocate the main config structure.
304 * It's allocated so we can hang talloced buffers off it.
305 */
307 if (!config) {
308 fprintf(stderr, "Failed allocating main config");
310 }
311
312 /*
313 * Set some default values
314 */
315 program = strrchr(argv[0], FR_DIR_SEP);
316 if (!program) {
317 program = argv[0];
318 } else {
319 program++;
320 }
321 main_config_name_set_default(config, program, false);
322
323 config->daemonize = true;
324 config->spawn_workers = true;
325
326#ifdef OSFC2
327 set_auth_parameters(argc, argv);
328#endif
329
330#ifdef WIN32
331 {
332 WSADATA wsaData;
333 if (WSAStartup(MAKEWORD(2, 0), &wsaData)) {
334 fprintf(stderr, "%s: Unable to initialize socket library.\n", config->name);
336 }
337 }
338#endif
339
340 fr_debug_lvl = 0;
342
343 /*
344 * Don't put output anywhere until we get told a little
345 * more.
346 */
348 default_log.fd = -1;
351
352 /*
353 * Set the panic action and enable other debugging facilities
354 */
355 if (fr_fault_setup(global_ctx, getenv("PANIC_ACTION"), argv[0]) < 0) {
356 fr_perror("Failed installing fault handlers... continuing");
357 }
358
359 /* Process the options. */
360 while ((c = getopt(argc, argv, "Cd:D:e:fhi:l:Mmn:p:PrsS:tTvxX")) != -1) switch (c) {
361 case 'C':
362 check_config = true;
363 config->spawn_workers = false;
364 config->daemonize = false;
365 break;
366
367 case 'd':
369 raddb_dir_set = true;
370 break;
371
372 case 'D':
374 break;
375
376#ifndef NDEBUG
377 case 'e':
378 exit_after = fr_time_delta_from_sec(atoi(optarg));
379 break;
380#endif
381
382 case 'f':
383 config->daemonize = false;
384 break;
385
386 case 'h':
387 usage(config, EXIT_SUCCESS);
388 break;
389
390 case 'l':
391 if (strcmp(optarg, "stdout") == 0) goto do_stdout;
392
393 config->log_file = talloc_typed_strdup(global_ctx, optarg);
396 default_log.fd = open(config->log_file, O_WRONLY | O_APPEND | O_CREAT, 0640);
397 if (default_log.fd < 0) {
398 fprintf(stderr, "%s: Failed to open log file %s: %s\n",
399 config->name, config->log_file, fr_syserror(errno));
401 }
402 break;
403
404 case 'm':
405 config->allow_multiple_procs = true;
406 break;
407
408 case 'M':
409 config->talloc_memory_report = true;
410 break;
411
412 case 'n':
414 break;
415
416 case 'P': /* Force the PID to be written, even in -f mode */
417 config->write_pid = true;
418 break;
419
420 case 'r': /* internal radmin-style control interface */
421 config->spawn_workers = false;
422 config->daemonize = false;
423 radmin = true;
424 break;
425
426 case 's': /* Single process mode */
427 config->spawn_workers = false;
428 config->daemonize = false;
429 break;
430
431 case 'S': /* Migration support */
432 if (main_config_parse_option(optarg) < 0) {
433 fprintf(stderr, "%s: Unknown configuration option '%s'\n",
434 config->name, optarg);
436 }
437 break;
438
439 case 't': /* no child threads */
440 config->spawn_workers = false;
441 break;
442
443 case 'T': /* enable timestamps */
445 break;
446
447 case 'v':
448 display_version = true;
449 break;
450
451 case 'X':
452 config->spawn_workers = false;
453 config->daemonize = false;
454 fr_debug_lvl += 2;
456
457 do_stdout:
459 default_log.fd = STDOUT_FILENO;
460 break;
461
462 case 'x':
463 fr_debug_lvl++;
465 break;
466
467 default:
468 usage(config, EXIT_FAILURE);
469 break;
470 }
471
472 /*
473 * Allow the configuration directory to be set from an
474 * environment variable. This allows tests to change the
475 * configuration directory without changing the scripts
476 * being executed.
477 */
478 if (!raddb_dir_set) {
479 char const *raddb_dir = getenv("FREERADIUS_CONFIG_DIR");
480
481 if (raddb_dir) main_config_raddb_dir_set(config, raddb_dir);
482 }
483
484 /*
485 * We've now got enough information to check to see
486 * if another process is running with the same config.
487 */
488 config->debug_level = fr_debug_lvl;
489
490 /*
491 * Mismatch between the binary and the libraries it depends on.
492 */
494 fr_perror("%s", config->name);
496 }
497
499
500#ifdef WITH_TLS
501 /*
502 * Mismatch between build time OpenSSL and linked SSL, better to die
503 * here than segfault later.
504 */
506
507 /*
508 * Initialising OpenSSL once, here, is safer than having individual modules do it.
509 * Must be called before display_version to ensure relevant engines are loaded.
510 *
511 * fr_openssl_init() must be called before *ANY* OpenSSL functions are used, which is why
512 * it's called so early.
513 */
514 if (fr_openssl_init() < 0) EXIT_WITH_FAILURE;
515#endif
516
517 /*
518 * According to the talloc peeps, no two threads may modify any part of
519 * a ctx tree with a common root without synchronisation.
520 *
521 * So we can't run with a null context and threads.
522 */
523 if (talloc_config_set(config) != 0) {
524 fr_perror("%s", config->name);
526 }
527
528 /*
529 * Better here, so it doesn't matter whether we get passed -xv or -vx.
530 */
531 if (display_version) {
532 if (fr_debug_lvl == 0) fr_debug_lvl = 1;
534 default_log.fd = STDOUT_FILENO;
535
536 INFO("%s - %s", config->name, radiusd_version);
539 }
540
542
543 /*
544 * Under linux CAP_SYS_PTRACE is usually only available before setuid/setguid,
545 * so we need to check whether we can attach before calling those functions
546 * (in main_config_init()).
547 */
549
550 /*
551 * Write the PID always if we're running as a daemon.
552 */
553 if (config->daemonize) config->write_pid = true;
554
555 /*
556 * Initialize the DL infrastructure, which is used by the
557 * config file parser. Note that we pass an empty path
558 * here, as we haven't yet read the configuration file.
559 */
560 modules_init(NULL);
561
562 /*
563 * Initialise the top level dictionary hashes which hold
564 * the protocols.
565 */
566 if (!fr_dict_global_ctx_init(NULL, true, config->dict_dir)) {
567 fr_perror("%s", program);
569 }
570
571#ifdef WITH_TLS
572 if (fr_tls_dict_init() < 0) {
573 fr_perror("%s", program);
575 }
576#endif
577
578 /*
579 * Setup the global structures for module lists
580 */
581 if (modules_rlm_init() < 0) {
582 fr_perror("%s", program);
584 }
585
586 if (virtual_servers_init() < 0) {
587 fr_perror("%s", program);
589 }
590
591 /*
592 * Load dictionary attributes used
593 * for requests.
594 */
595 if (request_global_init() < 0) {
596 fr_perror("%s", program);
598 }
599
600 /*
601 * Read the configuration files, BEFORE doing anything else.
602 */
604
605 if (!config->suppress_secrets) default_log.suppress_secrets = false;
606
607 /*
608 * Check we're the only process using this config.
609 */
610 if (!config->allow_multiple_procs) {
612 case 0: /* No other processes running */
613 break;
614
615 case -1: /* Permissions error - fail open */
616 PWARN("%s - Process concurrency checks disabled", program);
617 break;
618
619 case 1:
620 default: /* All other errors */
621 fr_perror("%s", program);
623 }
624 }
625
626 /*
627 * Set panic_action from the main config if one wasn't specified in the
628 * environment.
629 */
630 if (config->panic_action && !getenv("PANIC_ACTION") &&
631 (fr_fault_setup(global_ctx, config->panic_action, argv[0]) < 0)) {
632 fr_perror("radiusd - Failed configuring panic action: %s", config->name);
634 }
635
636 /*
637 * This is very useful in figuring out why the panic_action didn't fire.
638 */
640
641 /*
642 * Track configuration versions. This lets us know if the configuration changed.
643 */
644 if (fr_debug_lvl) {
645 uint8_t digest[16];
646
647 cf_md5_final(digest);
648
649 digest[6] &= 0x0f; /* ver is 0b0100 at bits 48:51 */
650 digest[6] |= 0x40;
651 digest[8] &= ~0xc0; /* var is 0b10 at bits 64:65 */
652 digest[8] |= 0x80;
653
654 /*
655 * UUIDv4 format: 4-2-2-2-6
656 */
657 INFO("Configuration version: %02X%02X%02X%02X-%02X%02X-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
658 digest[0], digest[1], digest[2], digest[3], digest[4], digest[5], digest[6], digest[7],
659 digest[8], digest[9], digest[10], digest[11], digest[12], digest[13], digest[14], digest[15]);
660 }
661
662 /*
663 * Call this again now we've loaded the configuration. Yes I know...
664 */
665 if (talloc_config_set(config) < 0) {
666 fr_perror("%s", config->name);
668 }
669
670 /*
671 * Check for vulnerabilities in the version of libssl were linked against.
672 */
673#ifdef WITH_TLS
674# ifdef ENABLE_OPENSSL_VERSION_CHECK
675 if (fr_openssl_version_check(config->allow_vulnerable_openssl) < 0) EXIT_WITH_FAILURE;
676# endif
677
678 /*
679 * Toggle FIPS mode
680 */
681 if (config->openssl_fips_mode_is_set &&
682 (fr_openssl_fips_mode(config->openssl_fips_mode) < 0)) EXIT_WITH_FAILURE;
683#endif
684
685 /*
686 * The systemd watchdog enablement must be checked before we
687 * daemonize, but the watchdog notifications can come from any
688 * process.
689 */
690#ifdef HAVE_SYSTEMD_WATCHDOG
691 if (!check_config) main_loop_set_sd_watchdog_interval();
692#else
693 /*
694 * If the default systemd unit file is used, but the server wasn't
695 * built with support for systemd, the status returned by systemctl
696 * will stay permanently as "activating".
697 *
698 * We detect this condition and warn about it here, using the
699 * presence of the NOTIFY_SOCKET environmental variable to determine
700 * whether we're running under systemd.
701 */
702 if (getenv("NOTIFY_SOCKET")) INFO("Built without support for systemd watchdog, but running under systemd");
703#endif
704
705 /*
706 * Don't allow radmin when checking the config.
707 */
708 if (check_config) radmin = false;
709
710 if (fr_radmin_start(config, radmin) < 0) EXIT_WITH_FAILURE;
711
712 /*
713 * Disconnect from session
714 */
715 if (config->daemonize) {
716 pid_t pid;
717 int devnull;
718
719 DUMP_CAPABILITIES("pre-fork");
720
721 /*
722 * Really weird things happen if we leave stdin open and call things like
723 * system() later.
724 */
725 devnull = open("/dev/null", O_RDWR);
726 if (devnull < 0) {
727 ERROR("Failed opening /dev/null: %s", fr_syserror(errno));
729 }
730 dup2(devnull, STDIN_FILENO);
731
732 close(devnull);
733
734 if (pipe(from_child) != 0) {
735 ERROR("Couldn't open pipe for child status: %s", fr_syserror(errno));
737 }
738
739 pid = fork();
740 if (pid < 0) {
741 ERROR("Couldn't fork: %s", fr_syserror(errno));
743 }
744
745 /*
746 * The parent exits, so the child can run in the background.
747 *
748 * As the child can still encounter an error during initialisation
749 * we do a blocking read on a pipe between it and the parent.
750 *
751 * Just before entering the event loop the child will send a success
752 * or failure message to the parent, via the pipe.
753 */
754 if (pid > 0) {
755 uint8_t child_ret;
756 int stat_loc;
757
758 /* So the pipe is correctly widowed if the child exits */
759 close(from_child[1]);
760
761 /*
762 * The child writes a 0x01 byte on success, and closes
763 * the pipe on error.
764 */
765 if ((read(from_child[0], &child_ret, 1) < 0)) child_ret = 0;
766
767 /* For cleanliness... */
768 close(from_child[0]);
769
770 /* Don't turn children into zombies */
771 if (child_ret == 0) {
772 waitpid(pid, &stat_loc, WNOHANG);
774 }
775
776#ifdef HAVE_SYSTEMD
777 /*
778 * Update the systemd MAINPID to be our child,
779 * as the parent is about to exit.
780 */
781 sd_notifyf(0, "MAINPID=%lu", (unsigned long)pid);
782#endif
783
784 goto cleanup;
785 /*
786 * The child needs to increment the semaphore as the parent
787 * is going to exit, and it will decrement the semaphore.
788 */
789 } else if (pid == 0) {
791 PWARN("%s - Failed incrementing exclusive proc semaphore in child", program);
792 }
793 }
794
795 /* so the pipe is correctly widowed if the parent exits?! */
796 close(from_child[0]);
797#ifdef HAVE_SETSID
798 setsid();
799#endif
800
801 DUMP_CAPABILITIES("post-fork");
802 } else {
803 DUMP_CAPABILITIES("pre-suid-down");
804 }
805
806 /*
807 * Ensure that we're using the CORRECT pid after forking, NOT the one
808 * we started with.
809 */
810 radius_pid = getpid();
811
812 /*
813 * Initialise the interpreter, registering operations.
814 */
816
818
819 /*
820 * Everything seems to have loaded OK, exit gracefully.
821 */
822 if (check_config) {
823 DEBUG("Configuration appears to be OK");
824 goto cleanup;
825 }
826
827 /*
828 * Initialise the SNMP stats structures
829 */
830 if (fr_snmp_init() < 0) {
831 PERROR("Failed initialising SNMP");
833 }
834
835 /*
836 * Initialize the global event loop which handles things like
837 * systemd.
838 *
839 * This has to be done post-fork in case we're using kqueue, where the
840 * queue isn't inherited by the child process.
841 */
842 if (main_loop_init() < 0) {
843 PERROR("Failed initialising main event loop");
845 }
846
847 /*
848 * Start the network / worker threads.
849 */
850 {
851 fr_event_list_t *el = NULL;
852 fr_schedule_config_t *schedule;
853
854 schedule = talloc_zero(global_ctx, fr_schedule_config_t);
855 schedule->max_workers = config->max_workers;
856 schedule->max_networks = config->max_networks;
857 schedule->stats_interval = config->stats_interval;
858
859 schedule->network.max_outstanding = config->max_requests;
860
861#define COPY(_x) schedule->worker._x = config->_x
862 COPY(max_requests);
863 COPY(max_request_time);
864
865 /*
866 * Single server mode: use the global event list.
867 * Otherwise, each network thread will create
868 * its own event list.
869 */
870 if (!config->spawn_workers) {
872 }
873
874 /*
875 * Fix spurious messages
876 */
880 if (!sc) {
881 PERROR("Failed starting the scheduler");
883 }
884
885 /*
886 * Tell the virtual servers to open their sockets.
887 */
889 }
890
891 /*
892 * At this point, no one has any business *ever* going
893 * back to root uid.
894 */
896
897 DUMP_CAPABILITIES("post-suid-down");
898
899 /*
900 * Dropping down may change the RLIMIT_CORE value, so
901 * reset it back to what to should be here.
902 */
904
905 /*
906 * If we're debugging, then a CTRL-C will cause the server to die
907 * immediately. Use SIGTERM to shut down the server cleanly in
908 * that case.
909 */
910 if (fr_set_signal(SIGINT, sig_fatal) < 0) {
911 set_signal_error:
912 PERROR("Failed installing signal handler");
914 }
915
916#ifdef SIGQUIT
917 if (fr_set_signal(SIGQUIT, sig_fatal) < 0) goto set_signal_error;
918#endif
919
920 /*
921 * Now that we've set everything up, we can install the signal
922 * handlers. Before this, if we get any signal, we don't know
923 * what to do, so we might as well do the default, and die.
924 */
925#ifdef SIGPIPE
926 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) {
927 ERROR("Failed ignoring SIGPIPE: %s", fr_syserror(errno));
928 goto cleanup;
929 }
930#endif
931
932 if (fr_set_signal(SIGHUP, sig_hup) < 0) goto set_signal_error;
933 if (fr_set_signal(SIGTERM, sig_fatal) < 0) goto set_signal_error;
934
935 /*
936 * Write the PID after we've forked, so that we write the correct one.
937 */
938 if (config->write_pid) {
939 FILE *fp;
940
941 fp = fopen(config->pid_file, "w");
942 if (fp != NULL) {
943 /*
944 * @fixme What about following symlinks,
945 * and having it over-write a normal file?
946 */
947 fprintf(fp, "%d\n", (int) radius_pid);
948 fclose(fp);
949 } else {
950 ERROR("Failed creating PID file %s: %s", config->pid_file, fr_syserror(errno));
952 }
953 }
954
955 trigger_exec(NULL, NULL, "server.start", false, NULL);
956
957 /*
958 * Inform the parent (who should still be waiting) that the rest of
959 * initialisation went OK, and that it should exit with a 0 status.
960 * If we don't get this far, then we just close the pipe on exit, and the
961 * parent gets a read failure.
962 */
963 if (config->daemonize) {
964 if (write(from_child[1], "\001", 1) < 0) {
965 WARN("Failed informing parent of successful start: %s",
966 fr_syserror(errno));
967 }
968 close(from_child[1]);
969 }
970
971 /*
972 * Clear the libfreeradius error buffer.
973 */
975
976 /*
977 * Prevent anything from modifying the dictionaries
978 * they're now immutable.
979 */
981
982 /*
983 * Protect global memory - If something attempts
984 * to write to this memory we get a SIGBUS.
985 */
986 if (do_mprotect) {
987 if (mprotect(pool_page_start, pool_page_len, PROT_READ) < 0) {
988 PERROR("Protecting global memory failed: %s", fr_syserror(errno));
990 }
991 DEBUG("Global memory protected");
992 }
993
995#ifndef NDEBUG
996 if (fr_time_delta_ispos(exit_after)) fr_exit_after(main_loop_event_list(), fr_time_wrap(0), &exit_after);
997#endif
998 /*
999 * Process requests until HUP or exit.
1000 */
1001 INFO("Ready to process requests"); /* we were actually ready a while ago, but oh well */
1002 while ((status = main_loop_start()) == 0x80) {
1004 }
1005
1006 /*
1007 * Ignore the TERM signal: we're about to die.
1008 */
1009 if (unlikely(signal(SIGTERM, SIG_IGN) == SIG_ERR)) {
1010 ERROR("Failed blocking SIGTERM, we may receive spurious signals: %s",
1011 fr_syserror(errno));
1012 }
1013
1014 /*
1015 * Unprotect global memory
1016 */
1017 if (do_mprotect) {
1018 if (mprotect(pool_page_start, pool_page_len,
1019 PROT_READ | PROT_WRITE) < 0) {
1020 PERROR("Unprotecting global memory failed: %s", fr_syserror(errno));
1022 }
1023 DEBUG("Global memory unprotected");
1024 }
1025
1026 if (status < 0) {
1027 PERROR("Exiting due to internal error");
1028 ret = EXIT_FAILURE;
1029 } else {
1030 INFO("Exiting normally");
1031 ret = EXIT_SUCCESS;
1032 }
1033
1035
1036 /*
1037 * Fire signal and stop triggers after ignoring SIGTERM, so handlers are
1038 * not killed with the rest of the process group, below.
1039 */
1040 if (status == 2) trigger_exec(NULL, NULL, "server.signal.term", true, NULL);
1041 trigger_exec(NULL, NULL, "server.stop", false, NULL);
1042
1043 /*
1044 * Stop the scheduler, this signals the network and worker threads
1045 * to exit gracefully. fr_schedule_destroy only returns once all
1046 * threads have been joined.
1047 */
1048 (void) fr_schedule_destroy(&sc);
1049
1050 /*
1051 * We're exiting, so we can delete the PID file.
1052 * (If it doesn't exist, we can ignore the error returned by unlink)
1053 */
1054 if (config->daemonize) {
1055 DEBUG3("Unlinking PID file %s", config->pid_file);
1056 unlink(config->pid_file);
1057 }
1058
1059 /*
1060 * Free memory in an explicit and consistent order
1061 *
1062 * We could let everything be freed by the global_ctx
1063 * context, but in some cases there are odd interactions
1064 * with destructors that may cause double frees and
1065 * SEGVs.
1066 */
1067 if (!config->spawn_workers) {
1069
1072 }
1073
1075
1076 /*
1077 * Send a TERM signal to all associated processes
1078 * (including us, which gets ignored.)
1079 *
1080 * This _shouldn't_ be needed, but may help with
1081 * processes created by the exec code or triggers.
1082 */
1083 if (config->spawn_workers) {
1084 INFO("All threads have exited, sending SIGTERM to remaining children");
1085
1086 /*
1087 * If pid is negative, but not -1, sig
1088 * shall be sent to all processes
1089 * (excluding an unspecified set of system processes)
1090 * whose process group ID is equal to the absolute value
1091 * of pid, and for which the process has permission
1092 * to send a signal.
1093 */
1094 kill(-getpgid(radius_pid), SIGTERM);
1095 }
1096
1097 /*
1098 * Remove the semaphore, allowing other processes
1099 * to start. We do this before the cleanup label
1100 * as the parent process MUST NOT call this
1101 * function as it exits, otherwise the semaphore
1102 * is removed and there's no exclusivity.
1103 */
1105
1106cleanup:
1107 /*
1108 * This may not have been done earlier if we're
1109 * exiting due to a startup error.
1110 */
1111 (void) fr_schedule_destroy(&sc);
1112
1113 /*
1114 * Ensure all thread local memory is cleaned up
1115 * before we start cleaning up global resources.
1116 * This is necessary for single threaded mode
1117 * to ensure that thread local resources that
1118 * depend on global resources are freed at the
1119 * appropriate time.
1120 */
1122
1123 server_free();
1124
1125#ifdef WITH_TLS
1126 fr_openssl_free(); /* Cleanup any memory alloced by OpenSSL and placed into globals */
1127#endif
1128
1129 if (config) talloc_memory_report = config->talloc_memory_report; /* Grab this before we free the config */
1130
1131 /*
1132 * Virtual servers need to be freed before modules
1133 * as state entries containing data with module-specific
1134 * destructors may exist.
1135 */
1137
1138 /*
1139 * Free modules, this needs to be done explicitly
1140 * because some libraries used by modules use atexit
1141 * handlers registered after ours, and they may deinit
1142 * themselves before we free the modules and cause
1143 * crashes on exit.
1144 */
1146
1147#ifdef WITH_TLS
1148 fr_tls_dict_free();
1149#endif
1150
1151 /*
1152 * And now nothing should be left anywhere except the
1153 * parsed configuration items.
1154 */
1156
1157 /*
1158 * Cleanup everything else
1159 */
1160 if (talloc_free(global_ctx) < 0) {
1161#ifndef NDEBUG
1162 fr_perror("radiusd");
1163 ret = EXIT_FAILURE;
1164#endif
1165 }
1166
1167 /*
1168 * Anything not cleaned up by the above is allocated in
1169 * the NULL top level context, and is likely leaked memory.
1170 */
1171 if (talloc_memory_report) fr_log_talloc_report(NULL);
1172
1173 /*
1174 * If we're running under LSAN, try and SUID back up so
1175 * we don't inteferere with the onexit() handler.
1176 */
1178 fr_strerror_clear(); /* clear error buffer */
1179
1180 /*
1181 * Ensure our atexit handlers run before any other
1182 * atexit handlers registered by third party libraries.
1183 */
1185
1186 return ret;
1187}
1188
1189/*
1190 * Display the syntax for starting this program.
1191 */
1192static NEVER_RETURNS void usage(main_config_t const *config, int status)
1193{
1194 FILE *output = status ? stderr : stdout;
1195
1196 fprintf(output, "Usage: %s [options]\n", config->name);
1197 fprintf(output, "Options:\n");
1198 fprintf(output, " -C Check configuration and exit.\n");
1199 fprintf(stderr, " -d <raddb> Set configuration directory (defaults to " RADDBDIR ").\n");
1200 fprintf(stderr, " -D <dictdir> Set main dictionary directory (defaults to " DICTDIR ").\n");
1201#ifndef NDEBUG
1202 fprintf(output, " -e <seconds> Exit after the specified number of seconds. Useful for diagnosing \"crash-on-exit\" issues.\n");
1203#endif
1204 fprintf(output, " -f Run as a foreground process, not a daemon.\n");
1205 fprintf(output, " -h Print this help message.\n");
1206 fprintf(output, " -l <log_file> Logging output will be written to this file.\n");
1207#ifndef NDEBUG
1208 fprintf(output, " -L <size> When running in memory debug mode, set a hard limit on talloced memory\n");
1209#endif
1210 fprintf(output, " -n <name> Read raddb/name.conf instead of raddb/radiusd.conf.\n");
1211 fprintf(output, " -m Allow multiple processes reading the same radiusd.conf to exist simultaneously.\n");
1212#ifndef NDEBUG
1213 fprintf(output, " -M Enable talloc memory debugging, and issue a memory report when the server terminates\n");
1214#endif
1215 fprintf(output, " -P Always write out PID, even with -f.\n");
1216 fprintf(output, " -s Do not spawn child processes to handle requests (same as -ft).\n");
1217 fprintf(output, " -t Disable threads.\n");
1218 fprintf(output, " -T Prepend timestamps to log messages.\n");
1219 fprintf(output, " -v Print server version information.\n");
1220 fprintf(output, " -X Turn on full debugging (similar to -tfxxl stdout).\n");
1221 fprintf(output, " -x Turn on additional debugging (-xx gives more debugging).\n");
1222 fr_exit(status);
1223}
1224
1225
1226/*
1227 * We got a fatal signal.
1228 */
1229static void sig_fatal(int sig)
1230{
1231 static int last_sig;
1232
1233 if (getpid() != radius_pid) _exit(sig);
1234
1235 /*
1236 * Suppress duplicate signals.
1237 *
1238 * For some reason on macOS we get multiple signals
1239 * for the same event (SIGINT).
1240 *
1241 * ...this also fixes the problem of the user hammering
1242 * Ctrl-C and causing ungraceful exits as we try and
1243 * write out signals to a pipe that's already closed.
1244 */
1245 if (sig == last_sig) return;
1246 last_sig = sig;
1247
1248 switch (sig) {
1249 case SIGTERM:
1251 break;
1252
1253 case SIGINT:
1254#ifdef SIGQUIT
1255 case SIGQUIT:
1256#endif
1258 break;
1259
1260 default:
1261 fr_exit(sig);
1262 }
1263}
1264
1265#ifdef SIGHUP
1266/*
1267 * We got the hangup signal.
1268 * Re-read the configuration files.
1269 */
1270static void sig_hup(UNUSED int sig)
1271{
1272 reset_signal(SIGHUP, sig_hup);
1273
1275}
1276#endif
int fr_atexit_global_setup(void)
Setup the atexit handler, should be called at the start of a program's execution.
Definition atexit.c:160
int fr_atexit_global_trigger_all(void)
Cause all global free triggers to fire.
Definition atexit.c:286
#define fr_atexit_thread_trigger_all(...)
Definition atexit.h:233
void fr_radmin_stop(void)
Definition radmin.c:1101
int fr_radmin_start(main_config_t *config, bool cli)
Definition radmin.c:1064
#define RCSID(id)
Definition build.h:483
#define NEVER_RETURNS
Should be placed before the function return type.
Definition build.h:313
#define unlikely(_x)
Definition build.h:381
#define UNUSED
Definition build.h:315
bool check_config
Definition cf_file.c:67
void cf_md5_final(uint8_t *digest)
Definition cf_file.c:3093
char const * fr_debug_state_to_msg(fr_debug_state_t state)
Return current value of debug_state.
Definition debug.c:541
int fr_log_talloc_report(TALLOC_CTX const *ctx)
Generate a talloc memory report for a context and print to stderr/stdout.
Definition debug.c:1147
int fr_reset_dumpable(void)
Reset dumpable state to previously configured value.
Definition debug.c:890
int fr_fault_setup(TALLOC_CTX *ctx, char const *cmd, char const *program)
Registers signal handlers to execute panic_action on fatal signal.
Definition debug.c:1242
int fr_get_lsan_state(void)
Definition debug.c:261
void fr_debug_state_store(void)
Should be run before using setuid or setgid to get useful results.
Definition debug.c:521
void fr_talloc_fault_setup(void)
Register talloc fault handlers.
Definition debug.c:1223
fr_debug_state_t fr_debug_state
Whether we're attached to by a debugger.
Definition debug.c:104
#define fr_exit(_x)
Exit, producing a log message in debug builds.
Definition debug.h:228
void dependency_version_print(void)
Definition dependency.c:376
int rad_check_lib_magic(uint64_t magic)
Check if the application linking to the library has the correct magic number.
Definition dependency.c:71
#define ERROR(fmt,...)
Definition dhcpclient.c:41
#define DEBUG(fmt,...)
Definition dhcpclient.c:39
static NEVER_RETURNS void usage(void)
Definition dhcpclient.c:114
fr_dict_gctx_t * fr_dict_global_ctx_init(TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir)
Initialise the global protocol hashes.
Definition dict_util.c:4392
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4585
void fr_dict_global_ctx_read_only(void)
Mark all dictionaries and the global dictionary ctx as read only.
Definition dict_util.c:4503
fr_dict_t const * fr_dict_internal(void)
Definition dict_util.c:4610
#define fr_event_timer_in(...)
Definition event.h:255
uint32_t max_outstanding
Definition network.h:46
int server_init(CONF_SECTION *cs, char const *dict_dir, fr_dict_t *dict)
Initialize src/lib/server/.
Definition base.c:49
void server_free(void)
Free src/lib/server/.
Definition base.c:139
#define PERROR(_fmt,...)
Definition log.h:228
#define DEBUG3(_fmt,...)
Definition log.h:266
#define PWARN(_fmt,...)
Definition log.h:227
void rad_suid_up(void)
Definition util.c:896
bool rad_suid_is_down_permanent(void)
Return whether we've permanently dropped root privileges.
Definition util.c:917
void(*)(int) reset_signal(int signo, void(*func)(int))
Definition util.c:55
void rad_suid_down_permanent(void)
Definition util.c:905
int unlang_global_init(void)
Definition base.c:133
waitpid(reap->pid_ev->pid, &status, 0)
talloc_free(reap)
void fr_event_loop_exit(fr_event_list_t *el, int code)
Signal an event loop exit with the specified code.
Definition event.c:2744
Stores all information relating to an event list.
Definition event.c:411
A timer event.
Definition event.c:102
int fr_debug_lvl
Definition log.c:43
static FILE * devnull
File handle for /dev/null.
Definition log.c:59
fr_log_t default_log
Definition log.c:291
@ L_DST_NULL
Discard log messages.
Definition log.h:83
@ L_DST_FILES
Log to a file on disk.
Definition log.h:79
@ L_DST_STDOUT
Log to stdout.
Definition log.h:78
@ L_TIMESTAMP_ON
Always log timestamps.
Definition log.h:90
int main_config_parse_option(char const *value)
int main_config_free(main_config_t **config)
main_config_t * main_config_alloc(TALLOC_CTX *ctx)
Allocate a main_config_t struct, setting defaults.
void main_config_raddb_dir_set(main_config_t *config, char const *name)
Set the global radius config directory.
void main_config_exclusive_proc_done(UNUSED main_config_t const *config)
Clean up the semaphore when the main config is freed.
void main_config_hup(main_config_t *config)
int main_config_exclusive_proc(main_config_t *config)
Check to see if we're the only process using this configuration file (or PID file if specified)
void main_config_name_set_default(main_config_t *config, char const *name, bool overwrite_config)
Set the server name.
int main_config_init(main_config_t *config)
main_config_t const * main_config
Main server configuration.
Definition main_config.c:69
int main_config_exclusive_proc_child(UNUSED main_config_t const *config)
Increment the semaphore in the child process so that it's not released when the parent exits.
void main_config_dict_dir_set(main_config_t *config, char const *name)
Set the global dictionary directory.
Main server configuration.
Definition main_config.h:51
int main_loop_start(void)
Definition main_loop.c:195
fr_event_list_t * main_loop_event_list(void)
Return the main loop event list.
Definition main_loop.c:165
void main_loop_signal_raise(int flag)
Definition main_loop.c:79
int main_loop_init(void)
Initialise the main event loop, setting up signal handlers.
Definition main_loop.c:254
void main_loop_free(void)
Definition main_loop.c:190
@ RADIUS_SIGNAL_SELF_HUP
Definition main_loop.h:36
@ RADIUS_SIGNAL_SELF_TERM
Definition main_loop.h:37
unsigned char uint8_t
int fr_set_signal(int sig, sig_t func)
Sets a signal handler using sigaction if available, else signal.
Definition misc.c:47
void modules_rlm_thread_detach(void)
Frees thread-specific data for all registered backend modules.
Definition module_rlm.c:963
int modules_rlm_free(void)
Cleanup all global structures.
int modules_rlm_thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el)
Allocates thread-specific data for all registered backend modules.
Definition module_rlm.c:976
int modules_rlm_init(void)
Initialise the module list structure.
static const conf_parser_t config[]
Definition base.c:183
#define WARN(fmt,...)
Definition radclient.h:47
#define INFO(fmt,...)
Definition radict.c:54
int main(int argc, char *argv[])
Entry point for the daemon.
Definition radiusd.c:224
static void thread_detach(UNUSED void *uctx)
Explicitly cleanup module/xlat resources.
Definition radiusd.c:149
static fr_event_timer_t const * fr_time_sync_ev
Definition radiusd.c:170
static void fr_exit_after(fr_event_list_t *el, fr_time_t now, void *uctx)
Encourage the server to exit after a period of time.
Definition radiusd.c:188
#define COPY(_x)
#define DUMP_CAPABILITIES(_phase)
Definition radiusd.c:217
#define EXIT_WITH_SUCCESS
Definition radiusd.c:164
char const * radiusd_version
Definition radiusd.c:83
static void fr_time_sync_event(fr_event_list_t *el, UNUSED fr_time_t now, UNUSED void *uctx)
Definition radiusd.c:172
static int thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el, UNUSED void *uctx)
Create module and xlat per-thread instances.
Definition radiusd.c:132
static int talloc_config_set(main_config_t *config)
Configure talloc debugging features.
Definition radiusd.c:108
static void sig_fatal(int)
Definition radiusd.c:1229
static pid_t radius_pid
Definition radiusd.c:84
#define EXIT_WITH_FAILURE
Definition radiusd.c:158
static bool cleanup
Definition radsniff.c:60
int request_global_init(void)
Definition request.c:722
#define FR_SBUFF_IN(_start, _len_or_end)
fr_schedule_t * fr_schedule_create(TALLOC_CTX *ctx, fr_event_list_t *el, fr_log_t *logger, fr_log_lvl_t lvl, fr_schedule_thread_instantiate_t worker_thread_instantiate, fr_schedule_thread_detach_t worker_thread_detach, fr_schedule_config_t *config)
Create a scheduler and spawn the child threads.
Definition schedule.c:463
int fr_schedule_destroy(fr_schedule_t **sc_to_free)
Destroy a scheduler, and tell its child threads to exit.
Definition schedule.c:761
The scheduler.
Definition schedule.c:125
fr_network_config_t network
configuration for each network;
Definition schedule.h:68
uint32_t max_workers
number of network threads
Definition schedule.h:65
fr_time_delta_t stats_interval
print channel statistics
Definition schedule.h:70
uint32_t max_networks
number of network threads
Definition schedule.h:64
Signals that can be sent to a request.
fr_slen_t fr_size_from_str(size_t *out, fr_sbuff_t *in)
Parse a size string with optional unit.
Definition size.c:40
static const uchar sc[16]
Definition smbdes.c:115
int fr_snmp_init(void)
Initialise the tree of SNMP map structures used to attach callbacks to OIDs.
Definition snmp.c:1130
void modules_init(char const *lib_dir)
Perform global initialisation for modules.
Definition module.c:1910
#define fr_time()
Allow us to arbitrarily manipulate time.
Definition state_test.c:8
fr_log_dst_t dst
Log destination.
Definition log.h:97
int fd
File descriptor to write messages to.
Definition log.h:112
fr_log_timestamp_t timestamp
Prefix log messages with timestamps.
Definition log.h:110
bool suppress_secrets
suppress secrets when printing to this destination
Definition log.h:108
char const * file
Path to log file.
Definition log.h:113
bool print_level
sometimes we don't want log levels printed
Definition log.h:106
char const * fr_syserror(int num)
Guaranteed to be thread-safe version of strerror.
Definition syserror.c:243
static TALLOC_CTX * global_ctx
Definition talloc.c:36
TALLOC_CTX * talloc_page_aligned_pool(TALLOC_CTX *ctx, void **start, size_t *end_len, unsigned int headers, size_t size)
Return a page aligned talloc memory pool.
Definition talloc.c:312
char * talloc_typed_strdup(TALLOC_CTX *ctx, char const *p)
Call talloc_strdup, setting the type on the new chunk correctly.
Definition talloc.c:445
#define talloc_autofree_context
The original function is deprecated, so replace it with our version.
Definition talloc.h:51
int fr_time_sync(void)
Get a new fr_time_monotonic_to_realtime value.
Definition time.c:102
int fr_time_start(void)
Initialize the local time.
Definition time.c:150
static fr_time_delta_t fr_time_delta_from_sec(int64_t sec)
Definition time.h:590
#define fr_time_delta_wrap(_time)
Definition time.h:152
#define fr_time_wrap(_time)
Definition time.h:145
#define fr_time_delta_ispos(_a)
Definition time.h:290
#define fr_time_eq(_a, _b)
Definition time.h:241
A time delta, a difference in time measured in nanoseconds.
Definition time.h:80
"server local" time.
Definition time.h:69
int fr_openssl_version_consistent(void)
Definition version.c:246
int trigger_exec(unlang_interpret_t *intp, CONF_SECTION const *cs, char const *name, bool rate_limit, fr_pair_list_t *args)
Execute a trigger - call an executable to process an event.
Definition trigger.c:233
close(uq->fd)
static fr_event_list_t * el
void xlat_thread_detach(void)
Destroy any thread specific xlat instances.
Definition xlat_inst.c:489
int xlat_thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el)
Create thread specific instance tree and create thread instances.
Definition xlat_inst.c:444
void fr_perror(char const *fmt,...)
Print the current error to stderr with a prefix.
Definition strerror.c:733
void fr_strerror_clear(void)
Clears all pending messages from the talloc pools.
Definition strerror.c:577
#define fr_strerror_printf(_fmt,...)
Log to thread local error buffer.
Definition strerror.h:64
int fr_check_lib_magic(uint64_t magic)
Check if the application linking to the library has the correct magic number.
Definition version.c:40
#define RADIUSD_VERSION_BUILD(_x)
Create a version string for a utility in the suite of FreeRADIUS utilities.
Definition version.h:58
#define RADIUSD_MAGIC_NUMBER
Definition version.h:81
int virtual_servers_open(fr_schedule_t *sc)
Open all the listen sockets.
void virtual_servers_thread_detach(void)
Free thread-specific data for all process modules and listeners.
int virtual_servers_init(void)
Performs global initialisation for the virtual server code.
int virtual_servers_free(void)
int virtual_servers_thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el)
Perform thread instantiation for all process modules and listeners.