GNUnet  0.11.x
Data Structures | Functions
gnunet-service-nat_helper.c File Reference

runs the gnunet-helper-nat-server More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet-service-nat_helper.h"
Include dependency graph for gnunet-service-nat_helper.c:

Go to the source code of this file.

Data Structures

struct  HelperContext
 Information we keep per NAT helper process. More...
 

Functions

static void restart_nat_server (void *cls)
 Task that restarts the gnunet-helper-nat-server process after a crash after a certain delay. More...
 
static void try_again (struct HelperContext *h)
 Try again starting the helper later. More...
 
static void nat_server_read (void *cls)
 We have been notified that gnunet-helper-nat-server has written something to stdout. More...
 
struct HelperContextGN_start_gnunet_nat_server_ (const struct in_addr *internal_address, GN_ReversalCallback cb, void *cb_cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Start the gnunet-helper-nat-server and process incoming requests. More...
 
void GN_stop_gnunet_nat_server_ (struct HelperContext *h)
 Start the gnunet-helper-nat-server and process incoming requests. More...
 
int GN_request_connection_reversal (const struct in_addr *internal_address, uint16_t internal_port, const struct in_addr *remote_v4, const struct GNUNET_CONFIGURATION_Handle *cfg)
 We want to connect to a peer that is behind NAT. More...
 

Detailed Description

runs the gnunet-helper-nat-server

Author
Milan Bouchet-Valat
Christian Grothoff

Definition in file gnunet-service-nat_helper.c.

Function Documentation

◆ restart_nat_server()

static void restart_nat_server ( void *  cls)
static

Task that restarts the gnunet-helper-nat-server process after a crash after a certain delay.

Parameters
clsa struct HelperContext

Definition at line 205 of file gnunet-service-nat_helper.c.

References _, HelperContext::cfg, GNUNET_assert, 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_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_strerror, GNUNET_NO, GNUNET_OS_check_helper_binary(), GNUNET_OS_get_suid_binary_path(), GNUNET_OS_start_process(), GNUNET_SCHEDULER_add_read_file(), GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, h, HelperContext::internal_address, nat_server_read(), HelperContext::server_proc, HelperContext::server_read_task, HelperContext::server_retry_delay, HelperContext::server_stdout, HelperContext::server_stdout_handle, and try_again().

Referenced by GN_start_gnunet_nat_server_(), and try_again().

206 {
207  struct HelperContext *h = cls;
208  char *binary;
209  char ia[INET_ADDRSTRLEN];
210 
211  h->server_read_task = NULL;
212  GNUNET_assert (NULL !=
213  inet_ntop (AF_INET, &h->internal_address, ia, sizeof(ia)));
214  /* Start the server process */
215  binary = GNUNET_OS_get_suid_binary_path (h->cfg, "gnunet-helper-nat-server");
217  {
218  /* move instantly to max delay, as this is unlikely to be fixed */
220  GNUNET_free (binary);
221  try_again (h);
222  return;
223  }
224  h->server_stdout =
226  if (NULL == h->server_stdout)
227  {
229  GNUNET_free (binary);
230  try_again (h);
231  return;
232  }
234  "Starting `%s' at `%s'\n",
235  "gnunet-helper-nat-server",
236  ia);
238  0,
239  NULL,
240  h->server_stdout,
241  NULL,
242  binary,
243  "gnunet-helper-nat-server",
244  ia,
245  NULL);
246  GNUNET_free (binary);
247  if (NULL == h->server_proc)
248  {
250  _ ("Failed to start %s\n"),
251  "gnunet-helper-nat-server");
253  h->server_stdout = NULL;
254  try_again (h);
255  return;
256  }
257  /* Close the write end of the read pipe */
261  h->server_read_task =
265  h);
266 }
struct GNUNET_OS_Process * server_proc
The process id of the server process (if behind NAT)
static void try_again(struct HelperContext *h)
Try again starting the helper later.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
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 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:1636
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.
struct GNUNET_TIME_Relative server_retry_delay
How long do we wait for restarting a crashed gnunet-helper-nat-server?
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:1753
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
struct GNUNET_SCHEDULER_Task * server_read_task
ID of select gnunet-helper-nat-server stdout read task.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
#define GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD
Threshold after which exponential backoff should not increase (15 m).
char * GNUNET_OS_get_suid_binary_path(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *progname)
Given the name of a helper, service or daemon binary construct the full path to the binary using the ...
#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:1526
struct GNUNET_DISK_PipeHandle * server_stdout
stdout pipe handle for the gnunet-helper-nat-server process
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1715
struct in_addr internal_address
IP address we pass to the NAT helper.
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:1643
static void nat_server_read(void *cls)
We have been notified that gnunet-helper-nat-server has written something to stdout.
#define GNUNET_log(kind,...)
#define GNUNET_YES
Definition: gnunet_common.h:77
const struct GNUNET_DISK_FileHandle * server_stdout_handle
stdout file handle (for reading) for the gnunet-helper-nat-server process
Information we keep per NAT helper process.
const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to the GNUnet configuration.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ try_again()

