gnunet-service-nat-auto.c File Reference

NAT autoconfiguration service. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_nat_service.h"
#include "gnunet_statistics_service.h"
#include "nat-auto.h"
#include <gcrypt.h>

Include dependency graph for gnunet-service-nat-auto.c:

Go to the source code of this file.

Data Structures
struct	ClientHandle
	Struct containing information about a client, handle to connect to it, and any pending messages that need to be sent to it. More...
struct	AutoconfigContext
	Context for autoconfiguration operations. More...

Macros
#define	AUTOCONFIG_TIMEOUT
	How long do we wait until we forcefully terminate autoconfiguration? More...

Functions
static int	check_autoconfig_request (void *cls, const struct GNUNET_NAT_AUTO_AutoconfigRequestMessage *message)
	Check validity of #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG message from client. More...
static void	terminate_ac_activities (struct AutoconfigContext *ac)
	Stop all pending activities with respect to the ac. More...
static void	conclude_autoconfig_request (void *cls)
	Finish handling the autoconfiguration request and send the response to the client. More...
static void	check_autoconfig_finished (struct AutoconfigContext *ac)
	Check if all autoconfiguration operations have concluded, and if they have, send the result back to the client. More...
static void	update_enable_upnpc_option (struct AutoconfigContext *ac)
	Update ENABLE_UPNPC configuration option. More...
static void	handle_autoconfig_request (void *cls, const struct GNUNET_NAT_AUTO_AutoconfigRequestMessage *message)
	Handler for #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG message from client. More...
static void	shutdown_task (void *cls)
	Task run during shutdown. More...
static void	run (void *cls, const struct GNUNET_CONFIGURATION_Handle *c, struct GNUNET_SERVICE_Handle *service)
	Setup NAT service. More...
static void *	client_connect_cb (void *cls, struct GNUNET_SERVICE_Client *c, struct GNUNET_MQ_Handle *mq)
	Callback called when a client connects to the service. More...
static void	client_disconnect_cb (void *cls, struct GNUNET_SERVICE_Client *c, void *internal_cls)
	Callback called when a client disconnected from the service. More...
	GNUNET_SERVICE_MAIN (GNUNET_OS_project_data_gnunet(), "nat-auto", GNUNET_SERVICE_OPTION_NONE, &run, &client_connect_cb, &client_disconnect_cb, NULL, GNUNET_MQ_hd_var_size(autoconfig_request, GNUNET_MESSAGE_TYPE_NAT_AUTO_REQUEST_CFG, struct GNUNET_NAT_AUTO_AutoconfigRequestMessage, NULL), GNUNET_MQ_handler_end())
	Define "main" method using service macro. More...

Variables
static struct ClientHandle *	ch_head
	Head of client DLL. More...
static struct ClientHandle *	ch_tail
	Tail of client DLL. More...
static struct AutoconfigContext *	ac_head
	DLL of our autoconfiguration operations. More...
static struct AutoconfigContext *	ac_tail
	DLL of our autoconfiguration operations. More...
static const struct GNUNET_CONFIGURATION_Handle *	cfg
	Handle to our current configuration. More...
static struct GNUNET_STATISTICS_Handle *	stats
	Handle to the statistics service. More...

Detailed Description

NAT autoconfiguration service.

Author

Christian Grothoff

TODO:

• merge client handle and autoconfig context
• implement "more" autoconfig:
  • re-work gnunet-nat-server & integrate!
  • integrate "legacy" code
  • test manually punched NAT (how?)

Definition in file gnunet-service-nat-auto.c.

Macro Definition Documentation

AUTOCONFIG_TIMEOUT

#define AUTOCONFIG_TIMEOUT

Value:

          GNUNET_TIME_relative_multiply ( \
          GNUNET_TIME_UNIT_SECONDS, 5)

How long do we wait until we forcefully terminate autoconfiguration?

Definition at line 45 of file gnunet-service-nat-auto.c.

Function Documentation

check_autoconfig_request()

static int check_autoconfig_request ( void *  cls, const struct GNUNET_NAT_AUTO_AutoconfigRequestMessage *  message  )

static

Check validity of #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG message from client.

Parameters

cls	client who sent the message
message	the message received

Returns

GNUNET_OK if message is well-formed

Definition at line 170 of file gnunet-service-nat-auto.c.

