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 struct ReadyList *
  96 receive(void *cls,
  97         struct ReadyList *
  98         service_context,
  99         struct GNUNET_TIME_Relative
 100         latency,
 101         const struct GNUNET_PeerIdentity
 102         * peer,
 103         const struct GNUNET_MessageHeader
 104         * message)
 105 {
 106   return NULL;
 107 }
 108
 109 void notify_address(void *cls,
 110                     const char *name,
 111                     const void *addr,
 112                     size_t addrlen,
 113                     struct
 114                     GNUNET_TIME_Relative
 115                     expires)
 116 {
 117 }
 118
 119 /**
 120  * Function called when the service shuts
 121  * down.  Unloads our plugins.
 122  *
 123  * @param cls closure
 124  * @param cfg configuration to use
 125  */
 126 static void
 127 unload_plugins (void *cls,
 128                 const struct GNUNET_CONFIGURATION_Handle *cfg)
 129 {
 130   GNUNET_assert (NULL == GNUNET_PLUGIN_unload ("libgnunet_plugin_transport_tcp",api));
 131   if (my_private_key != NULL)
 132     GNUNET_CRYPTO_rsa_key_free (my_private_key);
 133
 134 }
 135
 136
 137 static void
 138 unload_task (void *cls,
 139              const struct GNUNET_SCHEDULER_TaskContext *tc)
 140 {
 141   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 142   unload_plugins (NULL, cfg);
 143 }
 144
 145
 146 static GNUNET_SCHEDULER_TaskIdentifier validation_timeout_task;
 147
 148
 149 static void
 150 validation_notification (void *cls,
 151                          const char *name,
 152                          const struct GNUNET_PeerIdentity *peer,
 153                          uint32_t challenge,
 154                          const char *sender_addr)
 155 {
 156   if (validation_timeout_task != GNUNET_SCHEDULER_NO_TASK)
 157     {
 158       GNUNET_SCHEDULER_cancel (sched, validation_timeout_task);
 159       validation_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 160     }
 161
 162   GNUNET_assert (challenge == 42);
 163
 164   ok = 0; /* if the last test succeeded, report success */
 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   api->validate (api->cls,
 212                  &my_identity,
 213                  42,
 214                  TIMEOUT,
 215                  &soaddr,
 216                  sizeof(soaddr));
 217   /* add job to catch failure (timeout) */
 218   validation_timeout_task =
 219     GNUNET_SCHEDULER_add_delayed (sched,
 220                                   TIMEOUT,
 221                                   &validation_failed,
 222                                   NULL);
 223 }
 224
 225
 226 static void setup_plugin_environment()
 227 {
 228   env.cfg  = cfg;
 229   env.sched = sched;
 230   env.my_public_key = &my_public_key;
 231   env.my_private_key = my_private_key;
 232   env.my_identity = &my_identity;
 233   env.cls=&env;
 234   env.receive=&receive;
 235   env.notify_address=&notify_address;
 236   env.notify_validation = &validation_notification;
 237   env.max_connections = max_connect_per_transport;
 238 }
 239
 240
 241 /**
 242  * Runs the test.
 243  *
 244  * @param cls closure
 245  * @param s scheduler to use
 246  * @param c configuration to use
 247  */
 248 static void
 249 run (void *cls,
 250      struct GNUNET_SCHEDULER_Handle *s,
 251      char *const *args,
 252      const char *cfgfile,
 253      const struct GNUNET_CONFIGURATION_Handle *c)
 254 {
 255   unsigned long long tneigh;
 256   char *keyfile;
 257   char *libname;
 258
 259   sched = s;
 260   cfg = c;
 261   /* parse configuration */
 262   if ((GNUNET_OK !=
 263        GNUNET_CONFIGURATION_get_value_number (c,
 264                                               "TRANSPORT",
 265                                               "NEIGHBOUR_LIMIT",
 266                                               &tneigh)) ||
 267       (GNUNET_OK !=
 268        GNUNET_CONFIGURATION_get_value_filename (c,
 269                                                 "GNUNETD",
 270                                                 "HOSTKEY", &keyfile)))
 271     {
 272       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 273                   _("Transport service is lacking key configuration settings.  Exiting.\n"));
 274       GNUNET_SCHEDULER_shutdown (s);
 275       return;
 276     }
 277   max_connect_per_transport = (uint32_t) tneigh;
 278   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 279   GNUNET_free (keyfile);
 280   if (my_private_key == NULL)
 281     {
 282       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 283                   _("Transport service could not access hostkey.  Exiting.\n"));
 284       GNUNET_SCHEDULER_shutdown (s);
 285       return;
 286     }
 287   GNUNET_CRYPTO_rsa_key_get_public (my_private_key,
 288                                     &my_public_key);
 289   GNUNET_CRYPTO_hash (&my_public_key,
 290                       sizeof (my_public_key),
 291                       &my_identity.hashPubKey);
 292
 293
 294
 295   /* load plugins... */
 296   setup_plugin_environment();
 297   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 298               _("Loading tcp transport plugin\n"));
 299   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_tcp");
 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 tcp\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.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.c */