src/include/gnunet_namestore_service.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012 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 2, 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 include/gnunet_namestore_service.h
  23  * @brief API that can be used to store naming information on a GNUnet node;
  24  * @author Christian Grothoff
  25  *
  26  * Other functions we might want:
  27  * - enumerate all known zones
  28  * - convenience function to gather record and the full affilliated stree
  29  *   in one shot
  30  */
  31
  32 #ifndef GNUNET_NAMESTORE_SERVICE_H
  33 #define GNUNET_NAMESTORE_SERVICE_H
  34
  35 #include "gnunet_util_lib.h"
  36 #include "gnunet_block_lib.h"
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #if 0                           /* keep Emacsens' auto-indent happy */
  42 }
  43 #endif
  44 #endif
  45
  46 /**
  47  * Record type for GNS zone transfer ("PKEY").
  48  */
  49 #define GNUNET_NAMESTORE_TYPE_PKEY 65536
  50
  51 /**
  52  * Record type for GNS zone transfer ("PSEU").
  53  */
  54 #define GNUNET_NAMESTORE_TYPE_PSEU 65537
  55
  56 /**
  57  * Entry in the queue.
  58  */
  59 struct GNUNET_NAMESTORE_QueueEntry;
  60
  61 /**
  62  * Handle to the namestore service.
  63  */
  64 struct GNUNET_NAMESTORE_Handle;
  65
  66 /**
  67  * Handle to the namestore zone iterator.
  68  */
  69 struct GNUNET_NAMESTORE_ZoneIterator;
  70
  71 /**
  72  * Maximum size of a value that can be stored in the namestore.
  73  */
  74 #define GNUNET_NAMESTORE_MAX_VALUE_SIZE (63 * 1024)
  75
  76
  77
  78 /**
  79  * Connect to the namestore service.
  80  *
  81  * @param cfg configuration to use
  82  * @return handle to use to access the service
  83  */
  84 struct GNUNET_NAMESTORE_Handle *
  85 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  86
  87
  88 /**
  89  * Disconnect from the namestore service (and free associated
  90  * resources).
  91  *
  92  * @param h handle to the namestore
  93  * @param drop set to GNUNET_YES to delete all data in namestore (!)
  94  */
  95 void
  96 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h, int drop);
  97
  98
  99 /**
 100  * Continuation called to notify client about result of the
 101  * operation.
 102  *
 103  * @param cls closure
 104  * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
 105  *                GNUNET_NO if content was already there or not found
 106  *                GNUNET_YES (or other positive value) on success
 107  * @param emsg NULL on success, otherwise an error message
 108  */
 109 typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
 110                                                          int32_t success,
 111                                                          const char *emsg);
 112
 113
 114 /**
 115  * Flags that can be set for a record.
 116  */
 117 enum GNUNET_NAMESTORE_RecordFlags
 118 {
 119
 120   /**
 121    * No special options.
 122    */
 123   GNUNET_NAMESTORE_RF_NONE = 0,
 124
 125   /**
 126    * This peer is the authority for this record; it must thus
 127    * not be deleted (other records can be deleted if we run
 128    * out of space).
 129    */
 130   GNUNET_NAMESTORE_RF_AUTHORITY = 1,
 131
 132   /**
 133    * This is a private record of this peer and it should
 134    * thus not be handed out to other peers.
 135    */
 136   GNUNET_NAMESTORE_RF_PRIVATE = 2
 137
 138 };
 139
 140
 141 /**
 142  * A GNS record.
 143  */
 144 struct GNUNET_NAMESTORE_RecordData
 145 {
 146
 147   /**
 148    * Binary value stored in the DNS record.
 149    */
 150   const void *data;
 151
 152   /**
 153    * Expiration time for the DNS record.
 154    */
 155   struct GNUNET_TIME_Absolute expiration;
 156
 157   /**
 158    * Number of bytes in 'data'.
 159    */
 160   size_t data_size;
 161
 162   /**
 163    * Type of the GNS/DNS record.
 164    */
 165   uint32_t record_type;
 166
 167   /**
 168    * Flags for the record.
 169    */
 170   enum GNUNET_NAMESTORE_RecordFlags flags;
 171 };
 172
 173
 174 /**
 175  * Store an item in the namestore.  If the item is already present,
 176  * the expiration time is updated to the max of the existing time and
 177  * the new time.  This API is used when we cache signatures from other
 178  * authorities.
 179  *
 180  * @param h handle to the namestore
 181  * @param zone_key public key of the zone
 182  * @param name name that is being mapped (at most 255 characters long)
 183  * @param expire when does the corresponding block in the DHT expire (until
 184  *               when should we never do a DHT lookup for the same name again)?
 185  * @param rd_count number of entries in 'rd' array
 186  * @param rd array of records with data to store
 187  * @param signature signature for all the records in the zone under the given name
 188  * @param cont continuation to call when done
 189  * @param cont_cls closure for cont
 190  * @return handle to abort the request
 191  */
 192 struct GNUNET_NAMESTORE_QueueEntry *
 193 GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
 194                              const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
 195                              const char *name,
 196                              struct GNUNET_TIME_Absolute expire,
 197                              unsigned int rd_count,
 198                              const struct GNUNET_NAMESTORE_RecordData *rd,
 199                              const struct GNUNET_CRYPTO_RsaSignature *signature,
 200                              GNUNET_NAMESTORE_ContinuationWithStatus cont,
 201                              void *cont_cls);
 202
 203
 204 /**
 205  * Check if a signature is valid.  This API is used by the GNS Block
 206  * to validate signatures received from the network.
 207  *
 208  * @param public_key public key of the zone
 209  * @param expire block expiration
 210  * @param name name that is being mapped (at most 255 characters long)
 211  * @param rd_count number of entries in 'rd' array
 212  * @param rd array of records with data to store
 213  * @param signature signature for all the records in the zone under the given name
 214  * @return GNUNET_OK if the signature is valid
 215  */
 216 int
 217 GNUNET_NAMESTORE_verify_signature (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
 218                                    const struct GNUNET_TIME_Absolute expire,
 219                                    const char *name,
 220                                    unsigned int rd_count,
 221                                    const struct GNUNET_NAMESTORE_RecordData *rd,
 222                                    const struct GNUNET_CRYPTO_RsaSignature *signature);
 223
 224
 225 /**
 226  * Store an item in the namestore.  If the item is already present,
 227  * the expiration time is updated to the max of the existing time and
 228  * the new time.  This API is used by the authority of a zone.
 229  *
 230  * @param h handle to the namestore
 231  * @param pkey private key of the zone
 232  * @param name name that is being mapped (at most 255 characters long)
 233  * @param rd record data to store
 234  * @param cont continuation to call when done
 235  * @param cont_cls closure for cont
 236  * @return handle to abort the request
 237  */
 238 struct GNUNET_NAMESTORE_QueueEntry *
 239 GNUNET_NAMESTORE_record_create (struct GNUNET_NAMESTORE_Handle *h,
 240                                 const struct GNUNET_CRYPTO_RsaPrivateKey *pkey,
 241                                 const char *name,
 242                                 const struct GNUNET_NAMESTORE_RecordData *rd,
 243                                 GNUNET_NAMESTORE_ContinuationWithStatus cont,
 244                                 void *cont_cls);
 245
 246
 247 /**
 248  * Explicitly remove some content from the database.  The
 249  * "cont"inuation will be called with status "GNUNET_OK" if content
 250  * was removed, "GNUNET_NO" if no matching entry was found and
 251  * "GNUNET_SYSERR" on all other types of errors.
 252  * This API is used by the authority of a zone.
 253  *
 254  * @param h handle to the namestore
 255  * @param pkey private key of the zone
 256  * @param name name that is being mapped (at most 255 characters long)
 257  * @param rd record data
 258  * @param cont continuation to call when done
 259  * @param cont_cls closure for cont
 260  * @return handle to abort the request
 261  */
 262 struct GNUNET_NAMESTORE_QueueEntry *
 263 GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h,
 264                                 const struct GNUNET_CRYPTO_RsaPrivateKey *pkey,
 265                                 const char *name,
 266                                 const struct GNUNET_NAMESTORE_RecordData *rd,
 267                                 GNUNET_NAMESTORE_ContinuationWithStatus cont,
 268                                 void *cont_cls);
 269
 270
 271 /**
 272  * Process a record that was stored in the namestore.
 273  *
 274  * @param cls closure
 275  * @param zone_key public key of the zone
 276  * @param expire when does the corresponding block in the DHT expire (until
 277  *               when should we never do a DHT lookup for the same name again)?;
 278  *               GNUNET_TIME_UNIT_ZERO_ABS if there are no records of any type in the namestore,
 279  *               or the expiration time of the block in the namestore (even if there are zero
 280  *               records matching the desired record type)
 281  * @param name name that is being mapped (at most 255 characters long)
 282  * @param rd_count number of entries in 'rd' array
 283  * @param rd array of records with data to store
 284  * @param signature signature of the record block, NULL if signature is unavailable (i.e.
 285  *        because the user queried for a particular record type only)
 286  */
 287 typedef void (*GNUNET_NAMESTORE_RecordProcessor) (void *cls,
 288                                                   const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
 289                                                   struct GNUNET_TIME_Absolute expire,
 290                                                   const char *name,
 291                                                   unsigned int rd_len,
 292                                                   const struct GNUNET_NAMESTORE_RecordData *rd,
 293                                                   const struct GNUNET_CRYPTO_RsaSignature *signature);
 294
 295
 296 /**
 297  * Get a result for a particular key from the namestore.  The processor
 298  * will only be called once.
 299  *
 300  * @param h handle to the namestore
 301  * @param zone zone to look up a record from
 302  * @param name name to look up
 303  * @param record_type desired record type, 0 for all
 304  * @param proc function to call on the matching records, or with
 305  *        NULL (rd_count == 0) if there are no matching records
 306  * @param proc_cls closure for proc
 307  * @return a handle that can be used to
 308  *         cancel
 309  */
 310 struct GNUNET_NAMESTORE_QueueEntry *
 311 GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h,
 312                               const struct GNUNET_CRYPTO_ShortHashCode *zone,
 313                               const char *name,
 314                               uint32_t record_type,
 315                               GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls);
 316
 317
 318 /**
 319  * Look for an existing PKEY delegation record for a given public key.
 320  * Returns at most one result to the processor.
 321  *
 322  * @param h handle to the namestore
 323  * @param zone hash of public key of the zone to look up in, never NULL
 324  * @param value_zone hash of the public key of the target zone (value), never NULL
 325  * @param proc function to call on the matching records, or with
 326  *        NULL (rd_count == 0) if there are no matching records
 327  * @param proc_cls closure for proc
 328  * @return a handle that can be used to
 329  *         cancel
 330  */
 331 struct GNUNET_NAMESTORE_QueueEntry *
 332 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
 333                                const struct GNUNET_CRYPTO_ShortHashCode *zone,
 334                                const struct GNUNET_CRYPTO_ShortHashCode *value_zone,
 335                                GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls);
 336
 337
 338
 339 /**
 340  * Starts a new zone iteration (used to periodically PUT all of our
 341  * records into our DHT). "proc" will be called once
 342  * immediately, and then again after
 343  * "GNUNET_NAMESTORE_zone_iterator_next" is invoked.
 344  *
 345  * @param h handle to the namestore
 346  * @param zone zone to access, NULL for all zones
 347  * @param must_have_flags flags that must be set for the record to be returned
 348  * @param must_not_have_flags flags that must NOT be set for the record to be returned
 349  * @param proc function to call on each name from the zone; it
 350  *        will be called repeatedly with a value (if available)
 351  *        and always once at the end with a name of NULL.
 352  * @param proc_cls closure for proc
 353  * @return an iterator handle to use for iteration
 354  */
 355 struct GNUNET_NAMESTORE_ZoneIterator *
 356 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
 357                                        const struct GNUNET_CRYPTO_ShortHashCode *zone,
 358                                        enum GNUNET_NAMESTORE_RecordFlags must_have_flags,
 359                                        enum GNUNET_NAMESTORE_RecordFlags must_not_have_flags,
 360                                        GNUNET_NAMESTORE_RecordProcessor proc,
 361                                        void *proc_cls);
 362
 363
 364 /**
 365  * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start
 366  * for the next record.
 367  *
 368  * @param it the iterator
 369  */
 370 void
 371 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
 372
 373
 374 /**
 375  * Stops iteration and releases the namestore handle for further calls.
 376  *
 377  * @param it the iterator
 378  */
 379 void
 380 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
 381
 382
 383 /**
 384  * Cancel a namestore operation.  The final callback from the
 385  * operation must not have been done yet.
 386  *
 387  * @param qe operation to cancel
 388  */
 389 void
 390 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
 391
 392
 393
 394 /* convenience APIs for serializing / deserializing GNS records */
 395
 396 /**
 397  * Calculate how many bytes we will need to serialize the given
 398  * records.
 399  *
 400  * @param rd_count number of records in the rd array
 401  * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
 402  *
 403  * @return the required size to serialize
 404  *
 405  */
 406 size_t
 407 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
 408                                    const struct GNUNET_NAMESTORE_RecordData *rd);
 409
 410 /**
 411  * Serialize the given records to the given destination buffer.
 412  *
 413  * @param rd_count number of records in the rd array
 414  * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
 415  * @param dest_size size of the destination array
 416  * @param dest where to write the result
 417  *
 418  * @return the size of serialized records
 419  */
 420 ssize_t
 421 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
 422                                     const struct GNUNET_NAMESTORE_RecordData *rd,
 423                                     size_t dest_size,
 424                                     char *dest);
 425
 426
 427 /**
 428  * Deserialize the given records to the given destination.
 429  *
 430  * @param len size of the serialized record data
 431  * @param src the serialized record data
 432  * @param rd_count number of records in the rd array
 433  * @param dest where to put the data
 434  *
 435  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 436  */
 437 int
 438 GNUNET_NAMESTORE_records_deserialize (size_t len,
 439                                       const char *src,
 440                                       unsigned int rd_count,
 441                                       struct GNUNET_NAMESTORE_RecordData *dest);
 442
 443
 444
 445 /**
 446  * Convert the 'value' of a record to a string.
 447  *
 448  * @param type type of the record
 449  * @param data value in binary encoding
 450  * @param data_size number of bytes in data
 451  * @return NULL on error, otherwise human-readable representation of the value
 452  */
 453 char *
 454 GNUNET_NAMESTORE_value_to_string (uint32_t type,
 455                                   const void *data,
 456                                   size_t data_size);
 457
 458
 459 /**
 460  * Convert human-readable version of a 'value' of a record to the binary
 461  * representation.
 462  *
 463  * @param type type of the record
 464  * @param s human-readable string
 465  * @param data set to value in binary encoding (will be allocated)
 466  * @param data_size set to number of bytes in data
 467  * @return GNUNET_OK on success
 468  */
 469 int
 470 GNUNET_NAMESTORE_string_to_value (uint32_t type,
 471                                   const char *s,
 472                                   void **data,
 473                                   size_t *data_size);
 474
 475
 476 /**
 477  * Convert a type name (i.e. "AAAA") to the corresponding number.
 478  *
 479  * @param typename name to convert
 480  * @return corresponding number, UINT32_MAX on error
 481  */
 482 uint32_t
 483 GNUNET_NAMESTORE_typename_to_number (const char *typename);
 484
 485
 486 /**
 487  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 488  *
 489  * @param type number of a type to convert
 490  * @return corresponding typestring, NULL on error
 491  */
 492 const char *
 493 GNUNET_NAMESTORE_number_to_typename (uint32_t type);
 494
 495
 496 #if 0                           /* keep Emacsens' auto-indent happy */
 497 {
 498 #endif
 499 #ifdef __cplusplus
 500 }
 501 #endif
 502
 503 /* end of gnunet_namestore_service.h */
 504 #endif