/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2011-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 namestore/namestore.h
* @brief common internal definitions for namestore service
* @author Matthias Wachs
+ * @author Christian Grothoff
*/
#ifndef NAMESTORE_H
#define NAMESTORE_H
GNUNET_NETWORK_STRUCT_BEGIN
-
/**
- * A GNS record serialized for network transmission.
- *
- * Layout is [struct GNUNET_NAMESTORE_NetworkRecord][char[data_size] data]
+ * Generic namestore message with op id
*/
-struct GNUNET_NAMESTORE_NetworkRecord
+struct GNUNET_NAMESTORE_Header
{
/**
- * Expiration time for the DNS record.
- */
- struct GNUNET_TIME_AbsoluteNBO expiration;
-
- /**
- * Number of bytes in 'data'.
- */
- uint32_t data_size;
-
- /**
- * Type of the GNS/DNS record.
+ * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_*
+ * header.size will be message size
*/
- uint32_t record_type;
+ struct GNUNET_MessageHeader header;
/**
- * Flags for the record.
+ * Request ID in NBO
*/
- uint32_t flags;
+ uint32_t r_id GNUNET_PACKED;
};
-
/**
- * Connect to namestore service. FIXME: UNNECESSARY.
+ * Store a record to the namestore (as authority).
*/
-struct StartMessage
+struct RecordStoreMessage
{
-
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE
*/
- struct GNUNET_MessageHeader header;
-
-};
-
+ struct GNUNET_NAMESTORE_Header gns_header;
-/**
- * Generic namestore message with op id
- */
-struct GNUNET_NAMESTORE_Header
-{
/**
- * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_*
- * header.size will be message size
+ * Expiration time
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_TIME_AbsoluteNBO expire;
/**
- * Request ID in NBO
+ * Name length
*/
- uint32_t r_id;
-};
-
+ uint16_t name_len GNUNET_PACKED;
-/**
- * Lookup a name in the namestore
- */
-struct LookupNameMessage
-{
- struct GNUNET_NAMESTORE_Header gns_header;
+ /**
+ * Length of serialized record data
+ */
+ uint16_t rd_len GNUNET_PACKED;
/**
- * The zone
+ * Number of records contained
*/
- struct GNUNET_CRYPTO_ShortHashCode zone;
+ uint16_t rd_count GNUNET_PACKED;
/**
- * Requested record type
+ * always zero (for alignment)
*/
- uint32_t record_type;
+ uint16_t reserved GNUNET_PACKED;
/**
- * Length of the name
+ * The private key of the authority.
*/
- uint32_t name_len;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
- /* 0-terminated name here */
+ /* followed by:
+ * name with length name_len
+ * serialized record data with rd_count records
+ */
};
/**
- * Lookup response
+ * Response to a record storage request.
*/
-struct LookupNameResponseMessage
+struct RecordStoreResponseMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * Expiration time
+ * #GNUNET_SYSERR on failure, #GNUNET_OK on success
*/
- struct GNUNET_TIME_AbsoluteNBO expire;
-
-
- /**
- * Name length
- */
- uint16_t name_len;
+ int32_t op_result GNUNET_PACKED;
+};
- /**
- * Bytes of serialized record data
- */
- uint16_t rd_len;
+/**
+ * Lookup a label
+ */
+struct LabelLookupMessage
+{
/**
- * Number of records contained
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP
*/
- uint16_t rd_count;
+ struct GNUNET_NAMESTORE_Header gns_header;
/**
- * Is the signature valid
- * GNUNET_YES or GNUNET_NO
+ * Length of the name
*/
- int16_t contains_sig;
+ uint32_t label_len GNUNET_PACKED;
/**
- * All zeros if 'contains_sig' is GNUNET_NO.
+ * The private key of the zone to look up in
*/
- struct GNUNET_CRYPTO_EccSignature signature;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
- /**
- * The public key for the name
+ /* followed by:
+ * name with length name_len
*/
- struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key;
-
- /* 0-terminated name and serialized record data */
- /* rd_len bytes serialized record data */
};
/**
- * Put a record to the namestore
+ * Lookup a label
*/
-struct RecordPutMessage
+struct LabelLookupResponseMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_RECORD_PUT
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE
*/
struct GNUNET_NAMESTORE_Header gns_header;
- /**
- * Expiration time
- */
- struct GNUNET_TIME_AbsoluteNBO expire;
-
/**
* Name length
*/
- uint16_t name_len;
+ uint16_t name_len GNUNET_PACKED;
/**
* Length of serialized record data
*/
- uint16_t rd_len;
+ uint16_t rd_len GNUNET_PACKED;
/**
- * Number of records contained
+ * Number of records contained
*/
- uint16_t rd_count;
+ uint16_t rd_count GNUNET_PACKED;
/**
- * always zero (for alignment)
+ * Was the label found in the database??
+ * GNUNET_YES or GNUNET_NO
*/
- uint16_t reserved;
+ uint16_t found GNUNET_PACKED;
/**
- * The signature
+ * The private key of the authority.
*/
- struct GNUNET_CRYPTO_EccSignature signature;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
- /**
- * The public key
+ /* followed by:
+ * name with length name_len
+ * serialized record data with rd_count records
*/
- struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key;
-
- /* name (0-terminated) followed by "rd_count" serialized records */
-
};
+
/**
- * Put a record to the namestore response
+ * Lookup a name for a zone hash
*/
-struct RecordPutResponseMessage
+struct ZoneToNameMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * result:
- * GNUNET_SYSERR on failure
- * GNUNET_OK on success
+ * The private key of the zone to look up in
+ */
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
+
+ /**
+ * The public key of the target zone
*/
- int32_t op_result;
+ struct GNUNET_CRYPTO_EcdsaPublicKey value_zone;
};
/**
- * Create a record and put it to the namestore
- * Memory layout:
+ * Respone for zone to name lookup
*/
-struct RecordCreateMessage
+struct ZoneToNameResponseMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
*/
struct GNUNET_NAMESTORE_Header gns_header;
- struct GNUNET_TIME_AbsoluteNBO expire;
-
/**
- * Name length
+ * Length of the name
*/
- uint16_t name_len;
+ uint16_t name_len GNUNET_PACKED;
/**
* Length of serialized record data
*/
- uint16_t rd_len;
+ uint16_t rd_len GNUNET_PACKED;
/**
- * Record count
+ * Number of records contained
*/
- uint16_t rd_count;
+ uint16_t rd_count GNUNET_PACKED;
/**
- * private key length
+ * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no
+ * results, #GNUNET_SYSERR on error
*/
- uint16_t pkey_len;
-
- /* followed by:
- * GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded private key with length pkey_len
- * name with length name_len
- * serialized record data with length rd_len
- * */
-};
+ int16_t res GNUNET_PACKED;
-
-/**
- * Create a record to the namestore response
- */
-struct RecordCreateResponseMessage
-{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE_RESPONSE
+ * The private key of the zone that contained the name.
*/
- struct GNUNET_NAMESTORE_Header gns_header;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
- /**
- * name length: GNUNET_NO already exists, GNUNET_YES on success, GNUNET_SYSERR error
+ /* followed by:
+ * name with length name_len
+ * serialized record data with rd_count records
*/
- int32_t op_result;
+
};
/**
- * Lookup a name for a zone hash
+ * Record is returned from the namestore (as authority).
*/
-struct ZoneToNameMessage
+struct RecordResultMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * The hash of public key of the zone to look up in
+ * Name length
*/
- struct GNUNET_CRYPTO_ShortHashCode zone;
+ uint16_t name_len GNUNET_PACKED;
/**
- * The hash of the public key of the target zone
+ * Length of serialized record data
*/
- struct GNUNET_CRYPTO_ShortHashCode value_zone;
-};
+ uint16_t rd_len GNUNET_PACKED;
-/**
- * Respone for zone to name lookup
- */
-struct ZoneToNameResponseMessage
-{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
+ * Number of records contained
*/
- struct GNUNET_NAMESTORE_Header gns_header;
+ uint16_t rd_count GNUNET_PACKED;
/**
- * Record block expiration
+ * always zero (for alignment)
*/
- struct GNUNET_TIME_AbsoluteNBO expire;
+ uint16_t reserved GNUNET_PACKED;
/**
- * Length of the name
+ * The private key of the authority.
*/
- uint16_t name_len;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
- /**
- * Length of serialized record data
+ /* followed by:
+ * name with length name_len
+ * serialized record data with rd_count records
*/
- uint16_t rd_len;
+};
+
+/**
+ * Start monitoring a zone.
+ */
+struct ZoneMonitorStartMessage
+{
/**
- * Number of records contained
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
*/
- uint16_t rd_count;
-
- /* result in NBO: GNUNET_OK on success, GNUNET_NO if there were no results, GNUNET_SYSERR on error */
- int16_t res;
+ struct GNUNET_MessageHeader header;
/**
- * Signature
+ * #GNUNET_YES to first iterate over all records,
+ * #GNUNET_NO to only monitor changes.o
*/
- struct GNUNET_CRYPTO_EccSignature signature;
+ uint32_t iterate_first GNUNET_PACKED;
/**
- * Publik key
+ * Zone key.
*/
- struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded zone_key;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
};
-
/**
* Start a zone iteration for the given zone
*/
struct ZoneIterationStartMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * Zone hash
+ * Zone key. All zeros for "all zones".
*/
- struct GNUNET_CRYPTO_ShortHashCode zone;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
- /**
- * Which flags must be included
- */
- uint16_t must_have_flags;
-
- /**
- * Which flags must not be included
- */
- uint16_t must_not_have_flags;
};
struct ZoneIterationNextMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
*/
struct GNUNET_NAMESTORE_Header gns_header;
};
struct ZoneIterationStopMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
*/
struct GNUNET_NAMESTORE_Header gns_header;
};
-/**
- * Next result of zone iteration for the given operation
- * // FIXME: use 'struct LookupResponseMessage' instead? (identical except
- * for having 'contains_sig' instead of 'reserved', but fully compatible otherwise).
- */
-struct ZoneIterationResponseMessage
-{
- /**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_RESPONSE
- */
- struct GNUNET_NAMESTORE_Header gns_header;
-
- struct GNUNET_TIME_AbsoluteNBO expire;
-
- uint16_t name_len;
-
- /* Record data length */
- uint16_t rd_len;
-
- /**
- * Number of records contained
- */
- uint16_t rd_count;
-
- /**
- * always zero (for alignment)
- */
- uint16_t reserved;
-
- /**
- * All zeros if 'contains_sig' is GNUNET_NO.
- */
- struct GNUNET_CRYPTO_EccSignature signature;
- /**
- * The public key
- */
- struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key;
-
-
-
-};
GNUNET_NETWORK_STRUCT_END
projects / oweals / gnunet.git / blobdiff