-improve indentation, reduce duplication of PIDs in core's neighbour map
[oweals/gnunet.git] / src / nat / nat_auto.c
index 68689243e5e7293f120ada21a8e79a0f13b9f122..327970e0afae473c807360fca28832eaf838f2fe 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2012 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2012 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
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
@@ -86,7 +86,7 @@ enum AutoPhase
    * Last phase, we're done.
    */
   AUTO_DONE
-  
+
 };
 
 
@@ -105,12 +105,12 @@ struct GNUNET_NAT_AutoHandle
    * Function to call when done.
    */
   GNUNET_NAT_AutoResultCallback fin_cb;
-  
+
   /**
-   * Closure for 'fin_cb'.
+   * Closure for @e fin_cb.
    */
   void *fin_cb_cls;
-  
+
   /**
    * Handle for active 'GNUNET_NAT_mini_get_external_ipv4'-operation.
    */
@@ -129,7 +129,7 @@ struct GNUNET_NAT_AutoHandle
   /**
    * Task identifier for the timeout.
    */
-  GNUNET_SCHEDULER_TaskIdentifier task;
+  struct GNUNET_SCHEDULER_Task * task;
 
   /**
    * Where are we in the test?
@@ -141,6 +141,10 @@ struct GNUNET_NAT_AutoHandle
    */
   int have_v6;
 
+  /**
+   * Error code for better debugging and user feedback
+   */
+  enum GNUNET_NAT_StatusCode ret;
 };
 
 
@@ -154,78 +158,50 @@ next_phase (struct GNUNET_NAT_AutoHandle *ah);
 
 
 /**
- * Function called if NAT failed to confirm success.
- * Clean up and update GUI (with failure).
- *
- * @param cls closure with setup context
- * @param tc scheduler callback
- */
-static void
-fail_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
-{
-  struct GNUNET_NAT_AutoHandle *ah = cls;
-
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-             _("NAT traversal with ICMP Server timed out.\n"));
-  GNUNET_assert (NULL != ah->tst);
-  ah->task = GNUNET_SCHEDULER_NO_TASK;
-  GNUNET_NAT_test_stop (ah->tst);
-  ah->tst = NULL;
-  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", 
-                                        "ENABLE_ICMP_SERVER",
-                                        "NO");
-  next_phase (ah);
-}
-
-
-/**
- * Function called by NAT on success.
- * Clean up and update GUI (with success).
+ * Function called by NAT to report the outcome of the nat-test.
+ * Clean up and update GUI.
  *
  * @param cls the auto handle
- * @param success currently always GNUNET_OK
+ * @param success currently always #GNUNET_OK
+ * @param emsg NULL on success, otherwise an error message
  */
 static void
-result_callback (void *cls, int success)
+result_callback (void *cls,
+                 enum GNUNET_NAT_StatusCode ret)
 {
   struct GNUNET_NAT_AutoHandle *ah = cls;
-
-  GNUNET_SCHEDULER_cancel (ah->task);
-  ah->task = GNUNET_SCHEDULER_NO_TASK;
-  GNUNET_NAT_test_stop (ah->tst);
+  if (GNUNET_NAT_ERROR_SUCCESS == ret)
+    GNUNET_NAT_test_stop (ah->tst);
   ah->tst = NULL;
+  ah->ret = ret;
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-             success 
+              GNUNET_NAT_ERROR_SUCCESS == ret
              ? _("NAT traversal with ICMP Server succeeded.\n")
              : _("NAT traversal with ICMP Server failed.\n"));
-  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_ICMP_SERVER", 
-                                        success ? "YES": "NO");
+  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_ICMP_SERVER",
+                                        GNUNET_NAT_ERROR_SUCCESS == ret ? "NO" : "YES");
   next_phase (ah);
 }
 
+
 /**
  * Main function for the connection reversal test.
  *
- * @param cls the 'int*' for the result
+ * @param cls the `struct GNUNET_NAT_AutoHandle`
  * @param tc scheduler context
  */
 static void
-reversal_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+reversal_test (void *cls,
+               const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_NAT_AutoHandle *ah = cls;
 
-  ah->task = GNUNET_SCHEDULER_NO_TASK;
+  ah->task = NULL;
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              _("Testing connection reversal with ICMP server.\n"));
   GNUNET_RESOLVER_connect (ah->cfg);
