src/include/gnunet_gnsrecord_lib.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2012, 2013 GNUnet e.V.
   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 3, 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * API that can be used to manipulate GNS record data
  26  *
  27  * @defgroup gnsrecord  GNS Record library
  28  * Manipulate GNS record data
  29  *
  30  * @see [Documentation](https://gnunet.org/gns-plugins)
  31  *
  32  * @{
  33  */
  34 #ifndef GNUNET_GNSRECORD_LIB_H
  35 #define GNUNET_GNSRECORD_LIB_H
  36
  37 #ifdef __cplusplus
  38 extern "C"
  39 {
  40 #if 0                           /* keep Emacsens' auto-indent happy */
  41 }
  42 #endif
  43 #endif
  44
  45 /**
  46  * Maximum size of a value that can be stored in a GNS block.
  47  */
  48 #define GNUNET_GNSRECORD_MAX_BLOCK_SIZE (63 * 1024)
  49
  50
  51 /**
  52  * Record type indicating any record/'*'
  53  */
  54 #define GNUNET_GNSRECORD_TYPE_ANY 0
  55
  56 /**
  57  * Record type for GNS zone transfer ("PKEY").
  58  */
  59 #define GNUNET_GNSRECORD_TYPE_PKEY 65536
  60
  61 /**
  62  * Record type for GNS nick names ("NICK").
  63  */
  64 #define GNUNET_GNSRECORD_TYPE_NICK 65537
  65
  66 /**
  67  * Record type for GNS legacy hostnames ("LEHO").
  68  */
  69 #define GNUNET_GNSRECORD_TYPE_LEHO 65538
  70
  71 /**
  72  * Record type for VPN resolution
  73  */
  74 #define GNUNET_GNSRECORD_TYPE_VPN 65539
  75
  76 /**
  77  * Record type for delegation to DNS.
  78  */
  79 #define GNUNET_GNSRECORD_TYPE_GNS2DNS 65540
  80
  81 /**
  82  * Record type for a boxed record (see TLSA/SRV handling in GNS).
  83  */
  84 #define GNUNET_GNSRECORD_TYPE_BOX 65541
  85
  86 /**
  87  * Record type for a social place.
  88  */
  89 #define GNUNET_GNSRECORD_TYPE_PLACE 65542
  90
  91 /**
  92  * Record type for a phone (of CONVERSATION).
  93  */
  94 #define GNUNET_GNSRECORD_TYPE_PHONE 65543
  95
  96 /**
  97  * Record type for identity attributes (of IDENTITY).
  98  */
  99 #define GNUNET_GNSRECORD_TYPE_ID_ATTR 65544
 100
 101 /**
 102  * Record type for an identity token (of IDENTITY-TOKEN).
 103  */
 104 #define GNUNET_GNSRECORD_TYPE_ID_TOKEN 65545
 105
 106 /**
 107  * Record type for the private metadata of an identity token (of IDENTITY-TOKEN).
 108  */
 109 #define GNUNET_GNSRECORD_TYPE_ID_TOKEN_METADATA 65546
 110
 111 /**
 112  * Record type for credential
 113  */
 114 #define GNUNET_GNSRECORD_TYPE_CREDENTIAL 65547
 115
 116 /**
 117  * Record type for policies
 118  */
 119 #define GNUNET_GNSRECORD_TYPE_POLICY 65548
 120
 121 /**
 122  * Record type for reverse lookups
 123  */
 124 #define GNUNET_GNSRECORD_TYPE_ATTRIBUTE 65549
 125
 126 /**
 127  * Record type for ABE records
 128  */
 129 #define GNUNET_GNSRECORD_TYPE_ABE_KEY 65550
 130
 131 /**
 132  * Flags that can be set for a record.
 133  */
 134 enum GNUNET_GNSRECORD_Flags
 135 {
 136
 137   /**
 138    * No special options.
 139    */
 140   GNUNET_GNSRECORD_RF_NONE = 0,
 141
 142   /**
 143    * This is a private record of this peer and it should
 144    * thus not be handed out to other peers.
 145    */
 146   GNUNET_GNSRECORD_RF_PRIVATE = 2,
 147
 148   /**
 149    * This flag is currently unused; former RF_PENDING flag
 150    *
 151    * GNUNET_GNSRECORD_RF_UNUSED = 4,
 152    */
 153
 154   /**
 155    * This expiration time of the record is a relative
 156    * time (not an absolute time).
 157    */
 158   GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION = 8,
 159
 160   /**
 161    * This record should not be used unless all (other) records with an absolute
 162    * expiration time have expired.
 163    */
 164   GNUNET_GNSRECORD_RF_SHADOW_RECORD = 16
 165
 166   /**
 167    * When comparing flags for record equality for removal,
 168    * which flags should must match (in addition to the type,
 169    * name, expiration value and data of the record)?  All flags
 170    * that are not listed here will be ignored for this purpose.
 171    * (for example, we don't expect that users will remember to
 172    * pass the '--private' option when removing a record from
 173    * the namestore, hence we don't require this particular option
 174    * to match upon removal).  See also
 175    * #GNUNET_GNSRECORD_records_cmp.
 176    */
 177 #define GNUNET_GNSRECORD_RF_RCMP_FLAGS (GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION)
 178 };
 179
 180
 181 /**
 182  * A GNS record.
 183  */
 184 struct GNUNET_GNSRECORD_Data
 185 {
 186
 187   /**
 188    * Binary value stored in the DNS record.  Note: "data" must never
 189    * be individually 'malloc'ed, but instead always points into some
 190    * existing data area.
 191    */
 192   const void *data;
 193
 194   /**
 195    * Expiration time for the DNS record.  Can be relative
 196    * or absolute, depending on @e flags.  Measured in the same
 197    * unit as GNUnet time (microseconds).
 198    */
 199   uint64_t expiration_time;
 200
 201   /**
 202    * Number of bytes in @e data.
 203    */
 204   size_t data_size;
 205
 206   /**
 207    * Type of the GNS/DNS record.
 208    */
 209   uint32_t record_type;
 210
 211   /**
 212    * Flags for the record.
 213    */
 214   enum GNUNET_GNSRECORD_Flags flags;
 215 };
 216
 217
 218 GNUNET_NETWORK_STRUCT_BEGIN
 219
 220 /**
 221  * Data stored in a PLACE record.
 222  */
 223 struct GNUNET_GNSRECORD_PlaceData
 224 {
 225   /**
 226    * Public key of the place.
 227    */
 228   struct GNUNET_CRYPTO_EddsaPublicKey place_pub_key;
 229
 230   /**
 231    * Peer identity of the origin.
 232    */
 233   struct GNUNET_PeerIdentity origin;
 234
 235   /**
 236    * Number of relays that follow.
 237    */
 238   uint32_t relay_count GNUNET_PACKED;
 239
 240   /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */
 241 };
 242
 243
 244 /**
 245  * Information we have in an encrypted block with record data (i.e. in the DHT).
 246  */
 247 struct GNUNET_GNSRECORD_Block
 248 {
 249
 250   /**
 251    * Signature of the block.
 252    */
 253   struct GNUNET_CRYPTO_EcdsaSignature signature;
 254
 255   /**
 256    * Derived key used for signing; hash of this is the query.
 257    */
 258   struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
 259
 260   /**
 261    * Number of bytes signed; also specifies the number of bytes
 262    * of encrypted data that follow.
 263    */
 264   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 265
 266   /**
 267    * Expiration time of the block.
 268    */
 269   struct GNUNET_TIME_AbsoluteNBO expiration_time;
 270
 271   /* followed by encrypted data */
 272 };
 273
 274
 275 /**
 276  * Record type used to box up SRV and TLSA records.  For example, a
 277  * TLSA record for "_https._tcp.foo.gnu" will be stored under
 278  * "foo.gnu" as a BOX record with service 443 (https) and protocol 6
 279  * (tcp) and record_type "TLSA".  When a BOX record is received, GNS
 280  * unboxes it if the name contained "_SERVICE._PROTO", otherwise GNS
 281  * leaves it untouched.  This is done to ensure that TLSA (and SRV)
 282  * records do not require a separate network request, thus making TLSA
 283  * records inseparable from the "main" A/AAAA/VPN/etc. records.
 284  */
 285 struct GNUNET_GNSRECORD_BoxRecord
 286 {
 287
 288   /**
 289    * Protocol of the boxed record (6 = TCP, 17 = UDP, etc.).
 290    * Yes, in IP protocols are usually limited to 8 bits. In NBO.
 291    */
 292   uint16_t protocol GNUNET_PACKED;
 293
 294   /**
 295    * Service of the boxed record (aka port number), in NBO.
 296    */
 297   uint16_t service GNUNET_PACKED;
 298
 299   /**
 300    * GNS record type of the boxed record. In NBO.
 301    */
 302   uint32_t record_type GNUNET_PACKED;
 303
 304   /* followed by the 'original' record */
 305
 306 };
 307
 308 /**
 309  * Record type used internally to keep track of reverse mappings into a
 310  * namespace.
 311  * The record contains data related to PKEY delegations from other namespaces to
 312  * the namespace the record belongs to.
 313  * It is exclusively found under the label ``+''.
 314  */
 315 struct GNUNET_GNSRECORD_ReverseRecord
 316 {
 317   /**
 318    * The public key of the namespace the is delegating to our namespace
 319    */
 320   struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
 321
 322   /**
 323    * The expiration time of the delegation
 324    */
 325   struct GNUNET_TIME_Absolute expiration;
 326
 327   /* followed by the name the delegator uses to refer to our namespace */
 328 };
 329
 330 GNUNET_NETWORK_STRUCT_END
 331
 332
 333 /**
 334  * Process a records that were decrypted from a block.
 335  *
 336  * @param cls closure
 337  * @param rd_count number of entries in @a rd array
 338  * @param rd array of records with data to store
 339  */
 340 typedef void (*GNUNET_GNSRECORD_RecordCallback) (void *cls,
 341                                                  unsigned int rd_count,
 342                                                  const struct GNUNET_GNSRECORD_Data *rd);
 343
 344
 345
 346 /* ***************** API related to GNSRECORD plugins ************** */
 347
 348 /**
 349  * Convert the binary value @a data of a record of
 350  * type @a type to a human-readable string.
 351  *
 352  * @param type type of the record
 353  * @param data value in binary encoding
 354  * @param data_size number of bytes in @a data
 355  * @return NULL on error, otherwise human-readable representation of the value
 356  */
 357 char *
 358 GNUNET_GNSRECORD_value_to_string (uint32_t type,
 359                                   const void *data,
 360                                   size_t data_size);
 361
 362
 363 /**
 364  * Convert human-readable version of the value @a s of a record
 365  * of type @a type to the respective binary representation.
 366  *
 367  * @param type type of the record
 368  * @param s human-readable string
 369  * @param data set to value in binary encoding (will be allocated)
 370  * @param data_size set to number of bytes in @a data
 371  * @return #GNUNET_OK on success
 372  */
 373 int
 374 GNUNET_GNSRECORD_string_to_value (uint32_t type,
 375                                   const char *s,
 376                                   void **data,
 377                                   size_t *data_size);
 378
 379
 380 /**
 381  * Convert a type name (i.e. "AAAA") to the corresponding number.
 382  *
 383  * @param dns_typename name to convert
 384  * @return corresponding number, UINT32_MAX on error
 385  */
 386 uint32_t
 387 GNUNET_GNSRECORD_typename_to_number (const char *dns_typename);
 388
 389
 390 /**
 391  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 392  *
 393  * @param type number of a type to convert
 394  * @return corresponding typestring, NULL on error
 395  */
 396 const char *
 397 GNUNET_GNSRECORD_number_to_typename (uint32_t type);
 398
 399
 400 /* convenience APIs for serializing / deserializing GNS records */
 401
 402 /**
 403  * Calculate how many bytes we will need to serialize the given
 404  * records.
 405  *
 406  * @param rd_count number of records in the @a rd array
 407  * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
 408  * @return the required size to serialize
 409  */
 410 size_t
 411 GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
 412                                    const struct GNUNET_GNSRECORD_Data *rd);
 413
 414
 415 /**
 416  * Serialize the given records to the given destination buffer.
 417  *
 418  * @param rd_count number of records in the @a rd array
 419  * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
 420  * @param dest_size size of the destination array @a dst
 421  * @param dest where to write the result
 422  * @return the size of serialized records, -1 if records do not fit
 423  */
 424 ssize_t
 425 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
 426                                     const struct GNUNET_GNSRECORD_Data *rd,
 427                                     size_t dest_size,
 428                                     char *dest);
 429
 430
 431 /**
 432  * Deserialize the given records to the given destination.
 433  *
 434  * @param len size of the serialized record data
 435  * @param src the serialized record data
 436  * @param rd_count number of records in the @a dest array
 437  * @param dest where to put the data
 438  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 439  */
 440 int
 441 GNUNET_GNSRECORD_records_deserialize (size_t len,
 442                                       const char *src,
 443                                       unsigned int rd_count,
 444                                       struct GNUNET_GNSRECORD_Data *dest);
 445
 446
 447 /* ******* general APIs relating to blocks, records and labels ******** */
 448
 449
 450
 451 /**
 452  * Test if a given record is expired.
 453  *
 454  * @param rd record to test
 455  * @return #GNUNET_YES if the record is expired,
 456  *         #GNUNET_NO if not
 457  */
 458 int
 459 GNUNET_GNSRECORD_is_expired (const struct GNUNET_GNSRECORD_Data *rd);
 460
 461
 462 /**
 463  * Convert a UTF-8 string to UTF-8 lowercase
 464  * @param src source string
 465  * @return converted result
 466  */
 467 char *
 468 GNUNET_GNSRECORD_string_to_lowercase (const char *src);
 469
 470
 471 /**
 472  * Convert a zone to a string (for printing debug messages).
 473  * This is one of the very few calls in the entire API that is
 474  * NOT reentrant!
 475  *
 476  * @param z public key of a zone
 477  * @return string form; will be overwritten by next call to #GNUNET_GNSRECORD_z2s.
 478  */
 479 const char *
 480 GNUNET_GNSRECORD_z2s (const struct GNUNET_CRYPTO_EcdsaPublicKey *z);
 481
 482
 483 /**
 484  * Convert public key to the respective absolute domain name in the
 485  * ".zkey" pTLD.
 486  * This is one of the very few calls in the entire API that is
 487  * NOT reentrant!
 488  *
 489  * @param pkey a public key with a point on the eliptic curve
 490  * @return string "X.zkey" where X is the coordinates of the public
 491  *         key in an encoding suitable for DNS labels.
 492  */
 493 const char *
 494 GNUNET_GNSRECORD_pkey_to_zkey (const struct GNUNET_CRYPTO_EcdsaPublicKey *pkey);
 495
 496
 497 /**
 498  * Convert an absolute domain name in the ".zkey" pTLD to the
 499  * respective public key.
 500  *
 501  * @param zkey string "X.zkey" where X is the public
 502  *         key in an encoding suitable for DNS labels.
 503  * @param pkey set to a public key on the eliptic curve
 504  * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
 505  */
 506 int
 507 GNUNET_GNSRECORD_zkey_to_pkey (const char *zkey,
 508                                struct GNUNET_CRYPTO_EcdsaPublicKey *pkey);
 509
 510
 511 /**
 512  * Calculate the DHT query for a given @a label in a given @a zone.
 513  *
 514  * @param zone private key of the zone
 515  * @param label label of the record
 516  * @param query hash to use for the query
 517  */
 518 void
 519 GNUNET_GNSRECORD_query_from_private_key (const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
 520                                          const char *label,
 521                                          struct GNUNET_HashCode *query);
 522
 523
 524 /**
 525  * Calculate the DHT query for a given @a label in a given @a zone.
 526  *
 527  * @param pub public key of the zone
 528  * @param label label of the record
 529  * @param query hash to use for the query
 530  */
 531 void
 532 GNUNET_GNSRECORD_query_from_public_key (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
 533                                         const char *label,
 534                                         struct GNUNET_HashCode *query);
 535
 536
 537 /**
 538  * Sign name and records
 539  *
 540  * @param key the private key
 541  * @param expire block expiration
 542  * @param label the name for the records
 543  * @param rd record data
 544  * @param rd_count number of records in @a rd
 545  */
 546 struct GNUNET_GNSRECORD_Block *
 547 GNUNET_GNSRECORD_block_create (const struct GNUNET_CRYPTO_EcdsaPrivateKey *key,
 548                                struct GNUNET_TIME_Absolute expire,
 549                                const char *label,
 550                                const struct GNUNET_GNSRECORD_Data *rd,
 551                                unsigned int rd_count);
 552
 553
 554 /**
 555  * Check if a signature is valid.  This API is used by the GNS Block
 556  * to validate signatures received from the network.
 557  *
 558  * @param block block to verify
 559  * @return #GNUNET_OK if the signature is valid
 560  */
 561 int
 562 GNUNET_GNSRECORD_block_verify (const struct GNUNET_GNSRECORD_Block *block);
 563
 564
 565 /**
 566  * Decrypt block.
 567  *
 568  * @param block block to decrypt
 569  * @param zone_key public key of the zone
 570  * @param label the name for the records
 571  * @param proc function to call with the result
 572  * @param proc_cls closure for @a proc
 573  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
 574  *        not well-formed
 575  */
 576 int
 577 GNUNET_GNSRECORD_block_decrypt (const struct GNUNET_GNSRECORD_Block *block,
 578                                 const struct GNUNET_CRYPTO_EcdsaPublicKey *zone_key,
 579                                 const char *label,
 580                                 GNUNET_GNSRECORD_RecordCallback proc,
 581                                 void *proc_cls);
 582
 583
 584 /**
 585  * Compares if two records are equal
 586  *
 587  * @param a a record
 588  * @param b another record
 589  * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
 590  */
 591 int
 592 GNUNET_GNSRECORD_records_cmp (const struct GNUNET_GNSRECORD_Data *a,
 593                               const struct GNUNET_GNSRECORD_Data *b);
 594
 595
 596 /**
 597  * Returns the expiration time of the given block of records. The block
 598  * expiration time is the expiration time of the record with smallest
 599  * expiration time.
 600  *
 601  * @param rd_count number of records given in @a rd
 602  * @param rd array of records
 603  * @return absolute expiration time
 604  */
 605 struct GNUNET_TIME_Absolute
 606 GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count,
 607                                              const struct GNUNET_GNSRECORD_Data *rd);
 608
 609
 610 #if 0                           /* keep Emacsens' auto-indent happy */
 611 {
 612 #endif
 613 #ifdef __cplusplus
 614 }
 615 #endif
 616
 617 #endif
 618
 619 /** @} */  /* end of group */