GNUnet 0.22.2
gnunet-service-nat-auto.c File Reference

NAT autoconfiguration service. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_nat_service.h"
#include "gnunet_statistics_service.h"
#include "nat-auto.h"
#include <gcrypt.h>
Include dependency graph for gnunet-service-nat-auto.c:

Go to the source code of this file.

Data Structures

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

Macros

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

Functions

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

Variables

static struct ClientHandlech_head
 Head of client DLL. More...
 
static struct ClientHandlech_tail
 Tail of client DLL. More...
 
static struct AutoconfigContextac_head
 DLL of our autoconfiguration operations. More...
 
static struct AutoconfigContextac_tail
 DLL of our autoconfiguration operations. More...
 
static const struct GNUNET_CONFIGURATION_Handlecfg
 Handle to our current configuration. More...
 
static struct GNUNET_STATISTICS_Handlestats
 Handle to the statistics service. More...
 

Detailed Description

NAT autoconfiguration service.

Author
Christian Grothoff

TODO:

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

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

Macro Definition Documentation

◆ AUTOCONFIG_TIMEOUT

#define AUTOCONFIG_TIMEOUT
Value:
#define GNUNET_TIME_UNIT_SECONDS
One second.
struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Multiply relative time by a given factor.
Definition: time.c:486

How long do we wait until we forcefully terminate autoconfiguration?

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

Function Documentation

◆ check_autoconfig_request()

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

Check validity of #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG message from client.

Parameters
clsclient who sent the message
messagethe message received
Returns
GNUNET_OK if message is well-formed

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

173{
174 return GNUNET_OK; /* checked later */
175}
@ GNUNET_OK

References GNUNET_OK.

◆ terminate_ac_activities()

static void terminate_ac_activities ( struct AutoconfigContext ac)
static

Stop all pending activities with respect to the ac.

Parameters
acautoconfiguration to terminate activities for

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

185{
186 if (NULL != ac->timeout_task)
187 {
189 ac->timeout_task = NULL;
190 }
191}
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:980
struct GNUNET_SCHEDULER_Task * timeout_task
Timeout task to force termination.

References GNUNET_SCHEDULER_cancel(), and AutoconfigContext::timeout_task.

Referenced by conclude_autoconfig_request(), and shutdown_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ conclude_autoconfig_request()

static void conclude_autoconfig_request ( void *  cls)
static

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

Parameters
clsthe struct AutoconfigContext to conclude

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

202{
203 struct AutoconfigContext *ac = cls;
204 struct ClientHandle *ch = ac->ch;
206 struct GNUNET_MQ_Envelope *env;
207 size_t c_size;
208 char *buf;
209 struct GNUNET_CONFIGURATION_Handle *diff;
210
211 ac->timeout_task = NULL;
213
214 /* Send back response */
216 ac->c);
218 &c_size);
221 c_size,
223 arm->status_code = htonl ((uint32_t) ac->status_code);
224 arm->type = htonl ((uint32_t) ac->type);
225 GNUNET_memcpy (&arm[1],
226 buf,
227 c_size);
228 GNUNET_free (buf);
230 env);
231
232 /* clean up */
236 ac_tail,
237 ac);
238 GNUNET_free (ac);
240}
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static struct GNUNET_CADET_Channel * ch
Channel handle.
Definition: gnunet-cadet.c:117
static struct AutoconfigContext * ac_tail
DLL of our autoconfiguration operations.
static struct AutoconfigContext * ac_head
DLL of our autoconfiguration operations.
static void terminate_ac_activities(struct AutoconfigContext *ac)
Stop all pending activities with respect to the ac.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
char * GNUNET_CONFIGURATION_serialize(const struct GNUNET_CONFIGURATION_Handle *cfg, size_t *size)
Serializes the given configuration.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_get_diff(const struct GNUNET_CONFIGURATION_Handle *cfg_default, const struct GNUNET_CONFIGURATION_Handle *cfg_new)
Compute configuration with only entries that have been changed.
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:305
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct.
Definition: gnunet_mq_lib.h:61
#define GNUNET_MESSAGE_TYPE_NAT_AUTO_CFG_RESULT
Message from NAT service with the autoconfiguration result.
void GNUNET_SERVICE_client_continue(struct GNUNET_SERVICE_Client *c)
Continue receiving further messages from the given client.
Definition: service.c:2389
Context for autoconfiguration operations.
struct GNUNET_CONFIGURATION_Handle * c
Configuration we are creating.
enum GNUNET_NAT_Type type
NAT type to return to the client.
struct GNUNET_CONFIGURATION_Handle * orig
Original configuration (for diffing).
enum GNUNET_NAT_StatusCode status_code
Status code to return to the client.
struct ClientHandle * ch
Which client asked the question.
Struct containing information about a client, handle to connect to it, and any pending messages that ...
struct GNUNET_MQ_Handle * mq
Message Queue for the channel (which we are implementing).
Definition: cadet.h:142
Service responding with proposed configuration.
Definition: nat-auto.h:85
int32_t type
An enum GNUNET_NAT_Type in NBO.
Definition: nat-auto.h:99
int32_t status_code
An enum GNUNET_NAT_StatusCode in NBO.
Definition: nat-auto.h:94

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

