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