path: root/src/setup/gnunet-setup-transport.c

/*
     This file is part of GNUnet.
     (C) 2010, 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
     by the Free Software Foundation; either version 2, or (at your
     option) any later version.

     GNUnet 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 GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file src/setup/gnunet-setup-transport.c
 * @brief support for transport (NAT) configuration
 * @author Christian Grothoff
 *
 * TODO:
 * - cummulate collected information in the context
 * - implement and refine existing network setup tests
 * - if NAT detected and all traversal methods fail and no IPv6,
 *   set transport plugin ports to 0
 */
#include "gnunet-setup.h"
#include "gnunet-setup-transport.h"
#include <gnunet/gnunet_util_lib.h>
#include <gnunet/gnunet_resolver_service.h>
#include <gnunet/gnunet_nat_lib.h>

/**
 * How long do we wait for the NAT test to report success?
 */
#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)

/**
 * Phases of the auto configuration.
 */
enum AutoPhase
{
  /**
   * Initial start value.
   */
  AUTO_INIT = 0,

  /**
   * Test if we are online.
   */
  AUTO_ONLINE = 1,

  /**
   * Test our external IP.
   */
  AUTO_EXTERNAL_IP,

  /**
   * Test our internal IP.
   */
  AUTO_LOCAL_IP,

  /**
   * Test if NAT was punched.
   */
  AUTO_NAT_PUNCHED,

  /**
   * Test if UPnP is working.
   */
  AUTO_UPNPC,

  /**
   * Test if ICMP server works.
   */
  AUTO_ICMP_SERVER,

  /**
   * Test if ICMP client works.
   */
  AUTO_ICMP_CLIENT,

  /**
   * Last phase, we're done.
   */
  AUTO_DONE
  
};


/**
 * Context for the autoconfig test.
 */
struct GNUNET_SetupAutoContext
{

  /**
   * Handle to the active NAT test.
   */
  struct GNUNET_NAT_Test *tst;

  /**
   * Function to call when done.
   */
  GNUNET_SetupAutoConfigFinished fin_cb;
  
  /**
   * Closure for 'fin_cb'.
   */
  void *fin_cb_cls;
  
  /**
   * Handle for active 'GNUNET_NAT_mini_get_external_ipv4'-operation.
   */
  struct GNUNET_NAT_ExternalHandle *eh;

  /**
   * Task identifier for the timeout.
   */
  GNUNET_SCHEDULER_TaskIdentifier tsk;

  /**
   * Where are we in the test?
   */
  enum AutoPhase phase;

};


/**
 * Run the next phase of the auto test.
 */
static void
next_phase (struct GNUNET_SetupAutoContext *ac);


/**
 * Update the ICMP server button based on the result.
 *
 * @param on GNUNET_YES to enable, GNUNET_NO to disable
 */
static void
update_icmp_server_enable_button (int on)
{
  GtkToggleButton *button;

  button =
      GTK_TOGGLE_BUTTON (GNUNET_SETUP_get_object
                         ("GNUNET_setup_transport_icmp_server_enable_checkbutton"));
  if (button == NULL)
  {
    GNUNET_break (0);
    return;
  }
  gtk_toggle_button_set_active (button, on ? TRUE : FALSE);
}


/**
 * Function called by NAT on success.
 * Clean up and update GUI (with success).
 *
 * @param cls closure (unused)
 * @param success currently always GNUNET_OK
 */
static void
result_callback (void *cls, int success)
{
  struct GNUNET_SetupAutoContext *ac = cls;

  GNUNET_SCHEDULER_cancel (ac->tsk);
  ac->tsk = GNUNET_SCHEDULER_NO_TASK;
  GNUNET_NAT_test_stop (ac->tst);
  ac->tst = NULL;
  update_icmp_server_enable_button (success);
  next_phase (ac);
}


