GNUnet 0.21.0
gnunet-nat-auto.c File Reference
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_nat_service.h"
#include "gnunet_nat_auto_service.h"
Include dependency graph for gnunet-nat-auto.c:

Go to the source code of this file.

Functions

static void test_finished ()
 Test if all activities have finished, and if so, terminate. More...
 
static void auto_conf_iter (void *cls, const char *section, const char *option, const char *value)
 Function to iterate over suggested changes options. More...
 
static void auto_config_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *diff, enum GNUNET_NAT_StatusCode result, enum GNUNET_NAT_Type type)
 Function called with the result from the autoconfiguration. More...
 
static void test_report_cb (void *cls, enum GNUNET_NAT_StatusCode result)
 Function called to report success or failure for NAT configuration test. More...
 
static void do_shutdown (void *cls)
 Task run on shutdown. More...
 
static void run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
 Main function that will be run. More...
 
int main (int argc, char *const argv[])
 Main function of gnunet-nat-auto. More...
 

Variables

static int global_ret
 Value to return from main(). More...
 
static struct GNUNET_NAT_AUTO_AutoHandleah
 Handle to ongoing autoconfiguration. More...
 
static int write_cfg
 If we do auto-configuration, should we write the result to a file? More...
 
static const char * cfg_file
 Configuration filename. More...
 
static const struct GNUNET_CONFIGURATION_Handlecfg
 Original configuration. More...
 
static char * section_name
 Adapter we are supposed to test. More...
 
static int do_auto
 Should we run autoconfiguration? More...
 
static struct GNUNET_NAT_AUTO_Testnt
 Handle to a NAT test operation. More...
 
static int use_udp
 Flag set to 1 if we use IPPROTO_UDP. More...
 
static int use_tcp
 Flag set to 1 if we use IPPROTO_TCP. More...
 
static uint8_t proto
 Protocol to use. More...
 

Function Documentation

◆ test_finished()

static void test_finished ( void  )
static

Test if all activities have finished, and if so, terminate.

Definition at line 93 of file gnunet-nat-auto.c.

94{
95 if (NULL != ah)
96 return;
97 if (NULL != nt)
98 return;
100}
static struct GNUNET_NAT_AUTO_AutoHandle * ah
Handle to ongoing autoconfiguration.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:562

References ah, GNUNET_SCHEDULER_shutdown(), and nt.

Referenced by auto_config_cb(), run(), and test_report_cb().

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

◆ auto_conf_iter()

static void auto_conf_iter ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

Function to iterate over suggested changes options.

Parameters
clsclosure
sectionname of the section
optionname of the option
valuevalue of the option

Definition at line 112 of file gnunet-nat-auto.c.

116{
117 struct GNUNET_CONFIGURATION_Handle *new_cfg = cls;
118
119 printf ("%s: %s\n", option, value);
120 if (NULL != new_cfg)
121 GNUNET_CONFIGURATION_set_value_string (new_cfg, section, option, value);
122}
static char * value
Value of the record to add/remove.
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.

References GNUNET_CONFIGURATION_set_value_string(), and value.

Referenced by auto_config_cb().

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

◆ auto_config_cb()

static void auto_config_cb ( void *  cls,
const struct GNUNET_CONFIGURATION_Handle diff,
enum GNUNET_NAT_StatusCode  result,
enum GNUNET_NAT_Type  type 
)
static

Function called with the result from the autoconfiguration.

Parameters
clsclosure
diffminimal suggested changes to the original configuration to make it work (as best as we can)
resultGNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
typewhat the situation of the NAT

Definition at line 135 of file gnunet-nat-auto.c.

