2 * curvetun - the cipherspace wormhole creator
3 * Part of the netsniff-ng project
4 * By Daniel Borkmann <daniel@netsniff-ng.org>
5 * Copyright 2011 Daniel Borkmann <dborkma@tik.ee.ethz.ch>,
6 * Copyright 2011 Emmanuel Roullit.
7 * Subject to the GPL, version 2.
9 * This is curvetun, a lightweight, high-speed ECDH multiuser IP tunnel for
10 * Linux that is based on epoll(2). curvetun uses the Linux TUN/TAP interface
11 * and supports {IPv4,IPv6} over {IPv4,IPv6} with UDP or TCP as carrier
12 * protocols. It has an integrated packet forwarding trie, thus multiple
13 * users with different IPs can be handled via a single tunnel device on the
14 * server side and flows are scheduled for processing in a CPU-local manner.
15 * For transmission, packets are being compressed and encrypted by both, the
16 * client and the server side. As an appropriate key management, public-key
17 * cryptography based on elliptic curves are being used and packets are
18 * encrypted by a symmetric stream cipher (Salsa20) and authenticated by a MAC
19 * (Poly1305), where keys have previously been computed with the ECDH key
20 * agreement protocol (Curve25519). Cryptography is based on Daniel J.
21 * Bernsteins Networking and Cryptography library (NaCl).
23 * He used often to say there was only one Road; that it was like a great
24 * river: it's springs were at every doorstep and every path was it's
25 * tributary. "It's a dangerous business, Frodo, going out of your door,"
26 * he used to say. "You step into the Road, and if you don't keep your
27 * feet, there is no telling where you might be swept off to."
29 * -- The Lord of the Rings, Frodo about his uncle Bilbo Baggins,
30 * Chapter 'Three is Company'.
43 #include <sys/types.h>
45 #include <sys/socket.h>
46 #include <sys/ptrace.h>
47 #include <sys/fsuid.h>
48 #include <netinet/in.h>
57 #include "ct_usermgmt.h"
58 #include "ct_servmgmt.h"
61 #include "crypto_verify_32.h"
62 #include "crypto_box_curve25519xsalsa20poly1305.h"
63 #include "crypto_scalarmult_curve25519.h"
64 #include "crypto_auth_hmacsha512256.h"
66 #define CURVETUN_ENTROPY_SOURCE "/dev/random"
68 extern void print_stun_probe(char *server
, uint16_t sport
, uint16_t tunport
);
80 volatile sig_atomic_t sigint
= 0;
82 static const char *short_options
= "kxc::svhp:t:d:uCS46DN";
83 static const struct option long_options
[] = {
84 {"client", optional_argument
, NULL
, 'c'},
85 {"dev", required_argument
, NULL
, 'd'},
86 {"port", required_argument
, NULL
, 'p'},
87 {"stun", required_argument
, NULL
, 't'},
88 {"keygen", no_argument
, NULL
, 'k'},
89 {"export", no_argument
, NULL
, 'x'},
90 {"dumpc", no_argument
, NULL
, 'C'},
91 {"dumps", no_argument
, NULL
, 'S'},
92 {"no-logging", no_argument
, NULL
, 'N'},
93 {"server", no_argument
, NULL
, 's'},
94 {"udp", no_argument
, NULL
, 'u'},
95 {"ipv4", no_argument
, NULL
, '4'},
96 {"ipv6", no_argument
, NULL
, '6'},
97 {"nofork", no_argument
, NULL
, 'D'},
98 {"version", no_argument
, NULL
, 'v'},
99 {"help", no_argument
, NULL
, 'h'},
103 static void signal_handler(int number
)
114 static void header(void)
116 printf("%s%s%s\n", colorize_start(bold
), "curvetun "
117 VERSION_STRING
, colorize_end());
120 static void help(void)
122 printf("\ncurvetun %s, lightweight curve25519-based VPN/IP tunnel\n",
124 puts("http://www.netsniff-ng.org\n\n"
125 "Usage: curvetun [options]\n"
126 "Options, general:\n"
127 " -k|--keygen Generate public/private keypair\n"
128 " -x|--export Export your public data for remote servers\n"
129 " -C|--dumpc Dump parsed clients\n"
130 " -S|--dumps Dump parsed servers\n"
131 " -D|--nofork Do not daemonize\n"
132 " -d|--dev <tun> Networking tunnel device, e.g. tun0\n"
133 " -v|--version Print version\n"
134 " -h|--help Print this help\n"
135 " -c|--client[=alias] Client mode, server alias optional\n"
136 " -s|--server Server mode, options follow below\n"
137 " -N|--no-logging Disable server logging (for better anonymity)\n"
138 " -p|--port <num> Server port number (mandatory)\n"
139 " -t|--stun <server> Show public IP/Port mapping via STUN\n"
140 " -u|--udp Use UDP as carrier instead of TCP\n"
141 " -4|--ipv4 Tunnel devices are IPv4\n"
142 " -6|--ipv6 Tunnel devices are IPv6\n"
143 " (default: same as carrier protocol)\n\n"
145 " See Documentation/Curvetun for a configuration example.\n"
146 " curvetun --keygen\n"
147 " curvetun --export\n"
148 " curvetun --server -4 -u -N --port 6666 --stun stunserver.org\n"
149 " curvetun --client=ethz\n\n"
151 " There is no default port specified, so that you are forced\n"
152 " to select your own! For client/server status messages see syslog!\n"
153 " This software is an experimental prototype intended for researchers.\n\n"
154 "Secret ingredient: 7647-14-5\n\n"
155 "Please report bugs to <bugs@netsniff-ng.org>\n"
156 "Copyright (C) 2011-2012 Daniel Borkmann <dborkma@tik.ee.ethz.ch>,\n"
157 "License: GNU GPL version 2.0\n"
158 "This is free software: you are free to change and redistribute it.\n"
159 "There is NO WARRANTY, to the extent permitted by law.\n");
163 static void version(void)
165 printf("\ncurvetun %s, lightweight curve25519-based VPN/IP tunnel\n",
167 puts("http://www.netsniff-ng.org\n\n"
168 "Please report bugs to <bugs@netsniff-ng.org>\n"
169 "Copyright (C) 2011-2012 Daniel Borkmann <daniel@netsniff-ng.org>\n"
170 "License: GNU GPL version 2.0\n"
171 "This is free software: you are free to change and redistribute it.\n"
172 "There is NO WARRANTY, to the extent permitted by law.\n");
176 static void check_file_or_die(char *home
, char *file
, int maybeempty
)
181 memset(path
, 0, sizeof(path
));
182 slprintf(path
, sizeof(path
), "%s/%s", home
, file
);
185 panic("No such file %s! Type --help for further information\n",
188 if (!S_ISREG(st
.st_mode
))
189 panic("%s is not a regular file!\n", path
);
191 if ((st
.st_mode
& ~S_IFREG
) != (S_IRUSR
| S_IWUSR
))
192 panic("You have set too many permissions on %s (%o)!\n",
195 if (maybeempty
== 0 && st
.st_size
== 0)
196 panic("%s is empty!\n", path
);
199 static void check_config_exists_or_die(char *home
)
202 panic("No home dir specified!\n");
204 check_file_or_die(home
, FILE_CLIENTS
, 1);
205 check_file_or_die(home
, FILE_SERVERS
, 1);
206 check_file_or_die(home
, FILE_PRIVKEY
, 0);
207 check_file_or_die(home
, FILE_PUBKEY
, 0);
208 check_file_or_die(home
, FILE_USERNAM
, 0);
211 static char *fetch_home_dir(void)
213 char *home
= getenv("HOME");
215 panic("No HOME defined!\n");
219 static void write_username(char *home
)
225 memset(path
, 0, sizeof(path
));
226 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_USERNAM
);
228 printf("Username: [%s] ", getenv("USER"));
231 memset(user
, 0, sizeof(user
));
232 if (fgets(user
, sizeof(user
), stdin
) == NULL
)
233 panic("Could not read from stdin!\n");
234 user
[sizeof(user
) - 1] = 0;
235 user
[strlen(user
) - 1] = 0; /* omit last \n */
236 if (strlen(user
) == 0)
237 strlcpy(user
, getenv("USER"), sizeof(user
));
239 fd
= open_or_die_m(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, S_IRUSR
| S_IWUSR
);
241 ret
= write(fd
, user
, strlen(user
));
242 if (ret
!= strlen(user
))
243 panic("Could not write username!\n");
247 printf("Username written to %s!\n", path
);
250 static void create_curvedir(char *home
)
255 memset(path
, 0, sizeof(path
));
256 slprintf(path
, sizeof(path
), "%s/%s", home
, ".curvetun/");
260 ret
= mkdir(path
, S_IRWXU
);
261 if (ret
< 0 && errno
!= EEXIST
)
262 panic("Cannot create curvetun dir!\n");
264 printf("curvetun directory %s created!\n", path
);
265 /* We also create empty files for clients and servers! */
267 memset(path
, 0, sizeof(path
));
268 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_CLIENTS
);
270 create_or_die(path
, S_IRUSR
| S_IWUSR
);
272 printf("Empty client file written to %s!\n", path
);
274 memset(path
, 0, sizeof(path
));
275 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_SERVERS
);
277 create_or_die(path
, S_IRUSR
| S_IWUSR
);
279 printf("Empty server file written to %s!\n", path
);
282 static void create_keypair(char *home
)
286 unsigned char publickey
[crypto_box_curve25519xsalsa20poly1305_PUBLICKEYBYTES
] = { 0 };
287 unsigned char secretkey
[crypto_box_curve25519xsalsa20poly1305_SECRETKEYBYTES
] = { 0 };
289 const char * errstr
= NULL
;
291 printf("Reading from %s (this may take a while) ...\n", CURVETUN_ENTROPY_SOURCE
);
293 fd
= open_or_die(CURVETUN_ENTROPY_SOURCE
, O_RDONLY
);
295 ret
= read_exact(fd
, secretkey
, sizeof(secretkey
), 0);
296 if (ret
!= sizeof(secretkey
)) {
298 errstr
= "Cannot read from "CURVETUN_ENTROPY_SOURCE
"!\n";
304 crypto_scalarmult_curve25519_base(publickey
, secretkey
);
306 memset(path
, 0, sizeof(path
));
307 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_PUBKEY
);
309 fd
= open(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, S_IRUSR
| S_IWUSR
);
312 errstr
= "Cannot open pubkey file!\n";
316 ret
= write(fd
, publickey
, sizeof(publickey
));
317 if (ret
!= sizeof(publickey
)) {
319 errstr
= "Cannot write public key!\n";
325 printf("Public key written to %s!\n", path
);
327 memset(path
, 0, sizeof(path
));
328 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_PRIVKEY
);
330 fd
= open(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, S_IRUSR
| S_IWUSR
);
333 errstr
= "Cannot open privkey file!\n";
337 ret
= write(fd
, secretkey
, sizeof(secretkey
));
338 if (ret
!= sizeof(secretkey
)) {
340 errstr
= "Cannot write private key!\n";
346 xmemset(publickey
, 0, sizeof(publickey
));
347 xmemset(secretkey
, 0, sizeof(secretkey
));
350 panic("%s: %s", errstr
, strerror(errno
));
352 printf("Private key written to %s!\n", path
);
355 static void check_config_keypair_or_die(char *home
)
359 const char * errstr
= NULL
;
360 unsigned char publickey
[crypto_box_curve25519xsalsa20poly1305_PUBLICKEYBYTES
];
361 unsigned char publicres
[crypto_box_curve25519xsalsa20poly1305_PUBLICKEYBYTES
];
362 unsigned char secretkey
[crypto_box_curve25519xsalsa20poly1305_SECRETKEYBYTES
];
365 memset(path
, 0, sizeof(path
));
366 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_PRIVKEY
);
368 fd
= open(path
, O_RDONLY
);
371 errstr
= "Cannot open privkey file!\n";
375 ret
= read(fd
, secretkey
, sizeof(secretkey
));
376 if (ret
!= sizeof(secretkey
)) {
378 errstr
= "Cannot read private key!\n";
384 memset(path
, 0, sizeof(path
));
385 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_PUBKEY
);
387 fd
= open(path
, O_RDONLY
);
390 errstr
= "Cannot open pubkey file!\n";
394 ret
= read(fd
, publickey
, sizeof(publickey
));
395 if (ret
!= sizeof(publickey
)) {
397 errstr
= "Cannot read public key!\n";
401 crypto_scalarmult_curve25519_base(publicres
, secretkey
);
403 err
= crypto_verify_32(publicres
, publickey
);
406 errstr
= "WARNING: your keypair is corrupted!!! You need to "
407 "generate new keys!!!\n";
413 xmemset(publickey
, 0, sizeof(publickey
));
414 xmemset(publicres
, 0, sizeof(publicres
));
415 xmemset(secretkey
, 0, sizeof(secretkey
));
418 panic("%s: %s\n", errstr
, strerror(errno
));
421 static int main_keygen(char *home
)
423 create_curvedir(home
);
424 write_username(home
);
425 create_keypair(home
);
426 check_config_keypair_or_die(home
);
431 static int main_export(char *home
)
435 char path
[PATH_MAX
], tmp
[64];
437 check_config_exists_or_die(home
);
438 check_config_keypair_or_die(home
);
440 printf("Your exported public information:\n\n");
442 memset(path
, 0, sizeof(path
));
443 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_USERNAM
);
445 fd
= open_or_die(path
, O_RDONLY
);
447 while ((ret
= read(fd
, tmp
, sizeof(tmp
))) > 0) {
448 ret
= write(STDOUT_FILENO
, tmp
, ret
);
455 memset(path
, 0, sizeof(path
));
456 slprintf(path
, sizeof(path
), "%s/%s", home
, FILE_PUBKEY
);
458 fd
= open_or_die(path
, O_RDONLY
);
460 ret
= read(fd
, tmp
, sizeof(tmp
));
461 if (ret
!= crypto_box_curve25519xsalsa20poly1305_PUBLICKEYBYTES
)
462 panic("Cannot read public key!\n");
464 for (i
= 0; i
< ret
; ++i
)
466 printf("%02x\n\n", (unsigned char) tmp
[i
]);
468 printf("%02x:", (unsigned char) tmp
[i
]);
476 static int main_dumpc(char *home
)
478 check_config_exists_or_die(home
);
479 check_config_keypair_or_die(home
);
481 printf("Your clients:\n\n");
483 parse_userfile_and_generate_user_store_or_die(home
);
487 destroy_user_store();
494 static int main_dumps(char *home
)
496 check_config_exists_or_die(home
);
497 check_config_keypair_or_die(home
);
499 printf("Your servers:\n\n");
501 parse_userfile_and_generate_serv_store_or_die(home
);
505 destroy_serv_store();
512 static void daemonize(const char *lockfile
)
515 mode_t lperm
= S_IRWXU
| S_IRGRP
| S_IXGRP
; /* 0750 */
522 panic("Cannot daemonize: %s", strerror(errno
));
526 lfp
= open(lockfile
, O_RDWR
| O_CREAT
| O_EXCL
,
527 S_IRUSR
| S_IWUSR
| S_IRGRP
);
529 syslog_panic("Cannot create lockfile at %s! "
530 "curvetun server already running?\n",
533 slprintf(pidstr
, sizeof(pidstr
), "%u", getpid());
534 if (write(lfp
, pidstr
, strlen(pidstr
)) <= 0)
535 syslog_panic("Could not write pid to pidfile %s",
542 static int main_client(char *home
, char *dev
, char *alias
, int daemon
)
547 check_config_exists_or_die(home
);
548 check_config_keypair_or_die(home
);
550 parse_userfile_and_generate_serv_store_or_die(home
);
552 get_serv_store_entry_by_alias(alias
, alias
? strlen(alias
) + 1 : 0,
554 if (!host
|| !port
|| udp
< 0)
555 panic("Did not find alias/entry in configuration!\n");
557 printf("Using [%s] -> %s:%s via %s as endpoint!\n",
558 alias
? : "default", host
, port
, udp
? "udp" : "tcp");
562 ret
= client_main(home
, dev
, host
, port
, udp
);
564 destroy_serv_store();
569 static int main_server(char *home
, char *dev
, char *port
, int udp
,
570 int ipv4
, int daemon
, int log
)
574 check_config_exists_or_die(home
);
575 check_config_keypair_or_die(home
);
580 ret
= server_main(home
, dev
, port
, udp
, ipv4
, log
);
587 int main(int argc
, char **argv
)
589 int ret
= 0, c
, opt_index
, udp
= 0, ipv4
= -1, daemon
= 1, log
= 1;
590 char *port
= NULL
, *stun
= NULL
, *dev
= NULL
, *home
= NULL
, *alias
= NULL
;
591 enum working_mode wmode
= MODE_UNKNOW
;
596 home
= fetch_home_dir();
598 while ((c
= getopt_long(argc
, argv
, short_options
, long_options
,
599 &opt_index
)) != EOF
) {
624 alias
= xstrdup(optarg
);
628 dev
= xstrdup(optarg
);
649 stun
= xstrdup(optarg
);
652 port
= xstrdup(optarg
);
660 panic("Option -%c requires an argument!\n",
664 printf("Unknown option character `0x%X\'!\n", optopt
);
675 register_signal(SIGINT
, signal_handler
);
676 register_signal(SIGHUP
, signal_handler
);
677 register_signal(SIGTERM
, signal_handler
);
678 register_signal(SIGPIPE
, signal_handler
);
682 curve25519_selftest();
686 ret
= main_keygen(home
);
689 ret
= main_export(home
);
692 ret
= main_dumpc(home
);
695 ret
= main_dumps(home
);
698 ret
= main_client(home
, dev
, alias
, daemon
);
702 panic("No port specified!\n");
704 print_stun_probe(stun
, 3478, strtoul(port
, NULL
, 10));
705 ret
= main_server(home
, dev
, port
, udp
, ipv4
, daemon
, log
);