X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_namestore_service.h;h=7ab619c5127d6ed62668d0b5bce5955233d67b1b;hb=ec50a665dc884f7997419d0351ae8ade9c1aeabe;hp=8943975438bf13c952bcb5c57ce26c11d1962c11;hpb=3d8f372adbd1f765b2c4e0fadb4d7152e9301588;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index 894397543..7ab619c51 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h @@ -1,39 +1,44 @@ /* This file is part of GNUnet - (C) 2012 Christian Grothoff (and other contributing authors) + Copyright (C) 2012, 2013, 2018 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 - by the Free Software Foundation; either version 2, or (at your - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - 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. + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . */ /** - * @file include/gnunet_namestore_service.h - * @brief API that can be used to store naming information on a GNUnet node; * @author Christian Grothoff * - * Other functions we might want: - * - enumerate all known zones - * - convenience function to gather record and the full affilliated stree - * in one shot + * @file + * API that can be used to store naming information on a GNUnet node; + * + * @defgroup namestore Name Store service + * Store naming information on a GNUnet node. + * + * Naming information can either be records for which this peer/user is + * authoritative, or blocks which are cached, encrypted naming data from other + * peers. + * + * @see [Documentation](https://gnunet.org/namestore-subsystem) + * + * @{ */ - #ifndef GNUNET_NAMESTORE_SERVICE_H #define GNUNET_NAMESTORE_SERVICE_H #include "gnunet_util_lib.h" #include "gnunet_block_lib.h" +#include "gnunet_gnsrecord_lib.h" #ifdef __cplusplus extern "C" @@ -43,6 +48,7 @@ extern "C" #endif #endif + /** * Entry in the queue. */ @@ -58,10 +64,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. @@ -75,13 +77,13 @@ 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 - * @param drop set to GNUNET_YES to delete all data in namestore (!) */ void -GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h, int drop); +GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h); /** @@ -89,142 +91,43 @@ GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h, int drop); * operation. * * @param cls closure - * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) - * GNUNET_NO if content was already there - * 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, - int32_t success, - 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 - -}; - - -/** - * Get the hash of a record - * - * @param zone hash of the public key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param record_type type of the record (A, AAAA, PKEY, etc.) - * @param expiration expiration time for the content - * @param flags flags for the content - * @param data_size number of bytes in data - * @param data value, semantics depend on 'record_type' (see RFCs for DNS and - * GNS specification for GNS extensions) - * @param record_hash hash of the record (set) - */ -void -GNUNET_NAMESTORE_record_hash (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - const char *name, - uint32_t record_type, - struct GNUNET_TIME_Absolute expiration, - enum GNUNET_NAMESTORE_RecordFlags flags, - size_t data_size, - const void *data, - GNUNET_HashCode *record_hash); +typedef void +(*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls, + int32_t success, + const char *emsg); /** * Store an item in the namestore. If the item is already present, - * the expiration time is updated to the max of the existing time and - * the new time. - * - * @param h handle to the namestore - * @param zone hash of the public key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param record_type type of the record (A, AAAA, PKEY, etc.) - * @param expiration expiration time for the content - * @param flags flags for the content - * @param data_size number of bytes in data - * @param data value, semantics depend on 'record_type' (see RFCs for DNS and - * GNS specification for GNS extensions) - * @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_record_put (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - const char *name, - uint32_t record_type, - struct GNUNET_TIME_Absolute expiration, - enum GNUNET_NAMESTORE_RecordFlags flags, - size_t data_size, - const void *data, - GNUNET_NAMESTORE_ContinuationWithStatus cont, - void *cont_cls); - -/** - * Store a signature for 'name' in the namestore. - * Used by non-authorities to store signatures for cached name records. + * it is replaced with the new record. Use an empty array to + * remove all records under the given name. * - * @param h handle to the namestore - * @param zone hash of the public key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param sig the signature - * @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_signature_put (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - const char *name, - struct GNUNET_CRYPTO_RsaSignature sig, - GNUNET_NAMESTORE_ContinuationWithStatus cont, - void *cont_cls); - - -/** - * Explicitly remove some content from the database. The - * "cont"inuation will be called with status "GNUNET_OK" if content - * was removed, "GNUNET_NO" if no matching entry was found and - * "GNUNET_SYSERR" on all other types of errors. + * The continuation is called after the value has been stored in the + * database. Monitors may be notified asynchronously (basically with + * a buffer). However, if any monitor is consistently too slow to + * keep up with the changes, calling @a cont will be delayed until the + * monitors do keep up. * * @param h handle to the namestore - * @param zone hash of the public key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param record_type type of the record (A, AAAA, PKEY, etc.) - * @param size number of bytes in data - * @param data content stored + * @param pkey private key of the zone + * @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_record_remove (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - const char *name, - uint32_t record_type, - size_t size, - const void *data, +GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, + const char *label, + unsigned int rd_count, + const struct GNUNET_GNSRECORD_Data *rd, GNUNET_NAMESTORE_ContinuationWithStatus cont, void *cont_cls); @@ -233,146 +136,238 @@ GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h, * Process a record that was stored in the namestore. * * @param cls closure - * @param zone hash of the public key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param record_type type of the record (A, AAAA, PKEY, etc.) - * @param expiration expiration time for the content - * @param flags flags for the content - * @param size number of bytes in data - * @param data content stored + * @param zone private key of the zone + * @param label label of the records + * @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_RecordProcessor) (void *cls, - const GNUNET_HashCode *zone, - const char *name, - uint32_t record_type, - struct GNUNET_TIME_Absolute expiration, - enum GNUNET_NAMESTORE_RecordFlags flags, - size_t size, const void *data); +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); + /** - * Process a signature for a given name + * Set the desired nick name for a zone * - * @param cls closure - * @param zone hash of the public key of the zone - * @param name name of the records that were signed - * @param sig the signature + * @param h handle to the namestore + * @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 @a cont + * @return handle to abort the request */ -typedef void (*GNUNET_NAMESTORE_SignatureProcessor) (void *cls, - const GNUNET_HashCode *zone, - const char *name, - struct GNUNET_CRYPTO_RsaSignature sig); - +struct GNUNET_NAMESTORE_QueueEntry * +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); /** - * Get a result for a particular key from the namestore. The processor - * will only be called once. + * Lookup an item in the namestore. * * @param h handle to the namestore - * @param zone zone to look up a record from - * @param name name to look up - * @param record_type desired record type - * @param proc function to call on each matching value; - * will be called once with a NULL value at the end - * @param proc_cls closure for proc - * @return a handle that can be used to - * cancel + * @param pkey private key of the zone + * @param label name that is being mapped + * @param error_cb function to call on error (i.e. disconnect) + * the handle is afterwards invalid + * @param error_cb_cls closure for @a error_cb + * @param rm function to call with the result (with 0 records if we don't have that label); + * the handle is afterwards invalid + * @param rm_cls closure for @a rm + * @return handle to abort the request */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - const char *name, - uint32_t record_type, - GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls); +GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, + const char *label, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor rm, + void *rm_cls); /** - * Obtain latest/current signature of a zone's name. The processor - * will only be called once. + * Look for an existing PKEY delegation record for a given public key. + * Returns at most one result to the processor. * * @param h handle to the namestore - * @param zone zone to look up a signature from - * @param the common name of the records the signature is for - * @param proc function to call on each matching value; - * will be called once with a NULL value at the end - * @param proc_cls closure for proc + * @param zone private key of the zone to look up in, never NULL + * @param value_zone public key of the target zone (value), never NULL + * @param error_cb function to call on error (i.e. disconnect) + * the handle is afterwards invalid + * @param error_cb_cls closure for @a error_cb + * @param proc function to call on the matching records, or with + * NULL (rd_count == 0) if there are no matching records; + * the handle is afterwards invalid + * @param proc_cls closure for @a proc * @return a handle that can be used to * cancel */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_lookup_signature (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - const char* name, - GNUNET_NAMESTORE_SignatureProcessor proc, void *proc_cls); +GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor proc, + void *proc_cls); /** - * Get all records of a zone. + * Cancel a namestore operation. The final callback from the + * operation must not have been done yet. Must be called on any + * namestore operation that has not yet completed prior to calling + * #GNUNET_NAMESTORE_disconnect. * - * @param h handle to the namestore - * @param zone zone to access - * @param proc function to call on a random value; it - * will be called repeatedly with a value (if available) - * and always once at the end with a zone and name of NULL. - * @param proc_cls closure for proc - * @return a handle that can be used to - * cancel + * @param qe operation to cancel */ -struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_zone_transfer (struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - GNUNET_NAMESTORE_RecordProcessor proc, - void *proc_cls); +void +GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe); /** - * Starts a new zone iteration. This MUST lock the GNUNET_NAMESTORE_Handle - * for any other calls than - * GNUNET_NAMESTORE_zone_iterator_next - * and - * GNUNET_NAMESTORE_zone_iteration_stop + * Starts a new zone iteration (used to periodically PUT all of our + * 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. + * + * On error (disconnect), @a error_cb will be invoked. + * On normal completion, @a finish_cb proc will be + * invoked. * * @param h handle to the namestore - * @param zone zone to access - * @param proc function to call on a random value; it + * @param zone zone to access, NULL for all zones + * @param error_cb function to call on error (i.e. disconnect), + * the handle is afterwards invalid + * @param error_cb_cls closure for @a error_cb + * @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 zone and name of NULL. - * @param proc_cls closure for proc + * @param proc_cls closure for @a proc + * @param finish_cb function to call on completion + * the handle is afterwards invalid + * @param finish_cb_cls closure for @a finish_cb * @return an iterator handle to use for iteration */ struct GNUNET_NAMESTORE_ZoneIterator * -GNUNET_NAMESTORE_zone_iteration_start(struct GNUNET_NAMESTORE_Handle *h, - const GNUNET_HashCode *zone, - GNUNET_NAMESTORE_RecordProcessor proc, - void *proc_cls); +GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor proc, + void *proc_cls, + GNUNET_SCHEDULER_TaskCallback finish_cb, + void *finish_cb_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 - * @return 0 if no more records are available to iterate + * @param limit number of records to return to the iterator in one shot + * (before #GNUNET_NAMESTORE_zone_iterator_next is to be called again) */ -int -GNUNET_NAMESTORE_zone_iterator_next(struct GNUNET_NAMESTORE_ZoneIterator *it); +void +GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it, + uint64_t limit); + /** - * Stops iteration and releases the namestore handle for further calls. + * Stops iteration and releases the namestore handle for further calls. Must + * be called on any iteration that has not yet completed prior to calling + * #GNUNET_NAMESTORE_disconnect. * * @param it the iterator */ void -GNUNET_NAMESTORE_zone_iteration_stop(struct GNUNET_NAMESTORE_ZoneIterator *it); +GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it); /** - * Cancel a namestore operation. The final callback from the - * operation must not have been done yet. + * Handle for a monitoring activity. + */ +struct GNUNET_NAMESTORE_ZoneMonitor; + + +/** + * 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 error_cb function is + * called with a disconnect event. Once the connection is + * re-established, the process begins from the start (depending on @a + * iterate_first, we will again first do all existing records, then @a + * sync, then updates). * - * @param qe operation to cancel + * @param cfg configuration to use to connect to namestore + * @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 error_cb function to call on error (i.e. disconnect); note that + * unlike the other error callbacks in this API, a call to this + * function does NOT destroy the monitor handle, it merely signals + * that monitoring is down. You need to still explicitly call + * #GNUNET_NAMESTORE_zone_monitor_stop(). + * @param error_cb_cls closure for @a error_cb + * @param monitor function to call on zone changes, with an initial limit of 1 + * @param monitor_cls closure for @a monitor + * @param sync_cb function called when we're in sync with the namestore + * @param sync_cb_cls closure for @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_EcdsaPrivateKey *zone, + int iterate_first, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor monitor, + void *monitor_cls, + GNUNET_SCHEDULER_TaskCallback sync_cb, + void *sync_cb_cls); + + +/** + * Calls the monitor processor specified in #GNUNET_NAMESTORE_zone_monitor_start + * for the next record(s). This function is used to allow clients that merely + * monitor the NAMESTORE to still throttle namestore operations, so we can be + * sure that the monitors can keep up. + * + * Note that #GNUNET_NAMESTORE_records_store() only waits for this + * call if the previous limit set by the client was already reached. + * Thus, by using a @a limit greater than 1, monitors basically enable + * a queue of notifications to be processed asynchronously with some + * delay. Note that even with a limit of 1 the + * #GNUNET_NAMESTORE_records_store() function will run asynchronously + * and the continuation may be invoked before the monitors completed + * (or even started) processing the notification. Thus, monitors will + * only closely track the current state of the namestore, but not + * be involved in the transactions. + * + * @param zm the monitor + * @param limit number of records to return to the iterator in one shot + * (before #GNUNET_NAMESTORE_zone_monitor_next is to be called again) */ void -GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe); +GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm, + uint64_t limit); + + +/** + * Stop monitoring a zone for changes. + * + * @param zm handle to the monitor activity to stop + */ +void +GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); #if 0 /* keep Emacsens' auto-indent happy */ @@ -382,5 +377,6 @@ GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe); } #endif -/* end of gnunet_namestore_service.h */ #endif + +/** @} */ /* end of group */