2 tincctl.c -- Controlling a running tincd
3 Copyright (C) 2007-2011 Guus Sliepen <guus@tinc-vpn.org>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include "control_common.h"
32 /* The name this program was run with. */
33 static char *program_name = NULL;
35 /* If nonzero, display usage information and exit. */
36 static bool show_help = false;
38 /* If nonzero, print the version on standard output and exit. */
39 static bool show_version = false;
41 static char *name = NULL;
42 static char *identname = NULL; /* program name for syslog */
43 static char *controlcookiename = NULL; /* cookie file location */
44 static char controlcookie[1024];
46 char *confbase = NULL;
47 static char *host = NULL;
50 static struct WSAData wsa_state;
53 static struct option const long_options[] = {
54 {"config", required_argument, NULL, 'c'},
55 {"host", required_argument, NULL, 'h'},
56 {"net", required_argument, NULL, 'n'},
57 {"help", no_argument, NULL, 1},
58 {"version", no_argument, NULL, 2},
59 {"controlcookie", required_argument, NULL, 5},
63 static void usage(bool status) {
65 fprintf(stderr, "Try `%s --help\' for more information.\n",
68 printf("Usage: %s [options] command\n\n", program_name);
69 printf("Valid options are:\n"
70 " -c, --config=DIR Read configuration options from DIR.\n"
71 " -n, --net=NETNAME Connect to net NETNAME.\n"
72 " --controlcookie=FILENAME Read control socket from FILENAME.\n"
73 " --help Display this help and exit.\n"
74 " --version Output version information and exit.\n"
76 "Valid commands are:\n"
77 " start Start tincd.\n"
79 " restart Restart tincd.\n"
80 " reload Reload configuration of running tincd.\n"
81 " pid Show PID of currently running tincd.\n"
82 " generate-keys [bits] Generate a new public/private keypair.\n"
83 " dump Dump a list of one of the following things:\n"
84 " nodes - all known nodes in the VPN\n"
85 " edges - all known connections in the VPN\n"
86 " subnets - all known subnets in the VPN\n"
87 " connections - all meta connections with ourself\n"
88 " graph - graph of the VPN in dotty format\n"
89 " purge Purge unreachable nodes\n"
90 " debug N Set debug level\n"
91 " retry Retry all outgoing connections\n"
92 " reload Partial reload of configuration\n"
93 " disconnect NODE Close meta connection with NODE\n"
95 " top Show real-time statistics\n"
97 " pcap Dump traffic in pcap format\n"
99 printf("Report bugs to tinc@tinc-vpn.org.\n");
103 static bool parse_options(int argc, char **argv) {
105 int option_index = 0;
107 while((r = getopt_long(argc, argv, "c:n:h:", long_options, &option_index)) != EOF) {
109 case 0: /* long option */
112 case 'c': /* config file */
113 confbase = xstrdup(optarg);
116 case 'h': /* alternative host to connect to */
117 host = xstrdup(optarg);
120 case 'n': /* net name given */
121 netname = xstrdup(optarg);
124 case 1: /* show help */
128 case 2: /* show version */
132 case 5: /* open control socket here */
133 controlcookiename = xstrdup(optarg);
148 FILE *ask_and_open(const char *filename, const char *what, const char *mode) {
154 /* Check stdin and stdout */
155 if(isatty(0) && isatty(1)) {
156 /* Ask for a file and/or directory name. */
157 fprintf(stdout, "Please enter a file to save %s to [%s]: ",
161 if(fgets(buf, sizeof buf, stdin) == NULL) {
162 fprintf(stderr, "Error while reading stdin: %s\n",
167 size_t len = strlen(buf);
176 if(filename[0] != '\\' && filename[0] != '/' && !strchr(filename, ':')) {
178 if(filename[0] != '/') {
180 /* The directory is a relative path or a filename. */
181 directory = get_current_dir_name();
182 snprintf(buf2, sizeof buf2, "%s/%s", directory, filename);
186 umask(0077); /* Disallow everything for group and other */
188 /* Open it first to keep the inode busy */
190 r = fopen(filename, mode);
193 fprintf(stderr, "Error opening file `%s': %s\n", filename, strerror(errno));
201 Generate a public/private RSA keypair, and ask for a file to store
204 static bool keygen(int bits) {
209 fprintf(stderr, "Generating %d bits keys:\n", bits);
211 if(!rsa_generate(&key, bits, 0x10001)) {
212 fprintf(stderr, "Error during key generation!\n");
215 fprintf(stderr, "Done.\n");
217 xasprintf(&filename, "%s/rsa_key.priv", confbase);
218 f = ask_and_open(filename, "private RSA key", "a");
224 /* Make it unreadable for others. */
225 fchmod(fileno(f), 0600);
229 fprintf(stderr, "Appending key to existing contents.\nMake sure only one key is stored in the file.\n");
231 rsa_write_pem_private_key(&key, f);
237 xasprintf(&filename, "%s/hosts/%s", confbase, name);
239 xasprintf(&filename, "%s/rsa_key.pub", confbase);
241 f = ask_and_open(filename, "public RSA key", "a");
247 fprintf(stderr, "Appending key to existing contents.\nMake sure only one key is stored in the file.\n");
249 rsa_write_pem_public_key(&key, f);
258 Set all files and paths according to netname
260 static void make_names(void) {
263 char installdir[1024] = "";
264 long len = sizeof installdir;
268 xasprintf(&identname, "tinc.%s", netname);
270 identname = xstrdup("tinc");
273 if(!RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\tinc", 0, KEY_READ, &key)) {
274 if(!RegQueryValueEx(key, NULL, 0, 0, installdir, &len)) {
277 xasprintf(&confbase, "%s/%s", installdir, netname);
279 xasprintf(&confbase, "%s", installdir);
282 if(!controlcookiename)
283 xasprintf(&controlcookiename, "%s/cookie", confbase);
290 if(!controlcookiename)
291 xasprintf(&controlcookiename, "%s/run/%s.cookie", LOCALSTATEDIR, identname);
295 xasprintf(&confbase, CONFDIR "/tinc/%s", netname);
297 fprintf(stderr, "Both netname and configuration directory given, using the latter...\n");
300 xasprintf(&confbase, CONFDIR "/tinc");
304 static char buffer[4096];
305 static size_t blen = 0;
307 bool recvline(int fd, char *line, size_t len) {
308 char *newline = NULL;
310 while(!(newline = memchr(buffer, '\n', blen))) {
311 int result = recv(fd, buffer + blen, sizeof buffer - blen, 0);
312 if(result == -1 && errno == EINTR)
319 if(newline - buffer >= len)
322 len = newline - buffer;
324 memcpy(line, buffer, len);
326 memmove(buffer, newline + 1, blen - len - 1);
332 bool recvdata(int fd, char *data, size_t len) {
334 int result = recv(fd, buffer + blen, sizeof buffer - blen, 0);
335 if(result == -1 && errno == EINTR)
342 memcpy(data, buffer, len);
343 memmove(buffer, buffer + len, blen - len);
349 bool sendline(int fd, char *format, ...) {
350 static char buffer[4096];
355 va_start(ap, format);
356 blen = vsnprintf(buffer, sizeof buffer, format, ap);
359 if(blen < 0 || blen >= sizeof buffer)
366 int result = send(fd, p, blen, 0);
367 if(result == -1 && errno == EINTR)
369 else if(result <= 0);
378 void pcap(int fd, FILE *out) {
379 sendline(fd, "%d %d", CONTROL, REQ_PCAP);
387 uint32_t tz_accuracy;
407 fwrite(&header, sizeof header, 1, out);
411 while(recvline(fd, line, sizeof line)) {
413 int n = sscanf(line, "%d %d %d", &code, &req, &len);
414 gettimeofday(&tv, NULL);
415 if(n != 3 || code != CONTROL || req != REQ_PCAP || len < 0 || len > sizeof data)
417 if(!recvdata(fd, data, len))
419 packet.tv_sec = tv.tv_sec;
420 packet.tv_usec = tv.tv_usec;
422 packet.origlen = len;
423 fwrite(&packet, sizeof packet, 1, out);
424 fwrite(data, len, 1, out);
429 int main(int argc, char *argv[], char *envp[]) {
435 program_name = argv[0];
437 if(!parse_options(argc, argv))
443 printf("%s version %s (built %s %s, protocol %d)\n", PACKAGE,
444 VERSION, __DATE__, __TIME__, PROT_CURRENT);
445 printf("Copyright (C) 1998-2009 Ivo Timmermans, Guus Sliepen and others.\n"
446 "See the AUTHORS file for a complete list.\n\n"
447 "tinc comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
448 "and you are welcome to redistribute it under certain conditions;\n"
449 "see the file COPYING for details.\n");
460 fprintf(stderr, "Not enough arguments.\n");
465 // First handle commands that don't involve connecting to a running tinc daemon.
467 if(!strcasecmp(argv[optind], "generate-keys")) {
468 return !keygen(optind > argc ? atoi(argv[optind + 1]) : 2048);
471 if(!strcasecmp(argv[optind], "start")) {
473 execve(SBINDIR "/tincd", argv, envp);
474 fprintf(stderr, "Could not start tincd: %s", strerror(errno));
479 * Now handle commands that do involve connecting to a running tinc daemon.
480 * Authenticate the server by ensuring the parent directory can be
481 * traversed only by root. Note this is not totally race-free unless all
482 * ancestors are writable only by trusted users, which we don't verify.
485 FILE *f = fopen(controlcookiename, "r");
487 fprintf(stderr, "Could not open control socket cookie file %s: %s\n", controlcookiename, strerror(errno));
490 if(fscanf(f, "%1024s %128s %20d", controlcookie, port, &pid) != 3) {
491 fprintf(stderr, "Could not parse control socket cookie file %s\n", controlcookiename);
496 if(WSAStartup(MAKEWORD(2, 2), &wsa_state)) {
497 fprintf(stderr, "System call `%s' failed: %s", "WSAStartup", winerror(GetLastError()));
502 struct addrinfo hints = {
503 .ai_family = AF_UNSPEC,
504 .ai_socktype = SOCK_STREAM,
505 .ai_protocol = IPPROTO_TCP,
509 struct addrinfo *res = NULL;
511 if(getaddrinfo(host, port, &hints, &res) || !res) {
512 fprintf(stderr, "Cannot resolve %s port %s: %s", host ?: "localhost", port, strerror(errno));
516 fd = socket(res->ai_family, SOCK_STREAM, IPPROTO_TCP);
518 fprintf(stderr, "Cannot create TCP socket: %s\n", sockstrerror(sockerrno));
523 unsigned long arg = 0;
525 if(ioctlsocket(fd, FIONBIO, &arg) != 0) {
526 fprintf(stderr, "ioctlsocket failed: %s", sockstrerror(sockerrno));
530 if(connect(fd, res->ai_addr, res->ai_addrlen) < 0) {
531 fprintf(stderr, "Cannot connect to %s port %s: %s\n", host ?: "localhost", port, sockstrerror(sockerrno));
539 int code, version, req;
541 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %s %d", &code, data, &version) != 3 || code != 0) {
542 fprintf(stderr, "Cannot read greeting from control socket: %s\n",
543 sockstrerror(sockerrno));
547 sendline(fd, "%d ^%s %d", ID, controlcookie, TINC_CTL_VERSION_CURRENT);
549 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &version, &pid) != 3 || code != 4 || version != TINC_CTL_VERSION_CURRENT) {
550 fprintf(stderr, "Could not fully establish control socket connection\n");
554 if(!strcasecmp(argv[optind], "pid")) {
559 if(!strcasecmp(argv[optind], "stop")) {
560 sendline(fd, "%d %d", CONTROL, REQ_STOP);
561 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_STOP || result) {
562 fprintf(stderr, "Could not stop tinc daemon\n");
568 if(!strcasecmp(argv[optind], "reload")) {
569 sendline(fd, "%d %d", CONTROL, REQ_RELOAD);
570 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_RELOAD || result) {
571 fprintf(stderr, "Could not reload tinc daemon\n");
577 if(!strcasecmp(argv[optind], "restart")) {
578 sendline(fd, "%d %d", CONTROL, REQ_RESTART);
579 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_RESTART || result) {
580 fprintf(stderr, "Could not restart tinc daemon\n");
586 if(!strcasecmp(argv[optind], "retry")) {
587 sendline(fd, "%d %d", CONTROL, REQ_RETRY);
588 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_RETRY || result) {
589 fprintf(stderr, "Could not retry outgoing connections\n");
595 if(!strcasecmp(argv[optind], "dump")) {
596 if(argc < optind + 2) {
597 fprintf(stderr, "Not enough arguments.\n");
602 bool do_graph = false;
604 if(!strcasecmp(argv[optind+1], "nodes"))
605 sendline(fd, "%d %d", CONTROL, REQ_DUMP_NODES);
606 else if(!strcasecmp(argv[optind+1], "edges"))
607 sendline(fd, "%d %d", CONTROL, REQ_DUMP_EDGES);
608 else if(!strcasecmp(argv[optind+1], "subnets"))
609 sendline(fd, "%d %d", CONTROL, REQ_DUMP_SUBNETS);
610 else if(!strcasecmp(argv[optind+1], "connections"))
611 sendline(fd, "%d %d", CONTROL, REQ_DUMP_CONNECTIONS);
612 else if(!strcasecmp(argv[optind+1], "graph")) {
613 sendline(fd, "%d %d", CONTROL, REQ_DUMP_NODES);
614 sendline(fd, "%d %d", CONTROL, REQ_DUMP_EDGES);
616 printf("digraph {\n");
618 fprintf(stderr, "Unknown dump type '%s'.\n", argv[optind+1]);
623 while(recvline(fd, line, sizeof line)) {
624 char node1[4096], node2[4096];
625 int n = sscanf(line, "%d %d %s to %s", &code, &req, node1, node2);
627 if(do_graph && req == REQ_DUMP_NODES)
639 printf("%s\n", line + 5);
641 if(req == REQ_DUMP_NODES)
642 printf(" %s [label = \"%s\"];\n", node1, node1);
644 printf(" %s -> %s;\n", node1, node2);
648 fprintf(stderr, "Error receiving dump\n");
652 if(!strcasecmp(argv[optind], "purge")) {
653 sendline(fd, "%d %d", CONTROL, REQ_PURGE);
654 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_PURGE || result) {
655 fprintf(stderr, "Could not purge tinc daemon\n");
661 if(!strcasecmp(argv[optind], "debug")) {
662 int debuglevel, origlevel;
664 if(argc != optind + 2) {
665 fprintf(stderr, "Invalid arguments.\n");
668 debuglevel = atoi(argv[optind+1]);
670 sendline(fd, "%d %d %d", CONTROL, REQ_SET_DEBUG, debuglevel);
671 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &origlevel) != 3 || code != CONTROL || req != REQ_SET_DEBUG) {
672 fprintf(stderr, "Could not purge tinc daemon\n");
676 fprintf(stderr, "Old level %d, new level %d\n", origlevel, debuglevel);
680 if(!strcasecmp(argv[optind], "connect")) {
681 if(argc != optind + 2) {
682 fprintf(stderr, "Invalid arguments.\n");
685 char *name = argv[optind + 1];
687 sendline(fd, "%d %d %s", CONTROL, REQ_CONNECT, name);
688 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_CONNECT || result) {
689 fprintf(stderr, "Could not connect to %s\n", name);
695 if(!strcasecmp(argv[optind], "disconnect")) {
696 if(argc != optind + 2) {
697 fprintf(stderr, "Invalid arguments.\n");
700 char *name = argv[optind + 1];
702 sendline(fd, "%d %d %s", CONTROL, REQ_DISCONNECT, name);
703 if(!recvline(fd, line, sizeof line) || sscanf(line, "%d %d %d", &code, &req, &result) != 3 || code != CONTROL || req != REQ_DISCONNECT || result) {
704 fprintf(stderr, "Could not disconnect %s\n", name);
711 if(!strcasecmp(argv[optind], "top")) {
717 if(!strcasecmp(argv[optind], "pcap")) {
722 fprintf(stderr, "Unknown command `%s'.\n", argv[optind]);