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 2, 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_transport_api.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_constants.h"
  29 #include "gnunet_getopt_lib.h"
  30 #include "gnunet_hello_lib.h"
  31 #include "gnunet_os_lib.h"
  32 #include "gnunet_peerinfo_service.h"
  33 #include "gnunet_plugin_lib.h"
  34 #include "gnunet_protocols.h"
  35 #include "gnunet_program_lib.h"
  36 #include "gnunet_signatures.h"
  37 #include "plugin_transport.h"
  38 #include "transport.h"
  39
  40 #define VERBOSE GNUNET_NO
  41
  42 /**
  43  * How long until we give up on transmitting the message?
  44  */
  45 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  46
  47 /**
  48  * Our public key.
  49  */
  50 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
  51
  52 /**
  53  * Our identity.
  54  */
  55 static struct GNUNET_PeerIdentity my_identity;
  56
  57 /**
  58  * Our private key.
  59  */
  60 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
  61
  62 /**
  63  * Our scheduler.
  64  */
  65 struct GNUNET_SCHEDULER_Handle *sched;
  66
  67 /**
  68  * Our configuration.
  69  */
  70 const struct GNUNET_CONFIGURATION_Handle *cfg;
  71
  72 /**
  73  * Number of neighbours we'd like to have.
  74  */
  75 static uint32_t max_connect_per_transport;
  76
  77 /**
  78  * Environment for this plugin.
  79  */
  80 struct GNUNET_TRANSPORT_PluginEnvironment env;
  81
  82 /**
  83  *handle for the api provided by this plugin
  84  */
  85 struct GNUNET_TRANSPORT_PluginFunctions *api;
  86
  87 /**
  88  * Did the test pass or fail?
  89  */
  90 static int ok;
  91
  92 /**
  93  * Initialize Environment for this plugin
  94  */
  95 struct ReadyList *
  96 receive(void *cls,void *plugin_context,
  97         struct ReadyList *
  98         service_context,
  99         struct GNUNET_TIME_Relative
 100         latency,
 101         const struct GNUNET_PeerIdentity
 102         * peer,
 103         const struct GNUNET_MessageHeader
 104         * message)
 105 {
 106   return NULL;
 107 }
 108
 109 void notify_address(void *cls,
 110                     const char *name,
 111                     const void *addr,
 112                     size_t addrlen,
 113                     struct
 114                     GNUNET_TIME_Relative
 115                     expires)
 116 {
 117 }
 118
 119 void lookup (void *cls,
 120              struct GNUNET_TIME_Relative
 121              timeout,
 122              const struct
 123              GNUNET_PeerIdentity * target,
 124              GNUNET_TRANSPORT_AddressCallback
 125              iter, void *iter_cls)
 126 {
 127 }
 128
 129
 130 /**
 131  * Function called when the service shuts
 132  * down.  Unloads our plugins.
 133  *
 134  * @param cls closure
 135  * @param cfg configuration to use
 136  */
 137 static void
 138 unload_plugins (void *cls,
 139                 const struct GNUNET_CONFIGURATION_Handle *cfg)
 140 {
 141   GNUNET_assert (NULL == GNUNET_PLUGIN_unload ("libgnunet_plugin_transport_tcp",api));
 142   if (my_private_key != NULL)
 143     GNUNET_CRYPTO_rsa_key_free (my_private_key);
 144
 145 }
 146
 147
 148 static void
 149 unload_task (void *cls,
 150              const struct GNUNET_SCHEDULER_TaskContext *tc)
 151 {
 152   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 153   unload_plugins (NULL, cfg);
 154 }
 155
 156
 157 static GNUNET_SCHEDULER_TaskIdentifier validation_timeout_task;
 158
 159
 160 static void
 161 validation_notification (void *cls,
 162                          const char *name,
 163                          const struct GNUNET_PeerIdentity *peer,
 164                          uint32_t challenge,
 165                          const char *sender_addr)
 166 {
 167   /* Sailor: 'test_validation' should get here
 168      if the validation worked; so we cancel the
 169      "delayed" task that will cause failure */
 170   if (validation_timeout_task != GNUNET_SCHEDULER_NO_TASK)
 171     {
 172       GNUNET_SCHEDULER_cancel (sched, validation_timeout_task);
 173       validation_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 174     }
 175
 176   GNUNET_assert (challenge == 42);
 177
 178   /* Sailor: if this is the last test, calling this function
 179      here will end the process. */
 180   ok = 0; /* if the last test succeeded, report success */
 181   GNUNET_SCHEDULER_add_continuation (sched,
 182                                      &unload_task,
 183                                      (void*) cfg,
 184                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 185 }
 186
 187
 188 static void
 189 validation_failed (void *cls,
 190                    const struct GNUNET_SCHEDULER_TaskContext *tc)
 191 {
 192   validation_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 193   GNUNET_break (0); /* output error */
 194   /* the "validation_notification" was not called
 195      in a timely fashion; we should set an error
 196      code for main and shut down */
 197   unload_plugins (NULL, cfg);
 198 }
 199
 200
 201 /**
 202  * Simple example test that invokes
 203  * the "validate" function of the plugin
 204  * and tries to see if the plugin would
 205  * succeed to validate its own address.
 206  * (This test is not well-written since
 207  *  we hand-compile the address which
 208  *  kind-of works for TCP but would not
 209  *  work for other plugins; we should ask
 210  *  the plugin about its address instead...).
 211  */
 212 /* FIXME: won't work on IPv6 enabled systems where IPv4 bridge
 213  * mode isn't enabled (eg. FreeBSD > 4)
 214  */
 215 static void
 216 test_validation ()
 217 {
 218   struct sockaddr_in soaddr;
 219
 220   memset (&soaddr, 0, sizeof(soaddr));
 221 #if HAVE_SOCKADDR_IN_SIN_LEN
 222   soaddr.sin_len = sizeof (soaddr);
 223 #endif
 224   soaddr.sin_family = AF_INET;
 225   /* Sailor: set this port to 2367 to see the
 226      testcase fail after 30s (because validation
 227      fails); obviously the test should be
 228      modified to test both successful and
 229      unsuccessful validation in the end... */
 230   soaddr.sin_port = htons(2368 /* FIXME: get from config! */);
 231   soaddr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 232   api->validate (api->cls,
 233                  &my_identity,
 234                  42,
 235                  TIMEOUT,
 236                  &soaddr,
 237                  sizeof(soaddr));
 238   /* add job to catch failure (timeout) */
 239   validation_timeout_task =
 240     GNUNET_SCHEDULER_add_delayed (sched,
 241                                   TIMEOUT,
 242                                   &validation_failed,
 243                                   NULL);
 244 }
 245
 246
 247 static void setup_plugin_environment()
 248 {
 249   env.cfg  = cfg;
 250   env.sched = sched;
 251   env.my_public_key = &my_public_key;
 252   env.my_private_key = my_private_key;
 253   env.my_identity = &my_identity;
 254   env.cls=&env;
 255   env.receive=&receive;
 256   env.lookup=&lookup;
 257   env.notify_address=&notify_address;
 258   env.notify_validation = &validation_notification;
 259   env.max_connections = max_connect_per_transport;
 260 }
 261
 262
 263 /**
 264  * Runs the test.
 265  *
 266  * @param cls closure
 267  * @param s scheduler to use
 268  * @param c configuration to use
 269  */
 270 static void
 271 run (void *cls,
 272      struct GNUNET_SCHEDULER_Handle *s,
 273      char *const *args,
 274      const char *cfgfile,
 275      const struct GNUNET_CONFIGURATION_Handle *c)
 276 {
 277   unsigned long long tneigh;
 278   char *keyfile;
 279   char *libname;
 280
 281   sched = s;
 282   cfg = c;
 283   /* parse configuration */
 284   if ((GNUNET_OK !=
 285        GNUNET_CONFIGURATION_get_value_number (c,
 286                                               "TRANSPORT",
 287                                               "NEIGHBOUR_LIMIT",
 288                                               &tneigh)) ||
 289       (GNUNET_OK !=
 290        GNUNET_CONFIGURATION_get_value_filename (c,
 291                                                 "GNUNETD",
 292                                                 "HOSTKEY", &keyfile)))
 293     {
 294       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 295                   _("Transport service is lacking key configuration settings.  Exiting.\n"));
 296       GNUNET_SCHEDULER_shutdown (s);
 297       return;
 298     }
 299   max_connect_per_transport = (uint32_t) tneigh;
 300   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 301   GNUNET_free (keyfile);
 302   if (my_private_key == NULL)
 303     {
 304       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 305                   _("Transport service could not access hostkey.  Exiting.\n"));
 306       GNUNET_SCHEDULER_shutdown (s);
 307       return;
 308     }
 309   GNUNET_CRYPTO_rsa_key_get_public (my_private_key,
 310                                     &my_public_key);
 311   GNUNET_CRYPTO_hash (&my_public_key,
 312                       sizeof (my_public_key),
 313                       &my_identity.hashPubKey);
 314
 315
 316
 317   /* load plugins... */
 318   setup_plugin_environment();
 319   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 320               _("Loading tcp transport plugin\n"));
 321   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_tcp");
 322
 323   api = GNUNET_PLUGIN_load(libname, &env);
 324   GNUNET_free (libname);
 325   if (api == NULL)
 326     {
 327       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 328                   _("Failed to load transport plugin for tcp\n"));
 329       /* FIXME: set some error code for main */
 330       return;
 331     }
 332   /* Sailor: if we had no real tests, we
 333      could call this function
 334      here to end the process; instead, I'll
 335      show how one could run a single test below.
 336      Note that the test is not particularly well-written,
 337      it just serves to illustrate (also,
 338      the "validation_notification" function above is
 339      part of the test.*/
 340   if (0)
 341     unload_plugins (NULL, cfg);
 342   else
 343     test_validation ();
 344 }
 345
 346
 347 /**
 348  * The main function for the transport service.
 349  *
 350  * @param argc number of arguments from the command line
 351  * @param argv command line arguments
 352  * @return 0 ok, 1 on error
 353  */
 354 int
 355 main (int argc, char *const *argv)
 356 {
 357   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 358     GNUNET_GETOPT_OPTION_END
 359   };
 360   int ret;
 361   char *const argv_prog[] = {
 362     "test_plugin_transport",
 363     "-c",
 364     "test_plugin_transport_data.conf",
 365     "-L",
 366 #if VERBOSE
 367     "DEBUG",
 368 #else
 369     "WARNING",
 370 #endif
 371     NULL
 372   };
 373   GNUNET_log_setup ("test-plugin-transport",
 374 #if VERBOSE
 375                     "DEBUG",
 376 #else
 377                     "WARNING",
 378 #endif
 379                     NULL);
 380   ok = 1; /* set to fail */
 381   ret = (GNUNET_OK ==
 382           GNUNET_PROGRAM_run (5,
 383                               argv_prog,
 384                               "test-plugin-transport",
 385                               "testcase",
 386                               options,
 387                               &run, NULL)) ? ok : 1;
 388   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
 389   return ret;
 390 }
 391
 392 /* end of test_plugin_transport.c */