GNUnet  0.10.x
gnunet-nat-auto.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2015, 2016, 2017 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_nat_service.h"
31 
35 static int global_ret;
36 
41 
46 static int write_cfg;
47 
51 static const char *cfg_file;
52 
56 static const struct GNUNET_CONFIGURATION_Handle *cfg;
57 
61 static char *section_name;
62 
66 static int do_auto;
67 
71 static struct GNUNET_NAT_AUTO_Test *nt;
72 
76 static int use_udp;
77 
81 static int use_tcp;
82 
86 static uint8_t proto;
87 
92 static void
94 {
95  if (NULL != ah)
96  return;
97  if (NULL != nt)
98  return;
100 }
101 
102 
111 static void
112 auto_conf_iter(void *cls,
113  const char *section,
114  const char *option,
115  const char *value)
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 }
123 
124 
134 static void
135 auto_config_cb(void *cls,
136  const struct GNUNET_CONFIGURATION_Handle *diff,
138  enum GNUNET_NAT_Type type)
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 }
225 
226 
234 static void
236 {
237  nt = NULL;
238  printf("NAT test result: %s\n", GNUNET_NAT_AUTO_status2string(result));
239  test_finished();
240 }
241 
242 
248 static void
249 do_shutdown(void *cls)
250 {
251  if (NULL != ah)
252  {
254  ah = NULL;
255  }
256  if (NULL != nt)
257  {
259  nt = NULL;
260  }
261 }
262 
263 
272 static void
273 run(void *cls,
274  char *const *args,
275  const char *cfgfile,
276  const struct GNUNET_CONFIGURATION_Handle *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,
306  section_name,
308  NULL);
309  }
310  test_finished();
311 }
312 
313 
321 int
322 main(int argc, char *const argv[])
323 {
324  struct GNUNET_GETOPT_CommandLineOption options[] =
326  "auto",
327  gettext_noop("run autoconfiguration"),
328  &do_auto),
329 
331  'S',
332  "section",
333  "NAME",
334  gettext_noop(
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((void *)argv);
363  return global_ret;
364 }
365 
366 
367 /* end of gnunet-nat-auto.c */
static int use_udp
Flag set to 1 if we use IPPROTO_UDP.
static int global_ret
Value to return from main().
static char * section_name
Adapter we are supposed to test.
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.
void GNUNET_NAT_AUTO_autoconfig_cancel(struct GNUNET_NAT_AUTO_AutoHandle *ah)
Abort autoconfiguration.
Definition: nat_auto_api.c:283
static void do_shutdown(void *cls)
Task run on 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, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1284
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1439
Handle to a NAT test.
const char * GNUNET_NAT_AUTO_status2string(enum GNUNET_NAT_StatusCode err)
Converts enum GNUNET_NAT_StatusCode to string.
Definition: nat_auto_api.c:68
#define GNUNET_NO
Definition: gnunet_common.h:78
void GNUNET_NAT_AUTO_test_stop(struct GNUNET_NAT_AUTO_Test *tst)
Stop an active NAT test.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
Definition of a command line option.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
We are under a NAT but cannot traverse it.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:517
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
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.
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
Main function that will be run.
int GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static char * section
Name of the section.
Definition: gnunet-config.c:33
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 void test_report_cb(void *cls, enum GNUNET_NAT_StatusCode result)
Function called to report success or failure for NAT configuration test.
static void test_finished()
Test if all activities have finished, and if so, terminate.
static char * value
Value of the record to add/remove.
int 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.
int GNUNET_CONFIGURATION_is_dirty(const struct GNUNET_CONFIGURATION_Handle *cfg)
Test if there are configuration options that were changed since the last save.
GNUNET_NAT_StatusCode
Error Types for the NAT subsystem (which can then later be converted/resolved to a string) ...
static int write_cfg
If we do auto-configuration, should we write the result to a file?
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
static char * option
Name of the option.
Definition: gnunet-config.c:38
static int result
Global testing status.
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.
static const char * cfg_file
Configuration filename.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Original configuration.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
int main(int argc, char *const argv[])
Main function of gnunet-nat-auto.
Handle to auto-configuration in progress.
Definition: nat_auto_api.c:38
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
static struct GNUNET_NAT_AUTO_AutoHandle * ah
Handle to ongoing autoconfiguration.
configuration data
Definition: configuration.c:83
We can traverse using UPNP.
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.
static int use_tcp
Flag set to 1 if we use IPPROTO_TCP.
#define GNUNET_log(kind,...)
We have a direct connection.
static uint8_t proto
Protocol to use.
int 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, parse options).
Definition: program.c:367
static int do_auto
Should we run autoconfiguration?
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
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:224
GNUNET_NAT_Type
What the situation of the NAT connectivity.
static void auto_conf_iter(void *cls, const char *section, const char *option, const char *value)
Function to iterate over sugested changes options.
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.
We can traverse using STUN.
#define GNUNET_free(ptr)
Wrapper around free.
#define gettext_noop(String)
Definition: gettext.h:69