src/include/gnunet_namestore_service.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2012, 2013 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 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * API that can be used to store naming information on a GNUnet node;
  26  *
  27  * @defgroup namestore  Name Store service
  28  * Store naming information on a GNUnet node.
  29  *
  30  * Naming information can either be records for which this peer/user is
  31  * authoritative, or blocks which are cached, encrypted naming data from other
  32  * peers.
  33  *
  34  * @see [Documentation](https://gnunet.org/namestore-subsystem)
  35  *
  36  * @{
  37  */
  38 #ifndef GNUNET_NAMESTORE_SERVICE_H
  39 #define GNUNET_NAMESTORE_SERVICE_H
  40
  41 #include "gnunet_util_lib.h"
  42 #include "gnunet_block_lib.h"
  43 #include "gnunet_gnsrecord_lib.h"
  44
  45 #ifdef __cplusplus
  46 extern "C"
  47 {
  48 #if 0                           /* keep Emacsens' auto-indent happy */
  49 }
  50 #endif
  51 #endif
  52
  53
  54 /**
  55  * Entry in the queue.
  56  */
  57 struct GNUNET_NAMESTORE_QueueEntry;
  58
  59 /**
  60  * Handle to the namestore service.
  61  */
  62 struct GNUNET_NAMESTORE_Handle;
  63
  64 /**
  65  * Handle to the namestore zone iterator.
  66  */
  67 struct GNUNET_NAMESTORE_ZoneIterator;
  68
  69
  70 /**
  71  * Connect to the namestore service.
  72  *
  73  * @param cfg configuration to use
  74  * @return handle to use to access the service
  75  */
  76 struct GNUNET_NAMESTORE_Handle *
  77 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  78
  79
  80 /**
  81  * Disconnect from the namestore service (and free associated
  82  * resources).  Must not be called from within operation callbacks of
  83  * the API.
  84  *
  85  * @param h handle to the namestore
  86  */
  87 void
  88 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
  89
  90
  91 /**
  92  * Continuation called to notify client about result of the
  93  * operation.
  94  *
  95  * @param cls closure
  96  * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
  97  *                #GNUNET_NO if content was already there or not found
  98  *                #GNUNET_YES (or other positive value) on success
  99  * @param emsg NULL on success, otherwise an error message
 100  */
 101 typedef void
 102 (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
 103                                             int32_t success,
 104                                             const char *emsg);
 105
 106
 107 /**
 108  * Store an item in the namestore.  If the item is already present,
 109  * it is replaced with the new record.  Use an empty array to
 110  * remove all records under the given name.
 111  *
 112  * @param h handle to the namestore
 113  * @param pkey private key of the zone
 114  * @param label name that is being mapped
 115  * @param rd_count number of records in the 'rd' array
 116  * @param rd array of records with data to store
 117  * @param cont continuation to call when done
 118  * @param cont_cls closure for @a cont
 119  * @return handle to abort the request
 120  */
 121 struct GNUNET_NAMESTORE_QueueEntry *
 122 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
 123                                 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
 124                                 const char *label,
 125                                 unsigned int rd_count,
 126                                 const struct GNUNET_GNSRECORD_Data *rd,
 127                                 GNUNET_NAMESTORE_ContinuationWithStatus cont,
 128                                 void *cont_cls);
 129
 130
 131
 132 /**
 133  * Process a record that was stored in the namestore.
 134  *
 135  * @param cls closure
 136  * @param zone private key of the zone
 137  * @param label label of the records
 138  * @param rd_count number of entries in @a rd array, 0 if label was deleted
 139  * @param rd array of records with data to store
 140  */
 141 typedef void
 142 (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
 143                                    const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 144                                    const char *label,
 145                                    unsigned int rd_count,
 146                                    const struct GNUNET_GNSRECORD_Data *rd);
 147
 148
 149 /**
 150  * Set the desired nick name for a zone
 151  *
 152  * @param h handle to the namestore
 153  * @param pkey private key of the zone
 154  * @param nick the nick name to set
 155  * @param cont continuation to call when done
 156  * @param cont_cls closure for 'cont'
 157  * @return handle to abort the request
 158  */
 159 struct GNUNET_NAMESTORE_QueueEntry *
 160 GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h,
 161                            const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
 162                            const char *nick,
 163                            GNUNET_NAMESTORE_ContinuationWithStatus cont,
 164                            void *cont_cls);
 165
 166
 167 /**
 168  * Lookup an item in the namestore.
 169  *
 170  * @param h handle to the namestore
 171  * @param pkey private key of the zone
 172  * @param label name that is being mapped
 173  * @param error_cb function to call on error (i.e. disconnect)
 174  *        the handle is afterwards invalid
 175  * @param error_cb_cls closure for @a error_cb
 176  * @param rm function to call with the result (with 0 records if we don't have that label);
 177  *        the handle is afterwards invalid
 178  * @param rm_cls closure for @a rm
 179  * @return handle to abort the request
 180  */
 181 struct GNUNET_NAMESTORE_QueueEntry *
 182 GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
 183                                  const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
 184                                  const char *label,
 185                                  GNUNET_SCHEDULER_TaskCallback error_cb,
 186                                  void *error_cb_cls,
 187                                  GNUNET_NAMESTORE_RecordMonitor rm,
 188                                  void *rm_cls);
 189
 190
 191 /**
 192  * Look for an existing PKEY delegation record for a given public key.
 193  * Returns at most one result to the processor.
 194  *
 195  * @param h handle to the namestore
 196  * @param zone public key of the zone to look up in, never NULL
 197  * @param value_zone public key of the target zone (value), never NULL
 198  * @param error_cb function to call on error (i.e. disconnect)
 199  *        the handle is afterwards invalid
 200  * @param error_cb_cls closure for @a error_cb
 201  * @param proc function to call on the matching records, or with
 202  *        NULL (rd_count == 0) if there are no matching records;
 203  *        the handle is afterwards invalid
 204  * @param proc_cls closure for @a proc
 205  * @return a handle that can be used to
 206  *         cancel
 207  */
 208 struct GNUNET_NAMESTORE_QueueEntry *
 209 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
 210                                const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 211                                const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
 212                                GNUNET_SCHEDULER_TaskCallback error_cb,
 213                                void *error_cb_cls,
 214                                GNUNET_NAMESTORE_RecordMonitor proc,
 215                                void *proc_cls);
 216
 217
 218 /**
 219  * Cancel a namestore operation.  The final callback from the
 220  * operation must not have been done yet.  Must be called on any
 221  * namestore operation that has not yet completed prior to calling
 222  * #GNUNET_NAMESTORE_disconnect.
 223  *
 224  * @param qe operation to cancel
 225  */
 226 void
 227 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
 228
 229
 230 /**
 231  * Starts a new zone iteration (used to periodically PUT all of our
 232  * records into our DHT). This MUST lock the `struct GNUNET_NAMESTORE_Handle`
 233  * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next() and
 234  * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once
 235  * immediately, and then again after
 236  * #GNUNET_NAMESTORE_zone_iterator_next() is invoked.
 237  *
 238  * On error (disconnect), @a error_cb will be invoked.
 239  * On normal completion, @a finish_cb proc will be
 240  * invoked.
 241  *
 242  * @param h handle to the namestore
 243  * @param zone zone to access, NULL for all zones
 244  * @param error_cb function to call on error (i.e. disconnect),
 245  *        the handle is afterwards invalid
 246  * @param error_cb_cls closure for @a error_cb
 247  * @param proc function to call on each name from the zone; it
 248  *        will be called repeatedly with a value (if available)
 249  * @param proc_cls closure for @a proc
 250  * @param finish_cb function to call on completion
 251  *        the handle is afterwards invalid
 252  * @param finish_cb_cls closure for @a finish_cb
 253  * @return an iterator handle to use for iteration
 254  */
 255 struct GNUNET_NAMESTORE_ZoneIterator *
 256 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
 257                                        const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 258                                        GNUNET_SCHEDULER_TaskCallback error_cb,
 259                                        void *error_cb_cls,
 260                                        GNUNET_NAMESTORE_RecordMonitor proc,
 261                                        void *proc_cls,
 262                                        GNUNET_SCHEDULER_TaskCallback finish_cb,
 263                                        void *finish_cb_cls);
 264
 265
 266 /**
 267  * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
 268  * for the next record.
 269  *
 270  * @param it the iterator
 271  */
 272 void
 273 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
 274
 275
 276 /**
 277  * Stops iteration and releases the namestore handle for further calls.  Must
 278  * be called on any iteration that has not yet completed prior to calling
 279  * #GNUNET_NAMESTORE_disconnect.
 280  *
 281  * @param it the iterator
 282  */
 283 void
 284 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
 285
 286
 287 /**
 288  * Handle for a monitoring activity.
 289  */
 290 struct GNUNET_NAMESTORE_ZoneMonitor;
 291
 292
 293 /**
 294  * Begin monitoring a zone for changes.  Will first call the @a
 295  * monitor function on all existing records in the selected zone(s) if
 296  * @a iterate_first is #GNUNET_YES.  In any case, we will then call @a
 297  * sync_cb, and then afterwards call the @a monitor whenever a record
 298  * changes.  If the namestore disconnects, the @a error_cb function is
 299  * called with a disconnect event. Once the connection is
 300  * re-established, the process begins from the start (depending on @a
 301  * iterate_first, we will again first do all existing records, then @a
 302  * sync, then updates).
 303  *
 304  * @param cfg configuration to use to connect to namestore
 305  * @param zone zone to monitor, NULL for all zones
 306  * @param iterate_first #GNUNET_YES to first iterate over all existing records,
 307  *                      #GNUNET_NO to only return changes that happen from now on
 308  * @param error_cb function to call on error (i.e. disconnect); note that
 309  *         unlike the other error callbacks in this API, a call to this
 310  *         function does NOT destroy the monitor handle, it merely signals
 311  *         that monitoring is down. You need to still explicitly call
 312  *         #GNUNET_NAMESTORE_zone_monitor_stop().
 313  * @param error_cb_cls closure for @a error_cb
 314  * @param monitor function to call on zone changes
 315  * @param monitor_cls closure for @a monitor
 316  * @param sync_cb function called when we're in sync with the namestore
 317  * @param sync_cb_cls closure for @a sync_cb
 318  * @return handle to stop monitoring
 319  */
 320 struct GNUNET_NAMESTORE_ZoneMonitor *
 321 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 322                                      const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 323                                      int iterate_first,
 324                                      GNUNET_SCHEDULER_TaskCallback error_cb,
 325                                      void *error_cb_cls,
 326                                      GNUNET_NAMESTORE_RecordMonitor monitor,
 327                                      void *monitor_cls,
 328                                      GNUNET_SCHEDULER_TaskCallback sync_cb,
 329                                      void *sync_cb_cls);
 330
 331
 332 /**
 333  * Stop monitoring a zone for changes.
 334  *
 335  * @param zm handle to the monitor activity to stop
 336  */
 337 void
 338 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
 339
 340
 341 #if 0                           /* keep Emacsens' auto-indent happy */
 342 {
 343 #endif
 344 #ifdef __cplusplus
 345 }
 346 #endif
 347
 348 #endif
 349
 350 /** @} */  /* end of group */