Initial import of STUN support
[oweals/gnunet.git] / src / nat / nat.c
index bb51f43b2045ee117b14b5b1f19d55d0f76669af..907728fb4dd4ea452e83b2742de2457f8a8d4b71 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -69,6 +69,11 @@ enum LocalAddressSource
    * given in the configuration (i.e. hole-punched DynDNS setup).
    */
   LAL_EXTERNAL_IP,
+  
+   /**
+   * Address was obtained by an external STUN server
+   */
+  LAL_EXTERNAL_STUN_IP,
 
   /**
    * Address was obtained by DNS resolution of the external hostname
@@ -230,27 +235,22 @@ struct GNUNET_NAT_Handle
   /**
    * ID of select gnunet-helper-nat-server stdout read task
    */
-  GNUNET_SCHEDULER_TaskIdentifier server_read_task;
+  struct GNUNET_SCHEDULER_Task * server_read_task;
 
   /**
    * ID of interface IP-scan task
    */
-  GNUNET_SCHEDULER_TaskIdentifier ifc_task;
+  struct GNUNET_SCHEDULER_Task * ifc_task;
 
   /**
    * ID of hostname DNS lookup task
    */
-  GNUNET_SCHEDULER_TaskIdentifier hostname_task;
+  struct GNUNET_SCHEDULER_Task * hostname_task;
 
   /**
    * ID of DynDNS lookup task
    */
