X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=ec7f2870401b8a78acc83b483c03d7d1d4a0a29b;hb=90c803401e6dbe336c6469ff874b0005e7a2f163;hp=98a9c5cd1ba5921c0bd43eed24546f86772d6f8b;hpb=9121b5fdbb38b5ee48695edf5c45bfca1eeb0a29;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index 98a9c5cd1..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,372 +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 MAX_NAME_LEN 256 -#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 +GNUNET_NETWORK_STRUCT_BEGIN +/** + * Generic namestore message with op id + */ +struct GNUNET_NAMESTORE_Header +{ + /** + * 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; +}; -struct GNUNET_CRYPTO_RsaSignature * -GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key, const char *name, struct GNUNET_NAMESTORE_RecordData *rd, unsigned int rd_count); -GNUNET_NETWORK_STRUCT_BEGIN /** - * A GNS record serialized for network transmission. - * layout is [struct GNUNET_NAMESTORE_NetworkRecord][char[data_size] data] + * Store a record to the namestore (as authority). */ -struct GNUNET_NAMESTORE_NetworkRecord +struct RecordStoreMessage { /** - * Expiration time for the DNS record. + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE */ - struct GNUNET_TIME_AbsoluteNBO expiration; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Number of bytes in 'data'. + * Expiration time */ - uint32_t data_size; + struct GNUNET_TIME_AbsoluteNBO expire; /** - * Type of the GNS/DNS record. + * Name length */ - uint32_t record_type; + uint16_t name_len GNUNET_PACKED; /** - * Flags for the record. + * Length of serialized record data */ - uint32_t flags; -}; - + uint16_t rd_len GNUNET_PACKED; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; -/** - * Connect to namestore service. FIXME: UNNECESSARY. - */ -struct StartMessage -{ + /** + * always zero (for alignment) + */ + uint16_t reserved GNUNET_PACKED; /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START + * The private key of the authority. */ - struct GNUNET_MessageHeader header; + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ }; + /** - * Generic namestore message with op id + * Response to a record storage request. */ -struct GNUNET_NAMESTORE_Header +struct RecordStoreResponseMessage { /** - * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_* - * header.size will be message size + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE */ - struct GNUNET_MessageHeader header; + struct GNUNET_NAMESTORE_Header gns_header; /** - * Request ID in NBO + * #GNUNET_SYSERR on failure, #GNUNET_OK on success */ - uint32_t r_id; + int32_t op_result GNUNET_PACKED; }; /** - * Connect to namestore service + * Lookup a label */ -struct LookupNameMessage +struct LabelLookupMessage { + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP + */ 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 + */ }; /** - * 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 LabelLookupResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE */ struct GNUNET_NAMESTORE_Header gns_header; - struct GNUNET_TIME_AbsoluteNBO expire; + /** + * Name length + */ + uint16_t name_len GNUNET_PACKED; - uint16_t name_len; + /** + * Length of serialized record data + */ + uint16_t rd_len GNUNET_PACKED; - uint16_t rd_len; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; - uint16_t rd_count; + /** + * Was the label found in the database?? + * GNUNET_YES or GNUNET_NO + */ + uint16_t found GNUNET_PACKED; - int32_t contains_sig; + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; - /* Requested record type */ + /* followed by: + * name with length name_len + * serialized record data with rd_count records + */ }; + /** - * 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 */ -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_NAMESTORE_Header gns_header; - /* Contenct starts here */ - - /* name length */ - uint16_t name_len; - - /* Length of serialized rd data */ - uint16_t rd_len; - - /* Number of records contained */ - uint16_t rd_count; - - /* Length of pubkey */ - uint16_t key_len; - - struct GNUNET_TIME_AbsoluteNBO expire; + /** + * The private key of the zone to look up in + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - struct GNUNET_CRYPTO_RsaSignature signature; + /** + * The public key of the target zone + */ + struct GNUNET_CRYPTO_EcdsaPublicKey value_zone; }; /** - * Put a record to the namestore response + * Respone for zone to name lookup */ -struct RecordPutResponseMessage +struct ZoneToNameResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE + * 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 */ + uint16_t name_len GNUNET_PACKED; /** - * name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success + * Length of serialized record data */ - uint16_t op_result; -}; + uint16_t rd_len GNUNET_PACKED; - -/** - * Create a record and put it to the namestore - * Memory layout: - * [struct RecordCreateMessage][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData] - */ -struct RecordCreateMessage -{ /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE + * Number of records contained */ - struct GNUNET_NAMESTORE_Header gns_header; - - /* Contenct starts here */ + uint16_t rd_count GNUNET_PACKED; - /* name length */ - uint16_t name_len; + /** + * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no + * results, #GNUNET_SYSERR on error + */ + int16_t res GNUNET_PACKED; - /* Record data length */ - uint16_t rd_len; + /** + * The private key of the zone that contained the name. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /* Record count */ - uint16_t rd_count; + /* 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; -/** - * 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 + * Length of serialized record data */ - struct GNUNET_NAMESTORE_Header gns_header; - - /* Contenct starts here */ + uint16_t rd_len GNUNET_PACKED; - /* Name length */ - uint16_t name_len; + /** + * Number of records contained + */ + uint16_t rd_count GNUNET_PACKED; - /* Length of serialized rd data */ - uint16_t rd_len; + /** + * always zero (for alignment) + */ + uint16_t reserved GNUNET_PACKED; - /* Number of records contained */ - uint16_t rd_count; + /** + * The private key of the authority. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; - /* Length of pubkey */ - uint16_t key_len; + /* 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; /** - * result: - * 0 : successful - * 1 : no records for entry - * 2 : Could not find record to remove - * 3 : Failed to create new signature - * 4 : Failed to put new set of records in database + * 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