/**
 * 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_SetupAutoContext *ac = cls;

  GNUNET_assert (NULL != ac->tst);
  ac->tsk = GNUNET_SCHEDULER_NO_TASK;
  GNUNET_NAT_test_stop (ac->tst);
  ac->tst = NULL;
  update_icmp_server_enable_button (GNUNET_NO);
  next_phase (ac);
}


/**
 * Main function for the connection reversal test.
 *
 * @param cls the 'int*' for the result
 * @param tc scheduler context
 */
static void
reversal_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct GNUNET_SetupAutoContext *ac = cls;

  GNUNET_assert (NULL != cfg);
  GNUNET_RESOLVER_connect (cfg);
  ac->tst = GNUNET_NAT_test_start (cfg, GNUNET_YES, 0, 0, &result_callback, ac);
  if (NULL == ac->tst)
  {
    next_phase (ac);
    return;
  }
  ac->tsk = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, ac);
}


/**
 * Test if we are online at all.
 *
 * @param ac auto setup context
 */
static void
test_online (struct GNUNET_SetupAutoContext *ac)
{
  // FIXME: not implemented
  next_phase (ac);
}


/**
 * Set our external IPv4 address.
 *
 * @param cls closure with our setup context
 * @param addr the address, NULL on errors
 */
static void
set_external_ipv4 (void *cls, const struct in_addr *addr)
{
  struct GNUNET_SetupAutoContext *ac = cls;
  char buf[INET_ADDRSTRLEN];
  GObject *o;

  ac->eh = NULL;
  if (NULL == addr)
  {
    next_phase (ac);
    return;
  }
  /* enable 'behind nat' */
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
	      _("Detected external IP `%s'\n"),
	      inet_ntop (AF_INET,
			 addr,
			 buf,
			 sizeof (buf)));
  if (NULL != cfg)
    GNUNET_CONFIGURATION_set_value_string (cfg, "nat", "BEHIND_NAT", "YES");
  o = GNUNET_SETUP_get_object ("GNUNET_setup_transport_nat_checkbutton");
  gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (o), TRUE);

  /* set external IP address */
  if (NULL == inet_ntop (AF_INET, addr, buf, sizeof (buf)))
  {
    GNUNET_break (0);
    next_phase (ac);
    return;
  }
  if (NULL != cfg)
    GNUNET_CONFIGURATION_set_value_string (cfg, "nat", "EXTERNAL_ADDRESS",
					   buf);
  o = GNUNET_SETUP_get_object ("GNUNET_setup_transport_external_ip_address_entry");
  gtk_entry_set_text (GTK_ENTRY (o), buf);
  next_phase (ac);
}


/**
 * Determine our external IPv4 address.
 *
 * @param ac auto setup context
 */
static void
test_external_ip (struct GNUNET_SetupAutoContext *ac)
{
  // FIXME: CPS?
  /* try to detect external IP */
  ac->eh = GNUNET_NAT_mini_get_external_ipv4 (TIMEOUT,
					      &set_external_ipv4, ac);
}


/**
 * Process list of local IP addresses.  Find and set the
 * one of the default interface.
 *
 * @param cls pointer to int to store if we have a non-local IPv6 address
 * @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
 */
static int
nipo (void *cls, const char *name, int isDefault, const struct sockaddr *addr,
      const struct sockaddr *broadcast_addr, const struct sockaddr *netmask,
      socklen_t addrlen)
{
  int *have_v6 = cls;
  const struct sockaddr_in *in;
  char buf[INET_ADDRSTRLEN];
  GtkEntry *entry;

  if (!isDefault)
    return GNUNET_OK;
  if ( (sizeof (struct sockaddr_in6) == addrlen) &&
       (0 != memcmp (&in6addr_loopback, addr,
		     addrlen)) &&
       (! IN6_IS_ADDR_LINKLOCAL(addr)) )
  {
    *have_v6 = GNUNET_YES;
    return GNUNET_OK;
  }
  if (addrlen != sizeof (struct sockaddr_in))
    return GNUNET_OK;
  in = (const struct sockaddr_in *) addr;

  /* set internal IP address */
  if (NULL == inet_ntop (AF_INET, &in->sin_addr, buf, sizeof (buf)))
  {
    GNUNET_break (0);
    return GNUNET_OK;
  }
  GNUNET_CONFIGURATION_set_value_string (cfg, "nat", "INTERNAL_ADDRESS", buf);
  entry =
      GTK_ENTRY (GNUNET_SETUP_get_object
                 ("GNUNET_setup_transport_internal_ip_entry"));
  gtk_entry_set_text (entry, buf);
  /* no need to continue iteration */
  return GNUNET_SYSERR;
}


