src/transport/test_plugin_transport.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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  * @file transport/test_plugin_transport.c
  22  * @brief testcase for transport_api.c
  23  * @author Sailor Siraj
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_peerinfo_service.h"
  33 #include "gnunet_statistics_service.h"
  34 #include "gnunet_protocols.h"
  35 #include "gnunet_signatures.h"
  36 #include "gnunet_transport_plugin.h"
  37
  38 #include "transport.h"
  39
  40 /**
  41  * How long until we give up on transmitting the message?
  42  */
  43 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  45
  46 /**
  47  * Our public key.
  48  */
  49 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
  50
  51 /**
  52  * Our identity.
  53  */
  54 static struct GNUNET_PeerIdentity my_identity;
  55
  56 /**
  57  * Our private key.
  58  */
  59 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
  60
  61 /**
  62  * Our configuration.
  63  */
  64 const struct GNUNET_CONFIGURATION_Handle *cfg;
  65
  66 /**
  67  * Our configuration.
  68  */
  69 struct GNUNET_STATISTICS_Handle *stats;
  70
  71 /**
  72  * Our HELLO
  73  */
  74 struct GNUNET_HELLO_Message *hello;
  75
  76 /**
  77  * Number of neighbours we'd like to have.
  78  */
  79 static uint32_t max_connect_per_transport;
  80
  81 /**
  82  * Environment for this plugin.
  83  */
  84 struct GNUNET_TRANSPORT_PluginEnvironment env;
  85
  86 /**
  87  *handle for the api provided by this plugin
  88  */
  89 struct GNUNET_TRANSPORT_PluginFunctions *api;
  90
  91 /**
  92  * Helper handler
  93  */
  94 struct GNUNET_HELPER_Handle *suid_helper;
  95
  96 /**
  97  * Timeout task
  98  */
  99 static GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 100
 101 /**
 102  * Timeout task
 103  */
 104 static GNUNET_SCHEDULER_TaskIdentifier timeout_wait;
 105
 106 /**
 107  * Library name
 108  */
 109 static char *libname;
 110
 111 /**
 112  * Plugin addresses head
 113  */
 114 struct AddressWrapper *head;
 115
 116 /**
 117  * Plugin addresses tail
 118  */
 119 struct AddressWrapper *tail;
 120
 121 unsigned int addresses_reported;
 122
 123 /**
 124  * Did the test pass or fail?
 125  */
 126 static int ok;
 127
 128
 129 struct AddressWrapper
 130 {
 131   struct AddressWrapper *next;
 132
 133   struct AddressWrapper *prev;
 134
 135   void *addr;
 136
 137   size_t addrlen;
 138
 139   char *addrstring;
 140 };
 141
 142 static void
 143 end ()
 144 {
 145   struct AddressWrapper *w;
 146   int c = 0;
 147   ok = 0;
 148
 149   if (GNUNET_SCHEDULER_NO_TASK != timeout_task)
 150   {
 151       GNUNET_SCHEDULER_cancel (timeout_task);
 152       timeout_task = GNUNET_SCHEDULER_NO_TASK;
 153   }
 154   if (NULL != api)
 155       GNUNET_PLUGIN_unload (libname, api);
 156
 157   while (NULL != head)
 158   {
 159       w = head;
 160       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 161                 _("Plugin did not remove address `%s' \n"), w->addrstring);
 162       GNUNET_CONTAINER_DLL_remove (head, tail, w);
 163       c ++;
 164       GNUNET_free (w->addr);
 165       GNUNET_free (w->addrstring);
 166       GNUNET_free (w);
 167   }
 168   if (c > 0)
 169   {
 170     GNUNET_break (0);
 171     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 172               _("Plugin did not remove %u addresses \n"), c);
 173     ok = 1;
 174   }
 175
 176
 177   GNUNET_free (libname);
 178   libname = NULL;
 179   GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
 180   stats = NULL;
 181
 182   if (NULL != suid_helper)
 183   {
 184     GNUNET_HELPER_stop (suid_helper);
 185     suid_helper = NULL;
 186   }
 187 }
 188
 189 static void
 190 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 191 {
 192   struct AddressWrapper *w;
 193   int c = 0;
 194   timeout_task = GNUNET_SCHEDULER_NO_TASK;
 195   if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
 196   {
 197       GNUNET_SCHEDULER_cancel (timeout_wait);
 198       timeout_wait = GNUNET_SCHEDULER_NO_TASK;
 199   }
 200
 201   if (NULL != cls)
 202   {
 203       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 204                 _("Test took too long to execute, timeout .... \n"));
 205   }
 206
 207   if (NULL != libname)
 208   {
 209     if (NULL != api)
 210       GNUNET_PLUGIN_unload (libname, api);
 211     GNUNET_free (libname);
 212     libname = NULL;
 213   }
 214
 215   while (NULL != head)
 216   {
 217       w = head;
 218       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 219                 _("Plugin did not remove address `%s' \n"), w->addrstring);
 220       GNUNET_CONTAINER_DLL_remove (head, tail, w);
 221       c ++;
 222       GNUNET_free (w->addr);
 223       GNUNET_free (w->addrstring);
 224       GNUNET_free (w);
 225   }
 226   if (c > 0)
 227   {
 228     GNUNET_break (0);
 229     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 230               _("Plugin did not remove %u addresses \n"), c);
 231   }
 232
 233   if (NULL != stats)
 234   {
 235     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
 236     stats = NULL;
 237   }
 238
 239   if (NULL != suid_helper)
 240   {
 241     GNUNET_HELPER_stop (suid_helper);
 242     suid_helper = NULL;
 243   }
 244
 245   ok = 1;
 246 }
 247
 248 static void
 249 wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 250 {
 251   timeout_wait = GNUNET_SCHEDULER_NO_TASK;
 252   if (0 == addresses_reported)
 253     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 254               _("Plugin did not report any addresses, could not check address conversion functions\n"));
 255   end ();
 256 }
 257
 258
 259 static void
 260 end_badly_now ()
 261 {
 262   if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
 263   {
 264       GNUNET_SCHEDULER_cancel (timeout_wait);
 265       timeout_wait = GNUNET_SCHEDULER_NO_TASK;
 266   }
 267   if (GNUNET_SCHEDULER_NO_TASK != timeout_task)
 268   {
 269       GNUNET_SCHEDULER_cancel (timeout_task);
 270       timeout_task = GNUNET_SCHEDULER_NO_TASK;
 271   }
 272   timeout_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 273 }
 274
 275
 276 static struct GNUNET_TIME_Relative
 277 env_receive (void *cls,
 278             const struct GNUNET_PeerIdentity *peer,
 279             const struct GNUNET_MessageHeader *message,
 280             const struct GNUNET_ATS_Information *ats,
 281             uint32_t ats_count,
 282             struct Session * session,
 283             const char *sender_address,
 284             uint16_t sender_address_len)
 285 {
 286   /* do nothing */
 287   return GNUNET_TIME_relative_get_zero_();
 288 }
 289
 290 /**
 291  * Take the given address and append it to the set of results sent back to
 292  * the client.
 293  *
 294  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
 295  * @param buf text to transmit
 296  */
 297 static void
 298 address_pretty_printer_cb (void *cls, const char *buf)
 299 {
 300   if (NULL != buf)
 301   {
 302     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 303                 "Pretty address : `%s'\n", buf);
 304   }
 305   else
 306   {
 307       GNUNET_break (0);
 308       end_badly_now ();
 309   }
 310 }
 311
 312
 313 static void
 314 env_notify_address (void *cls,
 315                     int add_remove,
 316                     const void *addr,
 317                     size_t addrlen,
 318                     const char *plugin)
 319 {
 320   struct AddressWrapper *w;
 321   char *a2s;
 322   void *s2a;
 323   size_t s2a_len;
 324
 325   if (GNUNET_YES == add_remove)
 326   {
 327       addresses_reported ++;
 328       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 329                   _("Adding address of length %u\n"), addrlen);
 330
 331       w = GNUNET_malloc (sizeof (struct AddressWrapper));
 332       w->addr = GNUNET_malloc (addrlen);
 333       w->addrlen = addrlen;
 334       memcpy (w->addr, addr, addrlen);
 335       GNUNET_CONTAINER_DLL_insert(head, tail, w);
 336
 337       api->address_pretty_printer (api->cls, plugin, addr, addrlen,
 338                                     GNUNET_YES, GNUNET_TIME_UNIT_MINUTES,
 339                                     &address_pretty_printer_cb,
 340                                     w);
 341
 342       a2s = strdup (api->address_to_string (api, w->addr, w->addrlen));
 343       if (NULL == a2s)
 344       {
 345           GNUNET_break (0);
 346           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 347                       _("Plugin cannot convert address to string!\n"));
 348           end_badly_now();
 349           return;
 350       }
 351       w->addrstring = strdup (api->address_to_string (api, w->addr, w->addrlen));
 352       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 353                   _("Plugin added address `%s'\n"), a2s);
 354
 355       if ((GNUNET_OK != api->string_to_address (api, a2s, strlen (a2s)+1, &s2a, &s2a_len)) || (NULL == s2a))
 356       {
 357           GNUNET_break (0);
 358           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 359                       _("Plugin cannot convert string to address!\n"));
 360           end_badly_now();
 361           return;
 362       }
 363
 364       if (s2a_len != w->addrlen)
 365       {
 366           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 367                       _("Plugin creates different address length when converting address->string->address: %u != %u\n"), w->addrlen, s2a_len);
 368       }
 369       else
 370       {
 371           if (0 != memcmp (s2a, w->addr, s2a_len))
 372             GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 373                         _("Plugin creates different address length when connecting back and forth!\n"));
 374       }
 375       GNUNET_free (s2a);
 376       GNUNET_free (a2s);
 377       if (GNUNET_OK != api->check_address (api->cls, w->addr, w->addrlen))
 378       {
 379           GNUNET_break (0);
 380           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 381                       _("Plugin refuses added address!\n"));
 382           end_badly_now();
 383           return;
 384       }
 385       if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
 386       {
 387           GNUNET_SCHEDULER_cancel (timeout_wait);
 388           timeout_wait = GNUNET_SCHEDULER_NO_TASK;
 389       }
 390       timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
 391   }
 392   else if (GNUNET_NO == add_remove)
 393   {
 394       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 395                   _("Removing address of length %u\n"), addrlen);
 396
 397       w = head;
 398       while (NULL != w)
 399       {
 400           if ((addrlen == w->addrlen) && (0 == memcmp (w->addr, addr, addrlen)))
 401           {
 402             break;
 403           }
 404           w = w->next;
 405       }
 406
 407       if (w == NULL)
 408       {
 409           GNUNET_break (0);
 410           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 411                       _("Plugin removes address never added!\n"));
 412           end_badly_now();
 413           return;
 414       }
 415
 416       GNUNET_CONTAINER_DLL_remove (head, tail, w);
 417       GNUNET_free (w->addr);
 418       GNUNET_free (w->addrstring);
 419       GNUNET_free (w);
 420   }
 421   else
 422   {
 423       GNUNET_break (0);
 424       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 425                   _("Invalid operation: %u \n"), add_remove);
 426       end_badly_now ();
 427       return;
 428   }
 429 }
 430
 431 struct GNUNET_ATS_Information
 432 env_get_address_type (void *cls,
 433                      const struct sockaddr *addr,
 434                      size_t addrlen)
 435 {
 436   struct GNUNET_ATS_Information ats;
 437   ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
 438   ats.value = htonl (GNUNET_ATS_NET_LOOPBACK);
 439   return ats;
 440 }
 441
 442 const struct GNUNET_MessageHeader *
 443 env_get_our_hello (void)
 444 {
 445   return (const struct GNUNET_MessageHeader *) hello;
 446 }
 447
 448 void env_session_end (void *cls,
 449                       const struct GNUNET_PeerIdentity *peer,
 450                       struct Session * session)
 451 {
 452
 453 }
 454
 455 static void
 456 setup_plugin_environment ()
 457 {
 458   env.cfg = cfg;
 459   env.cls = &env;
 460   env.my_identity = &my_identity;
 461   env.max_connections = max_connect_per_transport;
 462   env.stats = stats;
 463
 464   env.receive = &env_receive;
 465   env.notify_address = &env_notify_address;
 466   env.get_address_type = &env_get_address_type;
 467   env.get_our_hello = &env_get_our_hello;
 468   env.session_end = &env_session_end;
 469 }
 470
 471 static int
 472 handle_helper_message (void *cls, void *client,
 473                        const struct GNUNET_MessageHeader *hdr)
 474 {
 475   return GNUNET_OK;
 476 }
 477
 478 /**
 479  * Runs the test.
 480  *
 481  * @param cls closure
 482  * @param c configuration to use
 483  */
 484 static void
 485 run (void *cls, char *const *args, const char *cfgfile,
 486      const struct GNUNET_CONFIGURATION_Handle *c)
 487 {
 488   char *const *argv = cls;
 489   unsigned long long tneigh;
 490   char *keyfile;
 491   char *plugin;
 492   char *sep;
 493
 494   timeout_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
 495
 496   cfg = c;
 497   /* parse configuration */
 498   if ((GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
 499                           "TRANSPORT",
 500                           "NEIGHBOUR_LIMIT",
 501                           &tneigh)) ||
 502       (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
 503                           "GNUNETD", "HOSTKEY",
 504                           &keyfile)))
 505   {
 506     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 507                 _("Transport service is lacking key configuration settings.  Exiting.\n"));
 508
 509     return;
 510   }
 511
 512   stats = GNUNET_STATISTICS_create ("transport", cfg);
 513   if (NULL == stats)
 514   {
 515       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 516                   _("Could not create statistics.  Exiting.\n"));
 517       end_badly_now ();
 518       return;
 519   }
 520
 521   max_connect_per_transport = (uint32_t) tneigh;
 522   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 523   GNUNET_free (keyfile);
 524   if (my_private_key == NULL)
 525   {
 526     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 527                 _("Transport service could not access hostkey.  Exiting.\n"));
 528     end_badly_now ();
 529     return;
 530   }
 531   GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
 532   GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
 533                       &my_identity.hashPubKey);
 534
 535
 536   hello = GNUNET_HELLO_create(&my_public_key, NULL, NULL);
 537
 538   /* load plugins... */
 539   setup_plugin_environment ();
 540
 541   GNUNET_assert (strlen (argv[0]) > strlen ("test_plugin_"));
 542   plugin = strstr(argv[0],"test_plugin_");
 543   sep = strrchr(argv[0],'.');
 544   if (NULL == plugin)
 545   {
 546       GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Not a valid test name\n"));
 547       end_badly_now ();
 548       return;
 549   }
 550   plugin += strlen ("test_plugin_");
 551   if (NULL != sep)
 552       sep[0] = '\0';
 553
 554   /* Hack for WLAN: start a second helper */
 555   if (0 == strcmp (plugin, "wlan"))
 556   {
 557     char * helper_argv[3];
 558     helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
 559     helper_argv[1] = (char *) "2";
 560     helper_argv[2] = NULL;
 561     suid_helper = GNUNET_HELPER_start (GNUNET_NO,
 562                                        "gnunet-helper-transport-wlan-dummy",
 563                                        helper_argv,
 564                                        &handle_helper_message,
 565                                        NULL,
 566                                        NULL);
 567   }
 568
 569
 570   /* Loading plugin */
 571   GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading transport plugin %s\n"), plugin);
 572   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
 573   api = GNUNET_PLUGIN_load (libname, &env);
 574   if (api == NULL)
 575   {
 576     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 577                 _("Failed to load transport plugin for %s\n"), plugin);
 578     end_badly_now ();
 579     return;
 580   }
 581
 582   timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
 583
 584   /* Check if all functions are implemented */
 585   if (NULL == api->address_pretty_printer)
 586   {
 587       GNUNET_break (0);
 588       end_badly_now ();
 589       return;
 590   }
 591   if (NULL == api->address_to_string)
 592   {
 593       GNUNET_break (0);
 594       end_badly_now ();
 595       return;
 596   }
 597   GNUNET_assert (NULL != api->check_address);
 598   if (NULL == api->check_address)
 599   {
 600       GNUNET_break (0);
 601       end_badly_now ();
 602       return;
 603   }
 604   GNUNET_assert (NULL != api->disconnect);
 605   if (NULL == api->disconnect)
 606   {
 607       GNUNET_break (0);
 608       end_badly_now ();
 609       return;
 610   }
 611   GNUNET_assert (NULL != api->get_session);
 612   if (NULL == api->get_session)
 613   {
 614       GNUNET_break (0);
 615       end_badly_now ();
 616       return;
 617   }
 618   if (NULL == api->address_pretty_printer)
 619   {
 620       GNUNET_break (0);
 621       end_badly_now ();
 622       return;
 623   }
 624   if (NULL == api->string_to_address)
 625   {
 626       GNUNET_break (0);
 627       end_badly_now ();
 628       return;
 629   }
 630 }
 631
 632
 633 /**
 634  * The main function for the transport service.
 635  *
 636  * @param argc number of arguments from the command line
 637  * @param argv command line arguments
 638  * @return 0 ok, 1 on error
 639  */
 640 int
 641 main (int argc, char *const *argv)
 642 {
 643   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 644     GNUNET_GETOPT_OPTION_END
 645   };
 646   int ret;
 647
 648   char *const argv_prog[] = {
 649     "test_plugin_transport",
 650     "-c",
 651     "test_plugin_transport_data.conf",
 652     "-L", "WARNING",
 653     NULL
 654   };
 655   GNUNET_log_setup ("test-plugin-transport",
 656                     "WARNING",
 657                     NULL);
 658   ok = 1;                       /* set to fail */
 659   ret = (GNUNET_OK == GNUNET_PROGRAM_run (5,
 660                            argv_prog,
 661                            "test-plugin-transport",
 662                            "testcase",
 663                            options,
 664                            &run,
 665                            (void *) argv)) ? ok : 1;
 666   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
 667   return ret;
 668 }
 669
 670 /* end of test_plugin_transport.c */