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