2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
23 * @brief Library handling UPnP and NAT-PMP port forwarding and
24 * external IP address retrieval
25 * @author Milan Bouchet-Valat
26 * @author Christian Grothoff
29 #include "gnunet_util_lib.h"
30 #include "gnunet_resolver_service.h"
31 #include "gnunet_nat_lib.h"
34 #define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
37 * How often do we scan for changes in our IP address from our local
40 #define IFC_SCAN_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
43 * How often do we scan for changes in how our hostname resolves?
45 #define HOSTNAME_DNS_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 20)
49 * How often do we scan for changes in how our external (dyndns) hostname resolves?
51 #define DYNDNS_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 7)
54 * How long until we give up trying to resolve our own hostname?
56 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
60 * How often do we check a STUN server ?
62 #define STUN_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
66 * Where did the given local address originate from?
67 * To be used for debugging as well as in the future
68 * to remove all addresses from a certain source when
69 * we reevaluate the source.
71 enum LocalAddressSource
74 * Address was obtained by DNS resolution of the external hostname
75 * given in the configuration (i.e. hole-punched DynDNS setup).
80 * Address was obtained by an external STUN server
85 * Address was obtained by DNS resolution of the external hostname
86 * given in the configuration (i.e. hole-punched DynDNS setup)
87 * during the previous iteration (see #3213).
92 * Address was obtained by looking up our own hostname in DNS.
97 * Address was obtained by scanning our hosts's network interfaces
98 * and taking their address (no DNS involved).
100 LAL_INTERFACE_ADDRESS,
103 * Addresses we were explicitly bound to.
108 * Addresses from UPnP or PMP
120 * List of local addresses that we currently deem valid. Actual
121 * struct is followed by the 'struct sockaddr'. Note that the code
122 * intentionally makes no attempt to ensure that a particular address
123 * is only listed once (especially since it may come from different
124 * sources, and the source is an "internal" construct).
126 struct LocalAddressList
129 * This is a linked list.
131 struct LocalAddressList *next;
136 struct LocalAddressList *prev;
139 * Number of bytes of address that follow.
144 * Origin of the local address.
146 enum LocalAddressSource source;
151 * Handle for miniupnp-based NAT traversal actions.
157 * Doubly-linked list.
159 struct MiniList *next;
162 * Doubly-linked list.
164 struct MiniList *prev;
167 * Handle to mini-action.
169 struct GNUNET_NAT_MiniHandle *mini;
172 * Local port number that was mapped.
180 * List of STUN servers
182 struct StunServerList
186 * Doubly-linked list.
188 struct StunServerList *next;
191 * Doubly-linked list.
193 struct StunServerList *prev;
209 * Handle for active NAT registrations.
211 struct GNUNET_NAT_Handle
215 * Configuration to use.
217 const struct GNUNET_CONFIGURATION_Handle *cfg;
220 * Function to call when we learn about a new address.
222 GNUNET_NAT_AddressCallback address_callback;
225 * Function to call when we notice another peer asking for
226 * connection reversal.
228 GNUNET_NAT_ReversalCallback reversal_callback;
231 * Closure for callbacks (@e address_callback and @e reversal_callback)
236 * Handle for (DYN)DNS lookup of our external IP.
238 struct GNUNET_RESOLVER_RequestHandle *ext_dns;
241 * Handle for request of hostname resolution, non-NULL if pending.
243 struct GNUNET_RESOLVER_RequestHandle *hostname_dns;
246 * stdout pipe handle for the gnunet-helper-nat-server process
248 struct GNUNET_DISK_PipeHandle *server_stdout;
251 * stdout file handle (for reading) for the gnunet-helper-nat-server process
253 const struct GNUNET_DISK_FileHandle *server_stdout_handle;
256 * Linked list of currently valid addresses (head).
258 struct LocalAddressList *lal_head;
261 * Linked list of currently valid addresses (tail).
263 struct LocalAddressList *lal_tail;
266 * How long do we wait for restarting a crashed gnunet-helper-nat-server?
268 struct GNUNET_TIME_Relative server_retry_delay;
271 * ID of select gnunet-helper-nat-server stdout read task
273 struct GNUNET_SCHEDULER_Task *server_read_task;
276 * ID of interface IP-scan task
278 struct GNUNET_SCHEDULER_Task *ifc_task;
281 * ID of hostname DNS lookup task
283 struct GNUNET_SCHEDULER_Task *hostname_task;
286 * ID of DynDNS lookup task
288 struct GNUNET_SCHEDULER_Task *dns_task;
291 * Active STUN request, if any.
293 struct GNUNET_NAT_STUN_Handle *stun_request;
296 * How often do we scan for changes in our IP address from our local
299 struct GNUNET_TIME_Relative ifc_scan_frequency;
302 * How often do we scan for changes in how our hostname resolves?
304 struct GNUNET_TIME_Relative hostname_dns_frequency;
307 * How often do we scan for changes in how our external (dyndns) hostname resolves?
309 struct GNUNET_TIME_Relative dyndns_frequency;
312 * The process id of the server process (if behind NAT)
314 struct GNUNET_OS_Process *server_proc;
317 * LAN address as passed by the caller (array).
319 struct sockaddr **local_addrs;
322 * Length of the @e local_addrs.
324 socklen_t *local_addrlens;
327 * List of handles for UPnP-traversal, one per local port (if
330 struct MiniList *mini_head;
333 * List of handles for UPnP-traversal, one per local port (if
336 struct MiniList *mini_tail;
339 * Number of entries in 'local_addrs' array.
341 unsigned int num_local_addrs;
344 * Our external address (according to config, UPnP may disagree...),
345 * in dotted decimal notation, IPv4-only. Or NULL if not known.
347 char *external_address;
350 * Presumably our internal address (according to config)
352 char *internal_address;
355 * Is this transport configured to be behind a NAT?
360 * Has the NAT been punched? (according to config)
365 * Is this transport configured to allow connections to NAT'd peers?
367 int enable_nat_client;
370 * Should we run the gnunet-helper-nat-server?
372 int enable_nat_server;
375 * Are we allowed to try UPnP/PMP for NAT traversal?
380 * Should we use local addresses (loopback)? (according to config)
382 int use_localaddresses;
385 * Should we return local addresses to clients
387 int return_localaddress;
390 * Should we do a DNS lookup of our hostname to find out our own IP?
395 * Is using IPv6 disabled?
400 * Is this TCP or UDP?
405 * Port we advertise to the outside.
410 * Should we use STUN ?
415 * How often should we check STUN ?
417 struct GNUNET_TIME_Relative stun_frequency;
422 struct GNUNET_NETWORK_Handle* socket;
425 * Am I waiting for a STUN response ?
432 struct GNUNET_SCHEDULER_Task * stun_task;
435 * Head of List of STUN servers
437 struct StunServerList *stun_servers_head;
440 * Tail of List of STUN servers
442 struct StunServerList *stun_servers_tail;
447 struct StunServerList *actual_stun_server;
453 * Try to start the gnunet-helper-nat-server (if it is not
456 * @param h handle to NAT
459 start_gnunet_nat_server (struct GNUNET_NAT_Handle *h);
463 * Call task to process STUN
465 * @param cls handle to NAT
466 * @param tc TaskContext
469 process_stun (void *cls,
470 const struct GNUNET_SCHEDULER_TaskContext *tc);
474 * Remove all addresses from the list of 'local' addresses
475 * that originated from the given source.
477 * @param h handle to NAT
478 * @param src source that identifies addresses to remove
481 remove_from_address_list_by_source (struct GNUNET_NAT_Handle *h,
482 enum LocalAddressSource src)
484 struct LocalAddressList *pos;
485 struct LocalAddressList *next;
488 while (NULL != (pos = next))
491 if (pos->source != src)
493 GNUNET_CONTAINER_DLL_remove (h->lal_head,
496 if (NULL != h->address_callback)
497 h->address_callback (h->callback_cls,
499 (const struct sockaddr *) &pos[1],
507 * Add the given address to the list of 'local' addresses, thereby
508 * making it a 'legal' address for this peer to have.
510 * @param h handle to NAT
511 * @param src where did the local address originate from?
512 * @param arg the address, some `struct sockaddr`
513 * @param arg_size number of bytes in @a arg
516 add_to_address_list_as_is (struct GNUNET_NAT_Handle *h,
517 enum LocalAddressSource src,
518 const struct sockaddr *arg,
521 struct LocalAddressList *lal;
523 lal = GNUNET_malloc (sizeof (struct LocalAddressList) + arg_size);
524 memcpy (&lal[1], arg, arg_size);
525 lal->addrlen = arg_size;
527 GNUNET_CONTAINER_DLL_insert (h->lal_head,
530 LOG (GNUNET_ERROR_TYPE_DEBUG,
531 "Adding address `%s' from source %d\n",
532 GNUNET_a2s (arg, arg_size),
534 if (NULL != h->address_callback)
535 h->address_callback (h->callback_cls,
543 * Add the given address to the list of 'local' addresses, thereby
544 * making it a 'legal' address for this peer to have. Set the
545 * port number in the process to the advertised port and possibly
546 * also to zero (if we have the gnunet-helper-nat-server).
548 * @param h handle to NAT
549 * @param src where did the local address originate from?
550 * @param arg the address, some `struct sockaddr`
551 * @param arg_size number of bytes in @a arg
554 add_to_address_list (struct GNUNET_NAT_Handle *h,
555 enum LocalAddressSource src,
556 const struct sockaddr *arg,
559 struct sockaddr_in s4;
560 const struct sockaddr_in *in4;
561 struct sockaddr_in6 s6;
562 const struct sockaddr_in6 *in6;
564 if (arg_size == sizeof (struct sockaddr_in))
566 in4 = (const struct sockaddr_in *) arg;
568 s4.sin_port = htons (h->adv_port);
569 add_to_address_list_as_is (h, src, (const struct sockaddr *) &s4,
570 sizeof (struct sockaddr_in));
571 if (GNUNET_YES == h->enable_nat_server)
573 /* also add with PORT = 0 to indicate NAT server is enabled */
574 s4.sin_port = htons (0);
575 add_to_address_list_as_is (h, src, (const struct sockaddr *) &s4,
576 sizeof (struct sockaddr_in));
579 else if (arg_size == sizeof (struct sockaddr_in6))
581 if (GNUNET_YES != h->disable_ipv6)
583 in6 = (const struct sockaddr_in6 *) arg;
585 s6.sin6_port = htons (h->adv_port);
586 add_to_address_list_as_is (h, src, (const struct sockaddr *) &s6,
587 sizeof (struct sockaddr_in6));
598 * Add the given IP address to the list of 'local' addresses, thereby
599 * making it a 'legal' address for this peer to have.
601 * @param h handle to NAT
602 * @param src where did the local address originate from?
603 * @param addr the address, some `struct in_addr` or `struct in6_addr`
604 * @param addrlen number of bytes in addr
607 add_ip_to_address_list (struct GNUNET_NAT_Handle *h,
608 enum LocalAddressSource src, const void *addr,
611 struct sockaddr_in s4;
612 const struct in_addr *in4;
613 struct sockaddr_in6 s6;
614 const struct in6_addr *in6;
616 if (addrlen == sizeof (struct in_addr))
618 in4 = (const struct in_addr *) addr;
619 memset (&s4, 0, sizeof (s4));
620 s4.sin_family = AF_INET;
622 #if HAVE_SOCKADDR_IN_SIN_LEN
623 s4.sin_len = (u_char) sizeof (struct sockaddr_in);
626 add_to_address_list (h, src, (const struct sockaddr *) &s4,
627 sizeof (struct sockaddr_in));
628 if (GNUNET_YES == h->enable_nat_server)
630 /* also add with PORT = 0 to indicate NAT server is enabled */
631 s4.sin_port = htons (0);
632 add_to_address_list (h, src, (const struct sockaddr *) &s4,
633 sizeof (struct sockaddr_in));
637 else if (addrlen == sizeof (struct in6_addr))
639 if (GNUNET_YES != h->disable_ipv6)
641 in6 = (const struct in6_addr *) addr;
642 memset (&s6, 0, sizeof (s6));
643 s6.sin6_family = AF_INET6;
644 s6.sin6_port = htons (h->adv_port);
645 #if HAVE_SOCKADDR_IN_SIN_LEN
646 s6.sin6_len = (u_char) sizeof (struct sockaddr_in6);
649 add_to_address_list (h, src, (const struct sockaddr *) &s6,
650 sizeof (struct sockaddr_in6));
661 * Task to do DNS lookup on our external hostname to
662 * get DynDNS-IP addresses.
664 * @param cls the NAT handle
665 * @param tc scheduler context
668 resolve_dns (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
672 * Our (external) hostname was resolved and the configuration says that
673 * the NAT was hole-punched.
675 * @param cls the `struct GNUNET_NAT_Handle`
676 * @param addr NULL on error, otherwise result of DNS lookup
677 * @param addrlen number of bytes in @a addr
680 process_external_ip (void *cls,
681 const struct sockaddr *addr,
684 struct GNUNET_NAT_Handle *h = cls;
685 struct in_addr dummy;
690 /* Current iteration is over, remove 'old' IPs now */
691 LOG (GNUNET_ERROR_TYPE_DEBUG,
692 "Purging old IPs for external address\n");
693 remove_from_address_list_by_source (h, LAL_EXTERNAL_IP_OLD);
694 if (1 == inet_pton (AF_INET,
698 LOG (GNUNET_ERROR_TYPE_DEBUG,
699 "Got numeric IP for external address, not repeating lookup\n");
700 return; /* repated lookup pointless: was numeric! */
703 GNUNET_SCHEDULER_add_delayed (h->dyndns_frequency,
707 LOG (GNUNET_ERROR_TYPE_DEBUG,
708 "Got IP `%s' for external address `%s'\n",
709 GNUNET_a2s (addr, addrlen),
710 h->external_address);
711 add_to_address_list (h, LAL_EXTERNAL_IP, addr, addrlen);
716 * Task to do a lookup on our hostname for IP addresses.
718 * @param cls the NAT handle
719 * @param tc scheduler context
722 resolve_hostname (void *cls,
723 const struct GNUNET_SCHEDULER_TaskContext *tc);
727 * Function called by the resolver for each address obtained from DNS
728 * for our own hostname. Add the addresses to the list of our IP
732 * @param addr one of the addresses of the host, NULL for the last address
733 * @param addrlen length of the @a addr
736 process_hostname_ip (void *cls,
737 const struct sockaddr *addr,
740 struct GNUNET_NAT_Handle *h = cls;
744 h->hostname_dns = NULL;
746 GNUNET_SCHEDULER_add_delayed (h->hostname_dns_frequency,
747 &resolve_hostname, h);
750 add_to_address_list (h, LAL_HOSTNAME_DNS, addr, addrlen);
755 * Length of the interface names returned from os_network.c.
756 * (in that file, hardcoded at 11).
758 #define IF_NAME_LEN 11
762 * Add the IP of our network interface to the list of
765 * @param cls the `struct GNUNET_NAT_Handle`
766 * @param name name of the interface
767 * @param isDefault do we think this may be our default interface
768 * @param addr address of the interface
769 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
770 * @param netmask the network mask (can be NULL for unknown or unassigned))
771 * @param addrlen number of bytes in @a addr and @a broadcast_addr
772 * @return #GNUNET_OK to continue iterating
775 process_interfaces (void *cls,
778 const struct sockaddr *addr,
779 const struct sockaddr *broadcast_addr,
780 const struct sockaddr *netmask,
783 const static struct in6_addr any6 = IN6ADDR_ANY_INIT;
784 struct GNUNET_NAT_Handle *h = cls;
785 const struct sockaddr_in *s4;
786 const struct sockaddr_in6 *s6;
788 char buf[INET6_ADDRSTRLEN];
793 /* skip virtual interfaces created by GNUnet-vpn */
795 GNUNET_CONFIGURATION_get_value_string (h->cfg,
800 if (0 == strncasecmp (name,
804 GNUNET_free (tun_if);
807 GNUNET_free (tun_if);
809 /* skip virtual interfaces created by GNUnet-dns */
811 GNUNET_CONFIGURATION_get_value_string (h->cfg,
816 if (0 == strncasecmp (name,
820 GNUNET_free (tun_if);
823 GNUNET_free (tun_if);
825 /* skip virtual interfaces created by GNUnet-exit */
827 GNUNET_CONFIGURATION_get_value_string (h->cfg,
832 if (0 == strncasecmp (name,
836 GNUNET_free (tun_if);
839 GNUNET_free (tun_if);
842 switch (addr->sa_family)
845 /* check if we're bound to the "ANY" IP address */
846 have_any = GNUNET_NO;
847 for (i=0;i<h->num_local_addrs;i++)
849 if (h->local_addrs[i]->sa_family != AF_INET)
854 if (INADDR_ANY == ((struct sockaddr_in*) h->local_addrs[i])->sin_addr.s_addr)
856 have_any = GNUNET_YES;
860 if (GNUNET_NO == have_any)
861 return GNUNET_OK; /* not bound to IP 0.0.0.0 but to specific IP addresses,
862 do not use those from interfaces */
863 s4 = (struct sockaddr_in *) addr;
866 /* Check if address is in 127.0.0.0/8 */
867 uint32_t address = ntohl ((uint32_t) (s4->sin_addr.s_addr));
868 uint32_t value = (address & 0xFF000000) ^ 0x7F000000;
870 if ((h->return_localaddress == GNUNET_NO) && (value == 0))
874 if ((GNUNET_YES == h->use_localaddresses) || (value != 0))
876 add_ip_to_address_list (h, LAL_INTERFACE_ADDRESS, &s4->sin_addr,
877 sizeof (struct in_addr));
881 /* check if we're bound to the "ANY" IP address */
882 have_any = GNUNET_NO;
883 for (i=0;i<h->num_local_addrs;i++)
885 if (h->local_addrs[i]->sa_family != AF_INET6)
887 if (0 == memcmp (&any6,
888 &((struct sockaddr_in6*) h->local_addrs[i])->sin6_addr,
889 sizeof (struct in6_addr)))
891 have_any = GNUNET_YES;
895 if (GNUNET_NO == have_any)
896 return GNUNET_OK; /* not bound to "ANY" IP (::0) but to specific IP addresses,
897 do not use those from interfaces */
899 s6 = (struct sockaddr_in6 *) addr;
900 if (IN6_IS_ADDR_LINKLOCAL (&((struct sockaddr_in6 *) addr)->sin6_addr))
902 /* skip link local addresses */
905 if ((h->return_localaddress == GNUNET_NO) &&
906 (IN6_IS_ADDR_LOOPBACK (&((struct sockaddr_in6 *) addr)->sin6_addr)))
911 if (GNUNET_YES == h->use_localaddresses)
913 add_ip_to_address_list (h, LAL_INTERFACE_ADDRESS, &s6->sin6_addr,
914 sizeof (struct in6_addr));
921 if ((h->internal_address == NULL) && (h->server_proc == NULL) &&
922 (h->server_read_task == NULL) &&
923 (GNUNET_YES == isDefault) && ((addr->sa_family == AF_INET) ||
924 (addr->sa_family == AF_INET6)))
926 /* no internal address configured, but we found a "default"
927 * interface, try using that as our 'internal' address */
928 h->internal_address =
929 GNUNET_strdup (inet_ntop (addr->sa_family, ip, buf, sizeof (buf)));
930 start_gnunet_nat_server (h);
937 * Task that restarts the gnunet-helper-nat-server process after a crash
938 * after a certain delay.
940 * @param cls the `struct GNUNET_NAT_Handle`
941 * @param tc scheduler context
944 restart_nat_server (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
946 struct GNUNET_NAT_Handle *h = cls;
948 h->server_read_task = NULL;
949 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
951 start_gnunet_nat_server (h);
956 * We have been notified that gnunet-helper-nat-server has written
957 * something to stdout. Handle the output, then reschedule this
958 * function to be called again once more is available.
960 * @param cls the NAT handle
961 * @param tc the scheduling context
964 nat_server_read (void *cls,
965 const struct GNUNET_SCHEDULER_TaskContext *tc)
967 struct GNUNET_NAT_Handle *h = cls;
972 const char *port_start;
973 struct sockaddr_in sin_addr;
975 h->server_read_task = NULL;
976 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
978 memset (mybuf, 0, sizeof (mybuf));
980 GNUNET_DISK_file_read (h->server_stdout_handle, mybuf, sizeof (mybuf));
983 LOG (GNUNET_ERROR_TYPE_DEBUG,
984 "Finished reading from server stdout with code: %d\n",
986 if (0 != GNUNET_OS_process_kill (h->server_proc, GNUNET_TERM_SIG))
987 GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING, "nat", "kill");
988 GNUNET_OS_process_wait (h->server_proc);
989 GNUNET_OS_process_destroy (h->server_proc);
990 h->server_proc = NULL;
991 GNUNET_DISK_pipe_close (h->server_stdout);
992 h->server_stdout = NULL;
993 h->server_stdout_handle = NULL;
994 /* now try to restart it */
995 h->server_retry_delay = GNUNET_TIME_STD_BACKOFF (h->server_retry_delay);
996 h->server_read_task =
997 GNUNET_SCHEDULER_add_delayed (h->server_retry_delay,
998 &restart_nat_server, h);
1003 for (i = 0; i < sizeof (mybuf); i++)
1005 if (mybuf[i] == '\n')
1010 if ((mybuf[i] == ':') && (i + 1 < sizeof (mybuf)))
1013 port_start = &mybuf[i + 1];
1017 /* construct socket address of sender */
1018 memset (&sin_addr, 0, sizeof (sin_addr));
1019 sin_addr.sin_family = AF_INET;
1020 #if HAVE_SOCKADDR_IN_SIN_LEN
1021 sin_addr.sin_len = sizeof (sin_addr);
1023 if ((NULL == port_start) || (1 != SSCANF (port_start, "%d", &port)) ||
1024 (-1 == inet_pton (AF_INET, mybuf, &sin_addr.sin_addr)))
1026 /* should we restart gnunet-helper-nat-server? */
1027 LOG (GNUNET_ERROR_TYPE_WARNING, "nat",
1028 _("gnunet-helper-nat-server generated malformed address `%s'\n"),
1030 h->server_read_task =
1031 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1032 h->server_stdout_handle,
1033 &nat_server_read, h);
1036 sin_addr.sin_port = htons ((uint16_t) port);
1037 LOG (GNUNET_ERROR_TYPE_DEBUG, "gnunet-helper-nat-server read: %s:%d\n", mybuf,
1039 h->reversal_callback (h->callback_cls, (const struct sockaddr *) &sin_addr,
1041 h->server_read_task =
1042 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1043 h->server_stdout_handle, &nat_server_read,
1049 * Try to start the gnunet-helper-nat-server (if it is not
1052 * @param h handle to NAT
1055 start_gnunet_nat_server (struct GNUNET_NAT_Handle *h)
1059 if ((h->behind_nat == GNUNET_YES) && (h->enable_nat_server == GNUNET_YES) &&
1060 (h->internal_address != NULL) &&
1063 GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES))))
1065 LOG (GNUNET_ERROR_TYPE_DEBUG,
1066 "Starting `%s' at `%s'\n",
1067 "gnunet-helper-nat-server", h->internal_address);
1068 /* Start the server process */
1069 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
1071 GNUNET_OS_start_process (GNUNET_NO, 0, NULL, h->server_stdout, NULL,
1073 "gnunet-helper-nat-server",
1074 h->internal_address, NULL);
1075 GNUNET_free (binary);
1076 if (h->server_proc == NULL)
1078 LOG (GNUNET_ERROR_TYPE_WARNING, "nat", _("Failed to start %s\n"),
1079 "gnunet-helper-nat-server");
1080 GNUNET_DISK_pipe_close (h->server_stdout);
1081 h->server_stdout = NULL;
1085 /* Close the write end of the read pipe */
1086 GNUNET_DISK_pipe_close_end (h->server_stdout, GNUNET_DISK_PIPE_END_WRITE);
1087 h->server_stdout_handle =
1088 GNUNET_DISK_pipe_handle (h->server_stdout, GNUNET_DISK_PIPE_END_READ);
1089 h->server_read_task =
1090 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1091 h->server_stdout_handle,
1092 &nat_server_read, h);
1099 * Task to scan the local network interfaces for IP addresses.
1101 * @param cls the NAT handle
1102 * @param tc scheduler context
1105 list_interfaces (void *cls,
1106 const struct GNUNET_SCHEDULER_TaskContext *tc)
1108 struct GNUNET_NAT_Handle *h = cls;
1111 remove_from_address_list_by_source (h, LAL_INTERFACE_ADDRESS);
1112 GNUNET_OS_network_interfaces_list (&process_interfaces, h);
1114 GNUNET_SCHEDULER_add_delayed (h->ifc_scan_frequency,
1115 &list_interfaces, h);
1120 * Callback with the result from the STUN request.
1122 * @param cls the NAT handle
1123 * @param result the status
1126 stun_request_callback (void *cls,
1127 enum GNUNET_NAT_StatusCode result)
1129 struct GNUNET_NAT_Handle *h = cls;
1131 h->stun_request = NULL;
1134 case GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR:
1135 LOG (GNUNET_ERROR_TYPE_WARNING,
1136 "Failed to transmit STUN request\n");
1138 case GNUNET_NAT_ERROR_NOT_ONLINE:
1139 LOG (GNUNET_ERROR_TYPE_WARNING,
1140 "Failed to resolve STUN server (are we online?)\n");
1142 case GNUNET_NAT_ERROR_SUCCESS:
1143 /* all good, STUN request active */
1144 h->waiting_stun = GNUNET_YES;
1147 /* unexpected error code for STUN */
1154 * CHECK if is a valid STUN packet sending to GNUNET_NAT_stun_handle_packet().
1155 * It also check if it can handle the packet based on the NAT handler.
1156 * You don't need to call anything else to check if the packet is valid,
1158 * @param cls the NAT handle
1159 * @param data packet
1160 * @param len packet length
1161 * @return #GNUNET_NO if it can't decode, #GNUNET_YES if is a packet
1164 GNUNET_NAT_is_valid_stun_packet (void *cls,
1168 struct GNUNET_NAT_Handle *h = cls;
1169 struct sockaddr_in answer;
1171 /* We are not expecting a STUN message */
1172 if (GNUNET_YES != h->waiting_stun)
1175 /* We dont have STUN installed */
1179 /* Empty the answer structure */
1182 sizeof(struct sockaddr_in));
1184 /* Lets handle the packet*/
1186 GNUNET_NAT_stun_handle_packet (data,
1191 LOG (GNUNET_ERROR_TYPE_INFO,
1192 "STUN server returned %s:%d\n",
1193 inet_ntoa (answer.sin_addr),
1194 ntohs (answer.sin_port));
1195 /* Remove old IPs from previous STUN calls */
1196 remove_from_address_list_by_source (h,
1197 LAL_EXTERNAL_STUN_IP);
1198 /* Add new IP from STUN packet */
1199 add_to_address_list (h,
1200 LAL_EXTERNAL_STUN_IP,
1201 (const struct sockaddr *) &answer,
1202 sizeof (struct sockaddr_in));
1203 h->waiting_stun = GNUNET_NO;
1209 * Task to do a STUN request
1211 * @param cls the NAT handle
1212 * @param tc scheduler context
1215 process_stun (void *cls,
1216 const struct GNUNET_SCHEDULER_TaskContext *tc)
1218 struct GNUNET_NAT_Handle *h = cls;
1219 struct StunServerList* elem = h->actual_stun_server;
1221 h->stun_task = NULL;
1222 /* Make the request */
1223 LOG (GNUNET_ERROR_TYPE_INFO,
1224 "I will request the stun server %s:%i\n",
1227 if (NULL != h->stun_request)
1229 GNUNET_NAT_stun_make_request_cancel (h->stun_request);
1230 h->stun_request = NULL;
1232 h->waiting_stun = GNUNET_NO;
1234 = GNUNET_NAT_stun_make_request (elem->address,
1237 &stun_request_callback,
1239 if (NULL == h->stun_request)
1241 LOG (GNUNET_ERROR_TYPE_ERROR,
1242 "STUN request to %s:%i failed\n",
1247 GNUNET_SCHEDULER_add_delayed (h->stun_frequency,
1251 /* Set actual Server*/
1252 if (NULL != elem->next)
1254 h->actual_stun_server = elem->next;
1258 h->actual_stun_server = h->stun_servers_head;
1264 * Task to do a lookup on our hostname for IP addresses.
1266 * @param cls the NAT handle
1267 * @param tc scheduler context
1270 resolve_hostname (void *cls,
1271 const struct GNUNET_SCHEDULER_TaskContext *tc)
1273 struct GNUNET_NAT_Handle *h = cls;
1275 h->hostname_task = NULL;
1276 remove_from_address_list_by_source (h, LAL_HOSTNAME_DNS);
1278 GNUNET_RESOLVER_hostname_resolve (AF_UNSPEC, HOSTNAME_RESOLVE_TIMEOUT,
1279 &process_hostname_ip, h);
1284 * Task to do DNS lookup on our external hostname to
1285 * get DynDNS-IP addresses.
1287 * @param cls the NAT handle
1288 * @param tc scheduler context
1291 resolve_dns (void *cls,
1292 const struct GNUNET_SCHEDULER_TaskContext *tc)
1294 struct GNUNET_NAT_Handle *h = cls;
1295 struct LocalAddressList *pos;
1298 for (pos = h->lal_head; NULL != pos; pos = pos->next)
1299 if (pos->source == LAL_EXTERNAL_IP)
1300 pos->source = LAL_EXTERNAL_IP_OLD;
1301 LOG (GNUNET_ERROR_TYPE_DEBUG,
1302 "Resolving external address `%s'\n",
1303 h->external_address);
1305 GNUNET_RESOLVER_ip_get (h->external_address, AF_INET,
1306 GNUNET_TIME_UNIT_MINUTES,
1307 &process_external_ip, h);
1312 * Add or remove UPnP-mapped addresses.
1314 * @param cls the `struct GNUNET_NAT_Handle`
1315 * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
1316 * the previous (now invalid) one
1317 * @param addr either the previous or the new public IP address
1318 * @param addrlen actual lenght of @a addr
1319 * @param ret GNUNET_NAT_ERROR_SUCCESS on success, otherwise an error code
1322 upnp_add (void *cls,
1324 const struct sockaddr *addr,
1326 enum GNUNET_NAT_StatusCode ret)
1328 struct GNUNET_NAT_Handle *h = cls;
1329 struct LocalAddressList *pos;
1330 struct LocalAddressList *next;
1333 if (GNUNET_NAT_ERROR_SUCCESS != ret)
1335 /* Error while running upnp client */
1336 LOG (GNUNET_ERROR_TYPE_ERROR,
1337 _("Error while running upnp client:\n"));
1338 //FIXME: convert error code to string
1342 if (GNUNET_YES == add_remove)
1344 add_to_address_list (h,
1350 else if (GNUNET_NO == add_remove)
1352 /* remove address */
1354 while (NULL != (pos = next))
1357 if ((pos->source != LAL_UPNP) || (pos->addrlen != addrlen) ||
1358 (0 != memcmp (&pos[1], addr, addrlen)))
1360 GNUNET_CONTAINER_DLL_remove (h->lal_head,
1363 if (NULL != h->address_callback)
1364 h->address_callback (h->callback_cls,
1366 (const struct sockaddr *) &pos[1],
1369 return; /* only remove once */
1371 /* asked to remove address that does not exist */
1372 LOG (GNUNET_ERROR_TYPE_ERROR,
1373 "Asked to remove unkown address `%s'\n",
1374 GNUNET_a2s(addr, addrlen));
1386 * Try to add a port mapping using UPnP.
1388 * @param h overall NAT handle
1389 * @param port port to map with UPnP
1392 add_minis (struct GNUNET_NAT_Handle *h,
1395 struct MiniList *ml;
1400 if (port == ml->port)
1401 return; /* already got this port */
1405 ml = GNUNET_new (struct MiniList);
1407 ml->mini = GNUNET_NAT_mini_map_start (port, h->is_tcp, &upnp_add, h);
1409 if (NULL == ml->mini)
1411 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1412 _("Failed to run upnp client for port %u\n"), ml->port);
1417 GNUNET_CONTAINER_DLL_insert (h->mini_head,
1424 * Task to add addresses from original bind to set of valid addrs.
1426 * @param h the NAT handle
1429 add_from_bind (struct GNUNET_NAT_Handle *h)
1431 static struct in6_addr any = IN6ADDR_ANY_INIT;
1434 struct sockaddr *sa;
1435 const struct sockaddr_in *v4;
1437 for (i = 0; i < h->num_local_addrs; i++)
1439 sa = h->local_addrs[i];
1440 switch (sa->sa_family)
1443 if (sizeof (struct sockaddr_in) != h->local_addrlens[i])
1448 v4 = (const struct sockaddr_in *) sa;
1449 if (0 != v4->sin_addr.s_addr)
1450 add_to_address_list (h,
1451 LAL_BINDTO_ADDRESS, sa,
1452 sizeof (struct sockaddr_in));
1455 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1456 "Running upnp client for address `%s'\n",
1457 GNUNET_a2s (sa,sizeof (struct sockaddr_in)));
1458 add_minis (h, ntohs (v4->sin_port));
1462 if (sizeof (struct sockaddr_in6) != h->local_addrlens[i])
1468 memcmp (&((const struct sockaddr_in6 *) sa)->sin6_addr,
1470 sizeof (struct in6_addr)))
1471 add_to_address_list (h,
1474 sizeof (struct sockaddr_in6));
1484 * Attempt to enable port redirection and detect public IP address contacting
1485 * UPnP or NAT-PMP routers on the local network. Use addr to specify to which
1486 * of the local host's addresses should the external port be mapped. The port
1487 * is taken from the corresponding sockaddr_in[6] field.
1489 * @param cfg configuration to use
1490 * @param is_tcp #GNUNET_YES for TCP, #GNUNET_NO for UDP
1491 * @param adv_port advertised port (port we are either bound to or that our OS
1492 * locally performs redirection from to our bound port).
1493 * @param num_addrs number of addresses in @a addrs
1494 * @param addrs the local addresses packets should be redirected to
1495 * @param addrlens actual lengths of the addresses
1496 * @param address_callback function to call everytime the public IP address changes
1497 * @param reversal_callback function to call if someone wants connection reversal from us
1498 * @param callback_cls closure for callbacks
1499 * @param sock used socket
1500 * @return NULL on error, otherwise handle that can be used to unregister
1502 struct GNUNET_NAT_Handle *
1503 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
1506 unsigned int num_addrs,
1507 const struct sockaddr **addrs,
1508 const socklen_t *addrlens,
1509 GNUNET_NAT_AddressCallback address_callback,
1510 GNUNET_NAT_ReversalCallback reversal_callback,
1512 struct GNUNET_NETWORK_Handle *sock)
1514 struct GNUNET_NAT_Handle *h;
1515 struct in_addr in_addr;
1519 LOG (GNUNET_ERROR_TYPE_DEBUG,
1520 "Registered with NAT service at port %u with %u IP bound local addresses\n",
1521 (unsigned int) adv_port, num_addrs);
1522 h = GNUNET_new (struct GNUNET_NAT_Handle);
1523 h->server_retry_delay = GNUNET_TIME_UNIT_SECONDS;
1526 h->address_callback = address_callback;
1527 h->reversal_callback = reversal_callback;
1528 h->callback_cls = callback_cls;
1529 h->num_local_addrs = num_addrs;
1530 h->adv_port = adv_port;
1533 h->local_addrs = GNUNET_malloc (num_addrs * sizeof (struct sockaddr *));
1534 h->local_addrlens = GNUNET_malloc (num_addrs * sizeof (socklen_t));
1535 for (i = 0; i < num_addrs; i++)
1537 GNUNET_assert (addrlens[i] > 0);
1538 GNUNET_assert (addrs[i] != NULL);
1539 h->local_addrlens[i] = addrlens[i];
1540 h->local_addrs[i] = GNUNET_malloc (addrlens[i]);
1541 memcpy (h->local_addrs[i], addrs[i], addrlens[i]);
1545 GNUNET_CONFIGURATION_have_value (cfg, "nat", "INTERNAL_ADDRESS"))
1547 (void) GNUNET_CONFIGURATION_get_value_string (cfg, "nat",
1549 &h->internal_address);
1551 if ((h->internal_address != NULL) &&
1552 (inet_pton (AF_INET, h->internal_address, &in_addr) != 1))
1554 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1555 "nat", "INTERNAL_ADDRESS",
1557 GNUNET_free (h->internal_address);
1558 h->internal_address = NULL;
1562 GNUNET_CONFIGURATION_have_value (cfg, "nat", "EXTERNAL_ADDRESS"))
1564 (void) GNUNET_CONFIGURATION_get_value_string (cfg, "nat",
1566 &h->external_address);
1569 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "BEHIND_NAT");
1571 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "PUNCHED_NAT");
1572 h->enable_nat_client =
1573 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "ENABLE_ICMP_CLIENT");
1574 h->enable_nat_server =
1575 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "ENABLE_ICMP_SERVER");
1577 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "ENABLE_UPNP");
1578 h->use_localaddresses =
1579 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "USE_LOCALADDR");
1580 h->return_localaddress =
1581 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat",
1582 "RETURN_LOCAL_ADDRESSES");
1585 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "USE_HOSTNAME");
1587 GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "DISABLEV6");
1589 GNUNET_CONFIGURATION_get_value_time (cfg, "nat", "DYNDNS_FREQUENCY",
1590 &h->dyndns_frequency))
1591 h->dyndns_frequency = DYNDNS_FREQUENCY;
1593 GNUNET_CONFIGURATION_get_value_time (cfg, "nat", "IFC_SCAN_FREQUENCY",
1594 &h->ifc_scan_frequency))
1595 h->ifc_scan_frequency = IFC_SCAN_FREQUENCY;
1597 GNUNET_CONFIGURATION_get_value_time (cfg, "nat", "HOSTNAME_DNS_FREQUENCY",
1598 &h->hostname_dns_frequency))
1599 h->hostname_dns_frequency = HOSTNAME_DNS_FREQUENCY;
1601 if (NULL == reversal_callback)
1602 h->enable_nat_server = GNUNET_NO;
1604 /* Check for UPnP client, disable immediately if not available */
1605 if ( (GNUNET_YES == h->enable_upnp) &&
1607 GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL)) )
1609 LOG (GNUNET_ERROR_TYPE_ERROR,
1610 _("UPnP enabled in configuration, but UPnP client `upnpc` command not found, disabling UPnP \n"));
1611 h->enable_upnp = GNUNET_NO;
1616 GNUNET_CONFIGURATION_get_value_yesno (cfg,
1621 GNUNET_CONFIGURATION_get_value_time (cfg,
1624 &h->stun_frequency))
1625 h->stun_frequency = STUN_FREQUENCY;
1628 /* Check if NAT was hole-punched */
1629 if ((NULL != h->address_callback) &&
1630 (NULL != h->external_address) &&
1631 (GNUNET_YES == h->nat_punched))
1633 h->dns_task = GNUNET_SCHEDULER_add_now (&resolve_dns, h);
1634 h->enable_nat_server = GNUNET_NO;
1635 h->enable_upnp = GNUNET_NO;
1636 h->use_stun = GNUNET_NO;
1640 LOG (GNUNET_ERROR_TYPE_DEBUG,
1641 "No external IP address given to add to our list of addresses\n");
1644 /* ENABLE STUN ONLY ON UDP */
1655 h->actual_stun_server = NULL;
1656 stun_servers = NULL;
1657 /* Lets process the servers*/
1658 (void) GNUNET_CONFIGURATION_get_value_string (cfg,
1663 h->stun_servers_head = NULL;
1664 h->stun_servers_tail = NULL;
1665 h->actual_stun_server = NULL;
1666 if ( (NULL != stun_servers) &&
1667 (strlen (stun_servers) > 0) )
1670 for (pos = strlen (stun_servers) - 1;
1674 if (stun_servers[pos] == ':')
1677 stun_servers[pos] = '\0';
1680 if ((stun_servers[pos] == ' ') || (0 == pos))
1682 struct StunServerList *ml;
1684 /*Check if we do have a port*/
1685 if((0 == pos_port) || (pos_port <= pos))
1687 LOG (GNUNET_ERROR_TYPE_WARNING,
1688 "STUN server format mistake\n");
1692 ml = GNUNET_new (struct StunServerList);
1693 ml->port = atoi (&stun_servers[pos_port]);
1695 /* Remove trailing space */
1696 if(stun_servers[pos] == ' ')
1697 ml->address = GNUNET_strdup (&stun_servers[pos + 1]);
1699 ml->address = GNUNET_strdup (&stun_servers[pos]);
1700 LOG (GNUNET_ERROR_TYPE_DEBUG,
1701 "Found STUN server %s:%i\n",
1704 GNUNET_CONTAINER_DLL_insert (h->stun_servers_head,
1705 h->stun_servers_tail,
1712 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
1718 /* Set the actual STUN server*/
1719 h->actual_stun_server = h->stun_servers_head;
1721 h->stun_task = GNUNET_SCHEDULER_add_now (&process_stun,
1723 GNUNET_free_non_null (stun_servers);
1727 /* Test for SUID binaries */
1728 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
1729 if ( (GNUNET_YES == h->behind_nat) &&
1730 (GNUNET_YES == h->enable_nat_server) &&
1732 GNUNET_OS_check_helper_binary (binary,
1736 // use localhost as source for that one udp-port, ok for testing
1737 h->enable_nat_server = GNUNET_NO;
1738 LOG (GNUNET_ERROR_TYPE_WARNING,
1739 _("Configuration requires `%s', but binary is not installed properly (SUID bit not set). Option disabled.\n"),
1740 "gnunet-helper-nat-server");
1742 GNUNET_free (binary);
1743 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
1744 if ((GNUNET_YES == h->enable_nat_client) &&
1746 GNUNET_OS_check_helper_binary (binary,
1748 "-d 127.0.0.1 127.0.0.2 42"))) /* none of these parameters are actually used in privilege testing mode */
1750 h->enable_nat_client = GNUNET_NO;
1751 LOG (GNUNET_ERROR_TYPE_WARNING,
1752 _("Configuration requires `%s', but binary is not installed properly (SUID bit not set). Option disabled.\n"),
1753 "gnunet-helper-nat-client");
1755 GNUNET_free (binary);
1756 start_gnunet_nat_server (h);
1758 /* FIXME: add support for UPnP, etc */
1760 if (NULL != h->address_callback)
1762 h->ifc_task = GNUNET_SCHEDULER_add_now (&list_interfaces,
1764 if (GNUNET_YES == h->use_hostname)
1765 h->hostname_task = GNUNET_SCHEDULER_add_now (&resolve_hostname,
1775 * Stop port redirection and public IP address detection for the given handle.
1776 * This frees the handle, after having sent the needed commands to close open ports.
1778 * @param h the handle to stop
1781 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h)
1784 struct LocalAddressList *lal;
1785 struct MiniList *ml;
1787 LOG (GNUNET_ERROR_TYPE_DEBUG,
1788 "NAT unregister called\n");
1789 while (NULL != (ml = h->mini_head))
1791 GNUNET_CONTAINER_DLL_remove (h->mini_head,
1794 if (NULL != ml->mini)
1795 GNUNET_NAT_mini_map_stop (ml->mini);
1798 if (NULL != h->ext_dns)
1800 GNUNET_RESOLVER_request_cancel (h->ext_dns);
1803 if (NULL != h->hostname_dns)
1805 GNUNET_RESOLVER_request_cancel (h->hostname_dns);
1806 h->hostname_dns = NULL;
1808 if (NULL != h->server_read_task)
1810 GNUNET_SCHEDULER_cancel (h->server_read_task);
1811 h->server_read_task = NULL;
1813 if (NULL != h->ifc_task)
1815 GNUNET_SCHEDULER_cancel (h->ifc_task);
1818 if (NULL != h->hostname_task)
1820 GNUNET_SCHEDULER_cancel (h->hostname_task);
1821 h->hostname_task = NULL;
1823 if (NULL != h->dns_task)
1825 GNUNET_SCHEDULER_cancel (h->dns_task);
1828 if (NULL != h->stun_task)
1830 GNUNET_SCHEDULER_cancel (h->stun_task);
1831 h->stun_task = NULL;
1833 if (NULL != h->stun_request)
1835 GNUNET_NAT_stun_make_request_cancel (h->stun_request);
1836 h->stun_request = NULL;
1838 if (NULL != h->server_proc)
1840 if (0 != GNUNET_OS_process_kill (h->server_proc,
1842 GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING,
1845 GNUNET_OS_process_wait (h->server_proc);
1846 GNUNET_OS_process_destroy (h->server_proc);
1847 h->server_proc = NULL;
1848 GNUNET_DISK_pipe_close (h->server_stdout);
1849 h->server_stdout = NULL;
1850 h->server_stdout_handle = NULL;
1852 if (NULL != h->server_stdout)
1854 GNUNET_DISK_pipe_close (h->server_stdout);
1855 h->server_stdout = NULL;
1856 h->server_stdout_handle = NULL;
1858 while (NULL != (lal = h->lal_head))
1860 GNUNET_CONTAINER_DLL_remove (h->lal_head,
1863 if (NULL != h->address_callback)
1864 h->address_callback (h->callback_cls,
1866 (const struct sockaddr *) &lal[1],
1870 for (i = 0; i < h->num_local_addrs; i++)
1871 GNUNET_free (h->local_addrs[i]);
1872 GNUNET_free_non_null (h->local_addrs);
1873 GNUNET_free_non_null (h->local_addrlens);
1874 GNUNET_free_non_null (h->external_address);
1875 GNUNET_free_non_null (h->internal_address);
1881 * We learned about a peer (possibly behind NAT) so run the
1882 * gnunet-helper-nat-client to send dummy ICMP responses to cause
1883 * that peer to connect to us (connection reversal).
1885 * @param h handle (used for configuration)
1886 * @param sa the address of the peer (IPv4-only)
1887 * @return #GNUNET_SYSERR on error, #GNUNET_NO if nat client is disabled,
1888 * #GNUNET_OK otherwise
1891 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
1892 const struct sockaddr_in *sa)
1896 char inet4[INET_ADDRSTRLEN];
1897 char port_as_string[6];
1898 struct GNUNET_OS_Process *proc;
1901 if (GNUNET_YES != h->enable_nat_client)
1902 return GNUNET_NO; /* not permitted / possible */
1904 if (h->internal_address == NULL)
1906 LOG (GNUNET_ERROR_TYPE_WARNING, "nat",
1907 _("Internal IP address not known, cannot use ICMP NAT traversal method\n"));
1908 return GNUNET_SYSERR;
1910 GNUNET_assert (sa->sin_family == AF_INET);
1911 if (NULL == inet_ntop (AF_INET, &sa->sin_addr, inet4, INET_ADDRSTRLEN))
1913 GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING,
1916 return GNUNET_SYSERR;
1918 GNUNET_snprintf (port_as_string,
1919 sizeof (port_as_string),
1922 LOG (GNUNET_ERROR_TYPE_DEBUG,
1923 _("Running gnunet-helper-nat-client %s %s %u\n"),
1924 h->internal_address,
1926 (unsigned int) h->adv_port);
1927 binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
1929 GNUNET_OS_start_process (GNUNET_NO, 0, NULL, NULL, NULL,
1931 "gnunet-helper-nat-client",
1932 h->internal_address,
1933 inet4, port_as_string, NULL);
1934 GNUNET_free (binary);
1936 return GNUNET_SYSERR;
1937 /* we know that the gnunet-helper-nat-client will terminate virtually
1939 GNUNET_OS_process_wait (proc);
1940 GNUNET_OS_process_destroy (proc);
1946 * Test if the given address is (currently) a plausible IP address for this peer.
1948 * @param h the handle returned by register
1949 * @param addr IP address to test (IPv4 or IPv6)
1950 * @param addrlen number of bytes in @a addr
1951 * @return #GNUNET_YES if the address is plausible,
1952 * #GNUNET_NO if the address is not plausible,
1953 * #GNUNET_SYSERR if the address is malformed
1956 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
1960 struct LocalAddressList *pos;
1961 const struct sockaddr_in *in4;
1962 const struct sockaddr_in6 *in6;
1963 char pbuf[INET6_ADDRSTRLEN+1];
1965 if ((addrlen != sizeof (struct in_addr)) &&
1966 (addrlen != sizeof (struct in6_addr)))
1969 return GNUNET_SYSERR;
1971 for (pos = h->lal_head; NULL != pos; pos = pos->next)
1973 if (pos->addrlen == sizeof (struct sockaddr_in))
1975 in4 = (struct sockaddr_in *) &pos[1];
1976 if ((addrlen == sizeof (struct in_addr)) &&
1977 (0 == memcmp (&in4->sin_addr, addr, sizeof (struct in_addr))))
1980 else if (pos->addrlen == sizeof (struct sockaddr_in6))
1982 in6 = (struct sockaddr_in6 *) &pos[1];
1983 if ((addrlen == sizeof (struct in6_addr)) &&
1984 (0 == memcmp (&in6->sin6_addr, addr, sizeof (struct in6_addr))))
1992 LOG (GNUNET_ERROR_TYPE_WARNING,
1993 "Asked to validate one of my addresses (%s) and validation failed!\n",
1994 inet_ntop ((addrlen == sizeof(struct in_addr))
1998 pbuf, sizeof (pbuf)));
2003 * Converts enum GNUNET_NAT_StatusCode to a string
2005 * @param err error code to resolve to a string
2006 * @return pointer to a static string containing the error code
2009 GNUNET_NAT_status2string (enum GNUNET_NAT_StatusCode err)
2013 case GNUNET_NAT_ERROR_SUCCESS:
2014 return _ ("Operation Successful");
2015 case GNUNET_NAT_ERROR_IPC_FAILURE:
2016 return _ ("Internal Failure (IPC, ...)");
2017 case GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR:
2018 return _ ("Failure in network subsystem, check permissions.");
2019 case GNUNET_NAT_ERROR_TIMEOUT:
2020 return _ ("Encountered timeout while performing operation");
2021 case GNUNET_NAT_ERROR_NOT_ONLINE:
2022 return _ ("detected that we are offline");
2023 case GNUNET_NAT_ERROR_UPNPC_NOT_FOUND:
2024 return _ ("`upnpc` command not found");
2025 case GNUNET_NAT_ERROR_UPNPC_FAILED:
2026 return _ ("Failed to run `upnpc` command");
2027 case GNUNET_NAT_ERROR_UPNPC_TIMEOUT:
2028 return _ ("`upnpc' command took too long, process killed");
2029 case GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED:
2030 return _ ("`upnpc' command failed to establish port mapping");
2031 case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND:
2032 return _ ("`external-ip' command not found");
2033 case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED:
2034 return _ ("Failed to run `external-ip` command");
2035 case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID:
2036 return _ ("`external-ip' command output invalid");
2037 case GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID:
2038 return _ ("no valid address was returned by `external-ip'");
2039 case GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO:
2040 return _ ("Could not determine interface with internal/local network address");
2041 case GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND:
2042 return _ ("No functioning gnunet-helper-nat-server installation found");
2043 case GNUNET_NAT_ERROR_NAT_TEST_START_FAILED:
2044 return _ ("NAT test could not be initialized");
2045 case GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT:
2046 return _ ("NAT test timeout reached");
2047 case GNUNET_NAT_ERROR_NAT_REGISTER_FAILED:
2048 return _ ("could not register NAT");
2049 case GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND:
2050 return _ ("No working gnunet-helper-nat-client installation found");
2054 return "unknown status code";