/**
 * Determine our local IP addresses; detect internal IP & IPv6-support 
 *
 * @param ac auto setup context
 */
static void
test_local_ip (struct GNUNET_SetupAutoContext *ac)
{
  GtkToggleButton *button;
  int have_v6;

  have_v6 = GNUNET_NO;
  GNUNET_OS_network_interfaces_list (&nipo, &have_v6);
  button = GTK_TOGGLE_BUTTON (GNUNET_SETUP_get_object ("GNUNET_setup_transport_disable_ipv6_checkbutton"));
  gtk_toggle_button_set_active (button,
				(GNUNET_YES == have_v6) ? FALSE : TRUE);
  if (NULL != cfg)
    GNUNET_CONFIGURATION_set_value_string (cfg, "nat", "DISABLEV6", 
					   (GNUNET_YES == have_v6) ? "NO" : "YES");
  next_phase (ac);
}


/**
 * Test if NAT has been punched
 *
 * @param ac auto setup context
 */
static void
test_nat_punched (struct GNUNET_SetupAutoContext *ac)
{
  // FIXME: not implemented
  next_phase (ac);
}


/**
 * Test if UPnPC works.
 *
 * @param ac auto setup context
 */
static void
test_upnpc (struct GNUNET_SetupAutoContext *ac)
{
  int have_upnpc;
  GtkToggleButton *button;

  /* test if upnpc is available */
  button = GTK_TOGGLE_BUTTON (GNUNET_SETUP_get_object ("GNUNET_setup_transport_upnp_enable_checkbutton"));
  have_upnpc = (GNUNET_SYSERR !=
		GNUNET_OS_check_helper_binary ("upnpc"));
  /* FIXME: test if upnpc is actually working, that is, if transports
     start to work once we use UPnP */
  gtk_toggle_button_set_active (button,
				have_upnpc
				? TRUE
				: FALSE);
  if (NULL != cfg)
    GNUNET_CONFIGURATION_set_value_string (cfg, "nat", "ENABLE_UPNP", 
					   (GNUNET_YES == have_upnpc) ? "YES" : "NO");
  next_phase (ac);
}


/**
 * Test if ICMP server is working
 *
 * @param ac auto setup context
 */
static void
test_icmp_server (struct GNUNET_SetupAutoContext *ac)
{
  int hns;
  char *tmp;
  char *binary;

  tmp = NULL;
  binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
  hns =
      ((GNUNET_OK ==
        GNUNET_CONFIGURATION_get_value_string (cfg, "nat", "EXTERNAL_ADDRESS",
                                               &tmp)) && (0 < strlen (tmp)) &&
       (GNUNET_YES ==
        GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "BEHIND_NAT")) &&
       (GNUNET_YES ==
        GNUNET_OS_check_helper_binary (binary)));
  GNUNET_free_non_null (tmp);
  GNUNET_free (binary);
  if (hns)
     GNUNET_SCHEDULER_add_now (&reversal_test, ac);
  else
    next_phase (ac);
}


/**
 * Test if ICMP client is working
 *
 * @param ac auto setup context
 */
