X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=ec7f2870401b8a78acc83b483c03d7d1d4a0a29b;hb=90c803401e6dbe336c6469ff874b0005e7a2f163;hp=c8353e83b5cf5c39b3381cc3e4feed012441d119;hpb=206054928a4b151286d4af3eba3665b2b4d24155;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index c8353e83b..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,356 +14,352 @@ 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 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_RESPONSE 440 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT 441 -#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP 442 - +#define MAX_NAME_LEN 256 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. + * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_* + * header.size will be message size */ - struct GNUNET_TIME_AbsoluteNBO expiration; + struct GNUNET_MessageHeader header; /** - * Number of bytes in 'data'. + * Request ID in NBO */ - uint32_t data_size; + uint32_t r_id GNUNET_PACKED; +}; + +/** + * Store a record to the namestore (as authority). + */ +struct RecordStoreMessage +{ /** - * Type of the GNS/DNS record. + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE */ - uint32_t record_type; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Flags for the record. + * Expiration time */ - uint32_t flags; -}; - - + struct GNUNET_TIME_AbsoluteNBO expire; -/** - * Connect to namestore service. FIXME: UNNECESSARY. - */ -struct StartMessage -{ + /** + * Name length + */ + uint16_t name_len GNUNET_PACKED; /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START + * Length of serialized record data */ - struct GNUNET_MessageHeader header; + uint16_t rd_len GNUNET_PACKED; -}; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; -/** - * Generic namestore message with op id - */ -struct GNUNET_NAMESTORE_Header -{ /** - * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_* - * header.size will be message size + * always zero (for alignment) */ - struct GNUNET_MessageHeader header; + uint16_t reserved GNUNET_PACKED; /** - * Request ID in NBO + * 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 r_id; }; /** - * Connect to namestore service + * Response to a record storage request. */ -struct LookupNameMessage +struct RecordStoreResponseMessage { + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE + */ struct GNUNET_NAMESTORE_Header gns_header; - /* The zone */ - GNUNET_HashCode zone; - - /* Requested record type */ - uint32_t record_type; - - /* Requested record type */ - uint32_t name_len; + /** + * #GNUNET_SYSERR on failure, #GNUNET_OK on success + */ + int32_t op_result GNUNET_PACKED; }; /** - * 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 */ -struct LookupNameResponseMessage +struct LabelLookupMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP */ struct GNUNET_NAMESTORE_Header gns_header; - struct GNUNET_TIME_AbsoluteNBO expire; - - uint16_t name_len; - - uint16_t rd_len; - - uint16_t rd_count; + /** + * Length of the name + */ + uint32_t label_len GNUNET_PACKED; - int32_t contains_sig; + /** + * The private key of the zone to look up in + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /* Requested record type */ + /* followed by: + * name with length name_len + */ }; /** - * Put a record to the namestore - * Memory layout: - * [struct RecordPutMessage][struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData] + * 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; - /* Contenct starts here */ - - /* name length */ - uint16_t name_len; + /** + * Name length + */ + uint16_t name_len GNUNET_PACKED; - /* Length of serialized rd data */ - uint16_t rd_len; + /** + * Length of serialized record data + */ + uint16_t rd_len GNUNET_PACKED; - uint16_t rd_count; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; - /* Length of pubkey */ - uint16_t key_len; + /** + * Was the label found in the database?? + * GNUNET_YES or GNUNET_NO + */ + uint16_t found GNUNET_PACKED; - struct GNUNET_TIME_AbsoluteNBO expire; + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; - struct GNUNET_CRYPTO_RsaSignature signature; + /* followed by: + * name with length name_len + * serialized record data with rd_count 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_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_EcdsaPrivateKey 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_EcdsaPublicKey value_zone; }; /** - * Create a record and put it to the namestore - * Memory layout: - * [struct RecordCreateMessage][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData] + * 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; - /* Contenct starts here */ + /** + * Length of the name + */ + uint16_t name_len GNUNET_PACKED; - /* name length */ - uint16_t name_len; + /** + * Length of serialized record data + */ + uint16_t rd_len GNUNET_PACKED; - /* Record data length */ - uint16_t rd_len; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; - /* Record count */ - 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 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 + */ - /* private key length */ - uint16_t pkey_len; }; /** - * Create a record to the namestore response - * Memory layout: + * Record is returned from the namestore (as authority). */ -struct RecordCreateResponseMessage +struct RecordResultMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT */ struct GNUNET_NAMESTORE_Header gns_header; - /* Contenct starts here */ - /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * Name length */ - uint16_t op_result; + uint16_t name_len GNUNET_PACKED; + /** + * Length of serialized record data + */ + uint16_t rd_len GNUNET_PACKED; -}; - -/** - * Remove a record from the namestore - * Memory layout: - * [struct RecordRemoveMessage][char *name][struct GNUNET_NAMESTORE_RecordData] - */ -struct RecordRemoveMessage -{ /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE + * Number of records contained */ - struct GNUNET_NAMESTORE_Header gns_header; + uint16_t rd_count GNUNET_PACKED; - /* Contenct starts here */ + /** + * always zero (for alignment) + */ + uint16_t reserved GNUNET_PACKED; - /* name length */ - uint16_t name_len; + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; - struct GNUNET_CRYPTO_RsaSignature signature; + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ }; -GNUNET_NETWORK_STRUCT_END /** - * Remove a record from the namestore response + * Start monitoring a zone. */ -GNUNET_NETWORK_STRUCT_BEGIN -struct RecordRemoveResponseMessage +struct ZoneMonitorStartMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START */ - struct GNUNET_NAMESTORE_Header gns_header; + struct GNUNET_MessageHeader header; - /* Contenct starts here */ + /** + * #GNUNET_YES to first iterate over all records, + * #GNUNET_NO to only monitor changes.o + */ + uint32_t iterate_first GNUNET_PACKED; /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * Zone key. */ - uint16_t op_result; + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; + }; -GNUNET_NETWORK_STRUCT_END /** * Start a zone iteration for the given zone */ -GNUNET_NETWORK_STRUCT_BEGIN 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; - /* Contenct starts here */ - - uint16_t must_have_flags; - uint16_t must_not_have_flags; + /** + * Zone key. All zeros for "all zones". + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - GNUNET_HashCode zone; }; -GNUNET_NETWORK_STRUCT_END + /** * Ask for next result of zone iteration for the given operation */ -GNUNET_NETWORK_STRUCT_BEGIN 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; }; -GNUNET_NETWORK_STRUCT_END /** * Stop zone iteration for the given operation */ -GNUNET_NETWORK_STRUCT_BEGIN 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; }; -GNUNET_NETWORK_STRUCT_END - -/** - * Ask for next result of zone iteration for the given operation - */ -GNUNET_NETWORK_STRUCT_BEGIN -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; - uint16_t contains_sig; - /* Record data length */ - uint16_t rd_len; - -}; GNUNET_NETWORK_STRUCT_END