src/include/gnunet_namestore_service.h

   1
   2 /*
   3      This file is part of GNUnet
   4      (C) 2012, 2013 Christian Grothoff (and other contributing authors)
   5
   6      GNUnet is free software; you can redistribute it and/or modify
   7      it under the terms of the GNU General Public License as published
   8      by the Free Software Foundation; either version 3, or (at your
   9      option) any later version.
  10
  11      GNUnet is distributed in the hope that it will be useful, but
  12      WITHOUT ANY WARRANTY; without even the implied warranty of
  13      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14      General Public License for more details.
  15
  16      You should have received a copy of the GNU General Public License
  17      along with GNUnet; see the file COPYING.  If not, write to the
  18      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19      Boston, MA 02111-1307, USA.
  20 */
  21
  22 /**
  23  * @file include/gnunet_namestore_service.h
  24  * @brief API that can be used to store naming information on a GNUnet node;
  25  *        Naming information can either be records for which this peer/user
  26  *        is authoritative, or blocks which are cached, encrypted naming
  27  *        data from other peers.
  28  * @author Christian Grothoff
  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  * Record type for a social place.
  76  */
  77 #define GNUNET_NAMESTORE_TYPE_PLACE 65541
  78
  79 /**
  80  * Entry in the queue.
  81  */
  82 struct GNUNET_NAMESTORE_QueueEntry;
  83
  84 /**
  85  * Handle to the namestore service.
  86  */
  87 struct GNUNET_NAMESTORE_Handle;
  88
  89 /**
  90  * Handle to the namestore zone iterator.
  91  */
  92 struct GNUNET_NAMESTORE_ZoneIterator;
  93
  94 /**
  95  * Maximum size of a value that can be stored in the namestore.
  96  */
  97 #define GNUNET_NAMESTORE_MAX_VALUE_SIZE (63 * 1024)
  98
  99
 100 /**
 101  * Connect to the namestore service.
 102  *
 103  * @param cfg configuration to use
 104  * @return handle to use to access the service
 105  */
 106 struct GNUNET_NAMESTORE_Handle *
 107 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 108
 109
 110 /**
 111  * Disconnect from the namestore service (and free associated
 112  * resources).
 113  *
 114  * @param h handle to the namestore
 115  */
 116 void
 117 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
 118
 119
 120 /**
 121  * Continuation called to notify client about result of the
 122  * operation.
 123  *
 124  * @param cls closure
 125  * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
 126  *                GNUNET_NO if content was already there or not found
 127  *                GNUNET_YES (or other positive value) on success
 128  * @param emsg NULL on success, otherwise an error message
 129  */
 130 typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
 131                                                          int32_t success,
 132                                                          const char *emsg);
 133
 134
 135 /**
 136  * Flags that can be set for a record.
 137  */
 138 enum GNUNET_NAMESTORE_RecordFlags
 139 {
 140
 141   /**
 142    * No special options.
 143    */
 144   GNUNET_NAMESTORE_RF_NONE = 0,
 145
 146   /**
 147    * This peer is the authority for this record; it must thus
 148    * not be deleted (other records can be deleted if we run
 149    * out of space).
 150    * @deprecated
 151    */
 152   GNUNET_NAMESTORE_RF_AUTHORITY = 1,
 153
 154   /**
 155    * This is a private record of this peer and it should
 156    * thus not be handed out to other peers.
 157    */
 158   GNUNET_NAMESTORE_RF_PRIVATE = 2,
 159
 160   /**
 161    * This record was added automatically by the system
 162    * and is pending user confimation.
 163    */
 164   GNUNET_NAMESTORE_RF_PENDING = 4,
 165
 166   /**
 167    * This expiration time of the record is a relative
 168    * time (not an absolute time).
 169    */
 170   GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION = 8,
 171
 172   /**
 173    * This record should not be used unless all (other) records with an absolute
 174    * expiration time have expired.
 175    */
 176   GNUNET_NAMESTORE_RF_SHADOW_RECORD = 16
 177
 178   /**
 179    * When comparing flags for record equality for removal,
 180    * which flags should must match (in addition to the type,
 181    * name, expiration value and data of the record)?  All flags
 182    * that are not listed here will be ignored for this purpose.
 183    * (for example, we don't expect that users will remember to
 184    * pass the '--private' option when removing a record from
 185    * the namestore, hence we don't require this particular option
 186    * to match upon removal).  See also
 187    * 'GNUNET_NAMESTORE_records_cmp'.
 188    */
 189 #define GNUNET_NAMESTORE_RF_RCMP_FLAGS (GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION)
 190 };
 191
 192
 193 /**
 194  * A GNS record.
 195  */
 196 struct GNUNET_NAMESTORE_RecordData
 197 {
 198
 199   /**
 200    * Binary value stored in the DNS record.  Note: "data" must never
 201    * be individually 'malloc'ed, but instead always points into some
 202    * existing data area.
 203    */
 204   const void *data;
 205
 206   /**
 207    * Expiration time for the DNS record.  Can be relative
 208    * or absolute, depending on 'flags'.  Measured in the same
 209    * unit as GNUnet time (microseconds).
 210    */
 211   uint64_t expiration_time;
 212
 213   /**
 214    * Number of bytes in 'data'.
 215    */
 216   size_t data_size;
 217
 218   /**
 219    * Type of the GNS/DNS record.
 220    */
 221   uint32_t record_type;
 222
 223   /**
 224    * Flags for the record.
 225    */
 226   enum GNUNET_NAMESTORE_RecordFlags flags;
 227 };
 228
 229
 230
 231 GNUNET_NETWORK_STRUCT_BEGIN
 232
 233
 234 /**
 235  * Information we have in an encrypted block with record data (i.e. in the DHT).
 236  */
 237 struct GNUNET_NAMESTORE_Block
 238 {
 239
 240   /**
 241    * Signature of the block.
 242    */
 243   struct GNUNET_CRYPTO_EccSignature signature;
 244
 245   /**
 246    * Derived key used for signing; hash of this is the query.
 247    */
 248   struct GNUNET_CRYPTO_EccPublicKey derived_key;
 249
 250   /**
 251    * Number of bytes signed; also specifies the number of bytes
 252    * of encrypted data that follow.
 253    */
 254   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 255
 256   /**
 257    * Expiration time of the block.
 258    */
 259   struct GNUNET_TIME_AbsoluteNBO expiration_time;
 260
 261   /* followed by encrypted data */
 262 };
 263
 264 GNUNET_NETWORK_STRUCT_END
 265
 266 /**
 267  * Store an item in the namestore.  If the item is already present,
 268  * it is replaced with the new record.
 269  *
 270  * @param h handle to the namestore
 271  * @param block block to store
 272  * @param cont continuation to call when done
 273  * @param cont_cls closure for @a cont
 274  * @return handle to abort the request
 275  */
 276 struct GNUNET_NAMESTORE_QueueEntry *
 277 GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h,
 278                               const struct GNUNET_NAMESTORE_Block *block,
 279                               GNUNET_NAMESTORE_ContinuationWithStatus cont,
 280                               void *cont_cls);
 281
 282
 283 /**
 284  * Store an item in the namestore.  If the item is already present,
 285  * it is replaced with the new record.  Use an empty array to
 286  * remove all records under the given name.
 287  *
 288  * @param h handle to the namestore
 289  * @param pkey private key of the zone
 290  * @param label name that is being mapped (at most 255 characters long)
 291  * @param rd_count number of records in the 'rd' array
 292  * @param rd array of records with data to store
 293  * @param cont continuation to call when done
 294  * @param cont_cls closure for @a cont
 295  * @return handle to abort the request
 296  */
 297 struct GNUNET_NAMESTORE_QueueEntry *
 298 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
 299                                 const struct GNUNET_CRYPTO_EccPrivateKey *pkey,
 300                                 const char *label,
 301                                 unsigned int rd_count,
 302                                 const struct GNUNET_NAMESTORE_RecordData *rd,
 303                                 GNUNET_NAMESTORE_ContinuationWithStatus cont,
 304                                 void *cont_cls);
 305
 306
 307 /**
 308  * Process a record that was stored in the namestore.
 309  *
 310  * @param cls closure
 311  * @param block block that was stored in the namestore
 312  */
 313 typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls,
 314                                                  const struct GNUNET_NAMESTORE_Block *block);
 315
 316
 317 /**
 318  * Get a result for a particular key from the namestore.  The processor
 319  * will only be called once.
 320  *
 321  * @param h handle to the namestore
 322  * @param derived_hash hash of zone key combined with name to lookup
 323  * @param proc function to call on the matching block, or with
 324  *        NULL if there is no matching block
 325  * @param proc_cls closure for proc
 326  * @return a handle that can be used to cancel
 327  */
 328 struct GNUNET_NAMESTORE_QueueEntry *
 329 GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
 330                                const struct GNUNET_HashCode *derived_hash,
 331                                GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls);
 332
 333
 334 /**
 335  * Process a record that was stored in the namestore.
 336  *
 337  * @param cls closure
 338  * @param zone private key of the zone
 339  * @param label label of the records
 340  * @param rd_count number of entries in @a rd array
 341  * @param rd array of records with data to store
 342  */
 343 typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
 344                                                 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 345                                                 const char *label,
 346                                                 unsigned int rd_count,
 347                                                 const struct GNUNET_NAMESTORE_RecordData *rd);
 348
 349
 350 /**
 351  * Look for an existing PKEY delegation record for a given public key.
 352  * Returns at most one result to the processor.
 353  *
 354  * @param h handle to the namestore
 355  * @param zone public key of the zone to look up in, never NULL
 356  * @param value_zone public key of the target zone (value), never NULL
 357  * @param proc function to call on the matching records, or with
 358  *        NULL (rd_count == 0) if there are no matching records
 359  * @param proc_cls closure for proc
 360  * @return a handle that can be used to
 361  *         cancel
 362  */
 363 struct GNUNET_NAMESTORE_QueueEntry *
 364 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
 365                                const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 366                                const struct GNUNET_CRYPTO_EccPublicKey *value_zone,
 367                                GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls);
 368
 369
 370 /**
 371  * Process a records that were decrypted from a block.
 372  *
 373  * @param cls closure
 374  * @param rd_count number of entries in @a rd array
 375  * @param rd array of records with data to store
 376  */
 377 typedef void (*GNUNET_NAMESTORE_RecordCallback) (void *cls,
 378                                                  unsigned int rd_count,
 379                                                  const struct GNUNET_NAMESTORE_RecordData *rd);
 380
 381
 382 /**
 383  * Cancel a namestore operation.  The final callback from the
 384  * operation must not have been done yet.  Must be called on any
 385  * namestore operation that has not yet completed prior to calling
 386  * #GNUNET_NAMESTORE_disconnect.
 387  *
 388  * @param qe operation to cancel
 389  */
 390 void
 391 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
 392
 393
 394 /**
 395  * Starts a new zone iteration (used to periodically PUT all of our
 396  * records into our DHT). @a proc will be called once immediately, and
 397  * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked.
 398  *
 399  * @param h handle to the namestore
 400  * @param zone zone to access
 401  * @param proc function to call on each name from the zone; it
 402  *        will be called repeatedly with a value (if available)
 403  *        and always once at the end with a name of NULL.
 404  * @param proc_cls closure for proc
 405  * @return an iterator handle to use for iteration
 406  */
 407 struct GNUNET_NAMESTORE_ZoneIterator *
 408 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
 409                                        const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 410                                        GNUNET_NAMESTORE_RecordMonitor proc,
 411                                        void *proc_cls);
 412
 413
 414 /**
 415  * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
 416  * for the next record.
 417  *
 418  * @param it the iterator
 419  */
 420 void
 421 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
 422
 423
 424 /**
 425  * Stops iteration and releases the namestore handle for further calls.  Must
 426  * be called on any iteration that has not yet completed prior to calling
 427  * #GNUNET_NAMESTORE_disconnect.
 428  *
 429  * @param it the iterator
 430  */
 431 void
 432 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
 433
 434
 435 /**
 436  * Handle for a monitoring activity.
 437  */
 438 struct GNUNET_NAMESTORE_ZoneMonitor;
 439
 440
 441 /**
 442  * Function called once the monitor has caught up with the current
 443  * state of the database.  Will be called AGAIN after each disconnect
 444  * (record monitor called with 'NULL' for zone_key) once we're again
 445  * in sync.
 446  *
 447  * @param cls closure
 448  */
 449 typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
 450
 451
 452 /**
 453  * Begin monitoring a zone for changes.  Will first call the @a monitor function
 454  * on all existing records in the selected zone(s), then calls @a sync_cb,
 455  * and then calls the @a monitor whenever a record changes.  If the namestore
 456  * disconnects, the @a monitor function is called with a disconnect event; if
 457  * the connection is re-established, the process begins from the start (all
 458  * existing records, sync, then updates).
 459  *
 460  * @param cfg configuration to use to connect to namestore
 461  * @param zone zone to monitor
 462  * @param monitor function to call on zone changes
 463  * @param sync_cb function called when we're in sync with the namestore
 464  * @param cls closure for @a monitor' and @a sync_cb
 465  * @return handle to stop monitoring
 466  */
 467 struct GNUNET_NAMESTORE_ZoneMonitor *
 468 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 469                                      const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 470                                      GNUNET_NAMESTORE_RecordMonitor monitor,
 471                                      GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
 472                                      void *cls);
 473
 474
 475 /**
 476  * Stop monitoring a zone for changes.
 477  *
 478  * @param zm handle to the monitor activity to stop
 479  */
 480 void
 481 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
 482
 483
 484 /* convenience APIs for serializing / deserializing GNS records */
 485
 486 /**
 487  * Calculate how many bytes we will need to serialize the given
 488  * records.
 489  *
 490  * @param rd_count number of records in the @a rd array
 491  * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
 492  * @return the required size to serialize
 493  */
 494 size_t
 495 GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
 496                                    const struct GNUNET_NAMESTORE_RecordData *rd);
 497
 498
 499 /**
 500  * Serialize the given records to the given destination buffer.
 501  *
 502  * @param rd_count number of records in the @a rd array
 503  * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
 504  * @param dest_size size of the destination array @a dst
 505  * @param dest where to write the result
 506  * @return the size of serialized records, -1 if records do not fit
 507  */
 508 ssize_t
 509 GNUNET_NAMESTORE_records_serialize (unsigned int rd_count,
 510                                     const struct GNUNET_NAMESTORE_RecordData *rd,
 511                                     size_t dest_size,
 512                                     char *dest);
 513
 514
 515 /**
 516  * Deserialize the given records to the given destination.
 517  *
 518  * @param len size of the serialized record data
 519  * @param src the serialized record data
 520  * @param rd_count number of records in the @a dest array
 521  * @param dest where to put the data
 522  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 523  */
 524 int
 525 GNUNET_NAMESTORE_records_deserialize (size_t len,
 526                                       const char *src,
 527                                       unsigned int rd_count,
 528                                       struct GNUNET_NAMESTORE_RecordData *dest);
 529
 530
 531 /**
 532  * Convert the binary value @a data of a record of
 533  * type @a type to a human-readable string.
 534  *
 535  * @param type type of the record
 536  * @param data value in binary encoding
 537  * @param data_size number of bytes in @a data
 538  * @return NULL on error, otherwise human-readable representation of the value
 539  */
 540 char *
 541 GNUNET_NAMESTORE_value_to_string (uint32_t type,
 542                                   const void *data,
 543                                   size_t data_size);
 544
 545
 546 /**
 547  * Convert human-readable version of the value @a s of a record
 548  * of type @a type to the respective binary representation.
 549  *
 550  * @param type type of the record
 551  * @param s human-readable string
 552  * @param data set to value in binary encoding (will be allocated)
 553  * @param data_size set to number of bytes in @a data
 554  * @return #GNUNET_OK on success
 555  */
 556 int
 557 GNUNET_NAMESTORE_string_to_value (uint32_t type,
 558                                   const char *s,
 559                                   void **data,
 560                                   size_t *data_size);
 561
 562
 563 /**
 564  * Convert a type name (i.e. "AAAA") to the corresponding number.
 565  *
 566  * @param typename name to convert
 567  * @return corresponding number, UINT32_MAX on error
 568  */
 569 uint32_t
 570 GNUNET_NAMESTORE_typename_to_number (const char *typename);
 571
 572
 573 /**
 574  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 575  *
 576  * @param type number of a type to convert
 577  * @return corresponding typestring, NULL on error
 578  */
 579 const char *
 580 GNUNET_NAMESTORE_number_to_typename (uint32_t type);
 581
 582
 583 /**
 584  * Test if a given record is expired.
 585  *
 586  * @param rd record to test
 587  * @return #GNUNET_YES if the record is expired,
 588  *         #GNUNET_NO if not
 589  */
 590 int
 591 GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd);
 592
 593
 594 /**
 595  * Convert a UTF-8 string to UTF-8 lowercase
 596  * @param src source string
 597  * @return converted result
 598  */
 599 char *
 600 GNUNET_NAMESTORE_normalize_string (const char *src);
 601
 602
 603 /**
 604  * Convert a zone to a string (for printing debug messages).
 605  * This is one of the very few calls in the entire API that is
 606  * NOT reentrant!
 607  *
 608  * @param z public key of a zone
 609  * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s.
 610  */
 611 const char *
 612 GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z);
 613
 614
 615 /**
 616  * Convert public key to the respective absolute domain name in the
 617  * ".zkey" pTLD.
 618  * This is one of the very few calls in the entire API that is
 619  * NOT reentrant!
 620  *
 621  * @param pkey a public key with (x,y) on the eliptic curve
 622  * @return string "Y.X.zkey" where X and Y are the coordinates of the public
 623  *         key in an encoding suitable for DNS labels.
 624  */
 625 const char *
 626 GNUNET_NAMESTORE_pkey_to_zkey (const struct GNUNET_CRYPTO_EccPublicKey *pkey);
 627
 628
 629 /**
 630  * Convert an absolute domain name in the ".zkey" pTLD to the
 631  * respective public key.
 632  *
 633  * @param zkey string "Y.X.zkey" where X and Y are the coordinates of the public
 634  *         key in an encoding suitable for DNS labels.
 635  * @param pkey set to a public key with (x,y) on the eliptic curve
 636  * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
 637  */
 638 int
 639 GNUNET_NAMESTORE_zkey_to_pkey (const char *zkey,
 640                                struct GNUNET_CRYPTO_EccPublicKey *pkey);
 641
 642
 643 /**
 644  * Calculate the DHT query for a given @a label in a given @a zone.
 645  *
 646  * @param zone private key of the zone
 647  * @param label label of the record
 648  * @param query hash to use for the query
 649  */
 650 void
 651 GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 652                                          const char *label,
 653                                          struct GNUNET_HashCode *query);
 654
 655
 656 /**
 657  * Calculate the DHT query for a given @a label in a given @a zone.
 658  *
 659  * @param pub public key of the zone
 660  * @param label label of the record
 661  * @param query hash to use for the query
 662  */
 663 void
 664 GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub,
 665                                         const char *label,
 666                                         struct GNUNET_HashCode *query);
 667
 668
 669 /**
 670  * Sign name and records
 671  *
 672  * @param key the private key
 673  * @param expire block expiration
 674  * @param label the name for the records
 675  * @param rd record data
 676  * @param rd_count number of records in @a rd
 677  */
 678 struct GNUNET_NAMESTORE_Block *
 679 GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
 680                                struct GNUNET_TIME_Absolute expire,
 681                                const char *label,
 682                                const struct GNUNET_NAMESTORE_RecordData *rd,
 683                                unsigned int rd_count);
 684
 685
 686 /**
 687  * Check if a signature is valid.  This API is used by the GNS Block
 688  * to validate signatures received from the network.
 689  *
 690  * @param block block to verify
 691  * @return #GNUNET_OK if the signature is valid
 692  */
 693 int
 694 GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block);
 695
 696
 697 /**
 698  * Decrypt block.
 699  *
 700  * @param block block to decrypt
 701  * @param zone_key public key of the zone
 702  * @param label the name for the records
 703  * @param proc function to call with the result
 704  * @param proc_cls closure for @a proc
 705  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
 706  *        not well-formed
 707  */
 708 int
 709 GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
 710                                 const struct GNUNET_CRYPTO_EccPublicKey *zone_key,
 711                                 const char *label,
 712                                 GNUNET_NAMESTORE_RecordCallback proc,
 713                                 void *proc_cls);
 714
 715
 716 /**
 717  * Compares if two records are equal
 718  *
 719  * @param a a record
 720  * @param b another record
 721  * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
 722  */
 723 int
 724 GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
 725                               const struct GNUNET_NAMESTORE_RecordData *b);
 726
 727
 728 /**
 729  * Returns the expiration time of the given block of records. The block
 730  * expiration time is the expiration time of the block with smallest
 731  * expiration time.
 732  *
 733  * @param rd_count number of records given in @a rd
 734  * @param rd array of records
 735  * @return absolute expiration time
 736  */
 737 struct GNUNET_TIME_Absolute
 738 GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count,
 739                                              const struct GNUNET_NAMESTORE_RecordData *rd);
 740
 741
 742 #if 0                           /* keep Emacsens' auto-indent happy */
 743 {
 744 #endif
 745 #ifdef __cplusplus
 746 }
 747 #endif
 748
 749 /* end of gnunet_namestore_service.h */
 750 #endif