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