More generic handling of tap device under Windows.
[tinc] / src / mingw / device.c
index d8aabcc..4a962fe 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 CIPE driver in a MinGW environment
+    Copyright (C) 2002-2003 Ivo Timmermans <ivo@o2w.nl>,
+                  2002-2003 Guus Sliepen <guus@sliepen.eu.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., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+    $Id: device.c,v 1.1.2.3 2003/07/28 21:54:03 guus Exp $
+*/
+
+#include "system.h"
+
+#include <windows.h>
+#include <winioctl.h>
+
+#include "conf.h"
+#include "logger.h"
+#include "net.h"
+#include "route.h"
+#include "utils.h"
+#include "xalloc.h"
+
+#define NETCARD_REG_KEY_2000 "SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
+#define NETCARD_REG_KEY      "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\NetworkCards"
+#define REG_SERVICE_KEY      "SYSTEM\\CurrentControlSet\\Services"
+#define REG_CONTROL_NET      "SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}"
+
+#define USERMODEDEVICEDIR "\\\\.\\"
+#define SYSDEVICEDIR  "\\Device\\"
+#define USERDEVICEDIR "\\??\\"
+#define TAPSUFFIX     ".tap"
+
+#define TAP_CONTROL_CODE(request,method) CTL_CODE(FILE_DEVICE_PHYSICAL_NETCARD | 8000, request, method, FILE_ANY_ACCESS)
+
+#define TAP_IOCTL_GET_LASTMAC    TAP_CONTROL_CODE(0, METHOD_BUFFERED)
+#define TAP_IOCTL_GET_MAC        TAP_CONTROL_CODE(1, METHOD_BUFFERED)
+#define TAP_IOCTL_SET_STATISTICS TAP_CONTROL_CODE(2, METHOD_BUFFERED)
+
+/* FIXME: This only works for Windows 2000 */
+#define OSTYPE 5
+
+HANDLE device_fd = INVALID_HANDLE_VALUE;
+char *device = NULL;
+char *iface = NULL;
+char *device_info = NULL;
+
+int device_total_in = 0;
+int device_total_out = 0;
+
+bool setup_device(void)
+{
+       HKEY key, key2;
+       int i;
+
+       char regpath[1024];
+       char adapterid[1024];
+       char adaptername[1024];
+       char tapname[1024];
+       char gelukt = 0;
+       long len;
+
+       bool found = false;
+
+       cp();
+
+       get_config_string(lookup_config(config_tree, "Device"), &device);
+       get_config_string(lookup_config(config_tree, "Interface"), &iface);
+
+       /* Open registry and look for network adapters */
+
+       if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, REG_CONTROL_NET, 0, KEY_READ, &key)) {
+               logger(LOG_ERR, _("Unable to read registry"));
+               return false;
+       }
+
+       for (i = 0; ; i++) {
+               len = sizeof(adapterid);
+               if(RegEnumKeyEx(key, i, adapterid, &len, 0, 0, 0, NULL))
+                       break;
+
+               if(device) {
+                       if(!strcmp(device, adapterid)) {
+                               found = true;
+                               break;
+                       } else
+                               continue;
+               }
+
+               /* Find out more about this adapter */
+
+               snprintf(regpath, sizeof(regpath), "%s\\%s\\Connection", REG_CONTROL_NET, adapterid);
+
+                if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, regpath, 0, KEY_READ, &key2)) {
+                       logger(LOG_ERR, _("Unable to read registry"));
+                       return false;
+               }
+
+               len = sizeof(adaptername);
+               RegQueryValueEx(key2, "Name", 0, 0, adaptername, &len);
+
+               if(iface) {
+                       if(!strcmp(iface, adaptername)) {
+                               found = true;
+                               break;
+                       } else
+                               continue;
+               }
+
+               snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, adapterid);
+               device_fd = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
+               if(device_fd != INVALID_HANDLE_VALUE) {
+                       found = true;
+                       break;
+               }
+       }
+
+       if(!found) {
+               logger(LOG_ERR, _("No Windows tap device found!"));
+               return false;
+       }
+
+       device = adapterid;
+       iface = adaptername;
+
+       /* Try to open the corresponding tap device */
+
+       if(device_fd == INVALID_HANDLE_VALUE) {
+               snprintf(tapname, sizeof(tapname), USERMODEDEVICEDIR "%s" TAPSUFFIX, device);
+               device_fd = CreateFile(tapname, GENERIC_WRITE | GENERIC_READ, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_SYSTEM, 0);
+       }
+       
+       if(device_fd == INVALID_HANDLE_VALUE) {
+               logger(LOG_ERR, _("%s (%s) is no a usable Windows tap device!"), device, iface);
+               return false;
+       }
+
+       /* Get MAC address from tap device */
+
+       if(DeviceIoControl(device_fd, 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!"));
+               return false;
+       }
+
+       if(routing_mode == RMODE_ROUTER) {
+               overwrite_mac = 1;
+       }
+
+       if(!get_config_string(lookup_config(config_tree, "Interface"), &iface))
+               iface = device;
+
+       device_info = _("Windows tap device");
+
+       logger(LOG_INFO, _("%s (%s) is a %s"), device, iface, device_info);
+
+       return true;
+}
+
+void close_device(void)
+{
+       cp();
+
+       CloseHandle(device_fd);
+}
+
+bool read_packet(vpn_packet_t *packet)
+{
+       int lenin;
+
+       cp();
+
+       if(!ReadFile(device_fd, packet->data, MTU, &lenin, NULL)) {
+               logger(LOG_ERR, _("Error while reading from %s %s: %s"), device_info,
+                          device, strerror(errno));
+               return false;
+       }
+       
+       packet->len = lenin;
+
+       device_total_in += packet->len;
+
+       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Read packet of %d bytes from %s"), packet->len,
+                          device_info);
+
+       return true;
+}
+
+bool write_packet(vpn_packet_t *packet)
+{
+       int lenout;
+
+       cp();
+
+       ifdebug(TRAFFIC) logger(LOG_DEBUG, _("Writing packet of %d bytes to %s"),
+                          packet->len, device_info);
+
+       if(!WriteFile(device_fd, packet->data, packet->len, &lenout, NULL)) {
+               logger(LOG_ERR, "Error while writing to %s %s", device_info, device);
+               return false;
+       }
+
+       device_total_out += packet->len;
+
+       return true;
+}
+
+void dump_device_stats(void)
+{
+       cp();
+
+       logger(LOG_DEBUG, _("Statistics for %s %s:"), device_info, device);
+       logger(LOG_DEBUG, _(" total bytes in:  %10d"), device_total_in);
+       logger(LOG_DEBUG, _(" total bytes out: %10d"), device_total_out);
+}