X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=ec7f2870401b8a78acc83b483c03d7d1d4a0a29b;hb=90c803401e6dbe336c6469ff874b0005e7a2f163;hp=03b4bb45a75f46c1be97b49071ba4446ab03bde6;hpb=11e0d70c68bdec7df62a1118ce346fc8ec629c4a;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index 03b4bb45a..ec7f28704 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) + 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 @@ -14,179 +14,354 @@ 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 -/* - * 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 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_PACKED; }; -GNUNET_NETWORK_STRUCT_END -GNUNET_NETWORK_STRUCT_BEGIN /** - * Generic namestore message with op id + * Store a record to the namestore (as authority). */ -struct GenericMessage +struct RecordStoreMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_* + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Expiration time + */ + struct GNUNET_TIME_AbsoluteNBO expire; /** - * Operation ID in NBO + * Name length + */ + 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; + + /** + * always zero (for alignment) + */ + uint16_t reserved GNUNET_PACKED; + + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; + + /* followed by: + * name with length name_len + * serialized record data with rd_count records */ - uint32_t op_id; }; -GNUNET_NETWORK_STRUCT_END /** - * Connect to namestore service + * Response to a record storage request. */ -GNUNET_NETWORK_STRUCT_BEGIN -struct LookupNameMessage +struct RecordStoreResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * #GNUNET_SYSERR on failure, #GNUNET_OK on success + */ + int32_t op_result GNUNET_PACKED; +}; + +/** + * Lookup a label + */ +struct LabelLookupMessage +{ /** - * Operation ID in NBO + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP */ - uint32_t op_id; + struct GNUNET_NAMESTORE_Header gns_header; - /* The zone */ - GNUNET_HashCode zone; + /** + * Length of the name + */ + uint32_t label_len GNUNET_PACKED; - /* Requested record type */ - uint32_t record_type; + /** + * The private key of the zone to look up in + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /* Requested record type */ - uint32_t name_len; + /* followed by: + * name with length name_len + */ }; -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] + * Lookup a label */ -GNUNET_NETWORK_STRUCT_BEGIN -struct LookupNameResponseMessage +struct LabelLookupResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Operation ID in NBO + * Name length */ - uint32_t op_id; + uint16_t name_len GNUNET_PACKED; - struct GNUNET_TIME_AbsoluteNBO expire; + /** + * Length of serialized record data + */ + uint16_t rd_len GNUNET_PACKED; - uint16_t name_len; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; - uint16_t contains_sig; + /** + * Was the label found in the database?? + * GNUNET_YES or GNUNET_NO + */ + uint16_t found GNUNET_PACKED; - /* Requested record type */ - uint32_t rc_count; + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; + + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ }; -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] + * Lookup a name for a zone hash */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordPutMessage +struct ZoneToNameMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_RECORD_PUT + * 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; + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /* Contenct starts here */ + /** + * The public key of the target zone + */ + struct GNUNET_CRYPTO_EcdsaPublicKey value_zone; +}; - /* name length */ - uint16_t name_len; - /* Requested record type */ - uint32_t rd_count; +/** + * 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; - struct GNUNET_TIME_AbsoluteNBO expire; + /** + * 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 + */ + int16_t res GNUNET_PACKED; + + /** + * 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_RsaSignature signature; }; -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] + * Record is returned from the namestore (as authority). */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordPutResponseMessage +struct RecordResultMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Name length + */ + 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; + + /** + * always zero (for alignment) + */ + uint16_t reserved GNUNET_PACKED; + + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey 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_MessageHeader header; /** - * Operation ID in NBO + * #GNUNET_YES to first iterate over all records, + * #GNUNET_NO to only monitor changes.o */ - uint32_t op_id; + uint32_t iterate_first GNUNET_PACKED; + + /** + * Zone key. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; + +}; - /* Contenct starts here */ +/** + * Start a zone iteration for the given zone + */ +struct ZoneIterationStartMessage +{ /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START */ - uint16_t op_result; + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Zone key. All zeros for "all zones". + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; + }; -GNUNET_NETWORK_STRUCT_END +/** + * 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 + /* end of namestore.h */ #endif