-  GNUNET_SCHEDULER_TaskIdentifier dns_task;
-
-  /**
-   * ID of task to add addresses from bind.
-   */
-  GNUNET_SCHEDULER_TaskIdentifier bind_task;
+  struct GNUNET_SCHEDULER_Task *dns_task;
 
   /**
    * How often do we scan for changes in our IP address from our local
@@ -710,7 +710,7 @@ process_interfaces (void *cls, const char *name, int isDefault,
     {
       return GNUNET_OK;
     }
-    if (GNUNET_YES == h->use_localaddresses)
+    if ((GNUNET_YES == h->use_localaddresses) || (value != 0))
     {
       add_ip_to_address_list (h, LAL_INTERFACE_ADDRESS, &s4->sin_addr,
                               sizeof (struct in_addr));
@@ -758,7 +758,7 @@ process_interfaces (void *cls, const char *name, int isDefault,
     return GNUNET_OK;
   }
   if ((h->internal_address == NULL) && (h->server_proc == NULL) &&
-      (h->server_read_task == GNUNET_SCHEDULER_NO_TASK) &&
+      (h->server_read_task == NULL) &&
       (GNUNET_YES == isDefault) && ((addr->sa_family == AF_INET) ||
                                     (addr->sa_family == AF_INET6)))
   {
@@ -784,7 +784,7 @@ restart_nat_server (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_NAT_Handle *h = cls;
 
-  h->server_read_task = GNUNET_SCHEDULER_NO_TASK;
+  h->server_read_task = NULL;
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
     return;
   start_gnunet_nat_server (h);
@@ -811,7 +811,7 @@ nat_server_read (void *cls,
   const char *port_start;
   struct sockaddr_in sin_addr;
 
-  h->server_read_task = GNUNET_SCHEDULER_NO_TASK;
+  h->server_read_task = NULL;
   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
     return;
   memset (mybuf, 0, sizeof (mybuf));
@@ -946,7 +946,7 @@ list_interfaces (void *cls,
 {
   struct GNUNET_NAT_Handle *h = cls;
 
-  h->ifc_task = GNUNET_SCHEDULER_NO_TASK;
+  h->ifc_task = NULL;
   remove_from_address_list_by_source (h, LAL_INTERFACE_ADDRESS);
   GNUNET_OS_network_interfaces_list (&process_interfaces, h);
   h->ifc_task =
@@ -967,7 +967,7 @@ resolve_hostname (void *cls,
 {
   struct GNUNET_NAT_Handle *h = cls;
 
-  h->hostname_task = GNUNET_SCHEDULER_NO_TASK;
+  h->hostname_task = NULL;
   remove_from_address_list_by_source (h, LAL_HOSTNAME_DNS);
   h->hostname_dns =
       GNUNET_RESOLVER_hostname_resolve (AF_UNSPEC, HOSTNAME_RESOLVE_TIMEOUT,
@@ -989,7 +989,7 @@ resolve_dns (void *cls,
   struct GNUNET_NAT_Handle *h = cls;
   struct LocalAddressList *pos;
 
-  h->dns_task = GNUNET_SCHEDULER_NO_TASK;
+  h->dns_task = NULL;
   for (pos = h->lal_head; NULL != pos; pos = pos->next)
     if (pos->source == LAL_EXTERNAL_IP)
       pos->source = LAL_EXTERNAL_IP_OLD;
@@ -1011,41 +1011,64 @@ resolve_dns (void *cls,
  *     the previous (now invalid) one
  * @param addr either the previous or the new public IP address
  * @param addrlen actual lenght of @a addr
- * @param emsg NULL on success, otherwise an error message
+ * @param ret GNUNET_NAT_ERROR_SUCCESS on success, otherwise an error code
  */
 static void
 upnp_add (void *cls,
           int add_remove,
           const struct sockaddr *addr,
           socklen_t addrlen,
-          const char *emsg)
+          enum GNUNET_NAT_StatusCode ret)
 {
   struct GNUNET_NAT_Handle *h = cls;
   struct LocalAddressList *pos;
   struct LocalAddressList *next;
 
+
+  if (GNUNET_NAT_ERROR_SUCCESS != ret)
+  {
+    /* Error while running upnp client */
+    LOG (GNUNET_ERROR_TYPE_ERROR,
+          _("Error while running upnp client:\n"));
+
+    //FIXME: convert error code to string
+
+    return;
+  }
+
   if (GNUNET_YES == add_remove)
   {
     add_to_address_list (h, LAL_UPNP, addr, addrlen);
     return;
   }
-  /* remove address */
-  next = h->lal_head;
-  while (NULL != (pos = next))
+  else if (GNUNET_NO == add_remove)
   {
-    next = pos->next;
-    if ((pos->source != LAL_UPNP) || (pos->addrlen != addrlen) ||
-        (0 != memcmp (&pos[1], addr, addrlen)))
-      continue;
-    GNUNET_CONTAINER_DLL_remove (h->lal_head, h->lal_tail, pos);
-    if (NULL != h->address_callback)
-      h->address_callback (h->callback_cls, GNUNET_NO,
-                           (const struct sockaddr *) &pos[1], pos->addrlen);
-    GNUNET_free (pos);
-    return;                     /* only remove once */
+    /* remove address */
+    next = h->lal_head;
+    while (NULL != (pos = next))
+    {
+      next = pos->next;
+      if ((pos->source != LAL_UPNP) || (pos->addrlen != addrlen) ||
+          (0 != memcmp (&pos[1], addr, addrlen)))
+        continue;
+      GNUNET_CONTAINER_DLL_remove (h->lal_head, h->lal_tail, pos);
+      if (NULL != h->address_callback)
+        h->address_callback (h->callback_cls, GNUNET_NO,
+                             (const struct sockaddr *) &pos[1], pos->addrlen);
+      GNUNET_free (pos);
+      return;                     /* only remove once */
+    }
+    /* asked to remove address that does not exist */
+    LOG (GNUNET_ERROR_TYPE_ERROR,
+         "Asked to remove unkown address `%s'\n",
+         GNUNET_a2s(addr, addrlen));
+    GNUNET_break (0);
+  }
+  else
+  {
+
+    GNUNET_break (0);
   }
-  /* asked to remove address that does not exist */
-  GNUNET_break (0);
 }
 
 
@@ -1068,9 +1091,19 @@ add_minis (struct GNUNET_NAT_Handle *h,
       return;                   /* already got this port */
     ml = ml->next;
   }
+
   ml = GNUNET_new (struct MiniList);
   ml->port = port;
   ml->mini = GNUNET_NAT_mini_map_start (port, h->is_tcp, &upnp_add, h);
+
+  if (NULL == ml->mini)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+        _("Failed to run upnp client for port %u\n"), ml->port);
+    GNUNET_free (ml);
+    return;
+  }
+
   GNUNET_CONTAINER_DLL_insert (h->mini_head, h->mini_tail, ml);
 }
 
