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 3, 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          const struct GNUNET_PeerIdentity
  98          *peer, const struct GNUNET_MessageHeader *message,
  99          uint32_t distance,
 100          const char *sender_address,
 101          size_t sender_address_len)
 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_tcp",
 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 /**
 142  * Simple example test that invokes
 143  * the "validate" function of the plugin
 144  * and tries to see if the plugin would
 145  * succeed to validate its own address.
 146  * (This test is not well-written since
 147  *  we hand-compile the address which
 148  *  kind-of works for TCP but would not
 149  *  work for other plugins; we should ask
 150  *  the plugin about its address instead...).
 151  */
 152 /* FIXME: this is TCP/UDP-specific and won't work
 153    for HTTP/SMTP/DV; we should instead use an
 154    address that we get from the plugin itself
 155    (if it is willing/able to give us one...) */
 156 static void
 157 test_validation ()
 158 {
 159   struct sockaddr_in soaddr;
 160
 161   memset (&soaddr, 0, sizeof (soaddr));
 162 #if HAVE_SOCKADDR_IN_SIN_LEN
 163   soaddr.sin_len = sizeof (soaddr);
 164 #endif
 165   soaddr.sin_family = AF_INET;
 166   soaddr.sin_port = htons (2368 /* FIXME: get from config! */ );
 167   soaddr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 168   GNUNET_assert (GNUNET_OK ==
 169                  api->check_address (api->cls,
 170                                      &soaddr, sizeof (soaddr)));
 171   ok = 0;
 172   GNUNET_SCHEDULER_add_continuation (sched,
 173                                      &unload_task,
 174                                      (void *) cfg,
 175                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 176 }
 177
 178
 179 static void
 180 setup_plugin_environment ()
 181 {
 182   env.cfg = cfg;
 183   env.sched = sched;
 184   env.my_identity = &my_identity;
 185   env.cls = &env;
 186   env.receive = &receive;
 187   env.notify_address = &notify_address;
 188   env.max_connections = max_connect_per_transport;
 189 }
 190
 191
 192 /**
 193  * Runs the test.
 194  *
 195  * @param cls closure
 196  * @param s scheduler to use
 197  * @param c configuration to use
 198  */
 199 static void
 200 run (void *cls,
 201      struct GNUNET_SCHEDULER_Handle *s,
 202      char *const *args,
 203      const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
 204 {
 205   unsigned long long tneigh;
 206   char *keyfile;
 207   char *libname;
 208
 209   sched = s;
 210   cfg = c;
 211   /* parse configuration */
 212   if ((GNUNET_OK !=
 213        GNUNET_CONFIGURATION_get_value_number (c,
 214                                               "TRANSPORT",
 215                                               "NEIGHBOUR_LIMIT",
 216                                               &tneigh)) ||
 217       (GNUNET_OK !=
 218        GNUNET_CONFIGURATION_get_value_filename (c,
 219                                                 "GNUNETD",
 220                                                 "HOSTKEY", &keyfile)))
 221     {
 222       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 223                   _
 224                   ("Transport service is lacking key configuration settings.  Exiting.\n"));
 225       GNUNET_SCHEDULER_shutdown (s);
 226       return;
 227     }
 228   max_connect_per_transport = (uint32_t) tneigh;
 229   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 230   GNUNET_free (keyfile);
 231   if (my_private_key == NULL)
 232     {
 233       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 234                   _
 235                   ("Transport service could not access hostkey.  Exiting.\n"));
 236       GNUNET_SCHEDULER_shutdown (s);
 237       return;
 238     }
 239   GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
 240   GNUNET_CRYPTO_hash (&my_public_key,
 241                       sizeof (my_public_key), &my_identity.hashPubKey);
 242
 243
 244
 245   /* load plugins... */
 246   setup_plugin_environment ();
 247   GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading tcp transport plugin\n"));
 248   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_tcp");
 249
 250   api = GNUNET_PLUGIN_load (libname, &env);
 251   GNUNET_free (libname);
 252   if (api == NULL)
 253     {
 254       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 255                   _("Failed to load transport plugin for tcp\n"));
 256       /* FIXME: set some error code for main */
 257       return;
 258     }
 259   test_validation ();
 260 }
 261
 262
 263 /**
 264  * The main function for the transport service.
 265  *
 266  * @param argc number of arguments from the command line
 267  * @param argv command line arguments
 268  * @return 0 ok, 1 on error
 269  */
 270 int
 271 main (int argc, char *const *argv)
 272 {
 273   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 274     GNUNET_GETOPT_OPTION_END
 275   };
 276   int ret;
 277   char *const argv_prog[] = {
 278     "test_plugin_transport",
 279     "-c",
 280     "test_plugin_transport_data.conf",
 281     "-L",
 282 #if VERBOSE
 283     "DEBUG",
 284 #else
 285     "WARNING",
 286 #endif
 287     NULL
 288   };
 289   GNUNET_log_setup ("test-plugin-transport",
 290 #if VERBOSE
 291                     "DEBUG",
 292 #else
 293                     "WARNING",
 294 #endif
 295                     NULL);
 296   ok = 1;                       /* set to fail */
 297   ret = (GNUNET_OK ==
 298          GNUNET_PROGRAM_run (5,
 299                              argv_prog,
 300                              "test-plugin-transport",
 301                              "testcase", options, &run, NULL)) ? ok : 1;
 302   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
 303   return ret;
 304 }
 305
 306 /* end of test_plugin_transport.c */