Initial import of STUN support
[oweals/gnunet.git] / src / nat / nat.c
index 0aefc4312ebac61249de41b22366709f6a153c60..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
  */
 enum LocalAddressSource
 {
-    /**
-     * Address was obtained by DNS resolution of the external hostname
-     * given in the configuration (i.e. hole-punched DynDNS setup).
-     */
+  /**
+   * Address was obtained by DNS resolution of the external hostname
+   * 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
+   * given in the configuration (i.e. hole-punched DynDNS setup)
+   * during the previous iteration (see #3213).
+   */
+  LAL_EXTERNAL_IP_OLD,
 
-    /**
-     * Address was obtained by looking up our own hostname in DNS.
-     */
+  /**
+   * Address was obtained by looking up our own hostname in DNS.
+   */
   LAL_HOSTNAME_DNS,
 
-    /**
-     * Address was obtained by scanning our hosts's network interfaces
-     * and taking their address (no DNS involved).
-     */
+  /**
+   * Address was obtained by scanning our hosts's network interfaces
+   * and taking their address (no DNS involved).
+   */
   LAL_INTERFACE_ADDRESS,
 
-    /**
-     * Addresses we were explicitly bound to.
-     */
+  /**
+   * Addresses we were explicitly bound to.
+   */
   LAL_BINDTO_ADDRESS,
 
-    /**
-     * Addresses from UPnP or PMP
-     */
+  /**
+   * Addresses from UPnP or PMP
+   */
   LAL_UPNP,
 
-    /**
-     * End of the list.
-     */
+  /**
+   * End of the list.
+   */
   LAL_END
 };
 
@@ -181,7 +193,7 @@ struct GNUNET_NAT_Handle
   GNUNET_NAT_ReversalCallback reversal_callback;
 
   /**
-   * Closure for 'callback'.
+   * Closure for callbacks (@e address_callback and @e reversal_callback)
    */
   void *callback_cls;
 
@@ -223,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
@@ -272,7 +279,7 @@ struct GNUNET_NAT_Handle
   struct sockaddr **local_addrs;
 
   /**
-   * Length of the 'local_addrs'.
+   * Length of the @e local_addrs.
    */
   socklen_t *local_addrlens;
 