Referenced by check_autoconfig_finished(), and handle_autoconfig_request().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_autoconfig_finished()

static void check_autoconfig_finished ( struct AutoconfigContext ac)
static

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

Parameters
acautoconfiguation context to check

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

251{
253 ac->timeout_task
255 ac);
256}
static void conclude_autoconfig_request(void *cls)
Finish handling the autoconfiguration request and send the response to the client.
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:1304

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

Referenced by handle_autoconfig_request().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ update_enable_upnpc_option()

static void update_enable_upnpc_option ( struct AutoconfigContext ac)
static

Update ENABLE_UPNPC configuration option.

Parameters
acautoconfiguration to update

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

266{
267 switch (ac->enable_upnpc)
268 {
269 case GNUNET_YES:
271 "NAT",
272 "ENABLE_UPNP",
273 "YES");
274 break;
275
276 case GNUNET_NO:
278 "NAT",
279 "ENABLE_UPNP",
280 "NO");
281 break;
282
283 case GNUNET_SYSERR:
284 /* We are unsure, do not change option */
285 break;
286 }
287}
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
@ GNUNET_YES
@ GNUNET_NO
@ GNUNET_SYSERR
int enable_upnpc
GNUNET_YES if upnpc should be used, GNUNET_NO if upnpc should not be used, GNUNET_SYSERR if we should...

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

Referenced by handle_autoconfig_request().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handle_autoconfig_request()

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

Handler for #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG message from client.

Parameters
clsclient who sent the message
messagethe message received

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

301{
302 struct ClientHandle *ch = cls;
303 size_t left = ntohs (message->header.size) - sizeof(*message);
304 struct AutoconfigContext *ac;
305
306 ac = GNUNET_new (struct AutoconfigContext);
308 ac->ch = ch;
310 if (GNUNET_OK !=
312 (const char *) &message[1],
313 left,
314 NULL))
315 {
316 GNUNET_break (0);
319 GNUNET_free (ac);
320 return;
321 }
323 "Received REQUEST_AUTO_CONFIG message from client\n");
324
326 ac_tail,
327 ac);
328 ac->orig
330 ac->timeout_task
333 ac);
334 ac->enable_upnpc = GNUNET_SYSERR; /* undecided */
335
336 /* Probe for upnpc */
337 if (GNUNET_SYSERR ==
339 GNUNET_NO,
340 NULL))
341 {
343 _ ("UPnP client `upnpc` command not found, disabling UPnP\n"));
345 }
346 else
347 {
348 /* We might at some point be behind NAT, try upnpc */
350 }
352
353 /* Finally, check if we are already done */
355}
static void update_enable_upnpc_option(struct AutoconfigContext *ac)
Update ENABLE_UPNPC configuration option.
#define AUTOCONFIG_TIMEOUT
How long do we wait until we forcefully terminate autoconfiguration?
static void check_autoconfig_finished(struct AutoconfigContext *ac)
Check if all autoconfiguration operations have concluded, and if they have, send the result back to t...
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(const struct GNUNET_OS_ProjectData *pd)
Create a new configuration object.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_deserialize(struct GNUNET_CONFIGURATION_Handle *cfg, const char *mem, size_t size, const char *source_filename)
De-serializes configuration.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
#define GNUNET_log(kind,...)
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_INFO
#define GNUNET_new(type)
Allocate a struct or union of the given type.
@ GNUNET_NAT_ERROR_SUCCESS
Just the default.
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_gnunet(void)
Return default project data used by 'libgnunetutil' for GNUnet.
enum GNUNET_GenericReturnValue GNUNET_OS_check_helper_binary(const char *binary, bool check_suid, const char *params)
Check whether an executable exists and possibly if the suid bit is set on the file.
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:1277
void GNUNET_SERVICE_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2418
#define _(String)
GNU gettext support macro.
Definition: platform.h:178
struct GNUNET_MessageHeader header
Header with type #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG.
Definition: nat-auto.h:75

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

