X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=ec7f2870401b8a78acc83b483c03d7d1d4a0a29b;hb=90c803401e6dbe336c6469ff874b0005e7a2f163;hp=4266a32c7815bb5218b7ec601c0f1f8bf6d679cd;hpb=75571213d264a51d6b7136cb4748db66f587d008;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index 4266a32c7..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,33 +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 +/** + * Maximum length of any name, including 0-termination. + */ +#define MAX_NAME_LEN 256 + 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; +}; + + +/** + * 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 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 + */ +}; + + +/** + * 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 GNUNET_PACKED; +}; + + +/** + * Lookup a label + */ +struct LabelLookupMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP + */ + struct GNUNET_NAMESTORE_Header gns_header; + + /** + * Length of the name + */ + uint32_t label_len GNUNET_PACKED; + + /** + * The private key of the zone to look up in + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; + + /* followed by: + * name with length name_len + */ +}; + + +/** + * Lookup a label + */ +struct LabelLookupResponseMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE + */ + 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; + + /** + * Was the label found in the database?? + * GNUNET_YES or GNUNET_NO + */ + uint16_t found 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 + */ +}; + + + +/** + * 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_EcdsaPrivateKey zone; + + /** + * The public key of the target zone + */ + struct GNUNET_CRYPTO_EcdsaPublicKey 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 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 + */ + +}; + + /** - * Change in blacklisting (either request or notification, - * depending on which direction it is going). + * Record is returned from the namestore (as authority). */ -struct StartMessage +struct RecordResultMessage { + /** + * 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; /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START + * 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; + /** + * #GNUNET_YES to first iterate over all records, + * #GNUNET_NO to only monitor changes.o + */ + uint32_t iterate_first GNUNET_PACKED; + + /** + * Zone key. + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey 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_EcdsaPrivateKey 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 + /* end of namestore.h */ #endif