@@ -407,8 +414,8 @@ remove_from_address_list_by_source (struct GNUNET_NAT_Handle *h,
  *
  * @param h handle to NAT
  * @param src where did the local address originate from?
- * @param arg the address, some 'struct sockaddr'
- * @param arg_size number of bytes in arg
+ * @param arg the address, some `struct sockaddr`
+ * @param arg_size number of bytes in @a arg
  */
 static void
 add_to_address_list_as_is (struct GNUNET_NAT_Handle *h,
@@ -422,8 +429,10 @@ add_to_address_list_as_is (struct GNUNET_NAT_Handle *h,
   lal->addrlen = arg_size;
   lal->source = src;
   GNUNET_CONTAINER_DLL_insert (h->lal_head, h->lal_tail, lal);
-  LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address `%s' from source %d\n",
-       GNUNET_a2s (arg, arg_size), src);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Adding address `%s' from source %d\n",
+       GNUNET_a2s (arg, arg_size),
+       src);
   if (NULL != h->address_callback)
     h->address_callback (h->callback_cls, GNUNET_YES, arg, arg_size);
 }
@@ -437,12 +446,14 @@ add_to_address_list_as_is (struct GNUNET_NAT_Handle *h,
  *
  * @param h handle to NAT
  * @param src where did the local address originate from?
- * @param arg the address, some 'struct sockaddr'
- * @param arg_size number of bytes in arg
+ * @param arg the address, some `struct sockaddr`
+ * @param arg_size number of bytes in @a arg
  */
 static void
-add_to_address_list (struct GNUNET_NAT_Handle *h, enum LocalAddressSource src,
-                     const struct sockaddr *arg, socklen_t arg_size)
+add_to_address_list (struct GNUNET_NAT_Handle *h,
+                     enum LocalAddressSource src,
+                     const struct sockaddr *arg,
+                     socklen_t arg_size)
 {
   struct sockaddr_in s4;
   const struct sockaddr_in *in4;
@@ -488,7 +499,7 @@ add_to_address_list (struct GNUNET_NAT_Handle *h, enum LocalAddressSource src,
  *
  * @param h handle to NAT
  * @param src where did the local address originate from?
- * @param addr the address, some 'struct in_addr' or 'struct in6_addr'
+ * @param addr the address, some `struct in_addr` or `struct in6_addr`
  * @param addrlen number of bytes in addr
  */
 static void
@@ -560,25 +571,42 @@ resolve_dns (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
  * Our (external) hostname was resolved and the configuration says that
  * the NAT was hole-punched.
  *
- * @param cls the 'struct Plugin'
+ * @param cls the `struct GNUNET_NAT_Handle`
  * @param addr NULL on error, otherwise result of DNS lookup
- * @param addrlen number of bytes in addr
+ * @param addrlen number of bytes in @a addr
  */
 static void
-process_external_ip (void *cls, const struct sockaddr *addr, socklen_t addrlen)
+process_external_ip (void *cls,
+                     const struct sockaddr *addr,
+                     socklen_t addrlen)
 {
   struct GNUNET_NAT_Handle *h = cls;
   struct in_addr dummy;
 
-  if (addr == NULL)
+  if (NULL == addr)
   {
     h->ext_dns = NULL;
-    if (1 == inet_pton (AF_INET, h->external_address, &dummy))
+    /* Current iteration is over, remove 'old' IPs now */
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Purging old IPs for external address\n");
+    remove_from_address_list_by_source (h, LAL_EXTERNAL_IP_OLD);
+    if (1 == inet_pton (AF_INET,
+                        h->external_address,
+                        &dummy))
+    {
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "Got numeric IP for external address, not repeating lookup\n");
       return;                   /* repated lookup pointless: was numeric! */
+    }
     h->dns_task =
-        GNUNET_SCHEDULER_add_delayed (h->dyndns_frequency, &resolve_dns, h);
+      GNUNET_SCHEDULER_add_delayed (h->dyndns_frequency,
+                                    &resolve_dns, h);
     return;
   }
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Got IP `%s' for external address `%s'\n",
+       GNUNET_a2s (addr, addrlen),
+       h->external_address);
   add_to_address_list (h, LAL_EXTERNAL_IP, addr, addrlen);
 }
 
@@ -590,7 +618,8 @@ process_external_ip (void *cls, const struct sockaddr *addr, socklen_t addrlen)
  * @param tc scheduler context
  */
 static void
-resolve_hostname (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+resolve_hostname (void *cls,
+                  const struct GNUNET_SCHEDULER_TaskContext *tc);
 
 
 /**
@@ -600,14 +629,16 @@ resolve_hostname (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
  *
  * @param cls closure
  * @param addr one of the addresses of the host, NULL for the last address
- * @param addrlen length of the address
+ * @param addrlen length of the @a addr
  */
 static void
-process_hostname_ip (void *cls, const struct sockaddr *addr, socklen_t addrlen)
+process_hostname_ip (void *cls,
+                     const struct sockaddr *addr,
+                     socklen_t addrlen)
 {
   struct GNUNET_NAT_Handle *h = cls;
 
-  if (addr == NULL)
+  if (NULL == addr)
   {
     h->hostname_dns = NULL;
     h->hostname_task =
@@ -623,14 +654,14 @@ process_hostname_ip (void *cls, const struct sockaddr *addr, socklen_t addrlen)
  * Add the IP of our network interface to the list of
  * our IP addresses.
  *
- * @param cls the 'struct GNUNET_NAT_Handle'
+ * @param cls the `struct GNUNET_NAT_Handle`
  * @param name name of the interface
  * @param isDefault do we think this may be our default interface
  * @param addr address of the interface
  * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
  * @param netmask the network mask (can be NULL for unknown or unassigned))
- * @param addrlen number of bytes in addr
- * @return GNUNET_OK to continue iterating
+ * @param addrlen number of bytes in @a addr and @a broadcast_addr
+ * @return #GNUNET_OK to continue iterating
  */
 static int
 process_interfaces (void *cls, const char *name, int isDefault,
@@ -679,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));
@@ -727,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)))
   {
@@ -745,7 +776,7 @@ process_interfaces (void *cls, const char *name, int isDefault,
  * Task that restarts the gnunet-helper-nat-server process after a crash
  * after a certain delay.
  *
- * @param cls the 'struct GNUNET_NAT_Handle'
+ * @param cls the `struct GNUNET_NAT_Handle`
  * @param tc scheduler context
  */
 static void
@@ -753,23 +784,24 @@ 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;
-  if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
+  h->server_read_task = NULL;
+  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
     return;
   start_gnunet_nat_server (h);
 }
 
 
 /**
- * We have been notified that gnunet-helper-nat-server has written something to stdout.
- * Handle the output, then reschedule this function to be called again once
- * more is available.
+ * We have been notified that gnunet-helper-nat-server has written
+ * something to stdout.  Handle the output, then reschedule this
+ * function to be called again once more is available.
  *
  * @param cls the NAT handle
  * @param tc the scheduling context
  */
 static void
-nat_server_read (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+nat_server_read (void *cls,
+                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_NAT_Handle *h = cls;
   char mybuf[40];
@@ -779,17 +811,18 @@ nat_server_read (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   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));
   bytes =
-      GNUNET_DISK_file_read (h->server_stdout_handle, mybuf, sizeof (mybuf));
+    GNUNET_DISK_file_read (h->server_stdout_handle, mybuf, sizeof (mybuf));
   if (bytes < 1)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Finished reading from server stdout with code: %d\n", bytes);
-    if (0 != GNUNET_OS_process_kill (h->server_proc, SIGTERM))
+         "Finished reading from server stdout with code: %d\n",
+         bytes);
+    if (0 != GNUNET_OS_process_kill (h->server_proc, GNUNET_TERM_SIG))
       GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING, "nat", "kill");
     GNUNET_OS_process_wait (h->server_proc);
     GNUNET_OS_process_destroy (h->server_proc);
@@ -868,12 +901,13 @@ start_gnunet_nat_server (struct GNUNET_NAT_Handle *h)
        (h->server_stdout =
         GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES))))
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Starting `%s' at `%s'\n",
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Starting `%s' at `%s'\n",
          "gnunet-helper-nat-server", h->internal_address);
     /* Start the server process */
     binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
     h->server_proc =