static void
test_icmp_client (struct GNUNET_SetupAutoContext *ac)
{
  GtkToggleButton *button;
  int hnc;
  char *tmp;
  char *binary;

  tmp = NULL;
  binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
  hnc =
      ((GNUNET_OK ==
        GNUNET_CONFIGURATION_get_value_string (cfg, "nat", "INTERNAL_ADDRESS",
                                               &tmp)) && (0 < strlen (tmp)) &&
       (GNUNET_YES !=
        GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "BEHIND_NAT")) &&
       (GNUNET_YES ==
        GNUNET_OS_check_helper_binary (binary)));
  GNUNET_free_non_null (tmp);
  GNUNET_free (binary);
  button =
      GTK_TOGGLE_BUTTON (GNUNET_SETUP_get_object
                         ("GNUNET_setup_transport_icmp_client_enable_checkbutton"));
  gtk_toggle_button_set_active (button, hnc ? TRUE : FALSE);
  next_phase (ac);
}


/**
 * User asked for autoconfiguration.  Try the full program.
 *
 * @param fin_cb function to call when done
 * @param fin_cb_cls closure for 'fin_cb'
 * @return handle for the operation 
 */
struct GNUNET_SetupAutoContext *
GNUNET_setup_transport_autoconfig_start (GNUNET_SetupAutoConfigFinished fin_cb,
					 void *fin_cb_cls)
{
  struct GNUNET_SetupAutoContext *ac;

  ac = GNUNET_malloc (sizeof (struct GNUNET_SetupAutoContext));
  ac->fin_cb = fin_cb;
  ac->fin_cb_cls = fin_cb_cls;

  /* never use loopback addresses if user wanted autoconfiguration */
  GNUNET_CONFIGURATION_set_value_string (cfg, "nat", 
					 "USE_LOCALADDR", 
					 "NO");
  next_phase (ac);
  return ac;
}


/**
 * Run the next phase of the auto test.
 */
static void
next_phase (struct GNUNET_SetupAutoContext *ac)
{
  ac->phase++;
  switch (ac->phase)
  {
  case AUTO_INIT:
    GNUNET_assert (0);
    break;
  case AUTO_ONLINE:
    test_online (ac);
    break;
  case AUTO_EXTERNAL_IP:
    test_external_ip (ac);
    break;
  case AUTO_LOCAL_IP:
    test_local_ip (ac);
    break;
  case AUTO_NAT_PUNCHED:
    test_nat_punched (ac);
    break;
  case AUTO_UPNPC:
    test_upnpc (ac);
    break;
  case AUTO_ICMP_SERVER:
    test_icmp_server (ac);
    break;
  case AUTO_ICMP_CLIENT:
    test_icmp_client (ac);
    break;
  case AUTO_DONE:
    ac->fin_cb (ac->fin_cb_cls);
    GNUNET_free (ac);
    return;
  }
}


/**
 * Autoconfiguration test is finished, clear the block so
 * that it can be run again.
 *
 * @param cls pointer to the location that needs to be NULLed
 */
static void
clear_ac (void *cls)
{
  struct GNUNET_SetupAutoContext **acp = cls;

  *acp = NULL;
  gtk_widget_set_sensitive (GTK_WIDGET (GNUNET_SETUP_get_object ("GNUNET_setup_transport_autoconfig_button")),
			    TRUE);
}


/**
 * User asked for autoconfiguration.  Try the full program
 */
void
GNUNET_setup_transport_autoconfig_button_clicked_cb ()
{
  static struct GNUNET_SetupAutoContext *ac;

  /* make sure only one test is running at a time */
  if (NULL != ac)
  {
    GNUNET_break (0);
    return; 
  }
  gtk_widget_set_sensitive (GTK_WIDGET (GNUNET_SETUP_get_object ("GNUNET_setup_transport_autoconfig_button")),
			    FALSE);
  ac = GNUNET_setup_transport_autoconfig_start (&clear_ac,
						&ac);
}


/* end of gnunet-setup-transport.c */