static void try_again ( struct HelperContext h)
static

Try again starting the helper later.

Parameters
hcontext of the helper

Definition at line 100 of file gnunet-service-nat_helper.c.

References GNUNET_assert, GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, restart_nat_server(), HelperContext::server_read_task, and HelperContext::server_retry_delay.

Referenced by nat_server_read(), and restart_nat_server().

101 {
102  GNUNET_assert (NULL == h->server_read_task);
106  h);
107 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_TIME_Relative server_retry_delay
How long do we wait for restarting a crashed gnunet-helper-nat-server?
struct GNUNET_SCHEDULER_Task * server_read_task
ID of select gnunet-helper-nat-server stdout read task.
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:1253
static void restart_nat_server(void *cls)
Task that restarts the gnunet-helper-nat-server process after a crash after a certain delay...
#define GNUNET_TIME_STD_BACKOFF(r)
Perform our standard exponential back-off calculation, starting at 1 ms and then going by a factor of...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ nat_server_read()

static void nat_server_read ( void *  cls)
static

We have been notified that gnunet-helper-nat-server has written something to stdout.

Handle the output, then reschedule this function to be called again once more is available.

Parameters
clsthe struct HelperContext

Definition at line 118 of file gnunet-service-nat_helper.c.

References _, HelperContext::cb, HelperContext::cb_cls, GNUNET_DISK_file_read(), GNUNET_DISK_pipe_close(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_log_from_strerror, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_SCHEDULER_add_read_file(), GNUNET_TERM_SIG, GNUNET_TIME_UNIT_FOREVER_REL, h, port, HelperContext::server_proc, HelperContext::server_read_task, HelperContext::server_stdout, HelperContext::server_stdout_handle, and try_again().

Referenced by restart_nat_server().

119 {
120  struct HelperContext *h = cls;
121  char mybuf[40];
122  ssize_t bytes;
123  int port;
124  const char *port_start;
125  struct sockaddr_in sin_addr;
126 
127  h->server_read_task = NULL;
128  memset (mybuf, 0, sizeof(mybuf));
129  bytes =
130  GNUNET_DISK_file_read (h->server_stdout_handle, mybuf, sizeof(mybuf));
131  if (bytes < 1)
132  {
134  "Finished reading from server stdout with code: %d\n",
135  (int) bytes);
140  h->server_proc = NULL;
142  h->server_stdout = NULL;
143  h->server_stdout_handle = NULL;
144  try_again (h);
145  return;
146  }
147 
148  port_start = NULL;
149  for (size_t i = 0; i < sizeof(mybuf); i++)
150  {
151  if (mybuf[i] == '\n')
152  {
153  mybuf[i] = '\0';
154  break;
155  }
156  if ((mybuf[i] == ':') && (i + 1 < sizeof(mybuf)))
157  {
158  mybuf[i] = '\0';
159  port_start = &mybuf[i + 1];
160  }
161  }
162 
163  /* construct socket address of sender */
164  memset (&sin_addr, 0, sizeof(sin_addr));
165  sin_addr.sin_family = AF_INET;
166 #if HAVE_SOCKADDR_IN_SIN_LEN
167  sin_addr.sin_len = sizeof(sin_addr);
168 #endif
169  if ((NULL == port_start) || (1 != sscanf (port_start, "%d", &port)) ||
170  (-1 == inet_pton (AF_INET, mybuf, &sin_addr.sin_addr)))
171  {
172  /* should we restart gnunet-helper-nat-server? */
174  _ (
175  "gnunet-helper-nat-server generated malformed address `%s'\n"),
176  mybuf);
177  h->server_read_task =
181  h);
182  return;
183  }
184  sin_addr.sin_port = htons ((uint16_t) port);
186  "gnunet-helper-nat-server read: %s:%d\n",
187  mybuf,
188  port);
189  h->cb (h->cb_cls, &sin_addr);
190  h->server_read_task =
194  h);
195 }
struct GNUNET_OS_Process * server_proc
The process id of the server process (if behind NAT)
GN_ReversalCallback cb
Function to call if we receive a reversal request.
static void try_again(struct HelperContext *h)
Try again starting the helper later.
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
#define GNUNET_log_from_strerror(level, component, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
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:732
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:1636
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
struct GNUNET_SCHEDULER_Task * server_read_task
ID of select gnunet-helper-nat-server stdout read task.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
struct GNUNET_DISK_PipeHandle * server_stdout
stdout pipe handle for the gnunet-helper-nat-server process
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1715
static void nat_server_read(void *cls)
We have been notified that gnunet-helper-nat-server has written something to stdout.
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:1000
static uint16_t port
Port number.
Definition: gnunet-bcd.c:81
void * cb_cls
Closure for cb.
#define GNUNET_log(kind,...)
const struct GNUNET_DISK_FileHandle * server_stdout_handle
stdout file handle (for reading) for the gnunet-helper-nat-server process
#define GNUNET_TERM_SIG
The termination signal.
Definition: platform.h:242
Information we keep per NAT helper process.
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:225
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GN_start_gnunet_nat_server_()

