2 This file is part of GNUnet
3 Copyright (C) 2012, 2013 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
25 * API that can be used to manipulate GNS record data
27 * @defgroup gnsrecord GNS Record library
28 * Manipulate GNS record data
30 * @see [Documentation](https://gnunet.org/gns-plugins)
34 #ifndef GNUNET_GNSRECORD_LIB_H
35 #define GNUNET_GNSRECORD_LIB_H
39 #if 0 /* keep Emacsens' auto-indent happy */
45 * Maximum size of a value that can be stored in a GNS block.
47 #define GNUNET_GNSRECORD_MAX_BLOCK_SIZE (63 * 1024)
51 * Record type indicating any record/'*'
53 #define GNUNET_GNSRECORD_TYPE_ANY 0
56 * Record type for GNS zone transfer ("PKEY").
58 #define GNUNET_GNSRECORD_TYPE_PKEY 65536
61 * Record type for GNS nick names ("NICK").
63 #define GNUNET_GNSRECORD_TYPE_NICK 65537
66 * Record type for GNS legacy hostnames ("LEHO").
68 #define GNUNET_GNSRECORD_TYPE_LEHO 65538
71 * Record type for VPN resolution
73 #define GNUNET_GNSRECORD_TYPE_VPN 65539
76 * Record type for delegation to DNS.
78 #define GNUNET_GNSRECORD_TYPE_GNS2DNS 65540
81 * Record type for a boxed record (see TLSA/SRV handling in GNS).
83 #define GNUNET_GNSRECORD_TYPE_BOX 65541
86 * Record type for a social place.
88 #define GNUNET_GNSRECORD_TYPE_PLACE 65542
91 * Record type for a phone (of CONVERSATION).
93 #define GNUNET_GNSRECORD_TYPE_PHONE 65543
96 * Record type for identity attributes (of RECLAIM).
98 #define GNUNET_GNSRECORD_TYPE_RECLAIM_ATTRIBUTE 65544
101 * Record type for local ticket references
103 #define GNUNET_GNSRECORD_TYPE_RECLAIM_TICKET 65545
110 * 65547 deleted, free to use
114 * Record type for policies
116 #define GNUNET_GNSRECORD_TYPE_DELEGATE 65548
119 * Record type for reverse lookups
121 #define GNUNET_GNSRECORD_TYPE_ATTRIBUTE 65549
124 * Record type for reclaim records
126 #define GNUNET_GNSRECORD_TYPE_RECLAIM_ATTRIBUTE_REF 65550
129 * Record type for RECLAIM master
131 #define GNUNET_GNSRECORD_TYPE_RECLAIM_MASTER 65551
134 * Record type for reclaim OIDC clients
136 #define GNUNET_GNSRECORD_TYPE_RECLAIM_OIDC_CLIENT 65552
139 * Record type for reclaim OIDC redirect URIs
141 #define GNUNET_GNSRECORD_TYPE_RECLAIM_OIDC_REDIRECT 65553
144 * Record type for an attribute attestation
146 #define GNUNET_GNSRECORD_TYPE_RECLAIM_ATTESTATION 65554
149 * Record type for an attestation reference in a ticket
151 #define GNUNET_GNSRECORD_TYPE_RECLAIM_ATTESTATION_REF 65555
155 * Flags that can be set for a record.
157 enum GNUNET_GNSRECORD_Flags
160 * No special options.
162 GNUNET_GNSRECORD_RF_NONE = 0,
165 * This is a private record of this peer and it should
166 * thus not be handed out to other peers.
168 GNUNET_GNSRECORD_RF_PRIVATE = 2,
171 * This flag is currently unused; former RF_PENDING flag
173 * GNUNET_GNSRECORD_RF_UNUSED = 4,
177 * This expiration time of the record is a relative
178 * time (not an absolute time).
180 GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION = 8,
183 * This record should not be used unless all (other) records with an absolute
184 * expiration time have expired.
186 GNUNET_GNSRECORD_RF_SHADOW_RECORD = 16
189 * When comparing flags for record equality for removal,
190 * which flags should must match (in addition to the type,
191 * name, expiration value and data of the record)? All flags
192 * that are not listed here will be ignored for this purpose.
193 * (for example, we don't expect that users will remember to
194 * pass the '--private' option when removing a record from
195 * the namestore, hence we don't require this particular option
196 * to match upon removal). See also
197 * #GNUNET_GNSRECORD_records_cmp.
199 #define GNUNET_GNSRECORD_RF_RCMP_FLAGS (GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION)
206 struct GNUNET_GNSRECORD_Data
209 * Binary value stored in the DNS record. Note: "data" must never
210 * be individually 'malloc'ed, but instead always points into some
211 * existing data area.
216 * Expiration time for the DNS record. Can be relative
217 * or absolute, depending on @e flags. Measured in the same
218 * unit as GNUnet time (microseconds).
220 uint64_t expiration_time;
223 * Number of bytes in @e data.
228 * Type of the GNS/DNS record.
230 uint32_t record_type;
233 * Flags for the record.
235 enum GNUNET_GNSRECORD_Flags flags;
239 GNUNET_NETWORK_STRUCT_BEGIN
242 * Data stored in a PLACE record.
244 struct GNUNET_GNSRECORD_PlaceData
247 * Public key of the place.
249 struct GNUNET_CRYPTO_EddsaPublicKey place_pub_key;
252 * Peer identity of the origin.
254 struct GNUNET_PeerIdentity origin;
257 * Number of relays that follow.
259 uint32_t relay_count GNUNET_PACKED;
261 /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */
266 * Information we have in an encrypted block with record data (i.e. in the DHT).
268 struct GNUNET_GNSRECORD_Block
271 * Signature of the block.
273 struct GNUNET_CRYPTO_EcdsaSignature signature;
276 * Derived key used for signing; hash of this is the query.
278 struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
281 * Number of bytes signed; also specifies the number of bytes
282 * of encrypted data that follow.
284 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
287 * Expiration time of the block.
289 struct GNUNET_TIME_AbsoluteNBO expiration_time;
291 /* followed by encrypted data */
296 * Record type used to box up SRV and TLSA records. For example, a
297 * TLSA record for "_https._tcp.foo.gnu" will be stored under
298 * "foo.gnu" as a BOX record with service 443 (https) and protocol 6
299 * (tcp) and record_type "TLSA". When a BOX record is received, GNS
300 * unboxes it if the name contained "_SERVICE._PROTO", otherwise GNS
301 * leaves it untouched. This is done to ensure that TLSA (and SRV)
302 * records do not require a separate network request, thus making TLSA
303 * records inseparable from the "main" A/AAAA/VPN/etc. records.
305 struct GNUNET_GNSRECORD_BoxRecord
308 * Protocol of the boxed record (6 = TCP, 17 = UDP, etc.).
309 * Yes, in IP protocols are usually limited to 8 bits. In NBO.
311 uint16_t protocol GNUNET_PACKED;
314 * Service of the boxed record (aka port number), in NBO.
316 uint16_t service GNUNET_PACKED;
319 * GNS record type of the boxed record. In NBO.
321 uint32_t record_type GNUNET_PACKED;
323 /* followed by the 'original' record */
327 * Record type used internally to keep track of reverse mappings into a
329 * The record contains data related to PKEY delegations from other namespaces to
330 * the namespace the record belongs to.
331 * It is exclusively found under the label ``+''.
333 struct GNUNET_GNSRECORD_ReverseRecord
336 * The public key of the namespace the is delegating to our namespace
338 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
341 * The expiration time of the delegation
343 struct GNUNET_TIME_Absolute expiration;
345 /* followed by the name the delegator uses to refer to our namespace */
348 GNUNET_NETWORK_STRUCT_END
352 * Process a records that were decrypted from a block.
355 * @param rd_count number of entries in @a rd array
356 * @param rd array of records with data to store
358 typedef void (*GNUNET_GNSRECORD_RecordCallback) (
359 void *cls, unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd);
362 /* ***************** API related to GNSRECORD plugins ************** */
365 * Convert the binary value @a data of a record of
366 * type @a type to a human-readable string.
368 * @param type type of the record
369 * @param data value in binary encoding
370 * @param data_size number of bytes in @a data
371 * @return NULL on error, otherwise human-readable representation of the value
374 GNUNET_GNSRECORD_value_to_string (uint32_t type, const void *data,
379 * Convert human-readable version of the value @a s of a record
380 * of type @a type to the respective binary representation.
382 * @param type type of the record
383 * @param s human-readable string
384 * @param data set to value in binary encoding (will be allocated)
385 * @param data_size set to number of bytes in @a data
386 * @return #GNUNET_OK on success
389 GNUNET_GNSRECORD_string_to_value (uint32_t type, const char *s, void **data,
394 * Convert a type name (i.e. "AAAA") to the corresponding number.
396 * @param dns_typename name to convert
397 * @return corresponding number, UINT32_MAX on error
400 GNUNET_GNSRECORD_typename_to_number (const char *dns_typename);
404 * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A")
406 * @param type number of a type to convert
407 * @return corresponding typestring, NULL on error
410 GNUNET_GNSRECORD_number_to_typename (uint32_t type);
413 /* convenience APIs for serializing / deserializing GNS records */
416 * Calculate how many bytes we will need to serialize the given
419 * @param rd_count number of records in the @a rd array
420 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
421 * @return the required size to serialize, -1 on error
424 GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
425 const struct GNUNET_GNSRECORD_Data *rd);
429 * Serialize the given records to the given destination buffer.
431 * @param rd_count number of records in the @a rd array
432 * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
433 * @param dest_size size of the destination array @a dst
434 * @param dest where to write the result
435 * @return the size of serialized records, -1 if records do not fit
438 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
439 const struct GNUNET_GNSRECORD_Data *rd,
440 size_t dest_size, char *dest);
444 * Deserialize the given records to the given destination.
446 * @param len size of the serialized record data
447 * @param src the serialized record data
448 * @param rd_count number of records in the @a dest array
449 * @param dest where to put the data
450 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
453 GNUNET_GNSRECORD_records_deserialize (size_t len, const char *src,
454 unsigned int rd_count,
455 struct GNUNET_GNSRECORD_Data *dest);
458 /* ******* general APIs relating to blocks, records and labels ******** */
462 * Test if a given record is expired.
464 * @param rd record to test
465 * @return #GNUNET_YES if the record is expired,
469 GNUNET_GNSRECORD_is_expired (const struct GNUNET_GNSRECORD_Data *rd);
473 * Convert a UTF-8 string to UTF-8 lowercase
474 * @param src source string
475 * @return converted result
478 GNUNET_GNSRECORD_string_to_lowercase (const char *src);
482 * Convert a zone to a string (for printing debug messages).
483 * This is one of the very few calls in the entire API that is
486 * @param z public key of a zone
487 * @return string form; will be overwritten by next call to
488 * #GNUNET_GNSRECORD_z2s.
491 GNUNET_GNSRECORD_z2s (const struct GNUNET_CRYPTO_EcdsaPublicKey *z);
495 * Convert public key to the respective absolute domain name in the
497 * This is one of the very few calls in the entire API that is
500 * @param pkey a public key with a point on the eliptic curve
501 * @return string "X.zkey" where X is the coordinates of the public
502 * key in an encoding suitable for DNS labels.
505 GNUNET_GNSRECORD_pkey_to_zkey (const struct GNUNET_CRYPTO_EcdsaPublicKey *pkey);
509 * Convert an absolute domain name to the
510 * respective public key.
512 * @param zkey string "X" where X is the public
513 * key in an encoding suitable for DNS labels.
514 * @param pkey set to a public key on the eliptic curve
515 * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
518 GNUNET_GNSRECORD_zkey_to_pkey (const char *zkey,
519 struct GNUNET_CRYPTO_EcdsaPublicKey *pkey);
523 * Calculate the DHT query for a given @a label in a given @a zone.
525 * @param zone private key of the zone
526 * @param label label of the record
527 * @param query hash to use for the query
530 GNUNET_GNSRECORD_query_from_private_key (
531 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, const char *label,
532 struct GNUNET_HashCode *query);
536 * Calculate the DHT query for a given @a label in a given @a zone.
538 * @param pub public key of the zone
539 * @param label label of the record
540 * @param query hash to use for the query
543 GNUNET_GNSRECORD_query_from_public_key (
544 const struct GNUNET_CRYPTO_EcdsaPublicKey *pub, const char *label,
545 struct GNUNET_HashCode *query);
549 * Sign name and records
551 * @param key the private key
552 * @param expire block expiration
553 * @param label the name for the records
554 * @param rd record data
555 * @param rd_count number of records in @a rd
557 struct GNUNET_GNSRECORD_Block *
558 GNUNET_GNSRECORD_block_create (const struct GNUNET_CRYPTO_EcdsaPrivateKey *key,
559 struct GNUNET_TIME_Absolute expire,
561 const struct GNUNET_GNSRECORD_Data *rd,
562 unsigned int rd_count);
566 * Sign name and records, cache derived public key (also keeps the
567 * private key in static memory, so do not use this function if
568 * keeping the private key in the process'es RAM is a major issue).
570 * @param key the private key
571 * @param expire block expiration
572 * @param label the name for the records
573 * @param rd record data
574 * @param rd_count number of records in @a rd
576 struct GNUNET_GNSRECORD_Block *
577 GNUNET_GNSRECORD_block_create2 (const struct GNUNET_CRYPTO_EcdsaPrivateKey *key,
578 struct GNUNET_TIME_Absolute expire,
580 const struct GNUNET_GNSRECORD_Data *rd,
581 unsigned int rd_count);
585 * Check if a signature is valid. This API is used by the GNS Block
586 * to validate signatures received from the network.
588 * @param block block to verify
589 * @return #GNUNET_OK if the signature is valid
592 GNUNET_GNSRECORD_block_verify (const struct GNUNET_GNSRECORD_Block *block);
598 * @param block block to decrypt
599 * @param zone_key public key of the zone
600 * @param label the name for the records
601 * @param proc function to call with the result
602 * @param proc_cls closure for @a proc
603 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
607 GNUNET_GNSRECORD_block_decrypt (
608 const struct GNUNET_GNSRECORD_Block *block,
609 const struct GNUNET_CRYPTO_EcdsaPublicKey *zone_key, const char *label,
610 GNUNET_GNSRECORD_RecordCallback proc, void *proc_cls);
614 * Compares if two records are equal
617 * @param b another record
618 * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
621 GNUNET_GNSRECORD_records_cmp (const struct GNUNET_GNSRECORD_Data *a,
622 const struct GNUNET_GNSRECORD_Data *b);
626 * Returns the expiration time of the given block of records. The block
627 * expiration time is the expiration time of the record with smallest
630 * @param rd_count number of records given in @a rd
631 * @param rd array of records
632 * @return absolute expiration time
634 struct GNUNET_TIME_Absolute
635 GNUNET_GNSRECORD_record_get_expiration_time (
636 unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd);
639 #if 0 /* keep Emacsens' auto-indent happy */
648 /** @} */ /* end of group */