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