-  ah->tst = GNUNET_NAT_test_start (ah->cfg, GNUNET_YES, 0, 0,
+  ah->tst = GNUNET_NAT_test_start (ah->cfg, GNUNET_YES, 0, 0, TIMEOUT,
                                   &result_callback, ah);
-  if (NULL == ah->tst)
-  {
-    next_phase (ah);
-    return;
-  }
-  ah->task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, ah);
 }
 
 
@@ -238,6 +214,10 @@ static void
 test_online (struct GNUNET_NAT_AutoHandle *ah)
 {
   // FIXME: not implemented
+  /*
+   * if (failure)
+   *  ah->ret = GNUNET_NAT_ERROR_NOT_ONLINE;
+   */
   next_phase (ah);
 }
 
@@ -247,15 +227,19 @@ test_online (struct GNUNET_NAT_AutoHandle *ah)
  *
  * @param cls closure with our setup context
  * @param addr the address, NULL on errors
+ * @param emsg NULL on success, otherwise an error message
  */
 static void
-set_external_ipv4 (void *cls, const struct in_addr *addr)
+set_external_ipv4 (void *cls,
+                   const struct in_addr *addr,
+                   enum GNUNET_NAT_StatusCode ret)
 {
   struct GNUNET_NAT_AutoHandle *ah = cls;
   char buf[INET_ADDRSTRLEN];
 
   ah->eh = NULL;
-  if (NULL == addr)
+  ah->ret = ret;
+  if (GNUNET_NAT_ERROR_SUCCESS != ret)
   {
     next_phase (ah);
     return;
@@ -273,6 +257,11 @@ set_external_ipv4 (void *cls, const struct in_addr *addr)
   if (NULL == inet_ntop (AF_INET, addr, buf, sizeof (buf)))
   {
     GNUNET_break (0);
+    /* actually, this should never happen, as the caller already executed just
+     * this check, but for consistency (eg: future changes in the caller) 
+     * we still need to report this error...
+     */
+    ah->ret = GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID;
     next_phase (ah);
     return;
   }
@@ -290,6 +279,9 @@ set_external_ipv4 (void *cls, const struct in_addr *addr)
 static void
 test_external_ip (struct GNUNET_NAT_AutoHandle *ah)
 {
+  if (GNUNET_NAT_ERROR_SUCCESS != ah->ret)
+    next_phase (ah);
+  
   // FIXME: CPS?
   /* try to detect external IP */
   ah->eh = GNUNET_NAT_mini_get_external_ipv4 (TIMEOUT,
@@ -301,18 +293,22 @@ test_external_ip (struct GNUNET_NAT_AutoHandle *ah)
  * Process list of local IP addresses.  Find and set the
  * one of the default interface.
  *
- * @param cls our NAT auto handle
+ * @param cls our `struct GNUNET_NAT_AutoHandle`
  * @param name name of the interface (can be NULL for unknown)
  * @param isDefault is this presumably the default interface
  * @param addr address of this interface (can be NULL for unknown or unassigned)
  * @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 length of the address
- * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
+ * @param addrlen length of the @a addr and @a broadcast_addr
+ * @return GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
  */
 static int
-nipo (void *cls, const char *name, int isDefault, const struct sockaddr *addr,
-      const struct sockaddr *broadcast_addr, const struct sockaddr *netmask,
+process_if (void *cls,
+      const char *name,
+      int isDefault,
+      const struct sockaddr *addr,
+      const struct sockaddr *broadcast_addr,
+      const struct sockaddr *netmask,
       socklen_t addrlen)
 {
   struct GNUNET_NAT_AutoHandle *ah = cls;
@@ -346,13 +342,14 @@ nipo (void *cls, const char *name, int isDefault, const struct sockaddr *addr,
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              _("Detected internal network address `%s'.\n"),
              buf);
+  ah->ret = GNUNET_NAT_ERROR_SUCCESS;
   /* no need to continue iteration */
   return GNUNET_SYSERR;
 }
 
 
 /**
- * Determine our local IP addresses; detect internal IP & IPv6-support 
+ * Determine our local IP addresses; detect internal IP & IPv6-support
  *
  * @param ah auto setup context
  */
@@ -360,8 +357,10 @@ static void
 test_local_ip (struct GNUNET_NAT_AutoHandle *ah)
 {
   ah->have_v6 = GNUNET_NO;
-  GNUNET_OS_network_interfaces_list (&nipo, ah);
-  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "DISABLEV6", 
+  ah->ret = GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO; // reset to success if any of the IFs in below iterator has a valid IP
+  GNUNET_OS_network_interfaces_list (&process_if, ah);
+  
+  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "DISABLEV6",
                                         (GNUNET_YES == ah->have_v6) ? "NO" : "YES");
   next_phase (ah);
 }
@@ -375,7 +374,11 @@ test_local_ip (struct GNUNET_NAT_AutoHandle *ah)
 static void
 test_nat_punched (struct GNUNET_NAT_AutoHandle *ah)
 {
+  if (GNUNET_NAT_ERROR_SUCCESS != ah->ret)
+    next_phase (ah);
+  
   // FIXME: not implemented
+  
   next_phase (ah);
 }
 
@@ -390,16 +393,19 @@ test_upnpc (struct GNUNET_NAT_AutoHandle *ah)
 {
   int have_upnpc;
 
+  if (GNUNET_NAT_ERROR_SUCCESS != ah->ret)
+    next_phase (ah);
+  
   /* test if upnpc is available */
   have_upnpc = (GNUNET_SYSERR !=
                GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL));
   /* FIXME: test if upnpc is actually working, that is, if transports
      start to work once we use UPnP */
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-             (have_upnpc) 
+             (have_upnpc)
              ? _("upnpc found, enabling its use\n")
              : _("upnpc not found\n"));
-  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_UPNP", 
+  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_UPNP",
                                         (GNUNET_YES == have_upnpc) ? "YES" : "NO");
   next_phase (ah);
 }
@@ -413,27 +419,44 @@ test_upnpc (struct GNUNET_NAT_AutoHandle *ah)
 static void
 test_icmp_server (struct GNUNET_NAT_AutoHandle *ah)
 {
-  int hns;
+  int ext_ip;
+  int nated;
+  int binary;
   char *tmp;
-  char *binary;
-
+  char *helper;
+  ext_ip = GNUNET_NO;
+  nated = GNUNET_NO;
+  binary = GNUNET_NO;
+  
   tmp = NULL;
-  binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
-  hns =
-      ((GNUNET_OK ==
+  helper = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
+  if ((GNUNET_OK ==
         GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
-                                               &tmp)) && (0 < strlen (tmp)) &&
-       (GNUNET_YES ==
-        GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
-       (GNUNET_YES ==
-        GNUNET_OS_check_helper_binary (binary, GNUNET_YES, "-d 127.0.0.1" ))); // use localhost as source for that one udp-port, ok for testing
+                                               &tmp)) && (0 < strlen (tmp))){
+    ext_ip = GNUNET_OK;
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("test_icmp_server not possible, as we have no public IPv4 address\n"));
+  }
+  else
+    goto err;
+    
+  if (GNUNET_YES ==
+        GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")){
+    nated = GNUNET_YES;
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("test_icmp_server not possible, as we are not behind NAT\n"));
+  }
+  else
+    goto err;
+  
+  if (GNUNET_YES ==
+        GNUNET_OS_check_helper_binary (helper, GNUNET_YES, "-d 127.0.0.1" )){
+    binary = GNUNET_OK; // use localhost as source for that one udp-port, ok for testing
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("No working gnunet-helper-nat-server found\n"));
+  }
+err:
   GNUNET_free_non_null (tmp);
