/*
This file is part of GNUnet
- (C) 2012 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2012-2014, 2017 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 3, 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 <http://www.gnu.org/licenses/>.
*/
/**
- * @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?
+ * @file
+ * API to the GNS service
+ *
+ * @defgroup gns GNS service
+ * GNU Name System
+ *
+ * @see [Documentation](https://gnunet.org/gns-implementation)
+ *
+ * @{
*/
-
-
#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
#endif
+/**
+ * String we use to indicate an empty label (top-level
+ * entry in the zone). DNS uses "@", so do we.
+ */
+#define GNUNET_GNS_EMPTY_LABEL_AT "@"
+
/**
* Connection to the GNS service.
*/
struct GNUNET_GNS_Handle;
/**
- * Handle to control a get operation.
+ * Handle to control a lookup operation.
*/
-struct GNUNET_GNS_LookupHandle;
+struct GNUNET_GNS_LookupRequest;
/**
- * Record types
- * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
+ * Handle to control a lookup operation where the
+ * TLD is resolved to a zone as part of the lookup operation.
*/
-enum GNUNET_GNS_RecordType
-{
- /* Standard DNS */
- GNUNET_GNS_RECORD_TYPE_A = 1,
- GNUNET_GNS_RECORD_TYPE_NS = 2,
- GNUNET_GNS_RECORD_TYPE_CNAME = 5,
- GNUNET_GNS_RECORD_TYPE_SOA = 6,
- GNUNET_GNS_RECORD_TYPE_PTR = 12,
- GNUNET_GNS_RECORD_MX = 15,
- GNUNET_GNS_RECORD_TXT = 16,
- GNUNET_GNS_RECORD_AAAA = 28,
-
- /* GNS specific */
- GNUNET_GNS_RECORD_PKEY = 256
-};
+struct GNUNET_GNS_LookupWithTldRequest;
+
/**
* Initialize the connection with the GNS service.
- * FIXME: Do we need the ht_len?
*
* @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: lookup ******************* */
-
/**
- * Iterator called on each result obtained for a GNS
- * lookup
+ * Iterator called on obtained result for a GNS lookup.
*
* @param cls closure
- * @param name "name" of the original lookup
- * @param record the records in reply
- * @param num_records the number of records in reply
+ * @param rd_count number of records in @a rd
+ * @param rd the records in reply
*/
-typedef void (*GNUNET_GNS_LookupIterator) (void *cls,
- const char * name,
- const struct GNUNET_NAMESTORE_RecordData *record,
- unsigned int num_records);
+typedef void
+(*GNUNET_GNS_LookupResultProcessor) (void *cls,
+ uint32_t rd_count,
+ const struct GNUNET_GNSRECORD_Data *rd);
+/**
+ * Options for the GNS lookup.
+ */
+enum GNUNET_GNS_LocalOptions
+{
+ /**
+ * Defaults, look in cache, then in DHT.
+ */
+ GNUNET_GNS_LO_DEFAULT = 0,
+
+ /**
+ * Never look in the DHT, keep request to local cache.
+ */
+ GNUNET_GNS_LO_NO_DHT = 1,
+
+ /**
+ * For the rightmost label, only look in the cache (it
+ * is our local namestore), for the others, the DHT is OK.
+ */
+ GNUNET_GNS_LO_LOCAL_MASTER = 2
+
+};
+
/**
* Perform an asynchronous lookup 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 name the name to look up
- * @param type the GNUNET_GNS_RecordType to look for
- * @param iter function to call on each result
- * @param iter_cls closure for iter
+ * @param zone zone to look in
+ * @param type the GNS record type to look for
+ * @param options local options for the lookup
+ * @param proc function to call on result
+ * @param proc_cls closure for @a proc
+ * @return handle to the queued request
+ */
+struct GNUNET_GNS_LookupRequest *
+GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
+ const char *name,
+ const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
+ uint32_t type,
+ enum GNUNET_GNS_LocalOptions options,
+ GNUNET_GNS_LookupResultProcessor proc,
+ void *proc_cls);
+
+
+/**
+ * Cancel pending lookup request
+ *
+ * @param lr the lookup request to cancel
+ * @return closure from the lookup result processor
+ */
+void *
+GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
+
+
+/**
+ * Iterator called on obtained result for a GNS lookup
+ * where "not GNS" is a valid answer.
*
- * @return handle to stop the async get
+ * @param cls closure
+ * @param gns_tld #GNUNET_YES if a GNS lookup was attempted,
+ * #GNUNET_NO if the TLD is not configured for GNS
+ * @param rd_count number of records in @a rd
+ * @param rd the records in the reply
*/
-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_LookupResultProcessor2) (void *cls,
+ int gns_tld,
+ uint32_t rd_count,
+ const struct GNUNET_GNSRECORD_Data *rd);
/**
- * Stop async GNS lookup. Frees associated resources.
+ * Perform an asynchronous lookup operation on the GNS,
+ * determining the zone using the TLD of the given name
+ * and the current configuration to resolve TLDs to zones.
*
- * @param lookup_handle lookup operation to stop.
+ * @param handle handle to the GNS service
+ * @param name the name to look up, including TLD
+ * @param type the record type to look up
+ * @param options local options for the lookup
+ * @param proc processor to call on result
+ * @param proc_cls closure for @a proc
+ * @return handle to the get request
+ */
+struct GNUNET_GNS_LookupWithTldRequest*
+GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle,
+ const char *name,
+ uint32_t type,
+ enum GNUNET_GNS_LocalOptions options,
+ GNUNET_GNS_LookupResultProcessor2 proc,
+ void *proc_cls);
+
+
+/**
+ * Cancel pending lookup request
*
- * On return lookup_handle will no longer be valid, caller
- * must not use again!!!
+ * @param ltr the lookup request to cancel
+ * @return closure from the lookup result processor
*/
-void
-GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle);
+void *
+GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr);
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
-
#endif
-/* gnunet_gns_service.h */
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff