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
190 result_callback (void *cls, int success)
192 struct GNUNET_NAT_AutoHandle *ah = cls;
194 GNUNET_SCHEDULER_cancel (ah->task);
195 ah->task = GNUNET_SCHEDULER_NO_TASK;
196 GNUNET_NAT_test_stop (ah->tst);
198 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
200 ? _("NAT traversal with ICMP Server succeeded.\n")
201 : _("NAT traversal with ICMP Server failed.\n"));
202 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_ICMP_SERVER",
203 success ? "YES": "NO");
209 * Main function for the connection reversal test.
211 * @param cls the `struct GNUNET_NAT_AutoHandle`
212 * @param tc scheduler context
215 reversal_test (void *cls,
216 const struct GNUNET_SCHEDULER_TaskContext *tc)
218 struct GNUNET_NAT_AutoHandle *ah = cls;
220 ah->task = GNUNET_SCHEDULER_NO_TASK;
221 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
222 _("Testing connection reversal with ICMP server.\n"));
223 GNUNET_RESOLVER_connect (ah->cfg);
224 ah->tst = GNUNET_NAT_test_start (ah->cfg, GNUNET_YES, 0, 0,
225 &result_callback, ah);
231 ah->task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &fail_timeout, ah);
236 * Test if we are online at all.
238 * @param ah auto setup context
241 test_online (struct GNUNET_NAT_AutoHandle *ah)
243 // FIXME: not implemented
249 * Set our external IPv4 address.
251 * @param cls closure with our setup context
252 * @param addr the address, NULL on errors
255 set_external_ipv4 (void *cls,
256 const struct in_addr *addr)
258 struct GNUNET_NAT_AutoHandle *ah = cls;
259 char buf[INET_ADDRSTRLEN];
267 /* enable 'behind nat' */
268 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
269 _("Detected external IP `%s'\n"),
274 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "BEHIND_NAT", "YES");
276 /* set external IP address */
277 if (NULL == inet_ntop (AF_INET, addr, buf, sizeof (buf)))
283 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
290 * Determine our external IPv4 address.
292 * @param ah auto setup context
295 test_external_ip (struct GNUNET_NAT_AutoHandle *ah)
298 /* try to detect external IP */
299 ah->eh = GNUNET_NAT_mini_get_external_ipv4 (TIMEOUT,
300 &set_external_ipv4, ah);
305 * Process list of local IP addresses. Find and set the
306 * one of the default interface.
308 * @param cls our `struct GNUNET_NAT_AutoHandle`
309 * @param name name of the interface (can be NULL for unknown)
310 * @param isDefault is this presumably the default interface
311 * @param addr address of this interface (can be NULL for unknown or unassigned)
312 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
313 * @param netmask the network mask (can be NULL for unknown or unassigned))
314 * @param addrlen length of the @a addr and @a broadcast_addr
315 * @return GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
321 const struct sockaddr *addr,
322 const struct sockaddr *broadcast_addr,
323 const struct sockaddr *netmask,
326 struct GNUNET_NAT_AutoHandle *ah = cls;
327 const struct sockaddr_in *in;
328 char buf[INET_ADDRSTRLEN];
332 if ( (sizeof (struct sockaddr_in6) == addrlen) &&
333 (0 != memcmp (&in6addr_loopback, &((const struct sockaddr_in6 *) addr)->sin6_addr,
334 sizeof (struct in6_addr))) &&
335 (! IN6_IS_ADDR_LINKLOCAL(&((const struct sockaddr_in6 *) addr)->sin6_addr)) )
337 ah->have_v6 = GNUNET_YES;
338 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
339 _("This system has a global IPv6 address, setting IPv6 to supported.\n"));
342 if (addrlen != sizeof (struct sockaddr_in))
344 in = (const struct sockaddr_in *) addr;
346 /* set internal IP address */
347 if (NULL == inet_ntop (AF_INET, &in->sin_addr, buf, sizeof (buf)))
352 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
354 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
355 _("Detected internal network address `%s'.\n"),
357 /* no need to continue iteration */
358 return GNUNET_SYSERR;
363 * Determine our local IP addresses; detect internal IP & IPv6-support
365 * @param ah auto setup context
368 test_local_ip (struct GNUNET_NAT_AutoHandle *ah)
370 ah->have_v6 = GNUNET_NO;
371 GNUNET_OS_network_interfaces_list (&nipo, ah);
372 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "DISABLEV6",
373 (GNUNET_YES == ah->have_v6) ? "NO" : "YES");
379 * Test if NAT has been punched
381 * @param ah auto setup context
384 test_nat_punched (struct GNUNET_NAT_AutoHandle *ah)
386 // FIXME: not implemented
392 * Test if UPnPC works.
394 * @param ah auto setup context
397 test_upnpc (struct GNUNET_NAT_AutoHandle *ah)
401 /* test if upnpc is available */
402 have_upnpc = (GNUNET_SYSERR !=
403 GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL));
404 /* FIXME: test if upnpc is actually working, that is, if transports
405 start to work once we use UPnP */
406 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
408 ? _("upnpc found, enabling its use\n")
409 : _("upnpc not found\n"));
410 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat", "ENABLE_UPNP",
411 (GNUNET_YES == have_upnpc) ? "YES" : "NO");
417 * Test if ICMP server is working
419 * @param ah auto setup context
422 test_icmp_server (struct GNUNET_NAT_AutoHandle *ah)
429 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
432 GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "EXTERNAL_ADDRESS",
433 &tmp)) && (0 < strlen (tmp)) &&
435 GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
437 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
438 GNUNET_free_non_null (tmp);
439 GNUNET_free (binary);
440 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
442 ? _("gnunet-helper-nat-server found, testing it\n")
443 : _("No working gnunet-helper-nat-server found\n"));
445 ah->task = GNUNET_SCHEDULER_add_now (&reversal_test, ah);
452 * Test if ICMP client is working
454 * @param ah auto setup context
457 test_icmp_client (struct GNUNET_NAT_AutoHandle *ah)
464 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
467 GNUNET_CONFIGURATION_get_value_string (ah->cfg, "nat", "INTERNAL_ADDRESS",
468 &tmp)) && (0 < strlen (tmp)) &&
470 GNUNET_CONFIGURATION_get_value_yesno (ah->cfg, "nat", "BEHIND_NAT")) &&
472 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
473 GNUNET_free_non_null (tmp);
474 GNUNET_free (binary);
475 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
477 ? _("gnunet-helper-nat-client found, enabling it\n")
478 : _("gnunet-helper-nat-client not found or behind NAT, disabling it\n"));
484 * Run the next phase of the auto test.
487 next_phase (struct GNUNET_NAT_AutoHandle *ah)
489 struct GNUNET_CONFIGURATION_Handle *diff;
500 case AUTO_EXTERNAL_IP:
501 test_external_ip (ah);
506 case AUTO_NAT_PUNCHED:
507 test_nat_punched (ah);
512 case AUTO_ICMP_SERVER:
513 test_icmp_server (ah);
515 case AUTO_ICMP_CLIENT:
516 test_icmp_client (ah);
519 diff = GNUNET_CONFIGURATION_get_diff (ah->initial_cfg,
521 ah->fin_cb (ah->fin_cb_cls,
523 GNUNET_CONFIGURATION_destroy (diff);
524 GNUNET_NAT_autoconfig_cancel (ah);
531 * Start auto-configuration routine. The resolver service should
532 * be available when this function is called.
534 * @param cfg initial configuration
535 * @param cb function to call with autoconfiguration result
536 * @param cb_cls closure for @a cb
537 * @return handle to cancel operation
539 struct GNUNET_NAT_AutoHandle *
540 GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
541 GNUNET_NAT_AutoResultCallback cb,
544 struct GNUNET_NAT_AutoHandle *ah;
546 ah = GNUNET_new (struct GNUNET_NAT_AutoHandle);
548 ah->fin_cb_cls = cb_cls;
549 ah->cfg = GNUNET_CONFIGURATION_dup (cfg);
550 ah->initial_cfg = GNUNET_CONFIGURATION_dup (cfg);
552 /* never use loopback addresses if user wanted autoconfiguration */
553 GNUNET_CONFIGURATION_set_value_string (ah->cfg, "nat",
562 * Abort autoconfiguration.
564 * @param ah handle for operation to abort
567 GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah)
571 GNUNET_NAT_test_stop (ah->tst);
576 GNUNET_NAT_mini_get_external_ipv4_cancel (ah->eh);
579 if (GNUNET_SCHEDULER_NO_TASK != ah->task)
581 GNUNET_SCHEDULER_cancel (ah->task);
582 ah->task = GNUNET_SCHEDULER_NO_TASK;
584 GNUNET_CONFIGURATION_destroy (ah->cfg);
585 GNUNET_CONFIGURATION_destroy (ah->initial_cfg);
590 /* end of nat_auto.c */