X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_namestore_service.h;h=8466d613507d7f7d5a32e478e792c496b7f05a1a;hb=27c12911f4f2aba2d90099270d70de846e83854f;hp=5b622e6f2d90fc5677ff25ade4e90408541a9d54;hpb=17d1146c625092753e1b29b7ce6f0dfb603fbd09;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index 5b622e6f2..8466d6135 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h @@ -31,6 +31,7 @@ #include "gnunet_util_lib.h" #include "gnunet_block_lib.h" +#include "gnunet_gnsrecord_lib.h" #ifdef __cplusplus extern "C" @@ -40,40 +41,6 @@ extern "C" #endif #endif -/** - * Record type indicating any record/'*' - */ -#define GNUNET_NAMESTORE_TYPE_ANY 0 - -/** - * Record type for GNS zone transfer ("PKEY"). - */ -#define GNUNET_NAMESTORE_TYPE_PKEY 65536 - -/** - * Record type for GNS zone transfer ("PSEU"). - */ -#define GNUNET_NAMESTORE_TYPE_PSEU 65537 - -/** - * Record type for GNS legacy hostnames ("LEHO"). - */ -#define GNUNET_NAMESTORE_TYPE_LEHO 65538 - -/** - * Record type for VPN resolution - */ -#define GNUNET_NAMESTORE_TYPE_VPN 65539 - -/** - * Record type for zone revocation - */ -#define GNUNET_NAMESTORE_TYPE_REV 65540 - -/** - * Record type for a social place. - */ -#define GNUNET_NAMESTORE_TYPE_PLACE 65541 /** * Entry in the queue. @@ -90,11 +57,6 @@ struct GNUNET_NAMESTORE_Handle; */ struct GNUNET_NAMESTORE_ZoneIterator; -/** - * Maximum size of a value that can be stored in the namestore. - */ -#define GNUNET_NAMESTORE_MAX_VALUE_SIZE (63 * 1024) - /** * Connect to the namestore service. @@ -108,7 +70,8 @@ GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg); /** * Disconnect from the namestore service (and free associated - * resources). + * resources). Must not be called from within operation callbacks of + * the API. * * @param h handle to the namestore */ @@ -121,9 +84,9 @@ GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h); * operation. * * @param cls closure - * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) - * GNUNET_NO if content was already there or not found - * GNUNET_YES (or other positive value) on success + * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) + * #GNUNET_NO if content was already there or not found + * #GNUNET_YES (or other positive value) on success * @param emsg NULL on success, otherwise an error message */ typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls, @@ -131,157 +94,6 @@ typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls, const char *emsg); -/** - * Flags that can be set for a record. - */ -enum GNUNET_NAMESTORE_RecordFlags -{ - - /** - * No special options. - */ - GNUNET_NAMESTORE_RF_NONE = 0, - - /** - * This peer is the authority for this record; it must thus - * not be deleted (other records can be deleted if we run - * out of space). - */ - GNUNET_NAMESTORE_RF_AUTHORITY = 1, - - /** - * This is a private record of this peer and it should - * thus not be handed out to other peers. - */ - GNUNET_NAMESTORE_RF_PRIVATE = 2, - - /** - * This record was added by the system - * and is pending user confimation - */ - GNUNET_NAMESTORE_RF_PENDING = 4, - - /** - * This expiration time of the record is a relative - * time (not an absolute time). - */ - GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION = 8, - - /** - * This record should not be used unless all (other) records with an absolute - * expiration time have expired. - */ - GNUNET_NAMESTORE_RF_SHADOW_RECORD = 16 - - /** - * When comparing flags for record equality for removal, - * which flags should must match (in addition to the type, - * name, expiration value and data of the record)? All flags - * that are not listed here will be ignored for this purpose. - * (for example, we don't expect that users will remember to - * pass the '--private' option when removing a record from - * the namestore, hence we don't require this particular option - * to match upon removal). See also - * 'GNUNET_NAMESTORE_records_cmp'. - */ -#define GNUNET_NAMESTORE_RF_RCMP_FLAGS (GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION) -}; - - -/** - * A GNS record. - */ -struct GNUNET_NAMESTORE_RecordData -{ - - /** - * Binary value stored in the DNS record. - * FIXME: goofy API: sometimes 'data' is individually - * 'malloc'ed, sometimes it points into some existing - * data area (so sometimes this should be a 'void *', - * sometimes a 'const void *'). This is unclean. We - * should go over the code and make sure that 'data' - * is NEVER individually alloc'ed here but always points - * to some "other" location. - */ - const void *data; - - /** - * Expiration time for the DNS record. Can be relative - * or absolute, depending on 'flags'. - */ - uint64_t expiration_time; - - /** - * Number of bytes in 'data'. - */ - size_t data_size; - - /** - * Type of the GNS/DNS record. - */ - uint32_t record_type; - - /** - * Flags for the record. - */ - enum GNUNET_NAMESTORE_RecordFlags flags; -}; - - - -GNUNET_NETWORK_STRUCT_BEGIN - - -/** - * Information we have in an encrypted block with record data (i.e. in the DHT). - */ -struct GNUNET_NAMESTORE_Block -{ - - /** - * Signature of the block. - */ - struct GNUNET_CRYPTO_EccSignature signature; - - /** - * Derived key used for signing; hash of this is the query. - */ - struct GNUNET_CRYPTO_EccPublicKey derived_key; - - /** - * Number of bytes signed; also specifies the number of bytes - * of encrypted data that follow. - */ - struct GNUNET_CRYPTO_EccSignaturePurpose purpose; - - /** - * Expiration time of the block. - */ - struct GNUNET_TIME_AbsoluteNBO expiration_time; - - /* followed by encrypted data */ -}; - -GNUNET_NETWORK_STRUCT_END - -/** - * Store an item in the namestore. If the item is already present, - * it is replaced with the new record. - * - * @param h handle to the namestore - * @param block block to store - * @param cont continuation to call when done - * @param cont_cls closure for cont - * @return handle to abort the request - */ -struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_NAMESTORE_Block *block, - GNUNET_NAMESTORE_ContinuationWithStatus cont, - void *cont_cls); - - /** * Store an item in the namestore. If the item is already present, * it is replaced with the new record. Use an empty array to @@ -289,64 +101,72 @@ GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h, * * @param h handle to the namestore * @param pkey private key of the zone - * @param label name that is being mapped (at most 255 characters long) + * @param label name that is being mapped * @param rd_count number of records in the 'rd' array * @param rd array of records with data to store * @param cont continuation to call when done - * @param cont_cls closure for 'cont' + * @param cont_cls closure for @a cont * @return handle to abort the request */ struct GNUNET_NAMESTORE_QueueEntry * GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_EccPrivateKey *pkey, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, const char *label, unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, + const struct GNUNET_GNSRECORD_Data *rd, GNUNET_NAMESTORE_ContinuationWithStatus cont, void *cont_cls); + /** * Process a record that was stored in the namestore. * * @param cls closure - * @param block block that was stored in the namestore + * @param zone private key of the zone; NULL on disconnect + * @param label label of the records; NULL on disconnect + * @param rd_count number of entries in @a rd array, 0 if label was deleted + * @param rd array of records with data to store */ -typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls, - const struct GNUNET_NAMESTORE_Block *block); - +typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const char *label, + unsigned int rd_count, + const struct GNUNET_GNSRECORD_Data *rd); /** - * Get a result for a particular key from the namestore. The processor - * will only be called once. + * Set the desired nick name for a zone * * @param h handle to the namestore - * @param derived_hash hash of zone key combined with name to lookup - * @param proc function to call on the matching block, or with - * NULL if there is no matching block - * @param proc_cls closure for proc - * @return a handle that can be used to cancel + * @param pkey private key of the zone + * @param nick the nick name to set + * @param cont continuation to call when done + * @param cont_cls closure for 'cont' + * @return handle to abort the request */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_HashCode *derived_hash, - GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls); - +GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, + const char *nick, + GNUNET_NAMESTORE_ContinuationWithStatus cont, + void *cont_cls); /** - * Process a record that was stored in the namestore. + * Lookup an item in the namestore. * - * @param cls closure - * @param zone private key of the zone - * @param label label of the records - * @param rd_count number of entries in 'rd' array - * @param rd array of records with data to store + * @param h handle to the namestore + * @param pkey private key of the zone + * @param label name that is being mapped + * @param rm function to call with the result (with 0 records if we don't have that label) + * @param rm_cls closure for @a rm + * @return handle to abort the request */ -typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls, - const struct GNUNET_CRYPTO_EccPrivateKey *zone, - const char *label, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); +struct GNUNET_NAMESTORE_QueueEntry * +GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, + const char *label, + GNUNET_NAMESTORE_RecordMonitor rm, + void *rm_cls); /** @@ -358,29 +178,17 @@ typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls, * @param value_zone public key of the target zone (value), never NULL * @param proc function to call on the matching records, or with * NULL (rd_count == 0) if there are no matching records - * @param proc_cls closure for proc + * @param proc_cls closure for @a proc * @return a handle that can be used to * cancel */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_EccPrivateKey *zone, - const struct GNUNET_CRYPTO_EccPublicKey *value_zone, +GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone, GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls); -/** - * Process a records that were decrypted from a block. - * - * @param cls closure - * @param rd_count number of entries in @a rd array - * @param rd array of records with data to store - */ -typedef void (*GNUNET_NAMESTORE_RecordCallback) (void *cls, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); - - /** * Cancel a namestore operation. The final callback from the * operation must not have been done yet. Must be called on any @@ -395,26 +203,29 @@ GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe); /** * Starts a new zone iteration (used to periodically PUT all of our - * records into our DHT). @a proc will be called once immediately, and - * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked. + * records into our DHT). This MUST lock the struct GNUNET_NAMESTORE_Handle + * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next and + * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once + * immediately, and then again after + * #GNUNET_NAMESTORE_zone_iterator_next is invoked. * * @param h handle to the namestore - * @param zone zone to access + * @param zone zone to access, NULL for all zones * @param proc function to call on each name from the zone; it * will be called repeatedly with a value (if available) - * and always once at the end with a name of NULL. - * @param proc_cls closure for proc + * and always once at the end with a label of NULL. + * @param proc_cls closure for @a proc * @return an iterator handle to use for iteration */ struct GNUNET_NAMESTORE_ZoneIterator * GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_EccPrivateKey *zone, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls); /** - * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start + * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start * for the next record. * * @param it the iterator @@ -441,7 +252,7 @@ struct GNUNET_NAMESTORE_ZoneMonitor; /** - * Function called once the monitor has caught up with the current + * Function called once the monitor has caught up with the current * state of the database. Will be called AGAIN after each disconnect * (record monitor called with 'NULL' for zone_key) once we're again * in sync. @@ -452,23 +263,29 @@ typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls); /** - * Begin monitoring a zone for changes. Will first call the 'monitor' function - * on all existing records in the selected zone(s), then calls 'sync_cb', - * and then calls the 'monitor' whenever a record changes. If the namestore - * disconnects, the 'monitor' function is called with a disconnect event; if - * the connection is re-established, the process begins from the start (all - * existing records, sync, then updates). + * Begin monitoring a zone for changes. Will first call the @a + * monitor function on all existing records in the selected zone(s) if + * @a iterate_first is #GNUNET_YES. In any case, we will then call @a + * sync_cb, and then afterwards call the @a monitor whenever a record + * changes. If the namestore disconnects, the @a monitor function is + * called with a disconnect event; if the connection is + * re-established, the process begins from the start (depending on @a + * iterate_first, we first do all existing records, then @a sync, then + * updates). * * @param cfg configuration to use to connect to namestore - * @param zone zone to monitor + * @param zone zone to monitor, NULL for all zones + * @param iterate_first #GNUNET_YES to first iterate over all existing records, + * #GNUNET_NO to only return changes that happen from now on * @param monitor function to call on zone changes * @param sync_cb function called when we're in sync with the namestore - * @param cls closure for 'monitor' and 'sync_cb' + * @param cls closure for @a monitor and @a sync_cb * @return handle to stop monitoring */ struct GNUNET_NAMESTORE_ZoneMonitor * GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg, - const struct GNUNET_CRYPTO_EccPrivateKey *zone, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + int iterate_first, GNUNET_NAMESTORE_RecordMonitor monitor, GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb, void *cls); @@ -483,237 +300,6 @@ void GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); -/* convenience APIs for serializing / deserializing GNS records */ - -/** - * Calculate how many bytes we will need to serialize the given - * records. - * - * @param rd_count number of records in the rd array - * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements - * - * @return the required size to serialize - * - */ -size_t -GNUNET_NAMESTORE_records_get_size (unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); - - -/** - * Serialize the given records to the given destination buffer. - * - * @param rd_count number of records in the rd array - * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements - * @param dest_size size of the destination array - * @param dest where to write the result - * @return the size of serialized records, -1 if records do not fit - */ -ssize_t -GNUNET_NAMESTORE_records_serialize (unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, - size_t dest_size, - char *dest); - - -/** - * Deserialize the given records to the given destination. - * - * @param len size of the serialized record data - * @param src the serialized record data - * @param rd_count number of records in the rd array - * @param dest where to put the data - * - * @return GNUNET_OK on success, GNUNET_SYSERR on error - */ -int -GNUNET_NAMESTORE_records_deserialize (size_t len, - const char *src, - unsigned int rd_count, - struct GNUNET_NAMESTORE_RecordData *dest); - - -/** - * Convert the 'value' of a record to a string. - * - * @param type type of the record - * @param data value in binary encoding - * @param data_size number of bytes in data - * @return NULL on error, otherwise human-readable representation of the value - */ -char * -GNUNET_NAMESTORE_value_to_string (uint32_t type, - const void *data, - size_t data_size); - - -/** - * Convert human-readable version of a 'value' of a record to the binary - * representation. - * - * @param type type of the record - * @param s human-readable string - * @param data set to value in binary encoding (will be allocated) - * @param data_size set to number of bytes in data - * @return GNUNET_OK on success - */ -int -GNUNET_NAMESTORE_string_to_value (uint32_t type, - const char *s, - void **data, - size_t *data_size); - - -/** - * Convert a type name (i.e. "AAAA") to the corresponding number. - * - * @param typename name to convert - * @return corresponding number, UINT32_MAX on error - */ -uint32_t -GNUNET_NAMESTORE_typename_to_number (const char *typename); - - -/** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") - * - * @param type number of a type to convert - * @return corresponding typestring, NULL on error - */ -const char * -GNUNET_NAMESTORE_number_to_typename (uint32_t type); - - -/** - * Test if a given record is expired. - * - * @param rd record to test - * @return #GNUNET_YES if the record is expired, - * #GNUNET_NO if not - */ -int -GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd); - - -/** - * 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 zone to a string (for printing debug messages). - * This is one of the very few calls in the entire API that is - * NOT reentrant! - * - * @param z public key of a zone - * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s. - */ -const char * -GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z); - - -/** - * Calculate the DHT query for a given @a label in a given @a zone. - * - * @param zone private key of the zone - * @param label label of the record - * @param query hash to use for the query - */ -void -GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone, - const char *label, - struct GNUNET_HashCode *query); - - -/** - * Calculate the DHT query for a given @a label in a given @a zone. - * - * @param pub public key of the zone - * @param label label of the record - * @param query hash to use for the query - */ -void -GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub, - const char *label, - struct GNUNET_HashCode *query); - - -/** - * Sign name and records - * - * @param key the private key - * @param expire block expiration - * @param label the name for the records - * @param rd record data - * @param rd_count number of records - */ -struct GNUNET_NAMESTORE_Block * -GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key, - struct GNUNET_TIME_Absolute expire, - const char *label, - const struct GNUNET_NAMESTORE_RecordData *rd, - unsigned int rd_count); - - -/** - * Check if a signature is valid. This API is used by the GNS Block - * to validate signatures received from the network. - * - * @param block block to verify - * @return #GNUNET_OK if the signature is valid - */ -int -GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block); - - -/** - * Decrypt block. - * - * @param block block to decrypt - * @param zone_key public key of the zone - * @param label the name for the records - * @param proc function to call with the result - * @param proc_cls closure for @a proc - * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was - * not well-formed - */ -int -GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block, - const struct GNUNET_CRYPTO_EccPublicKey *zone_key, - const char *label, - GNUNET_NAMESTORE_RecordCallback proc, - void *proc_cls); - - -/** - * Compares if two records are equal - * - * @param a a record - * @param b another record - * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not. - */ -int -GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, - const struct GNUNET_NAMESTORE_RecordData *b); - - -/** - * Returns the expiration time of the given block of records. The block - * expiration time is the expiration time of the block with smallest - * expiration time. - * - * @param rd_count number of records given in 'rd' - * @param rd array of records - * @return absolute expiration time - */ -struct GNUNET_TIME_Absolute -GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); - #if 0 /* keep Emacsens' auto-indent happy */ {