-        GNUNET_OS_start_process (GNUNET_NO, 0, NULL, h->server_stdout,
+        GNUNET_OS_start_process (GNUNET_NO, 0, NULL, h->server_stdout, NULL,
                                  binary,
                                  "gnunet-helper-nat-server",
                                  h->internal_address, NULL);
@@ -907,15 +941,17 @@ start_gnunet_nat_server (struct GNUNET_NAT_Handle *h)
  * @param tc scheduler context
  */
 static void
-list_interfaces (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+list_interfaces (void *cls,
+                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   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 =
-      GNUNET_SCHEDULER_add_delayed (h->ifc_scan_frequency, &list_interfaces, h);
+    GNUNET_SCHEDULER_add_delayed (h->ifc_scan_frequency,
+                                  &list_interfaces, h);
 }
 
 
@@ -926,11 +962,12 @@ list_interfaces (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @param tc scheduler context
  */
 static void
-resolve_hostname (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+resolve_hostname (void *cls,
+                  const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   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,
@@ -946,58 +983,92 @@ resolve_hostname (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @param tc scheduler context
  */
 static void
-resolve_dns (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+resolve_dns (void *cls,
+             const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_NAT_Handle *h = cls;
+  struct LocalAddressList *pos;
 
-  h->dns_task = GNUNET_SCHEDULER_NO_TASK;
-  remove_from_address_list_by_source (h, LAL_EXTERNAL_IP);
+  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;
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Resolving external address `%s'\n",
+       h->external_address);
   h->ext_dns =
       GNUNET_RESOLVER_ip_get (h->external_address, AF_INET,
-                              GNUNET_TIME_UNIT_MINUTES, &process_external_ip,
-                              h);
+                              GNUNET_TIME_UNIT_MINUTES,
+                              &process_external_ip, h);
 }
 
 
 /**
  * Add or remove UPnP-mapped addresses.
  *
- * @param cls the GNUNET_NAT_Handle
- * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
+ * @param cls the `struct GNUNET_NAT_Handle`
+ * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
  *     the previous (now invalid) one
  * @param addr either the previous or the new public IP address
- * @param addrlen actual lenght of the address
+ * @param addrlen actual lenght of @a addr
+ * @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)
+upnp_add (void *cls,
+          int add_remove,
+          const struct sockaddr *addr,
+          socklen_t addrlen,
+          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);
 }
 
 
@@ -1008,7 +1079,8 @@ upnp_add (void *cls, int add_remove, const struct sockaddr *addr,
  * @param port port to map with UPnP
  */
 static void
-add_minis (struct GNUNET_NAT_Handle *h, uint16_t port)
+add_minis (struct GNUNET_NAT_Handle *h,
+           uint16_t port)
 {
   struct MiniList *ml;
 
@@ -1019,9 +1091,19 @@ add_minis (struct GNUNET_NAT_Handle *h, uint16_t port)
       return;                   /* already got this port */
     ml = ml->next;
   }
-  ml = GNUNET_malloc (sizeof (struct MiniList));
+
+  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);
 }
 
@@ -1029,19 +1111,17 @@ add_minis (struct GNUNET_NAT_Handle *h, uint16_t port)
 /**
  * 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];
@@ -1055,10 +1135,16 @@ add_from_bind (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
       }
       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])
@@ -1067,9 +1153,12 @@ add_from_bind (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
         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:
@@ -1079,7 +1168,6 @@ add_from_bind (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 }
 
 
-
 /**
  * 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
@@ -1087,10 +1175,10 @@ add_from_bind (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * is taken from the corresponding sockaddr_in[6] field.
  *
  * @param cfg configuration to use
- * @param is_tcp GNUNET_YES for TCP, GNUNET_NO for UDP
+ * @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
@@ -1099,9 +1187,12 @@ add_from_bind (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @return NULL on error, otherwise handle that can be used to unregister
  */
 struct GNUNET_NAT_Handle *
-GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
-                     uint16_t adv_port, unsigned int num_addrs,
-                     const struct sockaddr **addrs, const socklen_t * addrlens,
+GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                     int is_tcp,
+                     uint16_t adv_port,
+                     unsigned int num_addrs,
+                     const struct sockaddr **addrs,
+                     const socklen_t *addrlens,
                      GNUNET_NAT_AddressCallback address_callback,
                      GNUNET_NAT_ReversalCallback reversal_callback,
                      void *callback_cls)
@@ -1114,7 +1205,7 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Registered with NAT service at port %u with %u IP bound local addresses\n",
        (unsigned int) adv_port, num_addrs);
-  h = GNUNET_malloc (sizeof (struct GNUNET_NAT_Handle));
+  h = GNUNET_new (struct GNUNET_NAT_Handle);
   h->server_retry_delay = GNUNET_TIME_UNIT_SECONDS;
   h->cfg = cfg;
   h->is_tcp = is_tcp;
@@ -1136,7 +1227,6 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
       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"))
   {
@@ -1147,7 +1237,7 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
   if ((h->internal_address != NULL) &&
       (inet_pton (AF_INET, h->internal_address, &in_addr) != 1))
   {
-    GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING, 
+    GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
                               "nat", "INTERNAL_ADDRESS",
                               _("malformed"));
     GNUNET_free (h->internal_address);
@@ -1197,14 +1287,30 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
   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) && (h->external_address != NULL) &&
-      (h->nat_punched == GNUNET_YES))
+  if ((NULL != h->address_callback) &&
+      (NULL != h->external_address) &&
+      (GNUNET_YES == h->nat_punched))
   {
     h->dns_task = GNUNET_SCHEDULER_add_now (&resolve_dns, h);
     h->enable_nat_server = GNUNET_NO;
     h->enable_upnp = GNUNET_NO;
   }
+  else
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "No external IP address given to add to our list of addresses\n");
+  }
 
   /* Test for SUID binaries */
   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
@@ -1214,8 +1320,7 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
   {
     h->enable_nat_server = GNUNET_NO;
     LOG (GNUNET_ERROR_TYPE_WARNING,
-         _
-         ("Configuration requires `%s', but binary is not installed properly (SUID bit not set).  Option disabled.\n"),
+         _("Configuration requires `%s', but binary is not installed properly (SUID bit not set).  Option disabled.\n"),
          "gnunet-helper-nat-server");
   }
   GNUNET_free (binary);
@@ -1237,10 +1342,13 @@ GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
 
   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;
 }
@@ -1259,14 +1367,18 @@ GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h)
   struct LocalAddressList *lal;
   struct MiniList *ml;
 
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "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);
   }
-  if (h->ext_dns != NULL)
+  if (NULL != h->ext_dns)
   {
     GNUNET_RESOLVER_request_cancel (h->ext_dns);
     h->ext_dns = NULL;
@@ -1276,34 +1388,29 @@ 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)
   {
-    if (0 != GNUNET_OS_process_kill (h->server_proc, SIGTERM))
+    if (0 != GNUNET_OS_process_kill (h->server_proc, GNUNET_TERM_SIG))
       GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING, "nat", "kill");
     GNUNET_OS_process_wait (h->server_proc);
     GNUNET_OS_process_destroy (h->server_proc);
@@ -1341,8 +1448,10 @@ GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h)
  * gnunet-helper-nat-client to send dummy ICMP responses to cause
  * that peer to connect to us (connection reversal).
  *
- * @return GNUNET_SYSERR on error, GNUNET_NO if nat client is disabled,
- *         GNUNET_OK otherwise
+ * @param h handle (used for configuration)
+ * @param sa the address of the peer (IPv4-only)
+ * @return #GNUNET_SYSERR on error, #GNUNET_NO if nat client is disabled,
+ *         #GNUNET_OK otherwise
  */
 int
 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
@@ -1361,25 +1470,32 @@ GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
   if (h->internal_address == NULL)
   {
     LOG (GNUNET_ERROR_TYPE_WARNING, "nat",
-         _
-         ("Internal IP address not known, cannot use ICMP NAT traversal method\n"));
+         _("Internal IP address not known, cannot use ICMP NAT traversal method\n"));
     return GNUNET_SYSERR;
   }
   GNUNET_assert (sa->sin_family == AF_INET);
   if (NULL == inet_ntop (AF_INET, &sa->sin_addr, inet4, INET_ADDRSTRLEN))
   {
-    GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING, "nat", "inet_ntop");
+    GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING,
+                              "nat",
+                              "inet_ntop");
     return GNUNET_SYSERR;
   }
