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