139{
140 const char *nat_type;
141 char unknown_type[64];
142 struct GNUNET_CONFIGURATION_Handle *new_cfg;
143
144 ah = NULL;
145 switch (type)
146 {
148 nat_type = "NO NAT";
149 break;
150
152 nat_type = "NAT but we can traverse";
153 break;
154
156 nat_type = "NAT but STUN is able to identify the correct information";
157 break;
158
160 nat_type = "NAT but UPNP opened the ports";
161 break;
162
163 default:
164 sprintf (unknown_type, "NAT unknown, type %u", type);
165 nat_type = unknown_type;
166 break;
167 }
168
170 "NAT status: %s/%s\n",
172 nat_type);
173
174 if (NULL == diff)
175 return;
176
177 /* Shortcut: if there are no changes suggested, bail out early. */
179 {
180 test_finished ();
181 return;
182 }
183
184 /* Apply diff to original configuration and show changes
185 to the user */
186 new_cfg = write_cfg ? GNUNET_CONFIGURATION_dup (cfg) : NULL;
187
189 _ ("Suggested configuration changes:\n"));
191 "nat",
193 new_cfg);
194
195 /* If desired, write configuration to file; we write only the
196 changes to the defaults to keep things compact. */
197 if (write_cfg)
198 {
199 struct GNUNET_CONFIGURATION_Handle *def_cfg;
200
201 GNUNET_CONFIGURATION_set_value_string (new_cfg, "ARM", "CONFIG", NULL);
202 def_cfg = GNUNET_CONFIGURATION_create ();
204 if (GNUNET_OK !=
205 GNUNET_CONFIGURATION_write_diffs (def_cfg, new_cfg, cfg_file))
206 {
208 _ ("Failed to write configuration to `%s'\n"),
209 cfg_file);
210 global_ret = 1;
211 }
212 else
213 {
215 _ ("Wrote updated configuration to `%s'\n"),
216 cfg_file);
217 }
219 }
220
221 if (NULL != new_cfg)
223 test_finished ();
224}
static uint32_t type
Type string converted to DNS type value.
static void auto_conf_iter(void *cls, const char *section, const char *option, const char *value)
Function to iterate over suggested changes options.
static int global_ret
Value to return from main().
static const struct GNUNET_CONFIGURATION_Handle * cfg
Original configuration.
static int write_cfg
If we do auto-configuration, should we write the result to a file?
static const char * cfg_file
Configuration filename.
static void test_finished()
Test if all activities have finished, and if so, terminate.
static int result
Global testing status.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_is_dirty(const struct GNUNET_CONFIGURATION_Handle *cfg)
Test if there are configuration options that were changed since the last save.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
void GNUNET_CONFIGURATION_iterate_section_values(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over values of a section in the configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write_diffs(const struct GNUNET_CONFIGURATION_Handle *cfg_default, const struct GNUNET_CONFIGURATION_Handle *cfg_new, const char *filename)
Write only configuration entries that have been changed to configuration file.
#define GNUNET_log(kind,...)
@ GNUNET_OK
@ GNUNET_NO
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_MESSAGE
const char * GNUNET_NAT_AUTO_status2string(enum GNUNET_NAT_StatusCode err)
Converts enum GNUNET_NAT_StatusCode to string.
Definition: nat_auto_api.c:68
@ GNUNET_NAT_TYPE_UPNP_NAT
We can traverse using UPNP.
@ GNUNET_NAT_TYPE_UNREACHABLE_NAT
We are under a NAT but cannot traverse it.
@ GNUNET_NAT_TYPE_NO_NAT
We have a direct connection.
@ GNUNET_NAT_TYPE_STUN_PUNCHED_NAT
We can traverse using STUN.
#define _(String)
GNU gettext support macro.
Definition: platform.h:178

References _, ah, auto_conf_iter(), cfg, cfg_file, global_ret, GNUNET_break, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_dup(), GNUNET_CONFIGURATION_is_dirty(), GNUNET_CONFIGURATION_iterate_section_values(), GNUNET_CONFIGURATION_load(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_CONFIGURATION_write_diffs(), GNUNET_ERROR_TYPE_MESSAGE, GNUNET_log, GNUNET_NAT_AUTO_status2string(), GNUNET_NAT_TYPE_NO_NAT, GNUNET_NAT_TYPE_STUN_PUNCHED_NAT, GNUNET_NAT_TYPE_UNREACHABLE_NAT, GNUNET_NAT_TYPE_UPNP_NAT, GNUNET_NO, GNUNET_OK, result, test_finished(), type, and write_cfg.

Referenced by run().

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

◆ test_report_cb()

static void test_report_cb ( void *  cls,
enum GNUNET_NAT_StatusCode  result 
)
static

Function called to report success or failure for NAT configuration test.

Parameters
clsclosure
resultGNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code

Definition at line 235 of file gnunet-nat-auto.c.

236{
237 nt = NULL;
238 printf ("NAT test result: %s\n", GNUNET_NAT_AUTO_status2string (result));
239 test_finished ();
240}

References GNUNET_NAT_AUTO_status2string(), nt, result, and test_finished().

Referenced by run().

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

◆ do_shutdown()

static void do_shutdown ( void *  cls)
static

Task run on shutdown.

Parameters
clsNULL

Definition at line 249 of file gnunet-nat-auto.c.

250{
251 if (NULL != ah)
252 {
254 ah = NULL;
255 }
256 if (NULL != nt)
257 {
259 nt = NULL;
260 }
261}
void GNUNET_NAT_AUTO_test_stop(struct GNUNET_NAT_AUTO_Test *tst)
Stop an active NAT test.
void GNUNET_NAT_AUTO_autoconfig_cancel(struct GNUNET_NAT_AUTO_AutoHandle *ah)
Abort autoconfiguration.
Definition: nat_auto_api.c:285

References ah, GNUNET_NAT_AUTO_autoconfig_cancel(), GNUNET_NAT_AUTO_test_stop(), and nt.

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,
char *const *  args,
const char *  cfgfile,
const struct GNUNET_CONFIGURATION_Handle c 
)
static

Main function that will be run.

Parameters
clsclosure
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cconfiguration

Definition at line 273 of file gnunet-nat-auto.c.

277{
278 cfg_file = cfgfile;
279 cfg = c;
280
282
283 if (do_auto)
284 {
286 }
287
288 if (use_tcp && use_udp)
289 {
290 if (do_auto)
291 return;
292 GNUNET_log (GNUNET_ERROR_TYPE_MESSAGE, "Cannot use TCP and UDP\n");
293 global_ret = 1;
294 return;
295 }
296 proto = 0;
297 if (use_tcp)
298 proto = IPPROTO_TCP;
299 if (use_udp)
300 proto = IPPROTO_UDP;
301
302 if (NULL != section_name)
303 {
305 proto,
308 NULL);
309 }
310 test_finished ();
311}
static void auto_config_cb(void *cls, const struct GNUNET_CONFIGURATION_Handle *diff, enum GNUNET_NAT_StatusCode result, enum GNUNET_NAT_Type type)
Function called with the result from the autoconfiguration.
static char * section_name
Adapter we are supposed to test.
static void test_report_cb(void *cls, enum GNUNET_NAT_StatusCode result)
Function called to report success or failure for NAT configuration test.
static void do_shutdown(void *cls)
Task run on shutdown.
static int do_auto
Should we run autoconfiguration?
static int use_udp
Flag set to 1 if we use IPPROTO_UDP.
static int use_tcp
Flag set to 1 if we use IPPROTO_TCP.
static uint8_t proto
Protocol to use.
struct GNUNET_NAT_AUTO_Test * GNUNET_NAT_AUTO_test_start(const struct GNUNET_CONFIGURATION_Handle *cfg, uint8_t proto, const char *section_name, GNUNET_NAT_TestCallback report, void *report_cls)
Start testing if NAT traversal works using the given configuration.
struct GNUNET_NAT_AUTO_AutoHandle * GNUNET_NAT_AUTO_autoconfig_start(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_NAT_AUTO_AutoResultCallback cb, void *cb_cls)
Start auto-configuration routine.
Definition: nat_auto_api.c:225
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:1334