@@ -1078,20 +1111,17 @@ add_minis (struct GNUNET_NAT_Handle *h,
 /**
  * Task to add addresses from original bind to set of valid addrs.
  *
- * @param cls the NAT handle
- * @param tc scheduler context
+ * @param h the NAT handle
  */
 static void
-add_from_bind (void *cls,
-               const struct GNUNET_SCHEDULER_TaskContext *tc)
+add_from_bind (struct GNUNET_NAT_Handle *h)
 {
   static struct in6_addr any = IN6ADDR_ANY_INIT;
-  struct GNUNET_NAT_Handle *h = cls;
+
   unsigned int i;
   struct sockaddr *sa;
   const struct sockaddr_in *v4;
 
-  h->bind_task = GNUNET_SCHEDULER_NO_TASK;
   for (i = 0; i < h->num_local_addrs; i++)
   {
     sa = h->local_addrs[i];
@@ -1105,10 +1135,16 @@ add_from_bind (void *cls,
       }
       v4 = (const struct sockaddr_in *) sa;
       if (0 != v4->sin_addr.s_addr)
-        add_to_address_list (h, LAL_BINDTO_ADDRESS, sa,
+        add_to_address_list (h,
+                             LAL_BINDTO_ADDRESS, sa,
                              sizeof (struct sockaddr_in));
       if (h->enable_upnp)
+      {
+        GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                    "Running upnp client for address `%s'\n",
+                    GNUNET_a2s (sa,sizeof (struct sockaddr_in)));
         add_minis (h, ntohs (v4->sin_port));
+      }
       break;
     case AF_INET6:
       if (sizeof (struct sockaddr_in6) != h->local_addrlens[i])
@@ -1117,9 +1153,12 @@ add_from_bind (void *cls,
         break;
       }
       if (0 !=
-          memcmp (&((const struct sockaddr_in6 *) sa)->sin6_addr, &any,
+          memcmp (&((const struct sockaddr_in6 *) sa)->sin6_addr,
+                  &any,
                   sizeof (struct in6_addr)))
-        add_to_address_list (h, LAL_BINDTO_ADDRESS, sa,
+        add_to_address_list (h,
+                             LAL_BINDTO_ADDRESS,
+                             sa,
                              sizeof (struct sockaddr_in6));
       break;
     default:
@@ -1129,7 +1168,6 @@ add_from_bind (void *cls,
 }
 
 
-
 /**
  * Attempt to enable port redirection and detect public IP address contacting
  * UPnP or NAT-PMP routers on the local network. Use addr to specify to which
@@ -1140,7 +1178,7 @@ add_from_bind (void *cls,
  * @param is_tcp #GNUNET_YES for TCP, #GNUNET_NO for UDP
  * @param adv_port advertised port (port we are either bound to or that our OS
  *                 locally performs redirection from to our bound port).
- * @param num_addrs number of addresses in 'addrs'
+ * @param num_addrs number of addresses in @a addrs
  * @param addrs the local addresses packets should be redirected to
  * @param addrlens actual lengths of the addresses
  * @param address_callback function to call everytime the public IP address changes
@@ -1154,7 +1192,7 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
                      uint16_t adv_port,
                      unsigned int num_addrs,
                      const struct sockaddr **addrs,
-                     const socklen_t * addrlens,
+                     const socklen_t *addrlens,
                      GNUNET_NAT_AddressCallback address_callback,
                      GNUNET_NAT_ReversalCallback reversal_callback,
                      void *callback_cls)
@@ -1189,7 +1227,6 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
       memcpy (h->local_addrs[i], addrs[i], addrlens[i]);
     }
   }
-  h->bind_task = GNUNET_SCHEDULER_add_now (&add_from_bind, h);
   if (GNUNET_OK ==
       GNUNET_CONFIGURATION_have_value (cfg, "nat", "INTERNAL_ADDRESS"))
   {
@@ -1250,6 +1287,16 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
   if (NULL == reversal_callback)
     h->enable_nat_server = GNUNET_NO;
 
+  /* Check for UPnP client, disable immediately if not available */
+  if ( (GNUNET_YES == h->enable_upnp) &&
+       (GNUNET_SYSERR ==
+        GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL)) )
+  {
+    LOG (GNUNET_ERROR_TYPE_ERROR,
+        _("UPnP enabled in configuration, but UPnP client `upnpc` command not found, disabling UPnP \n"));
+    h->enable_upnp = GNUNET_NO;
+  }
+
   /* Check if NAT was hole-punched */
   if ((NULL != h->address_callback) &&
       (NULL != h->external_address) &&
@@ -1295,10 +1342,13 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
 
   if (NULL != h->address_callback)
   {
-    h->ifc_task = GNUNET_SCHEDULER_add_now (&list_interfaces, h);
+    h->ifc_task = GNUNET_SCHEDULER_add_now (&list_interfaces,
+                                            h);
     if (GNUNET_YES == h->use_hostname)
-      h->hostname_task = GNUNET_SCHEDULER_add_now (&resolve_hostname, h);
+      h->hostname_task = GNUNET_SCHEDULER_add_now (&resolve_hostname,
+                                                   h);
   }
+  add_from_bind (h);
 
   return h;
 }
@@ -1321,7 +1371,9 @@ GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h)
        "NAT unregister called\n");
   while (NULL != (ml = h->mini_head))
   {
-    GNUNET_CONTAINER_DLL_remove (h->mini_head, h->mini_tail, ml);
+    GNUNET_CONTAINER_DLL_remove (h->mini_head,
+                                 h->mini_tail,
+                                 ml);
     if (NULL != ml->mini)
       GNUNET_NAT_mini_map_stop (ml->mini);
     GNUNET_free (ml);
@@ -1336,30 +1388,25 @@ GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h)
     GNUNET_RESOLVER_request_cancel (h->hostname_dns);
     h->hostname_dns = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != h->server_read_task)
+  if (NULL != h->server_read_task)
   {
     GNUNET_SCHEDULER_cancel (h->server_read_task);
-    h->server_read_task = GNUNET_SCHEDULER_NO_TASK;
+    h->server_read_task = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != h->bind_task)
-  {
-    GNUNET_SCHEDULER_cancel (h->bind_task);
-    h->bind_task = GNUNET_SCHEDULER_NO_TASK;
-  }
-  if (GNUNET_SCHEDULER_NO_TASK != h->ifc_task)
+  if (NULL != h->ifc_task)
   {
     GNUNET_SCHEDULER_cancel (h->ifc_task);
-    h->ifc_task = GNUNET_SCHEDULER_NO_TASK;
+    h->ifc_task = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != h->hostname_task)
+  if (NULL != h->hostname_task)
   {
     GNUNET_SCHEDULER_cancel (h->hostname_task);
-    h->hostname_task = GNUNET_SCHEDULER_NO_TASK;
+    h->hostname_task = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != h->dns_task)
+  if (NULL != h->dns_task)
   {
     GNUNET_SCHEDULER_cancel (h->dns_task);
-    h->dns_task = GNUNET_SCHEDULER_NO_TASK;
+    h->dns_task = NULL;
   }
   if (NULL != h->server_proc)
   {
@@ -1512,5 +1559,60 @@ GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
   return GNUNET_NO;
 }
 
+/**
+ * Converts enum GNUNET_NAT_StatusCode to a string
+ *
+ * @param err error code to resolve to a string
+ * @return pointer to a static string containing the error code
+ */
+const char *
+GNUNET_NAT_status2string (enum GNUNET_NAT_StatusCode err)
+{
+  switch (err)
+  {
+  case GNUNET_NAT_ERROR_SUCCESS:
+    return _ ("Operation Successful");
+  case GNUNET_NAT_ERROR_IPC_FAILURE:
+    return _ ("Internal Failure (IPC, ...)");
+  case GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR:
+    return _ ("Failure in network subsystem, check permissions.");
+  case GNUNET_NAT_ERROR_TIMEOUT:
+    return _ ("Encountered timeout while performing operation");
+  case GNUNET_NAT_ERROR_NOT_ONLINE:
+    return _ ("detected that we are offline");
+  case GNUNET_NAT_ERROR_UPNPC_NOT_FOUND:
+    return _ ("`upnpc` command not found");
+  case GNUNET_NAT_ERROR_UPNPC_FAILED:
+    return _ ("Failed to run `upnpc` command");
+  case GNUNET_NAT_ERROR_UPNPC_TIMEOUT:
+    return _ ("`upnpc' command took too long, process killed");
+  case GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED:
+    return _ ("`upnpc' command failed to establish port mapping");
+  case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND:
+    return _ ("`external-ip' command not found");
+  case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED:
+    return _ ("Failed to run `external-ip` command");
+  case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID:
+    return _ ("`external-ip' command output invalid");
+  case GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID:
+    return _ ("no valid address was returned by `external-ip'");
+  case GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO:
+    return _ ("Could not determine interface with internal/local network address");
+  case GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND:
+    return _ ("No functioning gnunet-helper-nat-server installation found");
+  case GNUNET_NAT_ERROR_NAT_TEST_START_FAILED:
+    return _ ("NAT test could not be initialized");
+  case GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT:
+    return _ ("NAT test timeout reached");
+  case GNUNET_NAT_ERROR_NAT_REGISTER_FAILED:
+    return _ ("could not register NAT");
+  case GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND:
+    return _ ("No working gnunet-helper-nat-client installation found");
+/*  case:
+    return _ ("");*/
+  default:
+    return "unknown status code";
+  }
+}
 
 /* end of nat.c */