src/dv/plugin_transport_dv.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 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 /**
  22  * @file dv/plugin_transport_dv.c
  23  * @brief DV transport service, takes incoming DV requests and deals with
  24  * the DV service
  25  * @author Nathan Evans
  26  * @author Christian Grothoff
  27  */
  28
  29 #include "platform.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_connection_lib.h"
  32 #include "gnunet_server_lib.h"
  33 #include "gnunet_service_lib.h"
  34 #include "gnunet_statistics_service.h"
  35 #include "gnunet_dv_service.h"
  36 #include "gnunet_transport_service.h"
  37 #include "gnunet_transport_plugin.h"
  38 #include "dv.h"
  39
  40 #define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
  41
  42 /**
  43  * Encapsulation of all of the state of the plugin.
  44  */
  45 struct Plugin;
  46
  47
  48 /**
  49  * Session handle for connections.
  50  */
  51 struct Session
  52 {
  53
  54   /**
  55    * Stored in a linked list.
  56    */
  57   struct Session *next;
  58
  59   /**
  60    * Pointer to the global plugin struct.
  61    */
  62   struct Plugin *plugin;
  63
  64   /**
  65    * The client (used to identify this connection)
  66    */
  67   /* void *client; */
  68
  69   /**
  70    * Continuation function to call once the transmission buffer
  71    * has again space available.  NULL if there is no
  72    * continuation to call.
  73    */
  74   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
  75
  76   /**
  77    * Closure for transmit_cont.
  78    */
  79   void *transmit_cont_cls;
  80
  81   /**
  82    * To whom are we talking to (set to our identity
  83    * if we are still waiting for the welcome message)
  84    */
  85   struct GNUNET_PeerIdentity sender;
  86
  87   /**
  88    * At what time did we reset last_received last?
  89    */
  90   struct GNUNET_TIME_Absolute last_quota_update;
  91
  92   /**
  93    * How many bytes have we received since the "last_quota_update"
  94    * timestamp?
  95    */
  96   uint64_t last_received;
  97
  98   /**
  99    * Number of bytes per ms that this peer is allowed
 100    * to send to us.
 101    */
 102   uint32_t quota;
 103
 104 };
 105
 106 /**
 107  * Encapsulation of all of the state of the plugin.
 108  */
 109 struct Plugin
 110 {
 111   /**
 112    * Our environment.
 113    */
 114   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 115
 116   /**
 117    * List of open sessions.
 118    */
 119   struct Session *sessions;
 120
 121   /**
 122    * Our server.
 123    */
 124   //struct GNUNET_SERVER_Handle *server;
 125
 126   /*
 127    * Handle to the running service.
 128    */
 129   //struct GNUNET_SERVICE_Context *service;
 130
 131   /**
 132    * Copy of the handler array where the closures are
 133    * set to this struct's instance.
 134    */
 135   struct GNUNET_SERVER_MessageHandler *handlers;
 136
 137   /**
 138    * Handle to the DV service
 139    */
 140   struct GNUNET_DV_Handle *dv_handle;
 141
 142 };
 143
 144 /**
 145  * Handler for messages received from the DV service.
 146  */
 147 void
 148 handle_dv_message_received (void *cls, struct GNUNET_PeerIdentity *sender,
 149                             char *msg, size_t msg_len, uint32_t distance,
 150                             char *sender_address, size_t sender_address_len)
 151 {
 152   struct Plugin *plugin = cls;
 153
 154 #if DEBUG_DV_MESSAGES
 155   char *my_id;
 156
 157   my_id = GNUNET_strdup (GNUNET_i2s (plugin->env->my_identity));
 158   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "plugin_transport_dv",
 159                    _("%s Received message from %s of type %d, distance %u!\n"),
 160                    my_id, GNUNET_i2s (sender),
 161                    ntohs (((struct GNUNET_MessageHeader *) msg)->type),
 162                    distance);
 163   if (sender_address_len == (2 * sizeof (struct GNUNET_PeerIdentity)))
 164   {
 165     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "plugin_transport_dv",
 166                      "Parsed sender address: %s:%s\n",
 167                      GNUNET_i2s ((struct GNUNET_PeerIdentity *) sender_address),
 168                      GNUNET_h2s (&
 169                                  ((struct GNUNET_PeerIdentity *)
 170                                   &sender_address[sizeof
 171                                                   (struct
 172                                                    GNUNET_PeerIdentity)])->hashPubKey));
 173   }
 174
 175   GNUNET_free_non_null (my_id);
 176 #endif
 177   struct GNUNET_ATS_Information ats[1];
 178
 179   ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
 180   ats[0].value = htonl (distance);
 181
 182   plugin->env->receive (plugin->env->cls, sender,
 183                         (struct GNUNET_MessageHeader *) msg,
 184                         (const struct GNUNET_ATS_Information *) &ats, 1, NULL,
 185                         sender_address, sender_address_len);
 186
 187 }
 188
 189
 190 /* Question: how does the transport service learn of a newly connected (gossipped about)
 191  * DV peer?  Should the plugin (here) create a HELLO for that peer and send it along,
 192  * or should the DV service create a HELLO and send it to us via the other part?
 193  */
 194
 195 /**
 196  * Function that can be used by the transport service to transmit
 197  * a message using the plugin.
 198  *
 199  * @param cls closure
 200  * @param target who should receive this message
 201  * @param priority how important is the message
 202  * @param msgbuf the message to transmit
 203  * @param msgbuf_size number of bytes in 'msgbuf'
 204  * @param timeout when should we time out
 205  * @param session the session used
 206  * @param addr the address to use (can be NULL if the plugin
 207  *                is "on its own" (i.e. re-use existing TCP connection))
 208  * @param addrlen length of the address in bytes
 209  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 210  *                otherwise the plugin may use other addresses or
 211  *                existing connections (if available)
 212  * @param cont continuation to call once the message has
 213  *        been transmitted (or if the transport is ready
 214  *        for the next transmission call; or if the
 215  *        peer disconnected...)
 216  * @param cont_cls closure for cont
 217  * @return number of bytes used (on the physical network, with overheads);
 218  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 219  *         and does NOT mean that the message was not transmitted (DV)
 220  */
 221 static ssize_t
 222 dv_plugin_send (void *cls, const struct GNUNET_PeerIdentity *target,
 223                 const char *msgbuf, size_t msgbuf_size, unsigned int priority,
 224                 struct GNUNET_TIME_Relative timeout, struct Session *session,
 225                 const void *addr, size_t addrlen, int force_address,
 226                 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 227 {
 228   int ret = 0;
 229   struct Plugin *plugin = cls;
 230
 231   ret =
 232       GNUNET_DV_send (plugin->dv_handle, target, msgbuf, msgbuf_size, priority,
 233                       timeout, addr, addrlen, cont, cont_cls);
 234   return ret;
 235 }
 236
 237
 238
 239 /**
 240  * Function that can be used to force the plugin to disconnect
 241  * from the given peer and cancel all previous transmissions
 242  * (and their continuations).
 243  *
 244  * @param cls closure
 245  * @param target peer from which to disconnect
 246  */
 247 static void
 248 dv_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
 249 {
 250   // struct Plugin *plugin = cls;
 251   // TODO: Add message type to send to dv service to "disconnect" a peer
 252 }
 253
 254
 255 /**
 256  * Convert the transports address to a nice, human-readable
 257  * format.
 258  *
 259  * @param cls closure
 260  * @param type name of the transport that generated the address
 261  * @param addr one of the addresses of the host, NULL for the last address
 262  *        the specific address format depends on the transport
 263  * @param addrlen length of the address
 264  * @param numeric should (IP) addresses be displayed in numeric form?
 265  * @param timeout after how long should we give up?
 266  * @param asc function to call on each string
 267  * @param asc_cls closure for asc
 268  */
 269 static void
 270 dv_plugin_address_pretty_printer (void *cls, const char *type, const void *addr,
 271                                   size_t addrlen, int numeric,
 272                                   struct GNUNET_TIME_Relative timeout,
 273                                   GNUNET_TRANSPORT_AddressStringCallback asc,
 274                                   void *asc_cls)
 275 {
 276   char *dest_peer;
 277   char *via_peer;
 278   char *print_string;
 279   char *addr_buf = (char *) addr;
 280
 281   if (addrlen != sizeof (struct GNUNET_PeerIdentity) * 2)
 282   {
 283     asc (asc_cls, NULL);
 284   }
 285   else
 286   {
 287     dest_peer =
 288         GNUNET_strdup (GNUNET_i2s ((struct GNUNET_PeerIdentity *) addr));
 289     via_peer =
 290         GNUNET_strdup (GNUNET_i2s
 291                        ((struct GNUNET_PeerIdentity *)
 292                         &addr_buf[sizeof (struct GNUNET_PeerIdentity)]));
 293     GNUNET_asprintf (&print_string, "DV Peer `%s' via peer`%s'", dest_peer,
 294                      via_peer);
 295     asc (asc_cls, print_string);
 296     asc (asc_cls, NULL);
 297     GNUNET_free (via_peer);
 298     GNUNET_free (dest_peer);
 299     GNUNET_free (print_string);
 300   }
 301 }
 302
 303 /**
 304  * Convert the DV address to a pretty string.
 305  *
 306  * @param cls closure
 307  * @param addr the (hopefully) DV address
 308  * @param addrlen the length of the address
 309  *
 310  * @return string representing the DV address
 311  */
 312 static const char *
 313 address_to_string (void *cls, const void *addr, size_t addrlen)
 314 {
 315   static char return_buffer[2 * 4 + 2]; // Two four character peer identity prefixes a ':' and '\0'
 316
 317   struct GNUNET_CRYPTO_HashAsciiEncoded peer_hash;
 318   struct GNUNET_CRYPTO_HashAsciiEncoded via_hash;
 319   struct GNUNET_PeerIdentity *peer;
 320   struct GNUNET_PeerIdentity *via;
 321   char *addr_buf = (char *) addr;
 322
 323   if (addrlen == (2 * sizeof (struct GNUNET_PeerIdentity)))
 324   {
 325     peer = (struct GNUNET_PeerIdentity *) addr_buf;
 326     via =
 327         (struct GNUNET_PeerIdentity *)
 328         &addr_buf[sizeof (struct GNUNET_PeerIdentity)];
 329
 330     GNUNET_CRYPTO_hash_to_enc (&peer->hashPubKey, &peer_hash);
 331     peer_hash.encoding[4] = '\0';
 332     GNUNET_CRYPTO_hash_to_enc (&via->hashPubKey, &via_hash);
 333     via_hash.encoding[4] = '\0';
 334     GNUNET_snprintf (return_buffer, sizeof (return_buffer), "%s:%s", &peer_hash,
 335                      &via_hash);
 336   }
 337   else
 338     return NULL;
 339
 340   return return_buffer;
 341 }
 342
 343 /**
 344  * Another peer has suggested an address for this peer and transport
 345  * plugin.  Check that this could be a valid address.  This function
 346  * is not expected to 'validate' the address in the sense of trying to
 347  * connect to it but simply to see if the binary format is technically
 348  * legal for establishing a connection to this peer (and make sure that
 349  * the address really corresponds to our network connection/settings
 350  * and not some potential man-in-the-middle).
 351  *
 352  * @param cls closure
 353  * @param addr pointer to the address
 354  * @param addrlen length of addr
 355  * @return GNUNET_OK if this is a plausible address for this peer
 356  *         and transport, GNUNET_SYSERR if not
 357  *
 358  */
 359 static int
 360 dv_plugin_check_address (void *cls, const void *addr, size_t addrlen)
 361 {
 362   struct Plugin *plugin = cls;
 363
 364   /* Verify that the first peer of this address matches our peer id! */
 365   if ((addrlen != (2 * sizeof (struct GNUNET_PeerIdentity))) ||
 366       (0 !=
 367        memcmp (addr, plugin->env->my_identity,
 368                sizeof (struct GNUNET_PeerIdentity))))
 369   {
 370     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 371                 "%s: Address not correct size or identity doesn't match ours!\n",
 372                 GNUNET_i2s (plugin->env->my_identity));
 373     if (addrlen == (2 * sizeof (struct GNUNET_PeerIdentity)))
 374     {
 375       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer in address is %s\n",
 376                   GNUNET_i2s (addr));
 377     }
 378     return GNUNET_SYSERR;
 379   }
 380
 381   return GNUNET_OK;
 382 }
 383
 384
 385 /**
 386  * Entry point for the plugin.
 387  */
 388 void *
 389 libgnunet_plugin_transport_dv_init (void *cls)
 390 {
 391   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 392   struct GNUNET_TRANSPORT_PluginFunctions *api;
 393   struct Plugin *plugin;
 394
 395   plugin = GNUNET_malloc (sizeof (struct Plugin));
 396   plugin->env = env;
 397
 398   plugin->dv_handle =
 399       GNUNET_DV_connect (env->cfg, &handle_dv_message_received, plugin);
 400
 401   if (plugin->dv_handle == NULL)
 402   {
 403     GNUNET_free (plugin);
 404     return NULL;
 405   }
 406
 407   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
 408   api->cls = plugin;
 409   api->send = &dv_plugin_send;
 410   api->disconnect = &dv_plugin_disconnect;
 411   api->address_pretty_printer = &dv_plugin_address_pretty_printer;
 412   api->check_address = &dv_plugin_check_address;
 413   api->address_to_string = &address_to_string;
 414   return api;
 415 }
 416
 417
 418 /**
 419  * Exit point from the plugin.
 420  */
 421 void *
 422 libgnunet_plugin_transport_dv_done (void *cls)
 423 {
 424   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 425   struct Plugin *plugin = api->cls;
 426
 427   if (plugin->dv_handle != NULL)
 428     GNUNET_DV_disconnect (plugin->dv_handle);
 429
 430   GNUNET_free (plugin);
 431   GNUNET_free (api);
 432   return NULL;
 433 }
 434
 435 /* end of plugin_transport_template.c */