/*
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
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
*/
#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
/**
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
};
-
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).
/* 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 */
+
+};
+
+
GNUNET_NETWORK_STRUCT_END
const struct GNUNET_GNSRECORD_Data *rd);
-
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#endif
#endif
+
+/** @} */ /* end of group */