X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=7d406df61d56be3c0124da9736c05e9bcbb4407c;hb=dc40d894157a9eeee4c72f8cb974fd48e1a98a1b;hp=d469ac836db8270e56046f04087ec0dc6e0c5467;hpb=3a04f1fdf2882b96608e164babcd34dbcb2ad777;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index d469ac836..7d406df61 100644 --- a/src/namestore/namestore.h +++ b/src/namestore/namestore.h @@ -1,6 +1,6 @@ /* 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 @@ -22,43 +22,362 @@ * @file namestore/namestore.h * @brief common internal definitions for namestore service * @author Matthias Wachs + * @author Christian Grothoff */ #ifndef NAMESTORE_H #define NAMESTORE_H -/* - * Collect message types here, move to protocols later +/** + * Maximum length of any name, including 0-termination. */ -#define GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME 431 +#define MAX_NAME_LEN 256 GNUNET_NETWORK_STRUCT_BEGIN + /** - * Connect to namestore service + * Generic namestore message with op id */ -struct StartMessage +struct GNUNET_NAMESTORE_Header { - /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START + * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_* + * header.size will be message size */ struct GNUNET_MessageHeader header; + /** + * Request ID in NBO + */ + uint32_t r_id; }; -GNUNET_NETWORK_STRUCT_END -GNUNET_NETWORK_STRUCT_BEGIN + /** - * Connect to namestore service + * Lookup a block in the namestore */ -struct LookupNameMessage +struct LookupBlockMessage { + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK + */ + struct GNUNET_NAMESTORE_Header gns_header; /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME + * The query. + */ + struct GNUNET_HashCode query; + +}; + + +/** + * Lookup response + */ +struct LookupBlockResponseMessage +{ + /** + * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Expiration time + */ + struct GNUNET_TIME_AbsoluteNBO expire; + + /** + * Signature. + */ + struct GNUNET_CRYPTO_EccSignature signature; + + /** + * Derived public key. + */ + struct GNUNET_CRYPTO_EccPublicKey derived_key; + + /* follwed by encrypted block data */ +}; + + +/** + * Cache a record in the namestore. + */ +struct BlockCacheMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Expiration time + */ + struct GNUNET_TIME_AbsoluteNBO expire; + + /** + * Signature. + */ + struct GNUNET_CRYPTO_EccSignature signature; + + /** + * Derived public key. + */ + struct GNUNET_CRYPTO_EccPublicKey derived_key; + + /* follwed by encrypted block data */ +}; + + +/** + * Response to a request to cache a block. + */ +struct BlockCacheResponseMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * #GNUNET_OK on success, #GNUNET_SYSERR error + */ + int32_t op_result; +}; + + +/** + * Store a record to the namestore (as authority). + */ +struct RecordStoreMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Expiration time + */ + struct GNUNET_TIME_AbsoluteNBO expire; + + /** + * Name length + */ + uint16_t name_len; + + /** + * Length of serialized record data + */ + uint16_t rd_len; + + /** + * Number of records contained + */ + uint16_t rd_count; + + /** + * always zero (for alignment) + */ + uint16_t reserved; + + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EccPrivateKey private_key; + + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ +}; + + +/** + * Response to a record storage request. + */ +struct RecordStoreResponseMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * #GNUNET_SYSERR on failure, #GNUNET_OK on success + */ + int32_t op_result; +}; + + + +/** + * Lookup a name for a zone hash + */ +struct ZoneToNameMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * The private key of the zone to look up in + */ + struct GNUNET_CRYPTO_EccPrivateKey zone; + + /** + * The public key of the target zone + */ + struct GNUNET_CRYPTO_EccPublicKey value_zone; +}; + + +/** + * Respone for zone to name lookup + */ +struct ZoneToNameResponseMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Length of the name + */ + uint16_t name_len; + + /** + * Length of serialized record data + */ + uint16_t rd_len; + + /** + * Number of records contained + */ + 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; + + /** + * The private key of the zone that contained the name. + */ + struct GNUNET_CRYPTO_EccPrivateKey zone; + + /* followed by: + * name with length name_len + * serialized record data with rd_count records */ - struct GNUNET_MessageHeader header; }; + + +/** + * Record is returned from the namestore (as authority). + */ +struct RecordResultMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Name length + */ + uint16_t name_len; + + /** + * Length of serialized record data + */ + uint16_t rd_len; + + /** + * Number of records contained + */ + uint16_t rd_count; + + /** + * always zero (for alignment) + */ + uint16_t reserved; + + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EccPrivateKey private_key; + + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ +}; + + +/** + * Start monitoring a zone. + */ +struct ZoneMonitorStartMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Zone key. + */ + struct GNUNET_CRYPTO_EccPrivateKey zone; + +}; + + +/** + * Start a zone iteration for the given zone + */ +struct ZoneIterationStartMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Zone key. All zeros for "all zones". + */ + struct GNUNET_CRYPTO_EccPrivateKey zone; + +}; + + +/** + * Ask for next result of zone iteration for the given operation + */ +struct ZoneIterationNextMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT + */ + struct GNUNET_NAMESTORE_Header gns_header; +}; + + +/** + * Stop zone iteration for the given operation + */ +struct ZoneIterationStopMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP + */ + struct GNUNET_NAMESTORE_Header gns_header; +}; + + GNUNET_NETWORK_STRUCT_END