GNUnet  0.10.x
Data Structures | Macros | Functions
gnunet-service-nat_mini.c File Reference

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:

Go to the source code of this file.

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_ExternalHandleGNUNET_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_MiniHandleGNUNET_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__)

◆ MAP_TIMEOUT

How long do we give upnpc to create a mapping?

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

Referenced by do_refresh(), and run_upnpc_r().

◆ UNMAP_TIMEOUT

How long do we give upnpc to remove a mapping?

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

Referenced by GNUNET_NAT_mini_map_stop().

◆ 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 47 of file gnunet-service-nat_mini.c.

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

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
clsthe struct GNUNET_NAT_ExternalHandle

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

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, inet_pton(), GNUNET_NAT_ExternalHandle::off, GNUNET_NAT_ExternalHandle::r, GNUNET_NAT_ExternalHandle::ret, and GNUNET_NAT_ExternalHandle::task.

Referenced by GNUNET_NAT_mini_get_external_ipv4_().

113 {
114  struct GNUNET_NAT_ExternalHandle *eh = cls;
115  ssize_t ret;
116  struct in_addr addr;
117 
118  eh->task = NULL;
119  ret = GNUNET_DISK_file_read (eh->r,
120  &eh->buf[eh->off],
121  sizeof (eh->buf) - eh->off);
122  if (ret > 0)
123  {
124  /* try to read more */
125  eh->off += ret;
126  eh->task
128  eh->r,
130  eh);
131  return;
132  }
134  if ( (eh->off > 7) &&
135  (eh->buf[eh->off - 1] == '\n') )
136  {
137  eh->buf[eh->off - 1] = '\0';
138  if (1 == inet_pton (AF_INET,
139  eh->buf,
140  &addr))
141  {
142  if (0 == addr.s_addr)
143  eh->ret = GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID; /* got 0.0.0.0 */
144  else
146  }
147  }
148  eh->cb (eh->cb_cls,
149  (GNUNET_NAT_ERROR_SUCCESS == eh->ret) ? &addr : NULL,
150  eh->ret);
152 }
Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
ssize_t GNUNET_DISK_file_read(const struct GNUNET_DISK_FileHandle *h, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:881
enum GNUNET_NAT_StatusCode ret
Error code for better debugging and user feedback.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_file(struct GNUNET_TIME_Relative delay, const struct GNUNET_DISK_FileHandle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1643
struct GNUNET_SCHEDULER_Task * task
Read task.
static int ret
Final status code.
Definition: gnunet-arm.c:89
GNUNET_NAT_IPCallback cb
Function to call with the result.
`external-ip' command output invalid
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
size_t off
Number of bytes in buf that are valid.
static void read_external_ipv4(void *cls)
Read the output of external-ip into buf.
const struct GNUNET_DISK_FileHandle * r
Read handle of opipe.
static int inet_pton(int af, const char *cp, struct in_addr *buf)
Convert IPv4 address from text to binary form.
"no valid address was returned by `external-ip'"
char buf[17]
Destination of our read operation (output of 'external-ip').
void GNUNET_NAT_mini_get_external_ipv4_cancel_(struct GNUNET_NAT_ExternalHandle *eh)
Cancel operation.
void * cb_cls
Closure for cb.
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
clsthe struct GNUNET_NAT_ExternalHandle (freed)

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

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_().

162 {
163  struct GNUNET_NAT_ExternalHandle *eh = cls;
164 
165  eh->task = NULL;
166  eh->cb (eh->cb_cls,
167  NULL,
168  eh->ret);
169  GNUNET_free (eh);
170 }
Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
enum GNUNET_NAT_StatusCode ret
Error code for better debugging and user feedback.
struct GNUNET_SCHEDULER_Task * task
Read task.
GNUNET_NAT_IPCallback cb
Function to call with the result.
void * cb_cls
Closure for cb.
#define GNUNET_free(ptr)
Wrapper around free.
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
cbfunction to call with result
cb_clsclosure for cb
Returns
handle for cancellation (can only be used until cb is called), never NULL

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

References _, GNUNET_NAT_ExternalHandle::cb, GNUNET_NAT_ExternalHandle::cb_cls, GNUNET_NAT_ExternalHandle::eip, 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_start_process(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_add_read_file(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, 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().

183 {
184  struct GNUNET_NAT_ExternalHandle *eh;
185 
187  eh->cb = cb;
188  eh->cb_cls = cb_cls;
190  if (GNUNET_SYSERR ==
191  GNUNET_OS_check_helper_binary ("external-ip",
192  GNUNET_NO,
193  NULL))
194  {
196  _("`external-ip' command not found\n"));
199  eh);
200  return eh;
201  }
203  "Running `external-ip' to determine our external IP\n");
205  GNUNET_YES,
206  GNUNET_NO,
207  GNUNET_YES);
208  if (NULL == eh->opipe)
209  {
212  eh);
213  return eh;
214  }
215  eh->eip =
217  0,
218  NULL,
219  eh->opipe,
220  NULL,
221  "external-ip",
222  "external-ip",
223  NULL);
224  if (NULL == eh->eip)
225  {
229  eh);
230  return eh;
231  }
234  eh->r = GNUNET_DISK_pipe_handle (eh->opipe,
236  eh->task
238  eh->r,
240  eh);
241  return eh;
242 }
Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
enum GNUNET_NAT_StatusCode ret
Error code for better debugging and user feedback.
struct GNUNET_OS_Process * GNUNET_OS_start_process(int pipe_control, enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, struct GNUNET_DISK_PipeHandle *pipe_stdout, struct GNUNET_DISK_PipeHandle *pipe_stderr, const char *filename,...)
Start a process.
Definition: os_priority.c:1400
#define LOG(kind,...)
struct GNUNET_OS_Process * eip
Handle to external-ip process.
#define GNUNET_NO
Definition: gnunet_common.h:81
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_file(struct GNUNET_TIME_Relative delay, const struct GNUNET_DISK_FileHandle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1643
int GNUNET_OS_check_helper_binary(const char *binary, int check_suid, const char *params)
Check whether an executable exists and possibly if the suid bit is set on the file.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_SCHEDULER_Task * task
Read task.
GNUNET_NAT_IPCallback cb
Function to call with the result.
const struct GNUNET_DISK_FileHandle * GNUNET_DISK_pipe_handle(const struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd n)
Get the handle to a particular pipe end.
Definition: disk.c:2641
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1273
static void signal_external_ip_error(void *cls)
(Asynchronously) signal error invoking external-ip to client.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
The writing-end of a pipe.
The reading-end of a pipe.
struct GNUNET_DISK_PipeHandle * GNUNET_DISK_pipe(int blocking_read, int blocking_write, int inherit_read, int inherit_write)
Creates an interprocess channel.
Definition: disk.c:2289
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
`external-ip' command not found
static void read_external_ipv4(void *cls)
Read the output of external-ip into buf.
const struct GNUNET_DISK_FileHandle * r
Read handle of opipe.
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:2603
int GNUNET_DISK_pipe_close_end(struct GNUNET_DISK_PipeHandle *p, enum GNUNET_DISK_PipeEnd end)
Closes one half of an interprocess channel.
Definition: disk.c:2532
struct GNUNET_DISK_PipeHandle * opipe
Handle to stdout pipe of external-ip.
#define GNUNET_YES
Definition: gnunet_common.h:80
Failed to run external-ip command.
void * cb_cls
Closure for cb.
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
ehoperation to cancel

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

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().

252 {
253  if (NULL != eh->eip)
254  {
255  (void) GNUNET_OS_process_kill (eh->eip,
256  SIGKILL);
260  }
261  if (NULL != eh->opipe)
262  {
264  eh->opipe = NULL;
265  }
266  if (NULL != eh->task)
267  {
269  eh->task = NULL;
270  }
271  GNUNET_free (eh);
272 }
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:364
struct GNUNET_OS_Process * eip
Handle to external-ip process.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
struct GNUNET_SCHEDULER_Task * task
Read task.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:2603
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:1762
struct GNUNET_DISK_PipeHandle * opipe
Handle to stdout pipe of external-ip.
#define GNUNET_free(ptr)
Wrapper around free.
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:251
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:965
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
clsthe struct GNUNET_NAT_MiniHandle
clsthe 'struct GNUNET_NAT_MiniHandle'

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

References ac, GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, 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 GNUNET_NAT_mini_map_start(), and process_map_output().

517 {
518  struct GNUNET_NAT_MiniHandle *mini = cls;
519  int ac;
520 
521  mini->refresh_task
523  &do_refresh,
524  mini);
526  "Running `upnpc' to check if our mapping still exists\n");
527  mini->found = GNUNET_NO;
528  ac = GNUNET_NO;
529  if (NULL != mini->map_cmd)
530  {
531  /* took way too long, abort it! */
533  mini->map_cmd = NULL;
534  ac = GNUNET_YES;
535  }
536  if (NULL != mini->refresh_cmd)
537  {
538  /* took way too long, abort it! */
540  mini->refresh_cmd = NULL;
541  ac = GNUNET_YES;
542  }
543  mini->refresh_cmd
545  mini,
546  MAP_TIMEOUT,
547  "upnpc",
548  "upnpc",
549  "-l",
550  NULL);
551  if (GNUNET_YES == ac)
552  mini->ac (mini->ac_cls,
554  NULL,
555  0,
557 }
#define MAP_REFRESH_FREQ
How often do we check for changes in the mapping?
struct GNUNET_OS_CommandHandle * refresh_cmd
Command used to refresh our map information.
Handle to a mapping created with upnpc.
static void do_refresh(void *cls)
Run "upnpc -l" to find out if our mapping changed.
#define LOG(kind,...)
`upnpc' command took too long, process killed
#define GNUNET_NO
Definition: gnunet_common.h:81
#define MAP_TIMEOUT
How long do we give upnpc to create a mapping?
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1246
struct GNUNET_SCHEDULER_Task * refresh_task
We check the mapping periodically to see if it still works.
void * ac_cls
Closure for ac.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
static struct GNUNET_MQ_Envelope * ac
Handle to current GNUNET_PEERINFO_add_peer() operation.
struct GNUNET_OS_CommandHandle * GNUNET_OS_command_run(GNUNET_OS_LineProcessor proc, void *proc_cls, struct GNUNET_TIME_Relative timeout, const char *binary,...)
Run the given command line and call the given function for each line of the output.
Definition: os_priority.c:1948
static void process_refresh_output(void *cls, const char *line)
Process the output from "upnpc -l" to see if our external mapping changed.
struct GNUNET_OS_CommandHandle * map_cmd
Command used to install the map.
int found
Did we find our mapping during refresh scan?
void GNUNET_OS_command_stop(struct GNUNET_OS_CommandHandle *cmd)
Stop/kill a command.
Definition: os_priority.c:1862
#define GNUNET_YES
Definition: gnunet_common.h:80
GNUNET_NAT_MiniAddressCallback ac
Function to call on mapping changes.
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
clsthe struct GNUNET_NAT_MiniHandle
lineline of output, NULL at the end

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

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, inet_pton(), GNUNET_NAT_MiniHandle::map_cmd, MAP_REFRESH_FREQ, port, GNUNET_NAT_MiniHandle::refresh_task, and SSCANF.

Referenced by run_upnpc_r().

569 {
570  struct GNUNET_NAT_MiniHandle *mini = cls;
571  const char *ipaddr;
572  char *ipa;
573  const char *pstr;
574  unsigned int port;
575 
576  if (NULL == line)
577  {
579  mini->map_cmd = NULL;
580  if (GNUNET_YES != mini->did_map)
581  mini->ac (mini->ac_cls,
583  NULL,
584  0,
586  if (NULL == mini->refresh_task)
587  mini->refresh_task
589  &do_refresh,
590  mini);
591  return;
592  }
593  /*
594  * The upnpc output we're after looks like this:
595  *
596  * "external 87.123.42.204:3000 TCP is redirected to internal 192.168.2.150:3000"
597  */
598  if ((NULL == (ipaddr = strstr (line, " "))) ||
599  (NULL == (pstr = strstr (ipaddr, ":"))) ||
600  (1 != SSCANF (pstr + 1, "%u", &port)))
601  {
602  return; /* skip line */
603  }
604  ipa = GNUNET_strdup (ipaddr + 1);
605  strstr (ipa, ":")[0] = '\0';
606  if (1 != inet_pton (AF_INET,
607  ipa,
608  &mini->current_addr.sin_addr))
609  {
610  GNUNET_free (ipa);
611  return; /* skip line */
612  }
613  GNUNET_free (ipa);
614 
615  mini->current_addr.sin_port = htons (port);
616  mini->current_addr.sin_family = AF_INET;
617 #if HAVE_SOCKADDR_IN_SIN_LEN
618  mini->current_addr.sin_len = sizeof (struct sockaddr_in);
619 #endif
620  mini->did_map = GNUNET_YES;
621  mini->ac (mini->ac_cls,
622  GNUNET_YES,
623  (const struct sockaddr *) &mini->current_addr,
624  sizeof (mini->current_addr),
626 }
#define MAP_REFRESH_FREQ
How often do we check for changes in the mapping?
Handle to a mapping created with upnpc.
`upnpc' command failed to establish port mapping
static void do_refresh(void *cls)
Run "upnpc -l" to find out if our mapping changed.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
int did_map
Did we succeed with creating a mapping?
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1246
static char * line
Desired phone line (string to be converted to a hash).
struct GNUNET_SCHEDULER_Task * refresh_task
We check the mapping periodically to see if it still works.
void * ac_cls
Closure for ac.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
#define SSCANF
Definition: plibc.h:691
static uint16_t port
Port number.
Definition: gnunet-bcd.c:79
struct GNUNET_OS_CommandHandle * map_cmd
Command used to install the map.
static int inet_pton(int af, const char *cp, struct in_addr *buf)
Convert IPv4 address from text to binary form.
void GNUNET_OS_command_stop(struct GNUNET_OS_CommandHandle *cmd)
Stop/kill a command.
Definition: os_priority.c:1862
#define GNUNET_YES
Definition: gnunet_common.h:80
GNUNET_NAT_MiniAddressCallback ac
Function to call on mapping changes.
struct sockaddr_in current_addr
Our current external mapping (if we have one).
#define GNUNET_free(ptr)
Wrapper around free.
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
miniour handle

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

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().

