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_ATTR 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_ATTR_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  * Flags that can be set for a record.
 145  */
 146 enum GNUNET_GNSRECORD_Flags
 147 {
 148   /**
 149    * No special options.
 150    */
 151   GNUNET_GNSRECORD_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_GNSRECORD_RF_PRIVATE = 2,
 158
 159   /**
 160    * This flag is currently unused; former RF_PENDING flag
 161    *
 162    * GNUNET_GNSRECORD_RF_UNUSED = 4,
 163    */
 164
 165   /**
 166    * This expiration time of the record is a relative
 167    * time (not an absolute time).
 168    */
 169   GNUNET_GNSRECORD_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_GNSRECORD_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_GNSRECORD_records_cmp.
 187  */
 188 #define GNUNET_GNSRECORD_RF_RCMP_FLAGS (GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION)
 189 };
 190
 191
 192 /**
 193  * A GNS record.
 194  */
 195 struct GNUNET_GNSRECORD_Data
 196 {
 197   /**
 198    * Binary value stored in the DNS record.  Note: "data" must never
 199    * be individually 'malloc'ed, but instead always points into some
 200    * existing data area.
 201    */
 202   const void *data;
 203
 204   /**
 205    * Expiration time for the DNS record.  Can be relative
 206    * or absolute, depending on @e flags.  Measured in the same
 207    * unit as GNUnet time (microseconds).
 208    */
 209   uint64_t expiration_time;
 210
 211   /**
 212    * Number of bytes in @e data.
 213    */
 214   size_t data_size;
 215
 216   /**
 217    * Type of the GNS/DNS record.
 218    */
 219   uint32_t record_type;
 220
 221   /**
 222    * Flags for the record.
 223    */
 224   enum GNUNET_GNSRECORD_Flags flags;
 225 };
 226
 227
 228 GNUNET_NETWORK_STRUCT_BEGIN
 229
 230 /**
 231  * Data stored in a PLACE record.
 232  */
 233 struct GNUNET_GNSRECORD_PlaceData
 234 {
 235   /**
 236    * Public key of the place.
 237    */
 238   struct GNUNET_CRYPTO_EddsaPublicKey place_pub_key;
 239
 240   /**
 241    * Peer identity of the origin.
 242    */
 243   struct GNUNET_PeerIdentity origin;
 244
 245   /**
 246    * Number of relays that follow.
 247    */
 248   uint32_t relay_count GNUNET_PACKED;
 249
 250   /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */
 251 };
 252
 253
 254 /**
 255  * Information we have in an encrypted block with record data (i.e. in the DHT).
 256  */
 257 struct GNUNET_GNSRECORD_Block
 258 {
 259   /**
 260    * Signature of the block.
 261    */
 262   struct GNUNET_CRYPTO_EcdsaSignature signature;
 263
 264   /**
 265    * Derived key used for signing; hash of this is the query.
 266    */
 267   struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
 268
 269   /**
 270    * Number of bytes signed; also specifies the number of bytes
 271    * of encrypted data that follow.
 272    */
 273   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 274
 275   /**
 276    * Expiration time of the block.
 277    */
 278   struct GNUNET_TIME_AbsoluteNBO expiration_time;
 279
 280   /* followed by encrypted data */
 281 };
 282
 283
 284 /**
 285  * Record type used to box up SRV and TLSA records.  For example, a
 286  * TLSA record for "_https._tcp.foo.gnu" will be stored under
 287  * "foo.gnu" as a BOX record with service 443 (https) and protocol 6
 288  * (tcp) and record_type "TLSA".  When a BOX record is received, GNS
 289  * unboxes it if the name contained "_SERVICE._PROTO", otherwise GNS
 290  * leaves it untouched.  This is done to ensure that TLSA (and SRV)
 291  * records do not require a separate network request, thus making TLSA
 292  * records inseparable from the "main" A/AAAA/VPN/etc. records.
 293  */
 294 struct GNUNET_GNSRECORD_BoxRecord
 295 {
 296   /**
 297    * Protocol of the boxed record (6 = TCP, 17 = UDP, etc.).
 298    * Yes, in IP protocols are usually limited to 8 bits. In NBO.
 299    */
 300   uint16_t protocol GNUNET_PACKED;
 301
 302   /**
 303    * Service of the boxed record (aka port number), in NBO.
 304    */
 305   uint16_t service GNUNET_PACKED;
 306
 307   /**
 308    * GNS record type of the boxed record. In NBO.
 309    */
 310   uint32_t record_type GNUNET_PACKED;
 311
 312   /* followed by the 'original' record */
 313 };
 314
 315 /**
 316  * Record type used internally to keep track of reverse mappings into a
 317  * namespace.
 318  * The record contains data related to PKEY delegations from other namespaces to
 319  * the namespace the record belongs to.
 320  * It is exclusively found under the label ``+''.
 321  */
 322 struct GNUNET_GNSRECORD_ReverseRecord
 323 {
 324   /**
 325    * The public key of the namespace the is delegating to our namespace
 326    */
 327   struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
 328
 329   /**
 330    * The expiration time of the delegation
 331    */
 332   struct GNUNET_TIME_Absolute expiration;
 333
 334   /* followed by the name the delegator uses to refer to our namespace */
 335 };
 336
 337 GNUNET_NETWORK_STRUCT_END
 338
 339
 340 /**
 341  * Process a records that were decrypted from a block.
 342  *
 343  * @param cls closure
 344  * @param rd_count number of entries in @a rd array
 345  * @param rd array of records with data to store
 346  */
 347 typedef void (*GNUNET_GNSRECORD_RecordCallback) (
 348   void *cls, unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd);
 349
 350
 351 /* ***************** API related to GNSRECORD plugins ************** */
 352
 353 /**
 354  * Convert the binary value @a data of a record of
 355  * type @a type to a human-readable string.
 356  *
 357  * @param type type of the record
 358  * @param data value in binary encoding
 359  * @param data_size number of bytes in @a data
 360  * @return NULL on error, otherwise human-readable representation of the value
 361  */
 362 char *
 363 GNUNET_GNSRECORD_value_to_string (uint32_t type, const void *data,
 364                                   size_t data_size);
 365
 366
 367 /**
 368  * Convert human-readable version of the value @a s of a record
 369  * of type @a type to the respective binary representation.
 370  *
 371  * @param type type of the record
 372  * @param s human-readable string
 373  * @param data set to value in binary encoding (will be allocated)
 374  * @param data_size set to number of bytes in @a data
 375  * @return #GNUNET_OK on success
 376  */
 377 int
 378 GNUNET_GNSRECORD_string_to_value (uint32_t type, const char *s, void **data,
 379                                   size_t *data_size);
 380
 381
 382 /**
 383  * Convert a type name (i.e. "AAAA") to the corresponding number.
 384  *
 385  * @param dns_typename name to convert
 386  * @return corresponding number, UINT32_MAX on error
 387  */
 388 uint32_t
 389 GNUNET_GNSRECORD_typename_to_number (const char *dns_typename);
 390
 391
 392 /**
 393  * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
 394  *
 395  * @param type number of a type to convert
 396  * @return corresponding typestring, NULL on error
 397  */
 398 const char *
 399 GNUNET_GNSRECORD_number_to_typename (uint32_t type);
 400
 401
 402 /* convenience APIs for serializing / deserializing GNS records */
 403
 404 /**
 405  * Calculate how many bytes we will need to serialize the given
 406  * records.
 407  *
 408  * @param rd_count number of records in the @a rd array
 409  * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
 410  * @return the required size to serialize, -1 on error
 411  */
 412 ssize_t
 413 GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
 414                                    const struct GNUNET_GNSRECORD_Data *rd);
 415
 416
 417 /**
 418  * Serialize the given records to the given destination buffer.
 419  *
 420  * @param rd_count number of records in the @a rd array
 421  * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
 422  * @param dest_size size of the destination array @a dst
 423  * @param dest where to write the result
 424  * @return the size of serialized records, -1 if records do not fit
 425  */
 426 ssize_t
 427 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
 428                                     const struct GNUNET_GNSRECORD_Data *rd,
 429                                     size_t dest_size, char *dest);
 430
 431
 432 /**
 433  * Deserialize the given records to the given destination.
 434  *
 435  * @param len size of the serialized record data
 436  * @param src the serialized record data
 437  * @param rd_count number of records in the @a dest array
 438  * @param dest where to put the data
 439  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 440  */
 441 int
 442 GNUNET_GNSRECORD_records_deserialize (size_t len, 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  * Test if a given record is expired.
 452  *
 453  * @param rd record to test
 454  * @return #GNUNET_YES if the record is expired,
 455  *         #GNUNET_NO if not
 456  */
 457 int
 458 GNUNET_GNSRECORD_is_expired (const struct GNUNET_GNSRECORD_Data *rd);
 459
 460
 461 /**
 462  * Convert a UTF-8 string to UTF-8 lowercase
 463  * @param src source string
 464  * @return converted result
 465  */
 466 char *
 467 GNUNET_GNSRECORD_string_to_lowercase (const char *src);
 468
 469
 470 /**
 471  * Convert a zone to a string (for printing debug messages).
 472  * This is one of the very few calls in the entire API that is
 473  * NOT reentrant!
 474  *
 475  * @param z public key of a zone
 476  * @return string form; will be overwritten by next call to
 477  * #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 to the
 499  * respective public key.
 500  *
 501  * @param zkey string "X" 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 (
 520   const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, 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 (
 533   const struct GNUNET_CRYPTO_EcdsaPublicKey *pub, 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  * Sign name and records, cache derived public key (also keeps the
 556  * private key in static memory, so do not use this function if
 557  * keeping the private key in the process'es RAM is a major issue).
 558  *
 559  * @param key the private key
 560  * @param expire block expiration
 561  * @param label the name for the records
 562  * @param rd record data
 563  * @param rd_count number of records in @a rd
 564  */
 565 struct GNUNET_GNSRECORD_Block *
 566 GNUNET_GNSRECORD_block_create2 (const struct GNUNET_CRYPTO_EcdsaPrivateKey *key,
 567                                 struct GNUNET_TIME_Absolute expire,
 568                                 const char *label,
 569                                 const struct GNUNET_GNSRECORD_Data *rd,
 570                                 unsigned int rd_count);
 571
 572
 573 /**
 574  * Check if a signature is valid.  This API is used by the GNS Block
 575  * to validate signatures received from the network.
 576  *
 577  * @param block block to verify
 578  * @return #GNUNET_OK if the signature is valid
 579  */
 580 int
 581 GNUNET_GNSRECORD_block_verify (const struct GNUNET_GNSRECORD_Block *block);
 582
 583
 584 /**
 585  * Decrypt block.
 586  *
 587  * @param block block to decrypt
 588  * @param zone_key public key of the zone
 589  * @param label the name for the records
 590  * @param proc function to call with the result
 591  * @param proc_cls closure for @a proc
 592  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
 593  *        not well-formed
 594  */
 595 int
 596 GNUNET_GNSRECORD_block_decrypt (
 597   const struct GNUNET_GNSRECORD_Block *block,
 598   const struct GNUNET_CRYPTO_EcdsaPublicKey *zone_key, const char *label,
 599   GNUNET_GNSRECORD_RecordCallback proc, void *proc_cls);
 600
 601
 602 /**
 603  * Compares if two records are equal
 604  *
 605  * @param a a record
 606  * @param b another record
 607  * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
 608  */
 609 int
 610 GNUNET_GNSRECORD_records_cmp (const struct GNUNET_GNSRECORD_Data *a,
 611                               const struct GNUNET_GNSRECORD_Data *b);
 612
 613
 614 /**
 615  * Returns the expiration time of the given block of records. The block
 616  * expiration time is the expiration time of the record with smallest
 617  * expiration time.
 618  *
 619  * @param rd_count number of records given in @a rd
 620  * @param rd array of records
 621  * @return absolute expiration time
 622  */
 623 struct GNUNET_TIME_Absolute
 624 GNUNET_GNSRECORD_record_get_expiration_time (
 625   unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd);
 626
 627
 628 #if 0 /* keep Emacsens' auto-indent happy */
 629 {
 630 #endif
 631 #ifdef __cplusplus
 632 }
 633 #endif
 634
 635 #endif
 636
 637 /** @} */ /* end of group */