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