X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fnamestore%2Fnamestore.h;h=ec7f2870401b8a78acc83b483c03d7d1d4a0a29b;hb=90c803401e6dbe336c6469ff874b0005e7a2f163;hp=b0d3ffad002532a50d3b7aa346d102672fcab3af;hpb=022002438e4047d235a688cfd9da7b63ab990103;p=oweals%2Fgnunet.git diff --git a/src/namestore/namestore.h b/src/namestore/namestore.h index b0d3ffad0..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,14 +14,15 @@ 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 @@ -31,102 +32,7 @@ */ #define MAX_NAME_LEN 256 -/** - * Convert a UTF-8 string to UTF-8 lowercase - * @param src source string - * @return converted result - */ -char * -GNUNET_NAMESTORE_normalize_string (const char *src); - -/** - * Convert a short hash to a string (for printing debug messages). - * This is one of the very few calls in the entire API that is - * NOT reentrant! - * - * @param hc the short hash code - * @return string form; will be overwritten by next call to GNUNET_h2s. - */ -const char * -GNUNET_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc); - - -/** - * Sign name and records - * - * @param key the private key - * @param expire block expiration - * @param name the name - * @param rd record data - * @param rd_count number of records - * - * @return the signature - */ -struct GNUNET_CRYPTO_EccSignature * -GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_EccPrivateKey *key, - struct GNUNET_TIME_Absolute expire, - const char *name, - const struct GNUNET_NAMESTORE_RecordData *rd, - unsigned int rd_count); - - -/** - * Compares if two records are equal - * - * @param a Record a - * @param b Record b - * - * @return GNUNET_YES or GNUNET_NO - */ -int -GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, - const struct GNUNET_NAMESTORE_RecordData *b); - - GNUNET_NETWORK_STRUCT_BEGIN -/** - * A GNS record serialized for network transmission. - * - * Layout is [struct GNUNET_NAMESTORE_NetworkRecord][char[data_size] data] - */ -struct GNUNET_NAMESTORE_NetworkRecord -{ - /** - * Expiration time for the DNS record. - */ - struct GNUNET_TIME_AbsoluteNBO expiration; - - /** - * Number of bytes in 'data'. - */ - uint32_t data_size; - - /** - * Type of the GNS/DNS record. - */ - uint32_t record_type; - - /** - * Flags for the record. - */ - uint32_t flags; -}; - - - -/** - * Connect to namestore service. FIXME: UNNECESSARY. - */ -struct StartMessage -{ - - /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_START - */ - struct GNUNET_MessageHeader header; - -}; - /** * Generic namestore message with op id @@ -142,43 +48,17 @@ struct GNUNET_NAMESTORE_Header /** * Request ID in NBO */ - uint32_t r_id; + uint32_t r_id GNUNET_PACKED; }; /** - * Lookup a name in the namestore + * Store a record to the namestore (as authority). */ -struct LookupNameMessage +struct RecordStoreMessage { - struct GNUNET_NAMESTORE_Header gns_header; - - /** - * The zone - */ - struct GNUNET_CRYPTO_ShortHashCode zone; - /** - * Requested record type - */ - uint32_t record_type; - - /** - * Length of the name - */ - uint32_t name_len; - - /* 0-terminated name here */ -}; - - -/** - * Lookup response - */ -struct LookupNameResponseMessage -{ - /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE */ struct GNUNET_NAMESTORE_Header gns_header; @@ -187,361 +67,272 @@ struct LookupNameResponseMessage */ struct GNUNET_TIME_AbsoluteNBO expire; - /** * Name length */ - uint16_t name_len; + uint16_t name_len GNUNET_PACKED; /** - * Bytes of serialized record data + * Length of serialized record data */ - uint16_t rd_len; + uint16_t rd_len GNUNET_PACKED; /** * Number of records contained */ - uint16_t rd_count; + uint16_t rd_count GNUNET_PACKED; /** - * Is the signature valid - * GNUNET_YES or GNUNET_NO + * always zero (for alignment) */ - int16_t contains_sig; + uint16_t reserved GNUNET_PACKED; /** - * All zeros if 'contains_sig' is GNUNET_NO. + * The private key of the authority. */ - struct GNUNET_CRYPTO_EccSignature signature; + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; - /** - * The public key for the name + /* followed by: + * name with length name_len + * serialized record data with rd_count records */ - struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key; - - /* 0-terminated name and serialized record data */ - /* rd_len bytes serialized record data */ }; /** - * Put a record to the namestore + * Response to a record storage request. */ -struct RecordPutMessage +struct RecordStoreResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_RECORD_PUT + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE */ struct GNUNET_NAMESTORE_Header gns_header; /** - * Expiration time - */ - struct GNUNET_TIME_AbsoluteNBO expire; - - /** - * Name length + * #GNUNET_SYSERR on failure, #GNUNET_OK on success */ - uint16_t name_len; + int32_t op_result GNUNET_PACKED; +}; - /** - * Length of serialized record data - */ - uint16_t rd_len; +/** + * Lookup a label + */ +struct LabelLookupMessage +{ /** - * Number of records contained + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP */ - uint16_t rd_count; + struct GNUNET_NAMESTORE_Header gns_header; /** - * always zero (for alignment) + * Length of the name */ - uint16_t reserved; + uint32_t label_len GNUNET_PACKED; /** - * The signature + * The private key of the zone to look up in */ - struct GNUNET_CRYPTO_EccSignature signature; + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /** - * The public key + /* followed by: + * name with length name_len */ - struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key; - - /* name (0-terminated) followed by "rd_count" serialized records */ - }; /** - * Put a record to the namestore response + * Lookup a label */ -struct RecordPutResponseMessage +struct LabelLookupResponseMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE */ struct GNUNET_NAMESTORE_Header gns_header; /** - * result: - * GNUNET_SYSERR on failure - * GNUNET_OK on success - */ - int32_t op_result; -}; - - -/** - * Create a record and put it to the namestore - * Memory layout: - */ -struct RecordCreateMessage -{ - /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE + * Name length */ - struct GNUNET_NAMESTORE_Header gns_header; - - struct GNUNET_TIME_AbsoluteNBO expire; + uint16_t name_len GNUNET_PACKED; /** - * Name length + * Length of serialized record data */ - uint16_t name_len; + uint16_t rd_len GNUNET_PACKED; /** - * Length of serialized record data + * Number of records contained */ - uint16_t rd_len; + uint16_t rd_count GNUNET_PACKED; /** - * Record count + * Was the label found in the database?? + * GNUNET_YES or GNUNET_NO */ - uint16_t rd_count; + uint16_t found GNUNET_PACKED; /** - * private key length + * The private key of the authority. */ - uint16_t pkey_len; + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; /* followed by: - * GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded private key with length pkey_len * name with length name_len - * serialized record data with length rd_len - * */ + * serialized record data with rd_count records + */ }; + /** - * Create a record to the namestore response + * Lookup a name for a zone hash */ -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_NAMESTORE_Header gns_header; /** - * name length: GNUNET_NO already exists, GNUNET_YES on success, GNUNET_SYSERR error + * The private key of the zone to look up in + */ + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; + + /** + * The public key of the target zone */ - int32_t op_result; + struct GNUNET_CRYPTO_EcdsaPublicKey value_zone; }; /** - * Remove a record from the namestore - * Memory layout: + * Respone for zone to name lookup */ -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_NAMESTORE_Header gns_header; /** - * Name length + * Length of the name */ - uint16_t name_len; + uint16_t name_len GNUNET_PACKED; /** - * Length of serialized rd data + * Length of serialized record data */ - uint16_t rd_len; + uint16_t rd_len GNUNET_PACKED; /** - * Number of records contained + * Number of records contained */ - uint16_t rd_count; + uint16_t rd_count GNUNET_PACKED; /** - * Length of private key + * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no + * results, #GNUNET_SYSERR on error */ - uint16_t pkey_len; - - /* followed by: - * GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded private key with length pkey_len - * name with length name_len - * serialized record data with length rd_len - * */ -}; - - -/** - * Removal of the record succeeded. - */ -#define RECORD_REMOVE_RESULT_SUCCESS 0 - -/** - * There are NO records for the given name. - */ -#define RECORD_REMOVE_RESULT_NO_RECORDS 1 - -/** - * The specific record that was to be removed was - * not found. - */ -#define RECORD_REMOVE_RESULT_RECORD_NOT_FOUND 2 - -/** - * Internal error, failed to sign the remaining records. - * (Note: not used?) - */ -#define RECORD_REMOVE_RESULT_FAILED_TO_SIGN 3 - -/** - * Internal error, failed to store the updated record set - */ -#define RECORD_REMOVE_RESULT_FAILED_TO_PUT_UPDATE 4 - -/** - * Internal error, failed to remove records from database - */ -#define RECORD_REMOVE_RESULT_FAILED_TO_REMOVE 5 - -/** - * Internal error, failed to access database - */ -#define RECORD_REMOVE_RESULT_FAILED_ACCESS_DATABASE 6 - -/** - * Internal error, failed to access database - */ -#define RECORD_REMOVE_RESULT_FAILED_INTERNAL_ERROR 7 + int16_t res GNUNET_PACKED; - -/** - * Remove a record from the namestore response - */ -struct RecordRemoveResponseMessage -{ /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE_RESPONSE + * The private key of the zone that contained the name. */ - struct GNUNET_NAMESTORE_Header gns_header; + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /** - * Result code (see RECORD_REMOVE_RESULT_*). In network byte order. + /* followed by: + * name with length name_len + * serialized record data with rd_count records */ - int32_t op_result; + }; /** - * Lookup a name for a zone hash + * Record is returned from the namestore (as authority). */ -struct ZoneToNameMessage +struct RecordResultMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT */ struct GNUNET_NAMESTORE_Header gns_header; /** - * The hash of public key of the zone to look up in + * Name length */ - struct GNUNET_CRYPTO_ShortHashCode zone; + uint16_t name_len GNUNET_PACKED; /** - * The hash of the public key of the target zone + * Length of serialized record data */ - struct GNUNET_CRYPTO_ShortHashCode value_zone; -}; + uint16_t rd_len GNUNET_PACKED; -/** - * Respone for zone to name lookup - */ -struct ZoneToNameResponseMessage -{ /** - * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE + * Number of records contained */ - struct GNUNET_NAMESTORE_Header gns_header; + uint16_t rd_count GNUNET_PACKED; /** - * Record block expiration + * always zero (for alignment) */ - struct GNUNET_TIME_AbsoluteNBO expire; + uint16_t reserved GNUNET_PACKED; /** - * Length of the name + * The private key of the authority. */ - uint16_t name_len; + struct GNUNET_CRYPTO_EcdsaPrivateKey private_key; - /** - * Length of serialized record data + /* followed by: + * name with length name_len + * serialized record data with rd_count records */ - uint16_t rd_len; +}; + +/** + * Start monitoring a zone. + */ +struct ZoneMonitorStartMessage +{ /** - * Number of records contained + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START */ - 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; + struct GNUNET_MessageHeader header; /** - * Signature + * #GNUNET_YES to first iterate over all records, + * #GNUNET_NO to only monitor changes.o */ - struct GNUNET_CRYPTO_EccSignature signature; + uint32_t iterate_first GNUNET_PACKED; /** - * Publik key + * Zone key. */ - struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded 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 + * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START */ struct GNUNET_NAMESTORE_Header gns_header; /** - * Zone hash - */ - struct GNUNET_CRYPTO_ShortHashCode zone; - - /** - * Which flags must be included + * Zone key. All zeros for "all zones". */ - uint16_t must_have_flags; + struct GNUNET_CRYPTO_EcdsaPrivateKey zone; - /** - * Which flags must not be included - */ - uint16_t must_not_have_flags; }; @@ -551,7 +342,7 @@ struct ZoneIterationStartMessage 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; }; @@ -563,53 +354,12 @@ struct ZoneIterationNextMessage 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; }; -/** - * Next result of zone iteration for the given operation - * // FIXME: use 'struct LookupResponseMessage' instead? (identical except - * for having 'contains_sig' instead of 'reserved', but fully compatible otherwise). - */ -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; - - /* Record data length */ - uint16_t rd_len; - - /** - * Number of records contained - */ - uint16_t rd_count; - /** - * always zero (for alignment) - */ - uint16_t reserved; - - /** - * All zeros if 'contains_sig' is GNUNET_NO. - */ - struct GNUNET_CRYPTO_EccSignature signature; - - /** - * The public key - */ - struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key; - - - -}; GNUNET_NETWORK_STRUCT_END