functions for interaction with miniupnp; tested with miniupnpc 1.5 More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_nat_service.h"
#include "gnunet-service-nat_mini.h"
#include "nat.h"

Include dependency graph for gnunet-service-nat_mini.c:

Data Structures
struct	GNUNET_NAT_ExternalHandle
	Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation. More...

struct	GNUNET_NAT_MiniHandle
	Handle to a mapping created with upnpc. More...

Macros
#define	LOG(kind, ...) GNUNET_log_from (kind, "nat", __VA_ARGS__)

#define	MAP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
	How long do we give upnpc to create a mapping? More...

#define	UNMAP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
	How long do we give upnpc to remove a mapping? More...

#define	MAP_REFRESH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
	How often do we check for changes in the mapping? More...

Functions
static void	read_external_ipv4 (void *cls)
	Read the output of `external-ip` into `buf`. More...

static void	signal_external_ip_error (void *cls)
	(Asynchronously) signal error invoking `external-ip` to client. More...

struct GNUNET_NAT_ExternalHandle *	GNUNET_NAT_mini_get_external_ipv4_ (GNUNET_NAT_IPCallback cb, void *cb_cls)
	Try to get the external IPv4 address of this peer. More...

void	GNUNET_NAT_mini_get_external_ipv4_cancel_ (struct GNUNET_NAT_ExternalHandle *eh)
	Cancel operation. More...

static void	do_refresh (void *cls)
	Run "upnpc -l" to find out if our mapping changed. More...

static void	process_map_output (void cls, const char line)
	Process the output from the "upnpc -r" command. More...

static void	run_upnpc_r (struct GNUNET_NAT_MiniHandle *mini)
	Run "upnpc -r" to map our internal port. More...

static void	process_refresh_output (void cls, const char line)
	Process the output from "upnpc -l" to see if our external mapping changed. More...

struct GNUNET_NAT_MiniHandle *	GNUNET_NAT_mini_map_start (uint16_t port, int is_tcp, GNUNET_NAT_MiniAddressCallback ac, void *ac_cls)
	Start mapping the given port using (mini)upnpc. More...

static void	process_unmap_output (void cls, const char line)
	Process output from our 'unmap' command. More...

void	GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini)
	Remove a mapping created with (mini)upnpc. More...

Detailed Description

functions for interaction with miniupnp; tested with miniupnpc 1.5

Author: Christian Grothoff

Definition in file gnunet-service-nat_mini.c.

Macro Definition Documentation

◆ LOG

#define LOG	(	kind,
		...
	)	GNUNET_log_from (kind, "nat", __VA_ARGS__)

Definition at line 32 of file gnunet-service-nat_mini.c.

◆ MAP_TIMEOUT

#define MAP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)

How long do we give upnpc to create a mapping?

Definition at line 37 of file gnunet-service-nat_mini.c.

◆ UNMAP_TIMEOUT

#define UNMAP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)

How long do we give upnpc to remove a mapping?

Definition at line 42 of file gnunet-service-nat_mini.c.

◆ MAP_REFRESH_FREQ

#define MAP_REFRESH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)

How often do we check for changes in the mapping?

Definition at line 48 of file gnunet-service-nat_mini.c.

Function Documentation

◆ read_external_ipv4()

static void read_external_ipv4 ( void * cls )

static

Read the output of external-ip into buf.

When complete, parse the address and call our callback.

Parameters

cls	the `struct GNUNET_NAT_ExternalHandle`

