2 tincd.c -- the main file for tincd
3 Copyright (C) 1998-2005 Ivo Timmermans
4 2000-2021 Guus Sliepen <guus@tinc-vpn.org>
5 2008 Max Rijevski <maksuf@gmail.com>
6 2009 Michael Tokarev <mjt@tls.msk.ru>
7 2010 Julien Muchembled <jm@jmuchemb.eu>
8 2010 Timothy Redaelli <timothy@redaelli.eu>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License along
21 with this program; if not, write to the Free Software Foundation, Inc.,
22 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 /* Darwin (MacOS/X) needs the following definition... */
28 #ifndef _P1003_1B_VISIBLE
29 #define _P1003_1B_VISIBLE
32 #ifdef HAVE_SYS_MMAN_H
62 /* If nonzero, display usage information and exit. */
63 static bool show_help = false;
65 /* If nonzero, print the version on standard output and exit. */
66 static bool show_version = false;
68 /* If nonzero, use null ciphers and skip all key exchanges. */
69 bool bypass_security = false;
72 /* If nonzero, disable swapping for this process. */
73 static bool do_mlock = false;
77 /* If nonzero, chroot to netdir after startup. */
78 static bool do_chroot = false;
80 /* If !NULL, do setuid to given user after startup */
81 static const char *switchuser = NULL;
84 /* If nonzero, write log entries to a separate file. */
85 bool use_logfile = false;
87 /* If nonzero, use syslog instead of stderr in no-detach mode. */
88 bool use_syslog = false;
90 char **g_argv; /* a copy of the cmdline arguments */
92 static int status = 1;
94 static struct option const long_options[] = {
95 {"config", required_argument, NULL, 'c'},
96 {"net", required_argument, NULL, 'n'},
97 {"help", no_argument, NULL, 1},
98 {"version", no_argument, NULL, 2},
99 {"no-detach", no_argument, NULL, 'D'},
100 {"debug", optional_argument, NULL, 'd'},
101 {"bypass-security", no_argument, NULL, 3},
102 {"mlock", no_argument, NULL, 'L'},
103 {"chroot", no_argument, NULL, 'R'},
104 {"user", required_argument, NULL, 'U'},
105 {"logfile", optional_argument, NULL, 4},
106 {"syslog", no_argument, NULL, 's'},
107 {"pidfile", required_argument, NULL, 5},
108 {"option", required_argument, NULL, 'o'},
113 static struct WSAData wsa_state;
114 int main2(int argc, char **argv);
117 static void usage(bool status) {
119 fprintf(stderr, "Try `%s --help\' for more information.\n",
122 printf("Usage: %s [option]...\n\n", program_name);
123 printf(" -c, --config=DIR Read configuration options from DIR.\n"
124 " -D, --no-detach Don't fork and detach.\n"
125 " -d, --debug[=LEVEL] Increase debug level or set it to LEVEL.\n"
126 " -n, --net=NETNAME Connect to net NETNAME.\n"
128 " -L, --mlock Lock tinc into main memory.\n"
130 " --logfile[=FILENAME] Write log entries to a logfile.\n"
131 " -s --syslog Use syslog instead of stderr with --no-detach.\n"
132 " --pidfile=FILENAME Write PID and control socket cookie to FILENAME.\n"
133 " --bypass-security Disables meta protocol security, for debugging.\n"
134 " -o, --option[HOST.]KEY=VALUE Set global/host configuration value.\n"
136 " -R, --chroot chroot to NET dir at startup.\n"
137 " -U, --user=USER setuid to given USER at startup.\n"
139 " --help Display this help and exit.\n"
140 " --version Output version information and exit.\n\n");
141 printf("Report bugs to tinc@tinc-vpn.org.\n");
145 static bool parse_options(int argc, char **argv) {
148 int option_index = 0;
151 cmdline_conf = list_alloc((list_action_t)free_config);
153 while((r = getopt_long(argc, argv, "c:DLd::n:so:RU:", long_options, &option_index)) != EOF) {
155 case 0: /* long option */
158 case 'c': /* config file */
160 confbase = xstrdup(optarg);
163 case 'D': /* no detach */
167 case 'L': /* no detach */
168 #ifndef HAVE_MLOCKALL
169 logger(DEBUG_ALWAYS, LOG_ERR, "The %s option is not supported on this platform.", argv[optind - 1]);
176 case 'd': /* increase debug level */
177 if(!optarg && optind < argc && *argv[optind] != '-') {
178 optarg = argv[optind++];
182 debug_level = atoi(optarg);
189 case 'n': /* net name given */
191 netname = xstrdup(optarg);
194 case 's': /* syslog */
199 case 'o': /* option */
200 cfg = parse_config_line(optarg, NULL, ++lineno);
206 list_insert_tail(cmdline_conf, cfg);
213 logger(DEBUG_ALWAYS, LOG_ERR, "The %s option is not supported on this platform.", argv[optind - 1]);
217 case 'R': /* chroot to NETNAME dir */
221 case 'U': /* setuid to USER */
226 case 1: /* show help */
230 case 2: /* show version */
234 case 3: /* bypass security */
235 bypass_security = true;
238 case 4: /* write log entries to a file */
242 if(!optarg && optind < argc && *argv[optind] != '-') {
243 optarg = argv[optind++];
248 logfilename = xstrdup(optarg);
253 case 5: /* open control socket here */
255 pidfilename = xstrdup(optarg);
258 case '?': /* wrong options */
268 fprintf(stderr, "%s: unrecognized argument '%s'\n", argv[0], argv[optind]);
273 if(!netname && (netname = getenv("NETNAME"))) {
274 netname = xstrdup(netname);
277 /* netname "." is special: a "top-level name" */
279 if(netname && (!*netname || !strcmp(netname, "."))) {
284 if(netname && !check_netname(netname, false)) {
285 fprintf(stderr, "Invalid character in netname!\n");
289 if(netname && !check_netname(netname, true)) {
290 fprintf(stderr, "Warning: unsafe character in netname!\n");
297 list_delete_list(cmdline_conf);
302 static bool drop_privs(void) {
307 struct passwd *pw = getpwnam(switchuser);
310 logger(DEBUG_ALWAYS, LOG_ERR, "unknown user `%s'", switchuser);
316 // The second parameter to initgroups on macOS requires int,
317 // but __gid_t is unsigned int. There's not much we can do here.
318 if(initgroups(switchuser, pw->pw_gid) != 0 || // NOLINT(bugprone-narrowing-conversions)
319 setgid(pw->pw_gid) != 0) {
320 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
321 "initgroups", strerror(errno));
326 // Not supported in android NDK
333 tzset(); /* for proper timestamps in logs */
335 if(chroot(confbase) != 0 || chdir("/") != 0) {
336 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
337 "chroot", strerror(errno));
342 confbase = xstrdup("");
346 if(setuid(uid) != 0) {
347 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
348 "setuid", strerror(errno));
357 # define setpriority(level) !SetPriorityClass(GetCurrentProcess(), (level))
359 static void stop_handler(void *data, int flags) {
366 static BOOL WINAPI console_ctrl_handler(DWORD type) {
369 logger(DEBUG_ALWAYS, LOG_NOTICE, "Got console shutdown request");
371 if(WSASetEvent(stop_io.event) == FALSE) {
378 # define NORMAL_PRIORITY_CLASS 0
379 # define BELOW_NORMAL_PRIORITY_CLASS 10
380 # define HIGH_PRIORITY_CLASS -10
381 # define setpriority(level) (setpriority(PRIO_PROCESS, 0, (level)))
384 static void cleanup() {
386 exit_configuration(&config_tree);
389 list_delete_list(cmdline_conf);
393 int main(int argc, char **argv) {
394 program_name = argv[0];
396 if(!parse_options(argc, argv)) {
401 printf("%s version %s (built %s %s, protocol %d.%d)\n", PACKAGE,
402 BUILD_VERSION, BUILD_DATE, BUILD_TIME, PROT_MAJOR, PROT_MINOR);
407 #ifdef HAVE_LIBGCRYPT
419 #ifndef DISABLE_LEGACY
422 #ifdef ENABLE_JUMBOGRAMS
428 #ifdef HAVE_MINIUPNPC
438 printf("Copyright (C) 1998-2021 Ivo Timmermans, Guus Sliepen and others.\n"
439 "See the AUTHORS file for a complete list.\n\n"
440 "tinc comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
441 "and you are welcome to redistribute it under certain conditions;\n"
442 "see the file COPYING for details.\n");
459 if(WSAStartup(MAKEWORD(2, 2), &wsa_state)) {
460 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "WSAStartup", winerror(GetLastError()));
465 // Check if we got an umbilical fd from the process that started us
466 char *umbstr = getenv("TINC_UMBILICAL");
469 umbilical = atoi(umbstr);
471 if(fcntl(umbilical, F_GETFL) < 0) {
478 fcntl(umbilical, F_SETFD, FD_CLOEXEC);
486 openlogger("tinc", use_logfile ? LOGMODE_FILE : LOGMODE_STDERR);
490 if(getenv("LISTEN_PID") && atoi(getenv("LISTEN_PID")) == getpid()) {
495 unsetenv("LISTEN_PID");
498 init_configuration(&config_tree);
500 /* Slllluuuuuuurrrrp! */
502 gettimeofday(&now, NULL);
503 srand(now.tv_sec + now.tv_usec);
506 if(!read_server_config(config_tree)) {
510 if(debug_level == DEBUG_NOTHING) {
513 if(get_config_int(lookup_config(config_tree, "LogLevel"), &level)) {
520 if(lzo_init() != LZO_E_OK) {
521 logger(DEBUG_ALWAYS, LOG_ERR, "Error initializing LZO compressor!");
528 io_add_event(&stop_io, stop_handler, NULL, WSACreateEvent());
530 if(stop_io.event == FALSE) {
536 if(!do_detach || !init_service()) {
537 SetConsoleCtrlHandler(console_ctrl_handler, TRUE);
538 result = main2(argc, argv);
543 if(WSACloseEvent(stop_io.event) == FALSE) {
551 int main2(int argc, char **argv) {
555 char *priority = NULL;
563 /* Lock all pages into memory if requested.
564 * This has to be done after daemon()/fork() so it works for child.
565 * No need to do that in parent as it's very short-lived. */
566 if(do_mlock && mlockall(MCL_CURRENT | MCL_FUTURE) != 0) {
567 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "mlockall",
574 /* Setup sockets and open device. */
576 if(!setup_network()) {
580 /* Change process priority */
582 if(get_config_string(lookup_config(config_tree, "ProcessPriority"), &priority)) {
583 if(!strcasecmp(priority, "Normal")) {
584 if(setpriority(NORMAL_PRIORITY_CLASS) != 0) {
585 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
588 } else if(!strcasecmp(priority, "Low")) {
589 if(setpriority(BELOW_NORMAL_PRIORITY_CLASS) != 0) {
590 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
593 } else if(!strcasecmp(priority, "High")) {
594 if(setpriority(HIGH_PRIORITY_CLASS) != 0) {
595 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
599 logger(DEBUG_ALWAYS, LOG_ERR, "Invalid priority `%s`!", priority);
604 /* drop privileges */
609 /* Start main loop. It only exits when tinc is killed. */
611 logger(DEBUG_ALWAYS, LOG_NOTICE, "Ready");
613 if(umbilical) { // snip!
614 write(umbilical, "", 1);
619 try_outgoing_connections();
621 status = main_loop();
623 /* Shutdown properly. */
626 close_network_connections();
628 logger(DEBUG_ALWAYS, LOG_NOTICE, "Terminating");