src/solaris/device.c

   1 /*
   2     device.c -- Interaction with Solaris tun device
   3     Copyright (C) 2001-2005 Ivo Timmermans,
   4                   2002-2010 OpenVPN Technologies, Inc. <sales@openvpn.net>
   5                   2001-2013 Guus Sliepen <guus@tinc-vpn.org>
   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
  23 #include "../system.h"
  24
  25 #include <sys/stropts.h>
  26 #include <sys/sockio.h>
  27
  28 #include "../conf.h"
  29 #include "../device.h"
  30 #include "../logger.h"
  31 #include "../net.h"
  32 #include "../route.h"
  33 #include "../utils.h"
  34 #include "../xalloc.h"
  35
  36 #ifndef TUNNEWPPA
  37 #warning Missing net/if_tun.h, using hardcoded value for TUNNEWPPA
  38 #define TUNNEWPPA       (('T'<<16) | 0x0001)
  39 #endif
  40
  41 #define DEFAULT_TUN_DEVICE "/dev/tun"
  42 #define DEFAULT_TAP_DEVICE "/dev/tap"
  43
  44 static enum {
  45         DEVICE_TYPE_TUN,
  46         DEVICE_TYPE_TAP,
  47 } device_type = DEVICE_TYPE_TUN;
  48
  49 int device_fd = -1;
  50 static int if_fd = -1;
  51 static int ip_fd = -1;
  52 char *device = NULL;
  53 char *iface = NULL;
  54 static char *device_info = NULL;
  55
  56 uint64_t device_total_in = 0;
  57 uint64_t device_total_out = 0;
  58
  59 static bool setup_device(void) {
  60         char *type;
  61
  62         if(!get_config_string(lookup_config(config_tree, "Device"), &device)) {
  63                 if(routing_mode == RMODE_ROUTER)
  64                         device = xstrdup(DEFAULT_TUN_DEVICE);
  65                 else
  66                         device = xstrdup(DEFAULT_TAP_DEVICE);
  67         }
  68
  69         if(get_config_string(lookup_config(config_tree, "DeviceType"), &type)) {
  70                 if(!strcasecmp(type, "tun"))
  71                         /* use default */;
  72                 else if(!strcasecmp(type, "tap"))
  73                         device_type = DEVICE_TYPE_TAP;
  74                 else {
  75                         logger(LOG_ERR, "Unknown device type %s!", type);
  76                         return false;
  77                 }
  78         } else {
  79                 if(strstr(device, "tap") || routing_mode != RMODE_ROUTER)
  80                         device_type = DEVICE_TYPE_TAP;
  81         }
  82
  83         if(device_type == DEVICE_TYPE_TUN)
  84                 device_info = "Solaris tun device";
  85         else
  86                 device_info = "Solaris tap device";
  87
  88         /* The following is black magic copied from OpenVPN. */
  89
  90         if((ip_fd = open("/dev/ip", O_RDWR, 0)) < 0) {
  91                 logger(LOG_ERR, "Could not open %s: %s\n", "/dev/ip", strerror(errno));
  92                 return false;
  93         }
  94
  95         if((device_fd = open(device, O_RDWR, 0)) < 0) {
  96                 logger(LOG_ERR, "Could not open %s: %s\n", device, strerror(errno));
  97                 return false;
  98         }
  99
 100         /* Get unit number. */
 101
 102         char *ptr = device;
 103         get_config_string(lookup_config(config_tree, "Interface"), &ptr);
 104
 105         while(*ptr && !isdigit(*ptr))
 106                 ptr++;
 107         int ppa = atoi(ptr);
 108
 109         /* Assign a new PPA and get its unit number. */
 110
 111         struct strioctl strioc_ppa = {
 112                 .ic_cmd = TUNNEWPPA,
 113                 .ic_len = sizeof ppa,
 114                 .ic_dp = (char *)&ppa,
 115         };
 116
 117         if(!*ptr) { /* no number given, try dynamic */
 118                 bool found = false;
 119                 while(!found && ppa < 64) {
 120                         int new_ppa = ioctl(device_fd, I_STR, &strioc_ppa);
 121                         if(new_ppa >= 0) {
 122                                 ppa = new_ppa;
 123                                 found = true;
 124                                 break;
 125                         }
 126                         ppa++;
 127                 }
 128                 if(!found) {
 129                         logger(LOG_ERR, "Could not find free PPA for %s %s!", device_info, device);
 130                         return false;
 131                 }
 132         } else { /* try this particular one */
 133                 if((ppa = ioctl(device_fd, I_STR, &strioc_ppa)) < 0) {
 134                         logger(LOG_ERR, "Could not assign PPA %d for %s %s!", ppa, device_info, device);
 135                         return false;
 136                 }
 137         }
 138
 139         if((if_fd = open(device, O_RDWR, 0)) < 0) {
 140                 logger(LOG_ERR, "Could not open %s: %s\n", device, strerror(errno));
 141                 return false;
 142         }
 143
 144         if(ioctl(if_fd, I_PUSH, "ip") < 0) {
 145                 logger(LOG_ERR, "Could not push IP module onto %s %s!", device_info, device);
 146                 return false;
 147         }
 148
 149         xasprintf(&iface, "%s%d", device_type == DEVICE_TYPE_TUN ? "tun" : "tap", ppa);
 150
 151         {
 152                 /* Remove muxes just in case they are left over from a crashed tincd */
 153                 struct lifreq ifr = {};
 154                 strncpy(ifr.lifr_name, iface, sizeof ifr.lifr_name);
 155                 if(ioctl(ip_fd, SIOCGLIFMUXID, &ifr) >= 0) {
 156                         int muxid = ifr.lifr_arp_muxid;
 157                         ioctl(ip_fd, I_PUNLINK, muxid);
 158                         muxid = ifr.lifr_ip_muxid;
 159                         ioctl(ip_fd, I_PUNLINK, muxid);
 160                 }
 161         }
 162
 163         if(device_type == DEVICE_TYPE_TUN) {
 164                 /* Assign ppa according to the unit number returned by tun device */
 165                 if(ioctl(if_fd, IF_UNITSEL, (char *)&ppa) < 0) {
 166                         logger(LOG_ERR, "Could not set PPA %d on %s %s!", ppa, device_info, device);
 167                         return false;
 168                 }
 169         }
 170
 171         int arp_fd = -1;
 172
 173         if(device_type == DEVICE_TYPE_TAP) {
 174                 struct lifreq ifr = {};
 175
 176                 if(ioctl(if_fd, SIOCGLIFFLAGS, &ifr) < 0) {
 177                         logger(LOG_ERR, "Could not set flags on %s %s!", device_info, device);
 178                         return false;
 179                 }
 180
 181                 strncpy(ifr.lifr_name, iface, sizeof(ifr.lifr_name));
 182                 ifr.lifr_ppa = ppa;
 183
 184                 /* Assign ppa according to the unit number returned by tun device */
 185                 if(ioctl(if_fd, SIOCSLIFNAME, &ifr) < 0) {
 186                         logger(LOG_ERR, "Could not set PPA %d on %s %s!", ppa, device_info, device);
 187                         return false;
 188                 }
 189                 if(ioctl(if_fd, SIOCGLIFFLAGS, &ifr) < 0) {
 190                         logger(LOG_ERR, "Could not set flags on %s %s!", device_info, device);
 191                         return false;
 192                 }
 193
 194                 /* Push arp module to if_fd */
 195                 if(ioctl(if_fd, I_PUSH, "arp") < 0) {
 196                         logger(LOG_ERR, "Could not push ARP module onto %s %s!", device_info, device);
 197                         return false;
 198                 }
 199
 200                 /* Pop any modules on the stream */
 201                 while(true) {
 202                         if(ioctl(ip_fd, I_POP, NULL) < 0)
 203                                 break;
 204                 }
 205
 206                 /* Push arp module to ip_fd */
 207                 if(ioctl(ip_fd, I_PUSH, "arp") < 0) {
 208                         logger(LOG_ERR, "Could not push ARP module onto %s!", "/dev/ip");
 209                         return false;
 210                 }
 211
 212                 /* Open arp_fd */
 213                 if((arp_fd = open(device, O_RDWR, 0)) < 0) {
 214                         logger(LOG_ERR, "Could not open %s: %s\n", device, strerror(errno));
 215                         return false;
 216                 }
 217
 218                 /* Push arp module to arp_fd */
 219                 if(ioctl(arp_fd, I_PUSH, "arp") < 0) {
 220                         logger(LOG_ERR, "Could not push ARP module onto %s %s!", device_info, device);
 221                         return false;
 222                 }
 223
 224                 /* Set ifname to arp */
 225                 struct strioctl strioc_if = {
 226                         .ic_cmd = SIOCSLIFNAME,
 227                         .ic_len = sizeof ifr,
 228                         .ic_dp = (char *)&ifr,
 229                 };
 230
 231                 if(ioctl(arp_fd, I_STR, &strioc_if) < 0) {
 232                         logger(LOG_ERR, "Could not set ifname to %s %s", device_info, device);
 233                         return false;
 234                 }
 235         }
 236
 237         int ip_muxid, arp_muxid;
 238
 239         if((ip_muxid = ioctl(ip_fd, I_PLINK, if_fd)) < 0) {
 240                 logger(LOG_ERR, "Could not link %s %s to IP", device_info, device);
 241                 return false;
 242         }
 243
 244         if(device_type == DEVICE_TYPE_TAP) {
 245                 if((arp_muxid = ioctl(ip_fd, I_PLINK, arp_fd)) < 0) {
 246                         logger(LOG_ERR, "Could not link %s %s to ARP", device_info, device);
 247                         return false;
 248                 }
 249                 close(arp_fd);
 250         }
 251
 252         struct lifreq ifr = {};
 253         strncpy(ifr.lifr_name, iface, sizeof(ifr.lifr_name));
 254         ifr.lifr_ip_muxid = ip_muxid;
 255         if(device_type == DEVICE_TYPE_TAP) {
 256                 ifr.lifr_arp_muxid = arp_muxid;
 257         }
 258
 259         if(ioctl(ip_fd, SIOCSLIFMUXID, &ifr) < 0) {
 260                 if(device_type == DEVICE_TYPE_TAP) {
 261                         ioctl(ip_fd, I_PUNLINK, arp_muxid);
 262                 }
 263                 ioctl(ip_fd, I_PUNLINK, ip_muxid);
 264                 logger(LOG_ERR, "Could not set multiplexor id for %s %s", device_info, device);
 265                 return false;
 266         }
 267
 268         close(if_fd);
 269
 270 #ifdef FD_CLOEXEC
 271         fcntl(device_fd, F_SETFD, FD_CLOEXEC);
 272         fcntl(ip_fd, F_SETFD, FD_CLOEXEC);
 273 #endif
 274
 275         logger(LOG_INFO, "%s is a %s", device, device_info);
 276
 277         return true;
 278 }
 279
 280 static void close_device(void) {
 281         if(iface) {
 282                 struct lifreq ifr = {};
 283                 strncpy(ifr.lifr_name, iface, sizeof ifr.lifr_name);
 284                 if(ioctl(ip_fd, SIOCGLIFMUXID, &ifr) >= 0) {
 285                         int muxid = ifr.lifr_arp_muxid;
 286                         ioctl(ip_fd, I_PUNLINK, muxid);
 287                         muxid = ifr.lifr_ip_muxid;
 288                         ioctl(ip_fd, I_PUNLINK, muxid);
 289                 }
 290         }
 291
 292         close(ip_fd);
 293         close(device_fd);
 294
 295         free(device);
 296         free(iface);
 297 }
 298
 299 static bool read_packet(vpn_packet_t *packet) {
 300         int inlen;
 301
 302         switch(device_type) {
 303                 case DEVICE_TYPE_TUN:
 304                         if((inlen = read(device_fd, packet->data + 14, MTU - 14)) <= 0) {
 305                                 logger(LOG_ERR, "Error while reading from %s %s: %s", device_info, device, strerror(errno));
 306                                 return false;
 307                         }
 308
 309                         switch(packet->data[14] >> 4) {
 310                                 case 4:
 311                                         packet->data[12] = 0x08;
 312                                         packet->data[13] = 0x00;
 313                                         break;
 314                                 case 6:
 315                                         packet->data[12] = 0x86;
 316                                         packet->data[13] = 0xDD;
 317                                         break;
 318                                 default:
 319                                         logger(DEBUG_TRAFFIC, LOG_ERR, "Unknown IP version %d while reading packet from %s %s", packet->data[14] >> 4, device_info, device);
 320                                         return false;
 321                         }
 322
 323                         memset(packet->data, 0, 12);
 324                         packet->len = inlen + 14;
 325                         break;
 326
 327                 case DEVICE_TYPE_TAP:
 328                         if((inlen = read(device_fd, packet->data, MTU)) <= 0) {
 329                                 logger(LOG_ERR, "Error while reading from %s %s: %s", device_info, device, strerror(errno));
 330                                 return false;
 331                         }
 332
 333                         packet->len = inlen + 14;
 334                         break;
 335
 336                 default:
 337                         abort();
 338         }
 339
 340         device_total_in += packet->len;
 341
 342         logger(DEBUG_TRAFFIC, LOG_DEBUG, "Read packet of %d bytes from %s", packet->len, device_info);
 343
 344         return true;
 345 }
 346
 347 static bool write_packet(vpn_packet_t *packet) {
 348         logger(DEBUG_TRAFFIC, LOG_DEBUG, "Writing packet of %d bytes to %s", packet->len, device_info);
 349
 350         switch(device_type) {
 351                 case DEVICE_TYPE_TUN:
 352                         if(write(device_fd, packet->data + 14, packet->len - 14) < 0) {
 353                                 logger(LOG_ERR, "Can't write to %s %s: %s", device_info, device, strerror(errno));
 354                                 return false;
 355                         }
 356                         break;
 357
 358                 case DEVICE_TYPE_TAP:
 359                         if(write(device_fd, packet->data, packet->len) < 0) {
 360                                 logger(LOG_ERR, "Can't write to %s %s: %s", device_info, device, strerror(errno));
 361                                 return false;
 362                         }
 363                         break;
 364
 365                 default:
 366                         abort();
 367         }
 368
 369         device_total_out += packet->len;
 370
 371         return true;
 372 }
 373
 374 static void dump_device_stats(void) {
 375         logger(LOG_DEBUG, "Statistics for %s %s:", device_info, device);
 376         logger(LOG_DEBUG, " total bytes in:  %10"PRIu64, device_total_in);
 377         logger(LOG_DEBUG, " total bytes out: %10"PRIu64, device_total_out);
 378 }
 379
 380 const devops_t os_devops = {
 381         .setup = setup_device,
 382         .close = close_device,
 383         .read = read_packet,
 384         .write = write_packet,
 385         .dump_stats = dump_device_stats,
 386 };