src/nat-auto/gnunet-nat-auto_legacy.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011, 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  * @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   struct GNUNET_SCHEDULER_Task *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_MQ_Handle *mq;
  86
  87   /**
  88    * Handle to overall NAT test.
  89    */
  90   struct GNUNET_NAT_Test *h;
  91
  92 };
  93
  94
  95 /**
  96  * Handle to a NAT test.
  97  */
  98 struct GNUNET_NAT_Test
  99 {
 100
 101   /**
 102    * Configuration used
 103    */
 104   const struct GNUNET_CONFIGURATION_Handle *cfg;
 105
 106   /**
 107    * Function to call with success report
 108    */
 109   GNUNET_NAT_TestCallback report;
 110
 111   /**
 112    * Closure for @e report.
 113    */
 114   void *report_cls;
 115
 116   /**
 117    * Handle to NAT traversal in use
 118    */
 119   struct GNUNET_NAT_Handle *nat;
 120
 121   /**
 122    * Handle to listen socket, or NULL
 123    */
 124   struct GNUNET_NETWORK_Handle *lsock;
 125
 126   /**
 127    * Head of list of nat activities.
 128    */
 129   struct NatActivity *na_head;
 130
 131   /**
 132    * Tail of list of nat activities.
 133    */
 134   struct NatActivity *na_tail;
 135
 136   /**
 137    * Head of list of client activities.
 138    */
 139   struct ClientActivity *ca_head;
 140
 141   /**
 142    * Tail of list of client activities.
 143    */
 144   struct ClientActivity *ca_tail;
 145
 146   /**
 147    * Identity of task for the listen socket (if any)
 148    */
 149   struct GNUNET_SCHEDULER_Task *ltask;
 150
 151   /**
 152    * Task identifier for the timeout (if any)
 153    */
 154   struct GNUNET_SCHEDULER_Task *ttask;
 155
 156   /**
 157    * #GNUNET_YES if we're testing TCP
 158    */
 159   int is_tcp;
 160
 161   /**
 162    * Data that should be transmitted or source-port.
 163    */
 164   uint16_t data;
 165
 166   /**
 167    * Advertised port to the other peer.
 168    */
 169   uint16_t adv_port;
 170
 171   /**
 172    * Status code to be reported to the timeout/status call
 173    */
 174   enum GNUNET_NAT_StatusCode status;
 175 };
 176
 177
 178 /**
 179  * Function called from #GNUNET_NAT_register whenever someone asks us
 180  * to do connection reversal.
 181  *
 182  * @param cls closure, our `struct GNUNET_NAT_Handle`
 183  * @param addr public IP address of the other peer
 184  * @param addrlen actual lenght of the @a addr
 185  */
 186 static void
 187 reversal_cb (void *cls,
 188              const struct sockaddr *addr,
 189              socklen_t addrlen)
 190 {
 191   struct GNUNET_NAT_Test *h = cls;
 192   const struct sockaddr_in *sa;
 193
 194   if (sizeof (struct sockaddr_in) != addrlen)
 195     return;
 196   sa = (const struct sockaddr_in *) addr;
 197   if (h->data != sa->sin_port)
 198   {
 199     LOG (GNUNET_ERROR_TYPE_DEBUG,
 200          "Received connection reversal request for wrong port\n");
 201     return;                     /* wrong port */
 202   }
 203   /* report success */
 204   h->report (h->report_cls,
 205              GNUNET_NAT_ERROR_SUCCESS);
 206 }
 207
 208
 209 /**
 210  * Activity on our incoming socket.  Read data from the
 211  * incoming connection.
 212  *
 213  * @param cls the `struct GNUNET_NAT_Test`
 214  */
 215 static void
 216 do_udp_read (void *cls)
 217 {
 218   struct GNUNET_NAT_Test *tst = cls;
 219   uint16_t data;
 220   const struct GNUNET_SCHEDULER_TaskContext *tc;
 221
 222   tc = GNUNET_SCHEDULER_get_task_context ();
 223   tst->ltask =
 224       GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 225                                      tst->lsock,
 226                                      &do_udp_read,
 227                                      tst);
 228   if ((NULL != tc->write_ready) &&
 229       (GNUNET_NETWORK_fdset_isset (tc->read_ready,
 230                                    tst->lsock)) &&
 231       (sizeof (data) ==
 232        GNUNET_NETWORK_socket_recv (tst->lsock,
 233                                    &data,
 234                                    sizeof (data))))
 235   {
 236     if (data == tst->data)
 237       tst->report (tst->report_cls,
 238                    GNUNET_NAT_ERROR_SUCCESS);
 239     else
 240       LOG (GNUNET_ERROR_TYPE_DEBUG,
 241            "Received data mismatches expected value\n");
 242   }
 243   else
 244     LOG (GNUNET_ERROR_TYPE_DEBUG,
 245          "Failed to receive data from inbound connection\n");
 246 }
 247
 248
 249 /**
 250  * Activity on our incoming socket.  Read data from the
 251  * incoming connection.
 252  *
 253  * @param cls the `struct NatActivity`
 254  */
 255 static void
 256 do_read (void *cls)
 257 {
 258   struct NatActivity *na = cls;
 259   struct GNUNET_NAT_Test *tst;
 260   uint16_t data;
 261   const struct GNUNET_SCHEDULER_TaskContext *tc;
 262
 263   tc = GNUNET_SCHEDULER_get_task_context ();
 264   na->rtask = NULL;
 265   tst = na->h;
 266   GNUNET_CONTAINER_DLL_remove (tst->na_head,
 267                                tst->na_tail,
 268                                na);
 269   if ((NULL != tc->write_ready) &&
 270       (GNUNET_NETWORK_fdset_isset (tc->read_ready,
 271                                    na->sock)) &&
 272       (sizeof (data) ==
 273        GNUNET_NETWORK_socket_recv (na->sock,
 274                                    &data,
 275                                    sizeof (data))))
 276   {
 277     if (data == tst->data)
 278       tst->report (tst->report_cls,
 279                    GNUNET_NAT_ERROR_SUCCESS);
 280     else
 281       LOG (GNUNET_ERROR_TYPE_DEBUG,
 282            "Received data does not match expected value\n");
 283   }
 284   else
 285     LOG (GNUNET_ERROR_TYPE_DEBUG,
 286          "Failed to receive data from inbound connection\n");
 287   GNUNET_NETWORK_socket_close (na->sock);
 288   GNUNET_free (na);
 289 }
 290
 291
 292 /**
 293  * Activity on our listen socket. Accept the
 294  * incoming connection.
 295  *
 296  * @param cls the `struct GNUNET_NAT_Test`
 297  */
 298 static void
 299 do_accept (void *cls)
 300 {
 301   struct GNUNET_NAT_Test *tst = cls;
 302   struct GNUNET_NETWORK_Handle *s;
 303   struct NatActivity *wl;
 304
 305   tst->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 306                                               tst->lsock,
 307                                               &do_accept,
 308                                               tst);
 309   s = GNUNET_NETWORK_socket_accept (tst->lsock,
 310                                     NULL,
 311                                     NULL);
 312   if (NULL == s)
 313   {
 314     GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO,
 315                          "accept");
 316     return;                     /* odd error */
 317   }
 318   LOG (GNUNET_ERROR_TYPE_DEBUG,
 319        "Got an inbound connection, waiting for data\n");
 320   wl = GNUNET_new (struct NatActivity);
 321   wl->sock = s;
 322   wl->h = tst;
 323   wl->rtask =
 324     GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 325                                    wl->sock,
 326                                    &do_read,
 327                                    wl);
 328   GNUNET_CONTAINER_DLL_insert (tst->na_head,
 329                                tst->na_tail,
 330                                wl);
 331 }
 332
 333
 334 /**
 335  * We got disconnected from the NAT server.  Stop
 336  * waiting for a reply.
 337  *
 338  * @param cls the `struct ClientActivity`
 339  * @param error error code
 340  */
 341 static void
 342 mq_error_handler (void *cls,
 343                   enum GNUNET_MQ_Error error)
 344 {
 345   struct ClientActivity *ca = cls;
 346   struct GNUNET_NAT_Test *tst = ca->h;
 347
 348   GNUNET_CONTAINER_DLL_remove (tst->ca_head,
 349                                tst->ca_tail,
 350                                ca);
 351   GNUNET_MQ_destroy (ca->mq);
 352   GNUNET_free (ca);
 353 }
 354
 355
 356 /**
 357  * Address-callback, used to send message to gnunet-nat-server.
 358  *
 359  * @param cls closure
 360  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
 361  *     the previous (now invalid) one
 362  * @param addr either the previous or the new public IP address
 363  * @param addrlen actual length of the @a addr
 364  */
 365 static void
 366 addr_cb (void *cls,
 367          int add_remove,
 368          const struct sockaddr *addr,
 369          socklen_t addrlen)
 370 {
 371   struct GNUNET_NAT_Test *h = cls;
 372   struct ClientActivity *ca;
 373   struct GNUNET_MQ_Envelope *env;
 374   struct GNUNET_NAT_TestMessage *msg;
 375   const struct sockaddr_in *sa;
 376
 377   if (GNUNET_YES != add_remove)
 378     return;
 379   if (addrlen != sizeof (struct sockaddr_in))
 380   {
 381     LOG (GNUNET_ERROR_TYPE_DEBUG,
 382          "NAT test ignores IPv6 address `%s' returned from NAT library\n",
 383          GNUNET_a2s (addr,
 384                      addrlen));
 385     return;                     /* ignore IPv6 here */
 386   }
 387   LOG (GNUNET_ERROR_TYPE_INFO,
 388        "Asking gnunet-nat-server to connect to `%s'\n",
 389        GNUNET_a2s (addr,
 390                    addrlen));
 391
 392   ca = GNUNET_new (struct ClientActivity);
 393   ca->h = h;
 394   ca->mq = GNUNET_CLIENT_connect (h->cfg,
 395                                   "gnunet-nat-server",
 396                                   NULL,
 397                                   &mq_error_handler,
 398                                   ca);
 399   if (NULL == ca->mq)
 400   {
 401     GNUNET_free (ca);
 402     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 403                 _("Failed to connect to `gnunet-nat-server'\n"));
 404     return;
 405   }
 406   GNUNET_CONTAINER_DLL_insert (h->ca_head,
 407                                h->ca_tail,
 408                                ca);
 409   sa = (const struct sockaddr_in *) addr;
 410   env = GNUNET_MQ_msg (msg,
 411                        GNUNET_MESSAGE_TYPE_NAT_TEST);
 412   msg->dst_ipv4 = sa->sin_addr.s_addr;
 413   msg->dport = sa->sin_port;
 414   msg->data = h->data;
 415   msg->is_tcp = htonl ((uint32_t) h->is_tcp);
 416   GNUNET_MQ_send (ca->mq,
 417                   env);
 418 }
 419
 420
 421 /**
 422  * Timeout task for a nat test.
 423  * Calls the report-callback with a timeout return value
 424  *
 425  * Destroys the nat handle after the callback has been processed.
 426  *
 427  * @param cls handle to the timed out NAT test
 428  */
 429 static void
 430 do_timeout (void *cls)
 431 {
 432   struct GNUNET_NAT_Test *nh = cls;
 433
 434   nh->ttask = NULL;
 435   nh->report (nh->report_cls,
 436               (GNUNET_NAT_ERROR_SUCCESS == nh->status)
 437               ? GNUNET_NAT_ERROR_TIMEOUT
 438               : nh->status);
 439 }
 440
 441
 442 /**
 443  * Start testing if NAT traversal works using the
 444  * given configuration (IPv4-only).
 445  *
 446  * ALL failures are reported directly to the report callback
 447  *
 448  * @param cfg configuration for the NAT traversal
 449  * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
 450  * @param bnd_port port to bind to, 0 for connection reversal
 451  * @param adv_port externally advertised port to use
 452  * @param timeout delay after which the test should be aborted
 453  * @param report function to call with the result of the test
 454  * @param report_cls closure for @a report
 455  * @return handle to cancel NAT test or NULL. The error is always indicated via the report callback
 456  */
 457 struct GNUNET_NAT_Test *
 458 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 459                        int is_tcp,
 460                        uint16_t bnd_port,
 461                        uint16_t adv_port,
 462                        struct GNUNET_TIME_Relative timeout,
 463                        GNUNET_NAT_TestCallback report,
 464                        void *report_cls)
 465 {
 466   struct GNUNET_NAT_Test *nh;
 467   struct sockaddr_in sa;
 468   const struct sockaddr *addrs[] = {
 469     (const struct sockaddr *) &sa
 470   };
 471   const socklen_t addrlens[] = {
 472     sizeof (sa)
 473   };
 474
 475   memset (&sa, 0, sizeof (sa));
 476   sa.sin_family = AF_INET;
 477   sa.sin_port = htons (bnd_port);
 478 #if HAVE_SOCKADDR_IN_SIN_LEN
 479   sa.sin_len = sizeof (sa);
 480 #endif
 481
 482   nh = GNUNET_new (struct GNUNET_NAT_Test);
 483   nh->cfg = cfg;
 484   nh->is_tcp = is_tcp;
 485   nh->data = bnd_port;
 486   nh->adv_port = adv_port;
 487   nh->report = report;
 488   nh->report_cls = report_cls;
 489   nh->status = GNUNET_NAT_ERROR_SUCCESS;
 490   if (0 == bnd_port)
 491   {
 492     nh->nat
 493       = GNUNET_NAT_register (cfg,
 494                              is_tcp,
 495                              0,
 496                              0,
 497                              NULL,
 498                              NULL,
 499                              &addr_cb,
 500                              &reversal_cb,
 501                              nh,
 502                              NULL);
 503   }
 504   else
 505   {
 506     nh->lsock =
 507         GNUNET_NETWORK_socket_create (AF_INET,
 508                                       (is_tcp ==
 509                                        GNUNET_YES) ? SOCK_STREAM : SOCK_DGRAM,
 510                                       0);
 511     if ((nh->lsock == NULL) ||
 512         (GNUNET_OK !=
 513          GNUNET_NETWORK_socket_bind (nh->lsock,
 514                                      (const struct sockaddr *) &sa,
 515                                      sizeof (sa))))
 516     {
 517       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 518                   _("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
 519                   GNUNET_a2s ((const struct sockaddr *) &sa,
 520                               sizeof (sa)),
 521                   STRERROR (errno));
 522       if (NULL != nh->lsock)
 523       {
 524         GNUNET_NETWORK_socket_close (nh->lsock);
 525         nh->lsock = NULL;
 526       }
 527       nh->status = GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR;
 528       nh->ttask = GNUNET_SCHEDULER_add_now (&do_timeout,
 529                                             nh);
 530       return nh;
 531     }
 532     if (GNUNET_YES == is_tcp)
 533     {
 534       GNUNET_break (GNUNET_OK ==
 535                     GNUNET_NETWORK_socket_listen (nh->lsock,
 536                                                   5));
 537       nh->ltask =
 538           GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 539                                          nh->lsock,
 540                                          &do_accept,
 541                                          nh);
 542     }
 543     else
 544     {
 545       nh->ltask =
 546           GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
 547                                          nh->lsock,
 548                                          &do_udp_read,
 549                                          nh);
 550     }
 551     LOG (GNUNET_ERROR_TYPE_INFO,
 552          "NAT test listens on port %u (%s)\n",
 553          bnd_port,
 554          (GNUNET_YES == is_tcp) ? "tcp" : "udp");
 555     nh->nat = GNUNET_NAT_register (cfg,
 556                                    is_tcp,
 557                                    adv_port,
 558                                    1,
 559                                    addrs,
 560                                    addrlens,
 561                                    &addr_cb,
 562                                    NULL,
 563                                    nh,
 564                                    NULL);
 565     if (NULL == nh->nat)
 566     {
 567       LOG (GNUNET_ERROR_TYPE_INFO,
 568           _("NAT test failed to start NAT library\n"));
 569       if (NULL != nh->ltask)
 570       {
 571         GNUNET_SCHEDULER_cancel (nh->ltask);
 572         nh->ltask = NULL;
 573       }
 574       if (NULL != nh->lsock)
 575       {
 576         GNUNET_NETWORK_socket_close (nh->lsock);
 577         nh->lsock = NULL;
 578       }
 579       nh->status = GNUNET_NAT_ERROR_NAT_REGISTER_FAILED;
 580       nh->ttask = GNUNET_SCHEDULER_add_now (&do_timeout,
 581                                             nh);
 582       return nh;
 583     }
 584   }
 585   nh->ttask = GNUNET_SCHEDULER_add_delayed (timeout,
 586                                             &do_timeout,
 587                                             nh);
 588   return nh;
 589 }
 590
 591
 592 /**
 593  * Stop an active NAT test.
 594  *
 595  * @param tst test to stop.
 596  */
 597 void
 598 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst)
 599 {
 600   struct NatActivity *pos;
 601   struct ClientActivity *cpos;
 602
 603   LOG (GNUNET_ERROR_TYPE_DEBUG,
 604        "Stopping NAT test\n");
 605   while (NULL != (cpos = tst->ca_head))
 606   {
 607     GNUNET_CONTAINER_DLL_remove (tst->ca_head,
 608                                  tst->ca_tail,
 609                                  cpos);
 610     GNUNET_MQ_destroy (cpos->mq);
 611     GNUNET_free (cpos);
 612   }
 613   while (NULL != (pos = tst->na_head))
 614   {
 615     GNUNET_CONTAINER_DLL_remove (tst->na_head,
 616                                  tst->na_tail,
 617                                  pos);
 618     GNUNET_SCHEDULER_cancel (pos->rtask);
 619     GNUNET_NETWORK_socket_close (pos->sock);
 620     GNUNET_free (pos);
 621   }
 622   if (NULL != tst->ttask)
 623   {
 624     GNUNET_SCHEDULER_cancel (tst->ttask);
 625     tst->ttask = NULL;
 626   }
 627   if (NULL != tst->ltask)
 628   {
 629     GNUNET_SCHEDULER_cancel (tst->ltask);
 630     tst->ltask = NULL;
 631   }
 632   if (NULL != tst->lsock)
 633   {
 634     GNUNET_NETWORK_socket_close (tst->lsock);
 635     tst->lsock = NULL;
 636   }
 637   if (NULL != tst->nat)
 638   {
 639     GNUNET_NAT_unregister (tst->nat);
 640     tst->nat = NULL;
 641   }
 642   GNUNET_free (tst);
 643 }
 644
 645 /* end of nat_test.c */