src/transport/test_plugin_transport_udp.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 static void
  96 receive(void *cls,
  97         struct GNUNET_TIME_Relative
  98         latency,
  99         const struct GNUNET_PeerIdentity
 100         * peer,
 101         const struct GNUNET_MessageHeader
 102         * message)
 103 {
 104   /* do nothing */
 105 }
 106
 107 void notify_address(void *cls,
 108                     const char *name,
 109                     const void *addr,
 110                     size_t addrlen,
 111                     struct
 112                     GNUNET_TIME_Relative
 113                     expires)
 114 {
 115 }
 116
 117 /**
 118  * Function called when the service shuts
 119  * down.  Unloads our plugins.
 120  *
 121  * @param cls closure
 122  * @param cfg configuration to use
 123  */
 124 static void
 125 unload_plugins (void *cls,
 126                 const struct GNUNET_CONFIGURATION_Handle *cfg)
 127 {
 128   GNUNET_assert (NULL == GNUNET_PLUGIN_unload ("libgnunet_plugin_transport_udp",api));
 129   if (my_private_key != NULL)
 130     GNUNET_CRYPTO_rsa_key_free (my_private_key);
 131
 132 }
 133
 134
 135 static void
 136 unload_task (void *cls,
 137              const struct GNUNET_SCHEDULER_TaskContext *tc)
 138 {
 139   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 140   unload_plugins (NULL, cfg);
 141 }
 142
 143
 144 static GNUNET_SCHEDULER_TaskIdentifier validation_timeout_task;
 145
 146
 147 static void
 148 validation_notification (void *cls,
 149                          const char *name,
 150                          const struct GNUNET_PeerIdentity *peer,
 151                          uint32_t challenge,
 152                          const char *sender_addr)
 153 {
 154   if (validation_timeout_task != GNUNET_SCHEDULER_NO_TASK)
 155     {
 156       GNUNET_SCHEDULER_cancel (sched, validation_timeout_task);
 157       validation_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 158     }
 159
 160   GNUNET_assert (challenge == 42);
 161
 162   ok = 0; /* if the last test succeeded, report success */
 163
 164   GNUNET_SCHEDULER_add_continuation (sched,
 165                                      &unload_task,
 166                                      (void*) cfg,
 167                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 168 }
 169
 170
 171 static void
 172 validation_failed (void *cls,
 173                    const struct GNUNET_SCHEDULER_TaskContext *tc)
 174 {
 175   validation_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 176   GNUNET_break (0); /* output error */
 177   /* the "validation_notification" was not called
 178      in a timely fashion; we should set an error
 179      code for main and shut down */
 180   unload_plugins (NULL, cfg);
 181 }
 182
 183
 184 /**
 185  * Simple example test that invokes
 186  * the "validate" function of the plugin
 187  * and tries to see if the plugin would
 188  * succeed to validate its own address.
 189  * (This test is not well-written since
 190  *  we hand-compile the address which
 191  *  kind-of works for TCP but would not
 192  *  work for other plugins; we should ask
 193  *  the plugin about its address instead...).
 194  */
 195 /* FIXME: won't work on IPv6 enabled systems where IPv4 mapping
 196  * isn't enabled (eg. FreeBSD > 4)
 197  */
 198 static void
 199 test_validation ()
 200 {
 201   struct sockaddr_in soaddr;
 202
 203   memset (&soaddr, 0, sizeof(soaddr));
 204 #if HAVE_SOCKADDR_IN_SIN_LEN
 205   soaddr.sin_len = sizeof (soaddr);
 206 #endif
 207   soaddr.sin_family = AF_INET;
 208   soaddr.sin_port = htons(2368 /* FIXME: get from config! */);
 209   soaddr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 210
 211   /* add job to catch failure (timeout) */
 212   validation_timeout_task =
 213     GNUNET_SCHEDULER_add_delayed (sched,
 214                                   TIMEOUT,
 215                                   &validation_failed,
 216                                   NULL);
 217
 218   api->validate (api->cls,
 219                  &my_identity,
 220                  42,
 221                  TIMEOUT,
 222                  &soaddr,
 223                  sizeof(soaddr));
 224 }
 225
 226
 227 static void setup_plugin_environment()
 228 {
 229   env.cfg  = cfg;
 230   env.sched = sched;
 231   env.my_public_key = &my_public_key;
 232   env.my_private_key = my_private_key;
 233   env.my_identity = &my_identity;
 234   env.cls=&env;
 235   env.receive=&receive;
 236   env.notify_address=&notify_address;
 237   env.notify_validation = &validation_notification;
 238   env.max_connections = max_connect_per_transport;
 239 }
 240 static int retx;
 241
 242 /**
 243  * Runs the test.
 244  *
 245  * @param cls closure
 246  * @param s scheduler to use
 247  * @param c configuration to use
 248  */
 249 static void
 250 run (void *cls,
 251      struct GNUNET_SCHEDULER_Handle *s,
 252      char *const *args,
 253      const char *cfgfile,
 254      const struct GNUNET_CONFIGURATION_Handle *c)
 255 {
 256   unsigned long long tneigh;
 257   char *keyfile;
 258   char *libname;
 259
 260   sched = s;
 261   cfg = c;
 262   /* parse configuration */
 263   if ((GNUNET_OK !=
 264        GNUNET_CONFIGURATION_get_value_number (c,
 265                                               "TRANSPORT",
 266                                               "NEIGHBOUR_LIMIT",
 267                                               &tneigh)) ||
 268       (GNUNET_OK !=
 269        GNUNET_CONFIGURATION_get_value_filename (c,
 270                                                 "GNUNETD",
 271                                                 "HOSTKEY", &keyfile)))
 272     {
 273       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 274                   _("Transport service is lacking key configuration settings.  Exiting.\n"));
 275       GNUNET_SCHEDULER_shutdown (s);
 276       return;
 277     }
 278   max_connect_per_transport = (uint32_t) tneigh;
 279   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 280   GNUNET_free (keyfile);
 281   if (my_private_key == NULL)
 282     {
 283       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 284                   _("Transport service could not access hostkey.  Exiting.\n"));
 285       GNUNET_SCHEDULER_shutdown (s);
 286       return;
 287     }
 288   GNUNET_CRYPTO_rsa_key_get_public (my_private_key,
 289                                     &my_public_key);
 290   GNUNET_CRYPTO_hash (&my_public_key,
 291                       sizeof (my_public_key),
 292                       &my_identity.hashPubKey);
 293
 294   /* load plugins... */
 295   setup_plugin_environment();
 296   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 297               _("Loading udp transport plugin\n"));
 298   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_udp");
 299
 300   api = GNUNET_PLUGIN_load(libname, &env);
 301   GNUNET_free (libname);
 302   if (api == NULL)
 303     {
 304       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 305                   _("Failed to load transport plugin for udp\n"));
 306       /* FIXME: set some error code for main */
 307       return;
 308     }
 309   test_validation ();
 310 }
 311
 312
 313 /**
 314  * The main function for the transport service.
 315  *
 316  * @param argc number of arguments from the command line
 317  * @param argv command line arguments
 318  * @return 0 ok, 1 on error
 319  */
 320 int
 321 main (int argc, char *const *argv)
 322 {
 323   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 324     GNUNET_GETOPT_OPTION_END
 325   };
 326   int ret;
 327   char *const argv_prog[] = {
 328     "test_plugin_transport",
 329     "-c",
 330     "test_plugin_transport_data_udp.conf",
 331     "-L",
 332 #if VERBOSE
 333     "DEBUG",
 334 #else
 335     "WARNING",
 336 #endif
 337     NULL
 338   };
 339   GNUNET_log_setup ("test-plugin-transport",
 340 #if VERBOSE
 341                     "DEBUG",
 342 #else
 343                     "WARNING",
 344 #endif
 345                     NULL);
 346   ok = 1; /* set to fail */
 347   ret = (GNUNET_OK ==
 348           GNUNET_PROGRAM_run (5,
 349                               argv_prog,
 350                               "test-plugin-transport",
 351                               "testcase",
 352                               options,
 353                               &run, NULL)) ? ok : 1;
 354   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
 355   return ret;
 356 }
 357
 358 /* end of test_plugin_transport_udp.c */