struct HelperContext* GN_start_gnunet_nat_server_ ( const struct in_addr *  internal_address,
GN_ReversalCallback  cb,
void *  cb_cls,
const struct GNUNET_CONFIGURATION_Handle cfg 
)

Start the gnunet-helper-nat-server and process incoming requests.

Parameters
internal_address
cbfunction to call if we receive a request
cb_clsclosure for cb
cfgHandle to the GNUnet configuration
Returns
NULL on error

Definition at line 280 of file gnunet-service-nat_helper.c.

References HelperContext::cb, HelperContext::cb_cls, HelperContext::cfg, GN_stop_gnunet_nat_server_(), GNUNET_new, h, HelperContext::internal_address, restart_nat_server(), and HelperContext::server_stdout.

Referenced by run_scan().

284 {
285  struct HelperContext *h;
286 
287  h = GNUNET_new (struct HelperContext);
288  h->cb = cb;
289  h->cb_cls = cb_cls;
291  h->cfg = cfg;
292  restart_nat_server (h);
293  if (NULL == h->server_stdout)
294  {
296  return NULL;
297  }
298  return h;
299 }
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
GN_ReversalCallback cb
Function to call if we receive a reversal request.
void GN_stop_gnunet_nat_server_(struct HelperContext *h)
Start the gnunet-helper-nat-server and process incoming requests.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
struct GNUNET_DISK_PipeHandle * server_stdout
stdout pipe handle for the gnunet-helper-nat-server process
static void restart_nat_server(void *cls)
Task that restarts the gnunet-helper-nat-server process after a crash after a certain delay...
struct in_addr internal_address
IP address we pass to the NAT helper.
void * cb_cls
Closure for cb.
Information we keep per NAT helper process.
const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to the GNUnet configuration.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GN_stop_gnunet_nat_server_()

void GN_stop_gnunet_nat_server_ ( struct HelperContext h)

Start the gnunet-helper-nat-server and process incoming requests.

Parameters
hhelper context to stop

Definition at line 309 of file gnunet-service-nat_helper.c.

References GNUNET_DISK_pipe_close(), GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log_strerror, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_SCHEDULER_cancel(), GNUNET_TERM_SIG, HelperContext::server_proc, HelperContext::server_read_task, HelperContext::server_stdout, and HelperContext::server_stdout_handle.

