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 48 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, 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;
127  eh->r,
129  eh);
130  return;
131  }
133  if ((eh->off > 7) && (eh->buf[eh->off - 1] == '\n'))
134  {
135  eh->buf[eh->off - 1] = '\0';
136  if (1 == inet_pton(AF_INET, eh->buf, &addr))
137  {
138  if (0 == addr.s_addr)
139  eh->ret =
141  else
143  }
144  }
145  eh->cb(eh->cb_cls,
146  (GNUNET_NAT_ERROR_SUCCESS == eh->ret) ? &addr : NULL,
147  eh->ret);
149 }
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:729
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:1615
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.
"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 158 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_().

159 {
160  struct GNUNET_NAT_ExternalHandle *eh = cls;
161 
162  eh->task = NULL;
163  eh->cb(eh->cb_cls, NULL, eh->ret);
164  GNUNET_free(eh);
165 }
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 176 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().

177 {
178  struct GNUNET_NAT_ExternalHandle *eh;
179 
181  eh->cb = cb;
182  eh->cb_cls = cb_cls;
184  if (GNUNET_SYSERR ==
185  GNUNET_OS_check_helper_binary("external-ip", GNUNET_NO, NULL))
186  {
187  LOG(GNUNET_ERROR_TYPE_INFO, _("`external-ip' command not found\n"));
190  return eh;
191  }
193  "Running `external-ip' to determine our external IP\n");
195  if (NULL == eh->opipe)
196  {
199  return eh;
200  }
202  0,
203  NULL,
204  eh->opipe,
205  NULL,
206  "external-ip",
207  "external-ip",
208  NULL);
209  if (NULL == eh->eip)
210  {
214  return eh;
215  }
219  eh->r,
221  eh);
222  return eh;
223 }
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:687
#define LOG(kind,...)
struct GNUNET_OS_Process * eip
Handle to external-ip process.
#define GNUNET_NO
Definition: gnunet_common.h:78
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:1615
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:1744
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
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:1264
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:1518
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
`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:1706
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:1635
struct GNUNET_DISK_PipeHandle * opipe
Handle to stdout pipe of external-ip.
#define GNUNET_YES
Definition: gnunet_common.h:77
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 232 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().

233 {
234  if (NULL != eh->eip)
235  {
236  (void)GNUNET_OS_process_kill(eh->eip, SIGKILL);
239  }
240  if (NULL != eh->opipe)
241  {
243  eh->opipe = NULL;
244  }
245  if (NULL != eh->task)
246  {
248  eh->task = NULL;
249  }
250  GNUNET_free(eh);
251 }
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:286
struct GNUNET_OS_Process * eip
Handle to external-ip process.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
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:1706
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:1000
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:224
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
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 480 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().

481 {
482  struct GNUNET_NAT_MiniHandle *mini = cls;
483  int ac;
484 
485  mini->refresh_task =
488  "Running `upnpc' to check if our mapping still exists\n");
489  mini->found = GNUNET_NO;
490  ac = GNUNET_NO;
491  if (NULL != mini->map_cmd)
492  {
493  /* took way too long, abort it! */
495  mini->map_cmd = NULL;
496  ac = GNUNET_YES;
497  }
498  if (NULL != mini->refresh_cmd)
499  {
500  /* took way too long, abort it! */
502  mini->refresh_cmd = NULL;
503  ac = GNUNET_YES;
504  }
506  mini,
507  MAP_TIMEOUT,
508  "upnpc",
509  "upnpc",
510  "-l",
511  NULL);
512  if (GNUNET_YES == ac)
513  mini->ac(mini->ac_cls,
515  NULL,
516  0,
518 }
#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:78
#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:1237
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:76
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:1160
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:1075
#define GNUNET_YES
Definition: gnunet_common.h:77
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 528 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, GNUNET_NAT_MiniHandle::map_cmd, MAP_REFRESH_FREQ, port, and GNUNET_NAT_MiniHandle::refresh_task.

Referenced by run_upnpc_r().

