b0ec4fe19734eb919b3bef733eee37a321bdfe47
[oweals/gnunet.git] / src / nat / nat.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
4
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.
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      General Public License for more details.
14
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.
19 */
20
21 /**
22  * @file nat/nat.c
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
27  */
28 #include "platform.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_resolver_service.h"
31 #include "gnunet_nat_lib.h"
32 #include "nat.h"
33
34 #define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
35
36 /**
37  * How often do we scan for changes in our IP address from our local
38  * interfaces?
39  */
40 #define IFC_SCAN_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
41
42 /**
43  * How often do we scan for changes in how our hostname resolves?
44  */
45 #define HOSTNAME_DNS_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 20)
46
47
48 /**
49  * How often do we scan for changes in how our external (dyndns) hostname resolves?
50  */
51 #define DYNDNS_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 7)
52
53 /**
54  * How long until we give up trying to resolve our own hostname?
55  */
56 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
57
58
59 /**
60  * How often do we check a STUN server ?
61  */
62 #define STUN_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
63
64
65 /**
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.
70  */
71 enum LocalAddressSource
72 {
73   /**
74    * Address was obtained by DNS resolution of the external hostname
75    * given in the configuration (i.e. hole-punched DynDNS setup).
76    */
77   LAL_EXTERNAL_IP,
78
79    /**
80    * Address was obtained by an external STUN server
81    */
82   LAL_EXTERNAL_STUN_IP,
83
84   /**
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).
88    */
89   LAL_EXTERNAL_IP_OLD,
90
91   /**
92    * Address was obtained by looking up our own hostname in DNS.
93    */
94   LAL_HOSTNAME_DNS,
95
96   /**
97    * Address was obtained by scanning our hosts's network interfaces
98    * and taking their address (no DNS involved).
99    */
100   LAL_INTERFACE_ADDRESS,
101
102   /**
103    * Addresses we were explicitly bound to.
104    */
105   LAL_BINDTO_ADDRESS,
106
107   /**
108    * Addresses from UPnP or PMP
109    */
110   LAL_UPNP,
111
112   /**
113    * End of the list.
114    */
115   LAL_END
116 };
117
118
119 /**
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).
125  */
126 struct LocalAddressList
127 {
128   /**
129    * This is a linked list.
130    */
131   struct LocalAddressList *next;
132
133   /**
134    * Previous entry.
135    */
136   struct LocalAddressList *prev;
137
138   /**
139    * Number of bytes of address that follow.
140    */
141   socklen_t addrlen;
142
143   /**
144    * Origin of the local address.
145    */
146   enum LocalAddressSource source;
147 };
148
149
150 /**
151  * Handle for miniupnp-based NAT traversal actions.
152  */
153 struct MiniList
154 {
155
156   /**
157    * Doubly-linked list.
158    */
159   struct MiniList *next;
160
161   /**
162    * Doubly-linked list.
163    */
164   struct MiniList *prev;
165
166   /**
167    * Handle to mini-action.
168    */
169   struct GNUNET_NAT_MiniHandle *mini;
170
171   /**
172    * Local port number that was mapped.
173    */
174   uint16_t port;
175
176 };
177
178
179 /**
180  * List of STUN servers
181  */
182 struct StunServerList
183 {
184
185   /**
186    * Doubly-linked list.
187    */
188   struct StunServerList *next;
189
190   /**
191    * Doubly-linked list.
192    */
193   struct StunServerList *prev;
194
195   /**
196    * Address
197    */
198   char * address;
199
200   /**
201    * Server Port
202    */
203   uint16_t port;
204
205 };
206
207
208 /**
209  * Handle for active NAT registrations.
210  */
211 struct GNUNET_NAT_Handle
212 {
213
214   /**
215    * Configuration to use.
216    */
217   const struct GNUNET_CONFIGURATION_Handle *cfg;
218
219   /**
220    * Function to call when we learn about a new address.
221    */
222   GNUNET_NAT_AddressCallback address_callback;
223
224   /**
225    * Function to call when we notice another peer asking for
226    * connection reversal.
227    */
228   GNUNET_NAT_ReversalCallback reversal_callback;
229
230   /**
231    * Closure for callbacks (@e address_callback and @e reversal_callback)
232    */
233   void *callback_cls;
234
235   /**
236    * Handle for (DYN)DNS lookup of our external IP.
237    */
238   struct GNUNET_RESOLVER_RequestHandle *ext_dns;
239
240   /**
241    * Handle for request of hostname resolution, non-NULL if pending.
242    */
243   struct GNUNET_RESOLVER_RequestHandle *hostname_dns;
244
245   /**
246    * stdout pipe handle for the gnunet-helper-nat-server process
247    */
248   struct GNUNET_DISK_PipeHandle *server_stdout;
249
250   /**
251    * stdout file handle (for reading) for the gnunet-helper-nat-server process
252    */
253   const struct GNUNET_DISK_FileHandle *server_stdout_handle;
254
255   /**
256    * Linked list of currently valid addresses (head).
257    */
258   struct LocalAddressList *lal_head;
259
260   /**
261    * Linked list of currently valid addresses (tail).
262    */
263   struct LocalAddressList *lal_tail;
264
265   /**
266    * How long do we wait for restarting a crashed gnunet-helper-nat-server?
267    */
268   struct GNUNET_TIME_Relative server_retry_delay;
269
270   /**
271    * ID of select gnunet-helper-nat-server stdout read task
272    */
273   struct GNUNET_SCHEDULER_Task *server_read_task;
274
275   /**
276    * ID of interface IP-scan task
277    */
278   struct GNUNET_SCHEDULER_Task *ifc_task;
279
280   /**
281    * ID of hostname DNS lookup task
282    */
283   struct GNUNET_SCHEDULER_Task *hostname_task;
284
285   /**
286    * ID of DynDNS lookup task
287    */
288   struct GNUNET_SCHEDULER_Task *dns_task;
289
290   /**
291    * Active STUN request, if any.
292    */
293   struct GNUNET_NAT_STUN_Handle *stun_request;
294
295   /**
296    * How often do we scan for changes in our IP address from our local
297    * interfaces?
298    */
299   struct GNUNET_TIME_Relative ifc_scan_frequency;
300
301   /**
302    * How often do we scan for changes in how our hostname resolves?
303    */
304   struct GNUNET_TIME_Relative hostname_dns_frequency;
305
306   /**
307    * How often do we scan for changes in how our external (dyndns) hostname resolves?
308    */
309   struct GNUNET_TIME_Relative dyndns_frequency;
310
311   /**
312    * The process id of the server process (if behind NAT)
313    */
314   struct GNUNET_OS_Process *server_proc;
315
316   /**
317    * LAN address as passed by the caller (array).
318    */
319   struct sockaddr **local_addrs;
320
321   /**
322    * Length of the @e local_addrs.
323    */
324   socklen_t *local_addrlens;
325
326   /**
327    * List of handles for UPnP-traversal, one per local port (if
328    * not IPv6-only).
329    */
330   struct MiniList *mini_head;
331
332   /**
333    * List of handles for UPnP-traversal, one per local port (if
334    * not IPv6-only).
335    */
336   struct MiniList *mini_tail;
337
338   /**
339    * Number of entries in 'local_addrs' array.
340    */
341   unsigned int num_local_addrs;
342
343   /**
344    * Our external address (according to config, UPnP may disagree...),
345    * in dotted decimal notation, IPv4-only. Or NULL if not known.
346    */
347   char *external_address;
348
349   /**
350    * Presumably our internal address (according to config)
351    */
352   char *internal_address;
353
354   /**
355    * Is this transport configured to be behind a NAT?
356    */
357   int behind_nat;
358
359   /**
360    * Has the NAT been punched? (according to config)
361    */
362   int nat_punched;
363
364   /**
365    * Is this transport configured to allow connections to NAT'd peers?
366    */
367   int enable_nat_client;
368
369   /**
370    * Should we run the gnunet-helper-nat-server?
371    */
372   int enable_nat_server;
373
374   /**
375    * Are we allowed to try UPnP/PMP for NAT traversal?
376    */
377   int enable_upnp;
378
379   /**
380    * Should we use local addresses (loopback)? (according to config)
381    */
382   int use_localaddresses;
383
384   /**
385    * Should we return local addresses to clients
386    */
387   int return_localaddress;
388
389   /**
390    * Should we do a DNS lookup of our hostname to find out our own IP?
391    */
392   int use_hostname;
393
394   /**
395    * Is using IPv6 disabled?
396    */
397   int disable_ipv6;
398
399   /**
400    * Is this TCP or UDP?
401    */
402   int is_tcp;
403
404   /**
405    * Port we advertise to the outside.
406    */
407   uint16_t adv_port;
408
409   /**
410    * Should we use STUN ?
411    */
412   int use_stun;
413
414   /**
415    * How often should we check STUN ?
416    */
417   struct GNUNET_TIME_Relative stun_frequency;
418
419   /**
420    * STUN socket
421    */
422   struct GNUNET_NETWORK_Handle* socket;
423
424   /*
425    * Am I waiting for a STUN response ?
426    */
427   int waiting_stun;
428
429   /**
430    * STUN request task
431    */
432   struct GNUNET_SCHEDULER_Task * stun_task;
433
434   /**
435    * Head of List of STUN servers
436    */
437   struct StunServerList *stun_servers_head;
438
439   /**
440    * Tail of List of STUN servers
441    */
442   struct StunServerList *stun_servers_tail;
443
444   /**
445    * Actual STUN Server
446    */
447   struct StunServerList *actual_stun_server;
448
449 };
450
451
452 /**
453  * Try to start the gnunet-helper-nat-server (if it is not
454  * already running).
455  *
456  * @param h handle to NAT
457  */
458 static void
459 start_gnunet_nat_server (struct GNUNET_NAT_Handle *h);
460
461
462 /**
463  * Call task to process STUN
464  *
465  * @param cls handle to NAT
466  * @param tc TaskContext
467  */
468 static void
469 process_stun (void *cls,
470               const struct GNUNET_SCHEDULER_TaskContext *tc);
471
472
473 /**
474  * Remove all addresses from the list of 'local' addresses
475  * that originated from the given source.
476  *
477  * @param h handle to NAT
478  * @param src source that identifies addresses to remove
479  */
480 static void
481 remove_from_address_list_by_source (struct GNUNET_NAT_Handle *h,
482                                     enum LocalAddressSource src)
483 {
484   struct LocalAddressList *pos;
485   struct LocalAddressList *next;
486
487   next = h->lal_head;
488   while (NULL != (pos = next))
489   {
490     next = pos->next;
491     if (pos->source != src)
492       continue;
493     GNUNET_CONTAINER_DLL_remove (h->lal_head,
494                                  h->lal_tail,
495                                  pos);
496     if (NULL != h->address_callback)
497       h->address_callback (h->callback_cls,
498                            GNUNET_NO,
499                            (const struct sockaddr *) &pos[1],
500                            pos->addrlen);
501     GNUNET_free (pos);
502   }
503 }
504
505
506 /**
507  * Add the given address to the list of 'local' addresses, thereby
508  * making it a 'legal' address for this peer to have.
509  *
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
514  */
515 static void
516 add_to_address_list_as_is (struct GNUNET_NAT_Handle *h,
517                            enum LocalAddressSource src,
518                            const struct sockaddr *arg,
519                            socklen_t arg_size)
520 {
521   struct LocalAddressList *lal;
522
523   lal = GNUNET_malloc (sizeof (struct LocalAddressList) + arg_size);
524   memcpy (&lal[1], arg, arg_size);
525   lal->addrlen = arg_size;
526   lal->source = src;
527   GNUNET_CONTAINER_DLL_insert (h->lal_head,
528                                h->lal_tail,
529                                lal);
530   LOG (GNUNET_ERROR_TYPE_DEBUG,
531        "Adding address `%s' from source %d\n",
532        GNUNET_a2s (arg, arg_size),
533        src);
534   if (NULL != h->address_callback)
535     h->address_callback (h->callback_cls,
536                          GNUNET_YES,
537                          arg,
538                          arg_size);
539 }
540
541
542 /**
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).
547  *
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
552  */
553 static void
554 add_to_address_list (struct GNUNET_NAT_Handle *h,
555                      enum LocalAddressSource src,
556                      const struct sockaddr *arg,
557                      socklen_t arg_size)
558 {
559   struct sockaddr_in s4;
560   const struct sockaddr_in *in4;
561   struct sockaddr_in6 s6;
562   const struct sockaddr_in6 *in6;
563
564   if (arg_size == sizeof (struct sockaddr_in))
565   {
566     in4 = (const struct sockaddr_in *) arg;
567     s4 = *in4;
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)
572     {
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));
577     }
578   }
579   else if (arg_size == sizeof (struct sockaddr_in6))
580   {
581     if (GNUNET_YES != h->disable_ipv6)
582     {
583       in6 = (const struct sockaddr_in6 *) arg;
584       s6 = *in6;
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));
588     }
589   }
590   else
591   {
592     GNUNET_assert (0);
593   }
594 }
595
596
597 /**
598  * Add the given IP address to the list of 'local' addresses, thereby
599  * making it a 'legal' address for this peer to have.
600  *
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
605  */
606 static void
607 add_ip_to_address_list (struct GNUNET_NAT_Handle *h,
608                         enum LocalAddressSource src, const void *addr,
609                         socklen_t addrlen)
610 {
611   struct sockaddr_in s4;
612   const struct in_addr *in4;
613   struct sockaddr_in6 s6;
614   const struct in6_addr *in6;
615
616   if (addrlen == sizeof (struct in_addr))
617   {
618     in4 = (const struct in_addr *) addr;
619     memset (&s4, 0, sizeof (s4));
620     s4.sin_family = AF_INET;
621     s4.sin_port = 0;
622 #if HAVE_SOCKADDR_IN_SIN_LEN
623     s4.sin_len = (u_char) sizeof (struct sockaddr_in);
624 #endif
625     s4.sin_addr = *in4;
626     add_to_address_list (h, src, (const struct sockaddr *) &s4,
627                          sizeof (struct sockaddr_in));
628     if (GNUNET_YES == h->enable_nat_server)
629     {
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));
634
635     }
636   }
637   else if (addrlen == sizeof (struct in6_addr))
638   {
639     if (GNUNET_YES != h->disable_ipv6)
640     {
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);
647 #endif
648       s6.sin6_addr = *in6;
649       add_to_address_list (h, src, (const struct sockaddr *) &s6,
650                            sizeof (struct sockaddr_in6));
651     }
652   }
653   else
654   {
655     GNUNET_assert (0);
656   }
657 }
658
659
660 /**
661  * Task to do DNS lookup on our external hostname to
662  * get DynDNS-IP addresses.
663  *
664  * @param cls the NAT handle
665  * @param tc scheduler context
666  */
667 static void
668 resolve_dns (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
669
670
671 /**
672  * Our (external) hostname was resolved and the configuration says that
673  * the NAT was hole-punched.
674  *
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
678  */
679 static void
680 process_external_ip (void *cls,
681                      const struct sockaddr *addr,
682                      socklen_t addrlen)
683 {
684   struct GNUNET_NAT_Handle *h = cls;
685   struct in_addr dummy;
686
687   if (NULL == addr)
688   {
689     h->ext_dns = NULL;
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,
695                         h->external_address,
696                         &dummy))
697     {
698       LOG (GNUNET_ERROR_TYPE_DEBUG,
699            "Got numeric IP for external address, not repeating lookup\n");
700       return;                   /* repated lookup pointless: was numeric! */
701     }
702     h->dns_task =
703       GNUNET_SCHEDULER_add_delayed (h->dyndns_frequency,
704                                     &resolve_dns, h);
705     return;
706   }
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);
712 }
713
714
715 /**
716  * Task to do a lookup on our hostname for IP addresses.
717  *
718  * @param cls the NAT handle
719  * @param tc scheduler context
720  */
721 static void
722 resolve_hostname (void *cls,
723                   const struct GNUNET_SCHEDULER_TaskContext *tc);
724
725
726 /**
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
729  * addresses.
730  *
731  * @param cls closure
732  * @param addr one of the addresses of the host, NULL for the last address
733  * @param addrlen length of the @a addr
734  */
735 static void
736 process_hostname_ip (void *cls,
737                      const struct sockaddr *addr,
738                      socklen_t addrlen)
739 {
740   struct GNUNET_NAT_Handle *h = cls;
741
742   if (NULL == addr)
743   {
744     h->hostname_dns = NULL;
745     h->hostname_task =
746         GNUNET_SCHEDULER_add_delayed (h->hostname_dns_frequency,
747                                       &resolve_hostname, h);
748     return;
749   }
750   add_to_address_list (h, LAL_HOSTNAME_DNS, addr, addrlen);
751 }
752
753
754 /**
755  * Length of the interface names returned from os_network.c.
756  * (in that file, hardcoded at 11).
757  */
758 #define IF_NAME_LEN 11
759
760
761 /**
762  * Add the IP of our network interface to the list of
763  * our IP addresses.
764  *
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
773  */
774 static int
775 process_interfaces (void *cls,
776                     const char *name,
777                     int isDefault,
778                     const struct sockaddr *addr,
779                     const struct sockaddr *broadcast_addr,
780                     const struct sockaddr *netmask,
781                     socklen_t addrlen)
782 {
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;
787   const void *ip;
788   char buf[INET6_ADDRSTRLEN];
789   unsigned int i;
790   int have_any;
791   char *tun_if;
792
793   /* skip virtual interfaces created by GNUnet-vpn */
794   if (GNUNET_OK ==
795       GNUNET_CONFIGURATION_get_value_string (h->cfg,
796                                              "vpn",
797                                              "IFNAME",
798                                              &tun_if))
799   {
800     if (0 == strncasecmp (name,
801                           tun_if,
802                           IF_NAME_LEN))
803     {
804       GNUNET_free (tun_if);
805       return GNUNET_OK;
806     }
807   }
808   /* skip virtual interfaces created by GNUnet-dns */
809   if (GNUNET_OK ==
810       GNUNET_CONFIGURATION_get_value_string (h->cfg,
811                                              "dns",
812                                              "IFNAME",
813                                              &tun_if))
814   {
815     if (0 == strncasecmp (name,
816                           tun_if,
817                           IF_NAME_LEN))
818     {
819       GNUNET_free (tun_if);
820       return GNUNET_OK;
821     }
822   }
823   /* skip virtual interfaces created by GNUnet-exit */
824   if (GNUNET_OK ==
825       GNUNET_CONFIGURATION_get_value_string (h->cfg,
826                                              "exit",
827                                              "TUN_IFNAME",
828                                              &tun_if))
829   {
830     if (0 == strncasecmp (name,
831                           tun_if,
832                           IF_NAME_LEN))
833     {
834       GNUNET_free (tun_if);
835       return GNUNET_OK;
836     }
837   }
838
839
840   switch (addr->sa_family)
841   {
842   case AF_INET:
843     /* check if we're bound to the "ANY" IP address */
844     have_any = GNUNET_NO;
845     for (i=0;i<h->num_local_addrs;i++)
846       {
847         if (h->local_addrs[i]->sa_family != AF_INET)
848           continue;
849 #ifndef INADDR_ANY
850 #define INADDR_ANY 0
851 #endif
852         if (INADDR_ANY == ((struct sockaddr_in*) h->local_addrs[i])->sin_addr.s_addr)
853           {
854             have_any = GNUNET_YES;
855             break;
856           }
857       }
858     if (GNUNET_NO == have_any)
859       return GNUNET_OK; /* not bound to IP 0.0.0.0 but to specific IP addresses,
860                            do not use those from interfaces */
861     s4 = (struct sockaddr_in *) addr;
862     ip = &s4->sin_addr;
863
864     /* Check if address is in 127.0.0.0/8 */
865     uint32_t address = ntohl ((uint32_t) (s4->sin_addr.s_addr));
866     uint32_t value = (address & 0xFF000000) ^ 0x7F000000;
867
868     if ((h->return_localaddress == GNUNET_NO) && (value == 0))
869     {
870       return GNUNET_OK;
871     }
872     if ((GNUNET_YES == h->use_localaddresses) || (value != 0))
873     {
874       add_ip_to_address_list (h, LAL_INTERFACE_ADDRESS, &s4->sin_addr,
875                               sizeof (struct in_addr));
876     }
877     break;
878   case AF_INET6:
879     /* check if we're bound to the "ANY" IP address */
880     have_any = GNUNET_NO;
881     for (i=0;i<h->num_local_addrs;i++)
882       {
883         if (h->local_addrs[i]->sa_family != AF_INET6)
884           continue;
885         if (0 == memcmp (&any6,
886                          &((struct sockaddr_in6*) h->local_addrs[i])->sin6_addr,
887                          sizeof (struct in6_addr)))
888           {
889             have_any = GNUNET_YES;
890             break;
891           }
892       }
893     if (GNUNET_NO == have_any)
894       return GNUNET_OK; /* not bound to "ANY" IP (::0) but to specific IP addresses,
895                            do not use those from interfaces */
896
897     s6 = (struct sockaddr_in6 *) addr;
898     if (IN6_IS_ADDR_LINKLOCAL (&((struct sockaddr_in6 *) addr)->sin6_addr))
899     {
900       /* skip link local addresses */
901       return GNUNET_OK;
902     }
903     if ((h->return_localaddress == GNUNET_NO) &&
904         (IN6_IS_ADDR_LOOPBACK (&((struct sockaddr_in6 *) addr)->sin6_addr)))
905     {
906       return GNUNET_OK;
907     }
908     ip = &s6->sin6_addr;
909     if (GNUNET_YES == h->use_localaddresses)
910     {
911       add_ip_to_address_list (h, LAL_INTERFACE_ADDRESS, &s6->sin6_addr,
912                               sizeof (struct in6_addr));
913     }
914     break;
915   default:
916     GNUNET_break (0);
917     return GNUNET_OK;
918   }
919   if ((h->internal_address == NULL) && (h->server_proc == NULL) &&
920       (h->server_read_task == NULL) &&
921       (GNUNET_YES == isDefault) && ((addr->sa_family == AF_INET) ||
922                                     (addr->sa_family == AF_INET6)))
923   {
924     /* no internal address configured, but we found a "default"
925      * interface, try using that as our 'internal' address */
926     h->internal_address =
927         GNUNET_strdup (inet_ntop (addr->sa_family, ip, buf, sizeof (buf)));
928     start_gnunet_nat_server (h);
929   }
930   return GNUNET_OK;
931 }
932
933
934 /**
935  * Task that restarts the gnunet-helper-nat-server process after a crash
936  * after a certain delay.
937  *
938  * @param cls the `struct GNUNET_NAT_Handle`
939  * @param tc scheduler context
940  */
941 static void
942 restart_nat_server (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
943 {
944   struct GNUNET_NAT_Handle *h = cls;
945
946   h->server_read_task = NULL;
947   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
948     return;
949   start_gnunet_nat_server (h);
950 }
951
952
953 /**
954  * We have been notified that gnunet-helper-nat-server has written
955  * something to stdout.  Handle the output, then reschedule this
956  * function to be called again once more is available.
957  *
958  * @param cls the NAT handle
959  * @param tc the scheduling context
960  */
961 static void
962 nat_server_read (void *cls,
963                  const struct GNUNET_SCHEDULER_TaskContext *tc)
964 {
965   struct GNUNET_NAT_Handle *h = cls;
966   char mybuf[40];
967   ssize_t bytes;
968   size_t i;
969   int port;
970   const char *port_start;
971   struct sockaddr_in sin_addr;
972
973   h->server_read_task = NULL;
974   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
975     return;
976   memset (mybuf, 0, sizeof (mybuf));
977   bytes =
978     GNUNET_DISK_file_read (h->server_stdout_handle, mybuf, sizeof (mybuf));
979   if (bytes < 1)
980   {
981     LOG (GNUNET_ERROR_TYPE_DEBUG,
982          "Finished reading from server stdout with code: %d\n",
983          bytes);
984     if (0 != GNUNET_OS_process_kill (h->server_proc, GNUNET_TERM_SIG))
985       GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING, "nat", "kill");
986     GNUNET_OS_process_wait (h->server_proc);
987     GNUNET_OS_process_destroy (h->server_proc);
988     h->server_proc = NULL;
989     GNUNET_DISK_pipe_close (h->server_stdout);
990     h->server_stdout = NULL;
991     h->server_stdout_handle = NULL;
992     /* now try to restart it */
993     h->server_retry_delay = GNUNET_TIME_STD_BACKOFF (h->server_retry_delay);
994     h->server_read_task =
995         GNUNET_SCHEDULER_add_delayed (h->server_retry_delay,
996                                       &restart_nat_server, h);
997     return;
998   }
999
1000   port_start = NULL;
1001   for (i = 0; i < sizeof (mybuf); i++)
1002   {
1003     if (mybuf[i] == '\n')
1004     {
1005       mybuf[i] = '\0';
1006       break;
1007     }
1008     if ((mybuf[i] == ':') && (i + 1 < sizeof (mybuf)))
1009     {
1010       mybuf[i] = '\0';
1011       port_start = &mybuf[i + 1];
1012     }
1013   }
1014
1015   /* construct socket address of sender */
1016   memset (&sin_addr, 0, sizeof (sin_addr));
1017   sin_addr.sin_family = AF_INET;
1018 #if HAVE_SOCKADDR_IN_SIN_LEN
1019   sin_addr.sin_len = sizeof (sin_addr);
1020 #endif
1021   if ((NULL == port_start) || (1 != SSCANF (port_start, "%d", &port)) ||
1022       (-1 == inet_pton (AF_INET, mybuf, &sin_addr.sin_addr)))
1023   {
1024     /* should we restart gnunet-helper-nat-server? */
1025     LOG (GNUNET_ERROR_TYPE_WARNING, "nat",
1026          _("gnunet-helper-nat-server generated malformed address `%s'\n"),
1027          mybuf);
1028     h->server_read_task =
1029         GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1030                                         h->server_stdout_handle,
1031                                         &nat_server_read, h);
1032     return;
1033   }
1034   sin_addr.sin_port = htons ((uint16_t) port);
1035   LOG (GNUNET_ERROR_TYPE_DEBUG, "gnunet-helper-nat-server read: %s:%d\n", mybuf,
1036        port);
1037   h->reversal_callback (h->callback_cls, (const struct sockaddr *) &sin_addr,
1038                         sizeof (sin_addr));
1039   h->server_read_task =
1040       GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1041                                       h->server_stdout_handle, &nat_server_read,
1042                                       h);
1043 }
1044
1045
1046 /**
1047  * Try to start the gnunet-helper-nat-server (if it is not
1048  * already running).
1049  *
1050  * @param h handle to NAT
1051  */
1052 static void
1053 start_gnunet_nat_server (struct GNUNET_NAT_Handle *h)
1054 {
1055   char *binary;
1056
1057   if ((h->behind_nat == GNUNET_YES) && (h->enable_nat_server == GNUNET_YES) &&
1058       (h->internal_address != NULL) &&
1059       (NULL !=
1060        (h->server_stdout =
1061         GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES))))
1062   {
1063     LOG (GNUNET_ERROR_TYPE_DEBUG,
1064          "Starting `%s' at `%s'\n",
1065          "gnunet-helper-nat-server", h->internal_address);
1066     /* Start the server process */
1067     binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
1068     h->server_proc =
1069         GNUNET_OS_start_process (GNUNET_NO, 0, NULL, h->server_stdout, NULL,
1070                                  binary,
1071                                  "gnunet-helper-nat-server",
1072                                  h->internal_address, NULL);
1073     GNUNET_free (binary);
1074     if (h->server_proc == NULL)
1075     {
1076       LOG (GNUNET_ERROR_TYPE_WARNING, "nat", _("Failed to start %s\n"),
1077            "gnunet-helper-nat-server");
1078       GNUNET_DISK_pipe_close (h->server_stdout);
1079       h->server_stdout = NULL;
1080     }
1081     else
1082     {
1083       /* Close the write end of the read pipe */
1084       GNUNET_DISK_pipe_close_end (h->server_stdout, GNUNET_DISK_PIPE_END_WRITE);
1085       h->server_stdout_handle =
1086           GNUNET_DISK_pipe_handle (h->server_stdout, GNUNET_DISK_PIPE_END_READ);
1087       h->server_read_task =
1088           GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1089                                           h->server_stdout_handle,
1090                                           &nat_server_read, h);
1091     }
1092   }
1093 }
1094
1095
1096 /**
1097  * Task to scan the local network interfaces for IP addresses.
1098  *
1099  * @param cls the NAT handle
1100  * @param tc scheduler context
1101  */
1102 static void
1103 list_interfaces (void *cls,
1104                  const struct GNUNET_SCHEDULER_TaskContext *tc)
1105 {
1106   struct GNUNET_NAT_Handle *h = cls;
1107
1108   h->ifc_task = NULL;
1109   remove_from_address_list_by_source (h, LAL_INTERFACE_ADDRESS);
1110   GNUNET_OS_network_interfaces_list (&process_interfaces, h);
1111   h->ifc_task =
1112     GNUNET_SCHEDULER_add_delayed (h->ifc_scan_frequency,
1113                                   &list_interfaces, h);
1114 }
1115
1116
1117 /**
1118  * Callback with the result from the STUN request.
1119  *
1120  * @param cls the NAT handle
1121  * @param result the status
1122  */
1123 static void
1124 stun_request_callback (void *cls,
1125                        enum GNUNET_NAT_StatusCode result)
1126 {
1127   struct GNUNET_NAT_Handle *h = cls;
1128
1129   h->stun_request = NULL;
1130   if (GNUNET_NAT_ERROR_SUCCESS != result)
1131   {
1132     LOG (GNUNET_ERROR_TYPE_WARNING,
1133          "Error processing a STUN request");
1134   }
1135   else
1136   {
1137     h->waiting_stun = GNUNET_YES;
1138   }
1139 }
1140
1141
1142 /**
1143  * CHECK if is a valid STUN packet sending to GNUNET_NAT_stun_handle_packet().
1144  * It also check if it can handle the packet based on the NAT handler.
1145  * You don't need to call anything else to check if the packet is valid,
1146  *
1147  * @param cls the NAT handle
1148  * @param data packet
1149  * @param len packet length
1150  * @return #GNUNET_NO if it can't decode, #GNUNET_YES if is a packet
1151  */
1152 int
1153 GNUNET_NAT_is_valid_stun_packet (void *cls,
1154                                  const void *data,
1155                                  size_t len)
1156 {
1157   struct GNUNET_NAT_Handle *h = cls;
1158   struct sockaddr_in answer;
1159
1160   /* We are not expecting a STUN message */
1161   if (GNUNET_YES != h->waiting_stun)
1162     return GNUNET_NO;
1163
1164   /* We dont have STUN installed */
1165   if (! h->use_stun)
1166     return GNUNET_NO;
1167
1168   /* Empty the answer structure */
1169   memset (&answer,
1170           0,
1171           sizeof(struct sockaddr_in));
1172
1173   /*Lets handle the packet*/
1174   if (GNUNET_NO ==
1175       GNUNET_NAT_stun_handle_packet (data,
1176                                      len,
1177                                      &answer))
1178     return GNUNET_NO;
1179
1180   LOG (GNUNET_ERROR_TYPE_INFO,
1181        "STUN server returned %s:%d\n",
1182        inet_ntoa (answer.sin_addr),
1183        ntohs (answer.sin_port));
1184   /* Remove old IPs from previous STUN calls */
1185   remove_from_address_list_by_source (h,
1186                                       LAL_EXTERNAL_STUN_IP);
1187   /* Add new IP from STUN packet */
1188   add_to_address_list (h,
1189                        LAL_EXTERNAL_STUN_IP,
1190                        (const struct sockaddr *) &answer,
1191                        sizeof (struct sockaddr_in));
1192   h->waiting_stun = GNUNET_NO;
1193   return GNUNET_YES;
1194 }
1195
1196
1197 /**
1198  * Task to do a STUN request
1199  *
1200  * @param cls the NAT handle
1201  * @param tc scheduler context
1202  */
1203 static void
1204 process_stun (void *cls,
1205               const struct GNUNET_SCHEDULER_TaskContext *tc)
1206 {
1207   struct GNUNET_NAT_Handle *h = cls;
1208   struct StunServerList* elem = h->actual_stun_server;
1209
1210   h->stun_task = NULL;
1211   /* Make the request */
1212   LOG (GNUNET_ERROR_TYPE_INFO,
1213        "I will request the stun server %s:%i\n",
1214        elem->address,
1215        elem->port);
1216   if (NULL != h->stun_request)
1217   {
1218     GNUNET_NAT_stun_make_request_cancel (h->stun_request);
1219     h->stun_request = NULL;
1220   }
1221   h->waiting_stun = GNUNET_NO;
1222   h->stun_request
1223     = GNUNET_NAT_stun_make_request (elem->address,
1224                                     elem->port,
1225                                     h->socket,
1226                                     &stun_request_callback,
1227                                     h);
1228   if (NULL == h->stun_request)
1229   {
1230     LOG (GNUNET_ERROR_TYPE_ERROR,
1231          "STUN request to %s:%i failed\n",
1232          elem->address,
1233          elem->port);
1234   }
1235   h->stun_task =
1236     GNUNET_SCHEDULER_add_delayed (h->stun_frequency,
1237                                   &process_stun,
1238                                   h);
1239
1240   /* Set actual Server*/
1241   if (NULL != elem->next)
1242   {
1243     h->actual_stun_server = elem->next;
1244   }
1245   else
1246   {
1247     h->actual_stun_server = h->stun_servers_head;
1248   }
1249 }
1250
1251
1252 /**
1253  * Task to do a lookup on our hostname for IP addresses.
1254  *
1255  * @param cls the NAT handle
1256  * @param tc scheduler context
1257  */
1258 static void
1259 resolve_hostname (void *cls,
1260                   const struct GNUNET_SCHEDULER_TaskContext *tc)
1261 {
1262   struct GNUNET_NAT_Handle *h = cls;
1263
1264   h->hostname_task = NULL;
1265   remove_from_address_list_by_source (h, LAL_HOSTNAME_DNS);
1266   h->hostname_dns =
1267       GNUNET_RESOLVER_hostname_resolve (AF_UNSPEC, HOSTNAME_RESOLVE_TIMEOUT,
1268                                         &process_hostname_ip, h);
1269 }
1270
1271
1272 /**
1273  * Task to do DNS lookup on our external hostname to
1274  * get DynDNS-IP addresses.
1275  *
1276  * @param cls the NAT handle
1277  * @param tc scheduler context
1278  */
1279 static void
1280 resolve_dns (void *cls,
1281              const struct GNUNET_SCHEDULER_TaskContext *tc)
1282 {
1283   struct GNUNET_NAT_Handle *h = cls;
1284   struct LocalAddressList *pos;
1285
1286   h->dns_task = NULL;
1287   for (pos = h->lal_head; NULL != pos; pos = pos->next)
1288     if (pos->source == LAL_EXTERNAL_IP)
1289       pos->source = LAL_EXTERNAL_IP_OLD;
1290   LOG (GNUNET_ERROR_TYPE_DEBUG,
1291        "Resolving external address `%s'\n",
1292        h->external_address);
1293   h->ext_dns =
1294       GNUNET_RESOLVER_ip_get (h->external_address, AF_INET,
1295                               GNUNET_TIME_UNIT_MINUTES,
1296                               &process_external_ip, h);
1297 }
1298
1299
1300 /**
1301  * Add or remove UPnP-mapped addresses.
1302  *
1303  * @param cls the `struct GNUNET_NAT_Handle`
1304  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
1305  *     the previous (now invalid) one
1306  * @param addr either the previous or the new public IP address
1307  * @param addrlen actual lenght of @a addr
1308  * @param ret GNUNET_NAT_ERROR_SUCCESS on success, otherwise an error code
1309  */
1310 static void
1311 upnp_add (void *cls,
1312           int add_remove,
1313           const struct sockaddr *addr,
1314           socklen_t addrlen,
1315           enum GNUNET_NAT_StatusCode ret)
1316 {
1317   struct GNUNET_NAT_Handle *h = cls;
1318   struct LocalAddressList *pos;
1319   struct LocalAddressList *next;
1320
1321
1322   if (GNUNET_NAT_ERROR_SUCCESS != ret)
1323   {
1324     /* Error while running upnp client */
1325     LOG (GNUNET_ERROR_TYPE_ERROR,
1326           _("Error while running upnp client:\n"));
1327     //FIXME: convert error code to string
1328     return;
1329   }
1330
1331   if (GNUNET_YES == add_remove)
1332   {
1333     add_to_address_list (h,
1334                          LAL_UPNP,
1335                          addr,
1336                          addrlen);
1337     return;
1338   }
1339   else if (GNUNET_NO == add_remove)
1340   {
1341     /* remove address */
1342     next = h->lal_head;
1343     while (NULL != (pos = next))
1344     {
1345       next = pos->next;
1346       if ((pos->source != LAL_UPNP) || (pos->addrlen != addrlen) ||
1347           (0 != memcmp (&pos[1], addr, addrlen)))
1348         continue;
1349       GNUNET_CONTAINER_DLL_remove (h->lal_head,
1350                                    h->lal_tail,
1351                                    pos);
1352       if (NULL != h->address_callback)
1353         h->address_callback (h->callback_cls,
1354                              GNUNET_NO,
1355                              (const struct sockaddr *) &pos[1],
1356                              pos->addrlen);
1357       GNUNET_free (pos);
1358       return;                     /* only remove once */
1359     }
1360     /* asked to remove address that does not exist */
1361     LOG (GNUNET_ERROR_TYPE_ERROR,
1362          "Asked to remove unkown address `%s'\n",
1363          GNUNET_a2s(addr, addrlen));
1364     GNUNET_break (0);
1365   }
1366   else
1367   {
1368
1369     GNUNET_break (0);
1370   }
1371 }
1372
1373
1374 /**
1375  * Try to add a port mapping using UPnP.
1376  *
1377  * @param h overall NAT handle
1378  * @param port port to map with UPnP
1379  */
1380 static void
1381 add_minis (struct GNUNET_NAT_Handle *h,
1382            uint16_t port)
1383 {
1384   struct MiniList *ml;
1385
1386   ml = h->mini_head;
1387   while (NULL != ml)
1388   {
1389     if (port == ml->port)
1390       return;                   /* already got this port */
1391     ml = ml->next;
1392   }
1393
1394   ml = GNUNET_new (struct MiniList);
1395   ml->port = port;
1396   ml->mini = GNUNET_NAT_mini_map_start (port, h->is_tcp, &upnp_add, h);
1397
1398   if (NULL == ml->mini)
1399   {
1400     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1401         _("Failed to run upnp client for port %u\n"), ml->port);
1402     GNUNET_free (ml);
1403     return;
1404   }
1405
1406   GNUNET_CONTAINER_DLL_insert (h->mini_head,
1407                                h->mini_tail,
1408                                ml);
1409 }
1410
1411
1412 /**
1413  * Task to add addresses from original bind to set of valid addrs.
1414  *
1415  * @param h the NAT handle
1416  */
1417 static void
1418 add_from_bind (struct GNUNET_NAT_Handle *h)
1419 {
1420   static struct in6_addr any = IN6ADDR_ANY_INIT;
1421
1422   unsigned int i;
1423   struct sockaddr *sa;
1424   const struct sockaddr_in *v4;
1425
1426   for (i = 0; i < h->num_local_addrs; i++)
1427   {
1428     sa = h->local_addrs[i];
1429     switch (sa->sa_family)
1430     {
1431     case AF_INET:
1432       if (sizeof (struct sockaddr_in) != h->local_addrlens[i])
1433       {
1434         GNUNET_break (0);
1435         break;
1436       }
1437       v4 = (const struct sockaddr_in *) sa;
1438       if (0 != v4->sin_addr.s_addr)
1439         add_to_address_list (h,
1440                              LAL_BINDTO_ADDRESS, sa,
1441                              sizeof (struct sockaddr_in));
1442       if (h->enable_upnp)
1443       {
1444         GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1445                     "Running upnp client for address `%s'\n",
1446                     GNUNET_a2s (sa,sizeof (struct sockaddr_in)));
1447         add_minis (h, ntohs (v4->sin_port));
1448       }
1449       break;
1450     case AF_INET6:
1451       if (sizeof (struct sockaddr_in6) != h->local_addrlens[i])
1452       {
1453         GNUNET_break (0);
1454         break;
1455       }
1456       if (0 !=
1457           memcmp (&((const struct sockaddr_in6 *) sa)->sin6_addr,
1458                   &any,
1459                   sizeof (struct in6_addr)))
1460         add_to_address_list (h,
1461                              LAL_BINDTO_ADDRESS,
1462                              sa,
1463                              sizeof (struct sockaddr_in6));
1464       break;
1465     default:
1466       break;
1467     }
1468   }
1469 }
1470
1471
1472 /**
1473  * Attempt to enable port redirection and detect public IP address contacting
1474  * UPnP or NAT-PMP routers on the local network. Use addr to specify to which
1475  * of the local host's addresses should the external port be mapped. The port
1476  * is taken from the corresponding sockaddr_in[6] field.
1477  *
1478  * @param cfg configuration to use
1479  * @param is_tcp #GNUNET_YES for TCP, #GNUNET_NO for UDP
1480  * @param adv_port advertised port (port we are either bound to or that our OS
1481  *                 locally performs redirection from to our bound port).
1482  * @param num_addrs number of addresses in @a addrs
1483  * @param addrs the local addresses packets should be redirected to
1484  * @param addrlens actual lengths of the addresses
1485  * @param address_callback function to call everytime the public IP address changes
1486  * @param reversal_callback function to call if someone wants connection reversal from us
1487  * @param callback_cls closure for callbacks
1488  * @param sock used socket
1489  * @return NULL on error, otherwise handle that can be used to unregister
1490  */
1491 struct GNUNET_NAT_Handle *
1492 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
1493                      int is_tcp,
1494                      uint16_t adv_port,
1495                      unsigned int num_addrs,
1496                      const struct sockaddr **addrs,
1497                      const socklen_t *addrlens,
1498                      GNUNET_NAT_AddressCallback address_callback,
1499                      GNUNET_NAT_ReversalCallback reversal_callback,
1500                      void *callback_cls,
1501                      struct GNUNET_NETWORK_Handle *sock)
1502 {
1503   struct GNUNET_NAT_Handle *h;
1504   struct in_addr in_addr;
1505   unsigned int i;
1506   char *binary;
1507
1508   LOG (GNUNET_ERROR_TYPE_DEBUG,
1509        "Registered with NAT service at port %u with %u IP bound local addresses\n",
1510        (unsigned int) adv_port, num_addrs);
1511   h = GNUNET_new (struct GNUNET_NAT_Handle);
1512   h->server_retry_delay = GNUNET_TIME_UNIT_SECONDS;
1513   h->cfg = cfg;
1514   h->is_tcp = is_tcp;
1515   h->address_callback = address_callback;
1516   h->reversal_callback = reversal_callback;
1517   h->callback_cls = callback_cls;
1518   h->num_local_addrs = num_addrs;
1519   h->adv_port = adv_port;
1520   if (0 != num_addrs)
1521   {
1522     h->local_addrs = GNUNET_malloc (num_addrs * sizeof (struct sockaddr *));
1523     h->local_addrlens = GNUNET_malloc (num_addrs * sizeof (socklen_t));
1524     for (i = 0; i < num_addrs; i++)
1525     {
1526       GNUNET_assert (addrlens[i] > 0);
1527       GNUNET_assert (addrs[i] != NULL);
1528       h->local_addrlens[i] = addrlens[i];
1529       h->local_addrs[i] = GNUNET_malloc (addrlens[i]);
1530       memcpy (h->local_addrs[i], addrs[i], addrlens[i]);
1531     }
1532   }
1533   if (GNUNET_OK ==
1534       GNUNET_CONFIGURATION_have_value (cfg, "nat", "INTERNAL_ADDRESS"))
1535   {
1536     (void) GNUNET_CONFIGURATION_get_value_string (cfg, "nat",
1537                                                   "INTERNAL_ADDRESS",
1538                                                   &h->internal_address);
1539   }
1540   if ((h->internal_address != NULL) &&
1541       (inet_pton (AF_INET, h->internal_address, &in_addr) != 1))
1542   {
1543     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1544                                "nat", "INTERNAL_ADDRESS",
1545                                _("malformed"));
1546     GNUNET_free (h->internal_address);
1547     h->internal_address = NULL;
1548   }
1549
1550   if (GNUNET_OK ==
1551       GNUNET_CONFIGURATION_have_value (cfg, "nat", "EXTERNAL_ADDRESS"))
1552   {
1553     (void) GNUNET_CONFIGURATION_get_value_string (cfg, "nat",
1554                                                   "EXTERNAL_ADDRESS",
1555                                                   &h->external_address);
1556   }
1557   h->behind_nat =
1558       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "BEHIND_NAT");
1559   h->nat_punched =
1560       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "PUNCHED_NAT");
1561   h->enable_nat_client =
1562       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "ENABLE_ICMP_CLIENT");
1563   h->enable_nat_server =
1564       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "ENABLE_ICMP_SERVER");
1565   h->enable_upnp =
1566       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "ENABLE_UPNP");
1567   h->use_localaddresses =
1568       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "USE_LOCALADDR");
1569   h->return_localaddress =
1570       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat",
1571                                             "RETURN_LOCAL_ADDRESSES");
1572
1573   h->use_hostname =
1574       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "USE_HOSTNAME");
1575   h->disable_ipv6 =
1576       GNUNET_CONFIGURATION_get_value_yesno (cfg, "nat", "DISABLEV6");
1577   if (GNUNET_OK !=
1578       GNUNET_CONFIGURATION_get_value_time (cfg, "nat", "DYNDNS_FREQUENCY",
1579                                            &h->dyndns_frequency))
1580     h->dyndns_frequency = DYNDNS_FREQUENCY;
1581   if (GNUNET_OK !=
1582       GNUNET_CONFIGURATION_get_value_time (cfg, "nat", "IFC_SCAN_FREQUENCY",
1583                                            &h->ifc_scan_frequency))
1584     h->ifc_scan_frequency = IFC_SCAN_FREQUENCY;
1585   if (GNUNET_OK !=
1586       GNUNET_CONFIGURATION_get_value_time (cfg, "nat", "HOSTNAME_DNS_FREQUENCY",
1587                                            &h->hostname_dns_frequency))
1588     h->hostname_dns_frequency = HOSTNAME_DNS_FREQUENCY;
1589
1590   if (NULL == reversal_callback)
1591     h->enable_nat_server = GNUNET_NO;
1592
1593   /* Check for UPnP client, disable immediately if not available */
1594   if ( (GNUNET_YES == h->enable_upnp) &&
1595        (GNUNET_SYSERR ==
1596         GNUNET_OS_check_helper_binary ("upnpc", GNUNET_NO, NULL)) )
1597   {
1598     LOG (GNUNET_ERROR_TYPE_ERROR,
1599         _("UPnP enabled in configuration, but UPnP client `upnpc` command not found, disabling UPnP \n"));
1600     h->enable_upnp = GNUNET_NO;
1601   }
1602
1603   /* STUN */
1604   h->use_stun =
1605     GNUNET_CONFIGURATION_get_value_yesno (cfg,
1606                                           "nat",
1607                                           "USE_STUN");
1608
1609   if (GNUNET_OK !=
1610       GNUNET_CONFIGURATION_get_value_time (cfg,
1611                                            "nat",
1612                                            "STUN_FREQUENCY",
1613                                            &h->stun_frequency))
1614     h->stun_frequency = STUN_FREQUENCY;
1615
1616
1617   /* Check if NAT was hole-punched */
1618   if ((NULL != h->address_callback) &&
1619       (NULL != h->external_address) &&
1620       (GNUNET_YES == h->nat_punched))
1621   {
1622     h->dns_task = GNUNET_SCHEDULER_add_now (&resolve_dns, h);
1623     h->enable_nat_server = GNUNET_NO;
1624     h->enable_upnp = GNUNET_NO;
1625     h->use_stun = GNUNET_NO;
1626   }
1627   else
1628   {
1629     LOG (GNUNET_ERROR_TYPE_DEBUG,
1630          "No external IP address given to add to our list of addresses\n");
1631   }
1632
1633   /* ENABLE STUN ONLY ON UDP */
1634   if( (! is_tcp) &&
1635       (NULL != sock) &&
1636       h->use_stun)
1637   {
1638     char *stun_servers;
1639     size_t urls;
1640     int pos;
1641     size_t pos_port;
1642
1643     h->socket = sock;
1644     h->actual_stun_server = NULL;
1645     /* Lets process the servers*/
1646     if (GNUNET_OK !=
1647         GNUNET_CONFIGURATION_get_value_string (cfg,
1648                                                "nat",
1649                                                "STUN_SERVERS",
1650                                                &stun_servers))
1651     {
1652       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
1653                                  "nat",
1654                                  "STUN_SERVERS");
1655     }
1656
1657     urls = 0;
1658     h->stun_servers_head = NULL;
1659     h->stun_servers_tail = NULL;
1660     h->actual_stun_server = NULL;
1661     if (strlen (stun_servers) > 0)
1662     {
1663       pos = strlen (stun_servers) - 1;
1664       pos_port = 0;
1665       while (pos >= 0)
1666       {
1667         if (stun_servers[pos] == ':')
1668         {
1669           pos_port = pos + 1;
1670         }
1671         if ((stun_servers[pos] == ' ') || (0 == pos))
1672         {
1673
1674           /*Check if we do have a port*/
1675           if((0 == pos_port) || (pos_port <= pos))
1676           {
1677             LOG (GNUNET_ERROR_TYPE_WARNING,
1678                  "STUN server format mistake\n");
1679             break;
1680           }
1681
1682           urls++;
1683
1684           struct StunServerList* ml = GNUNET_new (struct StunServerList);
1685
1686           ml->port = atoi (&stun_servers[pos_port]);
1687           stun_servers[pos_port-1] = '\0';
1688
1689           /* Remove trailing space */
1690           if(stun_servers[pos] == ' ')
1691             ml->address = GNUNET_strdup (&stun_servers[pos + 1]);
1692           else
1693             ml->address = GNUNET_strdup (&stun_servers[pos]);
1694
1695           LOG (GNUNET_ERROR_TYPE_DEBUG,
1696                "Found STUN server %s:%i\n",
1697                ml->address,
1698                ml->port);
1699
1700           GNUNET_CONTAINER_DLL_insert (h->stun_servers_head,
1701                                        h->stun_servers_tail,
1702                                        ml);
1703           /* Make sure that we STOP if is the last one*/
1704           if (0 == pos)
1705             break;
1706         }
1707
1708         pos--;
1709       }
1710     }
1711     if (urls == 0)
1712     {
1713       GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
1714                                  "nat", "STUN_SERVERS");
1715     }
1716     else
1717     {
1718       /* Set the actual STUN server*/
1719       h->actual_stun_server = h->stun_servers_head;
1720     }
1721     h->stun_task = GNUNET_SCHEDULER_add_now (&process_stun,
1722                                              h);
1723   }
1724
1725
1726   /* Test for SUID binaries */
1727   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-server");
1728   if ( (GNUNET_YES == h->behind_nat) &&
1729        (GNUNET_YES == h->enable_nat_server) &&
1730        (GNUNET_YES !=
1731         GNUNET_OS_check_helper_binary (binary,
1732                                        GNUNET_YES,
1733                                        "-d 127.0.0.1" )))
1734   {
1735     // use localhost as source for that one udp-port, ok for testing
1736     h->enable_nat_server = GNUNET_NO;
1737     LOG (GNUNET_ERROR_TYPE_WARNING,
1738          _("Configuration requires `%s', but binary is not installed properly (SUID bit not set).  Option disabled.\n"),
1739          "gnunet-helper-nat-server");
1740   }
1741   GNUNET_free (binary);
1742   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
1743   if ((GNUNET_YES == h->enable_nat_client) &&
1744       (GNUNET_YES !=
1745        GNUNET_OS_check_helper_binary (binary,
1746                                       GNUNET_YES,
1747                                       "-d 127.0.0.1 127.0.0.2 42"))) /* none of these parameters are actually used in privilege testing mode */
1748   {
1749     h->enable_nat_client = GNUNET_NO;
1750     LOG (GNUNET_ERROR_TYPE_WARNING,
1751          _("Configuration requires `%s', but binary is not installed properly (SUID bit not set).  Option disabled.\n"),
1752          "gnunet-helper-nat-client");
1753   }
1754   GNUNET_free (binary);
1755   start_gnunet_nat_server (h);
1756
1757   /* FIXME: add support for UPnP, etc */
1758
1759   if (NULL != h->address_callback)
1760   {
1761     h->ifc_task = GNUNET_SCHEDULER_add_now (&list_interfaces,
1762                                             h);
1763     if (GNUNET_YES == h->use_hostname)
1764       h->hostname_task = GNUNET_SCHEDULER_add_now (&resolve_hostname,
1765                                                    h);
1766   }
1767   add_from_bind (h);
1768
1769   return h;
1770 }
1771
1772
1773 /**
1774  * Stop port redirection and public IP address detection for the given handle.
1775  * This frees the handle, after having sent the needed commands to close open ports.
1776  *
1777  * @param h the handle to stop
1778  */
1779 void
1780 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h)
1781 {
1782   unsigned int i;
1783   struct LocalAddressList *lal;
1784   struct MiniList *ml;
1785
1786   LOG (GNUNET_ERROR_TYPE_DEBUG,
1787        "NAT unregister called\n");
1788   while (NULL != (ml = h->mini_head))
1789   {
1790     GNUNET_CONTAINER_DLL_remove (h->mini_head,
1791                                  h->mini_tail,
1792                                  ml);
1793     if (NULL != ml->mini)
1794       GNUNET_NAT_mini_map_stop (ml->mini);
1795     GNUNET_free (ml);
1796   }
1797   if (NULL != h->ext_dns)
1798   {
1799     GNUNET_RESOLVER_request_cancel (h->ext_dns);
1800     h->ext_dns = NULL;
1801   }
1802   if (NULL != h->hostname_dns)
1803   {
1804     GNUNET_RESOLVER_request_cancel (h->hostname_dns);
1805     h->hostname_dns = NULL;
1806   }
1807   if (NULL != h->server_read_task)
1808   {
1809     GNUNET_SCHEDULER_cancel (h->server_read_task);
1810     h->server_read_task = NULL;
1811   }
1812   if (NULL != h->ifc_task)
1813   {
1814     GNUNET_SCHEDULER_cancel (h->ifc_task);
1815     h->ifc_task = NULL;
1816   }
1817   if (NULL != h->hostname_task)
1818   {
1819     GNUNET_SCHEDULER_cancel (h->hostname_task);
1820     h->hostname_task = NULL;
1821   }
1822   if (NULL != h->dns_task)
1823   {
1824     GNUNET_SCHEDULER_cancel (h->dns_task);
1825     h->dns_task = NULL;
1826   }
1827   if (NULL != h->stun_task)
1828   {
1829     GNUNET_SCHEDULER_cancel (h->stun_task);
1830     h->stun_task = NULL;
1831   }
1832   if (NULL != h->stun_request)
1833   {
1834     GNUNET_NAT_stun_make_request_cancel (h->stun_request);
1835     h->stun_request = NULL;
1836   }
1837   if (NULL != h->server_proc)
1838   {
1839     if (0 != GNUNET_OS_process_kill (h->server_proc,
1840                                      GNUNET_TERM_SIG))
1841       GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING,
1842                                 "nat",
1843                                 "kill");
1844     GNUNET_OS_process_wait (h->server_proc);
1845     GNUNET_OS_process_destroy (h->server_proc);
1846     h->server_proc = NULL;
1847     GNUNET_DISK_pipe_close (h->server_stdout);
1848     h->server_stdout = NULL;
1849     h->server_stdout_handle = NULL;
1850   }
1851   if (NULL != h->server_stdout)
1852   {
1853     GNUNET_DISK_pipe_close (h->server_stdout);
1854     h->server_stdout = NULL;
1855     h->server_stdout_handle = NULL;
1856   }
1857   while (NULL != (lal = h->lal_head))
1858   {
1859     GNUNET_CONTAINER_DLL_remove (h->lal_head,
1860                                  h->lal_tail,
1861                                  lal);
1862     if (NULL != h->address_callback)
1863       h->address_callback (h->callback_cls,
1864                            GNUNET_NO,
1865                            (const struct sockaddr *) &lal[1],
1866                            lal->addrlen);
1867     GNUNET_free (lal);
1868   }
1869   for (i = 0; i < h->num_local_addrs; i++)
1870     GNUNET_free (h->local_addrs[i]);
1871   GNUNET_free_non_null (h->local_addrs);
1872   GNUNET_free_non_null (h->local_addrlens);
1873   GNUNET_free_non_null (h->external_address);
1874   GNUNET_free_non_null (h->internal_address);
1875   GNUNET_free (h);
1876 }
1877
1878
1879 /**
1880  * We learned about a peer (possibly behind NAT) so run the
1881  * gnunet-helper-nat-client to send dummy ICMP responses to cause
1882  * that peer to connect to us (connection reversal).
1883  *
1884  * @param h handle (used for configuration)
1885  * @param sa the address of the peer (IPv4-only)
1886  * @return #GNUNET_SYSERR on error, #GNUNET_NO if nat client is disabled,
1887  *         #GNUNET_OK otherwise
1888  */
1889 int
1890 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
1891                        const struct sockaddr_in *sa)
1892
1893
1894 {
1895   char inet4[INET_ADDRSTRLEN];
1896   char port_as_string[6];
1897   struct GNUNET_OS_Process *proc;
1898   char *binary;
1899
1900   if (GNUNET_YES != h->enable_nat_client)
1901     return GNUNET_NO;                     /* not permitted / possible */
1902
1903   if (h->internal_address == NULL)
1904   {
1905     LOG (GNUNET_ERROR_TYPE_WARNING, "nat",
1906          _("Internal IP address not known, cannot use ICMP NAT traversal method\n"));
1907     return GNUNET_SYSERR;
1908   }
1909   GNUNET_assert (sa->sin_family == AF_INET);
1910   if (NULL == inet_ntop (AF_INET, &sa->sin_addr, inet4, INET_ADDRSTRLEN))
1911   {
1912     GNUNET_log_from_strerror (GNUNET_ERROR_TYPE_WARNING,
1913                               "nat",
1914                               "inet_ntop");
1915     return GNUNET_SYSERR;
1916   }
1917   GNUNET_snprintf (port_as_string,
1918                    sizeof (port_as_string),
1919                    "%d",
1920                    h->adv_port);
1921   LOG (GNUNET_ERROR_TYPE_DEBUG,
1922        _("Running gnunet-helper-nat-client %s %s %u\n"),
1923        h->internal_address,
1924        inet4,
1925        (unsigned int) h->adv_port);
1926   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-helper-nat-client");
1927   proc =
1928       GNUNET_OS_start_process (GNUNET_NO, 0, NULL, NULL, NULL,
1929                                binary,
1930                                "gnunet-helper-nat-client",
1931                                h->internal_address,
1932                                inet4, port_as_string, NULL);
1933   GNUNET_free (binary);
1934   if (NULL == proc)
1935     return GNUNET_SYSERR;
1936   /* we know that the gnunet-helper-nat-client will terminate virtually
1937    * instantly */
1938   GNUNET_OS_process_wait (proc);
1939   GNUNET_OS_process_destroy (proc);
1940   return GNUNET_OK;
1941 }
1942
1943
1944 /**
1945  * Test if the given address is (currently) a plausible IP address for this peer.
1946  *
1947  * @param h the handle returned by register
1948  * @param addr IP address to test (IPv4 or IPv6)
1949  * @param addrlen number of bytes in @a addr
1950  * @return #GNUNET_YES if the address is plausible,
1951  *         #GNUNET_NO if the address is not plausible,
1952  *         #GNUNET_SYSERR if the address is malformed
1953  */
1954 int
1955 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
1956                          const void *addr,
1957                          socklen_t addrlen)
1958 {
1959   struct LocalAddressList *pos;
1960   const struct sockaddr_in *in4;
1961   const struct sockaddr_in6 *in6;
1962
1963   if ((addrlen != sizeof (struct in_addr)) &&
1964       (addrlen != sizeof (struct in6_addr)))
1965   {
1966     GNUNET_break (0);
1967     return GNUNET_SYSERR;
1968   }
1969   for (pos = h->lal_head; NULL != pos; pos = pos->next)
1970   {
1971     if (pos->addrlen == sizeof (struct sockaddr_in))
1972     {
1973       in4 = (struct sockaddr_in *) &pos[1];
1974       if ((addrlen == sizeof (struct in_addr)) &&
1975           (0 == memcmp (&in4->sin_addr, addr, sizeof (struct in_addr))))
1976         return GNUNET_YES;
1977     }
1978     else if (pos->addrlen == sizeof (struct sockaddr_in6))
1979     {
1980       in6 = (struct sockaddr_in6 *) &pos[1];
1981       if ((addrlen == sizeof (struct in6_addr)) &&
1982           (0 == memcmp (&in6->sin6_addr, addr, sizeof (struct in6_addr))))
1983         return GNUNET_YES;
1984     }
1985     else
1986     {
1987       GNUNET_assert (0);
1988     }
1989   }
1990   LOG (GNUNET_ERROR_TYPE_WARNING,
1991        "Asked to validate one of my addresses (%s) and validation failed!\n",
1992        GNUNET_a2s (addr,
1993                    addrlen));
1994   return GNUNET_NO;
1995 }
1996
1997 /**
1998  * Converts enum GNUNET_NAT_StatusCode to a string
1999  *
2000  * @param err error code to resolve to a string
2001  * @return pointer to a static string containing the error code
2002  */
2003 const char *
2004 GNUNET_NAT_status2string (enum GNUNET_NAT_StatusCode err)
2005 {
2006   switch (err)
2007   {
2008   case GNUNET_NAT_ERROR_SUCCESS:
2009     return _ ("Operation Successful");
2010   case GNUNET_NAT_ERROR_IPC_FAILURE:
2011     return _ ("Internal Failure (IPC, ...)");
2012   case GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR:
2013     return _ ("Failure in network subsystem, check permissions.");
2014   case GNUNET_NAT_ERROR_TIMEOUT:
2015     return _ ("Encountered timeout while performing operation");
2016   case GNUNET_NAT_ERROR_NOT_ONLINE:
2017     return _ ("detected that we are offline");
2018   case GNUNET_NAT_ERROR_UPNPC_NOT_FOUND:
2019     return _ ("`upnpc` command not found");
2020   case GNUNET_NAT_ERROR_UPNPC_FAILED:
2021     return _ ("Failed to run `upnpc` command");
2022   case GNUNET_NAT_ERROR_UPNPC_TIMEOUT:
2023     return _ ("`upnpc' command took too long, process killed");
2024   case GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED:
2025     return _ ("`upnpc' command failed to establish port mapping");
2026   case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND:
2027     return _ ("`external-ip' command not found");
2028   case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED:
2029     return _ ("Failed to run `external-ip` command");
2030   case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID:
2031     return _ ("`external-ip' command output invalid");
2032   case GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID:
2033     return _ ("no valid address was returned by `external-ip'");
2034   case GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO:
2035     return _ ("Could not determine interface with internal/local network address");
2036   case GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND:
2037     return _ ("No functioning gnunet-helper-nat-server installation found");
2038   case GNUNET_NAT_ERROR_NAT_TEST_START_FAILED:
2039     return _ ("NAT test could not be initialized");
2040   case GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT:
2041     return _ ("NAT test timeout reached");
2042   case GNUNET_NAT_ERROR_NAT_REGISTER_FAILED:
2043     return _ ("could not register NAT");
2044   case GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND:
2045     return _ ("No working gnunet-helper-nat-client installation found");
2046 /*  case:
2047     return _ ("");*/
2048   default:
2049     return "unknown status code";
2050   }
2051 }
2052
2053 /* end of nat.c */