Update copyright notices.
[tinc] / src / mingw / device.c
index d8aabcc..3ff6759 100644 (file)
-/*\r
-    device.c -- Interaction with CIPE driver in a MinGW environment\r
-    Copyright (C) 2002-2003 Ivo Timmermans <ivo@o2w.nl>,\r
-                  2002-2003 Guus Sliepen <guus@sliepen.eu.org>\r
-\r
-    This program is free software; you can redistribute it and/or modify\r
-    it under the terms of the GNU General Public License as published by\r
-    the Free Software Foundation; either version 2 of the License, or\r
-    (at your option) any later version.\r
-\r
-    This program is distributed in the hope that it will be useful,\r
-    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-    GNU General Public License for more details.\r
-\r
-    You should have received a copy of the GNU General Public License\r
-    along with this program; if not, write to the Free Software\r
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.\r
-\r
-    $Id: device.c,v 1.1.2.2 2003/07/22 20:55:21 guus Exp $\r
-*/\r
-\r
-#error "Device driver for MinGW environment not written yet!"\r
-\r
-#include "system.h"\r
-\r
-#include <winioctl.h>\r
-\r
-#include "conf.h"\r
-#include "logger.h"\r
-#include "net.h"\r
-#include "route.h"\r
-#include "utils.h"\r
-#include "xalloc.h"\r
-\r
-/* Definitions from CIPE */\r
-\r
-#define NETCARD_REG_KEY_2000 "SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}"\r
-#define NETCARD_REG_KEY      "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\NetworkCards"\r
-#define REG_SERVICE_KEY      "SYSTEM\\CurrentControlSet\\Services"\r
-\r
-#define USERMODEDEVICEDIR "\\\\.\\"\r
-#define SYSDEVICEDIR  "\\Device\\"\r
-#define USERDEVICEDIR "\\??\\"\r
-#define TAPSUFFIX     ".tap"\r
-\r
-#define PRODUCT_STRING "DKW Heavy Industries VPN Adapter."\r
-#define CIPE_SERVICE_NAME "CIPE_Daemon"\r
-#define CIPE_DRIVER_NAME "CIPE"\r
-\r
-#define CIPE_NDIS_MAJOR_VERSION 4\r
-#define CIPE_NDIS_MINOR_VERSION 0\r
-\r
-#ifndef CIPE_DRIVER_MAJOR_VERSION\r
-#   define CIPE_DRIVER_MAJOR_VERSION 2\r
-#endif\r
-\r
-#ifndef CIPE_DRIVER_MINOR_VERSION\r
-#   define CIPE_DRIVER_MINOR_VERSION 1\r
-#endif\r
-\r
-#ifndef CIPE_MAC_ROOT_ADDRESS\r
-#   define CIPE_MAC_ROOT_ADDRESS "8:0:58:0:0:1"\r
-#endif\r
-\r
-#define CIPE_CONTROL_CODE(request,method) CTL_CODE (FILE_DEVICE_PHYSICAL_NETCARD | 8000, request, method, FILE_ANY_ACCESS)\r
-\r
-#define CIPE_IOCTL_GET_LASTMAC    CIPE_CONTROL_CODE (0, METHOD_BUFFERED)\r
-#define CIPE_IOCTL_GET_MAC        CIPE_CONTROL_CODE (1, METHOD_BUFFERED)\r
-#define CIPE_IOCTL_SET_STATISTICS CIPE_CONTROL_CODE (2, METHOD_BUFFERED)\r
-\r
-/* Windows 2000 */\r
-#define OSTYPE 5\r
-\r
-int device_fd = -1;\r
-char *device = NULL;\r
-char *iface = NULL;\r
-char *device_info = NULL;\r
-\r
-int device_total_in = 0;\r
-int device_total_out = 0;\r
-\r
-HANDLE handle;\r
-\r
-pid_t reader_pid;\r
-int sp[2];\r
-\r
-bool setup_device(void)\r
-{\r
-       HKEY key, key2, adapterkey;\r
-       int i;\r
-\r
-       char adapterid[1024];\r
-       char manufacturer[1024];\r
-       char productname[1024];\r
-       char adaptername[1024];\r
-       char tapname[1024];\r
-       char gelukt = 0;\r
-       long len;\r
-\r
-       FILETIME filetime;\r
-       bool found = false;\r
-\r
-       cp();\r
-\r
-       get_config_string(lookup_config(config_tree, "Device"), &device);\r
-\r
-       /* Open registry and look for network adapters */\r
-\r
-       if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, (OSTYPE > 4 ? NETCARD_REG_KEY_2000 : NETCARD_REG_KEY), 0, KEY_READ, &key)) {\r
-               logger(LOG_ERR, _("Unable to read registry"));\r
-               return false;\r
-       }\r
-\r
-       for (i = 0; ; i++) {\r
-               len = sizeof(adapterid);\r
-               if(RegEnumKeyEx (key, i, adapterid, &len, 0, 0, 0, &filetime))\r
-                       break;\r
-\r
-               /* Find out more about this adapter */\r
-\r
-                if(RegOpenKeyEx (key, adapterid, 0, KEY_READ, &adapterkey)) {\r
-                       logger(LOG_ERR, _("Unable to read registry"));\r
-                       return false;\r
-               }\r
-\r
-               len = sizeof(productname);\r
-               if(RegQueryValueEx(adapterkey, "ProductName", 0, 0, productname, &len))\r
-                       goto skip;\r
-\r
-               len = sizeof(manufacturer);\r
-               if(RegQueryValueEx(adapterkey, "Manufacturer", 0, 0, manufacturer, &len))\r
-                       goto skip;\r
-\r
-               if(!strcmp(productname, "CIPE") && !strcmp(manufacturer, "DKWHeavyIndustries")) {\r
-                       if(device && strcmp(adapterid, device))\r
-                               continue;\r
-                       if(!device)\r
-                               device = xstrdup(adapterid);\r
-                       found = true;\r
-                       break;\r
-               }\r
-               \r
-skip:\r
-                RegCloseKey (adapterkey);\r
-       }\r
-\r
-       if(!found) {\r
-               logger(LOG_ERR, _("No CIPE adapters found!"));\r
-               return false;\r
-       }\r
-\r
-       /* Get adapter name */\r
-\r
-       len = sizeof(adaptername);\r
-       RegQueryValueEx(adapterkey, (OSTYPE > 4 ? "NetCfgInstanceId" : "ServiceName"), 0, 0, adaptername, &len);\r
-\r
-       /* FIXME? cipsrvr checks if the device is in use at this point */\r
-\r
-       /* Try to open the corresponding tap device */\r
-\r
-       snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, adaptername);\r
-       \r
-       /* Now we are going to open this device twice: once for reading and once for writing.\r
-          We do this because apparently it isn't possible to check for activity in the select() loop.\r
-          Furthermore I don't really know how to do it the "Windows" way. */\r
-\r
-       if(socketpair(AF_UNIX, SOCK_DGRAM, PF_UNIX, sp)) {\r
-               logger(LOG_DEBUG, _("System call `%s' failed: %s"), "socketpair", strerror(errno));\r
-               return false;\r
-       }\r
-\r
-       reader_pid = fork();\r
-\r
-       if(reader_pid == -1) {\r
-               logger(LOG_DEBUG, _("System call `%s' failed: %s"), "fork", strerror(errno));\r
-               return false;\r
-       }\r
-\r
-       if(!reader_pid) {\r
-               /* The child opens the tap device for reading, blocking.\r
-                  It passes everything it reads to the socket. */\r
-       \r
-               char buf[MTU];\r
-               int lenin;\r
-\r
-               handle = CreateFile(tapname, GENERIC_READ,  FILE_SHARE_WRITE,  0,  OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM , 0);\r
-\r
-               if(handle == INVALID_HANDLE_VALUE) {\r
-                       logger(LOG_ERR, _("Could not open CIPE tap device for reading!"));\r
-                       buf[0] = 0;\r
-                       write(sp[1], buf, 1);\r
-                       exit(1);\r
-               }\r
-\r
-               logger(LOG_DEBUG, _("Tap reader forked and running."));\r
-\r
-               /* Notify success */\r
-\r
-               buf[0] = 1;\r
-               write(sp[1], buf, 1);\r
-\r
-               /* Pass packets */\r
-\r
-               for(;;) {\r
-                       ReadFile (handle, buf, MTU, &lenin, NULL);\r
-                       write(sp[1], buf, lenin);\r
-               }\r
-       }\r
-\r
-       /* The parent opens the tap device for writing. */\r
-       \r
-       handle = CreateFile(tapname, GENERIC_WRITE,  FILE_SHARE_READ,  0,  OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM , 0);\r
-       \r
-       if(handle == INVALID_HANDLE_VALUE) {\r
-               logger(LOG_ERR, _("Could not open CIPE tap device for writing!"));\r
-               return false;\r
-       }\r
-\r
-       device_fd = sp[0];\r
-\r
-       /* Get MAC address from tap device */\r
-\r
-       if(routing_mode == RMODE_ROUTER) {\r
-               DeviceIoControl (handle, CIPE_IOCTL_GET_MAC, mymac.x, sizeof(mymac.x), mymac.x, sizeof(mymac.x), &len, 0);\r
-               overwrite_mac = 1;\r
-       }\r
-\r
-       read(device_fd, &gelukt, 1);\r
-       if(gelukt != 1) {\r
-               logger(LOG_DEBUG, "Tap reader failed!");\r
-               return false;\r
-       }\r
-\r
-       if(!get_config_string(lookup_config(config_tree, "Interface"), &iface))\r
-               iface = device;\r
-\r
-       device_info = _("Cygwin CIPE device");\r
-\r
-       logger(LOG_INFO, _("%s is a %s"), device, device_info);\r
-\r
-       return true;\r
-}\r
-\r
-void close_device(void)\r
-{\r
-       cp();\r
-\r
-       close(sp[0]);\r
-       close(sp[1]);\r
-       CloseHandle(handle);\r
-\r
-       kill(reader_pid, SIGKILL);\r
-}\r
-\r
-bool read_packet(vpn_packet_t *packet)\r
-{\r
-       int lenin;\r
-\r
-       cp();\r
-\r
-       if((lenin = read(sp[0], packet->data, MTU)) <= 0) {\r
-               logger(LOG_ERR, _("Error while reading from %s %s: %s"), device_info,\r
-                          device, strerror(errno));\r
-               return false;\r
-       }\r
-       \r
-       packet->len = lenin;\r
-\r
-       device_total_in += packet->len;\r
-\r
-       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Read packet of %d bytes from %s"), packet->len,\r
-                          device_info);\r
-\r
-       return true;\r
-}\r
-\r
-bool write_packet(vpn_packet_t *packet)\r
-{\r
-       int lenout;\r
-\r
-       cp();\r
-\r
-       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Writing packet of %d bytes to %s"),\r
-                          packet->len, device_info);\r
-\r
-       if(!WriteFile (handle, packet->data, packet->len, &lenout, NULL)) {\r
-               logger(LOG_ERR, "Error while writing to %s %s", device_info, device);\r
-               return false;\r
-       }\r
-\r
-       device_total_out += packet->len;\r
-\r
-       return true;\r
-}\r
-\r
-void dump_device_stats(void)\r
-{\r
-       cp();\r
-\r
-       logger(LOG_DEBUG, _("Statistics for %s %s:"), device_info, device);\r
-       logger(LOG_DEBUG, _(" total bytes in:  %10d"), device_total_in);\r
-       logger(LOG_DEBUG, _(" total bytes out: %10d"), device_total_out);\r
-}\r
+/*
+    device.c -- Interaction with Windows tap driver in a MinGW environment
+    Copyright (C) 2002-2005 Ivo Timmermans,
+                  2002-2016 Guus Sliepen <guus@tinc-vpn.org>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#include "../system.h"
+
+#include <windows.h>
+#include <winioctl.h>
+
+#include "../conf.h"
+#include "../device.h"
+#include "../logger.h"
+#include "../net.h"
+#include "../route.h"
+#include "../utils.h"
+#include "../xalloc.h"
+
+#include "common.h"
+
+int device_fd = -1;
+static HANDLE device_handle = INVALID_HANDLE_VALUE;
+char *device = NULL;
+char *iface = NULL;
+static char *device_info = NULL;
+
+static uint64_t device_total_in = 0;
+static uint64_t device_total_out = 0;
+
+extern char *myport;
+OVERLAPPED r_overlapped;
+OVERLAPPED w_overlapped;
+
+static DWORD WINAPI tapreader(void *bla) {
+       int status;
+       DWORD len;
+       vpn_packet_t packet;
+       int errors = 0;
+
+       logger(LOG_DEBUG, "Tap reader running");
+
+       /* Read from tap device and send to parent */
+
+       r_overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
+
+       for(;;) {
+               ResetEvent(r_overlapped.hEvent);
+
+               status = ReadFile(device_handle, packet.data, MTU, &len, &r_overlapped);
+
+               if(!status) {
+                       if(GetLastError() == ERROR_IO_PENDING) {
+                               WaitForSingleObject(r_overlapped.hEvent, INFINITE);
+                               if(!GetOverlappedResult(device_handle, &r_overlapped, &len, FALSE))
+                                       continue;
+                       } else {
+                               logger(LOG_ERR, "Error while reading from %s %s: %s", device_info,
+                                          device, strerror(errno));
+                               errors++;
+                               if(errors >= 10) {
+                                       EnterCriticalSection(&mutex);
+                                       running = false;
+                                       LeaveCriticalSection(&mutex);
+                               }
+                               usleep(1000000);
+                               continue;
+                       }
+               }
+
+               errors = 0;
+               packet.len = len;
+               packet.priority = 0;
+
+               EnterCriticalSection(&mutex);
+               route(myself, &packet);
+               LeaveCriticalSection(&mutex);
+       }
+
+       return 0;
+}
+
+static bool setup_device(void) {
+       HKEY key, key2;
+       int i;
+
+       char regpath[1024];
+       char adapterid[1024];
+       char adaptername[1024];
+       char tapname[1024];
+       DWORD len;
+       unsigned long status;
+
+       bool found = false;
+
+       int err;
+       HANDLE thread;
+
+       get_config_string(lookup_config(config_tree, "Device"), &device);
+       get_config_string(lookup_config(config_tree, "Interface"), &iface);
+
+       if(device && iface)
+               logger(LOG_WARNING, "Warning: both Device and Interface specified, results may not be as expected");
+
+       /* Open registry and look for network adapters */
+
+       if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, NETWORK_CONNECTIONS_KEY, 0, KEY_READ, &key)) {
+               logger(LOG_ERR, "Unable to read registry: %s", winerror(GetLastError()));
+               return false;
+       }
+
+       for (i = 0; ; i++) {
+               len = sizeof(adapterid);
+               if(RegEnumKeyEx(key, i, adapterid, &len, 0, 0, 0, NULL))
+                       break;
+
+               /* Find out more about this adapter */
+
+               snprintf(regpath, sizeof(regpath), "%s\\%s\\Connection", NETWORK_CONNECTIONS_KEY, adapterid);
+
+                if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2))
+                       continue;
+
+               len = sizeof(adaptername);
+               err = RegQueryValueEx(key2, "Name", 0, 0, (LPBYTE)adaptername, &len);
+
+               RegCloseKey(key2);
+
+               if(err)
+                       continue;
+
+               if(device) {
+                       if(!strcmp(device, adapterid)) {
+                               found = true;
+                               break;
+                       } else
+                               continue;
+               }
+
+               if(iface) {
+                       if(!strcmp(iface, adaptername)) {
+                               found = true;
+                               break;
+                       } else
+                               continue;
+               }
+
+               snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, adapterid);
+               device_handle = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, 0);
+               if(device_handle != INVALID_HANDLE_VALUE) {
+                       found = true;
+                       break;
+               }
+       }
+
+       RegCloseKey(key);
+
+       if(!found) {
+               logger(LOG_ERR, "No Windows tap device found!");
+               return false;
+       }
+
+       if(!device)
+               device = xstrdup(adapterid);
+
+       if(!iface)
+               iface = xstrdup(adaptername);
+
+       /* Try to open the corresponding tap device */
+
+       if(device_handle == INVALID_HANDLE_VALUE) {
+               snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, device);
+               device_handle = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, 0);
+       }
+       
+       if(device_handle == INVALID_HANDLE_VALUE) {
+               logger(LOG_ERR, "%s (%s) is not a usable Windows tap device: %s", device, iface, winerror(GetLastError()));
+               return false;
+       }
+
+       /* Get MAC address from tap device */
+
+       if(!DeviceIoControl(device_handle, TAP_IOCTL_GET_MAC, mymac.x, sizeof(mymac.x), mymac.x, sizeof(mymac.x), &len, 0)) {
+               logger(LOG_ERR, "Could not get MAC address from Windows tap device %s (%s): %s", device, iface, winerror(GetLastError()));
+               return false;
+       }
+
+       if(routing_mode == RMODE_ROUTER) {
+               overwrite_mac = 1;
+       }
+
+       /* Create overlapped events for tap I/O */
+
+       r_overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
+       w_overlapped.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL);
+
+       /* Start the tap reader */
+
+       thread = CreateThread(NULL, 0, tapreader, NULL, 0, NULL);
+
+       if(!thread) {
+               logger(LOG_ERR, "System call `%s' failed: %s", "CreateThread", winerror(GetLastError()));
+               return false;
+       }
+
+       /* Set media status for newer TAP-Win32 devices */
+
+       status = true;
+       DeviceIoControl(device_handle, TAP_IOCTL_SET_MEDIA_STATUS, &status, sizeof(status), &status, sizeof(status), &len, NULL);
+
+       device_info = "Windows tap device";
+
+       logger(LOG_INFO, "%s (%s) is a %s", device, iface, device_info);
+
+       return true;
+}
+
+static void close_device(void) {
+       CloseHandle(device_handle);
+
+       free(device);
+       free(iface);
+}
+
+static bool read_packet(vpn_packet_t *packet) {
+       return false;
+}
+
+static bool write_packet(vpn_packet_t *packet) {
+       DWORD lenout;
+       static vpn_packet_t queue;
+
+       ifdebug(TRAFFIC) logger(LOG_DEBUG, "Writing packet of %d bytes to %s",
+                          packet->len, device_info);
+
+       /* Check if there is something in progress */
+
+       if(queue.len) {
+               DWORD size;
+               BOOL success = GetOverlappedResult(device_handle, &w_overlapped, &size, FALSE);
+               if(success) {
+                       ResetEvent(&w_overlapped);
+                       queue.len = 0;
+               } else {
+                       int err = GetLastError();
+                       if(err != ERROR_IO_INCOMPLETE) {
+                               ifdebug(TRAFFIC) logger(LOG_DEBUG, "Error completing previously queued write: %s", winerror(err));
+                               ResetEvent(&w_overlapped);
+                               queue.len = 0;
+                       } else {
+                               ifdebug(TRAFFIC) logger(LOG_DEBUG, "Previous overlapped write still in progress");
+                               // drop this packet
+                               return true;
+                       }
+               }
+       }
+
+       /* Otherwise, try to write. */
+
+       memcpy(queue.data, packet->data, packet->len);
+
+       if(!WriteFile(device_handle, queue.data, packet->len, &lenout, &w_overlapped)) {
+               int err = GetLastError();
+               if(err != ERROR_IO_PENDING) {
+                       logger(LOG_ERR, "Error while writing to %s %s: %s", device_info, device, winerror(err));
+                       return false;
+               }
+               // Write is being done asynchronously.
+               queue.len = packet->len;
+       } else {
+               // Write was completed immediately.
+               ResetEvent(&w_overlapped);
+       }
+
+       device_total_out += packet->len;
+
+       return true;
+}
+
+static void dump_device_stats(void) {
+       logger(LOG_DEBUG, "Statistics for %s %s:", device_info, device);
+       logger(LOG_DEBUG, " total bytes in:  %10"PRIu64, device_total_in);
+       logger(LOG_DEBUG, " total bytes out: %10"PRIu64, device_total_out);
+}
+
+const devops_t os_devops = {
+       .setup = setup_device,
+       .close = close_device,
+       .read = read_packet,
+       .write = write_packet,
+       .dump_stats = dump_device_stats,
+};