src/nat/nat_test.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file nat/nat_test.c
  23  * @brief functions to test if the NAT configuration is successful at achieving NAT traversal (with the help of a gnunet-nat-server)
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_nat_lib.h"
  29 #include "nat.h"
  30
  31 #define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
  32
  33 #define NAT_SERVER_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  34
  35 /**
  36  * Entry we keep for each incoming connection.
  37  */
  38 struct NatActivity
  39 {
  40   /**
  41    * This is a doubly-linked list.
  42    */
  43   struct NatActivity *next;
  44
  45   /**
  46    * This is a doubly-linked list.
  47    */
  48   struct NatActivity *prev;
  49
  50   /**
  51    * Socket of the incoming connection.
  52    */
  53   struct GNUNET_NETWORK_Handle *sock;
  54
  55   /**
  56    * Handle of the master context.
  57    */
  58   struct GNUNET_NAT_Test *h;
  59
  60   /**
  61    * Task reading from the incoming connection.
  62    */
  63   GNUNET_SCHEDULER_TaskIdentifier rtask;
  64 };
  65
  66
  67 /**
  68  * Entry we keep for each connection to the gnunet-nat-service.
  69  */
  70 struct ClientActivity
  71 {
  72   /**
  73    * This is a doubly-linked list.
  74    */
  75   struct ClientActivity *next;
  76
  77   /**
  78    * This is a doubly-linked list.
  79    */
  80   struct ClientActivity *prev;
  81
  82   /**
  83    * Socket of the incoming connection.
  84    */
  85   struct GNUNET_CLIENT_Connection *client;
  86
  87 };
  88
  89
  90 /**
  91  * Handle to a NAT test.
  92  */
  93 struct GNUNET_NAT_Test
  94 {
  95
  96   /**
  97    * Configuration used
  98    */
  99   const struct GNUNET_CONFIGURATION_Handle *cfg;
 100
 101   /**
 102    * Function to call with success report
 103    */
 104   GNUNET_NAT_TestCallback report;
 105
 106   /**
 107    * Closure for @e report.
 108    */
 109   void *report_cls;
 110
 111   /**
 112    * Handle to NAT traversal in use
 113    */
 114   struct GNUNET_NAT_Handle *nat;
 115
 116   /**
 117    * Handle to listen socket, or NULL
 118    */
 119   struct GNUNET_NETWORK_Handle *lsock;
 120
 121   /**
 122    * Head of list of nat activities.
 123    */
 124   struct NatActivity *na_head;
 125
 126   /**
 127    * Tail of list of nat activities.
 128    */
 129   struct NatActivity *na_tail;
 130
 131   /**
 132    * Head of list of client activities.
 133    */
 134   struct ClientActivity *ca_head;
 135
 136   /**
 137    * Tail of list of client activities.
 138    */
 139   struct ClientActivity *ca_tail;
 140
 141   /**
 142    * Identity of task for the listen socket (if any)
 143    */
 144   GNUNET_SCHEDULER_TaskIdentifier ltask;
 145
 146   /**
 147    * GNUNET_YES if we're testing TCP
 148    */
 149   int is_tcp;
 150
 151   /**
 152    * Data that should be transmitted or source-port.
 153    */
 154   uint16_t data;
 155
 156   /**
 157    * Advertised port to the other peer.
 158    */
 159   uint16_t adv_port;
 160
 161 };
 162
 163
 164 /**
 165  * Function called from #GNUNET_NAT_register whenever someone asks us
 166  * to do connection reversal.
 167  *
 168  * @param cls closure, our `struct GNUNET_NAT_Handle`
 169  * @param addr public IP address of the other peer
 170  * @param addrlen actual lenght of the address
 171  */
 172 static void
 173 reversal_cb (void *cls,
 174              const struct sockaddr *addr,
 175              socklen_t addrlen)
 176 {
 177   struct GNUNET_NAT_Test *h = cls;
 178   const struct sockaddr_in *sa;
 179
 180   if (addrlen != sizeof (struct sockaddr_in))
 181     return;
 182   sa = (const struct sockaddr_in *) addr;
 183   if (h->data != sa->sin_port)
 184   {
 185     LOG (GNUNET_ERROR_TYPE_DEBUG,
 186          "Received connection reversal request for wrong port\n");
 187     return;                     /* wrong port */
 188   }
 189   /* report success */
 190   h->report (h->report_cls, GNUNET_OK);
 191 }
 192
 193
 194 /**
 195  * Activity on our incoming socket.  Read data from the
 196  * incoming connection.
 197  *
 198  * @param cls the `struct GNUNET_NAT_Test`
 199  * @param tc scheduler context
 200  */
 201 static void
 202 do_udp_read (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 203 {
 204   struct GNUNET_NAT_Test *tst = cls;
 205   uint16_t data;
 206
 207   tst->ltask =
 208       GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 209                                      tst->lsock,
 210                                      &do_udp_read, tst);
 211   if ((NULL != tc->write_ready) &&
 212       (GNUNET_NETWORK_fdset_isset (tc->read_ready, tst->lsock)) &&
 213       (sizeof (data) ==
 214        GNUNET_NETWORK_socket_recv (tst->lsock, &data, sizeof (data))))
 215   {
 216     if (data == tst->data)
 217       tst->report (tst->report_cls, GNUNET_OK);
 218     else
 219       LOG (GNUNET_ERROR_TYPE_DEBUG,
 220            "Received data mismatches expected value\n");
 221   }
 222   else
 223     LOG (GNUNET_ERROR_TYPE_DEBUG,
 224          "Failed to receive data from inbound connection\n");
 225 }
 226
 227
 228 /**
 229  * Activity on our incoming socket.  Read data from the
 230  * incoming connection.
 231  *
 232  * @param cls the `struct NatActivity`
 233  * @param tc scheduler context
 234  */
 235 static void
 236 do_read (void *cls,
 237          const struct GNUNET_SCHEDULER_TaskContext *tc)
 238 {
 239   struct NatActivity *na = cls;
 240   struct GNUNET_NAT_Test *tst;
 241   uint16_t data;
 242
 243   na->rtask = GNUNET_SCHEDULER_NO_TASK;
 244   tst = na->h;
 245   GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, na);
 246   if ((NULL != tc->write_ready) &&
 247       (GNUNET_NETWORK_fdset_isset (tc->read_ready, na->sock)) &&
 248       (sizeof (data) ==
 249        GNUNET_NETWORK_socket_recv (na->sock, &data, sizeof (data))))
 250   {
 251     if (data == tst->data)
 252       tst->report (tst->report_cls, GNUNET_OK);
 253     else
 254       LOG (GNUNET_ERROR_TYPE_DEBUG,
 255            "Received data mismatches expected value\n");
 256   }
 257   else
 258     LOG (GNUNET_ERROR_TYPE_DEBUG,
 259          "Failed to receive data from inbound connection\n");
 260   GNUNET_NETWORK_socket_close (na->sock);
 261   GNUNET_free (na);
 262 }
 263
 264
 265 /**
 266  * Activity on our listen socket. Accept the
 267  * incoming connection.
 268  *
 269  * @param cls the `struct GNUNET_NAT_Test`
 270  * @param tc scheduler context
 271  */
 272 static void
 273 do_accept (void *cls,
 274            const struct GNUNET_SCHEDULER_TaskContext *tc)
 275 {
 276   struct GNUNET_NAT_Test *tst = cls;
 277   struct GNUNET_NETWORK_Handle *s;
 278   struct NatActivity *wl;
 279
 280   tst->ltask = GNUNET_SCHEDULER_NO_TASK;
 281   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 282     return;
 283   tst->ltask =
 284       GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL, tst->lsock,
 285                                      &do_accept, tst);
 286   s = GNUNET_NETWORK_socket_accept (tst->lsock, NULL, NULL);
 287   if (NULL == s)
 288   {
 289     GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "accept");
 290     return;                     /* odd error */
 291   }
 292   LOG (GNUNET_ERROR_TYPE_DEBUG,
 293        "Got an inbound connection, waiting for data\n");
 294   wl = GNUNET_new (struct NatActivity);
 295   wl->sock = s;
 296   wl->h = tst;
 297   wl->rtask =
 298       GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL, wl->sock,
 299                                      &do_read, wl);
 300   GNUNET_CONTAINER_DLL_insert (tst->na_head, tst->na_tail, wl);
 301 }
 302
 303
 304 /**
 305  * Address-callback, used to send message to gnunet-nat-server.
 306  *
 307  * @param cls closure
 308  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
 309  *     the previous (now invalid) one
 310  * @param addr either the previous or the new public IP address
 311  * @param addrlen actual length of the @a addr
 312  */
 313 static void
 314 addr_cb (void *cls,
 315          int add_remove,
 316          const struct sockaddr *addr,
 317          socklen_t addrlen)
 318 {
 319   struct GNUNET_NAT_Test *h = cls;
 320   struct ClientActivity *ca;
 321   struct GNUNET_CLIENT_Connection *client;
 322   struct GNUNET_NAT_TestMessage msg;
 323   const struct sockaddr_in *sa;
 324
 325   if (GNUNET_YES != add_remove)
 326     return;
 327   if (addrlen != sizeof (struct sockaddr_in))
 328   {
 329     LOG (GNUNET_ERROR_TYPE_DEBUG,
 330          "NAT test ignores IPv6 address `%s' returned from NAT library\n",
 331          GNUNET_a2s (addr, addrlen));
 332     return;                     /* ignore IPv6 here */
 333   }
 334   LOG (GNUNET_ERROR_TYPE_DEBUG, "Asking gnunet-nat-server to connect to `%s'\n",
 335        GNUNET_a2s (addr, addrlen));
 336   sa = (const struct sockaddr_in *) addr;
 337   msg.header.size = htons (sizeof (struct GNUNET_NAT_TestMessage));
 338   msg.header.type = htons (GNUNET_MESSAGE_TYPE_NAT_TEST);
 339   msg.dst_ipv4 = sa->sin_addr.s_addr;
 340   msg.dport = sa->sin_port;
 341   msg.data = h->data;
 342   msg.is_tcp = htonl ((uint32_t) h->is_tcp);
 343
 344   client = GNUNET_CLIENT_connect ("gnunet-nat-server", h->cfg);
 345   if (NULL == client)
 346   {
 347     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 348                 _("Failed to connect to `gnunet-nat-server'\n"));
 349     return;
 350   }
 351   ca = GNUNET_new (struct ClientActivity);
 352   ca->client = client;
 353   GNUNET_CONTAINER_DLL_insert (h->ca_head, h->ca_tail, ca);
 354   GNUNET_break (GNUNET_OK ==
 355                 GNUNET_CLIENT_transmit_and_get_response (client, &msg.header,
 356                                                          NAT_SERVER_TIMEOUT,
 357                                                          GNUNET_YES, NULL,
 358                                                          NULL));
 359 }
 360
 361
 362 /**
 363  * Start testing if NAT traversal works using the
 364  * given configuration (IPv4-only).
 365  *
 366  * @param cfg configuration for the NAT traversal
 367  * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
 368  * @param bnd_port port to bind to, 0 for connection reversal
 369  * @param adv_port externally advertised port to use
 370  * @param report function to call with the result of the test
 371  * @param report_cls closure for @a report
 372  * @return handle to cancel NAT test
 373  */
 374 struct GNUNET_NAT_Test *
 375 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 376                        int is_tcp,
 377                        uint16_t bnd_port,
 378                        uint16_t adv_port,
 379                        GNUNET_NAT_TestCallback report,
 380                        void *report_cls)
 381 {
 382   struct GNUNET_NAT_Test *ret;
 383   struct sockaddr_in sa;
 384   const struct sockaddr *addrs[] = { (const struct sockaddr *) &sa };
 385   const socklen_t addrlens[] = { sizeof (sa) };
 386
 387   memset (&sa, 0, sizeof (sa));
 388   sa.sin_family = AF_INET;
 389   sa.sin_port = htons (bnd_port);
 390 #if HAVE_SOCKADDR_IN_SIN_LEN
 391   sa.sin_len = sizeof (sa);
 392 #endif
 393
 394   ret = GNUNET_new (struct GNUNET_NAT_Test);
 395   ret->cfg = cfg;
 396   ret->is_tcp = is_tcp;
 397   ret->data = bnd_port;
 398   ret->adv_port = adv_port;
 399   ret->report = report;
 400   ret->report_cls = report_cls;
 401   if (bnd_port == 0)
 402   {
 403     ret->nat =
 404         GNUNET_NAT_register (cfg, is_tcp, 0, 0, NULL, NULL, &addr_cb,
 405                              &reversal_cb, ret);
 406   }
 407   else
 408   {
 409     ret->lsock =
 410         GNUNET_NETWORK_socket_create (AF_INET,
 411                                       (is_tcp ==
 412                                        GNUNET_YES) ? SOCK_STREAM : SOCK_DGRAM,
 413                                       0);
 414     if ((ret->lsock == NULL) ||
 415         (GNUNET_OK !=
 416          GNUNET_NETWORK_socket_bind (ret->lsock, (const struct sockaddr *) &sa,
 417                                      sizeof (sa))))
 418     {
 419       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 420                   _("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
 421                   GNUNET_a2s ((const struct sockaddr *) &sa, sizeof (sa)),
 422                   STRERROR (errno));
 423       if (NULL != ret->lsock)
 424         GNUNET_NETWORK_socket_close (ret->lsock);
 425       GNUNET_free (ret);
 426       return NULL;
 427     }
 428     if (GNUNET_YES == is_tcp)
 429     {
 430       GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (ret->lsock, 5));
 431       ret->ltask =
 432           GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 433                                          ret->lsock, &do_accept, ret);
 434     }
 435     else
 436     {
 437       ret->ltask =
 438           GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 439                                          ret->lsock, &do_udp_read, ret);
 440     }
 441     LOG (GNUNET_ERROR_TYPE_DEBUG,
 442          "NAT test listens on port %u (%s)\n",
 443          bnd_port,
 444          (GNUNET_YES == is_tcp) ? "tcp" : "udp");
 445     ret->nat =
 446         GNUNET_NAT_register (cfg, is_tcp, adv_port, 1, addrs, addrlens,
 447                              &addr_cb, NULL, ret);
 448   }
 449   return ret;
 450 }
 451
 452
 453 /**
 454  * Stop an active NAT test.
 455  *
 456  * @param tst test to stop.
 457  */
 458 void
 459 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst)
 460 {
 461   struct NatActivity *pos;
 462   struct ClientActivity *cpos;
 463
 464   LOG (GNUNET_ERROR_TYPE_DEBUG,
 465        "Stopping NAT test\n");
 466   while (NULL != (cpos = tst->ca_head))
 467   {
 468     GNUNET_CONTAINER_DLL_remove (tst->ca_head, tst->ca_tail, cpos);
 469     GNUNET_CLIENT_disconnect (cpos->client);
 470     GNUNET_free (cpos);
 471   }
 472   while (NULL != (pos = tst->na_head))
 473   {
 474     GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, pos);
 475     GNUNET_SCHEDULER_cancel (pos->rtask);
 476     GNUNET_NETWORK_socket_close (pos->sock);
 477     GNUNET_free (pos);
 478   }
 479   if (GNUNET_SCHEDULER_NO_TASK != tst->ltask)
 480     GNUNET_SCHEDULER_cancel (tst->ltask);
 481   if (NULL != tst->lsock)
 482     GNUNET_NETWORK_socket_close (tst->lsock);
 483   GNUNET_NAT_unregister (tst->nat);
 484   GNUNET_free (tst);
 485 }
 486
 487 /* end of nat_test.c */