src/transport/gnunet-service-transport.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 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 /**
  22  * @file transport/gnunet-service-transport-new.c
  23  * @brief
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet_transport_service.h"
  30 #include "gnunet_peerinfo_service.h"
  31 #include "gnunet_ats_service.h"
  32 #include "gnunet-service-transport.h"
  33 #include "gnunet-service-transport_blacklist.h"
  34 #include "gnunet-service-transport_clients.h"
  35 #include "gnunet-service-transport_hello.h"
  36 #include "gnunet-service-transport_neighbours.h"
  37 #include "gnunet-service-transport_plugins.h"
  38 #include "gnunet-service-transport_validation.h"
  39 #include "transport.h"
  40
  41 /* globals */
  42
  43 /**
  44  * Statistics handle.
  45  */
  46 struct GNUNET_STATISTICS_Handle *GST_stats;
  47
  48 /**
  49  * Configuration handle.
  50  */
  51 const struct GNUNET_CONFIGURATION_Handle *GST_cfg;
  52
  53 /**
  54  * Configuration handle.
  55  */
  56 struct GNUNET_PeerIdentity GST_my_identity;
  57
  58 /**
  59  * Handle to peerinfo service.
  60  */
  61 struct GNUNET_PEERINFO_Handle *GST_peerinfo;
  62
  63 /**
  64  * Our public key.
  65  */
  66 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded GST_my_public_key;
  67
  68 /**
  69  * Our private key.
  70  */
  71 struct GNUNET_CRYPTO_RsaPrivateKey *GST_my_private_key;
  72
  73 /**
  74  * ATS handle.
  75  */
  76 struct GNUNET_ATS_Handle *GST_ats;
  77
  78
  79 /**
  80  * Transmit our HELLO message to the given (connected) neighbour.
  81  *
  82  * @param cls the 'HELLO' message
  83  * @param target a connected neighbour
  84  * @param ats performance information (unused)
  85  * @param ats_count number of records in ats (unused)
  86  */
  87 static void
  88 transmit_our_hello (void *cls, const struct GNUNET_PeerIdentity *target,
  89                     const struct GNUNET_TRANSPORT_ATS_Information *ats,
  90                     uint32_t ats_count)
  91 {
  92   const struct GNUNET_MessageHeader *hello = cls;
  93
  94   GST_neighbours_send (target, (const char *) hello, ntohs (hello->size),
  95                        GST_HELLO_ADDRESS_EXPIRATION, NULL, NULL);
  96 }
  97
  98
  99 /**
 100  * My HELLO has changed. Tell everyone who should know.
 101  *
 102  * @param cls unused
 103  * @param hello new HELLO
 104  */
 105 static void
 106 process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello)
 107 {
 108   GST_clients_broadcast (hello, GNUNET_NO);
 109   GST_neighbours_iterate (&transmit_our_hello, (void *) hello);
 110 }
 111
 112
 113 /**
 114  * Try to initiate a connection to the given peer if the blacklist
 115  * allowed it.
 116  *
 117  * @param cls closure (unused, NULL)
 118  * @param peer identity of peer that was tested
 119  * @param result GNUNET_OK if the connection is allowed,
 120  *               GNUNET_NO if not
 121  */
 122 static void
 123 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
 124                         int result)
 125 {
 126   if (GNUNET_OK != result)
 127     return;                     /* not allowed */
 128   GST_neighbours_try_connect (peer);
 129 }
 130
 131
 132 /**
 133  * Function called by the transport for each received message.
 134  * This function should also be called with "NULL" for the
 135  * message to signal that the other peer disconnected.
 136  *
 137  * @param cls closure, const char* with the name of the plugin we received the message from
 138  * @param peer (claimed) identity of the other peer
 139  * @param message the message, NULL if we only care about
 140  *                learning about the delay until we should receive again -- FIXME!
 141  * @param ats performance information
 142  * @param ats_count number of records in ats
 143  * @param session identifier used for this session (NULL for plugins
 144  *                that do not offer bi-directional communication to the sender
 145  *                using the same "connection")
 146  * @param sender_address binary address of the sender (if we established the
 147  *                connection or are otherwise sure of it; should be NULL
 148  *                for inbound TCP/UDP connections since it it not clear
 149  *                that we could establish ourselves a connection to that
 150  *                IP address and get the same system)
 151  * @param sender_address_len number of bytes in sender_address
 152  * @return how long the plugin should wait until receiving more data
 153  *         (plugins that do not support this, can ignore the return value)
 154  */
 155 static struct GNUNET_TIME_Relative
 156 plugin_env_receive_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
 157                              const struct GNUNET_MessageHeader *message,
 158                              const struct GNUNET_TRANSPORT_ATS_Information *ats,
 159                              uint32_t ats_count, struct Session *session,
 160                              const char *sender_address,
 161                              uint16_t sender_address_len)
 162 {
 163   const char *plugin_name = cls;
 164   int do_forward;
 165   struct GNUNET_TIME_Relative ret;
 166   uint16_t type;
 167
 168   ret = GNUNET_TIME_UNIT_ZERO;
 169   if (NULL != message)
 170   {
 171     type = ntohs (message->type);
 172     switch (type)
 173     {
 174     case GNUNET_MESSAGE_TYPE_HELLO:
 175       GST_validation_handle_hello (message);
 176       return ret;
 177     case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
 178 #if DEBUG_TRANSPORT
 179       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 180                   "Processing `%s' from `%s'\n", "PING",
 181                   (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
 182                                                               sender_address,
 183                                                               sender_address_len)
 184                   : "<inbound>");
 185 #endif
 186       GST_validation_handle_ping (peer, message, plugin_name, session,
 187                                   sender_address, sender_address_len);
 188       break;
 189     case GNUNET_MESSAGE_TYPE_TRANSPORT_PONG:
 190 #if DEBUG_TRANSPORT
 191       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 192                   "Processing `%s' from `%s'\n", "PONG",
 193                   (sender_address != NULL) ? GST_plugins_a2s (plugin_name,
 194                                                               sender_address,
 195                                                               sender_address_len)
 196                   : "<inbound>");
 197 #endif
 198       GST_validation_handle_pong (peer, message);
 199       break;
 200     case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT:
 201       (void) GST_blacklist_test_allowed (peer, NULL, &try_connect_if_allowed,
 202                                          NULL);
 203       /* TODO: if 'session != NULL', and timestamp more recent than the
 204        * previous one, maybe notify ATS that this is now the preferred
 205        * * way to communicate with this peer (other peer switched transport) */
 206       break;
 207     case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT:
 208       /* FIXME: do some validation to prevent an attacker from sending
 209        * a fake disconnect message... */
 210       GST_neighbours_force_disconnect (peer);
 211       break;
 212     case GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE:
 213       GST_neighbours_keepalive (peer);
 214       break;
 215     default:
 216       /* should be payload */
 217       do_forward = GNUNET_SYSERR;
 218       ret =
 219           GST_neighbours_calculate_receive_delay (peer,
 220                                                   (message ==
 221                                                    NULL) ? 0 :
 222                                                   ntohs (message->size),
 223                                                   &do_forward);
 224       if (do_forward == GNUNET_YES)
 225       {
 226         struct InboundMessage *im;
 227         size_t size = sizeof (struct InboundMessage) + ntohs (message->size);
 228
 229         im = GNUNET_malloc (size);
 230         im->header.size = htons (size);
 231         im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
 232         im->ats_count = htonl (0);
 233         memcpy (&(im->peer), peer, sizeof (struct GNUNET_PeerIdentity));
 234         memcpy (&im[1], message, ntohs (message->size));
 235
 236         GST_clients_broadcast ((const struct GNUNET_MessageHeader *) im,
 237                                GNUNET_YES);
 238
 239         GNUNET_free (im);
 240       }
 241       break;
 242     }
 243   }
 244   GNUNET_assert ((ats_count > 0) && (ats != NULL));
 245   /*
 246      FIXME: this gives an address that might not have been validated to
 247      ATS for 'selection', which is probably not what we want; this
 248      might be particularly wrong (as in, possibly hiding bugs with address
 249      validation) as 'GNUNET_ATS_address_update' currently ignores
 250      the expiration given.
 251   */
 252   GNUNET_ATS_address_update (GST_ats, peer, GNUNET_TIME_absolute_get (),        /* valid at least until right now... */
 253                              plugin_name, session, sender_address,
 254                              sender_address_len, ats, ats_count);
 255   return ret;
 256 }
 257
 258
 259 /**
 260  * Function that will be called for each address the transport
 261  * is aware that it might be reachable under.  Update our HELLO.
 262  *
 263  * @param cls name of the plugin (const char*)
 264  * @param add_remove should the address added (YES) or removed (NO) from the
 265  *                   set of valid addresses?
 266  * @param addr one of the addresses of the host
 267  *        the specific address format depends on the transport
 268  * @param addrlen length of the address
 269  */
 270 static void
 271 plugin_env_address_change_notification (void *cls, int add_remove,
 272                                         const void *addr, size_t addrlen)
 273 {
 274   const char *plugin_name = cls;
 275
 276   GST_hello_modify_addresses (add_remove, plugin_name, addr, addrlen);
 277 }
 278
 279
 280 /**
 281  * Function that will be called whenever the plugin internally
 282  * cleans up a session pointer and hence the service needs to
 283  * discard all of those sessions as well.  Plugins that do not
 284  * use sessions can simply omit calling this function and always
 285  * use NULL wherever a session pointer is needed.  This function
 286  * should be called BEFORE a potential "TransmitContinuation"
 287  * from the "TransmitFunction".
 288  *
 289  * @param cls closure
 290  * @param peer which peer was the session for
 291  * @param session which session is being destoyed
 292  */
 293 static void
 294 plugin_env_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
 295                         struct Session *session)
 296 {
 297 #if DEBUG_TRANSPORT
 298   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 299               "Session %X to peer `%s' ended \n",
 300               session, GNUNET_i2s (peer));
 301 #endif
 302   GNUNET_ATS_session_destroyed(GST_ats, peer, session);
 303   GST_neighbours_session_terminated (peer, session);
 304 }
 305
 306
 307 /**
 308  * Function called by ATS to notify the callee that the
 309  * assigned bandwidth or address for a given peer was changed.  If the
 310  * callback is called with address/bandwidth assignments of zero, the
 311  * ATS disconnect function will still be called once the disconnect
 312  * actually happened.
 313  *
 314  * @param cls closure
 315  * @param peer identity of the peer
 316  * @param plugin_name name of the transport plugin, NULL to disconnect
 317  * @param session session to use (if available)
 318  * @param plugin_addr address to use (if available)
 319  * @param plugin_addr_len number of bytes in addr
 320  * @param bandwidth assigned outbound bandwidth for the connection
 321  */
 322 static void
 323 ats_request_address_change (void *cls, const struct GNUNET_PeerIdentity *peer,
 324                             const char *plugin_name, struct Session *session,
 325                             const void *plugin_addr, size_t plugin_addr_len,
 326                             struct GNUNET_BANDWIDTH_Value32NBO bandwidth)
 327 {
 328   GST_neighbours_switch_to_address (peer, plugin_name, plugin_addr,
 329                                     plugin_addr_len, session, NULL, 0);
 330   GST_neighbours_set_incoming_quota (peer, bandwidth);
 331 }
 332
 333
 334 /**
 335  * Function called to notify transport users that another
 336  * peer connected to us.
 337  *
 338  * @param cls closure
 339  * @param peer the peer that connected
 340  * @param ats performance data
 341  * @param ats_count number of entries in ats (excluding 0-termination)
 342  */
 343 static void
 344 neighbours_connect_notification (void *cls,
 345                                  const struct GNUNET_PeerIdentity *peer,
 346                                  const struct GNUNET_TRANSPORT_ATS_Information
 347                                  *ats, uint32_t ats_count)
 348 {
 349   char buf[sizeof (struct ConnectInfoMessage) +
 350            ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)];
 351   struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
 352   struct GNUNET_TRANSPORT_ATS_Information *atsm = &connect_msg->ats;
 353
 354   connect_msg->header.size = htons (sizeof (buf));
 355   connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
 356   connect_msg->ats_count = htonl (ats_count);
 357   connect_msg->id = *peer;
 358   memcpy (&connect_msg->ats, ats,
 359           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 360   atsm[ats_count].type = htonl (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR);
 361   atsm[ats_count].value = htonl (0);
 362   GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
 363 }
 364
 365
 366 /**
 367  * Function called to notify transport users that another
 368  * peer disconnected from us.
 369  *
 370  * @param cls closure
 371  * @param peer the peer that disconnected
 372  */
 373 static void
 374 neighbours_disconnect_notification (void *cls,
 375                                     const struct GNUNET_PeerIdentity *peer)
 376 {
 377   struct DisconnectInfoMessage disconnect_msg;
 378
 379   disconnect_msg.header.size = htons (sizeof (struct DisconnectInfoMessage));
 380   disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
 381   disconnect_msg.reserved = htonl (0);
 382   disconnect_msg.peer = *peer;
 383   GST_clients_broadcast (&disconnect_msg.header, GNUNET_NO);
 384 }
 385
 386
 387 /**
 388  * Function called when the service shuts down.  Unloads our plugins
 389  * and cancels pending validations.
 390  *
 391  * @param cls closure, unused
 392  * @param tc task context (unused)
 393  */
 394 static void
 395 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 396 {
 397   GST_validation_stop ();
 398   GST_plugins_unload ();
 399   GST_neighbours_stop ();
 400   GNUNET_ATS_shutdown (GST_ats);
 401   GST_ats = NULL;
 402   GST_clients_stop ();
 403   GST_blacklist_stop ();
 404   GST_hello_stop ();
 405
 406   if (GST_peerinfo != NULL)
 407   {
 408     GNUNET_PEERINFO_disconnect (GST_peerinfo);
 409     GST_peerinfo = NULL;
 410   }
 411   if (GST_stats != NULL)
 412   {
 413     GNUNET_STATISTICS_destroy (GST_stats, GNUNET_NO);
 414     GST_stats = NULL;
 415   }
 416   if (GST_my_private_key != NULL)
 417   {
 418     GNUNET_CRYPTO_rsa_key_free (GST_my_private_key);
 419     GST_my_private_key = NULL;
 420   }
 421 }
 422
 423
 424 /**
 425  * Initiate transport service.
 426  *
 427  * @param cls closure
 428  * @param server the initialized server
 429  * @param c configuration to use
 430  */
 431 static void
 432 run (void *cls, struct GNUNET_SERVER_Handle *server,
 433      const struct GNUNET_CONFIGURATION_Handle *c)
 434 {
 435   char *keyfile;
 436
 437   /* setup globals */
 438   GST_cfg = c;
 439   if (GNUNET_OK !=
 440       GNUNET_CONFIGURATION_get_value_filename (c, "GNUNETD", "HOSTKEY",
 441                                                &keyfile))
 442   {
 443     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 444                 _
 445                 ("Transport service is lacking key configuration settings.  Exiting.\n"));
 446     GNUNET_SCHEDULER_shutdown ();
 447     return;
 448   }
 449   GST_my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 450   GNUNET_free (keyfile);
 451   if (GST_my_private_key == NULL)
 452   {
 453     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 454                 _("Transport service could not access hostkey.  Exiting.\n"));
 455     GNUNET_SCHEDULER_shutdown ();
 456     return;
 457   }
 458   GST_stats = GNUNET_STATISTICS_create ("transport", c);
 459   GST_peerinfo = GNUNET_PEERINFO_connect (c);
 460   GNUNET_CRYPTO_rsa_key_get_public (GST_my_private_key, &GST_my_public_key);
 461   GNUNET_CRYPTO_hash (&GST_my_public_key, sizeof (GST_my_public_key),
 462                       &GST_my_identity.hashPubKey);
 463   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
 464                                 NULL);
 465   if (GST_peerinfo == NULL)
 466   {
 467     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 468                 _("Could not access PEERINFO service.  Exiting.\n"));
 469     GNUNET_SCHEDULER_shutdown ();
 470     return;
 471   }
 472
 473   /* start subsystems */
 474   GST_hello_start (&process_hello_update, NULL);
 475   GST_blacklist_start (server);
 476   GST_plugins_load (&plugin_env_receive_callback,
 477                     &plugin_env_address_change_notification,
 478                     &plugin_env_session_end);
 479   GST_ats = GNUNET_ATS_init (GST_cfg, &ats_request_address_change, NULL);
 480   GST_neighbours_start (NULL, &neighbours_connect_notification,
 481                         &neighbours_disconnect_notification);
 482   GST_clients_start (server);
 483   GST_validation_start ();
 484 }
 485
 486
 487 /**
 488  * The main function for the transport service.
 489  *
 490  * @param argc number of arguments from the command line
 491  * @param argv command line arguments
 492  * @return 0 ok, 1 on error
 493  */
 494 int
 495 main (int argc, char *const *argv)
 496 {
 497   return (GNUNET_OK ==
 498           GNUNET_SERVICE_run (argc, argv, "transport",
 499                               GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
 500 }
 501
 502 /* end of file gnunet-service-transport-new.c */