X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fgns%2Fgnunet-service-gns_resolver.h;h=7728c397db35bd0469524d7c4ee691dd260f7e42;hb=4871fb1f27887f7957fab11ca13bb154c48202fe;hp=e973b0c52fb451c0be24e54707d6ab76f46a1d19;hpb=e4ec722c9fa516adaf7e655c21fa1f338b240131;p=oweals%2Fgnunet.git diff --git a/src/gns/gnunet-service-gns_resolver.h b/src/gns/gnunet-service-gns_resolver.h index e973b0c52..7728c397d 100644 --- a/src/gns/gnunet-service-gns_resolver.h +++ b/src/gns/gnunet-service-gns_resolver.h @@ -1,322 +1,127 @@ -#ifndef GNS_RESOLVER_H -#define GNS_RESOLVER_H - -#include "gns.h" -#include "gnunet_dht_service.h" - -#define DHT_OPERATION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3) -#define GNUNET_GNS_DEFAULT_LOOKUP_TIMEOUT \ - GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10) -#define DHT_LOOKUP_TIMEOUT DHT_OPERATION_TIMEOUT -#define DHT_GNS_REPLICATION_LEVEL 5 - -#define GNUNET_GNS_MAX_PARALLEL_LOOKUPS 500 - /* - * DLL to hold the authority chain - * we had to pass in the resolution process - */ -struct AuthorityChain -{ - struct AuthorityChain *prev; - - struct AuthorityChain *next; - - /* the zone hash of the authority */ - struct GNUNET_CRYPTO_ShortHashCode zone; - - /* (local) name of the authority */ - char name[MAX_DNS_LABEL_LENGTH]; + This file is part of GNUnet. + (C) 2009-2013 Christian Grothoff (and other contributing authors) - /* was the ns entry fresh */ - int fresh; -}; - -/* handle to a resolution process */ -struct ResolverHandle; + 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 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. +*/ /** - * processor for a resultion result - * - * @param cls the closure - * @param rh the resolution handle - * @param rd_count number of results - * @pram rd resukt data + * @file gns/gnunet-service-gns_resolver.h + * @brief GNUnet GNS service + * @author Martin Schanzenbach */ -typedef void (*RecordLookupProcessor) (void *cls, - uint32_t rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); - - -/** - * processor for a shorten result - * - * @param cls the closure - * @param name shortened name - */ -typedef void (*ShortenResultProcessor) (void *cls, const char* name); - - -/** - * processor for an authority result - * - * @param cls the closure - * @param name name - */ -typedef void (*GetAuthorityResultProcessor) (void *cls, const char* name); +#ifndef GNS_RESOLVER_H +#define GNS_RESOLVER_H +#include "gns.h" +#include "gnunet_dht_service.h" +#include "gnunet_namecache_service.h" /** - * processor for a resultion result + * Initialize the resolver subsystem. + * MUST be called before #GNS_resolver_lookup. * - * @param cls the closure - * @param rh the resolution handle - * @param rd_count number of results - * @param rd result data - */ -typedef void (*ResolutionResultProcessor) (void *cls, - struct ResolverHandle *rh, - uint32_t rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); - - -/** - * Resoltion status indicator - * EXISTS: the name to lookup exists - * EXPIRED: the name in the record expired - */ -enum ResolutionStatus -{ - EXISTS = 1, - EXPIRED = 2 -}; - -/** - * Handle to a currenty pending resolution - */ -struct ResolverHandle -{ - /* The name to resolve */ - char name[MAX_DNS_NAME_LENGTH]; - - /* has this query been answered? how many matches */ - int answered; - - /* the authoritative zone to query */ - struct GNUNET_CRYPTO_ShortHashCode authority; - - /* the name of the authoritative zone to query */ - char authority_name[MAX_DNS_LABEL_LENGTH]; - - /** - * we have an authority in namestore that - * may be able to resolve - */ - int authority_found; - - /* a handle for dht lookups. should be NULL if no lookups are in progress */ - struct GNUNET_DHT_GetHandle *get_handle; - - /* timeout set for this lookup task */ - struct GNUNET_TIME_Relative timeout; - - /* timeout task for the lookup */ - GNUNET_SCHEDULER_TaskIdentifier timeout_task; - - /* continuation to call on timeout */ - GNUNET_SCHEDULER_Task timeout_cont; - - /* closure for timeout cont */ - void* timeout_cont_cls; - - /* called when resolution phase finishes */ - ResolutionResultProcessor proc; - - /* closure passed to proc */ - void* proc_cls; - - /* DLL to store the authority chain */ - struct AuthorityChain *authority_chain_head; - - /* DLL to store the authority chain */ - struct AuthorityChain *authority_chain_tail; - - /* status of the resolution result */ - enum ResolutionStatus status; - - /** - * private key of an/our authoritative zone - * can be NULL but automatical PKEY import will not work - */ - struct GNUNET_CRYPTO_RsaPrivateKey *priv_key; - - /** - * the heap node associated with this lookup, null if timeout is set - * used for DHT background lookups. - */ - struct GNUNET_CONTAINER_HeapNode *dht_heap_node; - -}; - - -/** - * Handle to a record lookup - */ -struct RecordLookupHandle -{ - /* the record type to look up */ - enum GNUNET_GNS_RecordType record_type; - - /* the name to look up */ - char name[MAX_DNS_NAME_LENGTH]; - - /* Method to call on record resolution result */ - RecordLookupProcessor proc; - - /* closure to pass to proc */ - void* proc_cls; - -}; - - -/** - * Handle to a shorten context + * @param nh handle to the namestore + * @param nc the namecache handle + * @param dht handle to the dht + * @param c configuration handle + * @param max_bg_queries maximum amount of background queries */ -struct NameShortenHandle -{ - - - /* Method to call on shorten result */ - ShortenResultProcessor proc; - - /* closure to pass to proc */ - void* proc_cls; +void +GNS_resolver_init (struct GNUNET_NAMESTORE_Handle *nh, + struct GNUNET_NAMECACHE_Handle *nc, + struct GNUNET_DHT_Handle *dht, + const struct GNUNET_CONFIGURATION_Handle *c, + unsigned long long max_bg_queries); -}; /** - * Handle to a get authority context + * Cleanup resolver: Terminate pending lookups */ -struct GetNameAuthorityHandle -{ - - /* the name to look up authority for */ - char name[MAX_DNS_NAME_LENGTH]; - - /* Method to call on result */ - GetAuthorityResultProcessor proc; - - /* closure to pass to proc */ - void* proc_cls; +void +GNS_resolver_done (void); -}; /** - * Handle to a pseu lookup + * Handle for an active request. */ -struct GetPseuAuthorityHandle -{ - /* the name given from delegation */ - char name[MAX_DNS_LABEL_LENGTH]; - - /* name to store the pseu under */ - char new_name[MAX_DNS_LABEL_LENGTH]; - - /* the zone of discovered authority */ - struct GNUNET_CRYPTO_ShortHashCode new_zone; - - /* the zone of our authority */ - struct GNUNET_CRYPTO_ShortHashCode zone; +struct GNS_ResolverHandle; - /* the private key of the zone to store the pseu in */ - struct GNUNET_CRYPTO_RsaPrivateKey *key; - - /* a handle for dht lookups. should be NULL if no lookups are in progress */ - struct GNUNET_DHT_GetHandle *get_handle; - - /* timeout task for lookup */ - GNUNET_SCHEDULER_TaskIdentifier timeout; -}; /** - * Initialize the resolver - * MUST be called before other gns_resolver_* methods + * Function called with results for a GNS resolution. * - * @param nh handle to the namestore - * @param dh handle to the dht - * @returns GNUNET_OK on success + * @param cls closure + * @param rd_count number of records in @a rd + * @param rd records returned for the lookup */ -int -gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh, - struct GNUNET_DHT_Handle *dh); +typedef void (*GNS_ResultProcessor)(void *cls, + uint32_t rd_count, + const struct GNUNET_GNSRECORD_Data *rd); + /** * Lookup of a record in a specific zone - * calls lookup result processor on result + * calls RecordLookupProcessor on result or timeout * - * @param zone the root zone + * @param zone the zone to perform the lookup in * @param record_type the record type to look up * @param name the name to look up - * @param key optional private key for authority caching + * @param shorten_key optional private key for authority caching, can be NULL + * @param only_cached GNUNET_NO to only check locally not DHT for performance * @param proc the processor to call - * @param cls the closure to pass to proc + * @param proc_cls the closure to pass to @a proc + * @return handle to cancel operation */ -void -gns_resolver_lookup_record(struct GNUNET_CRYPTO_ShortHashCode zone, - uint32_t record_type, - const char* name, - struct GNUNET_CRYPTO_RsaPrivateKey *key, - struct GNUNET_TIME_Relative timeout, - RecordLookupProcessor proc, - void* cls); +struct GNS_ResolverHandle * +GNS_resolver_lookup (const struct GNUNET_CRYPTO_EcdsaPublicKey *zone, + uint32_t record_type, + const char *name, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_key, + int only_cached, + GNS_ResultProcessor proc, + void *proc_cls); -/** - * Shortens a name if possible. If the shortening fails - * name will be returned as shortened string. Else - * a shorter version of the name will be returned. - * There is no guarantee that the shortened name will - * actually be canonical/short etc. - * - * @param zone the zone to perform the operation in - * @param name name to shorten - * @param proc the processor to call on shorten result - * @param proc_cls teh closure to pass to proc - */ -void -gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, - const char* name, - ShortenResultProcessor proc, - void* cls); /** - * Tries to resolve the authority for name - * in our namestore + * Cancel active resolution (i.e. client disconnected). * - * @param zone the root zone to look up for - * @param name the name to lookup up - * @param proc the processor to call when finished - * @param cls the closure to pass to the processor + * @param rh resolution to abort */ void -gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone, - const char* name, - GetAuthorityResultProcessor proc, - void* cls); +GNS_resolver_lookup_cancel (struct GNS_ResolverHandle *rh); + + + /** - * Generic function to check for TLDs + * Generic function to check for TLDs. Checks if "name" ends in ".tld" * * @param name the name to check * @param tld the tld to check - * @return GNUNET_YES or GNUNET_NO + * @return #GNUNET_YES or #GNUNET_NO */ int -is_tld(const char* name, const char* tld); +is_tld (const char *name, + const char *tld); + + /** - * Checks for gnunet/zkey + * Checks for gnu/zkey */ -#define is_gnunet_tld(name) is_tld(name, GNUNET_GNS_TLD) +#define is_gnu_tld(name) is_tld(name, GNUNET_GNS_TLD) #define is_zkey_tld(name) is_tld(name, GNUNET_GNS_TLD_ZKEY)