/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ (C) 2011-2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @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.
+ * Lookup a block in the namestore
*/
-struct StartMessage
+struct LookupBlockMessage
{
-
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK
*/
- 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
+ * The query.
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_HashCode query GNUNET_PACKED;
- /**
- * Request ID in NBO
- */
- uint32_t r_id;
};
/**
- * Lookup a name in the namestore
+ * Lookup response
*/
-struct LookupNameMessage
+struct LookupBlockResponseMessage
{
+ /**
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE
+ */
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * The zone
+ * Expiration time
*/
- struct GNUNET_CRYPTO_ShortHashCode zone;
+ struct GNUNET_TIME_AbsoluteNBO expire;
/**
- * Requested record type
+ * Signature.
*/
- uint32_t record_type;
+ struct GNUNET_CRYPTO_EcdsaSignature signature;
/**
- * Length of the name
+ * Derived public key.
*/
- uint32_t name_len;
+ struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
- /* 0-terminated name here */
+ /* followed by encrypted block data */
};
/**
- * Lookup response
+ * Cache a record in the namestore.
*/
-struct LookupNameResponseMessage
+struct BlockCacheMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE
*/
struct GNUNET_NAMESTORE_Header gns_header;
struct GNUNET_TIME_AbsoluteNBO expire;
/**
- * Name length
+ * Signature.
*/
- uint16_t name_len;
+ struct GNUNET_CRYPTO_EcdsaSignature signature;
/**
- * Bytes of serialized record data
+ * Derived public key.
*/
- uint16_t rd_len;
+ struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
- /**
- * Number of records contained
- */
- uint16_t rd_count;
+ /* follwed by encrypted block data */
+};
- /**
- * Is the signature valid
- * GNUNET_YES or GNUNET_NO
- */
- int16_t contains_sig;
+/**
+ * Response to a request to cache a block.
+ */
+struct BlockCacheResponseMessage
+{
/**
- * All zeros if 'contains_sig' is GNUNET_NO.
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE
*/
- struct GNUNET_CRYPTO_EccSignature signature;
+ struct GNUNET_NAMESTORE_Header gns_header;
/**
- * The public key for the name
+ * #GNUNET_OK on success, #GNUNET_SYSERR error
*/
- struct GNUNET_CRYPTO_EccPublicKey public_key;
-
- /* 0-terminated name and serialized record data */
- /* rd_len bytes serialized record data */
+ int32_t op_result GNUNET_PACKED;
};
/**
- * Put a record to the namestore
+ * Store a record to the namestore (as authority).
*/
-struct RecordPutMessage
+struct RecordStoreMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_RECORD_PUT
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
* 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)
*/
- uint16_t reserved;
+ uint16_t reserved 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_EccPublicKey public_key;
-
- /* name (0-terminated) followed by "rd_count" serialized records */
-
};
/**
- * Put a record to the namestore response
+ * Response to a record storage request.
*/
-struct RecordPutResponseMessage
+struct RecordStoreResponseMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * result:
- * GNUNET_SYSERR on failure
- * GNUNET_OK on success
+ * #GNUNET_SYSERR on failure, #GNUNET_OK on success
*/
- int32_t op_result;
+ int32_t op_result GNUNET_PACKED;
};
/**
- * Create a record and put it to the namestore
- * Memory layout:
+ * Lookup a label
*/
-struct RecordCreateMessage
+struct LabelLookupMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP
*/
struct GNUNET_NAMESTORE_Header gns_header;
- struct GNUNET_TIME_AbsoluteNBO expire;
-
/**
- * Name length
- */
- uint16_t name_len;
-
- /**
- * Length of serialized record data
- */
- uint16_t rd_len;
-
- /**
- * Record count
+ * Length of the name
*/
- uint16_t rd_count;
+ uint32_t label_len GNUNET_PACKED;
/**
- * always zero
+ * The private key of the zone to look up in
*/
- uint16_t reserved;
-
- struct GNUNET_CRYPTO_EccPrivateKey private_key;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
/* followed by:
* name with length name_len
- * serialized record data with length rd_len
*/
};
+
+
/**
- * Create a record to the namestore response
+ * Lookup a name for a zone hash
*/
-struct RecordCreateResponseMessage
+struct ZoneToNameMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE_RESPONSE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * name length: GNUNET_NO already exists, GNUNET_YES on success, GNUNET_SYSERR error
+ * The private key of the zone to look up in
*/
- int32_t op_result;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
+
+ /**
+ * The public key of the target zone
+ */
+ struct GNUNET_CRYPTO_EcdsaPublicKey value_zone;
};
/**
- * Lookup a name for a zone hash
+ * Respone for zone to name lookup
*/
-struct ZoneToNameMessage
+struct ZoneToNameResponseMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * The hash of public key of the zone to look up in
+ * Length of the name
+ */
+ uint16_t name_len GNUNET_PACKED;
+
+ /**
+ * Length of serialized record data
+ */
+ uint16_t rd_len GNUNET_PACKED;
+
+ /**
+ * Number of records contained
+ */
+ uint16_t rd_count GNUNET_PACKED;
+
+ /**
+ * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no
+ * results, #GNUNET_SYSERR on error
*/
- struct GNUNET_CRYPTO_ShortHashCode zone;
+ int16_t res GNUNET_PACKED;
/**
- * The hash of the public key of the target zone
+ * The private key of the zone that contained the name.
+ */
+ struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
+
+ /* followed by:
+ * name with length name_len
+ * serialized record data with rd_count records
*/
- struct GNUNET_CRYPTO_ShortHashCode value_zone;
+
};
/**
- * Respone for zone to name lookup
+ * Record is returned from the namestore (as authority).
*/
-struct ZoneToNameResponseMessage
+struct RecordResultMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * Record block expiration
- */
- struct GNUNET_TIME_AbsoluteNBO expire;
-
- /**
- * Length of the name
+ * 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
*/
- uint16_t rd_count;
+ uint16_t rd_count GNUNET_PACKED;
/**
- * result in NBO: GNUNET_OK on success, GNUNET_NO if there were no
- * results, GNUNET_SYSERR on error
+ * always zero (for alignment)
*/
- int16_t res;
+ uint16_t reserved GNUNET_PACKED;
/**
- * Signature
+ * The private key of the authority.
*/
- struct GNUNET_CRYPTO_EccSignature signature;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
- /**
- * Publik key
+ /* followed by:
+ * name with length name_len
+ * serialized record data with rd_count records
*/
- struct GNUNET_CRYPTO_EccPublicKey zone_key;
-
};
struct ZoneMonitorStartMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
+ * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
*/
- struct GNUNET_NAMESTORE_Header gns_header;
+ struct GNUNET_MessageHeader header;
/**
- * Zone hash
+ * #GNUNET_YES to first iterate over all records,
+ * #GNUNET_NO to only monitor changes.o
*/
- struct GNUNET_CRYPTO_ShortHashCode zone;
+ uint32_t iterate_first GNUNET_PACKED;
/**
- * All zones. GNUNET_YES to monitor all zones,
- * GNUNET_NO to only monitor 'zone'. In NBO.
+ * Zone key.
*/
- uint32_t all_zones GNUNET_PACKED;
+ struct GNUNET_CRYPTO_EcdsaPrivateKey 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;
};
projects / oweals / gnunet.git / blobdiff