* @file include/gnunet_gns_service.h
* @brief API to the GNS service
* @author Martin Schanzenbach
- *
- * TODO:
- * - decide what goes into storage API and what into GNS-service API
- * - decide where to pass/expose/check keys / signatures
- * - are GNS private keys per peer or per user?
*/
-
-
#ifndef GNUNET_GNS_SERVICE_H
#define GNUNET_GNS_SERVICE_H
#include "gnunet_util_lib.h"
+#include "gnunet_dnsparser_lib.h"
+#include "gnunet_namestore_service.h"
#ifdef __cplusplus
extern "C"
struct GNUNET_GNS_Handle;
/**
- * Handle to control a get operation.
+ * Handle to control a lookup operation.
*/
-struct GNUNET_GNS_LookupHandle;
+struct GNUNET_GNS_LookupRequest;
/**
- * A single GNS record.
+ * Handle to control a shorten operation.
*/
-struct GNUNET_GNS_Record;
+struct GNUNET_GNS_ShortenRequest;
/**
- * Records types
+ * Handle to control a get authority operation
+ */
+struct GNUNET_GNS_GetAuthRequest;
+
+/**
+ * Record types
+ * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
*/
enum GNUNET_GNS_RecordType
{
- // FIXME: should be based on GNUNET_DNSPARSER_TYPE's (standard DNS),
- // and then maybe our extensions in the area > 255?
- GNUNET_GNS_RECORD_A,
- GNUNET_GNS_RECORD_AAAA,
- GNUNET_GNS_RECORD_MX,
- GNUNET_GNS_RECORD_PKEY
+ /* Standard DNS */
+ /* struct in_addr */
+ GNUNET_GNS_RECORD_A = GNUNET_DNSPARSER_TYPE_A,
+
+ /* char */
+ GNUNET_GNS_RECORD_NS = GNUNET_DNSPARSER_TYPE_NS,
+
+ /* char */
+ GNUNET_GNS_RECORD_CNAME = GNUNET_DNSPARSER_TYPE_CNAME,
+
+ /* struct soa_data */
+ GNUNET_GNS_RECORD_SOA = GNUNET_DNSPARSER_TYPE_SOA,
+
+ /* struct srv_data */
+ GNUNET_GNS_RECORD_SRV = GNUNET_DNSPARSER_TYPE_SRV,
+
+ /* char */
+ GNUNET_GNS_RECORD_PTR = GNUNET_DNSPARSER_TYPE_PTR,
+
+ /* uint16_t, char */
+ GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
+
+ /* char */
+ GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
+
+ /* struct in6_addr */
+ GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
+
+ /* GNS specific */
+ /* struct GNUNET_CRYPTO_ShortHashCode */
+ GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
+
+ /* char */
+ GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
+ GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY,
+
+ /* char */
+ GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO,
+
+ /* struct vpn_data */
+ GNUNET_GNS_RECORD_VPN = GNUNET_NAMESTORE_TYPE_VPN,
+
+ /* revocation */
+ GNUNET_GNS_RECORD_REV = GNUNET_NAMESTORE_TYPE_REV
};
+
/**
* Initialize the connection with the GNS service.
*
* @param cfg configuration to use
- * @param ht_len size of the internal hash table to use for parallel lookups
- * @return NULL on error
+ *
+ * @return handle to the GNS service, or NULL on error
*/
struct GNUNET_GNS_Handle *
-GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
- unsigned int ht_len);
+GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
-/* *************** Standard API: add and lookup ******************* */
+/* *************** Standard API: lookup ******************* */
/**
- * Perform an add operation storing records in the GNS.
+ * Iterator called on obtained result for a GNS
+ * lookup
*
- * FIXME: Yes, we need this kind of API, but should it not be with the
- * NameDataStore, rather than the GNS-service?
+ * @param cls closure
+ * @param rd_count number of records
+ * @param rd the records in reply
+ */
+typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
+ uint32_t rd_count,
+ const struct GNUNET_NAMESTORE_RecordData *rd);
+
+
+
+/**
+ * Perform an asynchronous lookup operation on the GNS
+ * in the default zone.
+ *
+ * @param handle handle to the GNS service
+ * @param name the name to look up
+ * @param type the GNUNET_GNS_RecordType to look for
+ * @param only_cached GNUNET_NO to only check locally not DHT for performance
+ * @param shorten_key the private key of the shorten zone (can be NULL)
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
*
- * @param handle handle to GNS service
- * @param name the key to store under
- * // FIXME: need to be precise here what 'name' is. Does it
- // include '.gnunet'? What happens if we specify 'a.b.c.gnunet'
- // but 'b.c.gnunet' has been delegated? (error?)
- * @param desired_replication_level estimate of how many
- * nearest peers this request should reach
- * @param options routing options for this message
- // FIXME: which are? where is the arg?
- // FIXME: we should probably distinguish between 'private' and 'public'
- // records;
- * @param type type of the value
- * @param size number of bytes in data; must be less than 64k
- * @param data the data to store
- // FIXME: what is the exact format of data?
- * @param exp desired expiration time for the value
- * @param timeout how long to wait for transmission of this request
- * @param cont continuation to call when done (transmitting request to service)
- * @param cont_cls closure for cont
- * // FIXME: where are the continuations?
+ * @return handle to the queued request
*/
-void
-GNUNET_GNS_add_record (struct GNUNET_GNS_Handle *handle,
- const char* name,
- enum GNUNET_GNS_RecordType type,
- size_t size, const char *data,
- struct GNUNET_TIME_Absolute exp,
- struct GNUNET_TIME_Relative timeout);
+struct GNUNET_GNS_LookupRequest*
+GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
+ const char * name,
+ enum GNUNET_GNS_RecordType type,
+ int only_cached,
+ struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
+ GNUNET_GNS_LookupResultProcessor proc,
+ void *proc_cls);
/**
- * Iterator called on each result obtained for a GNS
- * operation that expects a reply TODO: eh?
+ * Perform an asynchronous lookup operation on the GNS
+ * in the zone specified by 'zone'.
*
+ * @param handle handle to the GNS service
+ * @param name the name to look up
+ * @param zone the zone to start the resolution in
+ * @param type the GNUNET_GNS_RecordType to look for
+ * @param only_cached GNUNET_YES to only check locally not DHT for performance
+ * @param shorten_key the private key of the shorten zone (can be NULL)
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
+ *
+ * @return handle to the queued request
+ */
+struct GNUNET_GNS_LookupRequest*
+GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
+ const char * name,
+ struct GNUNET_CRYPTO_ShortHashCode *zone,
+ enum GNUNET_GNS_RecordType type,
+ int only_cached,
+ struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
+ GNUNET_GNS_LookupResultProcessor proc,
+ void *proc_cls);
+
+
+/**
+ * Cancel pending lookup request
+ *
+ * @param lr the lookup request to cancel
+ */
+void
+GNUNET_GNS_cancel_lookup_request (struct GNUNET_GNS_LookupRequest *lr);
+
+/* *************** Standard API: shorten ******************* */
+
+
+/**
+ * Processor called on for a name shortening result
+ * called only once
*
* @param cls closure
- * @param exp when will this value expire
- * @param key key of the result
- * // how does the key relate to the name exactly? Why not give the name?
- * @param record the records in reply
- * // FIXME: shouldn't this then be an array of pointers?
- * @param num_records the number of records in reply
- * @param type type of the result
- * // FIXME: not in signature
+ * @param short_name the shortened name or NULL if no result / error
*/
-typedef void (*GNUNET_GNS_LookupIterator) (void *cls,
- const GNUNET_HashCode * key,
- const struct GNUNET_GNS_Record *record,
- unsigned int num_records);
+typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
+ const char* short_name);
+/**
+ * Perform a name shortening operation on the GNS.
+ *
+ * @param handle handle to the GNS service
+ * @param name the name to look up
+ * @param private_zone the public zone of the private zone
+ * @param shorten_zone the public zone of the shorten zone
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
+ * @return handle to the operation
+ */
+struct GNUNET_GNS_ShortenRequest*
+GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
+ const char * name,
+ struct GNUNET_CRYPTO_ShortHashCode *private_zone,
+ struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
+ GNUNET_GNS_ShortenResultProcessor proc,
+ void *proc_cls);
+
/**
- * Perform an asynchronous lookup operation on the GNS.
+ * Perform a name shortening operation on the GNS.
*
* @param handle handle to the GNS service
- * @param timeout how long to wait for transmission of this request to the service
- * // FIXME: what happens afterwards?
- * @param type expected type of the response object
- * @param key the key to look up
- * // FIXME: key, name, what format?
- * @param desired_replication_level estimate of how many
- nearest peers this request should reach
- * @param options routing options for this message
- * //FIXME: missmatch between documented and actual options...
- * @param xquery extended query data (can be NULL, depending on type)
- * @param xquery_size number of bytes in xquery
- * @param iter function to call on each result
- * @param iter_cls closure for iter
+ * @param name the name to look up
+ * @param private_zone the public zone of the private zone
+ * @param shorten_zone the public zone of the shorten zone
+ * @param zone the zone to start the resolution in
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
+ * @return handle to the operation
+ */
+struct GNUNET_GNS_ShortenRequest*
+GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
+ const char * name,
+ struct GNUNET_CRYPTO_ShortHashCode *private_zone,
+ struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
+ struct GNUNET_CRYPTO_ShortHashCode *zone,
+ GNUNET_GNS_ShortenResultProcessor proc,
+ void *proc_cls);
+
+
+/**
+ * Cancel pending shorten request
+ *
+ * @param sr the lookup request to cancel
+ */
+void
+GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr);
+
+
+/* *************** Standard API: get authority ******************* */
+
+
+/**
+ * Processor called on for a name shortening result
+ * called only once
*
- * @return handle to stop the async get
+ * @param cls closure
+ * @param auth_name the name of the auhtority or NULL
*/
-struct GNUNET_GNS_LookupHandle *
-GNUNET_GNS_lookup_start (struct GNUNET_GNS_Handle *handle,
- struct GNUNET_TIME_Relative timeout,
- const char * name,
- enum GNUNET_GNS_RecordType type,
- GNUNET_GNS_LookupIterator iter,
- void *iter_cls);
+typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
+ const char* short_name);
/**
- * Stop async GNS lookup. Frees associated resources.
+ * Perform an authority lookup for a given name.
*
- * @param lookup_handle lookup operation to stop.
+ * @param handle handle to the GNS service
+ * @param name the name to look up authority for
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
+ * @return handle to the operation
+ */
+struct GNUNET_GNS_GetAuthRequest*
+GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
+ const char * name,
+ GNUNET_GNS_GetAuthResultProcessor proc,
+ void *proc_cls);
+
+
+/**
+ * Cancel pending get auth request
*
- * On return lookup_handle will no longer be valid, caller
- * must not use again!!!
+ * @param gar the lookup request to cancel
*/
void
-GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle);
-
+GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar);
#if 0 /* keep Emacsens' auto-indent happy */
{
projects / oweals / gnunet.git / blobdiff