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