Definition at line 113 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_ExternalHandle *eh = cls;
  ssize_t ret;
  struct in_addr addr;
 
  eh->task = NULL;
  ret = GNUNET_DISK_file_read (eh->r,
                               &eh->buf[eh->off],
                               sizeof(eh->buf) - eh->off);
  if (ret > 0)
  {
    /* try to read more */
    eh->off += ret;
    eh->task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
                                               eh->r,
                                               &read_external_ipv4,
                                               eh);
    return;
  }
  eh->ret = GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID;
  if ((eh->off > 7) && (eh->buf[eh->off - 1] == '\n'))
  {
    eh->buf[eh->off - 1] = '\0';
    if (1 == inet_pton (AF_INET, eh->buf, &addr))
    {
      if (0 == addr.s_addr)
        eh->ret =
          GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID;     /* got 0.0.0.0 */
      else
        eh->ret = GNUNET_NAT_ERROR_SUCCESS;
    }
  }
  eh->cb (eh->cb_cls,
          (GNUNET_NAT_ERROR_SUCCESS == eh->ret) ? &addr : NULL,
          eh->ret);
  GNUNET_NAT_mini_get_external_ipv4_cancel_ (eh);
}

References GNUNET_NAT_ExternalHandle::buf, GNUNET_NAT_ExternalHandle::cb, GNUNET_NAT_ExternalHandle::cb_cls, GNUNET_DISK_file_read(), GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID, GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID, GNUNET_NAT_ERROR_SUCCESS, GNUNET_NAT_mini_get_external_ipv4_cancel_(), GNUNET_SCHEDULER_add_read_file(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_NAT_ExternalHandle::off, GNUNET_NAT_ExternalHandle::r, read_external_ipv4(), ret, GNUNET_NAT_ExternalHandle::ret, and GNUNET_NAT_ExternalHandle::task.

Referenced by GNUNET_NAT_mini_get_external_ipv4_(), and read_external_ipv4().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ signal_external_ip_error()

static void signal_external_ip_error ( void * cls )

static

(Asynchronously) signal error invoking external-ip to client.

Parameters

cls	the `struct GNUNET_NAT_ExternalHandle` (freed)

Definition at line 159 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_ExternalHandle *eh = cls;
 
  eh->task = NULL;
  eh->cb (eh->cb_cls, NULL, eh->ret);
  GNUNET_free (eh);
}

References GNUNET_NAT_ExternalHandle::cb, GNUNET_NAT_ExternalHandle::cb_cls, GNUNET_free, GNUNET_NAT_ExternalHandle::ret, and GNUNET_NAT_ExternalHandle::task.

Referenced by GNUNET_NAT_mini_get_external_ipv4_().

Here is the caller graph for this function:

◆ GNUNET_NAT_mini_get_external_ipv4_()

struct GNUNET_NAT_ExternalHandle * GNUNET_NAT_mini_get_external_ipv4_	(	GNUNET_NAT_IPCallback	cb,
		void *	cb_cls
	)

Try to get the external IPv4 address of this peer.

Parameters

cb	function to call with result
cb_cls	closure for cb

Returns: handle for cancellation (can only be used until cb is called), never NULL

