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