src/transport/test_plugin_transport_udp.c

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