2 This file is part of GNUnet.
3 (C) 2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file nat/nat_auto.c
23 * @brief functions for auto-configuration of the network
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_resolver_service.h"
29 #include "gnunet_nat_lib.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
36 * How long do we wait for the NAT test to report success?
38 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
41 * Phases of the auto configuration.
46 * Initial start value.
51 * Test if we are online.
56 * Test our external IP.
61 * Test our internal IP.
66 * Test if NAT was punched.
71 * Test if UPnP is working.
76 * Test if ICMP server works.
81 * Test if ICMP client works.
86 * Last phase, we're done.
94 * Handle to auto-configuration in progress.
96 struct GNUNET_NAT_AutoHandle
100 * Handle to the active NAT test.
102 struct GNUNET_NAT_Test *tst;
105 * Function to call when done.
107 GNUNET_NAT_AutoResultCallback fin_cb;
110 * Closure for 'fin_cb'.
115 * Handle for active 'GNUNET_NAT_mini_get_external_ipv4'-operation.
117 struct GNUNET_NAT_ExternalHandle *eh;
120 * Current configuration (with updates from previous phases)
122 struct GNUNET_CONFIGURATION_Handle *cfg;
125 * Original configuration (used to calculate differences)
127 struct GNUNET_CONFIGURATION_Handle *initial_cfg;
130 * Task identifier for the timeout.
132 GNUNET_SCHEDULER_TaskIdentifier task;
135 * Where are we in the test?
137 enum AutoPhase phase;
148 * Run the next phase of the auto test.
150 * @param ah auto test handle
153 next_phase (struct GNUNET_NAT_AutoHandle *ah);
157 * Function called if NAT failed to confirm success.
158 * Clean up and update GUI (with failure).
160 * @param cls closure with setup context
161 * @param tc scheduler callback
164 fail_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
166 struct GNUNET_NAT_AutoHandle *ah = cls;
168 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
169 _("NAT traversal with ICMP Server timed out.\n"));
170 GNUNET_assert (NULL != ah->tst);
171 ah->task = GNUNET_SCHEDULER_NO_TASK;
172 GNUNET_NAT_test_stop (ah->tst);
174 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat",
175 "ENABLE_ICMP_SERVER",
182 * Function called by NAT on success.
183 * Clean up and update GUI (with success).
185 * @param cls the auto handle
186 * @param success currently always GNUNET_OK
189 result_callback (void *cls, int success)
191 struct GNUNET_NAT_AutoHandle *ah = cls;
193 GNUNET_SCHEDULER_cancel (ah->task);
194 ah->task = GNUNET_SCHEDULER_NO_TASK;
195 GNUNET_NAT_test_stop (ah->tst);
197 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
199 ? _("NAT traversal with ICMP Server succeeded.\n")
200 : _("NAT traversal with ICMP Server failed.\n"));
201 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_ICMP_SERVER",
202 success ? "YES": "NO");
207 * Main function for the connection reversal test.
209 * @param cls the 'int*' for the result
210 * @param tc scheduler context
213 reversal_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
215 struct GNUNET_NAT_AutoHandle *ah = cls;
217 ah->task = GNUNET_SCHEDULER_NO_TASK;
218 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
219 _("Testing connection reversal with ICMP server.\n"));
220 GNUNET_RESOLVER_connect (ah->cfg);
221 ah->tst = GNUNET_NAT_test_start (ah->cfg, GNUNET_YES, 0, 0,
222 &result_callback, ah);
228 ah->task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, ah);
233 * Test if we are online at all.
235 * @param ah auto setup context
238 test_online (struct GNUNET_NAT_AutoHandle *ah)
240 // FIXME: not implemented
246 * Set our external IPv4 address.
248 * @param cls closure with our setup context
249 * @param addr the address, NULL on errors
252 set_external_ipv4 (void *cls, const struct in_addr *addr)
254 struct GNUNET_NAT_AutoHandle *ah = cls;
255 char buf[INET_ADDRSTRLEN];
263 /* enable 'behind nat' */
264 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
265 _("Detected external IP `%s'\n"),
270 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "BEHIND_NAT", "YES");
272 /* set external IP address */
273 if (NULL == inet_ntop (AF_INET, addr, buf, sizeof (buf)))
279 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
286 * Determine our external IPv4 address.
288 * @param ah auto setup context
291 test_external_ip (struct GNUNET_NAT_AutoHandle *ah)
294 /* try to detect external IP */
295 ah->eh = GNUNET_NAT_mini_get_external_ipv4 (TIMEOUT,
296 &set_external_ipv4, ah);
301 * Process list of local IP addresses. Find and set the
302 * one of the default interface.
304 * @param cls our NAT auto handle
305 * @param name name of the interface (can be NULL for unknown)
306 * @param isDefault is this presumably the default interface
307 * @param addr address of this interface (can be NULL for unknown or unassigned)
308 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
309 * @param netmask the network mask (can be NULL for unknown or unassigned))
310 * @param addrlen length of the address
311 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
314 nipo (void *cls, const char *name, int isDefault, const struct sockaddr *addr,
315 const struct sockaddr *broadcast_addr, const struct sockaddr *netmask,
318 struct GNUNET_NAT_AutoHandle *ah = cls;
319 const struct sockaddr_in *in;
320 char buf[INET_ADDRSTRLEN];
324 if ( (sizeof (struct sockaddr_in6) == addrlen) &&
325 (0 != memcmp (&in6addr_loopback, &((const struct sockaddr_in6 *) addr)->sin6_addr,
326 sizeof (struct in6_addr))) &&
327 (! IN6_IS_ADDR_LINKLOCAL(&((const struct sockaddr_in6 *) addr)->sin6_addr)) )
329 ah->have_v6 = GNUNET_YES;
330 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
331 _("This system has a global IPv6 address, setting IPv6 to supported.\n"));
334 if (addrlen != sizeof (struct sockaddr_in))
336 in = (const struct sockaddr_in *) addr;
338 /* set internal IP address */
339 if (NULL == inet_ntop (AF_INET, &in->sin_addr, buf, sizeof (buf)))
344 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
346 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
347 _("Detected internal network address `%s'.\n"),
349 /* no need to continue iteration */
350 return GNUNET_SYSERR;
355 * Determine our local IP addresses; detect internal IP & IPv6-support
357 * @param ah auto setup context
360 test_local_ip (struct GNUNET_NAT_AutoHandle *ah)
362 ah->have_v6 = GNUNET_NO;
363 GNUNET_OS_network_interfaces_list (&nipo, ah);
364 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "DISABLEV6",
365 (GNUNET_YES == ah->have_v6) ? "NO" : "YES");
371 * Test if NAT has been punched
373 * @param ah auto setup context
376 test_nat_punched (struct GNUNET_NAT_AutoHandle *ah)
378 // FIXME: not implemented
384 * Test if UPnPC works.
386 * @param ah auto setup context
389 test_upnpc (struct GNUNET_NAT_AutoHandle *ah)
393 /* test if upnpc is available */
394 have_upnpc = (GNUNET_SYSERR !=
395 GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL));
396 /* FIXME: test if upnpc is actually working, that is, if transports
397 start to work once we use UPnP */
398 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
400 ? _("upnpc found, enabling its use\n")
401 : _("upnpc not found\n"));
402 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_UPNP",
403 (GNUNET_YES == have_upnpc) ? "YES" : "NO");
409 * Test if ICMP server is working
411 * @param ah auto setup context
414 test_icmp_server (struct GNUNET_NAT_AutoHandle *ah)
421 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
424 GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
425 &tmp)) && (0 < strlen (tmp)) &&
427 GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
429 GNUNET_OS_check_helper_binary (binary, GNUNET_YES, "-d 127.0.0.1" ))); // use localhost as source for that one udp-port, ok for testing
430 GNUNET_free_non_null (tmp);
431 GNUNET_free (binary);
432 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
434 ? _("gnunet-helper-nat-server found, testing it\n")
435 : _("No working gnunet-helper-nat-server found\n"));
437 ah->task = GNUNET_SCHEDULER_add_now (&reversal_test, ah);
444 * Test if ICMP client is working
446 * @param ah auto setup context
449 test_icmp_client (struct GNUNET_NAT_AutoHandle *ah)
456 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
459 GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
460 &tmp)) && (0 < strlen (tmp)) &&
462 GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
464 GNUNET_OS_check_helper_binary (binary, GNUNET_YES, "-d 127.0.0.1 127.0.0.2 42"))); // none of these parameters are actually used in privilege testing mode
465 GNUNET_free_non_null (tmp);
466 GNUNET_free (binary);
467 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
469 ? _("gnunet-helper-nat-client found, enabling it\n")
470 : _("gnunet-helper-nat-client not found or behind NAT, disabling it\n"));
476 * Run the next phase of the auto test.
479 next_phase (struct GNUNET_NAT_AutoHandle *ah)
481 struct GNUNET_CONFIGURATION_Handle *diff;
492 case AUTO_EXTERNAL_IP:
493 test_external_ip (ah);
498 case AUTO_NAT_PUNCHED:
499 test_nat_punched (ah);
504 case AUTO_ICMP_SERVER:
505 test_icmp_server (ah);
507 case AUTO_ICMP_CLIENT:
508 test_icmp_client (ah);
511 diff = GNUNET_CONFIGURATION_get_diff (ah->initial_cfg,
513 ah->fin_cb (ah->fin_cb_cls,
515 GNUNET_CONFIGURATION_destroy (diff);
516 GNUNET_NAT_autoconfig_cancel (ah);
524 * Start auto-configuration routine. The resolver service should
525 * be available when this function is called.
527 * @param cfg initial configuration
528 * @param cb function to call with autoconfiguration result
529 * @param cb_cls closure for cb
530 * @return handle to cancel operation
532 struct GNUNET_NAT_AutoHandle *
533 GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
534 GNUNET_NAT_AutoResultCallback cb,
537 struct GNUNET_NAT_AutoHandle *ah;
539 ah = GNUNET_malloc (sizeof (struct GNUNET_NAT_AutoHandle));
541 ah->fin_cb_cls = cb_cls;
542 ah->cfg = GNUNET_CONFIGURATION_dup (cfg);
543 ah->initial_cfg = GNUNET_CONFIGURATION_dup (cfg);
545 /* never use loopback addresses if user wanted autoconfiguration */
546 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat",
555 * Abort autoconfiguration.
557 * @param ah handle for operation to abort
560 GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah)
564 GNUNET_NAT_test_stop (ah->tst);
569 GNUNET_NAT_mini_get_external_ipv4_cancel (ah->eh);
572 if (GNUNET_SCHEDULER_NO_TASK != ah->task)
574 GNUNET_SCHEDULER_cancel (ah->task);
575 ah->task = GNUNET_SCHEDULER_NO_TASK;
577 GNUNET_CONFIGURATION_destroy (ah->cfg);
578 GNUNET_CONFIGURATION_destroy (ah->initial_cfg);
584 /* end of nat_auto.c */