References ah, auto_config_cb(), cfg, cfg_file, do_auto, do_shutdown(), global_ret, GNUNET_ERROR_TYPE_MESSAGE, GNUNET_log, GNUNET_NAT_AUTO_autoconfig_start(), GNUNET_NAT_AUTO_test_start(), GNUNET_SCHEDULER_add_shutdown(), nt, proto, section_name, test_finished(), test_report_cb(), use_tcp, and use_udp.

Referenced by main().

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

◆ main()

int main ( int  argc,
char *const  argv[] 
)

Main function of gnunet-nat-auto.

Parameters
argcnumber of command-line arguments
argvcommand line
Returns
0 on success, -1 on error

Definition at line 322 of file gnunet-nat-auto.c.

323{
326 "auto",
327 gettext_noop ("run autoconfiguration"),
328 &do_auto),
329
331 'S',
332 "section",
333 "NAME",
335 "section name providing the configuration for the adapter"),
336 &section_name),
337
338 GNUNET_GETOPT_option_flag ('t', "tcp", gettext_noop ("use TCP"), &use_tcp),
339
340 GNUNET_GETOPT_option_flag ('u', "udp", gettext_noop ("use UDP"), &use_udp),
341
343 'w',
344 "write",
345 gettext_noop ("write configuration file (for autoconfiguration)"),
346 &write_cfg),
348
349 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
350 return 2;
351 if (GNUNET_OK !=
352 GNUNET_PROGRAM_run (argc,
353 argv,
354 "gnunet-nat-auto [options]",
355 _ ("GNUnet NAT traversal autoconfiguration"),
356 options,
357 &run,
358 NULL))
359 {
360 global_ret = 1;
361 }
362 GNUNET_free_nz ((void *) argv);
363 return global_ret;
364}
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
#define gettext_noop(String)
Definition: gettext.h:70
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
Main function that will be run.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
#define GNUNET_free_nz(ptr)
Wrapper around free.
enum GNUNET_GenericReturnValue GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration,...
Definition: program.c:400
enum GNUNET_GenericReturnValue GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1230
Definition of a command line option.