Definition at line 177 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_ExternalHandle *eh;
 
  eh = GNUNET_new (struct GNUNET_NAT_ExternalHandle);
  eh->cb = cb;
  eh->cb_cls = cb_cls;
  eh->ret = GNUNET_NAT_ERROR_SUCCESS;
  if (GNUNET_SYSERR ==
      GNUNET_OS_check_helper_binary ("external-ip", GNUNET_NO, NULL))
  {
    LOG (GNUNET_ERROR_TYPE_INFO, _ ("`external-ip' command not found\n"));
    eh->ret = GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND;
    eh->task = GNUNET_SCHEDULER_add_now (&signal_external_ip_error, eh);
    return eh;
  }
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Running `external-ip' to determine our external IP\n");
  eh->opipe = GNUNET_DISK_pipe (GNUNET_DISK_PF_BLOCKING_RW);
  if (NULL == eh->opipe)
  {
    eh->ret = GNUNET_NAT_ERROR_IPC_FAILURE;
    eh->task = GNUNET_SCHEDULER_add_now (&signal_external_ip_error, eh);
    return eh;
  }
  eh->eip = GNUNET_OS_start_process (GNUNET_OS_INHERIT_STD_NONE,
                                     NULL,
                                     eh->opipe,
                                     NULL,
                                     "external-ip",
                                     "external-ip",
                                     NULL);
  if (NULL == eh->eip)
  {
    GNUNET_DISK_pipe_close (eh->opipe);
    eh->ret = GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED;
    eh->task = GNUNET_SCHEDULER_add_now (&signal_external_ip_error, eh);
    return eh;
  }
  GNUNET_DISK_pipe_close_end (eh->opipe, GNUNET_DISK_PIPE_END_WRITE);
  eh->r = GNUNET_DISK_pipe_handle (eh->opipe, GNUNET_DISK_PIPE_END_READ);
  eh->task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
                                             eh->r,
                                             &read_external_ipv4,
                                             eh);
  return eh;
}

References _, GNUNET_NAT_ExternalHandle::cb, GNUNET_NAT_ExternalHandle::cb_cls, GNUNET_NAT_ExternalHandle::eip, GNUNET_DISK_PF_BLOCKING_RW, GNUNET_DISK_pipe(), GNUNET_DISK_pipe_close(), GNUNET_DISK_pipe_close_end(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_PIPE_END_WRITE, GNUNET_DISK_pipe_handle(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED, GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND, GNUNET_NAT_ERROR_IPC_FAILURE, GNUNET_NAT_ERROR_SUCCESS, GNUNET_new, GNUNET_NO, GNUNET_OS_check_helper_binary(), GNUNET_OS_INHERIT_STD_NONE, GNUNET_OS_start_process(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_add_read_file(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_REL, LOG, GNUNET_NAT_ExternalHandle::opipe, GNUNET_NAT_ExternalHandle::r, read_external_ipv4(), GNUNET_NAT_ExternalHandle::ret, signal_external_ip_error(), and GNUNET_NAT_ExternalHandle::task.

Referenced by run_external_ip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_NAT_mini_get_external_ipv4_cancel_()

void GNUNET_NAT_mini_get_external_ipv4_cancel_ ( struct GNUNET_NAT_ExternalHandle * eh )

Cancel operation.

Parameters

eh	operation to cancel

Definition at line 232 of file gnunet-service-nat_mini.c.

{
  if (NULL != eh->eip)
  {
    (void) GNUNET_OS_process_kill (eh->eip, SIGKILL);
    GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (eh->eip));
    GNUNET_OS_process_destroy (eh->eip);
  }
  if (NULL != eh->opipe)
  {
    GNUNET_DISK_pipe_close (eh->opipe);
    eh->opipe = NULL;
  }
  if (NULL != eh->task)
  {
    GNUNET_SCHEDULER_cancel (eh->task);
    eh->task = NULL;
  }
  GNUNET_free (eh);
}

References GNUNET_NAT_ExternalHandle::eip, GNUNET_break, GNUNET_DISK_pipe_close(), GNUNET_free, GNUNET_OK, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_SCHEDULER_cancel(), GNUNET_NAT_ExternalHandle::opipe, and GNUNET_NAT_ExternalHandle::task.

Referenced by GN_nat_status_changed(), read_external_ipv4(), and run_external_ip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ do_refresh()

static void do_refresh ( void * cls )

static

Run "upnpc -l" to find out if our mapping changed.

Parameters

cls	the `struct GNUNET_NAT_MiniHandle`

Definition at line 475 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_MiniHandle *mini = cls;
  int ac;
 
  mini->refresh_task =
    GNUNET_SCHEDULER_add_delayed (MAP_REFRESH_FREQ, &do_refresh, mini);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Running `upnpc' to check if our mapping still exists\n");
  mini->found = GNUNET_NO;
  ac = GNUNET_NO;
  if (NULL != mini->map_cmd)
  {
    /* took way too long, abort it! */
    GNUNET_OS_command_stop (mini->map_cmd);
    mini->map_cmd = NULL;
    ac = GNUNET_YES;
  }
  if (NULL != mini->refresh_cmd)
  {
    /* took way too long, abort it! */
    GNUNET_OS_command_stop (mini->refresh_cmd);
    mini->refresh_cmd = NULL;
    ac = GNUNET_YES;
  }
  mini->refresh_cmd = GNUNET_OS_command_run (&process_refresh_output,
                                             mini,
                                             MAP_TIMEOUT,
                                             "upnpc",
                                             "upnpc",
                                             "-l",
                                             NULL);
  if (GNUNET_YES == ac)
    mini->ac (mini->ac_cls,
              GNUNET_SYSERR,
              NULL,
              0,
              GNUNET_NAT_ERROR_UPNPC_TIMEOUT);
}

References GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, do_refresh(), GNUNET_NAT_MiniHandle::found, GNUNET_ERROR_TYPE_DEBUG, GNUNET_NAT_ERROR_UPNPC_TIMEOUT, GNUNET_NO, GNUNET_OS_command_run(), GNUNET_OS_command_stop(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SYSERR, GNUNET_YES, LOG, GNUNET_NAT_MiniHandle::map_cmd, MAP_REFRESH_FREQ, MAP_TIMEOUT, process_refresh_output(), GNUNET_NAT_MiniHandle::refresh_cmd, and GNUNET_NAT_MiniHandle::refresh_task.

Referenced by do_refresh(), GNUNET_NAT_mini_map_start(), and process_map_output().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process_map_output()

static void process_map_output	(	void *	cls,
		const char *	line
	)

static

Process the output from the "upnpc -r" command.

Process the output from the 'upnpc -r' command.

Parameters

cls	the `struct GNUNET_NAT_MiniHandle`
line	line of output, NULL at the end

Definition at line 523 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_MiniHandle *mini = cls;
  const char *ipaddr;
  char *ipa;
  const char *pstr;
  unsigned int port;
 
  if (NULL == line)
  {
    GNUNET_OS_command_stop (mini->map_cmd);
    mini->map_cmd = NULL;
    if (GNUNET_YES != mini->did_map)
      mini->ac (mini->ac_cls,
                GNUNET_SYSERR,
                NULL,
                0,
                GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED);
    if (NULL == mini->refresh_task)
      mini->refresh_task =
        GNUNET_SCHEDULER_add_delayed (MAP_REFRESH_FREQ, &do_refresh, mini);
    return;
  }
  /*
   * The upnpc output we're after looks like this:
   *
   * "external 87.123.42.204:3000 TCP is redirected to internal 192.168.2.150:3000"
   */if ((NULL == (ipaddr = strstr (line, " "))) ||
      (NULL == (pstr = strstr (ipaddr, ":"))) ||
      (1 != sscanf (pstr + 1, "%u", &port)))
  {
    return;   /* skip line */
  }
  ipa = GNUNET_strdup (ipaddr + 1);
  strstr (ipa, ":")[0] = '\0';
  if (1 != inet_pton (AF_INET, ipa, &mini->current_addr.sin_addr))
  {
    GNUNET_free (ipa);
    return;   /* skip line */
  }
  GNUNET_free (ipa);
 
  mini->current_addr.sin_port = htons (port);
  mini->current_addr.sin_family = AF_INET;
#if HAVE_SOCKADDR_IN_SIN_LEN
  mini->current_addr.sin_len = sizeof(struct sockaddr_in);
#endif
  mini->did_map = GNUNET_YES;
  mini->ac (mini->ac_cls,
            GNUNET_YES,
            (const struct sockaddr *) &mini->current_addr,
            sizeof(mini->current_addr),
            GNUNET_NAT_ERROR_SUCCESS);
}

References GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, GNUNET_NAT_MiniHandle::current_addr, GNUNET_NAT_MiniHandle::did_map, do_refresh(), GNUNET_free, GNUNET_NAT_ERROR_SUCCESS, GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED, GNUNET_OS_command_stop(), GNUNET_SCHEDULER_add_delayed(), GNUNET_strdup, GNUNET_SYSERR, GNUNET_YES, line, GNUNET_NAT_MiniHandle::map_cmd, MAP_REFRESH_FREQ, port, and GNUNET_NAT_MiniHandle::refresh_task.

Referenced by run_upnpc_r().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run_upnpc_r()

static void run_upnpc_r ( struct GNUNET_NAT_MiniHandle * mini )

static

Run "upnpc -r" to map our internal port.

Parameters

mini	our handle

Definition at line 345 of file gnunet-service-nat_mini.c.

{
  char pstr[6];
 
  GNUNET_snprintf (pstr, sizeof(pstr), "%u", (unsigned int) mini->port);
  mini->map_cmd = GNUNET_OS_command_run (&process_map_output,
                                         mini,
                                         MAP_TIMEOUT,
                                         "upnpc",
                                         "upnpc",
                                         "-r",
                                         pstr,
                                         mini->is_tcp ? "tcp" : "udp",
                                         NULL);
  if (NULL == mini->map_cmd)
  {
    mini->ac (mini->ac_cls,
              GNUNET_SYSERR,
              NULL,
              0,
              GNUNET_NAT_ERROR_UPNPC_FAILED);
    return;
  }
}

References GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, GNUNET_NAT_ERROR_UPNPC_FAILED, GNUNET_OS_command_run(), GNUNET_snprintf(), GNUNET_SYSERR, GNUNET_NAT_MiniHandle::is_tcp, GNUNET_NAT_MiniHandle::map_cmd, MAP_TIMEOUT, GNUNET_NAT_MiniHandle::port, and process_map_output().

Referenced by GNUNET_NAT_mini_map_start(), and process_refresh_output().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process_refresh_output()

static void process_refresh_output	(	void *	cls,
		const char *	line
	)

static

Process the output from "upnpc -l" to see if our external mapping changed.

If so, do the notifications.

Parameters

cls	the `struct GNUNET_NAT_MiniHandle`
line	line of output, NULL at the end

Definition at line 379 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_MiniHandle *mini = cls;
  char pstr[9];
  const char *s;
  unsigned int nport;
  struct in_addr exip;
 
  if (NULL == line)
  {
    GNUNET_OS_command_stop (mini->refresh_cmd);
    mini->refresh_cmd = NULL;
    if (GNUNET_NO == mini->found)
    {
      /* mapping disappeared, try to re-create */
      if (GNUNET_YES == mini->did_map)
      {
        mini->ac (mini->ac_cls,
                  GNUNET_NO,
                  (const struct sockaddr *) &mini->current_addr,
                  sizeof(mini->current_addr),
                  GNUNET_NAT_ERROR_SUCCESS);
        mini->did_map = GNUNET_NO;
      }
      run_upnpc_r (mini);
    }
    return;
  }
  if (! mini->did_map)
    return; /* never mapped, won't find our mapping anyway */
 
  /* we're looking for output of the form:
  * "ExternalIPAddress = 12.134.41.124" */
 
  s = strstr (line, "ExternalIPAddress = ");
  if (NULL != s)
  {
    s += strlen ("ExternalIPAddress = ");
    if (1 != inet_pton (AF_INET, s, &exip))
      return;   /* skip */
    if (exip.s_addr == mini->current_addr.sin_addr.s_addr)
      return;   /* no change */
    /* update mapping */
    mini->ac (mini->ac_cls,
              GNUNET_NO,
              (const struct sockaddr *) &mini->current_addr,
              sizeof(mini->current_addr),
              GNUNET_NAT_ERROR_SUCCESS);
    mini->current_addr.sin_addr = exip;
    mini->ac (mini->ac_cls,
              GNUNET_YES,
              (const struct sockaddr *) &mini->current_addr,
              sizeof(mini->current_addr),
              GNUNET_NAT_ERROR_SUCCESS);
    return;
  }
  /*
   * we're looking for output of the form:
   *
   * "0 TCP  3000->192.168.2.150:3000  'libminiupnpc' ''"
   * "1 UDP  3001->192.168.2.150:3001  'libminiupnpc' ''"
   *
   * the pattern we look for is:
   *
   * "%s TCP  PORT->STRING:OURPORT *" or
   * "%s UDP  PORT->STRING:OURPORT *"
   */GNUNET_snprintf (pstr, sizeof(pstr), ":%u ", mini->port);
  if (NULL == (s = strstr (line, "->")))
    return; /* skip */
  if (NULL == strstr (s, pstr))
    return; /* skip */
  if (1 != sscanf (line,
                   (mini->is_tcp) ? "%*u TCP  %u->%*s:%*u %*s"
                   : "%*u UDP  %u->%*s:%*u %*s",
                   &nport))
    return; /* skip */
  mini->found = GNUNET_YES;
  if (nport == ntohs (mini->current_addr.sin_port))
    return; /* no change */
 
  /* external port changed, update mapping */
  mini->ac (mini->ac_cls,
            GNUNET_NO,
            (const struct sockaddr *) &mini->current_addr,
            sizeof(mini->current_addr),
            GNUNET_NAT_ERROR_SUCCESS);
  mini->current_addr.sin_port = htons ((uint16_t) nport);
  mini->ac (mini->ac_cls,
            GNUNET_YES,
            (const struct sockaddr *) &mini->current_addr,
            sizeof(mini->current_addr),
            GNUNET_NAT_ERROR_SUCCESS);
}

References GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, GNUNET_NAT_MiniHandle::current_addr, GNUNET_NAT_MiniHandle::did_map, GNUNET_NAT_MiniHandle::found, GNUNET_NAT_ERROR_SUCCESS, GNUNET_NO, GNUNET_OS_command_stop(), GNUNET_snprintf(), GNUNET_YES, GNUNET_NAT_MiniHandle::is_tcp, line, GNUNET_NAT_MiniHandle::port, GNUNET_NAT_MiniHandle::refresh_cmd, and run_upnpc_r().

Referenced by do_refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_NAT_mini_map_start()

struct GNUNET_NAT_MiniHandle * GNUNET_NAT_mini_map_start	(	uint16_t	port,
		int	is_tcp,
		GNUNET_NAT_MiniAddressCallback	ac,
		void *	ac_cls
	)

Start mapping the given port using (mini)upnpc.

This function should typically not be used directly (it is used within the general-purpose GNUNET_NAT_register() code). However, it can be used if specifically UPnP-based NAT traversal is to be used or tested.

Parameters

port	port to map
is_tcp	GNUNET_YES to map TCP, GNUNET_NO for UDP
ac	function to call with mapping result
ac_cls	closure for ac

Returns: NULL on error (no 'upnpc' installed)

Definition at line 593 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_MiniHandle *ret;
 
  if (GNUNET_SYSERR == GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL))
  {
    LOG (GNUNET_ERROR_TYPE_INFO, _ ("`upnpc' command not found\n"));
    ac (ac_cls, GNUNET_SYSERR, NULL, 0, GNUNET_NAT_ERROR_UPNPC_NOT_FOUND);
    return NULL;
  }
  LOG (GNUNET_ERROR_TYPE_DEBUG, "Running `upnpc' to install mapping\n");
  ret = GNUNET_new (struct GNUNET_NAT_MiniHandle);
  ret->ac = ac;
  ret->ac_cls = ac_cls;
  ret->is_tcp = is_tcp;
  ret->port = port;
  ret->refresh_task =
    GNUNET_SCHEDULER_add_delayed (MAP_REFRESH_FREQ, &do_refresh, ret);
  run_upnpc_r (ret);
  return ret;
}