370 {
371  char pstr[6];
372 
373  GNUNET_snprintf (pstr,
374  sizeof (pstr),
375  "%u",
376  (unsigned int) mini->port);
377  mini->map_cmd
379  mini,
380  MAP_TIMEOUT,
381  "upnpc",
382  "upnpc",
383  "-r",
384  pstr,
385  mini->is_tcp ? "tcp" : "udp",
386  NULL);
387  if (NULL == mini->map_cmd)
388  {
389  mini->ac (mini->ac_cls,
391  NULL,
392  0,
394  return;
395  }
396 }
int GNUNET_snprintf(char *buf, size_t size, const char *format,...)
Like snprintf, just aborts if the buffer is of insufficient size.
int is_tcp
Are we mapping TCP or UDP?
static void process_map_output(void *cls, const char *line)
Process the output from the "upnpc -r" command.
#define MAP_TIMEOUT
How long do we give upnpc to create a mapping?
void * ac_cls
Closure for ac.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
uint16_t port
Which port are we mapping?
struct GNUNET_OS_CommandHandle * GNUNET_OS_command_run(GNUNET_OS_LineProcessor proc, void *proc_cls, struct GNUNET_TIME_Relative timeout, const char *binary,...)
Run the given command line and call the given function for each line of the output.
Definition: os_priority.c:1948
struct GNUNET_OS_CommandHandle * map_cmd
Command used to install the map.
Failed to run upnpc command.
GNUNET_NAT_MiniAddressCallback ac
Function to call on mapping changes.
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
clsthe struct GNUNET_NAT_MiniHandle
lineline of output, NULL at the end

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

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, inet_pton(), GNUNET_NAT_MiniHandle::is_tcp, GNUNET_NAT_MiniHandle::port, GNUNET_NAT_MiniHandle::refresh_cmd, run_upnpc_r(), and SSCANF.