Here is the call graph for this function:

◆ shutdown_task()

static void shutdown_task ( void *  cls)
static

Task run during shutdown.

Parameters
clsunused

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

365{
366 struct AutoconfigContext *ac;
367
368 while (NULL != (ac = ac_head))
369 {
371 ac_tail,
372 ac);
374 GNUNET_free (ac);
375 }
376 if (NULL != stats)
377 {
379 GNUNET_NO);
380 stats = NULL;
381 }
382}
static struct GNUNET_STATISTICS_Handle * stats
Handle to the statistics service.
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).

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

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ run()

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

Setup NAT service.

Parameters
clsclosure
cconfiguration to use
servicethe initialized service

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

396{
397 cfg = c;
399 NULL);
400 stats = GNUNET_STATISTICS_create ("nat-auto",
401 cfg);
402}
static const struct GNUNET_CONFIGURATION_Handle * cfg
Handle to our current configuration.
static void shutdown_task(void *cls)
Task run during shutdown.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received,...
Definition: scheduler.c:1339
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.

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

Here is the call graph for this function:

◆ client_connect_cb()

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

Callback called when a client connects to the service.

Parameters
clsclosure for the service
cthe new client that connected to the service
mqthe message queue used to send messages to the client
Returns
a struct ClientHandle

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

417{
418 struct ClientHandle *ch;
419
420 ch = GNUNET_new (struct ClientHandle);
421 ch->mq = mq;
422 ch->client = c;
424 ch_tail,
425 ch);
426 return ch;
427}
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
static struct ClientHandle * ch_head
Head of client DLL.
static struct ClientHandle * ch_tail
Tail of client DLL.

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

◆ client_disconnect_cb()

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

Callback called when a client disconnected from the service.

Parameters
clsclosure for the service
cthe client that disconnected
internal_clsa struct ClientHandle *

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

441{
442 struct ClientHandle *ch = internal_cls;
443
445 ch_tail,
446 ch);
447 GNUNET_free (ch);
448}

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

◆ GNUNET_SERVICE_MAIN()

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

Define "main" method using service macro.

Variable Documentation

◆ ch_head

struct ClientHandle* ch_head
static

Head of client DLL.

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

Referenced by client_connect_cb(), and client_disconnect_cb().

◆ ch_tail

struct ClientHandle* ch_tail
static

Tail of client DLL.

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

Referenced by client_connect_cb(), and client_disconnect_cb().

◆ ac_head

struct AutoconfigContext* ac_head
static

DLL of our autoconfiguration operations.

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

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

◆ ac_tail

struct AutoconfigContext* ac_tail
static

DLL of our autoconfiguration operations.

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

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

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg
static

Handle to our current configuration.

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

Referenced by run().

◆ stats

struct GNUNET_STATISTICS_Handle* stats
static

Handle to the statistics service.

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

Referenced by run(), and shutdown_task().