src/namestore/namestore_api_monitor.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2013, 2016, 2018 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file namestore/namestore_api_monitor.c
  22  * @brief API to monitor changes in the NAMESTORE
  23  * @author Christian Grothoff
  24  */
  25
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_crypto_lib.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_dnsparser_lib.h"
  31 #include "gnunet_arm_service.h"
  32 #include "gnunet_signatures.h"
  33 #include "gnunet_namestore_service.h"
  34 #include "namestore.h"
  35
  36
  37 /**
  38  * Handle for a monitoring activity.
  39  */
  40 struct GNUNET_NAMESTORE_ZoneMonitor
  41 {
  42   /**
  43    * Configuration (to reconnect).
  44    */
  45   const struct GNUNET_CONFIGURATION_Handle *cfg;
  46
  47   /**
  48    * Handle to namestore service.
  49    */
  50   struct GNUNET_MQ_Handle *mq;
  51
  52   /**
  53    * Function to call on errors.
  54    */
  55   GNUNET_SCHEDULER_TaskCallback error_cb;
  56
  57   /**
  58    * Closure for @e error_cb.
  59    */
  60   void *error_cb_cls;
  61
  62   /**
  63    * Function to call on events.
  64    */
  65   GNUNET_NAMESTORE_RecordMonitor monitor;
  66
  67   /**
  68    * Closure for @e monitor.
  69    */
  70   void *monitor_cls;
  71
  72   /**
  73    * Function called when we've synchronized.
  74    */
  75   GNUNET_SCHEDULER_TaskCallback sync_cb;
  76
  77   /**
  78    * Closure for @e sync_cb.
  79    */
  80   void *sync_cb_cls;
  81
  82   /**
  83    * Monitored zone.
  84    */
  85   struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
  86
  87   /**
  88    * Do we first iterate over all existing records?
  89    */
  90   int iterate_first;
  91
  92 };
  93
  94
  95 /**
  96  * Reconnect to the namestore service.
  97  *
  98  * @param zm monitor to reconnect
  99  */
 100 static void
 101 reconnect (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
 102
 103
 104 /**
 105  * Handle SYNC message from the namestore service.
 106  *
 107  * @param cls the monitor
 108  * @param msg the sync message
 109  */
 110 static void
 111 handle_sync (void *cls,
 112              const struct GNUNET_MessageHeader *msg)
 113 {
 114   struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 115
 116   (void) cls;
 117   (void) msg;
 118   if (NULL != zm->sync_cb)
 119     zm->sync_cb (zm->sync_cb_cls);
 120 }
 121
 122
 123 /**
 124  * We've received a notification about a change to our zone.
 125  * Check that it is well-formed.
 126  *
 127  * @param cls the zone monitor handle
 128  * @param lrm the message from the service.
 129  */
 130 static int
 131 check_result (void *cls,
 132               const struct RecordResultMessage *lrm)
 133 {
 134   size_t lrm_len;
 135   size_t exp_lrm_len;
 136   size_t name_len;
 137   size_t rd_len;
 138   unsigned rd_count;
 139   const char *name_tmp;
 140   const char *rd_ser_tmp;
 141
 142   (void) cls;
 143   lrm_len = ntohs (lrm->gns_header.header.size);
 144   rd_len = ntohs (lrm->rd_len);
 145   rd_count = ntohs (lrm->rd_count);
 146   name_len = ntohs (lrm->name_len);
 147   if (name_len > MAX_NAME_LEN)
 148   {
 149     GNUNET_break (0);
 150     return GNUNET_SYSERR;
 151   }
 152   exp_lrm_len = sizeof (struct RecordResultMessage) + name_len + rd_len;
 153   if (lrm_len != exp_lrm_len)
 154   {
 155     GNUNET_break (0);
 156     return GNUNET_SYSERR;
 157   }
 158   if (0 == name_len)
 159   {
 160     GNUNET_break (0);
 161     return GNUNET_SYSERR;
 162   }
 163   name_tmp = (const char *) &lrm[1];
 164   if (name_tmp[name_len -1] != '\0')
 165   {
 166     GNUNET_break (0);
 167     return GNUNET_SYSERR;
 168   }
 169   rd_ser_tmp = (const char *) &name_tmp[name_len];
 170   {
 171     struct GNUNET_GNSRECORD_Data rd[rd_count];
 172
 173     if (GNUNET_OK !=
 174         GNUNET_GNSRECORD_records_deserialize (rd_len,
 175                                               rd_ser_tmp,
 176                                               rd_count,
 177                                               rd))
 178     {
 179       GNUNET_break (0);
 180       return GNUNET_SYSERR;
 181     }
 182   }
 183   return GNUNET_OK;
 184 }
 185
 186
 187 /**
 188  * We've received a notification about a change to our zone.
 189  * Forward to monitor callback.
 190  *
 191  * @param cls the zone monitor handle
 192  * @param lrm the message from the service.
 193  */
 194 static void
 195 handle_result (void *cls,
 196                const struct RecordResultMessage *lrm)
 197 {
 198   struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 199   size_t name_len;
 200   size_t rd_len;
 201   unsigned rd_count;
 202   const char *name_tmp;
 203   const char *rd_ser_tmp;
 204
 205   rd_len = ntohs (lrm->rd_len);
 206   rd_count = ntohs (lrm->rd_count);
 207   name_len = ntohs (lrm->name_len);
 208   name_tmp = (const char *) &lrm[1];
 209   rd_ser_tmp = (const char *) &name_tmp[name_len];
 210   {
 211     struct GNUNET_GNSRECORD_Data rd[rd_count];
 212
 213     GNUNET_assert (GNUNET_OK ==
 214                    GNUNET_GNSRECORD_records_deserialize (rd_len,
 215                                                          rd_ser_tmp,
 216                                                          rd_count,
 217                                                          rd));
 218     zm->monitor (zm->monitor_cls,
 219                  &lrm->private_key,
 220                  name_tmp,
 221                  rd_count,
 222                  rd);
 223   }
 224 }
 225
 226
 227 /**
 228  * Generic error handler, called with the appropriate error code and
 229  * the same closure specified at the creation of the message queue.
 230  * Not every message queue implementation supports an error handler.
 231  *
 232  * @param cls closure with the `struct GNUNET_NAMESTORE_ZoneMonitor *`
 233  * @param error error code
 234  */
 235 static void
 236 mq_error_handler (void *cls,
 237                   enum GNUNET_MQ_Error error)
 238 {
 239   struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 240
 241   (void) error;
 242   reconnect (zm);
 243 }
 244
 245
 246 /**
 247  * Reconnect to the namestore service.
 248  *
 249  * @param zm monitor to reconnect
 250  */
 251 static void
 252 reconnect (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
 253 {
 254   struct GNUNET_MQ_MessageHandler handlers[] = {
 255     GNUNET_MQ_hd_fixed_size (sync,
 256                              GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_SYNC,
 257                              struct GNUNET_MessageHeader,
 258                              zm),
 259     GNUNET_MQ_hd_var_size (result,
 260                            GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT,
 261                            struct RecordResultMessage,
 262                            zm),
 263     GNUNET_MQ_handler_end ()
 264   };
 265   struct GNUNET_MQ_Envelope *env;
 266   struct ZoneMonitorStartMessage *sm;
 267
 268   if (NULL != zm->mq)
 269   {
 270     GNUNET_MQ_destroy (zm->mq);
 271     zm->error_cb (zm->error_cb_cls);
 272   }
 273   zm->mq = GNUNET_CLIENT_connect (zm->cfg,
 274                                   "namestore",
 275                                   handlers,
 276                                   &mq_error_handler,
 277                                   zm);
 278   if (NULL == zm->mq)
 279     return;
 280   env = GNUNET_MQ_msg (sm,
 281                        GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START);
 282   sm->iterate_first = htonl (zm->iterate_first);
 283   sm->zone = zm->zone;
 284   GNUNET_MQ_send (zm->mq,
 285                   env);
 286 }
 287
 288
 289
 290 /**
 291  * Begin monitoring a zone for changes.  If @a iterate_first is set,
 292  * we Will first call the @a monitor function on all existing records
 293  * in the selected zone(s).  In any case, we will call @a sync and
 294  * afterwards call @a monitor whenever a record changes.
 295  *
 296  * @param cfg configuration to use to connect to namestore
 297  * @param zone zone to monitor
 298  * @param iterate_first #GNUNET_YES to first iterate over all existing records,
 299  *                      #GNUNET_NO to only return changes that happen from now on
 300  * @param error_cb function to call on error (i.e. disconnect); note that
 301  *         unlike the other error callbacks in this API, a call to this
 302  *         function does NOT destroy the monitor handle, it merely signals
 303  *         that monitoring is down. You need to still explicitly call
 304  *         #GNUNET_NAMESTORE_zone_monitor_stop().
 305  * @param error_cb_cls closure for @a error_cb
 306  * @param monitor function to call on zone changes
 307  * @param monitor_cls closure for @a monitor
 308  * @param sync_cb function called when we're in sync with the namestore
 309  * @param cls closure for @a sync_cb
 310  * @return handle to stop monitoring
 311  */
 312 struct GNUNET_NAMESTORE_ZoneMonitor *
 313 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 314                                      const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 315                                      int iterate_first,
 316                                      GNUNET_SCHEDULER_TaskCallback error_cb,
 317                                      void *error_cb_cls,
 318                                      GNUNET_NAMESTORE_RecordMonitor monitor,
 319                                      void *monitor_cls,
 320                                      GNUNET_SCHEDULER_TaskCallback sync_cb,
 321                                      void *sync_cb_cls)
 322 {
 323   struct GNUNET_NAMESTORE_ZoneMonitor *zm;
 324
 325   zm = GNUNET_new (struct GNUNET_NAMESTORE_ZoneMonitor);
 326   if (NULL != zone)
 327     zm->zone = *zone;
 328   zm->iterate_first = iterate_first;
 329   zm->error_cb = error_cb;
 330   zm->error_cb_cls = error_cb_cls;
 331   zm->monitor = monitor;
 332   zm->monitor_cls = monitor_cls;
 333   zm->sync_cb = sync_cb;
 334   zm->sync_cb_cls = sync_cb_cls;
 335   zm->cfg = cfg;
 336   reconnect (zm);
 337   if (NULL == zm->mq)
 338   {
 339     GNUNET_free (zm);
 340     return NULL;
 341   }
 342   return zm;
 343 }
 344
 345
 346 /**
 347  * Calls the monitor processor specified in #GNUNET_NAMESTORE_zone_monitor_start
 348  * for the next record(s).  This function is used to allow clients that merely
 349  * monitor the NAMESTORE to still throttle namestore operations, so we can be
 350  * sure that the monitors can keep up.
 351  *
 352  * Note that #GNUNET_NAMESTORE_records_store() only waits for this
 353  * call if the previous limit set by the client was already reached.
 354  * Thus, by using a @a limit greater than 1, monitors basically enable
 355  * a queue of notifications to be processed asynchronously with some
 356  * delay.  Note that even with a limit of 1 the
 357  * #GNUNET_NAMESTORE_records_store() function will run asynchronously
 358  * and the continuation may be invoked before the monitors completed
 359  * (or even started) processing the notification.  Thus, monitors will
 360  * only closely track the current state of the namestore, but not
 361  * be involved in the transactions.
 362  *
 363  * @param zm the monitor
 364  * @param limit number of records to return to the iterator in one shot
 365  *        (before #GNUNET_NAMESTORE_zone_monitor_next is to be called again)
 366  */
 367 void
 368 GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm,
 369                                     uint64_t limit)
 370 {
 371   struct GNUNET_MQ_Envelope *env;
 372   struct ZoneMonitorNextMessage *nm;
 373
 374   env = GNUNET_MQ_msg (nm,
 375                        GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_NEXT);
 376   nm->limit = GNUNET_htonll (limit);
 377   GNUNET_MQ_send (zm->mq,
 378                   env);
 379 }
 380
 381
 382 /**
 383  * Stop monitoring a zone for changes.
 384  *
 385  * @param zm handle to the monitor activity to stop
 386  */
 387 void
 388 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
 389 {
 390   if (NULL != zm->mq)
 391   {
 392     GNUNET_MQ_destroy (zm->mq);
 393     zm->mq = NULL;
 394   }
 395   GNUNET_free (zm);
 396 }
 397
 398 /* end of namestore_api_monitor.c */