529 {
530  struct GNUNET_NAT_MiniHandle *mini = cls;
531  const char *ipaddr;
532  char *ipa;
533  const char *pstr;
534  unsigned int port;
535 
536  if (NULL == line)
537  {
539  mini->map_cmd = NULL;
540  if (GNUNET_YES != mini->did_map)
541  mini->ac(mini->ac_cls,
543  NULL,
544  0,
546  if (NULL == mini->refresh_task)
547  mini->refresh_task =
549  return;
550  }
551  /*
552  * The upnpc output we're after looks like this:
553  *
554  * "external 87.123.42.204:3000 TCP is redirected to internal 192.168.2.150:3000"
555  */
556  if ((NULL == (ipaddr = strstr(line, " "))) ||
557  (NULL == (pstr = strstr(ipaddr, ":"))) ||
558  (1 != sscanf(pstr + 1, "%u", &port)))
559  {
560  return; /* skip line */
561  }
562  ipa = GNUNET_strdup(ipaddr + 1);
563  strstr(ipa, ":")[0] = '\0';
564  if (1 != inet_pton(AF_INET, ipa, &mini->current_addr.sin_addr))
565  {
566  GNUNET_free(ipa);
567  return; /* skip line */
568  }
569  GNUNET_free(ipa);
570 
571  mini->current_addr.sin_port = htons(port);
572  mini->current_addr.sin_family = AF_INET;
573 #if HAVE_SOCKADDR_IN_SIN_LEN
574  mini->current_addr.sin_len = sizeof(struct sockaddr_in);
575 #endif
576  mini->did_map = GNUNET_YES;
577  mini->ac(mini->ac_cls,
578  GNUNET_YES,
579  (const struct sockaddr *)&mini->current_addr,
580  sizeof(mini->current_addr),
582 }
#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:1237
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:76
static uint16_t port
Port number.
Definition: gnunet-bcd.c:81
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:1075
#define GNUNET_YES
Definition: gnunet_common.h:77
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 344 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().

345 {
346  char pstr[6];
347 
348  GNUNET_snprintf(pstr, sizeof(pstr), "%u", (unsigned int)mini->port);
350  mini,
351  MAP_TIMEOUT,
352  "upnpc",
353  "upnpc",
354  "-r",
355  pstr,
356  mini->is_tcp ? "tcp" : "udp",
357  NULL);
358  if (NULL == mini->map_cmd)
359  {
360  mini->ac(mini->ac_cls,
362  NULL,
363  0,
365  return;
366  }
367 }
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:76
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:1160
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 378 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, GNUNET_NAT_MiniHandle::is_tcp, GNUNET_NAT_MiniHandle::port, GNUNET_NAT_MiniHandle::refresh_cmd, and run_upnpc_r().

Referenced by do_refresh().

379 {
380  struct GNUNET_NAT_MiniHandle *mini = cls;
381  char pstr[9];
382  const char *s;
383  unsigned int nport;
384  struct in_addr exip;
385 
386  if (NULL == line)
387  {
389  mini->refresh_cmd = NULL;
390  if (GNUNET_NO == mini->found)
391  {
392  /* mapping disappeared, try to re-create */
393  if (GNUNET_YES == mini->did_map)
394  {
395  mini->ac(mini->ac_cls,
396  GNUNET_NO,
397  (const struct sockaddr *)&mini->current_addr,
398  sizeof(mini->current_addr),
400  mini->did_map = GNUNET_NO;
401  }
402  run_upnpc_r(mini);
403  }
404  return;
405  }
406  if (!mini->did_map)
407  return; /* never mapped, won't find our mapping anyway */
408 
409  /* we're looking for output of the form:
410  * "ExternalIPAddress = 12.134.41.124" */
411 
412  s = strstr(line, "ExternalIPAddress = ");
413  if (NULL != s)
414  {
415  s += strlen("ExternalIPAddress = ");
416  if (1 != inet_pton(AF_INET, s, &exip))
417  return; /* skip */
418  if (exip.s_addr == mini->current_addr.sin_addr.s_addr)
419  return; /* no change */
420  /* update mapping */
421  mini->ac(mini->ac_cls,
422  GNUNET_NO,
423  (const struct sockaddr *)&mini->current_addr,
424  sizeof(mini->current_addr),
426  mini->current_addr.sin_addr = exip;
427  mini->ac(mini->ac_cls,
428  GNUNET_YES,
429  (const struct sockaddr *)&mini->current_addr,
430  sizeof(mini->current_addr),
432  return;
433  }
434  /*
435  * we're looking for output of the form:
436  *
437  * "0 TCP 3000->192.168.2.150:3000 'libminiupnpc' ''"
438  * "1 UDP 3001->192.168.2.150:3001 'libminiupnpc' ''"
439  *
440  * the pattern we look for is:
441  *
442  * "%s TCP PORT->STRING:OURPORT *" or
443  * "%s UDP PORT->STRING:OURPORT *"
444  */
445  GNUNET_snprintf(pstr, sizeof(pstr), ":%u ", mini->port);
446  if (NULL == (s = strstr(line, "->")))
447  return; /* skip */
448  if (NULL == strstr(s, pstr))
449  return; /* skip */
450  if (1 != sscanf(line,
451  (mini->is_tcp) ? "%*u TCP %u->%*s:%*u %*s"
452  : "%*u UDP %u->%*s:%*u %*s",
453  &nport))
454  return; /* skip */
455  mini->found = GNUNET_YES;
456  if (nport == ntohs(mini->current_addr.sin_port))
457  return; /* no change */
458 
459  /* external port changed, update mapping */
460  mini->ac(mini->ac_cls,
461  GNUNET_NO,
462  (const struct sockaddr *)&mini->current_addr,
463  sizeof(mini->current_addr),
465  mini->current_addr.sin_port = htons((uint16_t)nport);
466  mini->ac(mini->ac_cls,
467  GNUNET_YES,
468  (const struct sockaddr *)&mini->current_addr,
469  sizeof(mini->current_addr),
471 }
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:78
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?
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:1075
#define GNUNET_YES
Definition: gnunet_common.h:77
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 599 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().

603 {
604  struct GNUNET_NAT_MiniHandle *ret;
605 
607  {
608  LOG(GNUNET_ERROR_TYPE_INFO, _("`upnpc' command not found\n"));
610  return NULL;
611  }
612  LOG(GNUNET_ERROR_TYPE_DEBUG, "Running `upnpc' to install mapping\n");
613  ret = GNUNET_new(struct GNUNET_NAT_MiniHandle);
614  ret->ac = ac;
615  ret->ac_cls = ac_cls;
616  ret->is_tcp = is_tcp;
617  ret->port = port;
618  ret->refresh_task =
620  run_upnpc_r(ret);
621  return ret;
622 }
#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:78
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:181
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:1237
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:76
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:81
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 632 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().

633 {
634  struct GNUNET_NAT_MiniHandle *mini = cls;
635 
636  if (NULL == line)
637  {
638  LOG(GNUNET_ERROR_TYPE_DEBUG, "UPnP unmap done\n");
640  mini->unmap_cmd = NULL;
641  GNUNET_free(mini);
642  return;
643  }
644  /* we don't really care about the output... */
645 }
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:1075
#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 657 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().

658 {
659  char pstr[6];
660 
661  if (NULL != mini->refresh_task)
662  {
664  mini->refresh_task = NULL;
665  }
666  if (NULL != mini->refresh_cmd)
667  {
669  mini->refresh_cmd = NULL;
670  }
671  if (NULL != mini->map_cmd)
672  {
674  mini->map_cmd = NULL;
675  }
676  if (GNUNET_NO == mini->did_map)
677  {
678  GNUNET_free(mini);
679  return;
680  }
681  mini->ac(mini->ac_cls,
682  GNUNET_NO,
683  (const struct sockaddr *)&mini->current_addr,
684  sizeof(mini->current_addr),
686  /* Note: oddly enough, deletion uses the external port whereas
687  * addition uses the internal port; this rarely matters since they
688  * often are the same, but it might... */
689  GNUNET_snprintf(pstr,
690  sizeof(pstr),
691  "%u",
692  (unsigned int)ntohs(mini->current_addr.sin_port));
694  "Unmapping port %u with UPnP\n",
695  ntohs(mini->current_addr.sin_port));
697  mini,
699  "upnpc",
700  "upnpc",
701  "-d",
702  pstr,
703  mini->is_tcp ? "tcp" : "udp",
704  NULL);
705 }
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:78
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:1160
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:1075
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:956
Here is the call graph for this function:
Here is the caller graph for this function: