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