{
  return GNUNET_OK;  /* checked later */
}

References GNUNET_OK.

terminate_ac_activities()

static void terminate_ac_activities ( struct AutoconfigContext *  ac )

static

Stop all pending activities with respect to the ac.

Parameters

ac	autoconfiguration to terminate activities for

Definition at line 184 of file gnunet-service-nat-auto.c.

{
  if (NULL != ac->timeout_task)
  {
    GNUNET_SCHEDULER_cancel (ac->timeout_task);
    ac->timeout_task = NULL;
  }
}

References GNUNET_SCHEDULER_cancel(), and AutoconfigContext::timeout_task.

Referenced by conclude_autoconfig_request(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

conclude_autoconfig_request()

static void conclude_autoconfig_request ( void *  cls )

static

Finish handling the autoconfiguration request and send the response to the client.

Parameters

cls	the struct AutoconfigContext to conclude

Definition at line 201 of file gnunet-service-nat-auto.c.

{
  struct AutoconfigContext *ac = cls;
  struct ClientHandle *ch = ac->ch;
  struct GNUNET_NAT_AUTO_AutoconfigResultMessage *arm;
  struct GNUNET_MQ_Envelope *env;
  size_t c_size;
  char *buf;
  struct GNUNET_CONFIGURATION_Handle *diff;
 
  ac->timeout_task = NULL;
  terminate_ac_activities (ac);
 
  /* Send back response */
  diff = GNUNET_CONFIGURATION_get_diff (ac->orig,
                                        ac->c);
  buf = GNUNET_CONFIGURATION_serialize (diff,
                                        &c_size);
  GNUNET_CONFIGURATION_destroy (diff);
  env = GNUNET_MQ_msg_extra (arm,
                             c_size,
                             GNUNET_MESSAGE_TYPE_NAT_AUTO_CFG_RESULT);
  arm->status_code = htonl ((uint32_t) ac->status_code);
  arm->type = htonl ((uint32_t) ac->type);
  GNUNET_memcpy (&arm[1],
                 buf,
                 c_size);
  GNUNET_free (buf);
  GNUNET_MQ_send (ch->mq,
                  env);
 
  /* clean up */
  GNUNET_CONFIGURATION_destroy (ac->orig);
  GNUNET_CONFIGURATION_destroy (ac->c);
  GNUNET_CONTAINER_DLL_remove (ac_head,
                               ac_tail,
                               ac);
  GNUNET_free (ac);
  GNUNET_SERVICE_client_continue (ch->client);
}

References ac_head, ac_tail, AutoconfigContext::c, ch, AutoconfigContext::ch, env, GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_get_diff(), GNUNET_CONFIGURATION_serialize(), GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_NAT_AUTO_CFG_RESULT, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_SERVICE_client_continue(), GNUNET_CADET_Channel::mq, AutoconfigContext::orig, AutoconfigContext::status_code, GNUNET_NAT_AUTO_AutoconfigResultMessage::status_code, terminate_ac_activities(), AutoconfigContext::timeout_task, AutoconfigContext::type, and GNUNET_NAT_AUTO_AutoconfigResultMessage::type.

Referenced by check_autoconfig_finished(), and handle_autoconfig_request().

Here is the call graph for this function:

Here is the caller graph for this function:

check_autoconfig_finished()

static void check_autoconfig_finished ( struct AutoconfigContext *  ac )

static

Check if all autoconfiguration operations have concluded, and if they have, send the result back to the client.

Parameters

ac	autoconfiguation context to check

Definition at line 250 of file gnunet-service-nat-auto.c.

{
  GNUNET_SCHEDULER_cancel (ac->timeout_task);
  ac->timeout_task
    = GNUNET_SCHEDULER_add_now (&conclude_autoconfig_request,
                                ac);
}

References conclude_autoconfig_request(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), and AutoconfigContext::timeout_task.

Referenced by handle_autoconfig_request().

Here is the call graph for this function:

Here is the caller graph for this function:

update_enable_upnpc_option()

static void update_enable_upnpc_option ( struct AutoconfigContext *  ac )

static

Update ENABLE_UPNPC configuration option.

Parameters

ac	autoconfiguration to update

Definition at line 265 of file gnunet-service-nat-auto.c.

{
  switch (ac->enable_upnpc)
  {
  case GNUNET_YES:
    GNUNET_CONFIGURATION_set_value_string (ac->c,
                                           "NAT",
                                           "ENABLE_UPNP",
                                           "YES");
    break;
 
  case GNUNET_NO:
    GNUNET_CONFIGURATION_set_value_string (ac->c,
                                           "NAT",
                                           "ENABLE_UPNP",
                                           "NO");
    break;
 
  case GNUNET_SYSERR:
    /* We are unsure, do not change option */
    break;
  }
}

References AutoconfigContext::c, AutoconfigContext::enable_upnpc, GNUNET_CONFIGURATION_set_value_string(), GNUNET_NO, GNUNET_SYSERR, and GNUNET_YES.

Referenced by handle_autoconfig_request().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_autoconfig_request()

static void handle_autoconfig_request ( void *  cls, const struct GNUNET_NAT_AUTO_AutoconfigRequestMessage *  message  )

static

Handler for #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG message from client.

Parameters

cls	client who sent the message
message	the message received

Definition at line 298 of file gnunet-service-nat-auto.c.

{
  struct ClientHandle *ch = cls;
  size_t left = ntohs (message->header.size) - sizeof(*message);
  struct AutoconfigContext *ac;
 
  ac = GNUNET_new (struct AutoconfigContext);
  ac->status_code = GNUNET_NAT_ERROR_SUCCESS;
  ac->ch = ch;
  ac->c = GNUNET_CONFIGURATION_create (GNUNET_OS_project_data_gnunet ());
  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_deserialize (ac->c,
                                        (const char *) &message[1],
                                        left,
                                        NULL))
  {
    GNUNET_break (0);
    GNUNET_SERVICE_client_drop (ch->client);
    GNUNET_CONFIGURATION_destroy (ac->c);
    GNUNET_free (ac);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received REQUEST_AUTO_CONFIG message from client\n");
 
  GNUNET_CONTAINER_DLL_insert (ac_head,
                               ac_tail,
                               ac);
  ac->orig
    = GNUNET_CONFIGURATION_dup (ac->c);
  ac->timeout_task
    = GNUNET_SCHEDULER_add_delayed (AUTOCONFIG_TIMEOUT,
                                    &conclude_autoconfig_request,
                                    ac);
  ac->enable_upnpc = GNUNET_SYSERR; /* undecided */
 
  /* Probe for upnpc */
  if (GNUNET_SYSERR ==
      GNUNET_OS_check_helper_binary ("upnpc",
                                     GNUNET_NO,
                                     NULL))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                _ ("UPnP client `upnpc` command not found, disabling UPnP\n"));
    ac->enable_upnpc = GNUNET_NO;
  }
  else
  {
    /* We might at some point be behind NAT, try upnpc */
    ac->enable_upnpc = GNUNET_YES;
  }
  update_enable_upnpc_option (ac);
 
  /* Finally, check if we are already done */
  check_autoconfig_finished (ac);
}