References _, GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, do_refresh(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_NAT_ERROR_UPNPC_NOT_FOUND, GNUNET_new, GNUNET_NO, GNUNET_OS_check_helper_binary(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SYSERR, GNUNET_NAT_MiniHandle::is_tcp, LOG, MAP_REFRESH_FREQ, port, ret, and run_upnpc_r().

Referenced by handle_register().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process_unmap_output()

static void process_unmap_output	(	void *	cls,
		const char *	line
	)

static

Process output from our 'unmap' command.

Parameters

cls	the `struct GNUNET_NAT_MiniHandle`
line	line of output, NULL at the end

Definition at line 626 of file gnunet-service-nat_mini.c.

{
  struct GNUNET_NAT_MiniHandle *mini = cls;
 
  if (NULL == line)
  {
    LOG (GNUNET_ERROR_TYPE_DEBUG, "UPnP unmap done\n");
    GNUNET_OS_command_stop (mini->unmap_cmd);
    mini->unmap_cmd = NULL;
    GNUNET_free (mini);
    return;
  }
  /* we don't really care about the output... */
}

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_OS_command_stop(), line, LOG, and GNUNET_NAT_MiniHandle::unmap_cmd.

Referenced by GNUNET_NAT_mini_map_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_NAT_mini_map_stop()

void GNUNET_NAT_mini_map_stop ( struct GNUNET_NAT_MiniHandle * mini )

Remove a mapping created with (mini)upnpc.

Calling this function will give 'upnpc' 1s to remove the mapping, so while this function is non-blocking, a task will be left with the scheduler for up to 1s past this call.

Parameters

mini	the handle

Definition at line 643 of file gnunet-service-nat_mini.c.

{
  char pstr[6];
 
  if (NULL != mini->refresh_task)
  {
    GNUNET_SCHEDULER_cancel (mini->refresh_task);
    mini->refresh_task = NULL;
  }
  if (NULL != mini->refresh_cmd)
  {
    GNUNET_OS_command_stop (mini->refresh_cmd);
    mini->refresh_cmd = NULL;
  }
  if (NULL != mini->map_cmd)
  {
    GNUNET_OS_command_stop (mini->map_cmd);
    mini->map_cmd = NULL;
  }
  if (GNUNET_NO == mini->did_map)
  {
    GNUNET_free (mini);
    return;
  }
  mini->ac (mini->ac_cls,
            GNUNET_NO,
            (const struct sockaddr *) &mini->current_addr,
            sizeof(mini->current_addr),
            GNUNET_NAT_ERROR_SUCCESS);
  /* Note: oddly enough, deletion uses the external port whereas
   * addition uses the internal port; this rarely matters since they
   * often are the same, but it might... */
  GNUNET_snprintf (pstr,
                   sizeof(pstr),
                   "%u",
                   (unsigned int) ntohs (mini->current_addr.sin_port));
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Unmapping port %u with UPnP\n",
       ntohs (mini->current_addr.sin_port));
  mini->unmap_cmd = GNUNET_OS_command_run (&process_unmap_output,
                                           mini,
                                           UNMAP_TIMEOUT,
                                           "upnpc",
                                           "upnpc",
                                           "-d",
                                           pstr,
                                           mini->is_tcp ? "tcp" : "udp",
                                           NULL);
}

Referenced by client_disconnect_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ LOG

◆ MAP_TIMEOUT

◆ UNMAP_TIMEOUT

◆ MAP_REFRESH_FREQ

Function Documentation

◆ read_external_ipv4()

◆ signal_external_ip_error()

◆ GNUNET_NAT_mini_get_external_ipv4_()

◆ GNUNET_NAT_mini_get_external_ipv4_cancel_()

◆ do_refresh()

◆ process_map_output()

◆ run_upnpc_r()

◆ process_refresh_output()

◆ GNUNET_NAT_mini_map_start()

◆ process_unmap_output()

◆ GNUNET_NAT_mini_map_stop()