2 tincd.c -- the main file for tincd
3 Copyright (C) 1998-2005 Ivo Timmermans
4 2000-2022 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
59 /* If nonzero, display usage information and exit. */
60 static bool show_help = false;
62 /* If nonzero, print the version on standard output and exit. */
63 static bool show_version = false;
66 /* If nonzero, disable swapping for this process. */
67 static bool do_mlock = false;
71 /* If nonzero, chroot to netdir after startup. */
72 static bool do_chroot = false;
74 /* If !NULL, do setuid to given user after startup */
75 static const char *switchuser = NULL;
78 char **g_argv; /* a copy of the cmdline arguments */
80 static int status = 1;
82 typedef enum option_t {
87 OPT_CONFIG_FILE = 'c',
93 OPT_CHANGE_USER = 'U',
105 static struct option const long_options[] = {
106 {"config", required_argument, NULL, OPT_CONFIG_FILE},
107 {"net", required_argument, NULL, OPT_NETNAME},
108 {"no-detach", no_argument, NULL, OPT_NO_DETACH},
109 {"debug", optional_argument, NULL, OPT_DEBUG},
110 {"mlock", no_argument, NULL, OPT_MLOCK},
111 {"chroot", no_argument, NULL, OPT_CHROOT},
112 {"user", required_argument, NULL, OPT_CHANGE_USER},
113 {"syslog", no_argument, NULL, OPT_SYSLOG},
114 {"option", required_argument, NULL, OPT_OPTION},
115 {"help", no_argument, NULL, OPT_HELP},
116 {"version", no_argument, NULL, OPT_VERSION},
117 {"bypass-security", no_argument, NULL, OPT_NO_SECURITY},
118 {"logfile", optional_argument, NULL, OPT_LOGFILE},
119 {"pidfile", required_argument, NULL, OPT_PIDFILE},
124 static struct WSAData wsa_state;
125 int main2(int argc, char **argv);
128 static void usage(bool status) {
130 fprintf(stderr, "Try `%s --help\' for more information.\n",
133 static const char *message =
134 "Usage: %s [option]...\n"
136 " -c, --config=DIR Read configuration options from DIR.\n"
137 " -D, --no-detach Don't fork and detach.\n"
138 " -d, --debug[=LEVEL] Increase debug level or set it to LEVEL.\n"
139 " -n, --net=NETNAME Connect to net NETNAME.\n"
141 " -L, --mlock Lock tinc into main memory.\n"
143 " --logfile[=FILENAME] Write log entries to a logfile.\n"
144 " -s --syslog Use syslog instead of stderr with --no-detach.\n"
145 " --pidfile=FILENAME Write PID and control socket cookie to FILENAME.\n"
146 " --bypass-security Disables meta protocol security, for debugging.\n"
147 " -o, --option[HOST.]KEY=VALUE Set global/host configuration value.\n"
149 " -R, --chroot chroot to NET dir at startup.\n"
150 " -U, --user=USER setuid to given USER at startup.\n"
152 " --help Display this help and exit.\n"
153 " --version Output version information and exit.\n"
155 "Report bugs to tinc@tinc-vpn.org.\n";
157 printf(message, program_name);
161 // Try to resolve path to absolute, return a copy of the argument if this fails.
162 static char *get_path_arg(char *arg) {
163 char *result = absolute_path(arg);
166 result = xstrdup(arg);
172 static bool parse_options(int argc, char **argv) {
175 int option_index = 0;
178 while((r = getopt_long(argc, argv, "c:DLd::n:so:RU:", long_options, &option_index)) != EOF) {
179 switch((option_t) r) {
180 case OPT_LONG_OPTION:
187 case OPT_CONFIG_FILE:
189 confbase = get_path_arg(optarg);
196 case OPT_MLOCK: /* lock tincd into RAM */
197 #ifndef HAVE_MLOCKALL
198 logger(DEBUG_ALWAYS, LOG_ERR, "The %s option is not supported on this platform.", argv[optind - 1]);
205 case OPT_DEBUG: /* increase debug level */
206 if(!optarg && optind < argc && *argv[optind] != '-') {
207 optarg = argv[optind++];
211 debug_level = atoi(optarg);
220 netname = xstrdup(optarg);
229 cfg = parse_config_line(optarg, NULL, ++lineno);
235 list_insert_tail(&cmdline_conf, cfg);
240 case OPT_CHANGE_USER:
242 logger(DEBUG_ALWAYS, LOG_ERR, "The %s option is not supported on this platform.", argv[optind - 1]);
250 case OPT_CHANGE_USER:
263 case OPT_NO_SECURITY:
264 bypass_security = true;
271 if(!optarg && optind < argc && *argv[optind] != '-') {
272 optarg = argv[optind++];
277 logfilename = get_path_arg(optarg);
284 pidfilename = get_path_arg(optarg);
293 fprintf(stderr, "%s: unrecognized argument '%s'\n", argv[0], argv[optind]);
298 if(!netname && (netname = getenv("NETNAME"))) {
299 netname = xstrdup(netname);
302 /* netname "." is special: a "top-level name" */
304 if(netname && (!*netname || !strcmp(netname, "."))) {
309 if(netname && !check_netname(netname, false)) {
310 fprintf(stderr, "Invalid character in netname!\n");
314 if(netname && !check_netname(netname, true)) {
315 fprintf(stderr, "Warning: unsafe character in netname!\n");
322 list_empty_list(&cmdline_conf);
326 static bool drop_privs(void) {
331 struct passwd *pw = getpwnam(switchuser);
334 logger(DEBUG_ALWAYS, LOG_ERR, "unknown user `%s'", switchuser);
340 // The second parameter to initgroups on macOS requires int,
341 // but __gid_t is unsigned int. There's not much we can do here.
342 if(initgroups(switchuser, pw->pw_gid) != 0 || // NOLINT(bugprone-narrowing-conversions)
343 setgid(pw->pw_gid) != 0) {
344 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
345 "initgroups", strerror(errno));
350 // Not supported in android NDK
357 tzset(); /* for proper timestamps in logs */
359 if(chroot(confbase) != 0 || chdir("/") != 0) {
360 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
361 "chroot", strerror(errno));
366 confbase = xstrdup("");
370 if(setuid(uid) != 0) {
371 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
372 "setuid", strerror(errno));
381 # define setpriority(level) !SetPriorityClass(GetCurrentProcess(), (level))
383 static void stop_handler(void *data, int flags) {
390 static BOOL WINAPI console_ctrl_handler(DWORD type) {
393 logger(DEBUG_ALWAYS, LOG_NOTICE, "Got console shutdown request");
395 if(WSASetEvent(stop_io.event) == FALSE) {
402 # define NORMAL_PRIORITY_CLASS 0
403 # define BELOW_NORMAL_PRIORITY_CLASS 10
404 # define HIGH_PRIORITY_CLASS -10
405 # define setpriority(level) (setpriority(PRIO_PROCESS, 0, (level)))
408 static void cleanup(void) {
409 splay_empty_tree(&config_tree);
410 list_empty_list(&cmdline_conf);
414 int main(int argc, char **argv) {
415 program_name = argv[0];
417 if(!parse_options(argc, argv)) {
422 static const char *message =
423 "%s version %s (built %s %s, protocol %d.%d)\n"
428 #ifdef HAVE_LIBGCRYPT
440 #ifndef DISABLE_LEGACY
443 #ifdef ENABLE_JUMBOGRAMS
449 #ifdef HAVE_MINIUPNPC
459 "Copyright (C) 1998-2021 Ivo Timmermans, Guus Sliepen and others.\n"
460 "See the AUTHORS file for a complete list.\n"
462 "tinc comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
463 "and you are welcome to redistribute it under certain conditions;\n"
464 "see the file COPYING for details.\n";
466 printf(message, PACKAGE, BUILD_VERSION, BUILD_DATE, BUILD_TIME, PROT_MAJOR, PROT_MINOR);
478 if(chdir(confbase) == -1) {
479 logger(DEBUG_ALWAYS, LOG_ERR, "Could not change to configuration directory: %s", strerror(errno));
485 if(WSAStartup(MAKEWORD(2, 2), &wsa_state)) {
486 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "WSAStartup", winerror(GetLastError()));
491 // Check if we got an umbilical fd from the process that started us
492 char *umbstr = getenv("TINC_UMBILICAL");
496 sscanf(umbstr, "%d %d", &umbilical, &colorize);
497 umbilical_colorize = colorize;
499 if(fcntl(umbilical, F_GETFL) < 0) {
506 fcntl(umbilical, F_SETFD, FD_CLOEXEC);
514 openlogger("tinc", use_logfile ? LOGMODE_FILE : LOGMODE_STDERR);
518 if(getenv("LISTEN_PID") && atoi(getenv("LISTEN_PID")) == getpid()) {
523 unsetenv("LISTEN_PID");
526 gettimeofday(&now, NULL);
531 if(!read_server_config(&config_tree)) {
535 if(debug_level == DEBUG_NOTHING) {
538 if(get_config_int(lookup_config(&config_tree, "LogLevel"), &level)) {
545 if(lzo_init() != LZO_E_OK) {
546 logger(DEBUG_ALWAYS, LOG_ERR, "Error initializing LZO compressor!");
553 io_add_event(&stop_io, stop_handler, NULL, WSACreateEvent());
555 if(stop_io.event == FALSE) {
561 if(!do_detach || !init_service()) {
562 SetConsoleCtrlHandler(console_ctrl_handler, TRUE);
563 result = main2(argc, argv);
568 if(WSACloseEvent(stop_io.event) == FALSE) {
576 int main2(int argc, char **argv) {
580 char *priority = NULL;
588 /* Lock all pages into memory if requested.
589 * This has to be done after daemon()/fork() so it works for child.
590 * No need to do that in parent as it's very short-lived. */
591 if(do_mlock && mlockall(MCL_CURRENT | MCL_FUTURE) != 0) {
592 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "mlockall",
599 /* Setup sockets and open device. */
601 if(!setup_network()) {
605 /* Change process priority */
607 if(get_config_string(lookup_config(&config_tree, "ProcessPriority"), &priority)) {
608 if(!strcasecmp(priority, "Normal")) {
609 if(setpriority(NORMAL_PRIORITY_CLASS) != 0) {
610 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
613 } else if(!strcasecmp(priority, "Low")) {
614 if(setpriority(BELOW_NORMAL_PRIORITY_CLASS) != 0) {
615 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
618 } else if(!strcasecmp(priority, "High")) {
619 if(setpriority(HIGH_PRIORITY_CLASS) != 0) {
620 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
624 logger(DEBUG_ALWAYS, LOG_ERR, "Invalid priority `%s`!", priority);
629 /* drop privileges */
634 /* Start main loop. It only exits when tinc is killed. */
636 logger(DEBUG_ALWAYS, LOG_NOTICE, "Ready");
638 if(umbilical) { // snip!
639 if(write(umbilical, "", 1) != 1) {
640 // Pipe full or broken, nothing we can do about it.
647 try_outgoing_connections();
649 status = main_loop();
651 /* Shutdown properly. */
654 close_network_connections();
656 logger(DEBUG_ALWAYS, LOG_NOTICE, "Terminating");