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   exp_lrm_len = sizeof (struct RecordResultMessage) + name_len + rd_len;
 148   if (lrm_len != exp_lrm_len)
 149   {
 150     GNUNET_break (0);
 151     return GNUNET_SYSERR;
 152   }
 153   if (0 == name_len)
 154   {
 155     GNUNET_break (0);
 156     return GNUNET_SYSERR;
 157   }
 158   name_tmp = (const char *) &lrm[1];
 159   if ((name_tmp[name_len -1] != '\0') || (name_len > MAX_NAME_LEN))
 160   {
 161     GNUNET_break (0);
 162     return GNUNET_SYSERR;
 163   }
 164   rd_ser_tmp = (const char *) &name_tmp[name_len];
 165   {
 166     struct GNUNET_GNSRECORD_Data rd[rd_count];
 167
 168     if (GNUNET_OK !=
 169         GNUNET_GNSRECORD_records_deserialize (rd_len,
 170                                               rd_ser_tmp,
 171                                               rd_count,
 172                                               rd))
 173     {
 174       GNUNET_break (0);
 175       return GNUNET_SYSERR;
 176     }
 177   }
 178   return GNUNET_OK;
 179 }
 180
 181
 182 /**
 183  * We've received a notification about a change to our zone.
 184  * Forward to monitor callback.
 185  *
 186  * @param cls the zone monitor handle
 187  * @param lrm the message from the service.
 188  */
 189 static void
 190 handle_result (void *cls,
 191                const struct RecordResultMessage *lrm)
 192 {
 193   struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 194   size_t name_len;
 195   size_t rd_len;
 196   unsigned rd_count;
 197   const char *name_tmp;
 198   const char *rd_ser_tmp;
 199
 200   rd_len = ntohs (lrm->rd_len);
 201   rd_count = ntohs (lrm->rd_count);
 202   name_len = ntohs (lrm->name_len);
 203   name_tmp = (const char *) &lrm[1];
 204   rd_ser_tmp = (const char *) &name_tmp[name_len];
 205   {
 206     struct GNUNET_GNSRECORD_Data rd[rd_count];
 207
 208     GNUNET_assert (GNUNET_OK ==
 209                    GNUNET_GNSRECORD_records_deserialize (rd_len,
 210                                                          rd_ser_tmp,
 211                                                          rd_count,
 212                                                          rd));
 213     zm->monitor (zm->monitor_cls,
 214                  &lrm->private_key,
 215                  name_tmp,
 216                  rd_count,
 217                  rd);
 218   }
 219 }
 220
 221
 222 /**
 223  * Generic error handler, called with the appropriate error code and
 224  * the same closure specified at the creation of the message queue.
 225  * Not every message queue implementation supports an error handler.
 226  *
 227  * @param cls closure with the `struct GNUNET_NAMESTORE_ZoneMonitor *`
 228  * @param error error code
 229  */
 230 static void
 231 mq_error_handler (void *cls,
 232                   enum GNUNET_MQ_Error error)
 233 {
 234   struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 235
 236   (void) error;
 237   reconnect (zm);
 238 }
 239
 240
 241 /**
 242  * Reconnect to the namestore service.
 243  *
 244  * @param zm monitor to reconnect
 245  */
 246 static void
 247 reconnect (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
 248 {
 249   struct GNUNET_MQ_MessageHandler handlers[] = {
 250     GNUNET_MQ_hd_fixed_size (sync,
 251                              GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_SYNC,
 252                              struct GNUNET_MessageHeader,
 253                              zm),
 254     GNUNET_MQ_hd_var_size (result,
 255                            GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT,
 256                            struct RecordResultMessage,
 257                            zm),
 258     GNUNET_MQ_handler_end ()
 259   };
 260   struct GNUNET_MQ_Envelope *env;
 261   struct ZoneMonitorStartMessage *sm;
 262
 263   if (NULL != zm->mq)
 264   {
 265     GNUNET_MQ_destroy (zm->mq);
 266     zm->error_cb (zm->error_cb_cls);
 267   }
 268   zm->mq = GNUNET_CLIENT_connect (zm->cfg,
 269                                   "namestore",
 270                                   handlers,
 271                                   &mq_error_handler,
 272                                   zm);
 273   if (NULL == zm->mq)
 274     return;
 275   env = GNUNET_MQ_msg (sm,
 276                        GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START);
 277   sm->iterate_first = htonl (zm->iterate_first);
 278   sm->zone = zm->zone;
 279   GNUNET_MQ_send (zm->mq,
 280                   env);
 281 }
 282
 283
 284
 285 /**
 286  * Begin monitoring a zone for changes.  If @a iterate_first is set,
 287  * we Will first call the @a monitor function on all existing records
 288  * in the selected zone(s).  In any case, we will call @a sync and
 289  * afterwards call @a monitor whenever a record changes.
 290  *
 291  * @param cfg configuration to use to connect to namestore
 292  * @param zone zone to monitor
 293  * @param iterate_first #GNUNET_YES to first iterate over all existing records,
 294  *                      #GNUNET_NO to only return changes that happen from now on
 295  * @param error_cb function to call on error (i.e. disconnect); note that
 296  *         unlike the other error callbacks in this API, a call to this
 297  *         function does NOT destroy the monitor handle, it merely signals
 298  *         that monitoring is down. You need to still explicitly call
 299  *         #GNUNET_NAMESTORE_zone_monitor_stop().
 300  * @param error_cb_cls closure for @a error_cb
 301  * @param monitor function to call on zone changes
 302  * @param monitor_cls closure for @a monitor
 303  * @param sync_cb function called when we're in sync with the namestore
 304  * @param cls closure for @a sync_cb
 305  * @return handle to stop monitoring
 306  */
 307 struct GNUNET_NAMESTORE_ZoneMonitor *
 308 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 309                                      const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 310                                      int iterate_first,
 311                                      GNUNET_SCHEDULER_TaskCallback error_cb,
 312                                      void *error_cb_cls,
 313                                      GNUNET_NAMESTORE_RecordMonitor monitor,
 314                                      void *monitor_cls,
 315                                      GNUNET_SCHEDULER_TaskCallback sync_cb,
 316                                      void *sync_cb_cls)
 317 {
 318   struct GNUNET_NAMESTORE_ZoneMonitor *zm;
 319
 320   zm = GNUNET_new (struct GNUNET_NAMESTORE_ZoneMonitor);
 321   if (NULL != zone)
 322     zm->zone = *zone;
 323   zm->iterate_first = iterate_first;
 324   zm->error_cb = error_cb;
 325   zm->error_cb_cls = error_cb_cls;
 326   zm->monitor = monitor;
 327   zm->monitor_cls = monitor_cls;
 328   zm->sync_cb = sync_cb;
 329   zm->sync_cb_cls = sync_cb_cls;
 330   zm->cfg = cfg;
 331   reconnect (zm);
 332   if (NULL == zm->mq)
 333   {
 334     GNUNET_free (zm);
 335     return NULL;
 336   }
 337   return zm;
 338 }
 339
 340
 341 /**
 342  * Calls the monitor processor specified in #GNUNET_NAMESTORE_zone_monitor_start
 343  * for the next record(s).  This function is used to allow clients that merely
 344  * monitor the NAMESTORE to still throttle namestore operations, so we can be
 345  * sure that the monitors can keep up.
 346  *
 347  * Note that #GNUNET_NAMESTORE_records_store() only waits for this
 348  * call if the previous limit set by the client was already reached.
 349  * Thus, by using a @a limit greater than 1, monitors basically enable
 350  * a queue of notifications to be processed asynchronously with some
 351  * delay.  Note that even with a limit of 1 the
 352  * #GNUNET_NAMESTORE_records_store() function will run asynchronously
 353  * and the continuation may be invoked before the monitors completed
 354  * (or even started) processing the notification.  Thus, monitors will
 355  * only closely track the current state of the namestore, but not
 356  * be involved in the transactions.
 357  *
 358  * @param zm the monitor
 359  * @param limit number of records to return to the iterator in one shot
 360  *        (before #GNUNET_NAMESTORE_zone_monitor_next is to be called again)
 361  */
 362 void
 363 GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm,
 364                                     uint64_t limit)
 365 {
 366   struct GNUNET_MQ_Envelope *env;
 367   struct ZoneMonitorNextMessage *nm;
 368
 369   env = GNUNET_MQ_msg (nm,
 370                        GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_NEXT);
 371   nm->limit = GNUNET_htonll (limit);
 372   GNUNET_MQ_send (zm->mq,
 373                   env);
 374 }
 375
 376
 377 /**
 378  * Stop monitoring a zone for changes.
 379  *
 380  * @param zm handle to the monitor activity to stop
 381  */
 382 void
 383 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
 384 {
 385   if (NULL != zm->mq)
 386   {
 387     GNUNET_MQ_destroy (zm->mq);
 388     zm->mq = NULL;
 389   }
 390   GNUNET_free (zm);
 391 }
 392
 393 /* end of namestore_api_monitor.c */