src/transport/gnunet-service-transport_hello.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_hello.c
  23  * @brief hello management implementation
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_constants.h"
  28 #include "gnunet_hello_lib.h"
  29 #include "gnunet_peerinfo_service.h"
  30 #include "gnunet_statistics_service.h"
  31 #include "gnunet-service-transport_hello.h"
  32 #include "gnunet-service-transport.h"
  33 #include "gnunet-service-transport_plugins.h"
  34
  35
  36 /**
  37  * How often do we refresh our HELLO (due to expiration concerns)?
  38  */
  39 #define HELLO_REFRESH_PERIOD GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
  40
  41
  42 /**
  43  * Entry in linked list of network addresses for ourselves.  Also
  44  * includes a cached signature for 'struct TransportPongMessage's.
  45  */
  46 struct OwnAddressList
  47 {
  48   /**
  49    * This is a doubly-linked list.
  50    */
  51   struct OwnAddressList *next;
  52
  53   /**
  54    * This is a doubly-linked list.
  55    */
  56   struct OwnAddressList *prev;
  57
  58   /**
  59    * Name of the plugin.
  60    */
  61   char *plugin_name;
  62
  63   /**
  64    * How long until the current signature expires? (ZERO if the
  65    * signature was never created).
  66    */
  67   struct GNUNET_TIME_Absolute pong_sig_expires;
  68
  69   /**
  70    * Signature for a 'struct TransportPongMessage' for this address.
  71    */
  72   struct GNUNET_CRYPTO_RsaSignature pong_signature;
  73
  74   /**
  75    * Length of addr.
  76    */
  77   size_t addrlen;
  78
  79 };
  80
  81
  82 /**
  83  * Our HELLO message.
  84  */
  85 static struct GNUNET_HELLO_Message *our_hello;
  86
  87 /**
  88  * Function to call on HELLO changes.
  89  */
  90 static GST_HelloCallback hello_cb;
  91
  92 /**
  93  * Closure for 'hello_cb'.
  94  */
  95 static void *hello_cb_cls;
  96
  97 /**
  98  * Head of my addresses.
  99  */
 100 struct OwnAddressList *oal_head;
 101
 102 /**
 103  * Tail of my addresses.
 104  */
 105 struct OwnAddressList *oal_tail;
 106
 107 /**
 108  * Identifier of 'refresh_hello' task.
 109  */
 110 static GNUNET_SCHEDULER_TaskIdentifier hello_task;
 111
 112
 113 /**
 114  * Closure for 'address_generator'.
 115  */
 116 struct GeneratorContext
 117 {
 118   /**
 119    * Where are we in the DLL?
 120    */
 121   struct OwnAddressList *addr_pos;
 122
 123   /**
 124    * When do addresses expire?
 125    */
 126   struct GNUNET_TIME_Absolute expiration;
 127 };
 128
 129
 130 /**
 131  * Add an address from the 'OwnAddressList' to the buffer.
 132  *
 133  * @param cls the 'struct GeneratorContext'
 134  * @param max maximum number of bytes left
 135  * @param buf where to write the address
 136  */
 137 static size_t
 138 address_generator (void *cls, size_t max, void *buf)
 139 {
 140   struct GeneratorContext *gc = cls;
 141   size_t ret;
 142
 143   if (NULL == gc->addr_pos)
 144     return 0;
 145   ret =
 146       GNUNET_HELLO_add_address (gc->addr_pos->plugin_name, gc->expiration,
 147                                 &gc->addr_pos[1], gc->addr_pos->addrlen, buf,
 148                                 max);
 149   gc->addr_pos = gc->addr_pos->next;
 150   return ret;
 151 }
 152
 153
 154 /**
 155  * Construct our HELLO message from all of the addresses of
 156  * all of the transports.
 157  *
 158  * @param cls unused
 159  * @param tc scheduler context
 160  */
 161 static void
 162 refresh_hello_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 163 {
 164   struct GeneratorContext gc;
 165
 166   hello_task = GNUNET_SCHEDULER_NO_TASK;
 167   gc.addr_pos = oal_head;
 168   gc.expiration =
 169       GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION);
 170   GNUNET_free (our_hello);
 171   our_hello = GNUNET_HELLO_create (&GST_my_public_key, &address_generator, &gc);
 172 #if DEBUG_TRANSPORT
 173   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 174               "Refreshed my `%s', new size is %d\n", "HELLO",
 175               GNUNET_HELLO_size (our_hello));
 176 #endif
 177   GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# refreshed my HELLO"), 1,
 178                             GNUNET_NO);
 179   if (NULL != hello_cb)
 180     hello_cb (hello_cb_cls, GST_hello_get ());
 181   GNUNET_PEERINFO_add_peer (GST_peerinfo, our_hello);
 182   hello_task =
 183       GNUNET_SCHEDULER_add_delayed (HELLO_REFRESH_PERIOD, &refresh_hello_task,
 184                                     NULL);
 185
 186 }
 187
 188
 189 /**
 190  * Schedule task to refresh hello (unless such a
 191  * task exists already).
 192  */
 193 static void
 194 refresh_hello ()
 195 {
 196   if (hello_task != GNUNET_SCHEDULER_NO_TASK)
 197     GNUNET_SCHEDULER_cancel (hello_task);
 198   hello_task = GNUNET_SCHEDULER_add_now (&refresh_hello_task, NULL);
 199 }
 200
 201
 202 /**
 203  * Initialize the HELLO module.
 204  *
 205  * @param cb function to call whenever our HELLO changes
 206  * @param cb_cls closure for cb
 207  */
 208 void
 209 GST_hello_start (GST_HelloCallback cb, void *cb_cls)
 210 {
 211   hello_cb = cb;
 212   hello_cb_cls = cb_cls;
 213   our_hello = GNUNET_HELLO_create (&GST_my_public_key, NULL, NULL);
 214   refresh_hello ();
 215 }
 216
 217
 218 /**
 219  * Shutdown the HELLO module.
 220  */
 221 void
 222 GST_hello_stop ()
 223 {
 224   hello_cb = NULL;
 225   hello_cb_cls = NULL;
 226   if (GNUNET_SCHEDULER_NO_TASK != hello_task)
 227   {
 228     GNUNET_SCHEDULER_cancel (hello_task);
 229     hello_task = GNUNET_SCHEDULER_NO_TASK;
 230   }
 231   if (NULL != our_hello)
 232   {
 233     GNUNET_free (our_hello);
 234     our_hello = NULL;
 235   }
 236 }
 237
 238
 239 /**
 240  * Obtain this peers HELLO message.
 241  *
 242  * @return our HELLO message
 243  */
 244 const struct GNUNET_MessageHeader *
 245 GST_hello_get ()
 246 {
 247   return (struct GNUNET_MessageHeader *) our_hello;
 248 }
 249
 250
 251 /**
 252  * Add or remove an address from this peer's HELLO message.
 253  *
 254  * @param addremove GNUNET_YES to add, GNUNET_NO to remove
 255  * @param plugin_name name of the plugin for which this is an address
 256  * @param plugin_address address in a plugin-specific format
 257  * @param plugin_address_len number of bytes in plugin_address
 258  */
 259 void
 260 GST_hello_modify_addresses (int addremove, const char *plugin_name,
 261                             const void *plugin_address,
 262                             size_t plugin_address_len)
 263 {
 264   struct OwnAddressList *al;
 265
 266 #if DEBUG_TRANSPORT
 267   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 268               (add_remove ==
 269                GNUNET_YES) ? "Adding `%s':%s to the set of our addresses\n" :
 270               "Removing `%s':%s from the set of our addresses\n",
 271               GST_plugins_a2s (plugin_name, addr, addrlen), p->short_name);
 272 #endif
 273   GNUNET_assert (plugin_address != NULL);
 274   if (GNUNET_NO == addremove)
 275   {
 276     for (al = oal_head; al != NULL; al = al->next)
 277       if ((plugin_address_len == al->addrlen) &&
 278           (0 == strcmp (al->plugin_name, plugin_name)) &&
 279           (0 == memcmp (plugin_address, &al[1], plugin_address_len)))
 280       {
 281         GNUNET_CONTAINER_DLL_remove (oal_head, oal_tail, al);
 282         GNUNET_free (al->plugin_name);
 283         GNUNET_free (al);
 284         refresh_hello ();
 285         return;
 286       }
 287     /* address to be removed not found!? */
 288     GNUNET_break (0);
 289     return;
 290   }
 291   al = GNUNET_malloc (sizeof (struct OwnAddressList) + plugin_address_len);
 292   GNUNET_CONTAINER_DLL_insert (oal_head, oal_tail, al);
 293   al->plugin_name = GNUNET_strdup (plugin_name);
 294   al->addrlen = plugin_address_len;
 295   memcpy (&al[1], plugin_address, plugin_address_len);
 296   refresh_hello ();
 297 }
 298
 299
 300 /**
 301  * Test if a particular address is one of ours.
 302  *
 303  * @param plugin_name name of the plugin for which this is an address
 304  * @param plugin_address address in a plugin-specific format
 305  * @param plugin_address_len number of bytes in plugin_address
 306  * @param sig location where to cache PONG signatures for this address [set]
 307  * @param sig_expiration how long until the current 'sig' expires?
 308  *            (ZERO if sig was never created) [set]
 309  * @return GNUNET_YES if this is one of our addresses,
 310  *         GNUNET_NO if not
 311  */
 312 int
 313 GST_hello_test_address (const char *plugin_name, const void *plugin_address,
 314                         size_t plugin_address_len,
 315                         struct GNUNET_CRYPTO_RsaSignature **sig,
 316                         struct GNUNET_TIME_Absolute **sig_expiration)
 317 {
 318   struct OwnAddressList *al;
 319
 320   for (al = oal_head; al != NULL; al = al->next)
 321     if ((plugin_address_len == al->addrlen) &&
 322         (0 == strcmp (al->plugin_name, plugin_name)) &&
 323         (0 == memcmp (plugin_address, &al[1], plugin_address_len)))
 324     {
 325       *sig = &al->pong_signature;
 326       *sig_expiration = &al->pong_sig_expires;
 327       return GNUNET_YES;
 328     }
 329   *sig = NULL;
 330   *sig_expiration = NULL;
 331   return GNUNET_NO;
 332 }
 333
 334
 335 /* end of file gnunet-service-transport_hello.c */