References _, do_auto, gettext_noop, global_ret, GNUNET_free_nz, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_string(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), options, run(), section_name, use_tcp, use_udp, and write_cfg.

Here is the call graph for this function:

Variable Documentation

◆ global_ret

int global_ret
static

Value to return from main().

Definition at line 35 of file gnunet-nat-auto.c.

Referenced by auto_config_cb(), main(), and run().

◆ ah

◆ write_cfg

int write_cfg
static

If we do auto-configuration, should we write the result to a file?

Definition at line 46 of file gnunet-nat-auto.c.

Referenced by auto_config_cb(), and main().

◆ cfg_file

const char* cfg_file
static

Configuration filename.

Definition at line 51 of file gnunet-nat-auto.c.

Referenced by auto_config_cb(), and run().

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg
static

Original configuration.

Definition at line 56 of file gnunet-nat-auto.c.

Referenced by auto_config_cb(), and run().

◆ section_name

char* section_name
static

Adapter we are supposed to test.

Definition at line 61 of file gnunet-nat-auto.c.

Referenced by communicator_start(), GNUNET_NAT_AUTO_test_start(), main(), and run().

◆ do_auto

int do_auto
static

Should we run autoconfiguration?

Definition at line 66 of file gnunet-nat-auto.c.

Referenced by main(), and run().

◆ nt

◆ use_udp

int use_udp
static

Flag set to 1 if we use IPPROTO_UDP.

Definition at line 76 of file gnunet-nat-auto.c.

Referenced by main(), and run().

◆ use_tcp

int use_tcp
static

Flag set to 1 if we use IPPROTO_TCP.

Definition at line 81 of file gnunet-nat-auto.c.

Referenced by main(), and run().

◆ proto