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_NO
  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 handle_dv_message_received (void *cls,
 148                                  struct GNUNET_PeerIdentity *sender,
 149                                  char *msg,
 150                                  size_t msg_len,
 151                                  uint32_t distance,
 152                                  char *sender_address,
 153                                  size_t sender_address_len)
 154 {
 155   struct Plugin *plugin = cls;
 156 #if DEBUG_DV_MESSAGES
 157   char *my_id;
 158   my_id = GNUNET_strdup(GNUNET_i2s(plugin->env->my_identity));
 159   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 160                    "plugin_transport_dv",
 161                    _("%s Received message from %s of type %d, distance %u!\n"),
 162                    my_id, GNUNET_i2s(sender), ntohs(((struct GNUNET_MessageHeader *)msg)->type), distance);
 163   GNUNET_free_non_null(my_id);
 164 #endif
 165   struct GNUNET_TRANSPORT_ATS_Information ats[2];
 166   ats[0].type = htonl (GNUNET_TRANSPORT_ATS_QUALITY_NET_DISTANCE);
 167   ats[0].value = htonl (distance);
 168   ats[1].type = htonl (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR);
 169   ats[1].value = htonl (0);
 170
 171   plugin->env->receive(plugin->env->cls,
 172                        sender,
 173                        (struct GNUNET_MessageHeader *)msg,
 174                        (const struct GNUNET_TRANSPORT_ATS_Information *) &ats,
 175                        2,
 176                        NULL,
 177                        sender_address,
 178                        sender_address_len);
 179
 180 }
 181
 182
 183 /* Question: how does the transport service learn of a newly connected (gossipped about)
 184  * DV peer?  Should the plugin (here) create a HELLO for that peer and send it along,
 185  * or should the DV service create a HELLO and send it to us via the other part?
 186  */
 187
 188 /**
 189  * Function that can be used by the transport service to transmit
 190  * a message using the plugin.
 191  *
 192  * @param cls closure
 193  * @param target who should receive this message
 194  * @param priority how important is the message
 195  * @param msgbuf the message to transmit
 196  * @param msgbuf_size number of bytes in 'msgbuf'
 197  * @param timeout when should we time out
 198  * @param session the session used
 199  * @param addr the address to use (can be NULL if the plugin
 200  *                is "on its own" (i.e. re-use existing TCP connection))
 201  * @param addrlen length of the address in bytes
 202  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 203  *                otherwise the plugin may use other addresses or
 204  *                existing connections (if available)
 205  * @param cont continuation to call once the message has
 206  *        been transmitted (or if the transport is ready
 207  *        for the next transmission call; or if the
 208  *        peer disconnected...)
 209  * @param cont_cls closure for cont
 210  * @return number of bytes used (on the physical network, with overheads);
 211  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 212  *         and does NOT mean that the message was not transmitted (DV)
 213  */
 214 static ssize_t
 215 dv_plugin_send (void *cls,
 216                 const struct GNUNET_PeerIdentity *target,
 217                 const char *msgbuf,
 218                 size_t msgbuf_size,
 219                 unsigned int priority,
 220                 struct GNUNET_TIME_Relative timeout,
 221                 struct Session *session,
 222                 const void *addr,
 223                 size_t addrlen,
 224                 int force_address,
 225                 GNUNET_TRANSPORT_TransmitContinuation
 226                 cont, void *cont_cls)
 227 {
 228   int ret = 0;
 229   struct Plugin *plugin = cls;
 230
 231   ret = GNUNET_DV_send(plugin->dv_handle,
 232                        target,
 233                        msgbuf,
 234                        msgbuf_size,
 235                        priority,
 236                        timeout,
 237                        addr,
 238                        addrlen,
 239                        cont,
 240                        cont_cls);
 241   return ret;
 242 }
 243
 244
 245
 246 /**
 247  * Function that can be used to force the plugin to disconnect
 248  * from the given peer and cancel all previous transmissions
 249  * (and their continuations).
 250  *
 251  * @param cls closure
 252  * @param target peer from which to disconnect
 253  */
 254 static void
 255 dv_plugin_disconnect (void *cls,
 256                       const struct GNUNET_PeerIdentity *target)
 257 {
 258   // struct Plugin *plugin = cls;
 259   // TODO: Add message type to send to dv service to "disconnect" a peer
 260 }
 261
 262
 263 /**
 264  * Convert the transports address to a nice, human-readable
 265  * format.
 266  *
 267  * @param cls closure
 268  * @param type name of the transport that generated the address
 269  * @param addr one of the addresses of the host, NULL for the last address
 270  *        the specific address format depends on the transport
 271  * @param addrlen length of the address
 272  * @param numeric should (IP) addresses be displayed in numeric form?
 273  * @param timeout after how long should we give up?
 274  * @param asc function to call on each string
 275  * @param asc_cls closure for asc
 276  */
 277 static void
 278 dv_plugin_address_pretty_printer (void *cls,
 279                                   const char *type,
 280                                   const void *addr,
 281                                   size_t addrlen,
 282                                   int numeric,
 283                                   struct GNUNET_TIME_Relative timeout,
 284                                   GNUNET_TRANSPORT_AddressStringCallback
 285                                   asc, void *asc_cls)
 286 {
 287   char *dest_peer;
 288   char *via_peer;
 289   char *print_string;
 290   char *addr_buf = (char *)addr;
 291
 292   if (addrlen != sizeof(struct GNUNET_PeerIdentity) * 2)
 293     {
 294       asc (asc_cls, NULL);
 295     }
 296   else
 297     {
 298       dest_peer = GNUNET_strdup(GNUNET_i2s((struct GNUNET_PeerIdentity *)addr));
 299       via_peer = GNUNET_strdup(GNUNET_i2s((struct GNUNET_PeerIdentity *)&addr_buf[sizeof(struct GNUNET_PeerIdentity)]));
 300       GNUNET_asprintf(&print_string, "DV Peer `%s' via peer`%s'", dest_peer, via_peer);
 301       asc (asc_cls, print_string);
 302       asc (asc_cls, NULL);
 303       GNUNET_free(via_peer);
 304       GNUNET_free(dest_peer);
 305       GNUNET_free(print_string);
 306     }
 307 }
 308
 309 /**
 310  * Convert the DV address to a pretty string.
 311  *
 312  * @param cls closure
 313  * @param addr the (hopefully) DV address
 314  * @param addrlen the length of the address
 315  *
 316  * @return string representing the DV address
 317  */
 318 static const char *address_to_string (void *cls,
 319                                        const void *addr,
 320                                        size_t addrlen)
 321 {
 322   static char return_buffer[2 * 4 + 2]; // Two four character peer identity prefixes a ':' and '\0'
 323
 324   struct GNUNET_CRYPTO_HashAsciiEncoded peer_hash;
 325   struct GNUNET_CRYPTO_HashAsciiEncoded via_hash;
 326   struct GNUNET_PeerIdentity *peer;
 327   struct GNUNET_PeerIdentity *via;
 328   char *addr_buf = (char *)addr;
 329
 330   if (addrlen == (2 * sizeof(struct GNUNET_PeerIdentity)))
 331     {
 332       peer = (struct GNUNET_PeerIdentity *)addr_buf;
 333       via = (struct GNUNET_PeerIdentity *)&addr_buf[sizeof(struct GNUNET_PeerIdentity)];
 334
 335       GNUNET_CRYPTO_hash_to_enc (&peer->hashPubKey, &peer_hash);
 336       peer_hash.encoding[4] = '\0';
 337       GNUNET_CRYPTO_hash_to_enc (&via->hashPubKey, &via_hash);
 338       via_hash.encoding[4] = '\0';
 339       GNUNET_snprintf (return_buffer,
 340                        sizeof (return_buffer),
 341                        "%s:%s",
 342                        &peer_hash,
 343                        &via_hash);
 344     }
 345   else
 346     return NULL;
 347
 348   return return_buffer;
 349 }
 350
 351 /**
 352  * Another peer has suggested an address for this peer and transport
 353  * plugin.  Check that this could be a valid address.  This function
 354  * is not expected to 'validate' the address in the sense of trying to
 355  * connect to it but simply to see if the binary format is technically
 356  * legal for establishing a connection to this peer (and make sure that
 357  * the address really corresponds to our network connection/settings
 358  * and not some potential man-in-the-middle).
 359  *
 360  * @param cls closure
 361  * @param addr pointer to the address
 362  * @param addrlen length of addr
 363  * @return GNUNET_OK if this is a plausible address for this peer
 364  *         and transport, GNUNET_SYSERR if not
 365  *
 366  */
 367 static int
 368 dv_plugin_check_address (void *cls,
 369                          const void *addr, size_t addrlen)
 370 {
 371   struct Plugin *plugin = cls;
 372   /* Verify that the first peer of this address matches our peer id! */
 373   if ((addrlen != (2 * sizeof(struct GNUNET_PeerIdentity))) || (0 != memcmp(addr, plugin->env->my_identity, sizeof(struct GNUNET_PeerIdentity))))
 374   {
 375     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "%s: Address not correct size or identity doesn't match ours!\n", GNUNET_i2s(plugin->env->my_identity));
 376     if (addrlen == (2 * sizeof(struct GNUNET_PeerIdentity)))
 377     {
 378       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Peer in address is %s\n", GNUNET_i2s(addr));
 379     }
 380     return GNUNET_SYSERR;
 381   }
 382   return GNUNET_OK;
 383 }
 384
 385
 386 /**
 387  * Entry point for the plugin.
 388  */
 389 void *
 390 libgnunet_plugin_transport_dv_init (void *cls)
 391 {
 392   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 393   struct GNUNET_TRANSPORT_PluginFunctions *api;
 394   struct Plugin *plugin;
 395
 396   plugin = GNUNET_malloc (sizeof (struct Plugin));
 397   plugin->env = env;
 398
 399   plugin->dv_handle = 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 */