-  GNUNET_snprintf (port_as_string, sizeof (port_as_string), "%d", h->adv_port);
+  GNUNET_snprintf (port_as_string,
+                   sizeof (port_as_string),
+                   "%d",
+                   h->adv_port);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-       _("Running gnunet-helper-nat-client %s %s %u\n"), h->internal_address,
-       inet4, (unsigned int) h->adv_port);
+       _("Running gnunet-helper-nat-client %s %s %u\n"),
+       h->internal_address,
+       inet4,
+       (unsigned int) h->adv_port);
   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
   proc =
-      GNUNET_OS_start_process (GNUNET_NO, 0, NULL, NULL,
+      GNUNET_OS_start_process (GNUNET_NO, 0, NULL, NULL, NULL,
                                binary,
-                               "gnunet-helper-nat-client", h->internal_address,
+                               "gnunet-helper-nat-client",
+                               h->internal_address,
                                inet4, port_as_string, NULL);
   GNUNET_free (binary);
   if (NULL == proc)
@@ -1397,13 +1513,14 @@ GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
  *
  * @param h the handle returned by register
  * @param addr IP address to test (IPv4 or IPv6)
- * @param addrlen number of bytes in addr
- * @return GNUNET_YES if the address is plausible,
- *         GNUNET_NO if the address is not plausible,
- *         GNUNET_SYSERR if the address is malformed
+ * @param addrlen number of bytes in @a addr
+ * @return #GNUNET_YES if the address is plausible,
+ *         #GNUNET_NO if the address is not plausible,
+ *         #GNUNET_SYSERR if the address is malformed
  */
 int
-GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h, const void *addr,
+GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
+                         const void *addr,
                          socklen_t addrlen)
 {
   struct LocalAddressList *pos;
@@ -1416,8 +1533,7 @@ GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h, const void *addr,
     GNUNET_break (0);
     return GNUNET_SYSERR;
   }
-  pos = h->lal_head;
-  while (NULL != pos)
+  for (pos = h->lal_head; NULL != pos; pos = pos->next)
   {
     if (pos->addrlen == sizeof (struct sockaddr_in))
     {
@@ -1437,12 +1553,66 @@ GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h, const void *addr,
     {
       GNUNET_assert (0);
     }
-    pos = pos->next;
   }
   LOG (GNUNET_ERROR_TYPE_WARNING,
        "Asked to validate one of my addresses and validation failed!\n");
   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 */