src/nat/nat_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2007-2016 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 proto protocol this is about, IPPROTO_TCP or IPPROTO_UDP
 372  * @param adv_port advertised port (port we are either bound to or that our OS
 373  *                 locally performs redirection from to our bound port).
 374  * @param num_addrs number of addresses in @a addrs
 375  * @param addrs list of local addresses packets should be redirected to
 376  * @param addrlens actual lengths of the addresses in @a addrs
 377  * @param address_callback function to call everytime the public IP address changes
 378  * @param reversal_callback function to call if someone wants connection reversal from us,
 379  *        NULL if connection reversal is not supported
 380  * @param callback_cls closure for callbacks
 381  * @return NULL on error, otherwise handle that can be used to unregister
 382  */
 383 struct GNUNET_NAT_Handle *
 384 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
 385                      uint8_t proto,
 386                      uint16_t adv_port,
 387                      unsigned int num_addrs,
 388                      const struct sockaddr **addrs,
 389                      const socklen_t *addrlens,
 390                      GNUNET_NAT_AddressCallback address_callback,
 391                      GNUNET_NAT_ReversalCallback reversal_callback,
 392                      void *callback_cls)
 393 {
 394   struct GNUNET_NAT_Handle *nh;
 395   struct GNUNET_NAT_RegisterMessage *rm;
 396   size_t len;
 397   char *off;
 398
 399   len = 0;
 400   for (unsigned int i=0;i<num_addrs;i++)
 401     len += addrlens[i];
 402   if ( (len > GNUNET_SERVER_MAX_MESSAGE_SIZE - sizeof (*rm)) ||
 403        (num_addrs > UINT16_MAX) )
 404   {
 405     GNUNET_break (0);
 406     return NULL;
 407   }
 408   rm = GNUNET_malloc (sizeof (*rm) + len);
 409   rm->header.size = htons (sizeof (*rm) + len);
 410   rm->header.type = htons (GNUNET_MESSAGE_TYPE_NAT_REGISTER);
 411   rm->flags = GNUNET_NAT_RF_NONE;
 412   if (NULL != address_callback)
 413     rm->flags |= GNUNET_NAT_RF_ADDRESSES;
 414   if (NULL != reversal_callback)
 415     rm->flags |= GNUNET_NAT_RF_REVERSAL;
 416   rm->proto = proto;
 417   rm->adv_port = htons (adv_port);
 418   rm->num_addrs = htons ((uint16_t) num_addrs);
 419   off = (char *) &rm[1];
 420   for (unsigned int i=0;i<num_addrs;i++)
 421   {
 422     switch (addrs[i]->sa_family)
 423     {
 424     case AF_INET:
 425       if (sizeof (struct sockaddr_in) != addrlens[i])
 426       {
 427         GNUNET_break (0);
 428         return NULL;
 429       }
 430       break;
 431     case AF_INET6:
 432       if (sizeof (struct sockaddr_in6) != addrlens[i])
 433       {
 434         GNUNET_break (0);
 435         return NULL;
 436       }
 437       break;
 438 #if AF_UNIX
 439     case AF_UNIX:
 440       if (sizeof (struct sockaddr_un) != addrlens[i])
 441       {
 442         GNUNET_break (0);
 443         return NULL;
 444       }
 445       break;
 446 #endif
 447     default:
 448       GNUNET_break (0);
 449       return NULL;
 450     }
 451     GNUNET_memcpy (off,
 452                    addrs[i],
 453                    addrlens[i]);
 454     off += addrlens[i];
 455   }
 456
 457   nh = GNUNET_new (struct GNUNET_NAT_Handle);
 458   nh->reg = &rm->header;
 459   nh->cfg = cfg;
 460   nh->address_callback = address_callback;
 461   nh->reversal_callback = reversal_callback;
 462   nh->callback_cls = callback_cls;
 463   do_connect (nh);
 464   return nh;
 465 }
 466
 467
 468 /**
 469  * Check if an incoming message is a STUN message.
 470  *
 471  * @param data the packet
 472  * @param len the length of the packet in @a data
 473  * @return #GNUNET_YES if @a data is a STUN packet,
 474  *         #GNUNET_NO if the packet is invalid (not a stun packet)
 475  */
 476 static int
 477 test_stun_packet (const void *data,
 478                   size_t len)
 479 {
 480   const struct stun_header *hdr;
 481   const struct stun_attr *attr;
 482   uint32_t advertised_message_size;
 483   uint32_t message_magic_cookie;
 484
 485   /* On entry, 'len' is the length of the UDP payload. After the
 486    * initial checks it becomes the size of unprocessed options,
 487    * while 'data' is advanced accordingly.
 488    */
 489   if (len < sizeof(struct stun_header))
 490   {
 491     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 492                 "STUN packet too short (only %d, wanting at least %d)\n",
 493                 (int) len,
 494                 (int) sizeof (struct stun_header));
 495     return GNUNET_NO;
 496   }
 497   hdr = (const struct stun_header *) data;
 498   /* Skip header as it is already in hdr */
 499   len -= sizeof (struct stun_header);
 500   data += sizeof (struct stun_header);
 501
 502   /* len as advertised in the message */
 503   advertised_message_size = ntohs (hdr->msglen);
 504
 505   message_magic_cookie = ntohl (hdr->magic);
 506   /* Compare if the cookie match */
 507   if (STUN_MAGIC_COOKIE != message_magic_cookie)
 508   {
 509     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 510                 "Invalid magic cookie for STUN\n");
 511     return GNUNET_NO;
 512   }
 513
 514   if (advertised_message_size > len)
 515   {
 516     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 517                 "Scrambled STUN packet length (got %d, expecting %d)\n",
 518                 advertised_message_size,
 519                 (int)len);
 520     return GNUNET_NO;
 521   }
 522   len = advertised_message_size;
 523   while (len > 0)
 524   {
 525     if (len < sizeof (struct stun_attr))
 526     {
 527       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 528                   "Attribute too short in STUN packet (got %d, expecting %d)\n",
 529                   (int) len,
 530                   (int) sizeof(struct stun_attr));
 531       return GNUNET_NO;
 532     }
 533     attr = (const struct stun_attr *) data;
 534
 535     /* compute total attribute length */
 536     advertised_message_size = ntohs (attr->len) + sizeof(struct stun_attr);
 537
 538     /* Check if we still have space in our buffer */
 539     if (advertised_message_size > len)
 540     {
 541       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 542                   "Inconsistent Attribute (length %d exceeds remaining msg len %d)\n",
 543                   advertised_message_size,
 544                   (int) len);
 545       return GNUNET_NO;
 546     }
 547     data += advertised_message_size;
 548     len -= advertised_message_size;
 549   }
 550   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 551               "STUN Packet, msg %04x, length: %d\n",
 552               ntohs (hdr->msgtype),
 553               advertised_message_size);
 554   return GNUNET_OK;
 555 }
 556
 557
 558 /**
 559  * Handle an incoming STUN message.  This function is useful as
 560  * some GNUnet service may be listening on a UDP port and might
 561  * thus receive STUN messages while trying to receive other data.
 562  * In this case, this function can be used to process replies
 563  * to STUN requests.
 564  *
 565  * The function does some basic sanity checks on packet size and
 566  * content, try to extract a bit of information.
 567  *
 568  * At the moment this only processes BIND requests, and returns the
 569  * externally visible address of the request to the rest of the
 570  * NAT logic.
 571  *
 572  * @param nh handle to the NAT service
 573  * @param sender_addr address from which we got @a data
 574  * @param sender_addr_len number of bytes in @a sender_addr
 575  * @param data the packet
 576  * @param data_size number of bytes in @a data
 577  * @return #GNUNET_OK on success
 578  *         #GNUNET_NO if the packet is not a STUN packet
 579  *         #GNUNET_SYSERR on internal error handling the packet
 580  */
 581 int
 582 GNUNET_NAT_stun_handle_packet (struct GNUNET_NAT_Handle *nh,
 583                                const struct sockaddr *sender_addr,
 584                                size_t sender_addr_len,
 585                                const void *data,
 586                                size_t data_size)
 587 {
 588   struct GNUNET_MQ_Envelope *env;
 589   struct GNUNET_NAT_HandleStunMessage *hsn;
 590   char *buf;
 591
 592   if (GNUNET_YES !=
 593       test_stun_packet (data,
 594                         data_size))
 595     return GNUNET_NO;
 596   if (NULL == nh->mq)
 597     return GNUNET_SYSERR;
 598   env = GNUNET_MQ_msg_extra (hsn,
 599                              data_size + sender_addr_len,
 600                              GNUNET_MESSAGE_TYPE_NAT_HANDLE_STUN);
 601   hsn->sender_addr_size = htons ((uint16_t) sender_addr_len);
 602   hsn->payload_size = htons ((uint16_t) data_size);
 603   buf = (char *) &hsn[1];
 604   GNUNET_memcpy (buf,
 605                  sender_addr,
 606                  sender_addr_len);
 607   buf += sender_addr_len;
 608   GNUNET_memcpy (buf,
 609                  data,
 610                  data_size);
 611   GNUNET_MQ_send (nh->mq,
 612                   env);
 613   return GNUNET_OK;
 614 }
 615
 616
 617 /**
 618  * Test if the given address is (currently) a plausible IP address for
 619  * this peer.  Mostly a convenience function so that clients do not
 620  * have to explicitly track all IPs that the #GNUNET_NAT_AddressCallback
 621  * has returned so far.
 622  *
 623  * @param nh the handle returned by register
 624  * @param addr IP address to test (IPv4 or IPv6)
 625  * @param addrlen number of bytes in @a addr
 626  * @return #GNUNET_YES if the address is plausible,
 627  *         #GNUNET_NO if the address is not plausible,
 628  *         #GNUNET_SYSERR if the address is malformed
 629  */
 630 int
 631 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *nh,
 632                          const void *addr,
 633                          socklen_t addrlen)
 634 {
 635   struct AddrEntry *ae;
 636
 637   if ( (addrlen != sizeof (struct sockaddr_in)) &&
 638        (addrlen != sizeof (struct sockaddr_in6)) )
 639   {
 640     GNUNET_break (0);
 641     return GNUNET_SYSERR;
 642   }
 643   for (ae = nh->ae_head; NULL != ae; ae = ae->next)
 644     if ( (addrlen == ae->addrlen) &&
 645          (0 == memcmp (addr,
 646                        &ae[1],
 647                        addrlen)) )
 648       return GNUNET_YES;
 649   return GNUNET_NO;
 650 }
 651
 652
 653 /**
 654  * We learned about a peer (possibly behind NAT) so run the
 655  * gnunet-nat-client to send dummy ICMP responses to cause
 656  * that peer to connect to us (connection reversal).
 657  *
 658  * @param nh handle (used for configuration)
 659  * @param local_sa our local address of the peer (IPv4-only)
 660  * @param remote_sa the remote address of the peer (IPv4-only)
 661  * @return #GNUNET_SYSERR on error,
 662  *         #GNUNET_NO if connection reversal is unavailable,
 663  *         #GNUNET_OK otherwise (presumably in progress)
 664  */
 665 int
 666 GNUNET_NAT_request_reversal (struct GNUNET_NAT_Handle *nh,
 667                              const struct sockaddr_in *local_sa,
 668                              const struct sockaddr_in *remote_sa)
 669 {
 670   struct GNUNET_MQ_Envelope *env;
 671   struct GNUNET_NAT_RequestConnectionReversalMessage *req;
 672   char *buf;
 673
 674   if (NULL == nh->mq)
 675     return GNUNET_SYSERR;
 676   env = GNUNET_MQ_msg_extra (req,
 677                              2 * sizeof (struct sockaddr_in),
 678                              GNUNET_MESSAGE_TYPE_NAT_REQUEST_CONNECTION_REVERSAL);
 679   req->local_addr_size = htons (sizeof (struct sockaddr_in));
 680   req->remote_addr_size = htons (sizeof (struct sockaddr_in));
 681   buf = (char *) &req[1];
 682   GNUNET_memcpy (buf,
 683                  local_sa,
 684                  sizeof (struct sockaddr_in));
 685   buf += sizeof (struct sockaddr_in);
 686   GNUNET_memcpy (buf,
 687                  remote_sa,
 688                  sizeof (struct sockaddr_in));
 689   GNUNET_MQ_send (nh->mq,
 690                   env);
 691   return GNUNET_OK;
 692 }
 693
 694
 695 /**
 696  * Stop port redirection and public IP address detection for the given
 697  * handle.  This frees the handle, after having sent the needed
 698  * commands to close open ports.
 699  *
 700  * @param nh the handle to stop
 701  */
 702 void
 703 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *nh)
 704 {
 705   GNUNET_MQ_destroy (nh->mq);
 706   GNUNET_free (nh->reg);
 707   GNUNET_free (nh);
 708 }
 709
 710
 711
 712 /**
 713  * Handle to auto-configuration in progress.
 714  */
 715 struct GNUNET_NAT_AutoHandle
 716 {
 717
 718   /**
 719    * Configuration we use.
 720    */
 721   const struct GNUNET_CONFIGURATION_Handle *cfg;
 722
 723   /**
 724    * Message queue for communicating with the NAT service.
 725    */
 726   struct GNUNET_MQ_Handle *mq;
 727
 728   /**
 729    * Function called with the result from the autoconfiguration.
 730    */
 731   GNUNET_NAT_AutoResultCallback arc;
 732
 733   /**
 734    * Closure for @e arc.
 735    */
 736   void *arc_cls;
 737
 738 };
 739
 740
 741 /**
 742  * Converts `enum GNUNET_NAT_StatusCode` to string
 743  *
 744  * @param err error code to resolve to a string
 745  * @return point to a static string containing the error code
 746  */
 747 const char *
 748 GNUNET_NAT_status2string (enum GNUNET_NAT_StatusCode err)
 749 {
 750   switch (err)
 751   {
 752   case GNUNET_NAT_ERROR_SUCCESS:
 753     return _ ("Operation Successful");
 754   case GNUNET_NAT_ERROR_IPC_FAILURE:
 755     return _ ("IPC failure");
 756   case GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR:
 757     return _ ("Failure in network subsystem, check permissions.");
 758   case GNUNET_NAT_ERROR_TIMEOUT:
 759     return _ ("Encountered timeout while performing operation");
 760   case GNUNET_NAT_ERROR_NOT_ONLINE:
 761     return _ ("detected that we are offline");
 762   case GNUNET_NAT_ERROR_UPNPC_NOT_FOUND:
 763     return _ ("`upnpc` command not found");
 764   case GNUNET_NAT_ERROR_UPNPC_FAILED:
 765     return _ ("Failed to run `upnpc` command");
 766   case GNUNET_NAT_ERROR_UPNPC_TIMEOUT:
 767     return _ ("`upnpc' command took too long, process killed");
 768   case GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED:
 769     return _ ("`upnpc' command failed to establish port mapping");
 770   case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND:
 771     return _ ("`external-ip' command not found");
 772   case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED:
 773     return _ ("Failed to run `external-ip` command");
 774   case GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID:
 775     return _ ("`external-ip' command output invalid");
 776   case GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID:
 777     return _ ("no valid address was returned by `external-ip'");
 778   case GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO:
 779     return _ ("Could not determine interface with internal/local network address");
 780   case GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND:
 781     return _ ("No functioning gnunet-helper-nat-server installation found");
 782   case GNUNET_NAT_ERROR_NAT_TEST_START_FAILED:
 783     return _ ("NAT test could not be initialized");
 784   case GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT:
 785     return _ ("NAT test timeout reached");
 786   case GNUNET_NAT_ERROR_NAT_REGISTER_FAILED:
 787     return _ ("could not register NAT");
 788   case GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND:
 789     return _ ("No working gnunet-helper-nat-client installation found");
 790   default:
 791     return "unknown status code";
 792   }
 793 }
 794
 795
 796 /**
 797  * Check result from autoconfiguration attempt.
 798  *
 799  * @param cls the `struct GNUNET_NAT_AutoHandle`
 800  * @param res the result
 801  * @return #GNUNET_OK if @a res is well-formed (always for now)
 802  */
 803 static int
 804 check_auto_result (void *cls,
 805                    const struct GNUNET_NAT_AutoconfigResultMessage *res)
 806 {
 807   return GNUNET_OK;
 808 }
 809
 810
 811 /**
 812  * Handle result from autoconfiguration attempt.
 813  *
 814  * @param cls the `struct GNUNET_NAT_AutoHandle`
 815  * @param res the result
 816  */
 817 static void
 818 handle_auto_result (void *cls,
 819                     const struct GNUNET_NAT_AutoconfigResultMessage *res)
 820 {
 821   struct GNUNET_NAT_AutoHandle *ah = cls;
 822   size_t left;
 823   struct GNUNET_CONFIGURATION_Handle *cfg;
 824   enum GNUNET_NAT_Type type
 825     = (enum GNUNET_NAT_Type) ntohl (res->type);
 826   enum GNUNET_NAT_StatusCode status
 827     = (enum GNUNET_NAT_StatusCode) ntohl (res->status_code);
 828
 829   left = ntohs (res->header.size) - sizeof (*res);
 830   cfg = GNUNET_CONFIGURATION_create ();
 831   if (GNUNET_OK !=
 832       GNUNET_CONFIGURATION_deserialize (cfg,
 833                                         (const char *) &res[1],
 834                                         left,
 835                                         GNUNET_NO))
 836   {
 837     GNUNET_break (0);
 838     ah->arc (ah->arc_cls,
 839              NULL,
 840              GNUNET_NAT_ERROR_IPC_FAILURE,
 841              type);
 842   }
 843   else
 844   {
 845     ah->arc (ah->arc_cls,
 846              cfg,
 847              status,
 848              type);
 849   }
 850   GNUNET_CONFIGURATION_destroy (cfg);
 851   GNUNET_NAT_autoconfig_cancel (ah);
 852 }
 853
 854
 855 /**
 856  * Handle queue errors by reporting autoconfiguration failure.
 857  *
 858  * @param cls the `struct GNUNET_NAT_AutoHandle *`
 859  * @param error details about the error
 860  */
 861 static void
 862 ah_error_handler (void *cls,
 863                   enum GNUNET_MQ_Error error)
 864 {
 865   struct GNUNET_NAT_AutoHandle *ah = cls;
 866
 867   ah->arc (ah->arc_cls,
 868            NULL,
 869            GNUNET_NAT_ERROR_IPC_FAILURE,
 870            GNUNET_NAT_TYPE_UNKNOWN);
 871   GNUNET_NAT_autoconfig_cancel (ah);
 872 }
 873
 874
 875 /**
 876  * Start auto-configuration routine.  The transport adapters should
 877  * be stopped while this function is called.
 878  *
 879  * @param cfg initial configuration
 880  * @param cb function to call with autoconfiguration result
 881  * @param cb_cls closure for @a cb
 882  * @return handle to cancel operation
 883  */
 884 struct GNUNET_NAT_AutoHandle *
 885 GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 886                              GNUNET_NAT_AutoResultCallback cb,
 887                              void *cb_cls)
 888 {
 889   struct GNUNET_NAT_AutoHandle *ah = GNUNET_new (struct GNUNET_NAT_AutoHandle);
 890   struct GNUNET_MQ_MessageHandler handlers[] = {
 891     GNUNET_MQ_hd_var_size (auto_result,
 892                            GNUNET_MESSAGE_TYPE_NAT_AUTO_CFG_RESULT,
 893                            struct GNUNET_NAT_AutoconfigResultMessage,
 894                            ah),
 895     GNUNET_MQ_handler_end ()
 896   };
 897   struct GNUNET_MQ_Envelope *env;
 898   struct GNUNET_NAT_AutoconfigRequestMessage *req;
 899   char *buf;
 900   size_t size;
 901
 902   buf = GNUNET_CONFIGURATION_serialize (cfg,
 903                                         &size);
 904   if (size > GNUNET_SERVER_MAX_MESSAGE_SIZE - sizeof (*req))
 905   {
 906     GNUNET_break (0);
 907     GNUNET_free (buf);
 908     GNUNET_free (ah);
 909     return NULL;
 910   }
 911   ah->arc = cb;
 912   ah->arc_cls = cb_cls;
 913   ah->mq = GNUNET_CLIENT_connecT (cfg,
 914                                   "nat",
 915                                   handlers,
 916                                   &ah_error_handler,
 917                                   ah);
 918   if (NULL == ah->mq)
 919   {
 920     GNUNET_break (0);
 921     GNUNET_free (buf);
 922     GNUNET_free (ah);
 923     return NULL;
 924   }
 925   env = GNUNET_MQ_msg_extra (req,
 926                              size,
 927                              GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG);
 928   GNUNET_memcpy (&req[1],
 929                  buf,
 930                  size);
 931   GNUNET_free (buf);
 932   GNUNET_MQ_send (ah->mq,
 933                   env);
 934   return ah;
 935 }
 936
 937
 938 /**
 939  * Abort autoconfiguration.
 940  *
 941  * @param ah handle for operation to abort
 942  */
 943 void
 944 GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah)
 945 {
 946   GNUNET_MQ_destroy (ah->mq);
 947   GNUNET_free (ah);
 948 }
 949
 950 /* end of nat_api.c */