X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=7d406df61d56be3c0124da9736c05e9bcbb4407c;hb=dc40d894157a9eeee4c72f8cb974fd48e1a98a1b;hp=d2c026e7a351ce98147602c62d0037f6eab4c3ea;hpb=70657f072f1213e2f02a21040b9eeda8e0e36c1e;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index d2c026e7a..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,364 +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 GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE 432 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT 433 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE 434 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE 435 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE_RESPONSE 436 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE 437 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE_RESPONSE 438 - -#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START 439 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT 439 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP 439 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_RESPONSE 439 +#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 /** - * Generic namestore message with op id + * Lookup a block in the namestore */ -struct GenericMessage +struct LookupBlockMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_* + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * The query. */ - uint32_t op_id; + struct GNUNET_HashCode query; + }; -GNUNET_NETWORK_STRUCT_END /** - * Connect to namestore service + * Lookup response */ -GNUNET_NETWORK_STRUCT_BEGIN -struct LookupNameMessage +struct LookupBlockResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME + * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * Expiration time */ - uint32_t op_id; + struct GNUNET_TIME_AbsoluteNBO expire; - /* The zone */ - GNUNET_HashCode zone; + /** + * Signature. + */ + struct GNUNET_CRYPTO_EccSignature signature; - /* Requested record type */ - uint32_t record_type; + /** + * Derived public key. + */ + struct GNUNET_CRYPTO_EccPublicKey derived_key; - /* Requested record type */ - uint32_t name_len; + /* follwed by encrypted block data */ }; -GNUNET_NETWORK_STRUCT_END /** - * Lookup response - * Memory layout: - * [struct LookupNameResponseMessage][struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData][struct GNUNET_CRYPTO_RsaSignature] + * Cache a record in the namestore. */ -GNUNET_NETWORK_STRUCT_BEGIN -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_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * Expiration time */ - uint32_t op_id; - struct GNUNET_TIME_AbsoluteNBO expire; - uint16_t name_len; + /** + * Signature. + */ + struct GNUNET_CRYPTO_EccSignature signature; - uint16_t contains_sig; + /** + * Derived public key. + */ + struct GNUNET_CRYPTO_EccPublicKey derived_key; - /* Requested record type */ - uint32_t rc_count; + /* follwed by encrypted block data */ }; -GNUNET_NETWORK_STRUCT_END /** - * Put a record to the namestore - * Memory layout: - * [struct RecordPutMessage][struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData] + * Response to a request to cache a block. */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordPutMessage +struct BlockCacheResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_RECORD_PUT + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * #GNUNET_OK on success, #GNUNET_SYSERR error */ - uint32_t op_id; - - /* Contenct starts here */ + int32_t op_result; +}; - /* name length */ - uint16_t name_len; - /* Requested record type */ - uint32_t rd_count; +/** + * 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; - struct GNUNET_CRYPTO_RsaSignature signature; -}; -GNUNET_NETWORK_STRUCT_END + /** + * Name length + */ + uint16_t name_len; -/** - * Put a record to the namestore response - */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordPutResponseMessage -{ /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE + * Length of serialized record data */ - struct GNUNET_MessageHeader header; + uint16_t rd_len; /** - * Operation ID in NBO + * Number of records contained */ - uint32_t op_id; + uint16_t rd_count; - /* Contenct starts here */ + /** + * always zero (for alignment) + */ + uint16_t reserved; /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * 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 */ - uint16_t op_result; }; -GNUNET_NETWORK_STRUCT_END /** - * Put a record to the namestore - * Memory layout: - * [struct RecordPutMessage][struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData] + * Response to a record storage request. */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordCreateMessage +struct RecordStoreResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * #GNUNET_SYSERR on failure, #GNUNET_OK on success */ - uint32_t op_id; - - /* Contenct starts here */ - - /* name length */ - uint16_t name_len; - - struct GNUNET_CRYPTO_RsaSignature signature; + int32_t op_result; }; -GNUNET_NETWORK_STRUCT_END + /** - * Create a record to the namestore response - * Memory layout: + * Lookup a name for a zone hash */ -GNUNET_NETWORK_STRUCT_BEGIN -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_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * The private key of the zone to look up in */ - uint32_t op_id; - - /* Contenct starts here */ + struct GNUNET_CRYPTO_EccPrivateKey zone; /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * The public key of the target zone */ - uint16_t op_result; + struct GNUNET_CRYPTO_EccPublicKey value_zone; }; -GNUNET_NETWORK_STRUCT_END + /** - * Remove a record from the namestore - * Memory layout: - * [struct RecordRemoveMessage][char *name][struct GNUNET_NAMESTORE_RecordData] + * Respone for zone to name lookup */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordRemoveMessage +struct ZoneToNameResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * Length of the name */ - uint32_t op_id; - - /* Contenct starts here */ - - /* name length */ uint16_t name_len; - struct GNUNET_CRYPTO_RsaSignature signature; -}; -GNUNET_NETWORK_STRUCT_END - - -/** - * Remove a record from the namestore response - */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordRemoveResponseMessage -{ /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE_RESPONSE + * Length of serialized record data */ - struct GNUNET_MessageHeader header; + uint16_t rd_len; /** - * Operation ID in NBO + * Number of records contained */ - uint32_t op_id; + uint16_t rd_count; - /* Contenct starts here */ + /** + * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no + * results, #GNUNET_SYSERR on error + */ + int16_t res; /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * The private key of the zone that contained the name. */ - uint16_t op_result; + struct GNUNET_CRYPTO_EccPrivateKey zone; + + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ + }; -GNUNET_NETWORK_STRUCT_END /** - * Start a zone iteration for the given zone + * Record is returned from the namestore (as authority). */ -GNUNET_NETWORK_STRUCT_BEGIN -struct ZoneIterationStartMessage +struct RecordResultMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Name length + */ + uint16_t name_len; + + /** + * Length of serialized record data + */ + uint16_t rd_len; /** - * Operation ID in NBO + * Number of records contained */ - uint32_t op_id; + uint16_t rd_count; - /* Contenct starts here */ + /** + * always zero (for alignment) + */ + uint16_t reserved; - uint16_t must_have_flags; - uint16_t must_not_have_flags; + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EccPrivateKey private_key; - GNUNET_HashCode zone; + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ }; -GNUNET_NETWORK_STRUCT_END + /** - * Ask for next result of zone iteration for the given operation + * Start monitoring a zone. */ -GNUNET_NETWORK_STRUCT_BEGIN -struct ZoneIterationNextMessage +struct ZoneMonitorStartMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * Zone key. */ - uint32_t op_id; + struct GNUNET_CRYPTO_EccPrivateKey zone; + }; -GNUNET_NETWORK_STRUCT_END /** - * Stop zone iteration for the given operation + * Start a zone iteration for the given zone */ -GNUNET_NETWORK_STRUCT_BEGIN -struct ZoneIterationStopMessage +struct ZoneIterationStartMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * Zone key. All zeros for "all zones". */ - uint32_t op_id; + struct GNUNET_CRYPTO_EccPrivateKey zone; + }; -GNUNET_NETWORK_STRUCT_END + /** * Ask for next result of zone iteration for the given operation */ -GNUNET_NETWORK_STRUCT_BEGIN -struct ZoneIterationResponseMessage +struct ZoneIterationNextMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; +}; + +/** + * Stop zone iteration for the given operation + */ +struct ZoneIterationStopMessage +{ /** - * Operation ID in NBO + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP */ - uint32_t op_id; + struct GNUNET_NAMESTORE_Header gns_header; }; + + GNUNET_NETWORK_STRUCT_END