2 tincd.c -- the main file for tincd
3 Copyright (C) 1998-2005 Ivo Timmermans
4 2000-2017 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
36 #include <openssl/rand.h>
37 #include <openssl/rsa.h>
38 #include <openssl/pem.h>
39 #include <openssl/evp.h>
40 #include <openssl/engine.h>
52 #ifdef HAVE_GETOPT_LONG
70 /* The name this program was run with. */
71 char *program_name = NULL;
73 /* If nonzero, display usage information and exit. */
74 bool show_help = false;
76 /* If nonzero, print the version on standard output and exit. */
77 bool show_version = false;
79 /* If nonzero, it will attempt to kill a running tincd and exit. */
82 /* If nonzero, generate public/private keypair for this host/net. */
83 int generate_keys = 0;
85 /* If nonzero, use null ciphers and skip all key exchanges. */
86 bool bypass_security = false;
88 /* If nonzero, disable swapping for this process. */
89 bool do_mlock = false;
91 /* If nonzero, chroot to netdir after startup. */
92 static bool do_chroot = false;
94 /* If !NULL, do setuid to given user after startup */
95 static const char *switchuser = NULL;
97 /* If nonzero, write log entries to a separate file. */
98 bool use_logfile = false;
100 char *identname = NULL; /* program name for syslog */
101 char *pidfilename = NULL; /* pid file location */
102 char *logfilename = NULL; /* log file location */
103 char **g_argv; /* a copy of the cmdline arguments */
105 static int status = 1;
107 static struct option const long_options[] = {
108 {"config", required_argument, NULL, 'c'},
109 {"kill", optional_argument, NULL, 'k'},
110 {"net", required_argument, NULL, 'n'},
111 {"help", no_argument, NULL, 1},
112 {"version", no_argument, NULL, 2},
113 {"no-detach", no_argument, NULL, 'D'},
114 {"generate-keys", optional_argument, NULL, 'K'},
115 {"debug", optional_argument, NULL, 'd'},
116 {"bypass-security", no_argument, NULL, 3},
117 {"mlock", no_argument, NULL, 'L'},
118 {"chroot", no_argument, NULL, 'R'},
119 {"user", required_argument, NULL, 'U'},
120 {"logfile", optional_argument, NULL, 4},
121 {"pidfile", required_argument, NULL, 5},
122 {"option", required_argument, NULL, 'o'},
127 static struct WSAData wsa_state;
128 CRITICAL_SECTION mutex;
129 int main2(int argc, char **argv);
132 static void usage(bool status) {
134 fprintf(stderr, "Try `%s --help\' for more information.\n",
137 printf("Usage: %s [option]...\n\n", program_name);
138 printf(" -c, --config=DIR Read configuration options from DIR.\n"
139 " -D, --no-detach Don't fork and detach.\n"
140 " -d, --debug[=LEVEL] Increase debug level or set it to LEVEL.\n"
141 " -k, --kill[=SIGNAL] Attempt to kill a running tincd and exit.\n"
142 " -n, --net=NETNAME Connect to net NETNAME.\n"
143 " -K, --generate-keys[=BITS] Generate public/private RSA keypair.\n"
144 " -L, --mlock Lock tinc into main memory.\n"
145 " --logfile[=FILENAME] Write log entries to a logfile.\n"
146 " --pidfile=FILENAME Write PID to FILENAME.\n"
147 " -o, --option=[HOST.]KEY=VALUE Set global/host configuration value.\n"
148 " -R, --chroot chroot to NET dir at startup.\n"
149 " -U, --user=USER setuid to given USER at startup.\n"
150 " --help Display this help and exit.\n"
151 " --version Output version information and exit.\n\n");
152 printf("Report bugs to tinc@tinc-vpn.org.\n");
156 static bool parse_options(int argc, char **argv) {
159 int option_index = 0;
162 cmdline_conf = list_alloc((list_action_t)free_config);
164 while((r = getopt_long(argc, argv, "c:DLd::k::n:o:K::RU:", long_options, &option_index)) != EOF) {
166 case 0: /* long option */
169 case 'c': /* config file */
171 fprintf(stderr, "Only one configuration directory can be given.\n");
175 confbase = xstrdup(optarg);
178 case 'D': /* no detach */
182 case 'L': /* no detach */
183 #ifndef HAVE_MLOCKALL
184 logger(LOG_ERR, "%s not supported on this platform", "mlockall()");
191 case 'd': /* increase debug level */
192 if(!optarg && optind < argc && *argv[optind] != '-')
193 optarg = argv[optind++];
195 debug_level = atoi(optarg);
200 case 'k': /* kill old tincds */
202 if(!optarg && optind < argc && *argv[optind] != '-')
203 optarg = argv[optind++];
205 if(!strcasecmp(optarg, "HUP"))
207 else if(!strcasecmp(optarg, "TERM"))
208 kill_tincd = SIGTERM;
209 else if(!strcasecmp(optarg, "KILL"))
210 kill_tincd = SIGKILL;
211 else if(!strcasecmp(optarg, "USR1"))
212 kill_tincd = SIGUSR1;
213 else if(!strcasecmp(optarg, "USR2"))
214 kill_tincd = SIGUSR2;
215 else if(!strcasecmp(optarg, "WINCH"))
216 kill_tincd = SIGWINCH;
217 else if(!strcasecmp(optarg, "INT"))
219 else if(!strcasecmp(optarg, "ALRM"))
220 kill_tincd = SIGALRM;
221 else if(!strcasecmp(optarg, "ABRT"))
222 kill_tincd = SIGABRT;
224 kill_tincd = atoi(optarg);
227 fprintf(stderr, "Invalid argument `%s'; SIGNAL must be a number or one of HUP, TERM, KILL, USR1, USR2, WINCH, INT or ALRM.\n",
234 kill_tincd = SIGTERM;
240 case 'n': /* net name given */
241 /* netname "." is special: a "top-level name" */
243 fprintf(stderr, "Only one netname can be given.\n");
247 if(optarg && strcmp(optarg, "."))
248 netname = xstrdup(optarg);
251 case 'o': /* option */
252 cfg = parse_config_line(optarg, NULL, ++lineno);
255 list_insert_tail(cmdline_conf, cfg);
258 case 'K': /* generate public/private keypair */
259 if(!optarg && optind < argc && *argv[optind] != '-')
260 optarg = argv[optind++];
262 generate_keys = atoi(optarg);
264 if(generate_keys < 512) {
265 fprintf(stderr, "Invalid argument `%s'; BITS must be a number equal to or greater than 512.\n",
271 generate_keys &= ~7; /* Round it to bytes */
273 generate_keys = 2048;
276 case 'R': /* chroot to NETNAME dir */
280 case 'U': /* setuid to USER */
284 case 1: /* show help */
288 case 2: /* show version */
292 case 3: /* bypass security */
293 bypass_security = true;
296 case 4: /* write log entries to a file */
298 if(!optarg && optind < argc && *argv[optind] != '-')
299 optarg = argv[optind++];
302 fprintf(stderr, "Only one logfile can be given.\n");
306 logfilename = xstrdup(optarg);
310 case 5: /* write PID to a file */
312 fprintf(stderr, "Only one pidfile can be given.\n");
316 pidfilename = xstrdup(optarg);
329 fprintf(stderr, "%s: unrecognized argument '%s'\n", argv[0], argv[optind]);
337 /* This function prettyprints the key generation process */
339 static int indicator(int a, int b, BN_GENCB *cb) {
342 fprintf(stderr, ".");
346 fprintf(stderr, "+");
350 fprintf(stderr, "-");
356 fprintf(stderr, " p\n");
360 fprintf(stderr, " q\n");
364 fprintf(stderr, "?");
369 fprintf(stderr, "?");
375 #ifndef HAVE_BN_GENCB_NEW
376 BN_GENCB *BN_GENCB_new(void) {
377 return xmalloc_and_zero(sizeof(BN_GENCB));
380 void BN_GENCB_free(BN_GENCB *cb) {
386 Generate a public/private RSA keypair, and ask for a file to store
389 static bool keygen(int bits) {
393 char filename[PATH_MAX];
397 fprintf(stderr, "Generating %d bits keys:\n", bits);
402 BN_GENCB_set(cb, indicator, NULL);
405 BN_hex2bn(&e, "10001");
409 result = RSA_generate_key_ex(rsa_key, bits, e, cb);
415 fprintf(stderr, "Error during key generation!\n");
419 fprintf(stderr, "Done.\n");
421 snprintf(filename, sizeof filename, "%s/rsa_key.priv", confbase);
422 f = ask_and_open(filename, "private RSA key");
430 /* Make it unreadable for others. */
431 fchmod(fileno(f), 0600);
435 PEM_write_RSAPrivateKey(f, rsa_key, NULL, NULL, 0, NULL, NULL);
438 char *name = get_name();
441 snprintf(filename, sizeof filename, "%s/hosts/%s", confbase, name);
444 snprintf(filename, sizeof filename, "%s/rsa_key.pub", confbase);
447 f = ask_and_open(filename, "public RSA key");
455 PEM_write_RSAPublicKey(f, rsa_key);
464 Set all files and paths according to netname
466 static void make_names(void) {
469 char installdir[1024] = "";
470 DWORD len = sizeof(installdir);
474 xasprintf(&identname, "tinc.%s", netname);
476 identname = xstrdup("tinc");
479 if(!RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\tinc", 0, KEY_READ, &key)) {
480 if(!RegQueryValueEx(key, NULL, 0, 0, (LPBYTE)installdir, &len)) {
483 xasprintf(&confbase, "%s/%s", installdir, netname);
485 xasprintf(&confbase, "%s", installdir);
488 xasprintf(&logfilename, "%s/tinc.log", confbase);
497 xasprintf(&pidfilename, LOCALSTATEDIR "/run/%s.pid", identname);
500 xasprintf(&logfilename, LOCALSTATEDIR "/log/%s.log", identname);
504 xasprintf(&confbase, CONFDIR "/tinc/%s", netname);
506 logger(LOG_INFO, "Both netname and configuration directory given, using the latter...");
509 xasprintf(&confbase, CONFDIR "/tinc");
513 static void free_names() {
514 if (identname) free(identname);
515 if (netname) free(netname);
516 if (pidfilename) free(pidfilename);
517 if (logfilename) free(logfilename);
518 if (confbase) free(confbase);
521 static bool drop_privs() {
524 logger(LOG_ERR, "%s not supported on this platform", "-U");
528 logger(LOG_ERR, "%s not supported on this platform", "-R");
534 struct passwd *pw = getpwnam(switchuser);
536 logger(LOG_ERR, "unknown user `%s'", switchuser);
540 if (initgroups(switchuser, pw->pw_gid) != 0 ||
541 setgid(pw->pw_gid) != 0) {
542 logger(LOG_ERR, "System call `%s' failed: %s",
543 "initgroups", strerror(errno));
547 // Not supported in android NDK
553 tzset(); /* for proper timestamps in logs */
554 if (chroot(confbase) != 0 || chdir("/") != 0) {
555 logger(LOG_ERR, "System call `%s' failed: %s",
556 "chroot", strerror(errno));
560 confbase = xstrdup("");
563 if (setuid(uid) != 0) {
564 logger(LOG_ERR, "System call `%s' failed: %s",
565 "setuid", strerror(errno));
573 # define setpriority(level) !SetPriorityClass(GetCurrentProcess(), (level))
575 # define NORMAL_PRIORITY_CLASS 0
576 # define BELOW_NORMAL_PRIORITY_CLASS 10
577 # define HIGH_PRIORITY_CLASS -10
578 # define setpriority(level) (setpriority(PRIO_PROCESS, 0, (level)))
581 int main(int argc, char **argv) {
582 program_name = argv[0];
584 if(!parse_options(argc, argv))
590 printf("%s version %s\n", PACKAGE, VERSION);
591 printf("Copyright (C) 1998-2017 Ivo Timmermans, Guus Sliepen and others.\n"
592 "See the AUTHORS file for a complete list.\n\n"
593 "tinc comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
594 "and you are welcome to redistribute it under certain conditions;\n"
595 "see the file COPYING for details.\n");
606 return !kill_other(kill_tincd);
608 openlogger("tinc", use_logfile?LOGMODE_FILE:LOGMODE_STDERR);
612 if(getenv("LISTEN_PID") && atoi(getenv("LISTEN_PID")) == getpid())
615 unsetenv("LISTEN_PID");
618 init_configuration(&config_tree);
620 /* Slllluuuuuuurrrrp! */
622 RAND_load_file("/dev/urandom", 1024);
624 ENGINE_load_builtin_engines();
625 ENGINE_register_all_complete();
627 OpenSSL_add_all_algorithms();
630 read_server_config();
631 return !keygen(generate_keys);
634 if(!read_server_config())
638 if(lzo_init() != LZO_E_OK) {
639 logger(LOG_ERR, "Error initializing LZO compressor!");
645 if(WSAStartup(MAKEWORD(2, 2), &wsa_state)) {
646 logger(LOG_ERR, "System call `%s' failed: %s", "WSAStartup", winerror(GetLastError()));
650 if(!do_detach || !init_service())
651 return main2(argc, argv);
656 int main2(int argc, char **argv) {
657 InitializeCriticalSection(&mutex);
658 EnterCriticalSection(&mutex);
660 char *priority = NULL;
666 /* Lock all pages into memory if requested.
667 * This has to be done after daemon()/fork() so it works for child.
668 * No need to do that in parent as it's very short-lived. */
669 if(do_mlock && mlockall(MCL_CURRENT | MCL_FUTURE) != 0) {
670 logger(LOG_ERR, "System call `%s' failed: %s", "mlockall",
676 /* Setup sockets and open device. */
681 /* Initiate all outgoing connections. */
683 try_outgoing_connections();
685 /* Change process priority */
687 if(get_config_string(lookup_config(config_tree, "ProcessPriority"), &priority)) {
688 if(!strcasecmp(priority, "Normal")) {
689 if (setpriority(NORMAL_PRIORITY_CLASS) != 0) {
690 logger(LOG_ERR, "System call `%s' failed: %s",
691 "setpriority", strerror(errno));
694 } else if(!strcasecmp(priority, "Low")) {
695 if (setpriority(BELOW_NORMAL_PRIORITY_CLASS) != 0) {
696 logger(LOG_ERR, "System call `%s' failed: %s",
697 "setpriority", strerror(errno));
700 } else if(!strcasecmp(priority, "High")) {
701 if (setpriority(HIGH_PRIORITY_CLASS) != 0) {
702 logger(LOG_ERR, "System call `%s' failed: %s",
703 "setpriority", strerror(errno));
707 logger(LOG_ERR, "Invalid priority `%s`!", priority);
712 /* drop privileges */
716 /* Start main loop. It only exits when tinc is killed. */
718 status = main_loop();
720 /* Shutdown properly. */
725 close_network_connections();
728 logger(LOG_NOTICE, "Terminating");
731 remove_pid(pidfilename);
738 CRYPTO_cleanup_all_ex_data();
739 #ifdef HAVE_ERR_REMOVE_STATE
740 // OpenSSL claims this function was deprecated in 1.0.0,
741 // but valgrind's leak detector shows you still need to call it to make sure OpenSSL cleans up properly.
746 exit_configuration(&config_tree);
747 list_delete_list(cmdline_conf);