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
65 /* If nonzero, display usage information and exit. */
66 static bool show_help = false;
68 /* If nonzero, print the version on standard output and exit. */
69 static bool show_version = false;
71 /* If nonzero, use null ciphers and skip all key exchanges. */
72 bool bypass_security = false;
75 /* If nonzero, disable swapping for this process. */
76 static bool do_mlock = false;
80 /* If nonzero, chroot to netdir after startup. */
81 static bool do_chroot = false;
83 /* If !NULL, do setuid to given user after startup */
84 static const char *switchuser = NULL;
87 /* If nonzero, write log entries to a separate file. */
88 bool use_logfile = false;
90 /* If nonzero, use syslog instead of stderr in no-detach mode. */
91 bool use_syslog = false;
93 char **g_argv; /* a copy of the cmdline arguments */
95 static int status = 1;
97 static struct option const long_options[] = {
98 {"config", required_argument, NULL, 'c'},
99 {"net", required_argument, NULL, 'n'},
100 {"help", no_argument, NULL, 1},
101 {"version", no_argument, NULL, 2},
102 {"no-detach", no_argument, NULL, 'D'},
103 {"debug", optional_argument, NULL, 'd'},
104 {"bypass-security", no_argument, NULL, 3},
105 {"mlock", no_argument, NULL, 'L'},
106 {"chroot", no_argument, NULL, 'R'},
107 {"user", required_argument, NULL, 'U'},
108 {"logfile", optional_argument, NULL, 4},
109 {"syslog", no_argument, NULL, 's'},
110 {"pidfile", required_argument, NULL, 5},
111 {"option", required_argument, NULL, 'o'},
116 static struct WSAData wsa_state;
117 int main2(int argc, char **argv);
120 static void usage(bool status) {
122 fprintf(stderr, "Try `%s --help\' for more information.\n",
125 printf("Usage: %s [option]...\n\n", program_name);
126 printf(" -c, --config=DIR Read configuration options from DIR.\n"
127 " -D, --no-detach Don't fork and detach.\n"
128 " -d, --debug[=LEVEL] Increase debug level or set it to LEVEL.\n"
129 " -n, --net=NETNAME Connect to net NETNAME.\n"
131 " -L, --mlock Lock tinc into main memory.\n"
133 " --logfile[=FILENAME] Write log entries to a logfile.\n"
134 " -s --syslog Use syslog instead of stderr with --no-detach.\n"
135 " --pidfile=FILENAME Write PID and control socket cookie to FILENAME.\n"
136 " --bypass-security Disables meta protocol security, for debugging.\n"
137 " -o, --option[HOST.]KEY=VALUE Set global/host configuration value.\n"
139 " -R, --chroot chroot to NET dir at startup.\n"
140 " -U, --user=USER setuid to given USER at startup.\n"
142 " --help Display this help and exit.\n"
143 " --version Output version information and exit.\n\n");
144 printf("Report bugs to tinc@tinc-vpn.org.\n");
148 static bool parse_options(int argc, char **argv) {
151 int option_index = 0;
154 cmdline_conf = list_alloc((list_action_t)free_config);
156 while((r = getopt_long(argc, argv, "c:DLd::n:so:RU:", long_options, &option_index)) != EOF) {
158 case 0: /* long option */
161 case 'c': /* config file */
163 confbase = xstrdup(optarg);
166 case 'D': /* no detach */
170 case 'L': /* no detach */
171 #ifndef HAVE_MLOCKALL
172 logger(DEBUG_ALWAYS, LOG_ERR, "The %s option is not supported on this platform.", argv[optind - 1]);
179 case 'd': /* increase debug level */
180 if(!optarg && optind < argc && *argv[optind] != '-') {
181 optarg = argv[optind++];
185 debug_level = atoi(optarg);
192 case 'n': /* net name given */
194 netname = xstrdup(optarg);
197 case 's': /* syslog */
202 case 'o': /* option */
203 cfg = parse_config_line(optarg, NULL, ++lineno);
209 list_insert_tail(cmdline_conf, cfg);
216 logger(DEBUG_ALWAYS, LOG_ERR, "The %s option is not supported on this platform.", argv[optind - 1]);
220 case 'R': /* chroot to NETNAME dir */
224 case 'U': /* setuid to USER */
229 case 1: /* show help */
233 case 2: /* show version */
237 case 3: /* bypass security */
238 bypass_security = true;
241 case 4: /* write log entries to a file */
245 if(!optarg && optind < argc && *argv[optind] != '-') {
246 optarg = argv[optind++];
251 logfilename = xstrdup(optarg);
256 case 5: /* open control socket here */
258 pidfilename = xstrdup(optarg);
261 case '?': /* wrong options */
271 fprintf(stderr, "%s: unrecognized argument '%s'\n", argv[0], argv[optind]);
276 if(!netname && (netname = getenv("NETNAME"))) {
277 netname = xstrdup(netname);
280 /* netname "." is special: a "top-level name" */
282 if(netname && (!*netname || !strcmp(netname, "."))) {
287 if(netname && !check_netname(netname, false)) {
288 fprintf(stderr, "Invalid character in netname!\n");
292 if(netname && !check_netname(netname, true)) {
293 fprintf(stderr, "Warning: unsafe character in netname!\n");
300 list_delete_list(cmdline_conf);
305 static bool drop_privs(void) {
310 struct passwd *pw = getpwnam(switchuser);
313 logger(DEBUG_ALWAYS, LOG_ERR, "unknown user `%s'", switchuser);
319 if(initgroups(switchuser, pw->pw_gid) != 0 ||
320 setgid(pw->pw_gid) != 0) {
321 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
322 "initgroups", strerror(errno));
327 // Not supported in android NDK
334 tzset(); /* for proper timestamps in logs */
336 if(chroot(confbase) != 0 || chdir("/") != 0) {
337 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
338 "chroot", strerror(errno));
343 confbase = xstrdup("");
347 if(setuid(uid) != 0) {
348 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s",
349 "setuid", strerror(errno));
358 # define setpriority(level) !SetPriorityClass(GetCurrentProcess(), (level))
360 static void stop_handler(void *data, int flags) {
367 static BOOL WINAPI console_ctrl_handler(DWORD type) {
370 logger(DEBUG_ALWAYS, LOG_NOTICE, "Got console shutdown request");
372 if(WSASetEvent(stop_io.event) == FALSE) {
379 # define NORMAL_PRIORITY_CLASS 0
380 # define BELOW_NORMAL_PRIORITY_CLASS 10
381 # define HIGH_PRIORITY_CLASS -10
382 # define setpriority(level) (setpriority(PRIO_PROCESS, 0, (level)))
385 static void cleanup() {
387 exit_configuration(&config_tree);
390 list_delete_list(cmdline_conf);
394 int main(int argc, char **argv) {
395 program_name = argv[0];
397 if(!parse_options(argc, argv)) {
402 printf("%s version %s (built %s %s, protocol %d.%d)\n", PACKAGE,
403 BUILD_VERSION, BUILD_DATE, BUILD_TIME, PROT_MAJOR, PROT_MINOR);
408 #ifdef HAVE_LIBGCRYPT
420 #ifndef DISABLE_LEGACY
423 #ifdef ENABLE_JUMBOGRAMS
429 #ifdef HAVE_MINIUPNPC
439 printf("Copyright (C) 1998-2021 Ivo Timmermans, Guus Sliepen and others.\n"
440 "See the AUTHORS file for a complete list.\n\n"
441 "tinc comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
442 "and you are welcome to redistribute it under certain conditions;\n"
443 "see the file COPYING for details.\n");
460 if(WSAStartup(MAKEWORD(2, 2), &wsa_state)) {
461 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "WSAStartup", winerror(GetLastError()));
466 // Check if we got an umbilical fd from the process that started us
467 char *umbstr = getenv("TINC_UMBILICAL");
470 umbilical = atoi(umbstr);
472 if(fcntl(umbilical, F_GETFL) < 0) {
479 fcntl(umbilical, F_SETFD, FD_CLOEXEC);
487 openlogger("tinc", use_logfile ? LOGMODE_FILE : LOGMODE_STDERR);
491 if(getenv("LISTEN_PID") && atoi(getenv("LISTEN_PID")) == getpid()) {
496 unsetenv("LISTEN_PID");
499 init_configuration(&config_tree);
501 /* Slllluuuuuuurrrrp! */
503 gettimeofday(&now, NULL);
504 srand(now.tv_sec + now.tv_usec);
507 if(!read_server_config(config_tree)) {
512 get_config_int(lookup_config(config_tree, "LogLevel"), &debug_level);
517 if(lzo_init() != LZO_E_OK) {
518 logger(DEBUG_ALWAYS, LOG_ERR, "Error initializing LZO compressor!");
525 io_add_event(&stop_io, stop_handler, NULL, WSACreateEvent());
527 if(stop_io.event == FALSE) {
533 if(!do_detach || !init_service()) {
534 SetConsoleCtrlHandler(console_ctrl_handler, TRUE);
535 result = main2(argc, argv);
540 if(WSACloseEvent(stop_io.event) == FALSE) {
548 int main2(int argc, char **argv) {
552 char *priority = NULL;
560 /* Lock all pages into memory if requested.
561 * This has to be done after daemon()/fork() so it works for child.
562 * No need to do that in parent as it's very short-lived. */
563 if(do_mlock && mlockall(MCL_CURRENT | MCL_FUTURE) != 0) {
564 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "mlockall",
571 /* Setup sockets and open device. */
573 if(!setup_network()) {
577 /* Change process priority */
579 if(get_config_string(lookup_config(config_tree, "ProcessPriority"), &priority)) {
580 if(!strcasecmp(priority, "Normal")) {
581 if(setpriority(NORMAL_PRIORITY_CLASS) != 0) {
582 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
585 } else if(!strcasecmp(priority, "Low")) {
586 if(setpriority(BELOW_NORMAL_PRIORITY_CLASS) != 0) {
587 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
590 } else if(!strcasecmp(priority, "High")) {
591 if(setpriority(HIGH_PRIORITY_CLASS) != 0) {
592 logger(DEBUG_ALWAYS, LOG_ERR, "System call `%s' failed: %s", "setpriority", strerror(errno));
596 logger(DEBUG_ALWAYS, LOG_ERR, "Invalid priority `%s`!", priority);
601 /* drop privileges */
606 /* Start main loop. It only exits when tinc is killed. */
608 logger(DEBUG_ALWAYS, LOG_NOTICE, "Ready");
610 if(umbilical) { // snip!
611 write(umbilical, "", 1);
616 try_outgoing_connections();
618 status = main_loop();
620 /* Shutdown properly. */
623 close_network_connections();
625 logger(DEBUG_ALWAYS, LOG_NOTICE, "Terminating");