Referenced by free_lal(), and GN_start_gnunet_nat_server_().

310 {
311  if (NULL != h->server_read_task)
312  {
314  h->server_read_task = NULL;
315  }
316  if (NULL != h->server_proc)
317  {
322  h->server_proc = NULL;
324  h->server_stdout = NULL;
325  h->server_stdout_handle = NULL;
326  }
327  if (NULL != h->server_stdout)
328  {
330  h->server_stdout = NULL;
331  h->server_stdout_handle = NULL;
332  }
333  GNUNET_free (h);
334 }
struct GNUNET_OS_Process * server_proc
The process id of the server process (if behind NAT)
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
struct GNUNET_SCHEDULER_Task * server_read_task
ID of select gnunet-helper-nat-server stdout read task.
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
struct GNUNET_DISK_PipeHandle * server_stdout
stdout pipe handle for the gnunet-helper-nat-server process
int GNUNET_DISK_pipe_close(struct GNUNET_DISK_PipeHandle *p)
Closes an interprocess channel.
Definition: disk.c:1715
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:1000
const struct GNUNET_DISK_FileHandle * server_stdout_handle
stdout file handle (for reading) for the gnunet-helper-nat-server process
#define GNUNET_TERM_SIG
The termination signal.
Definition: platform.h:242
#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:225
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:966
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GN_request_connection_reversal()

int GN_request_connection_reversal ( const struct in_addr *  internal_address,
uint16_t  internal_port,
const struct in_addr *  remote_v4,
const struct GNUNET_CONFIGURATION_Handle cfg 
)

We want to connect to a peer that is behind NAT.

Run the gnunet-helper-nat-client to send dummy ICMP responses to cause that peer to connect to us (connection reversal).

Parameters
internal_addressout internal address to use
internal_portport to use
remote_v4the address of the peer (IPv4-only)
cfghandle to the GNUnet configuration
Returns
GNUNET_SYSERR on error, GNUNET_OK otherwise

Definition at line 350 of file gnunet-service-nat_helper.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_strerror, GNUNET_NO, GNUNET_OK, GNUNET_OS_get_suid_binary_path(), GNUNET_OS_process_destroy(), GNUNET_OS_process_wait(), GNUNET_OS_start_process(), GNUNET_snprintf(), and GNUNET_SYSERR.

Referenced by handle_request_connection_reversal().

354 {
355  char intv4[INET_ADDRSTRLEN];
356  char remv4[INET_ADDRSTRLEN];
357  char port_as_string[6];
358  struct GNUNET_OS_Process *proc;
359  char *binary;
360 
361  if (NULL == inet_ntop (AF_INET, internal_address, intv4, INET_ADDRSTRLEN))
362  {
364  return GNUNET_SYSERR;
365  }
366  if (NULL == inet_ntop (AF_INET, remote_v4, remv4, INET_ADDRSTRLEN))
367  {
369  return GNUNET_SYSERR;
370  }
371  GNUNET_snprintf (port_as_string,
372  sizeof(port_as_string),
373  "%d",
374  internal_port);
376  "Running gnunet-helper-nat-client %s %s %u\n",
377  intv4,
378  remv4,
379  internal_port);
380  binary = GNUNET_OS_get_suid_binary_path (cfg, "gnunet-helper-nat-client");
382  0,
383  NULL,
384  NULL,
385  NULL,
386  binary,
387  "gnunet-helper-nat-client",
388  intv4,
389  remv4,
390  port_as_string,
391  NULL);
392  GNUNET_free (binary);
393  if (NULL == proc)
394  return GNUNET_SYSERR;
395  /* we know that the gnunet-helper-nat-client will terminate virtually
396  * instantly */
397  GNUNET_OS_process_wait (proc);
399  return GNUNET_OK;
400 }
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
int GNUNET_snprintf(char *buf, size_t size, const char *format,...)
Like snprintf, just aborts if the buffer is of insufficient size.
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 GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
char * GNUNET_OS_get_suid_binary_path(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *progname)
Given the name of a helper, service or daemon binary construct the full path to the binary using the ...
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:1000
#define GNUNET_log(kind,...)
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function: