www.tinc-vpn.org Git - tinc/blob - src/bsd/device.c

   1 /*
   2     device.c -- Interaction BSD tun/tap device
   3     Copyright (C) 2001-2005 Ivo Timmermans,
   4                   2001-2016 Guus Sliepen <guus@tinc-vpn.org>
   5                   2009      Grzegorz Dymarek <gregd72002@googlemail.com>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License along
  18     with this program; if not, write to the Free Software Foundation, Inc.,
  19     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20 */
  21
  22 #include "../system.h"
  23
  24 #include "../conf.h"
  25 #include "../device.h"
  26 #include "../logger.h"
  27 #include "../net.h"
  28 #include "../route.h"
  29 #include "../utils.h"
  30 #include "../xalloc.h"
  31
  32 #ifdef ENABLE_TUNEMU
  33 #include "tunemu.h"
  34 #endif
  35
  36 #ifdef HAVE_NET_IF_UTUN_H
  37 #include <sys/sys_domain.h>
  38 #include <sys/kern_control.h>
  39 #include <net/if_utun.h>
  40 #endif
  41
  42 #define DEFAULT_TUN_DEVICE "/dev/tun0"
  43 #define DEFAULT_TAP_DEVICE "/dev/tap0"
  44
  45 typedef enum device_type {
  46         DEVICE_TYPE_TUN,
  47         DEVICE_TYPE_TUNIFHEAD,
  48         DEVICE_TYPE_TAP,
  49 #ifdef ENABLE_TUNEMU
  50         DEVICE_TYPE_TUNEMU,
  51 #endif
  52         DEVICE_TYPE_UTUN,
  53 } device_type_t;
  54
  55 int device_fd = -1;
  56 char *device = NULL;
  57 char *iface = NULL;
  58 static char *device_info = NULL;
  59 static uint64_t device_total_in = 0;
  60 static uint64_t device_total_out = 0;
  61 #if defined(ENABLE_TUNEMU)
  62 static device_type_t device_type = DEVICE_TYPE_TUNEMU;
  63 #elif defined(HAVE_OPENBSD) || defined(HAVE_FREEBSD) || defined(HAVE_DRAGONFLY)
  64 static device_type_t device_type = DEVICE_TYPE_TUNIFHEAD;
  65 #else
  66 static device_type_t device_type = DEVICE_TYPE_TUN;
  67 #endif
  68
  69 #ifdef HAVE_NET_IF_UTUN_H
  70 static bool setup_utun(void) {
  71         device_fd = socket(PF_SYSTEM, SOCK_DGRAM, SYSPROTO_CONTROL);
  72         if(device_fd == -1) {
  73                 logger(LOG_ERR, "Could not open PF_SYSTEM socket: %s\n", strerror(errno));
  74                 return false;
  75         }
  76
  77         struct ctl_info info = {};
  78         strlcpy(info.ctl_name, UTUN_CONTROL_NAME, sizeof info.ctl_name);
  79
  80         if(ioctl(device_fd, CTLIOCGINFO, &info) == -1) {
  81                 logger(LOG_ERR, "ioctl(CTLIOCGINFO) failed: %s", strerror(errno));
  82                 return false;
  83         }
  84
  85         int unit = -1;
  86         char *p = strstr(device, "utun"), *e = NULL;
  87         if(p) {
  88                 unit = strtol(p + 4, &e, 10);
  89                 if(!e)
  90                         unit = -1;
  91         }
  92
  93         struct sockaddr_ctl sc = {
  94                 .sc_id = info.ctl_id,
  95                 .sc_len = sizeof sc,
  96                 .sc_family = AF_SYSTEM,
  97                 .ss_sysaddr = AF_SYS_CONTROL,
  98                 .sc_unit = unit + 1,
  99         };
 100
 101         if(connect(device_fd, (struct sockaddr *)&sc, sizeof(sc)) == -1) {
 102                 logger(LOG_ERR, "Could not connect utun socket: %s\n", strerror(errno));
 103                 return false;
 104         }
 105
 106         char name[64] = "";
 107         socklen_t len = sizeof name;
 108         if(getsockopt(device_fd, SYSPROTO_CONTROL, UTUN_OPT_IFNAME, name, &len)) {
 109                 iface = xstrdup(device);
 110         } else {
 111                 iface = xstrdup(name);
 112         }
 113
 114         device_info = "OS X utun device";
 115
 116         logger(LOG_INFO, "%s is a %s", device, device_info);
 117
 118         return true;
 119 }
 120 #endif
 121
 122 static bool setup_device(void) {
 123         // Find out which device file to open
 124
 125         if(!get_config_string(lookup_config(config_tree, "Device"), &device)) {
 126                 if(routing_mode == RMODE_ROUTER)
 127                         device = xstrdup(DEFAULT_TUN_DEVICE);
 128                 else
 129                         device = xstrdup(DEFAULT_TAP_DEVICE);
 130         }
 131
 132         // Find out if it's supposed to be a tun or a tap device
 133
 134         char *type;
 135
 136         if(get_config_string(lookup_config(config_tree, "DeviceType"), &type)) {
 137                 if(!strcasecmp(type, "tun"))
 138                         /* use default */;
 139 #ifdef ENABLE_TUNEMU
 140                 else if(!strcasecmp(type, "tunemu"))
 141                         device_type = DEVICE_TYPE_TUNEMU;
 142 #endif
 143 #ifdef HAVE_NET_IF_UTUN_H
 144                 else if(!strcasecmp(type, "utun"))
 145                         device_type = DEVICE_TYPE_UTUN;
 146 #endif
 147                 else if(!strcasecmp(type, "tunnohead"))
 148                         device_type = DEVICE_TYPE_TUN;
 149                 else if(!strcasecmp(type, "tunifhead"))
 150                         device_type = DEVICE_TYPE_TUNIFHEAD;
 151                 else if(!strcasecmp(type, "tap"))
 152                         device_type = DEVICE_TYPE_TAP;
 153                 else {
 154                         logger(LOG_ERR, "Unknown device type %s!", type);
 155                         return false;
 156                 }
 157         } else {
 158 #ifdef HAVE_NET_IF_UTUN_H
 159                 if(strncmp(device, "utun", 4) == 0 || strncmp(device, "/dev/utun", 9) == 0)
 160                         device_type = DEVICE_TYPE_UTUN;
 161                 else
 162 #endif
 163                 if(strstr(device, "tap") || routing_mode != RMODE_ROUTER)
 164                         device_type = DEVICE_TYPE_TAP;
 165         }
 166
 167         if(routing_mode == RMODE_SWITCH && device_type != DEVICE_TYPE_TAP) {
 168                 logger(LOG_ERR, "Only tap devices support switch mode!");
 169                 return false;
 170         }
 171
 172         // Open the device
 173
 174         switch(device_type) {
 175 #ifdef ENABLE_TUNEMU
 176                 case DEVICE_TYPE_TUNEMU: {
 177                         char dynamic_name[256] = "";
 178                         device_fd = tunemu_open(dynamic_name);
 179                 }
 180                         break;
 181 #endif
 182 #ifdef HAVE_NET_IF_UTUN_H
 183                 case DEVICE_TYPE_UTUN:
 184                         return setup_utun();
 185 #endif
 186                 default:
 187                         device_fd = open(device, O_RDWR | O_NONBLOCK);
 188         }
 189
 190         if(device_fd < 0) {
 191                 logger(LOG_ERR, "Could not open %s: %s", device, strerror(errno));
 192                 return false;
 193         }
 194
 195 #ifdef FD_CLOEXEC
 196         fcntl(device_fd, F_SETFD, FD_CLOEXEC);
 197 #endif
 198
 199         // Guess what the corresponding interface is called
 200
 201         char *realname;
 202
 203 #if defined(HAVE_FDEVNAME)
 204         realname = fdevname(device_fd) ? : device;
 205 #elif defined(HAVE_DEVNAME)
 206         struct stat buf;
 207         if(!fstat(device_fd, &buf))
 208                 realname = devname(buf.st_rdev, S_IFCHR) ? : device;
 209 #else
 210         realname = device;
 211 #endif
 212
 213         if(!get_config_string(lookup_config(config_tree, "Interface"), &iface))
 214                 iface = xstrdup(strrchr(realname, '/') ? strrchr(realname, '/') + 1 : realname);
 215         else if(strcmp(iface, strrchr(realname, '/') ? strrchr(realname, '/') + 1 : realname))
 216                 logger(LOG_WARNING, "Warning: Interface does not match Device. $INTERFACE might be set incorrectly.");
 217
 218         // Configure the device as best as we can
 219
 220         switch(device_type) {
 221                 default:
 222                         device_type = DEVICE_TYPE_TUN;
 223                 case DEVICE_TYPE_TUN:
 224 #ifdef TUNSIFHEAD
 225                 {
 226                         const int zero = 0;
 227                         if(ioctl(device_fd, TUNSIFHEAD, &zero, sizeof zero) == -1) {
 228                                 logger(LOG_ERR, "System call `%s' failed: %s", "ioctl", strerror(errno));
 229                                 return false;
 230                         }
 231                 }
 232 #endif
 233 #if defined(TUNSIFMODE) && defined(IFF_BROADCAST) && defined(IFF_MULTICAST)
 234                 {
 235                         const int mode = IFF_BROADCAST | IFF_MULTICAST;
 236                         ioctl(device_fd, TUNSIFMODE, &mode, sizeof mode);
 237                 }
 238 #endif
 239
 240                         device_info = "Generic BSD tun device";
 241                         break;
 242                 case DEVICE_TYPE_TUNIFHEAD:
 243 #ifdef TUNSIFHEAD
 244                 {
 245                         const int one = 1;
 246                         if(ioctl(device_fd, TUNSIFHEAD, &one, sizeof one) == -1) {
 247                                 logger(LOG_ERR, "System call `%s' failed: %s", "ioctl", strerror(errno));
 248                                 return false;
 249                         }
 250                 }
 251 #endif
 252 #if defined(TUNSIFMODE) && defined(IFF_BROADCAST) && defined(IFF_MULTICAST)
 253                 {
 254                                 const int mode = IFF_BROADCAST | IFF_MULTICAST;
 255                                 ioctl(device_fd, TUNSIFMODE, &mode, sizeof mode);
 256                 }
 257 #endif
 258
 259                         device_info = "Generic BSD tun device";
 260                         break;
 261                 case DEVICE_TYPE_TAP:
 262                         if(routing_mode == RMODE_ROUTER)
 263                                 overwrite_mac = true;
 264                         device_info = "Generic BSD tap device";
 265 #ifdef TAPGIFNAME
 266                         {
 267                                 struct ifreq ifr;
 268                                 if(ioctl(device_fd, TAPGIFNAME, (void*)&ifr) == 0) {
 269                                         if(iface)
 270                                                 free(iface);
 271                                         iface = xstrdup(ifr.ifr_name);
 272                                 }
 273                         }
 274
 275 #endif
 276                         break;
 277 #ifdef ENABLE_TUNEMU
 278                 case DEVICE_TYPE_TUNEMU:
 279                         device_info = "BSD tunemu device";
 280                         break;
 281 #endif
 282         }
 283
 284 #ifdef SIOCGIFADDR
 285         if(overwrite_mac)
 286                 ioctl(device_fd, SIOCGIFADDR, mymac.x);
 287 #endif
 288
 289         logger(LOG_INFO, "%s is a %s", device, device_info);
 290
 291         return true;
 292 }
 293
 294 static void close_device(void) {
 295         switch(device_type) {
 296 #ifdef ENABLE_TUNEMU
 297                 case DEVICE_TYPE_TUNEMU:
 298                         tunemu_close(device_fd);
 299                         break;
 300 #endif
 301                 default:
 302                         close(device_fd);
 303         }
 304
 305         free(device);
 306         free(iface);
 307 }
 308
 309 static bool read_packet(vpn_packet_t *packet) {
 310         int lenin;
 311
 312         switch(device_type) {
 313                 case DEVICE_TYPE_TUN:
 314 #ifdef ENABLE_TUNEMU
 315                 case DEVICE_TYPE_TUNEMU:
 316                         if(device_type == DEVICE_TYPE_TUNEMU)
 317                                 lenin = tunemu_read(device_fd, packet->data + 14, MTU - 14);
 318                         else
 319 #endif
 320                                 lenin = read(device_fd, packet->data + 14, MTU - 14);
 321
 322                         if(lenin <= 0) {
 323                                 logger(LOG_ERR, "Error while reading from %s %s: %s", device_info,
 324                                            device, strerror(errno));
 325                                 return false;
 326                         }
 327
 328                         switch(packet->data[14] >> 4) {
 329                                 case 4:
 330                                         packet->data[12] = 0x08;
 331                                         packet->data[13] = 0x00;
 332                                         break;
 333                                 case 6:
 334                                         packet->data[12] = 0x86;
 335                                         packet->data[13] = 0xDD;
 336                                         break;
 337                                 default:
 338                                         ifdebug(TRAFFIC) logger(LOG_ERR,
 339                                                            "Unknown IP version %d while reading packet from %s %s",
 340                                                            packet->data[14] >> 4, device_info, device);
 341                                         return false;
 342                         }
 343
 344                         memset(packet->data, 0, 12);
 345                         packet->len = lenin + 14;
 346                         break;
 347
 348                 case DEVICE_TYPE_UTUN:
 349                 case DEVICE_TYPE_TUNIFHEAD: {
 350                         if((lenin = read(device_fd, packet->data + 10, MTU - 10)) <= 0) {
 351                                 logger(LOG_ERR, "Error while reading from %s %s: %s", device_info,
 352                                            device, strerror(errno));
 353                                 return false;
 354                         }
 355
 356                         switch(packet->data[14] >> 4) {
 357                                 case 4:
 358                                         packet->data[12] = 0x08;
 359                                         packet->data[13] = 0x00;
 360                                         break;
 361                                 case 6:
 362                                         packet->data[12] = 0x86;
 363                                         packet->data[13] = 0xDD;
 364                                         break;
 365                                 default:
 366                                         ifdebug(TRAFFIC) logger(LOG_ERR,
 367                                                            "Unknown IP version %d while reading packet from %s %s",
 368                                                            packet->data[14] >> 4, device_info, device);
 369                                         return false;
 370                         }
 371
 372                         memset(packet->data, 0, 12);
 373                         packet->len = lenin + 10;
 374                         break;
 375                 }
 376
 377                 case DEVICE_TYPE_TAP:
 378                         if((lenin = read(device_fd, packet->data, MTU)) <= 0) {
 379                                 logger(LOG_ERR, "Error while reading from %s %s: %s", device_info,
 380                                            device, strerror(errno));
 381                                 return false;
 382                         }
 383
 384                         packet->len = lenin;
 385                         break;
 386
 387                 default:
 388                         return false;
 389         }
 390
 391         device_total_in += packet->len;
 392
 393         ifdebug(TRAFFIC) logger(LOG_DEBUG, "Read packet of %d bytes from %s",
 394                            packet->len, device_info);
 395
 396         return true;
 397 }
 398
 399 static bool write_packet(vpn_packet_t *packet) {
 400         ifdebug(TRAFFIC) logger(LOG_DEBUG, "Writing packet of %d bytes to %s",
 401                            packet->len, device_info);
 402
 403         switch(device_type) {
 404                 case DEVICE_TYPE_TUN:
 405                         if(write(device_fd, packet->data + 14, packet->len - 14) < 0) {
 406                                 logger(LOG_ERR, "Error while writing to %s %s: %s", device_info,
 407                                            device, strerror(errno));
 408                                 return false;
 409                         }
 410                         break;
 411
 412                 case DEVICE_TYPE_UTUN:
 413                 case DEVICE_TYPE_TUNIFHEAD: {
 414                         int af = (packet->data[12] << 8) + packet->data[13];
 415                         uint32_t type;
 416
 417                         switch (af) {
 418                                 case 0x0800:
 419                                         type = htonl(AF_INET);
 420                                         break;
 421                                 case 0x86DD:
 422                                         type = htonl(AF_INET6);
 423                                         break;
 424                                 default:
 425                                         ifdebug(TRAFFIC) logger(LOG_ERR,
 426                                                            "Unknown address family %x while writing packet to %s %s",
 427                                                            af, device_info, device);
 428                                         return false;
 429                         }
 430
 431                         memcpy(packet->data + 10, &type, sizeof type);
 432
 433                         if(write(device_fd, packet->data + 10, packet->len - 10) < 0) {
 434                                 logger(LOG_ERR, "Can't write to %s %s: %s", device_info, device,
 435                                            strerror(errno));
 436                                 return false;
 437                         }
 438                         break;
 439                 }
 440
 441                 case DEVICE_TYPE_TAP:
 442                         if(write(device_fd, packet->data, packet->len) < 0) {
 443                                 logger(LOG_ERR, "Error while writing to %s %s: %s", device_info,
 444                                            device, strerror(errno));
 445                                 return false;
 446                         }
 447                         break;
 448
 449 #ifdef ENABLE_TUNEMU
 450                 case DEVICE_TYPE_TUNEMU:
 451                         if(tunemu_write(device_fd, packet->data + 14, packet->len - 14) < 0) {
 452                                 logger(LOG_ERR, "Error while writing to %s %s: %s", device_info,
 453                                            device, strerror(errno));
 454                                 return false;
 455                         }
 456                         break;
 457 #endif
 458
 459                 default:
 460                         return false;
 461         }
 462
 463         device_total_out += packet->len;
 464
 465         return true;
 466 }
 467
 468 static void dump_device_stats(void) {
 469         logger(LOG_DEBUG, "Statistics for %s %s:", device_info, device);
 470         logger(LOG_DEBUG, " total bytes in:  %10"PRIu64, device_total_in);
 471         logger(LOG_DEBUG, " total bytes out: %10"PRIu64, device_total_out);
 472 }
 473
 474 const devops_t os_devops = {
 475         .setup = setup_device,
 476         .close = close_device,
 477         .read = read_packet,
 478         .write = write_packet,
 479         .dump_stats = dump_device_stats,
 480 };