-  GNUNET_free (binary);
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-             (hns) 
-             ? _("gnunet-helper-nat-server found, testing it\n")
-             : _("No working gnunet-helper-nat-server found\n"));
-  if (hns)
+  GNUNET_free (helper);
+
+  if (GNUNET_OK == ext_ip && GNUNET_YES == nated && GNUNET_OK == binary)
     ah->task = GNUNET_SCHEDULER_add_now (&reversal_test, ah);
   else
     next_phase (ah);
@@ -448,26 +471,36 @@ test_icmp_server (struct GNUNET_NAT_AutoHandle *ah)
 static void
 test_icmp_client (struct GNUNET_NAT_AutoHandle *ah)
 {
-  int hnc;
   char *tmp;
-  char *binary;
+  char *helper;
 
   tmp = NULL;
-  binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
-  hnc =
-      ((GNUNET_OK ==
+  helper = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
+  if ((GNUNET_OK ==
         GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
-                                               &tmp)) && (0 < strlen (tmp)) &&
-       (GNUNET_YES !=
-        GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
-       (GNUNET_YES ==
-        GNUNET_OS_check_helper_binary (binary, GNUNET_YES, "-d 127.0.0.1 127.0.0.2 42"))); // none of these parameters are actually used in privilege testing mode
+                                               &tmp)) && (0 < strlen (tmp)))
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("test_icmp_client not possible, as we have no internal IPv4 address\n"));
+  }
+  else
+    goto err;
+  
+  if (GNUNET_YES !=
+      GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")){
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("test_icmp_server not possible, as we are not behind NAT\n"));
+  }
+  else
+    goto err;
+  
+  if (GNUNET_YES ==
+      GNUNET_OS_check_helper_binary (helper, GNUNET_YES, "-d 127.0.0.1 127.0.0.2 42")){
+          // none of these parameters are actually used in privilege testing mode
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("No working gnunet-helper-nat-server found\n"));
+  }
+err:
   GNUNET_free_non_null (tmp);