References _, ac_head, ac_tail, AUTOCONFIG_TIMEOUT, AutoconfigContext::c, ch, AutoconfigContext::ch, check_autoconfig_finished(), conclude_autoconfig_request(), AutoconfigContext::enable_upnpc, GNUNET_break, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_deserialize(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_dup(), GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_NAT_ERROR_SUCCESS, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_OS_check_helper_binary(), GNUNET_OS_project_data_gnunet(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SERVICE_client_drop(), GNUNET_SYSERR, GNUNET_YES, GNUNET_NAT_AUTO_AutoconfigRequestMessage::header, AutoconfigContext::orig, GNUNET_MessageHeader::size, AutoconfigContext::status_code, AutoconfigContext::timeout_task, and update_enable_upnpc_option().

Here is the call graph for this function:

shutdown_task()

static void shutdown_task ( void *  cls )

static

Task run during shutdown.

Parameters

cls

unused

Definition at line 364 of file gnunet-service-nat-auto.c.

{
  struct AutoconfigContext *ac;
 
  while (NULL != (ac = ac_head))
  {
    GNUNET_CONTAINER_DLL_remove (ac_head,
                                 ac_tail,
                                 ac);
    terminate_ac_activities (ac);
    GNUNET_free (ac);
  }
  if (NULL != stats)
  {
    GNUNET_STATISTICS_destroy (stats,
                               GNUNET_NO);
    stats = NULL;
  }
}

References ac_head, ac_tail, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_NO, GNUNET_STATISTICS_destroy(), stats, and terminate_ac_activities().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

run()

static void run ( void *  cls, const struct GNUNET_CONFIGURATION_Handle *  c, struct GNUNET_SERVICE_Handle *  service  )

static

Setup NAT service.

Parameters

cls	closure
c	configuration to use
service	the initialized service

Definition at line 393 of file gnunet-service-nat-auto.c.

{
  cfg = c;
  GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
                                 NULL);
  stats = GNUNET_STATISTICS_create ("nat-auto",
                                    cfg);
}

References AutoconfigContext::c, cfg, GNUNET_SCHEDULER_add_shutdown(), GNUNET_STATISTICS_create(), shutdown_task(), and stats.

Here is the call graph for this function:

client_connect_cb()

static void * client_connect_cb ( void *  cls, struct GNUNET_SERVICE_Client *  c, struct GNUNET_MQ_Handle *  mq  )

static

Callback called when a client connects to the service.

Parameters

cls	closure for the service
c	the new client that connected to the service
mq	the message queue used to send messages to the client

Returns

a struct ClientHandle

Definition at line 414 of file gnunet-service-nat-auto.c.

{
  struct ClientHandle *ch;
 
  ch = GNUNET_new (struct ClientHandle);
  ch->mq = mq;
  ch->client = c;
  GNUNET_CONTAINER_DLL_insert (ch_head,
                               ch_tail,
                               ch);
  return ch;
}

References ch, ch_head, ch_tail, GNUNET_CONTAINER_DLL_insert, GNUNET_new, mq, and GNUNET_CADET_Channel::mq.

client_disconnect_cb()

static void client_disconnect_cb ( void *  cls, struct GNUNET_SERVICE_Client *  c, void *  internal_cls  )

static

Callback called when a client disconnected from the service.

Parameters

cls	closure for the service
c	the client that disconnected
internal_cls	a struct ClientHandle *

Definition at line 438 of file gnunet-service-nat-auto.c.

{
  struct ClientHandle *ch = internal_cls;
 
  GNUNET_CONTAINER_DLL_remove (ch_head,
                               ch_tail,
                               ch);
  GNUNET_free (ch);
}

References ch, ch_head, ch_tail, GNUNET_CONTAINER_DLL_remove, and GNUNET_free.

GNUNET_SERVICE_MAIN()

GNUNET_SERVICE_MAIN	(	GNUNET_OS_project_data_gnunet()	,
		"nat-auto"	,
		GNUNET_SERVICE_OPTION_NONE	,
		&	run,
		&	client_connect_cb,
		&	client_disconnect_cb,
		NULL	,
		GNUNET_MQ_hd_var_size(autoconfig_request, GNUNET_MESSAGE_TYPE_NAT_AUTO_REQUEST_CFG, struct GNUNET_NAT_AUTO_AutoconfigRequestMessage, NULL)	,
		GNUNET_MQ_handler_end()
	)

Define "main" method using service macro.

Variable Documentation

ch_head

struct ClientHandle* ch_head

static

Head of client DLL.

Definition at line 133 of file gnunet-service-nat-auto.c.

Referenced by client_connect_cb(), and client_disconnect_cb().

ch_tail

struct ClientHandle* ch_tail

static

Tail of client DLL.

Definition at line 138 of file gnunet-service-nat-auto.c.

Referenced by client_connect_cb(), and client_disconnect_cb().

ac_head

struct AutoconfigContext* ac_head

static

DLL of our autoconfiguration operations.

Definition at line 143 of file gnunet-service-nat-auto.c.

Referenced by conclude_autoconfig_request(), handle_autoconfig_request(), and shutdown_task().

ac_tail

struct AutoconfigContext* ac_tail

static

DLL of our autoconfiguration operations.

Definition at line 148 of file gnunet-service-nat-auto.c.

Referenced by conclude_autoconfig_request(), handle_autoconfig_request(), and shutdown_task().

cfg

const struct GNUNET_CONFIGURATION_Handle* cfg

static

Handle to our current configuration.

Definition at line 153 of file gnunet-service-nat-auto.c.

Referenced by run().

stats

struct GNUNET_STATISTICS_Handle* stats

static

Handle to the statistics service.

Definition at line 158 of file gnunet-service-nat-auto.c.

Referenced by run(), and shutdown_task().