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 @e 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,
165 const struct GNUNET_SCHEDULER_TaskContext *tc)
167 struct GNUNET_NAT_AutoHandle *ah = cls;
169 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
170 _("NAT traversal with ICMP Server timed out.\n"));
171 GNUNET_assert (NULL != ah->tst);
172 ah->task = GNUNET_SCHEDULER_NO_TASK;
173 GNUNET_NAT_test_stop (ah->tst);
175 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat",
176 "ENABLE_ICMP_SERVER",
183 * Function called by NAT on success.
184 * Clean up and update GUI (with success).
186 * @param cls the auto handle
187 * @param success currently always #GNUNET_OK
188 * @param emsg NULL on success, otherwise an error message
191 result_callback (void *cls,
195 struct GNUNET_NAT_AutoHandle *ah = cls;
197 GNUNET_SCHEDULER_cancel (ah->task);
198 ah->task = GNUNET_SCHEDULER_NO_TASK;
199 GNUNET_NAT_test_stop (ah->tst);
201 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
203 ? _("NAT traversal with ICMP Server succeeded.\n")
204 : _("NAT traversal with ICMP Server failed.\n"));
205 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_ICMP_SERVER",
206 success ? "YES": "NO");
212 * Main function for the connection reversal test.
214 * @param cls the `struct GNUNET_NAT_AutoHandle`
215 * @param tc scheduler context
218 reversal_test (void *cls,
219 const struct GNUNET_SCHEDULER_TaskContext *tc)
221 struct GNUNET_NAT_AutoHandle *ah = cls;
223 ah->task = GNUNET_SCHEDULER_NO_TASK;
224 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
225 _("Testing connection reversal with ICMP server.\n"));
226 GNUNET_RESOLVER_connect (ah->cfg);
227 ah->tst = GNUNET_NAT_test_start (ah->cfg, GNUNET_YES, 0, 0,
228 &result_callback, ah);
234 ah->task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, ah);
239 * Test if we are online at all.
241 * @param ah auto setup context
244 test_online (struct GNUNET_NAT_AutoHandle *ah)
246 // FIXME: not implemented
252 * Set our external IPv4 address.
254 * @param cls closure with our setup context
255 * @param addr the address, NULL on errors
256 * @param emsg NULL on success, otherwise an error message
259 set_external_ipv4 (void *cls,
260 const struct in_addr *addr,
263 struct GNUNET_NAT_AutoHandle *ah = cls;
264 char buf[INET_ADDRSTRLEN];
272 /* enable 'behind nat' */
273 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
274 _("Detected external IP `%s'\n"),
279 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "BEHIND_NAT", "YES");
281 /* set external IP address */
282 if (NULL == inet_ntop (AF_INET, addr, buf, sizeof (buf)))
288 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
295 * Determine our external IPv4 address.
297 * @param ah auto setup context
300 test_external_ip (struct GNUNET_NAT_AutoHandle *ah)
303 /* try to detect external IP */
304 ah->eh = GNUNET_NAT_mini_get_external_ipv4 (TIMEOUT,
305 &set_external_ipv4, ah);
310 * Process list of local IP addresses. Find and set the
311 * one of the default interface.
313 * @param cls our `struct GNUNET_NAT_AutoHandle`
314 * @param name name of the interface (can be NULL for unknown)
315 * @param isDefault is this presumably the default interface
316 * @param addr address of this interface (can be NULL for unknown or unassigned)
317 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
318 * @param netmask the network mask (can be NULL for unknown or unassigned))
319 * @param addrlen length of the @a addr and @a broadcast_addr
320 * @return GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
326 const struct sockaddr *addr,
327 const struct sockaddr *broadcast_addr,
328 const struct sockaddr *netmask,
331 struct GNUNET_NAT_AutoHandle *ah = cls;
332 const struct sockaddr_in *in;
333 char buf[INET_ADDRSTRLEN];
337 if ( (sizeof (struct sockaddr_in6) == addrlen) &&
338 (0 != memcmp (&in6addr_loopback, &((const struct sockaddr_in6 *) addr)->sin6_addr,
339 sizeof (struct in6_addr))) &&
340 (! IN6_IS_ADDR_LINKLOCAL(&((const struct sockaddr_in6 *) addr)->sin6_addr)) )
342 ah->have_v6 = GNUNET_YES;
343 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
344 _("This system has a global IPv6 address, setting IPv6 to supported.\n"));
347 if (addrlen != sizeof (struct sockaddr_in))
349 in = (const struct sockaddr_in *) addr;
351 /* set internal IP address */
352 if (NULL == inet_ntop (AF_INET, &in->sin_addr, buf, sizeof (buf)))
357 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
359 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
360 _("Detected internal network address `%s'.\n"),
362 /* no need to continue iteration */
363 return GNUNET_SYSERR;
368 * Determine our local IP addresses; detect internal IP & IPv6-support
370 * @param ah auto setup context
373 test_local_ip (struct GNUNET_NAT_AutoHandle *ah)
375 ah->have_v6 = GNUNET_NO;
376 GNUNET_OS_network_interfaces_list (&nipo, ah);
377 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "DISABLEV6",
378 (GNUNET_YES == ah->have_v6) ? "NO" : "YES");
384 * Test if NAT has been punched
386 * @param ah auto setup context
389 test_nat_punched (struct GNUNET_NAT_AutoHandle *ah)
391 // FIXME: not implemented
397 * Test if UPnPC works.
399 * @param ah auto setup context
402 test_upnpc (struct GNUNET_NAT_AutoHandle *ah)
406 /* test if upnpc is available */
407 have_upnpc = (GNUNET_SYSERR !=
408 GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL));
409 /* FIXME: test if upnpc is actually working, that is, if transports
410 start to work once we use UPnP */
411 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
413 ? _("upnpc found, enabling its use\n")
414 : _("upnpc not found\n"));
415 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_UPNP",
416 (GNUNET_YES == have_upnpc) ? "YES" : "NO");
422 * Test if ICMP server is working
424 * @param ah auto setup context
427 test_icmp_server (struct GNUNET_NAT_AutoHandle *ah)
434 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
437 GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
438 &tmp)) && (0 < strlen (tmp)) &&
440 GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
442 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
443 GNUNET_free_non_null (tmp);
444 GNUNET_free (binary);
445 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
447 ? _("gnunet-helper-nat-server found, testing it\n")
448 : _("No working gnunet-helper-nat-server found\n"));
450 ah->task = GNUNET_SCHEDULER_add_now (&reversal_test, ah);
457 * Test if ICMP client is working
459 * @param ah auto setup context
462 test_icmp_client (struct GNUNET_NAT_AutoHandle *ah)
469 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
472 GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
473 &tmp)) && (0 < strlen (tmp)) &&
475 GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
477 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
478 GNUNET_free_non_null (tmp);
479 GNUNET_free (binary);
480 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
482 ? _("gnunet-helper-nat-client found, enabling it\n")
483 : _("gnunet-helper-nat-client not found or behind NAT, disabling it\n"));
489 * Run the next phase of the auto test.
492 next_phase (struct GNUNET_NAT_AutoHandle *ah)
494 struct GNUNET_CONFIGURATION_Handle *diff;
505 case AUTO_EXTERNAL_IP:
506 test_external_ip (ah);
511 case AUTO_NAT_PUNCHED:
512 test_nat_punched (ah);
517 case AUTO_ICMP_SERVER:
518 test_icmp_server (ah);
520 case AUTO_ICMP_CLIENT:
521 test_icmp_client (ah);
524 diff = GNUNET_CONFIGURATION_get_diff (ah->initial_cfg,
526 ah->fin_cb (ah->fin_cb_cls,
529 GNUNET_CONFIGURATION_destroy (diff);
530 GNUNET_NAT_autoconfig_cancel (ah);
537 * Start auto-configuration routine. The resolver service should
538 * be available when this function is called.
540 * @param cfg initial configuration
541 * @param cb function to call with autoconfiguration result
542 * @param cb_cls closure for @a cb
543 * @return handle to cancel operation
545 struct GNUNET_NAT_AutoHandle *
546 GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
547 GNUNET_NAT_AutoResultCallback cb,
550 struct GNUNET_NAT_AutoHandle *ah;
552 ah = GNUNET_new (struct GNUNET_NAT_AutoHandle);
554 ah->fin_cb_cls = cb_cls;
555 ah->cfg = GNUNET_CONFIGURATION_dup (cfg);
556 ah->initial_cfg = GNUNET_CONFIGURATION_dup (cfg);
558 /* never use loopback addresses if user wanted autoconfiguration */
559 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat",
568 * Abort autoconfiguration.
570 * @param ah handle for operation to abort
573 GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah)
577 GNUNET_NAT_test_stop (ah->tst);
582 GNUNET_NAT_mini_get_external_ipv4_cancel (ah->eh);
585 if (GNUNET_SCHEDULER_NO_TASK != ah->task)
587 GNUNET_SCHEDULER_cancel (ah->task);
588 ah->task = GNUNET_SCHEDULER_NO_TASK;
590 GNUNET_CONFIGURATION_destroy (ah->cfg);
591 GNUNET_CONFIGURATION_destroy (ah->initial_cfg);
596 /* end of nat_auto.c */