Referenced by do_refresh().

409 {
410  struct GNUNET_NAT_MiniHandle *mini = cls;
411  char pstr[9];
412  const char *s;
413  unsigned int nport;
414  struct in_addr exip;
415 
416  if (NULL == line)
417  {
419  mini->refresh_cmd = NULL;
420  if (GNUNET_NO == mini->found)
421  {
422  /* mapping disappeared, try to re-create */
423  if (GNUNET_YES == mini->did_map)
424  {
425  mini->ac (mini->ac_cls,
426  GNUNET_NO,
427  (const struct sockaddr *) &mini->current_addr,
428  sizeof (mini->current_addr),
430  mini->did_map = GNUNET_NO;
431  }
432  run_upnpc_r (mini);
433  }
434  return;
435  }
436  if (! mini->did_map)
437  return; /* never mapped, won't find our mapping anyway */
438 
439  /* we're looking for output of the form:
440  * "ExternalIPAddress = 12.134.41.124" */
441 
442  s = strstr (line,
443  "ExternalIPAddress = ");
444  if (NULL != s)
445  {
446  s += strlen ("ExternalIPAddress = ");
447  if (1 != inet_pton (AF_INET,
448  s,
449  &exip))
450  return; /* skip */
451  if (exip.s_addr == mini->current_addr.sin_addr.s_addr)
452  return; /* no change */
453  /* update mapping */
454  mini->ac (mini->ac_cls,
455  GNUNET_NO,
456  (const struct sockaddr *) &mini->current_addr,
457  sizeof (mini->current_addr),
459  mini->current_addr.sin_addr = exip;
460  mini->ac (mini->ac_cls,
461  GNUNET_YES,
462  (const struct sockaddr *) &mini->current_addr,
463  sizeof (mini->current_addr),
465  return;
466  }
467  /*
468  * we're looking for output of the form:
469  *
470  * "0 TCP 3000->192.168.2.150:3000 'libminiupnpc' ''"
471  * "1 UDP 3001->192.168.2.150:3001 'libminiupnpc' ''"
472  *
473  * the pattern we look for is:
474  *
475  * "%s TCP PORT->STRING:OURPORT *" or
476  * "%s UDP PORT->STRING:OURPORT *"
477  */
478  GNUNET_snprintf (pstr,
479  sizeof (pstr),
480  ":%u ",
481  mini->port);
482  if (NULL == (s = strstr (line, "->")))
483  return; /* skip */
484  if (NULL == strstr (s, pstr))
485  return; /* skip */
486  if (1 !=
487  SSCANF (line,
488  (mini->is_tcp) ? "%*u TCP %u->%*s:%*u %*s" :
489  "%*u UDP %u->%*s:%*u %*s", &nport))
490  return; /* skip */
491  mini->found = GNUNET_YES;
492  if (nport == ntohs (mini->current_addr.sin_port))
493  return; /* no change */
494 
495  /* external port changed, update mapping */
496  mini->ac (mini->ac_cls,
497  GNUNET_NO,
498  (const struct sockaddr *) &mini->current_addr,
499  sizeof (mini->current_addr),
501  mini->current_addr.sin_port = htons ((uint16_t) nport);
502  mini->ac (mini->ac_cls,
503  GNUNET_YES,
504  (const struct sockaddr *) &mini->current_addr,
505  sizeof (mini->current_addr),
507 }
struct GNUNET_OS_CommandHandle * refresh_cmd
Command used to refresh our map information.
Handle to a mapping created with upnpc.
int GNUNET_snprintf(char *buf, size_t size, const char *format,...)
Like snprintf, just aborts if the buffer is of insufficient size.
int is_tcp
Are we mapping TCP or UDP?
#define GNUNET_NO
Definition: gnunet_common.h:81
int did_map
Did we succeed with creating a mapping?
static char * line
Desired phone line (string to be converted to a hash).
void * ac_cls
Closure for ac.
uint16_t port
Which port are we mapping?
#define SSCANF
Definition: plibc.h:691
int found
Did we find our mapping during refresh scan?
static int inet_pton(int af, const char *cp, struct in_addr *buf)
Convert IPv4 address from text to binary form.
void GNUNET_OS_command_stop(struct GNUNET_OS_CommandHandle *cmd)
Stop/kill a command.
Definition: os_priority.c:1862
#define GNUNET_YES
Definition: gnunet_common.h:80
GNUNET_NAT_MiniAddressCallback ac
Function to call on mapping changes.
struct sockaddr_in current_addr
Our current external mapping (if we have one).
static void run_upnpc_r(struct GNUNET_NAT_MiniHandle *mini)
Run "upnpc -r" to map our internal port.
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
portport to map
is_tcpGNUNET_YES to map TCP, GNUNET_NO for UDP
acfunction to call with mapping result
ac_clsclosure for ac
Returns
NULL on error (no 'upnpc' installed)

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

References _, ac, 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, GNUNET_NAT_MiniHandle::port, GNUNET_NAT_MiniHandle::refresh_task, GNUNET_NAT_ExternalHandle::ret, and run_upnpc_r().

Referenced by handle_register().

647 {
648  struct GNUNET_NAT_MiniHandle *ret;
649 
650  if (GNUNET_SYSERR ==
652  GNUNET_NO,
653  NULL))
654  {
656  _("`upnpc' command not found\n"));
657  ac (ac_cls,
659  NULL, 0,
661  return NULL;
662  }
664  "Running `upnpc' to install mapping\n");
665  ret = GNUNET_new (struct GNUNET_NAT_MiniHandle);
666  ret->ac = ac;
667  ret->ac_cls = ac_cls;
668  ret->is_tcp = is_tcp;
669  ret->port = port;
670  ret->refresh_task =
672  &do_refresh,
673  ret);
674  run_upnpc_r (ret);
675  return ret;
676 }
#define MAP_REFRESH_FREQ
How often do we check for changes in the mapping?
Handle to a mapping created with upnpc.
static void do_refresh(void *cls)
Run "upnpc -l" to find out if our mapping changed.
#define LOG(kind,...)
int is_tcp
Are we mapping TCP or UDP?
#define GNUNET_NO
Definition: gnunet_common.h:81
int GNUNET_OS_check_helper_binary(const char *binary, int check_suid, const char *params)
Check whether an executable exists and possibly if the suid bit is set on the file.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static int ret
Final status code.
Definition: gnunet-arm.c:89
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1246
struct GNUNET_SCHEDULER_Task * refresh_task
We check the mapping periodically to see if it still works.
void * ac_cls
Closure for ac.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
uint16_t port
Which port are we mapping?
static struct GNUNET_MQ_Envelope * ac
Handle to current GNUNET_PEERINFO_add_peer() operation.
static uint16_t port
Port number.
Definition: gnunet-bcd.c:79
GNUNET_NAT_MiniAddressCallback ac
Function to call on mapping changes.
static void run_upnpc_r(struct GNUNET_NAT_MiniHandle *mini)
Run "upnpc -r" to map our internal port.
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
clsthe struct GNUNET_NAT_MiniHandle
lineline of output, NULL at the end

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

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

Referenced by GNUNET_NAT_mini_map_stop().

688 {
689  struct GNUNET_NAT_MiniHandle *mini = cls;
690 
691  if (NULL == line)
692  {
694  "UPnP unmap done\n");
696  mini->unmap_cmd = NULL;
697  GNUNET_free (mini);
698  return;
699  }
700  /* we don't really care about the output... */
701 }
Handle to a mapping created with upnpc.
#define LOG(kind,...)
struct GNUNET_OS_CommandHandle * unmap_cmd
Command used to remove the mapping.
static char * line
Desired phone line (string to be converted to a hash).
void GNUNET_OS_command_stop(struct GNUNET_OS_CommandHandle *cmd)
Stop/kill a command.
Definition: os_priority.c:1862
#define GNUNET_free(ptr)
Wrapper around free.
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 tha mapping, so while this function is non-blocking, a task will be left with the scheduler for up to 1s past this call.

Parameters
minithe handle

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

References GNUNET_NAT_MiniHandle::ac, GNUNET_NAT_MiniHandle::ac_cls, GNUNET_NAT_MiniHandle::current_addr, GNUNET_NAT_MiniHandle::did_map, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_NAT_ERROR_SUCCESS, GNUNET_NO, GNUNET_OS_command_run(), GNUNET_OS_command_stop(), GNUNET_SCHEDULER_cancel(), GNUNET_snprintf(), GNUNET_NAT_MiniHandle::is_tcp, LOG, GNUNET_NAT_MiniHandle::map_cmd, process_unmap_output(), GNUNET_NAT_MiniHandle::refresh_cmd, GNUNET_NAT_MiniHandle::refresh_task, GNUNET_NAT_MiniHandle::unmap_cmd, and UNMAP_TIMEOUT.

Referenced by client_disconnect_cb().

714 {
715  char pstr[6];
716 
717  if (NULL != mini->refresh_task)
718  {
720  mini->refresh_task = NULL;
721  }
722  if (NULL != mini->refresh_cmd)
723  {
725  mini->refresh_cmd = NULL;
726  }
727  if (NULL != mini->map_cmd)
728  {
730  mini->map_cmd = NULL;
731  }
732  if (GNUNET_NO == mini->did_map)
733  {
734  GNUNET_free (mini);
735  return;
736  }
737  mini->ac (mini->ac_cls,
738  GNUNET_NO,
739  (const struct sockaddr *) &mini->current_addr,
740  sizeof (mini->current_addr),
742  /* Note: oddly enough, deletion uses the external port whereas
743  * addition uses the internal port; this rarely matters since they
744  * often are the same, but it might... */
745  GNUNET_snprintf (pstr,
746  sizeof (pstr),
747  "%u",
748  (unsigned int) ntohs (mini->current_addr.sin_port));
750  "Unmapping port %u with UPnP\n",
751  ntohs (mini->current_addr.sin_port));
752  mini->unmap_cmd
754  mini,
756  "upnpc",
757  "upnpc",
758  "-d",
759  pstr,
760  mini->is_tcp ? "tcp" : "udp",
761  NULL);
762 }
static void process_unmap_output(void *cls, const char *line)
Process output from our 'unmap' command.
struct GNUNET_OS_CommandHandle * refresh_cmd
Command used to refresh our map information.
int GNUNET_snprintf(char *buf, size_t size, const char *format,...)
Like snprintf, just aborts if the buffer is of insufficient size.
#define LOG(kind,...)
int is_tcp
Are we mapping TCP or UDP?
#define GNUNET_NO
Definition: gnunet_common.h:81
struct GNUNET_OS_CommandHandle * unmap_cmd
Command used to remove the mapping.
int did_map
Did we succeed with creating a mapping?
struct GNUNET_SCHEDULER_Task * refresh_task
We check the mapping periodically to see if it still works.
void * ac_cls
Closure for ac.
struct GNUNET_OS_CommandHandle * GNUNET_OS_command_run(GNUNET_OS_LineProcessor proc, void *proc_cls, struct GNUNET_TIME_Relative timeout, const char *binary,...)
Run the given command line and call the given function for each line of the output.
Definition: os_priority.c:1948
struct GNUNET_OS_CommandHandle * map_cmd
Command used to install the map.
void GNUNET_OS_command_stop(struct GNUNET_OS_CommandHandle *cmd)
Stop/kill a command.
Definition: os_priority.c:1862
GNUNET_NAT_MiniAddressCallback ac
Function to call on mapping changes.
struct sockaddr_in current_addr
Our current external mapping (if we have one).
#define GNUNET_free(ptr)
Wrapper around free.
#define UNMAP_TIMEOUT
How long do we give upnpc to remove a mapping?
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:965
Here is the call graph for this function:
Here is the caller graph for this function: