another special case for loopback
[oweals/gnunet.git] / src / nat / nat_api.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2007-2017 GNUnet e.V.
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  * @author Christian Grothoff
23  * @author Milan Bouchet-Valat
24  *
25  * @file nat/nat_api.c
26  * Service for handling UPnP and NAT-PMP port forwarding
27  * and external IP address retrieval
28  */
29 #include "platform.h"
30 #include "gnunet_nat_service.h"
31 #include "nat.h"
32 #include "nat_stun.h"
33
34
35 /**
36  * Entry in DLL of addresses of this peer.
37  */
38 struct AddrEntry
39 {
40
41   /**
42    * DLL.
43    */
44   struct AddrEntry *next;
45
46   /**
47    * DLL.
48    */
49   struct AddrEntry *prev;
50
51   /**
52    * Address class of the address.
53    */
54   enum GNUNET_NAT_AddressClass ac;
55   
56   /**
57    * Number of bytes that follow.
58    */
59   socklen_t addrlen;
60 };
61
62
63 /**
64  * Handle for active NAT registrations.
65  */
66 struct GNUNET_NAT_Handle
67 {
68
69   /**
70    * Configuration we use.
71    */
72   const struct GNUNET_CONFIGURATION_Handle *cfg;
73   
74   /**
75    * Message queue for communicating with the NAT service.
76    */
77   struct GNUNET_MQ_Handle *mq;
78
79   /**
80    * Our registration message.
81    */
82   struct GNUNET_MessageHeader *reg;
83   
84   /**
85    * Head of address DLL.
86    */
87   struct AddrEntry *ae_head;
88
89   /**
90    * Tail of address DLL.
91    */
92   struct AddrEntry *ae_tail;
93
94   /**
95    * Function to call when our addresses change.
96    */
97   GNUNET_NAT_AddressCallback address_callback;
98   
99   /**
100    * Function to call when another peer requests connection reversal.
101    */
102   GNUNET_NAT_ReversalCallback reversal_callback;
103   
104   /**
105    * Closure for the various callbacks.
106    */
107   void *callback_cls;
108
109   /**
110    * Task scheduled to reconnect to the service.
111    */
112   struct GNUNET_SCHEDULER_Task *reconnect_task;
113
114   /**
115    * How long to wait until we reconnect.
116    */
117   struct GNUNET_TIME_Relative reconnect_delay;
118 };
119
120
121 /**
122  * Task to connect to the NAT service.
123  *
124  * @param cls our `struct GNUNET_NAT_Handle *`
125  */
126 static void
127 do_connect (void *cls);
128
129
130 /**
131  * Task to connect to the NAT service.
132  *
133  * @param nh handle to reconnect
134  */
135 static void
136 reconnect (struct GNUNET_NAT_Handle *nh)
137 {
138   struct AddrEntry *ae;
139   
140   if (NULL != nh->mq)
141   {
142     GNUNET_MQ_destroy (nh->mq);
143     nh->mq = NULL;
144   }
145   while (NULL != (ae = nh->ae_head))
146   {
147     GNUNET_CONTAINER_DLL_remove (nh->ae_head,
148                                  nh->ae_tail,
149                                  ae);
150     nh->address_callback (nh->callback_cls,
151                           GNUNET_NO,
152                           ae->ac,
153                           (const struct sockaddr *) &ae[1],
154                           ae->addrlen);
155     GNUNET_free (ae);
156   }
157   nh->reconnect_delay
158     = GNUNET_TIME_STD_BACKOFF (nh->reconnect_delay);
159   nh->reconnect_task
160     = GNUNET_SCHEDULER_add_delayed (nh->reconnect_delay,
161                                     &do_connect,
162                                     nh);
163 }
164
165
166 /**
167  * Check connection reversal request.
168  *
169  * @param cls our `struct GNUNET_NAT_Handle`
170  * @param crm the message
171  * @return #GNUNET_OK if @a crm is well-formed
172  */
173 static int
174 check_connection_reversal_request (void *cls,
175                                    const struct GNUNET_NAT_ConnectionReversalRequestedMessage *crm)
176 {
177   if (ntohs (crm->header.size) !=
178       sizeof (*crm) +
179       sizeof (struct sockaddr_in) )
180   {
181     GNUNET_break (0);
182     return GNUNET_SYSERR;
183   }
184   return GNUNET_OK;
185 }
186
187   
188 /**
189  * Handle connection reversal request.
190  *
191  * @param cls our `struct GNUNET_NAT_Handle`
192  * @param crm the message
193  */
194 static void
195 handle_connection_reversal_request (void *cls,
196                                     const struct GNUNET_NAT_ConnectionReversalRequestedMessage *crm)
197 {
198   struct GNUNET_NAT_Handle *nh = cls;
199
200   nh->reversal_callback (nh->callback_cls,
201                          (const struct sockaddr *) &crm[1],
202                          sizeof (struct sockaddr_in));
203 }
204
205
206 /**
207  * Check address change notification.
208  *
209  * @param cls our `struct GNUNET_NAT_Handle`
210  * @param acn the message
211  * @return #GNUNET_OK if @a crm is well-formed
212  */
213 static int
214 check_address_change_notification (void *cls,
215                                    const struct GNUNET_NAT_AddressChangeNotificationMessage *acn)
216 {
217   size_t alen = ntohs (acn->header.size) - sizeof (*acn);
218
219   switch (alen)
220   {
221   case sizeof (struct sockaddr_in):
222     {
223       const struct sockaddr_in *s4
224         = (const struct sockaddr_in *) &acn[1];
225       if (AF_INET != s4->sin_family)
226       {
227         GNUNET_break (0);
228         return GNUNET_SYSERR;
229       }
230     }
231     break;
232   case sizeof (struct sockaddr_in6):
233     {
234       const struct sockaddr_in6 *s6
235         = (const struct sockaddr_in6 *) &acn[1];
236       if (AF_INET6 != s6->sin6_family)
237       {
238         GNUNET_break (0);
239         return GNUNET_SYSERR;
240       }
241     }
242     break;
243   default:
244     GNUNET_break (0);
245     return GNUNET_SYSERR;
246   }
247   return GNUNET_OK;
248 }
249
250   
251 /**
252  * Handle connection reversal request.
253  *
254  * @param cls our `struct GNUNET_NAT_Handle`
255  * @param acn the message
256  */
257 static void
258 handle_address_change_notification (void *cls,
259                                     const struct GNUNET_NAT_AddressChangeNotificationMessage *acn)
260 {
261   struct GNUNET_NAT_Handle *nh = cls;
262   size_t alen = ntohs (acn->header.size) - sizeof (*acn);
263   const struct sockaddr *sa = (const struct sockaddr *) &acn[1];
264   enum GNUNET_NAT_AddressClass ac;
265   struct AddrEntry *ae;
266
267   ac = (enum GNUNET_NAT_AddressClass) ntohl (acn->addr_class);
268   if (GNUNET_YES == ntohl (acn->add_remove))
269   {
270     ae = GNUNET_malloc (sizeof (*ae) + alen);
271     ae->ac = ac;
272     ae->addrlen = alen;
273     GNUNET_memcpy (&ae[1],
274                    sa,
275                    alen);
276     GNUNET_CONTAINER_DLL_insert (nh->ae_head,
277                                  nh->ae_tail,
278                                  ae);
279   }
280   else
281   {
282     for (ae = nh->ae_head; NULL != ae; ae = ae->next)
283       if ( (ae->addrlen == alen) &&
284            (0 == memcmp (&ae[1],
285                          sa,
286                          alen)) )
287         break;
288     if (NULL == ae)
289     {
290       GNUNET_break (0);
291       reconnect (nh);
292       return;
293     }
294     GNUNET_CONTAINER_DLL_remove (nh->ae_head,
295                                  nh->ae_tail,
296                                  ae);
297     GNUNET_free (ae);
298   }
299   nh->address_callback (nh->callback_cls,
300                         ntohl (acn->add_remove),
301                         ac,
302                         sa,
303                         alen);
304 }
305
306
307 /**
308  * Handle queue errors by reconnecting to NAT.
309  *
310  * @param cls the `struct GNUNET_NAT_Handle *`
311  * @param error details about the error
312  */
313 static void
314 mq_error_handler (void *cls,
315                   enum GNUNET_MQ_Error error)
316 {
317   struct GNUNET_NAT_Handle *nh = cls;
318
319   reconnect (nh);
320 }
321
322
323 /**
324  * Task to connect to the NAT service.
325  *
326  * @param cls our `struct GNUNET_NAT_Handle *`
327  */
328 static void
329 do_connect (void *cls)
330 {
331   struct GNUNET_NAT_Handle *nh = cls;
332   struct GNUNET_MQ_MessageHandler handlers[] = {
333     GNUNET_MQ_hd_var_size (connection_reversal_request,
334                            GNUNET_MESSAGE_TYPE_NAT_CONNECTION_REVERSAL_REQUESTED,
335                            struct GNUNET_NAT_ConnectionReversalRequestedMessage,
336                            nh),
337     GNUNET_MQ_hd_var_size (address_change_notification,
338                            GNUNET_MESSAGE_TYPE_NAT_ADDRESS_CHANGE,
339                            struct GNUNET_NAT_AddressChangeNotificationMessage,
340                            nh),
341     GNUNET_MQ_handler_end ()
342   };
343   struct GNUNET_MQ_Envelope *env;
344
345   nh->reconnect_task = NULL;
346   nh->mq = GNUNET_CLIENT_connect (nh->cfg,
347                                   "nat",
348                                   handlers,
349                                   &mq_error_handler,
350                                   nh);
351   if (NULL == nh->mq)
352   {
353     reconnect (nh);
354     return;
355   }
356   env = GNUNET_MQ_msg_copy (nh->reg);
357   GNUNET_MQ_send (nh->mq,
358                   env);
359 }
360
361
362 /**
363  * Attempt to enable port redirection and detect public IP address
364  * contacting UPnP or NAT-PMP routers on the local network. Use @a
365  * addr to specify to which of the local host's addresses should the
366  * external port be mapped. The port is taken from the corresponding
367  * sockaddr_in[6] field.  The NAT module should call the given @a
368  * address_callback for any 'plausible' external address.
369  *
370  * @param cfg configuration to use
371  * @param config_section name of the configuration section for optionsx
372  * @param proto protocol this is about, IPPROTO_TCP or IPPROTO_UDP
373  * @param num_addrs number of addresses in @a addrs
374  * @param addrs list of local addresses packets should be redirected to
375  * @param addrlens actual lengths of the addresses in @a addrs
376  * @param address_callback function to call everytime the public IP address changes
377  * @param reversal_callback function to call if someone wants connection reversal from us,
378  *        NULL if connection reversal is not supported
379  * @param callback_cls closure for callbacks
380  * @return NULL on error, otherwise handle that can be used to unregister
381  */
382 struct GNUNET_NAT_Handle *
383 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
384                      const char *config_section,
385                      uint8_t proto,
386                      unsigned int num_addrs,
387                      const struct sockaddr **addrs,
388                      const socklen_t *addrlens,
389                      GNUNET_NAT_AddressCallback address_callback,
390                      GNUNET_NAT_ReversalCallback reversal_callback,
391                      void *callback_cls)
392 {
393   struct GNUNET_NAT_Handle *nh;
394   struct GNUNET_NAT_RegisterMessage *rm;
395   size_t len;
396   size_t str_len;
397   char *off;
398   
399   len = 0;
400   for (unsigned int i=0;i<num_addrs;i++)
401     len += addrlens[i];
402   str_len = strlen (config_section) + 1;
403   len += str_len;
404   if ( (len > GNUNET_SERVER_MAX_MESSAGE_SIZE - sizeof (*rm)) ||
405        (num_addrs > UINT16_MAX) )
406   {
407     GNUNET_break (0);
408     return NULL;
409   }
410   rm = GNUNET_malloc (sizeof (*rm) + len);
411   rm->header.size = htons (sizeof (*rm) + len);
412   rm->header.type = htons (GNUNET_MESSAGE_TYPE_NAT_REGISTER);
413   rm->flags = GNUNET_NAT_RF_NONE;
414   if (NULL != address_callback)
415     rm->flags |= GNUNET_NAT_RF_ADDRESSES;
416   if (NULL != reversal_callback)
417     rm->flags |= GNUNET_NAT_RF_REVERSAL;
418   rm->proto = proto;
419   rm->str_len = htons (str_len);
420   rm->num_addrs = htons ((uint16_t) num_addrs);
421   off = (char *) &rm[1];
422   for (unsigned int i=0;i<num_addrs;i++)
423   {
424     switch (addrs[i]->sa_family)
425     {
426     case AF_INET:
427       if (sizeof (struct sockaddr_in) != addrlens[i])
428       {
429         GNUNET_break (0);
430         return NULL;
431       }
432       break;
433     case AF_INET6:
434       if (sizeof (struct sockaddr_in6) != addrlens[i])
435       {
436         GNUNET_break (0);
437         return NULL;
438       }
439       break;
440 #if AF_UNIX
441     case AF_UNIX:
442       if (sizeof (struct sockaddr_un) != addrlens[i])
443       {
444         GNUNET_break (0);
445         return NULL;
446       }
447       break;
448 #endif
449     default:
450       GNUNET_break (0);
451       return NULL;
452     }
453     GNUNET_memcpy (off,
454                    addrs[i],
455                    addrlens[i]);
456     off += addrlens[i];
457   }
458   GNUNET_memcpy (off,
459                  config_section,
460                  str_len);
461
462   nh = GNUNET_new (struct GNUNET_NAT_Handle);
463   nh->reg = &rm->header;
464   nh->cfg = cfg;
465   nh->address_callback = address_callback;
466   nh->reversal_callback = reversal_callback;
467   nh->callback_cls = callback_cls;
468   do_connect (nh);
469   return nh;
470 }
471
472
473 /**
474  * Check if an incoming message is a STUN message.
475  *
476  * @param data the packet
477  * @param len the length of the packet in @a data
478  * @return #GNUNET_YES if @a data is a STUN packet,
479  *         #GNUNET_NO if the packet is invalid (not a stun packet)
480  */
481 static int
482 test_stun_packet (const void *data,
483                   size_t len)
484 {
485   const struct stun_header *hdr;
486   const struct stun_attr *attr;
487   uint32_t advertised_message_size;
488   uint32_t message_magic_cookie;
489
490   /* On entry, 'len' is the length of the UDP payload. After the
491    * initial checks it becomes the size of unprocessed options,
492    * while 'data' is advanced accordingly.
493    */
494   if (len < sizeof(struct stun_header))
495   {
496     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
497                 "STUN packet too short (only %d, wanting at least %d)\n",
498                 (int) len,
499                 (int) sizeof (struct stun_header));
500     return GNUNET_NO;
501   }
502   hdr = (const struct stun_header *) data;
503   /* Skip header as it is already in hdr */
504   len -= sizeof (struct stun_header);
505   data += sizeof (struct stun_header);
506
507   /* len as advertised in the message */
508   advertised_message_size = ntohs (hdr->msglen);
509
510   message_magic_cookie = ntohl (hdr->magic);
511   /* Compare if the cookie match */
512   if (STUN_MAGIC_COOKIE != message_magic_cookie)
513   {
514     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
515                 "Invalid magic cookie for STUN\n");
516     return GNUNET_NO;
517   }
518
519   if (advertised_message_size > len)
520   {
521     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
522                 "Scrambled STUN packet length (got %d, expecting %d)\n",
523                 advertised_message_size,
524                 (int)len);
525     return GNUNET_NO;
526   }
527   len = advertised_message_size;
528   while (len > 0)
529   {
530     if (len < sizeof (struct stun_attr))
531     {
532       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
533                   "Attribute too short in STUN packet (got %d, expecting %d)\n",
534                   (int) len,
535                   (int) sizeof(struct stun_attr));
536       return GNUNET_NO;
537     }
538     attr = (const struct stun_attr *) data;
539
540     /* compute total attribute length */
541     advertised_message_size = ntohs (attr->len) + sizeof(struct stun_attr);
542
543     /* Check if we still have space in our buffer */
544     if (advertised_message_size > len)
545     {
546       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
547                   "Inconsistent Attribute (length %d exceeds remaining msg len %d)\n",
548                   advertised_message_size,
549                   (int) len);
550       return GNUNET_NO;
551     }
552     data += advertised_message_size;
553     len -= advertised_message_size;
554   }
555   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
556               "STUN Packet, msg %04x, length: %d\n",
557               ntohs (hdr->msgtype),
558               advertised_message_size);
559   return GNUNET_OK;
560 }
561
562
563 /**
564  * Handle an incoming STUN message.  This function is useful as
565  * some GNUnet service may be listening on a UDP port and might
566  * thus receive STUN messages while trying to receive other data.
567  * In this case, this function can be used to process replies
568  * to STUN requests.
569  *
570  * The function does some basic sanity checks on packet size and
571  * content, try to extract a bit of information.
572  * 
573  * At the moment this only processes BIND requests, and returns the
574  * externally visible address of the request to the rest of the
575  * NAT logic.
576  *
577  * @param nh handle to the NAT service
578  * @param sender_addr address from which we got @a data
579  * @param sender_addr_len number of bytes in @a sender_addr
580  * @param data the packet
581  * @param data_size number of bytes in @a data
582  * @return #GNUNET_OK on success
583  *         #GNUNET_NO if the packet is not a STUN packet
584  *         #GNUNET_SYSERR on internal error handling the packet
585  */
586 int
587 GNUNET_NAT_stun_handle_packet (struct GNUNET_NAT_Handle *nh,
588                                const struct sockaddr *sender_addr,
589                                size_t sender_addr_len,
590                                const void *data,
591                                size_t data_size)
592 {
593   struct GNUNET_MQ_Envelope *env;
594   struct GNUNET_NAT_HandleStunMessage *hsn;
595   char *buf;
596
597   if (GNUNET_YES !=
598       test_stun_packet (data,
599                         data_size))
600     return GNUNET_NO;
601   if (NULL == nh->mq)
602     return GNUNET_SYSERR;
603   env = GNUNET_MQ_msg_extra (hsn,
604                              data_size + sender_addr_len,
605                              GNUNET_MESSAGE_TYPE_NAT_HANDLE_STUN);
606   hsn->sender_addr_size = htons ((uint16_t) sender_addr_len);
607   hsn->payload_size = htons ((uint16_t) data_size);
608   buf = (char *) &hsn[1];
609   GNUNET_memcpy (buf,
610                  sender_addr,
611                  sender_addr_len);
612   buf += sender_addr_len;
613   GNUNET_memcpy (buf,
614                  data,
615                  data_size);
616   GNUNET_MQ_send (nh->mq,
617                   env);
618   return GNUNET_OK;
619 }
620
621
622 /**
623  * Test if the given address is (currently) a plausible IP address for
624  * this peer.  Mostly a convenience function so that clients do not
625  * have to explicitly track all IPs that the #GNUNET_NAT_AddressCallback
626  * has returned so far.
627  *
628  * @param nh the handle returned by register
629  * @param addr IP address to test (IPv4 or IPv6)
630  * @param addrlen number of bytes in @a addr
631  * @return #GNUNET_YES if the address is plausible,
632  *         #GNUNET_NO if the address is not plausible,
633  *         #GNUNET_SYSERR if the address is malformed
634  */
635 int
636 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *nh,
637                          const void *addr,
638                          socklen_t addrlen)
639 {
640   struct AddrEntry *ae;
641
642   if ( (addrlen != sizeof (struct sockaddr_in)) &&
643        (addrlen != sizeof (struct sockaddr_in6)) )
644   {
645     GNUNET_break (0);
646     return GNUNET_SYSERR;
647   }
648   for (ae = nh->ae_head; NULL != ae; ae = ae->next)
649     if ( (addrlen == ae->addrlen) &&
650          (0 == memcmp (addr,
651                        &ae[1],
652                        addrlen)) )
653       return GNUNET_YES;
654   return GNUNET_NO;
655 }
656
657
658 /**
659  * We learned about a peer (possibly behind NAT) so run the
660  * gnunet-nat-client to send dummy ICMP responses to cause
661  * that peer to connect to us (connection reversal).
662  *
663  * @param nh handle (used for configuration)
664  * @param local_sa our local address of the peer (IPv4-only)
665  * @param remote_sa the remote address of the peer (IPv4-only)
666  * @return #GNUNET_SYSERR on error, 
667  *         #GNUNET_NO if connection reversal is unavailable,
668  *         #GNUNET_OK otherwise (presumably in progress)
669  */
670 int
671 GNUNET_NAT_request_reversal (struct GNUNET_NAT_Handle *nh,
672                              const struct sockaddr_in *local_sa,
673                              const struct sockaddr_in *remote_sa)
674 {
675   struct GNUNET_MQ_Envelope *env;
676   struct GNUNET_NAT_RequestConnectionReversalMessage *req;
677   char *buf;
678
679   if (NULL == nh->mq)
680     return GNUNET_SYSERR;
681   GNUNET_break (AF_INET == local_sa->sin_family);
682   GNUNET_break (AF_INET == remote_sa->sin_family);
683   env = GNUNET_MQ_msg_extra (req,
684                              2 * sizeof (struct sockaddr_in),
685                              GNUNET_MESSAGE_TYPE_NAT_REQUEST_CONNECTION_REVERSAL);
686   req->local_addr_size = htons (sizeof (struct sockaddr_in));
687   req->remote_addr_size = htons (sizeof (struct sockaddr_in));
688   buf = (char *) &req[1];
689   GNUNET_memcpy (buf,
690                  local_sa,
691                  sizeof (struct sockaddr_in));
692   buf += sizeof (struct sockaddr_in);
693   GNUNET_memcpy (buf,
694                  remote_sa,
695                  sizeof (struct sockaddr_in));
696   GNUNET_MQ_send (nh->mq,
697                   env);
698   return GNUNET_OK;
699 }
700
701
702 /**
703  * Stop port redirection and public IP address detection for the given
704  * handle.  This frees the handle, after having sent the needed
705  * commands to close open ports.
706  *
707  * @param nh the handle to stop
708  */
709 void
710 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *nh)
711 {
712   if (NULL != nh->mq)
713   {
714     GNUNET_MQ_destroy (nh->mq);
715     nh->mq = NULL;
716   }
717   if (NULL != nh->reconnect_task)
718   {
719     GNUNET_SCHEDULER_cancel (nh->reconnect_task);
720     nh->reconnect_task = NULL;
721   }
722   GNUNET_free (nh->reg);
723   GNUNET_free (nh);
724 }
725
726
727 /* end of nat_api.c */