-  GNUNET_free (binary);
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-             (hnc) 
-             ? _("gnunet-helper-nat-client found, enabling it\n")
-             : _("gnunet-helper-nat-client not found or behind NAT, disabling it\n"));
+  GNUNET_free (helper);
+
   next_phase (ah);
 }
 
@@ -511,7 +544,8 @@ next_phase (struct GNUNET_NAT_AutoHandle *ah)
     diff = GNUNET_CONFIGURATION_get_diff (ah->initial_cfg,
                                          ah->cfg);
     ah->fin_cb (ah->fin_cb_cls,
-               diff);
+               diff,
+                ah->ret);
     GNUNET_CONFIGURATION_destroy (diff);
     GNUNET_NAT_autoconfig_cancel (ah);
     return;
@@ -519,14 +553,13 @@ next_phase (struct GNUNET_NAT_AutoHandle *ah)
 }
 
 
-
 /**
  * Start auto-configuration routine.  The resolver service should
  * be available when this function is called.
  *
  * @param cfg initial configuration
  * @param cb function to call with autoconfiguration result
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
  * @return handle to cancel operation
  */
 struct GNUNET_NAT_AutoHandle *
@@ -536,21 +569,22 @@ GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 {
   struct GNUNET_NAT_AutoHandle *ah;
 
-  ah = GNUNET_malloc (sizeof (struct GNUNET_NAT_AutoHandle));
+  ah = GNUNET_new (struct GNUNET_NAT_AutoHandle);
   ah->fin_cb = cb;
   ah->fin_cb_cls = cb_cls;
+  ah->ret = GNUNET_NAT_ERROR_SUCCESS;
   ah->cfg = GNUNET_CONFIGURATION_dup (cfg);
   ah->initial_cfg = GNUNET_CONFIGURATION_dup (cfg);
 
   /* never use loopback addresses if user wanted autoconfiguration */
-  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", 
-                                        "USE_LOCALADDR", 
+  GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat",
+                                        "USE_LOCALADDR",
                                         "NO");
   next_phase (ah);
   return ah;
 }
 
-                            
+
 /**
  * Abort autoconfiguration.
  *
@@ -569,10 +603,10 @@ GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah)
     GNUNET_NAT_mini_get_external_ipv4_cancel (ah->eh);
     ah->eh = NULL;
   }
-  if (GNUNET_SCHEDULER_NO_TASK != ah->task)
+  if (NULL != ah->task)
   {
     GNUNET_SCHEDULER_cancel (ah->task);
-    ah->task = GNUNET_SCHEDULER_NO_TASK;
+    ah->task = NULL;
   }
   GNUNET_CONFIGURATION_destroy (ah->cfg);
   GNUNET_CONFIGURATION_destroy (ah->initial_cfg);
@@ -580,5 +614,4 @@ GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah)
 }
 
 
-
 /* end of nat_auto.c */