X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_gnsrecord_lib.h;h=985ae1f7ab0d5489d6ffbc3b00644787bf119990;hb=7a7ec54a324da4820202582126795a8ac6bbe94d;hp=96e7e3aeed6e3b1effa9246b75c6bf3f2c386078;hpb=accfd6bd85274da2f19e7230c8da6b273cfb2ece;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index 96e7e3aee..985ae1f7a 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - (C) 2012, 2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2012, 2013 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -14,14 +14,22 @@ You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_gnsrecord_lib.h - * @brief API that can be used to manipulate GNS record data * @author Christian Grothoff + * + * @file + * API that can be used to manipulate GNS record data + * + * @defgroup gnsrecord GNS Record library + * Manipulate GNS record data + * + * @see [Documentation](https://gnunet.org/gns-plugins) + * + * @{ */ #ifndef GNUNET_GNSRECORD_LIB_H #define GNUNET_GNSRECORD_LIB_H @@ -51,9 +59,9 @@ extern "C" #define GNUNET_GNSRECORD_TYPE_PKEY 65536 /** - * Record type for GNS zone transfer ("PSEU"). + * Record type for GNS nick names ("NICK"). */ -#define GNUNET_GNSRECORD_TYPE_PSEU 65537 +#define GNUNET_GNSRECORD_TYPE_NICK 65537 /** * Record type for GNS legacy hostnames ("LEHO"). @@ -70,16 +78,40 @@ extern "C" */ #define GNUNET_GNSRECORD_TYPE_GNS2DNS 65540 +/** + * Record type for a boxed record (see TLSA/SRV handling in GNS). + */ +#define GNUNET_GNSRECORD_TYPE_BOX 65541 + /** * Record type for a social place. */ -#define GNUNET_GNSRECORD_TYPE_PLACE 65541 +#define GNUNET_GNSRECORD_TYPE_PLACE 65542 /** * Record type for a phone (of CONVERSATION). */ -#define GNUNET_GNSRECORD_TYPE_PHONE 65542 +#define GNUNET_GNSRECORD_TYPE_PHONE 65543 + +/** + * Record type for identity attributes (of IDENTITY). + */ +#define GNUNET_GNSRECORD_TYPE_ID_ATTR 65544 + +/** + * Record type for an identity token (of IDENTITY-TOKEN). + */ +#define GNUNET_GNSRECORD_TYPE_ID_TOKEN 65545 + +/** + * Record type for the private metadata of an identity token (of IDENTITY-TOKEN). + */ +#define GNUNET_GNSRECORD_TYPE_ID_TOKEN_METADATA 65546 +/** + * Record type for reverse lookups + */ +#define GNUNET_GNSRECORD_TYPE_REVERSE 65548 /** * Flags that can be set for a record. @@ -99,10 +131,10 @@ enum GNUNET_GNSRECORD_Flags GNUNET_GNSRECORD_RF_PRIVATE = 2, /** - * This record was added automatically by the system - * and is pending user confimation. + * This flag is currently unused; former RF_PENDING flag + * + * GNUNET_GNSRECORD_RF_UNUSED = 4, */ - GNUNET_GNSRECORD_RF_PENDING = 4, /** * This expiration time of the record is a relative @@ -146,13 +178,13 @@ struct GNUNET_GNSRECORD_Data /** * Expiration time for the DNS record. Can be relative - * or absolute, depending on 'flags'. Measured in the same + * or absolute, depending on @e flags. Measured in the same * unit as GNUnet time (microseconds). */ uint64_t expiration_time; /** - * Number of bytes in 'data'. + * Number of bytes in @e data. */ size_t data_size; @@ -168,9 +200,31 @@ struct GNUNET_GNSRECORD_Data }; - GNUNET_NETWORK_STRUCT_BEGIN +/** + * Data stored in a PLACE record. + */ +struct GNUNET_GNSRECORD_PlaceData +{ + /** + * Public key of the place. + */ + struct GNUNET_CRYPTO_EddsaPublicKey place_pub_key; + + /** + * Peer identity of the origin. + */ + struct GNUNET_PeerIdentity origin; + + /** + * Number of relays that follow. + */ + uint32_t relay_count GNUNET_PACKED; + + /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */ +}; + /** * Information we have in an encrypted block with record data (i.e. in the DHT). @@ -202,6 +256,62 @@ struct GNUNET_GNSRECORD_Block /* followed by encrypted data */ }; + +/** + * Record type used to box up SRV and TLSA records. For example, a + * TLSA record for "_https._tcp.foo.gnu" will be stored under + * "foo.gnu" as a BOX record with service 443 (https) and protocol 6 + * (tcp) and record_type "TLSA". When a BOX record is received, GNS + * unboxes it if the name contained "_SERVICE._PROTO", otherwise GNS + * leaves it untouched. This is done to ensure that TLSA (and SRV) + * records do not require a separate network request, thus making TLSA + * records inseparable from the "main" A/AAAA/VPN/etc. records. + */ +struct GNUNET_GNSRECORD_BoxRecord +{ + + /** + * Protocol of the boxed record (6 = TCP, 17 = UDP, etc.). + * Yes, in IP protocols are usually limited to 8 bits. In NBO. + */ + uint16_t protocol GNUNET_PACKED; + + /** + * Service of the boxed record (aka port number), in NBO. + */ + uint16_t service GNUNET_PACKED; + + /** + * GNS record type of the boxed record. In NBO. + */ + uint32_t record_type GNUNET_PACKED; + + /* followed by the 'original' record */ + +}; + +/** + * Record type used internally to keep track of reverse mappings into a + * namespace. + * The record contains data related to PKEY delegations from other namespaces to + * the namespace the record belongs to. + * It is exclusively found under the label ``+''. + */ +struct GNUNET_GNSRECORD_ReverseRecord +{ + /** + * The public key of the namespace the is delegating to our namespace + */ + struct GNUNET_CRYPTO_EcdsaPublicKey pkey; + + /** + * The expiration time of the delegation + */ + struct GNUNET_TIME_Absolute expiration; + + /* followed by the name the delegator uses to refer to our namespace */ +}; + GNUNET_NETWORK_STRUCT_END @@ -482,7 +592,6 @@ GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd); - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -491,3 +600,5 @@ GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count, #endif #endif + +/** @} */ /* end of group */