src/include/gnunet_namestore_service.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2012, 2013, 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 /**
  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  * Process a record that was stored in the namestore.
 133  *
 134  * @param cls closure
 135  * @param zone private key of the zone
 136  * @param label label of the records
 137  * @param rd_count number of entries in @a rd array, 0 if label was deleted
 138  * @param rd array of records with data to store
 139  */
 140 typedef void
 141 (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
 142                                    const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 143                                    const char *label,
 144                                    unsigned int rd_count,
 145                                    const struct GNUNET_GNSRECORD_Data *rd);
 146
 147
 148 /**
 149  * Set the desired nick name for a zone
 150  *
 151  * @param h handle to the namestore
 152  * @param pkey private key of the zone
 153  * @param nick the nick name to set
 154  * @param cont continuation to call when done
 155  * @param cont_cls closure for @a cont
 156  * @return handle to abort the request
 157  */
 158 struct GNUNET_NAMESTORE_QueueEntry *
 159 GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h,
 160                            const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
 161                            const char *nick,
 162                            GNUNET_NAMESTORE_ContinuationWithStatus cont,
 163                            void *cont_cls);
 164
 165
 166 /**
 167  * Lookup an item in the namestore.
 168  *
 169  * @param h handle to the namestore
 170  * @param pkey private key of the zone
 171  * @param label name that is being mapped
 172  * @param error_cb function to call on error (i.e. disconnect)
 173  *        the handle is afterwards invalid
 174  * @param error_cb_cls closure for @a error_cb
 175  * @param rm function to call with the result (with 0 records if we don't have that label);
 176  *        the handle is afterwards invalid
 177  * @param rm_cls closure for @a rm
 178  * @return handle to abort the request
 179  */
 180 struct GNUNET_NAMESTORE_QueueEntry *
 181 GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
 182                                  const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
 183                                  const char *label,
 184                                  GNUNET_SCHEDULER_TaskCallback error_cb,
 185                                  void *error_cb_cls,
 186                                  GNUNET_NAMESTORE_RecordMonitor rm,
 187                                  void *rm_cls);
 188
 189
 190 /**
 191  * Look for an existing PKEY delegation record for a given public key.
 192  * Returns at most one result to the processor.
 193  *
 194  * @param h handle to the namestore
 195  * @param zone private key of the zone to look up in, never NULL
 196  * @param value_zone public key of the target zone (value), never NULL
 197  * @param error_cb function to call on error (i.e. disconnect)
 198  *        the handle is afterwards invalid
 199  * @param error_cb_cls closure for @a error_cb
 200  * @param proc function to call on the matching records, or with
 201  *        NULL (rd_count == 0) if there are no matching records;
 202  *        the handle is afterwards invalid
 203  * @param proc_cls closure for @a proc
 204  * @return a handle that can be used to
 205  *         cancel
 206  */
 207 struct GNUNET_NAMESTORE_QueueEntry *
 208 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
 209                                const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 210                                const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
 211                                GNUNET_SCHEDULER_TaskCallback error_cb,
 212                                void *error_cb_cls,
 213                                GNUNET_NAMESTORE_RecordMonitor proc,
 214                                void *proc_cls);
 215
 216
 217 /**
 218  * Cancel a namestore operation.  The final callback from the
 219  * operation must not have been done yet.  Must be called on any
 220  * namestore operation that has not yet completed prior to calling
 221  * #GNUNET_NAMESTORE_disconnect.
 222  *
 223  * @param qe operation to cancel
 224  */
 225 void
 226 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
 227
 228
 229 /**
 230  * Starts a new zone iteration (used to periodically PUT all of our
 231  * records into our DHT). This MUST lock the `struct GNUNET_NAMESTORE_Handle`
 232  * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next() and
 233  * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once
 234  * immediately, and then again after
 235  * #GNUNET_NAMESTORE_zone_iterator_next() is invoked.
 236  *
 237  * On error (disconnect), @a error_cb will be invoked.
 238  * On normal completion, @a finish_cb proc will be
 239  * invoked.
 240  *
 241  * @param h handle to the namestore
 242  * @param zone zone to access, NULL for all zones
 243  * @param error_cb function to call on error (i.e. disconnect),
 244  *        the handle is afterwards invalid
 245  * @param error_cb_cls closure for @a error_cb
 246  * @param proc function to call on each name from the zone; it
 247  *        will be called repeatedly with a value (if available)
 248  * @param proc_cls closure for @a proc
 249  * @param finish_cb function to call on completion
 250  *        the handle is afterwards invalid
 251  * @param finish_cb_cls closure for @a finish_cb
 252  * @return an iterator handle to use for iteration
 253  */
 254 struct GNUNET_NAMESTORE_ZoneIterator *
 255 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
 256                                        const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 257                                        GNUNET_SCHEDULER_TaskCallback error_cb,
 258                                        void *error_cb_cls,
 259                                        GNUNET_NAMESTORE_RecordMonitor proc,
 260                                        void *proc_cls,
 261                                        GNUNET_SCHEDULER_TaskCallback finish_cb,
 262                                        void *finish_cb_cls);
 263
 264
 265 /**
 266  * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
 267  * for the next record.
 268  *
 269  * @param it the iterator
 270  */
 271 void
 272 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
 273
 274
 275 /**
 276  * Stops iteration and releases the namestore handle for further calls.  Must
 277  * be called on any iteration that has not yet completed prior to calling
 278  * #GNUNET_NAMESTORE_disconnect.
 279  *
 280  * @param it the iterator
 281  */
 282 void
 283 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
 284
 285
 286 /**
 287  * Handle for a monitoring activity.
 288  */
 289 struct GNUNET_NAMESTORE_ZoneMonitor;
 290
 291
 292 /**
 293  * Begin monitoring a zone for changes.  Will first call the @a
 294  * monitor function on all existing records in the selected zone(s) if
 295  * @a iterate_first is #GNUNET_YES.  In any case, we will then call @a
 296  * sync_cb, and then afterwards call the @a monitor whenever a record
 297  * changes.  If the namestore disconnects, the @a error_cb function is
 298  * called with a disconnect event. Once the connection is
 299  * re-established, the process begins from the start (depending on @a
 300  * iterate_first, we will again first do all existing records, then @a
 301  * sync, then updates).
 302  *
 303  * @param cfg configuration to use to connect to namestore
 304  * @param zone zone to monitor, NULL for all zones
 305  * @param iterate_first #GNUNET_YES to first iterate over all existing records,
 306  *                      #GNUNET_NO to only return changes that happen from now on
 307  * @param error_cb function to call on error (i.e. disconnect); note that
 308  *         unlike the other error callbacks in this API, a call to this
 309  *         function does NOT destroy the monitor handle, it merely signals
 310  *         that monitoring is down. You need to still explicitly call
 311  *         #GNUNET_NAMESTORE_zone_monitor_stop().
 312  * @param error_cb_cls closure for @a error_cb
 313  * @param monitor function to call on zone changes
 314  * @param monitor_cls closure for @a monitor
 315  * @param sync_cb function called when we're in sync with the namestore
 316  * @param sync_cb_cls closure for @a sync_cb
 317  * @return handle to stop monitoring
 318  */
 319 struct GNUNET_NAMESTORE_ZoneMonitor *
 320 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 321                                      const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 322                                      int iterate_first,
 323                                      GNUNET_SCHEDULER_TaskCallback error_cb,
 324                                      void *error_cb_cls,
 325                                      GNUNET_NAMESTORE_RecordMonitor monitor,
 326                                      void *monitor_cls,
 327                                      GNUNET_SCHEDULER_TaskCallback sync_cb,
 328                                      void *sync_cb_cls);
 329
 330
 331 /**
 332  * Stop monitoring a zone for changes.
 333  *
 334  * @param zm handle to the monitor activity to stop
 335  */
 336 void
 337 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
 338
 339
 340 #if 0                           /* keep Emacsens' auto-indent happy */
 341 {
 342 #endif
 343 #ifdef __cplusplus
 344 }
 345 #endif
 346
 347 #endif
 348
 349 /** @} */  /* end of group */