10 #include <sys/utsname.h>
11 #include <sys/socket.h>
15 #ifdef HAVE_LINUX_IF_H
16 #include <linux/if_tun.h>
17 #define LINUX_TUN_SUPPORTED
21 #ifdef HAVE_NET_ROUTE_H
22 #include <net/route.h>
25 #if defined(HAVE_STROPTS_H) && defined(HAVE_SYS_SOCKIO_H) && \
26 defined(HAVE_NET_IF_TUN_H)
27 #define HAVE_TUN_STREAMS
30 #ifdef HAVE_TUN_STREAMS
32 #include <sys/sockio.h>
33 #include <net/if_tun.h>
36 #define TUN_FLAVOUR_GUESS 0
37 #define TUN_FLAVOUR_BSD 1
38 #define TUN_FLAVOUR_LINUX 2
39 #define TUN_FLAVOUR_STREAMS 3
41 static struct flagstr flavours[]={
42 {"guess", TUN_FLAVOUR_GUESS},
43 {"bsd", TUN_FLAVOUR_BSD},
44 {"BSD", TUN_FLAVOUR_BSD},
45 {"linux", TUN_FLAVOUR_LINUX},
46 {"streams", TUN_FLAVOUR_STREAMS},
47 {"STREAMS", TUN_FLAVOUR_STREAMS},
51 #define TUN_CONFIG_GUESS 0
52 #define TUN_CONFIG_IOCTL 1
53 #define TUN_CONFIG_BSD 2
54 #define TUN_CONFIG_LINUX 3
55 #define TUN_CONFIG_SOLARIS25 4
57 static struct flagstr config_types[]={
58 {"guess", TUN_CONFIG_GUESS},
59 {"ioctl", TUN_CONFIG_IOCTL},
60 {"bsd", TUN_CONFIG_BSD},
61 {"BSD", TUN_CONFIG_BSD},
62 {"linux", TUN_CONFIG_LINUX},
63 {"solaris-2.5", TUN_CONFIG_SOLARIS25},
67 /* Connection to the kernel through the universal TUN/TAP driver */
72 cstring_t device_path;
74 string_t interface_name;
75 cstring_t ifconfig_path;
76 uint32_t ifconfig_type;
80 bool_t search_for_if; /* Applies to tun-BSD only */
81 struct buffer_if *buff; /* We receive packets into here
82 and send them to the netlink code. */
83 netlink_deliver_fn *netlink_to_tunnel;
86 static cstring_t tun_flavour_str(uint32_t flavour)
89 case TUN_FLAVOUR_GUESS: return "guess";
90 case TUN_FLAVOUR_BSD: return "BSD";
91 case TUN_FLAVOUR_LINUX: return "linux";
92 case TUN_FLAVOUR_STREAMS: return "STREAMS";
93 default: return "unknown";
97 static int tun_beforepoll(void *sst, struct pollfd *fds, int *nfds_io,
101 BEFOREPOLL_WANT_FDS(1);
103 fds[0].events=POLLIN;
107 static void tun_afterpoll(void *sst, struct pollfd *fds, int nfds)
113 if (fds[0].revents&POLLERR) {
114 printf("tun_afterpoll: hup!\n");
116 if (fds[0].revents&POLLIN) {
117 BUF_ALLOC(st->buff,"tun_afterpoll");
118 buffer_init(st->buff,calculate_max_start_pad());
119 l=read(st->fd, st->buff->start, buf_remaining_space(st->buff));
121 if (errno==EINTR || iswouldblock(errno)) return;
122 fatal_perror("tun_afterpoll: read()");
125 fatal("tun_afterpoll: read()=0; device gone away?");
129 st->netlink_to_tunnel(&st->nl,st->buff);
130 BUF_ASSERT_FREE(st->buff);
135 static void tun_deliver_to_kernel(void *sst, struct buffer_if *buf)
140 BUF_ASSERT_USED(buf);
142 /* Log errors, so we can tell what's going on, but only once a
143 minute, so we don't flood the logs. Short writes count as
145 rc = write(st->fd,buf->start,buf->size);
146 if(rc != buf->size) {
147 static struct timeval last_report;
148 if(tv_now_global.tv_sec >= last_report.tv_sec + 60) {
151 "failed to deliver packet to tun device: %s\n",
155 "truncated packet delivered to tun device\n");
156 last_report = tv_now_global;
162 static bool_t tun_set_route(void *sst, struct netlink_client *routes)
165 string_t network, mask, secnetaddr;
166 struct subnet_list *nets;
171 if (routes->options & OPT_SOFTROUTE)
174 up = routes->link_quality > LINK_QUALITY_UNUSED;
176 if (up == routes->kup) return False;
177 if (st->route_type==TUN_CONFIG_IOCTL) {
178 if (st->tun_flavour==TUN_FLAVOUR_STREAMS) {
179 fd=open(st->ip_path,O_RDWR);
181 fatal_perror("tun_set_route: can't open %s",st->ip_path);
184 fd=socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
186 fatal_perror("tun_set_route: socket()");
190 nets=routes->subnets;
191 secnetaddr=ipaddr_to_string(st->nl.secnet_address);
192 for (i=0; i<nets->entries; i++) {
193 network=ipaddr_to_string(nets->list[i].prefix);
194 mask=ipaddr_to_string(nets->list[i].mask);
195 Message(M_INFO,"%s: %s route %s/%d %s kernel routing table\n",
196 st->nl.name,up?"adding":"deleting",network,
197 nets->list[i].len,up?"to":"from");
198 switch (st->route_type) {
199 case TUN_CONFIG_LINUX:
200 sys_cmd(st->route_path,"route",up?"add":"del",
201 "-net",network,"netmask",mask,
202 "gw",secnetaddr,(char *)0);
205 sys_cmd(st->route_path,"route",up?"add":"del",
206 "-net",network,secnetaddr,mask,(char *)0);
208 case TUN_CONFIG_SOLARIS25:
209 sys_cmd(st->route_path,"route",up?"add":"del",
210 network,secnetaddr,(char *)0);
212 case TUN_CONFIG_IOCTL:
214 /* darwin rtentry has a different format, use /sbin/route instead */
215 #if HAVE_NET_ROUTE_H && ! __APPLE__
217 struct sockaddr_in *sa;
221 sa=(struct sockaddr_in *)&rt.rt_dst;
222 sa->sin_family=AF_INET;
223 sa->sin_addr.s_addr=htonl(nets->list[i].prefix);
224 sa=(struct sockaddr_in *)&rt.rt_genmask;
225 sa->sin_family=AF_INET;
226 sa->sin_addr.s_addr=htonl(nets->list[i].mask);
227 sa=(struct sockaddr_in *)&rt.rt_gateway;
228 sa->sin_family=AF_INET;
229 sa->sin_addr.s_addr=htonl(st->nl.secnet_address);
230 rt.rt_flags=RTF_UP|RTF_GATEWAY;
231 action=up?SIOCADDRT:SIOCDELRT;
232 if (ioctl(fd,action,&rt)<0) {
233 fatal_perror("tun_set_route: ioctl()");
236 fatal("tun_set_route: ioctl method not supported");
241 fatal("tun_set_route: unsupported route command type");
252 static void tun_phase_hook(void *sst, uint32_t newphase)
255 string_t hostaddr,secnetaddr;
257 struct netlink_client *r;
259 if (st->tun_flavour==TUN_FLAVOUR_BSD) {
260 if (st->search_for_if) {
264 dname=safe_malloc(strlen(st->device_path)+4,"tun_old_apply");
265 st->interface_name=safe_malloc(8,"tun_phase_hook");
267 for (i=0; i<255; i++) {
268 sprintf(dname,"%s%d",st->device_path,i);
269 if ((st->fd=open(dname,O_RDWR))>0) {
270 sprintf(st->interface_name,"tun%d",i);
271 Message(M_INFO,"%s: allocated network interface %s "
272 "through %s\n",st->nl.name,st->interface_name,
278 fatal("%s: unable to open any TUN device (%s...)",
279 st->nl.name,st->device_path);
282 st->fd=open(st->device_path,O_RDWR);
284 fatal_perror("%s: unable to open TUN device file %s",
285 st->nl.name,st->device_path);
288 } else if (st->tun_flavour==TUN_FLAVOUR_LINUX) {
289 #ifdef LINUX_TUN_SUPPORTED
292 /* New TUN interface: open the device, then do ioctl TUNSETIFF
293 to set or find out the network interface name. */
294 st->fd=open(st->device_path,O_RDWR);
296 fatal_perror("%s: can't open device file %s",st->nl.name,
300 ifr.ifr_flags = IFF_TUN | IFF_NO_PI; /* Just send/receive IP packets,
302 if (st->interface_name)
303 strncpy(ifr.ifr_name,st->interface_name,IFNAMSIZ);
304 if (ioctl(st->fd,TUNSETIFF,&ifr)<0) {
305 fatal_perror("%s: ioctl(TUNSETIFF)",st->nl.name);
307 if (!st->interface_name) {
308 st->interface_name=safe_malloc(strlen(ifr.ifr_name)+1,"tun_apply");
309 strcpy(st->interface_name,ifr.ifr_name);
310 Message(M_INFO,"%s: allocated network interface %s\n",st->nl.name,
314 fatal("tun_phase_hook: TUN_FLAVOUR_LINUX unexpected");
315 #endif /* LINUX_TUN_SUPPORTED */
316 } else if (st->tun_flavour==TUN_FLAVOUR_STREAMS) {
317 #ifdef HAVE_TUN_STREAMS
318 int tun_fd, if_fd, ppa=-1, ip_fd;
320 if ((ip_fd=open(st->ip_path, O_RDWR)) < 0) {
321 fatal_perror("%s: can't open %s",st->nl.name,st->ip_path);
323 if ((tun_fd=open(st->device_path,O_RDWR)) < 0) {
324 fatal_perror("%s: can't open %s",st->nl.name,st->device_path);
326 if ((ppa=ioctl(tun_fd,TUNNEWPPA,ppa)) < 0) {
327 fatal_perror("%s: can't assign new interface");
329 if ((if_fd=open(st->device_path,O_RDWR)) < 0) {
330 fatal_perror("%s: can't open %s (2)",st->nl.name,st->device_path);
332 if (ioctl(if_fd,I_PUSH,"ip") < 0) {
333 fatal_perror("%s: can't push IP module",st->nl.name);
335 if (ioctl(if_fd,IF_UNITSEL,(char *)&ppa) < 0) {
336 fatal_perror("%s: can't set ppa %d",st->nl.name,ppa);
338 if (ioctl(ip_fd, I_LINK, if_fd) < 0) {
339 fatal_perror("%s: can't link TUN device to IP",st->nl.name);
341 st->interface_name=safe_malloc(10,"tun_apply");
342 sprintf(st->interface_name,"tun%d",ppa);
347 fatal("tun_phase_hook: TUN_FLAVOUR_STREAMS unexpected");
348 #endif /* HAVE_TUN_STREAMS */
350 fatal("tun_phase_hook: unknown flavour of TUN");
352 /* All the networks we'll be using have been registered. Invoke ifconfig
353 to set the TUN device's address, and route to add routes to all
359 hostaddr=ipaddr_to_string(st->nl.local_address);
360 secnetaddr=ipaddr_to_string(st->nl.secnet_address);
361 snprintf(mtu,sizeof(mtu),"%d",st->nl.mtu);
364 switch (st->ifconfig_type) {
365 case TUN_CONFIG_LINUX:
366 sys_cmd(st->ifconfig_path,"ifconfig",st->interface_name,
367 hostaddr,"netmask","255.255.255.255","-broadcast",
369 "pointopoint",secnetaddr,"mtu",mtu,"up",(char *)0);
372 sys_cmd(st->ifconfig_path,"ifconfig",st->interface_name,
373 hostaddr,"netmask","255.255.255.255",
374 secnetaddr,"mtu",mtu,"up",(char *)0);
376 case TUN_CONFIG_SOLARIS25:
377 sys_cmd(st->ifconfig_path,"ifconfig",st->interface_name,
378 hostaddr,secnetaddr,"mtu",mtu,"up",(char *)0);
380 case TUN_CONFIG_IOCTL:
381 #if HAVE_NET_IF_H && ! __APPLE__
385 struct sockaddr_in *sa;
386 fd=socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
388 /* Interface address */
389 strncpy(ifr.ifr_name,st->interface_name,IFNAMSIZ);
390 sa=(struct sockaddr_in *)&ifr.ifr_addr;
392 sa->sin_family=AF_INET;
393 sa->sin_addr.s_addr=htonl(st->nl.local_address);
394 if (ioctl(fd,SIOCSIFADDR, &ifr)!=0) {
395 fatal_perror("tun_apply: SIOCSIFADDR");
397 #ifdef SIOCSIFNETMASK
399 strncpy(ifr.ifr_name,st->interface_name,IFNAMSIZ);
400 sa=(struct sockaddr_in *)&ifr.ifr_netmask;
402 sa->sin_family=AF_INET;
403 sa->sin_addr.s_addr=htonl(0xffffffff);
404 if (ioctl(fd,SIOCSIFNETMASK, &ifr)!=0) {
405 fatal_perror("tun_apply: SIOCSIFNETMASK");
408 /* Destination address (point-to-point) */
409 strncpy(ifr.ifr_name,st->interface_name,IFNAMSIZ);
410 sa=(struct sockaddr_in *)&ifr.ifr_dstaddr;
412 sa->sin_family=AF_INET;
413 sa->sin_addr.s_addr=htonl(st->nl.secnet_address);
414 if (ioctl(fd,SIOCSIFDSTADDR, &ifr)!=0) {
415 fatal_perror("tun_apply: SIOCSIFDSTADDR");
418 strncpy(ifr.ifr_name,st->interface_name,IFNAMSIZ);
419 ifr.ifr_mtu=st->nl.mtu;
420 if (ioctl(fd,SIOCSIFMTU, &ifr)!=0) {
421 fatal_perror("tun_apply: SIOCSIFMTU");
424 strncpy(ifr.ifr_name,st->interface_name,IFNAMSIZ);
425 ifr.ifr_flags=IFF_UP|IFF_POINTOPOINT|IFF_RUNNING|IFF_NOARP;
426 if (ioctl(fd,SIOCSIFFLAGS, &ifr)!=0) {
427 fatal_perror("tun_apply: SIOCSIFFLAGS");
433 fatal("tun_apply: ifconfig by ioctl() not supported");
434 #endif /* HAVE_NET_IF_H */
437 fatal("tun_apply: unsupported ifconfig method");
441 for (r=st->nl.clients; r; r=r->next) {
445 /* Register for poll() */
446 register_for_poll(st, tun_beforepoll, tun_afterpoll, st->nl.name);
449 static list_t *tun_create(closure_t *self, struct cloc loc, dict_t *context,
450 list_t *args,uint32_t default_flavour)
455 string_t flavour,type;
457 st=safe_malloc(sizeof(*st),"tun_apply");
459 /* First parameter must be a dict */
460 item=list_elem(args,0);
461 if (!item || item->type!=t_dict)
462 cfgfatal(loc,"tun","parameter must be a dictionary\n");
464 dict=item->data.dict;
466 st->netlink_to_tunnel=
467 netlink_init(&st->nl,st,loc,dict,
468 "netlink-tun",tun_set_route,tun_deliver_to_kernel);
470 flavour=dict_read_string(dict,"flavour",False,"tun-netlink",loc);
472 st->tun_flavour=string_to_word(flavour,loc,flavours,"tun-flavour");
474 st->tun_flavour=default_flavour;
476 st->device_path=dict_read_string(dict,"device",False,"tun-netlink",loc);
477 st->ip_path=dict_read_string(dict,"ip-path",False,"tun-netlink",loc);
478 st->interface_name=dict_read_string(dict,"interface",False,
480 st->search_for_if=dict_read_bool(dict,"interface-search",False,
481 "tun-netlink",loc,st->device_path==NULL);
483 type=dict_read_string(dict,"ifconfig-type",False,"tun-netlink",loc);
484 if (type) st->ifconfig_type=string_to_word(type,loc,config_types,
486 else st->ifconfig_type=TUN_CONFIG_GUESS;
487 st->ifconfig_path=dict_read_string(dict,"ifconfig-path",False,
490 type=dict_read_string(dict,"route-type",False,"tun-netlink",loc);
491 if (type) st->route_type=string_to_word(type,loc,config_types,
493 else st->route_type=TUN_CONFIG_GUESS;
494 st->route_path=dict_read_string(dict,"route-path",False,"tun-netlink",loc);
496 st->buff=find_cl_if(dict,"buffer",CL_BUFFER,True,"tun-netlink",loc);
498 if (st->tun_flavour==TUN_FLAVOUR_GUESS) {
499 /* If we haven't been told what type of TUN we're using, take
500 a guess based on the system details. */
503 fatal_perror("tun_create: uname");
505 if (strcmp(u.sysname,"Linux")==0) {
506 st->tun_flavour=TUN_FLAVOUR_LINUX;
507 } else if (strcmp(u.sysname,"SunOS")==0) {
508 st->tun_flavour=TUN_FLAVOUR_STREAMS;
509 } else if (strcmp(u.sysname,"FreeBSD")==0
510 || strcmp(u.sysname,"Darwin")==0) {
511 st->tun_flavour=TUN_FLAVOUR_BSD;
514 if (st->tun_flavour==TUN_FLAVOUR_GUESS) {
515 cfgfatal(loc,"tun","cannot guess which type of TUN is in use; "
516 "specify the flavour explicitly\n");
519 if (st->ifconfig_type==TUN_CONFIG_GUESS) {
520 switch (st->tun_flavour) {
521 case TUN_FLAVOUR_LINUX:
522 st->ifconfig_type=TUN_CONFIG_IOCTL;
524 case TUN_FLAVOUR_BSD:
526 /* XXX on Linux we still want TUN_CONFIG_IOCTL. Perhaps we can
527 use this on BSD too. */
528 st->ifconfig_type=TUN_CONFIG_IOCTL;
530 st->ifconfig_type=TUN_CONFIG_BSD;
533 case TUN_FLAVOUR_STREAMS:
534 st->ifconfig_type=TUN_CONFIG_BSD;
538 if (st->route_type==TUN_CONFIG_GUESS)
539 st->route_type=st->ifconfig_type;
541 if (st->ifconfig_type==TUN_CONFIG_GUESS) {
542 cfgfatal(loc,"tun","cannot guess which ifconfig method to use\n");
544 if (st->route_type==TUN_CONFIG_GUESS) {
545 cfgfatal(loc,"tun","cannot guess which route method to use\n");
548 if (st->ifconfig_type==TUN_CONFIG_IOCTL && st->ifconfig_path) {
549 cfgfatal(loc,"tun","ifconfig-type \"ioctl\" is incompatible with "
552 if (st->route_type==TUN_CONFIG_IOCTL && st->route_path) {
553 cfgfatal(loc,"tun","route-type \"ioctl\" is incompatible with "
557 Message(M_DEBUG_CONFIG,"%s: tun flavour %s\n",st->nl.name,
558 tun_flavour_str(st->tun_flavour));
559 switch (st->tun_flavour) {
560 case TUN_FLAVOUR_BSD:
561 if (!st->device_path) st->device_path="/dev/tun";
563 case TUN_FLAVOUR_LINUX:
564 if (!st->device_path) st->device_path="/dev/net/tun";
566 case TUN_FLAVOUR_STREAMS:
567 if (!st->device_path) st->device_path="/dev/tun";
568 if (st->interface_name) cfgfatal(loc,"tun","interface name cannot "
569 "be specified with STREAMS TUN\n");
573 if (!st->ip_path) st->ip_path="/dev/ip";
574 if (!st->ifconfig_path) st->ifconfig_path="ifconfig";
575 if (!st->route_path) st->route_path="route";
577 #ifndef HAVE_TUN_STREAMS
578 if (st->tun_flavour==TUN_FLAVOUR_STREAMS) {
579 cfgfatal(loc,"tun","TUN flavour STREAMS unsupported in this build "
583 #ifndef LINUX_TUN_SUPPORTED
584 if (st->tun_flavour==TUN_FLAVOUR_LINUX) {
585 cfgfatal(loc,"tun","TUN flavour LINUX unsupported in this build "
590 /* Old TUN interface: the network interface name depends on which
591 /dev/tunX file we open. If 'interface-search' is set to true, treat
592 'device' as the prefix and try numbers from 0--255. If it's set
593 to false, treat 'device' as the whole name, and require than an
594 appropriate interface name be specified. */
595 if (st->tun_flavour==TUN_FLAVOUR_BSD) {
596 if (st->search_for_if && st->interface_name) {
597 cfgfatal(loc,"tun","you may not specify an interface name "
598 "in interface-search mode\n");
600 if (!st->search_for_if && !st->interface_name) {
601 cfgfatal(loc,"tun","you must specify an interface name "
602 "when you explicitly specify a TUN device file\n");
606 add_hook(PHASE_GETRESOURCES,tun_phase_hook,st);
608 return new_closure(&st->nl.cl);
611 static list_t *tun_apply(closure_t *self, struct cloc loc, dict_t *context,
614 return tun_create(self,loc,context,args,TUN_FLAVOUR_GUESS);
617 static list_t *tun_bsd_apply(closure_t *self, struct cloc loc, dict_t *context,
620 Message(M_WARNING,"(%s,%d): obsolete use of tun-old; replace with tun "
621 "and specify flavour \"bsd\".\n",loc.file,loc.line);
622 return tun_create(self,loc,context,args,TUN_FLAVOUR_BSD);
625 void tun_module(dict_t *dict)
627 add_closure(dict,"tun",tun_apply);
628 add_closure(dict,"tun-old",tun_bsd_apply);