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    * This record should not be used unless all (other) records with an absolute
 169    * expiration time have expired.
 170    */
 171   GNUNET_NAMESTORE_RF_SHADOW_RECORD = 16
 172
 173 };
 174
 175
 176 /**
 177  * A GNS record.
 178  */
 179 struct GNUNET_NAMESTORE_RecordData
 180 {
 181
 182   /**
 183    * Binary value stored in the DNS record.
 184    */
 185   const void *data;
 186
 187   /**
 188    * Expiration time for the DNS record.  Can be relative
 189    * or absolute, depending on 'flags'.
 190    */
 191   uint64_t expiration_time;
 192
 193   /**
 194    * Number of bytes in 'data'.
 195    */
 196   size_t data_size;
 197
 198   /**
 199    * Type of the GNS/DNS record.
 200    */
 201   uint32_t record_type;
 202
 203   /**
 204    * Flags for the record.
 205    */
 206   enum GNUNET_NAMESTORE_RecordFlags flags;
 207 };
 208
 209
 210 /**
 211  * Store an item in the namestore.  If the item is already present,
 212  * the expiration time is updated to the max of the existing time and
 213  * the new time.  This API is used when we cache signatures from other
 214  * authorities.
 215  *
 216  * @param h handle to the namestore
 217  * @param zone_key public key of the zone
 218  * @param name name that is being mapped (at most 255 characters long)
 219  * @param freshness when does the corresponding block in the DHT expire (until
 220  *               when should we never do a DHT lookup for the same name again)?
 221  * @param rd_count number of entries in 'rd' array
 222  * @param rd array of records with data to store
 223  * @param signature signature for all the records in the zone under the given name
 224  * @param cont continuation to call when done
 225  * @param cont_cls closure for cont
 226  * @return handle to abort the request
 227  */
 228 struct GNUNET_NAMESTORE_QueueEntry *
 229 GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
 230                              const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
 231                              const char *name,
 232                              struct GNUNET_TIME_Absolute freshness,
 233                              unsigned int rd_count,
 234                              const struct GNUNET_NAMESTORE_RecordData *rd,
 235                              const struct GNUNET_CRYPTO_RsaSignature *signature,
 236                              GNUNET_NAMESTORE_ContinuationWithStatus cont,
 237                              void *cont_cls);
 238
 239
 240 /**
 241  * Check if a signature is valid.  This API is used by the GNS Block
 242  * to validate signatures received from the network.
 243  *
 244  * @param public_key public key of the zone
 245  * @param freshness time set for block expiration
 246  * @param name name that is being mapped (at most 255 characters long)
 247  * @param rd_count number of entries in 'rd' array
 248  * @param rd array of records with data to store
 249  * @param signature signature for all the records in the zone under the given name
 250  * @return GNUNET_OK if the signature is valid
 251  */
 252 int
 253 GNUNET_NAMESTORE_verify_signature (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
 254                                    const struct GNUNET_TIME_Absolute freshness,
 255                                    const char *name,
 256                                    unsigned int rd_count,
 257                                    const struct GNUNET_NAMESTORE_RecordData *rd,
 258                                    const struct GNUNET_CRYPTO_RsaSignature *signature);
 259
 260
 261 /**
 262  * Store an item in the namestore.  If the item is already present,
 263  * the expiration time is updated to the max of the existing time and
 264  * the new time.  This API is used by the authority of a zone.
 265  * FIXME: consider allowing to pass multiple records in one call!
 266  *
 267  * @param h handle to the namestore
 268  * @param pkey private key of the zone
 269  * @param name name that is being mapped (at most 255 characters long)
 270  * @param rd record data to store
 271  * @param cont continuation to call when done
 272  * @param cont_cls closure for cont
 273  * @return handle to abort the request
 274  */
 275 struct GNUNET_NAMESTORE_QueueEntry *
 276 GNUNET_NAMESTORE_record_create (struct GNUNET_NAMESTORE_Handle *h,
 277                                 const struct GNUNET_CRYPTO_RsaPrivateKey *pkey,
 278                                 const char *name,
 279                                 const struct GNUNET_NAMESTORE_RecordData *rd,
 280                                 GNUNET_NAMESTORE_ContinuationWithStatus cont,
 281                                 void *cont_cls);
 282
 283
 284 /**
 285  * Explicitly remove some content from the database.  The
 286  * "cont"inuation will be called with status "GNUNET_OK" if content
 287  * was removed, "GNUNET_NO" if no matching entry was found and
 288  * "GNUNET_SYSERR" on all other types of errors.
 289  * This API is used by the authority of a zone.
 290  *
 291  * @param h handle to the namestore
 292  * @param pkey private key of the zone
 293  * @param name name that is being mapped (at most 255 characters long)
 294  * @param rd record data, remove specific record,  NULL to remove the name and all records
 295  * @param cont continuation to call when done
 296  * @param cont_cls closure for cont
 297  * @return handle to abort the request
 298  */
 299 struct GNUNET_NAMESTORE_QueueEntry *
 300 GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h,
 301                                 const struct GNUNET_CRYPTO_RsaPrivateKey *pkey,
 302                                 const char *name,
 303                                 const struct GNUNET_NAMESTORE_RecordData *rd,
 304                                 GNUNET_NAMESTORE_ContinuationWithStatus cont,
 305                                 void *cont_cls);
 306
 307
 308 /**
 309  * Process a record that was stored in the namestore.
 310  *
 311  * @param cls closure
 312  * @param zone_key public key of the zone
 313  * @param freshness when does the corresponding block in the DHT expire (until
 314  *               when should we never do a DHT lookup for the same name again)?;
 315  *               GNUNET_TIME_UNIT_ZERO_ABS if there are no records of any type in the namestore,
 316  *               or the expiration time of the block in the namestore (even if there are zero
 317  *               records matching the desired record type)
 318  * @param name name that is being mapped (at most 255 characters long)
 319  * @param rd_count number of entries in 'rd' array
 320  * @param rd array of records with data to store
 321  * @param signature signature of the record block, NULL if signature is unavailable (i.e.
 322  *        because the user queried for a particular record type only)
 323  */
 324 typedef void (*GNUNET_NAMESTORE_RecordProcessor) (void *cls,
 325                                                   const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
 326                                                   struct GNUNET_TIME_Absolute freshness,
 327                                                   const char *name,
 328                                                   unsigned int rd_len,
 329                                                   const struct GNUNET_NAMESTORE_RecordData *rd,
 330                                                   const struct GNUNET_CRYPTO_RsaSignature *signature);
 331
 332
 333 /**
 334  * Get a result for a particular key from the namestore.  The processor
 335  * will only be called once.  When using this functions, relative expiration
 336  * times will be converted to absolute expiration times and a signature
 337  * will be created if we are the authority.  The record data and signature
 338  * passed to 'proc' is thus always suitable for passing on to other peers
 339  * (if we are the authority).  If the record type is NOT set to 'ANY' and
 340  * if we are NOT the authority, then non-matching records may be omitted
 341  * from the result and no valid signature can be created; in this case,
 342  * 'signature' will be NULL and the result cannot be given to other peers.
 343  *
 344  * @param h handle to the namestore
 345  * @param zone zone to look up a record from
 346  * @param name name to look up
 347  * @param record_type desired record type, 0 for all
 348  * @param proc function to call on the matching records, or with
 349  *        NULL (rd_count == 0) if there are no matching records
 350  * @param proc_cls closure for proc
 351  * @return a handle that can be used to
 352  *         cancel
 353  */
 354 struct GNUNET_NAMESTORE_QueueEntry *
 355 GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h,
 356                                 const struct GNUNET_CRYPTO_ShortHashCode *zone,
 357                                 const char *name,
 358                                 uint32_t record_type,
 359                                 GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls);
 360
 361
 362 /**
 363  * Look for an existing PKEY delegation record for a given public key.
 364  * Returns at most one result to the processor.
 365  *
 366  * @param h handle to the namestore
 367  * @param zone hash of public key of the zone to look up in, never NULL
 368  * @param value_zone hash of the public key of the target zone (value), never NULL
 369  * @param proc function to call on the matching records, or with
 370  *        NULL (rd_count == 0) if there are no matching records
 371  * @param proc_cls closure for proc
 372  * @return a handle that can be used to
 373  *         cancel
 374  */
 375 struct GNUNET_NAMESTORE_QueueEntry *
 376 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
 377                                const struct GNUNET_CRYPTO_ShortHashCode *zone,
 378                                const struct GNUNET_CRYPTO_ShortHashCode *value_zone,
 379                                GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls);
 380
 381
 382
 383 /**
 384  * Starts a new zone iteration (used to periodically PUT all of our
 385  * records into our DHT). "proc" will be called once immediately, and
 386  * then again after "GNUNET_NAMESTORE_zone_iterator_next" is invoked.
 387  *
 388  * By specifying a 'zone' of NULL and setting 'GNUNET_NAMESTORE_RF_AUTHORITY'
 389  * in 'must_have_flags', we can iterate over all records for which we are
 390  * the authority.  In this case, the 'GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION'
 391  * bit in 'must_have_flags' has a special meaning:
 392  *
 393  * 0) If the bit is clear, all relative expriation times are converted to
 394  *    absolute expiration times.  This is useful for performing DHT PUT
 395  *    operations (and zone transfers) of our zone.  The generated signatures
 396  *    will be valid for other peers.
 397  * 1) if it is set, it means that relative expiration times should be
 398  *    preserved when returned (this is useful for the zone editor user
 399  *    interface).  No signatures will be created in this case, as
 400  *    signatures must not cover records with relative expiration times.
 401  *
 402  * Note that not all queries against this interface are equally performant
 403  * as for some combinations no efficient index may exist.
 404  *
 405  * @param h handle to the namestore
 406  * @param zone zone to access, NULL for all zones
 407  * @param must_have_flags flags that must be set for the record to be returned
 408  * @param must_not_have_flags flags that must NOT be set for the record to be returned
 409  * @param proc function to call on each name from the zone; it
 410  *        will be called repeatedly with a value (if available)
 411  *        and always once at the end with a name of NULL.
 412  * @param proc_cls closure for proc
 413  * @return an iterator handle to use for iteration
 414  */
 415 struct GNUNET_NAMESTORE_ZoneIterator *
 416 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
 417                                        const struct GNUNET_CRYPTO_ShortHashCode *zone,
 418                                        enum GNUNET_NAMESTORE_RecordFlags must_have_flags,
 419                                        enum GNUNET_NAMESTORE_RecordFlags must_not_have_flags,
 420                                        GNUNET_NAMESTORE_RecordProcessor proc,
 421                                        void *proc_cls);
 422
 423
 424 /**
 425  * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start
 426  * for the next record.
 427  *
 428  * @param it the iterator
 429  */
 430 void
 431 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
 432
 433
 434 /**
 435  * Stops iteration and releases the namestore handle for further calls.  Must
 436  * be called on any iteration that has not yet completed prior to calling
 437  * 'GNUNET_NAMESTORE_disconnect'.
 438  *
 439  * @param it the iterator
 440  */
 441 void
 442 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
 443
 444
 445 /**
 446  * Cancel a namestore operation.  The final callback from the
 447  * operation must not have been done yet.  Must be called on any
 448  * namestore operation that has not yet completed prior to calling
 449  * 'GNUNET_NAMESTORE_disconnect'.
 450  *
 451  * @param qe operation to cancel
 452  */
 453 void
 454 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
 455
 456
 457
 458 /* convenience APIs for serializing / deserializing GNS records */
 459
 460 /**
 461  * Calculate how many bytes we will need to serialize the given
 462  * records.
 463  *
 464  * @param rd_count number of records in the rd array
 465  * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
 466  *
 467  * @return the required size to serialize
 468  *
 469  */
 470 size_t
 471 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
 472                                    const struct GNUNET_NAMESTORE_RecordData *rd);
 473
 474
 475 /**
 476  * Serialize the given records to the given destination buffer.
 477  *
 478  * @param rd_count number of records in the rd array
 479  * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
 480  * @param dest_size size of the destination array
 481  * @param dest where to write the result
 482  *
 483  * @return the size of serialized records
 484  */
 485 ssize_t
 486 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
 487                                     const struct GNUNET_NAMESTORE_RecordData *rd,
 488                                     size_t dest_size,
 489                                     char *dest);
 490
 491
 492 /**
 493  * Deserialize the given records to the given destination.
 494  *
 495  * @param len size of the serialized record data
 496  * @param src the serialized record data
 497  * @param rd_count number of records in the rd array
 498  * @param dest where to put the data
 499  *
 500  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 501  */
 502 int
 503 GNUNET_NAMESTORE_records_deserialize (size_t len,
 504                                       const char *src,
 505                                       unsigned int rd_count,
 506                                       struct GNUNET_NAMESTORE_RecordData *dest);
 507
 508
 509 /**
 510  * Checks if a name is wellformed
 511  *
 512  * @param name the name to check
 513  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 514  */
 515 int
 516 GNUNET_NAMESTORE_check_name (const char * name);
 517
 518
 519 /**
 520  * Convert the 'value' of a record to a string.
 521  *
 522  * @param type type of the record
 523  * @param data value in binary encoding
 524  * @param data_size number of bytes in data
 525  * @return NULL on error, otherwise human-readable representation of the value
 526  */
 527 char *
 528 GNUNET_NAMESTORE_value_to_string (uint32_t type,
 529                                   const void *data,
 530                                   size_t data_size);
 531
 532
 533 /**
 534  * Convert human-readable version of a 'value' of a record to the binary
 535  * representation.
 536  *
 537  * @param type type of the record
 538  * @param s human-readable string
 539  * @param data set to value in binary encoding (will be allocated)
 540  * @param data_size set to number of bytes in data
 541  * @return GNUNET_OK on success
 542  */
 543 int
 544 GNUNET_NAMESTORE_string_to_value (uint32_t type,
 545                                   const char *s,
 546                                   void **data,
 547                                   size_t *data_size);
 548
 549
 550 /**
 551  * Convert a type name (i.e. "AAAA") to the corresponding number.
 552  *
 553  * @param typename name to convert
 554  * @return corresponding number, UINT32_MAX on error
 555  */
 556 uint32_t
 557 GNUNET_NAMESTORE_typename_to_number (const char *typename);
 558
 559
 560 /**
 561  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 562  *
 563  * @param type number of a type to convert
 564  * @return corresponding typestring, NULL on error
 565  */
 566 const char *
 567 GNUNET_NAMESTORE_number_to_typename (uint32_t type);
 568
 569
 570 /**
 571  * Test if a given record is expired.
 572  *
 573  * @return GNUNET_YES if the record is expired,
 574  *         GNUNET_NO if not
 575  */
 576 int
 577 GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd);
 578
 579
 580 #if 0                           /* keep Emacsens' auto-indent happy */
 581 {
 582 #endif
 583 #ifdef __cplusplus
 584 }
 585 #endif
 586
 587 /* end of gnunet_namestore_service.h */
 588 #endif