5 #include "gnunet_dht_service.h"
7 #define DHT_OPERATION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
8 #define GNUNET_GNS_DEFAULT_LOOKUP_TIMEOUT \
9 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
10 #define DHT_LOOKUP_TIMEOUT DHT_OPERATION_TIMEOUT
11 #define DHT_GNS_REPLICATION_LEVEL 5
13 #define GNUNET_GNS_MAX_PARALLEL_LOOKUPS 500
16 * DLL to hold the authority chain
17 * we had to pass in the resolution process
21 struct AuthorityChain *prev;
23 struct AuthorityChain *next;
25 /* the zone hash of the authority */
26 struct GNUNET_CRYPTO_ShortHashCode zone;
28 /* (local) name of the authority */
29 char name[MAX_DNS_LABEL_LENGTH];
31 /* was the ns entry fresh */
35 /* handle to a resolution process */
36 struct ResolverHandle;
39 * continuation called when cleanup of resolver finishes
41 typedef void (*ResolverCleanupContinuation) (void);
44 * processor for a record lookup result
46 * @param cls the closure
47 * @param rd_count number of results
48 * @param rd result data
50 typedef void (*RecordLookupProcessor) (void *cls,
52 const struct GNUNET_NAMESTORE_RecordData *rd);
56 * processor for a shorten result
58 * @param cls the closure
59 * @param name shortened name
61 typedef void (*ShortenResultProcessor) (void *cls, const char* name);
65 * processor for an authority result
67 * @param cls the closure
70 typedef void (*GetAuthorityResultProcessor) (void *cls, const char* name);
73 * processor for a resolution result
75 * @param cls the closure
76 * @param rh the resolution handle
77 * @param rd_count number of results
78 * @param rd result data
80 typedef void (*ResolutionResultProcessor) (void *cls,
81 struct ResolverHandle *rh,
83 const struct GNUNET_NAMESTORE_RecordData *rd);
87 * Resolution status indicator
88 * RSL_RECORD_EXISTS: the name to lookup exists
89 * RSL_RECORD_EXPIRED: the name in the record expired
90 * RSL_TIMED_OUT: resolution timed out
94 RSL_RECORD_EXISTS = 1,
95 RSL_RECORD_EXPIRED = 2,
100 * Handle to a currenty pending resolution
101 * a ResolverHandle is passed to, for example
102 * resolve_record_ns to resolve a record in the namestore.
103 * On result (positive or negative) the ResolutionResultProcessor
105 * If a timeout is set timeout_cont will be called.
106 * If no timeout is set (ie timeout forever) then background resolutions
107 * might be triggered.
109 struct ResolverHandle
111 /* The name to resolve */
112 char name[MAX_DNS_NAME_LENGTH];
114 /* has this query been answered? how many matches */
117 /* the authoritative zone to query */
118 struct GNUNET_CRYPTO_ShortHashCode authority;
120 /* the name of the authoritative zone to query */
121 char authority_name[MAX_DNS_LABEL_LENGTH];
123 /* a handle for dht lookups. should be NULL if no lookups are in progress */
124 struct GNUNET_DHT_GetHandle *get_handle;
126 /* timeout set for this lookup task */
127 struct GNUNET_TIME_Relative timeout;
129 /* timeout task for the lookup */
130 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
132 /* continuation to call on timeout */
133 GNUNET_SCHEDULER_Task timeout_cont;
135 /* closure for timeout cont */
136 void* timeout_cont_cls;
138 /* called when resolution phase finishes */
139 ResolutionResultProcessor proc;
141 /* closure passed to proc */
144 /* DLL to store the authority chain */
145 struct AuthorityChain *authority_chain_head;
147 /* DLL to store the authority chain */
148 struct AuthorityChain *authority_chain_tail;
150 /* status of the resolution result */
151 enum ResolutionStatus status;
153 /* The provate local zone of this request */
154 struct GNUNET_CRYPTO_ShortHashCode private_local_zone;
157 * private key of an/our authoritative zone
158 * can be NULL but automatical PKEY import will not work
160 struct GNUNET_CRYPTO_RsaPrivateKey *priv_key;
163 * the heap node associated with this lookup, null if timeout is set
164 * used for DHT background lookups.
166 struct GNUNET_CONTAINER_HeapNode *dht_heap_node;
169 * Id for resolution process
171 unsigned long long id;
177 * Handle to a record lookup
179 struct RecordLookupHandle
181 /* the record type to look up */
182 enum GNUNET_GNS_RecordType record_type;
184 /* the name to look up */
185 char name[MAX_DNS_NAME_LENGTH];
187 /* Method to call on record resolution result */
188 RecordLookupProcessor proc;
190 /* closure to pass to proc */
197 * Handle to a shorten context
199 struct NameShortenHandle
201 /* Method to call on shorten result */
202 ShortenResultProcessor proc;
204 /* closure to pass to proc */
209 * Handle to a get authority context
211 struct GetNameAuthorityHandle
213 /* the name to look up authority for */
214 char name[MAX_DNS_NAME_LENGTH];
216 /* Method to call on result */
217 GetAuthorityResultProcessor proc;
219 /* closure to pass to proc */
224 * Handle to a pseu lookup
226 struct GetPseuAuthorityHandle
228 /* the name given from delegation */
229 char name[MAX_DNS_LABEL_LENGTH];
231 /* name to store the pseu under */
232 char new_name[MAX_DNS_LABEL_LENGTH];
234 /* the zone of discovered authority */
235 struct GNUNET_CRYPTO_ShortHashCode new_zone;
237 /* the zone of our authority */
238 struct GNUNET_CRYPTO_ShortHashCode zone;
240 /* the private key of the zone to store the pseu in */
241 struct GNUNET_CRYPTO_RsaPrivateKey *key;
243 /* a handle for dht lookups. should be NULL if no lookups are in progress */
244 struct GNUNET_DHT_GetHandle *get_handle;
246 /* timeout task for lookup */
247 GNUNET_SCHEDULER_TaskIdentifier timeout;
251 * Initialize the resolver
252 * MUST be called before other gns_resolver_* methods
254 * @param nh handle to the namestore
255 * @param dh handle to the dht
256 * @param lz the local zone
257 * @param max_bg_queries maximum amount of background queries
258 * @param ignore_pending ignore records that still require user confirmation
260 * @returns GNUNET_OK on success
263 gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh,
264 struct GNUNET_DHT_Handle *dh,
265 struct GNUNET_CRYPTO_ShortHashCode lz,
266 unsigned long long max_bg_queries,
270 * Cleanup resolver: Terminate pending lookups
272 * @param cont continuation to call when finished
275 gns_resolver_cleanup(ResolverCleanupContinuation cont);
278 * Lookup of a record in a specific zone
279 * calls RecordLookupProcessor on result or timeout
281 * @param zone the root zone
282 * @param pzone the private local zone
283 * @param record_type the record type to look up
284 * @param name the name to look up
285 * @param key optional private key for authority caching
286 * @param timeout timeout for the resolution
287 * @param proc the processor to call
288 * @param cls the closure to pass to proc
291 gns_resolver_lookup_record(struct GNUNET_CRYPTO_ShortHashCode zone,
292 struct GNUNET_CRYPTO_ShortHashCode pzone,
293 uint32_t record_type,
295 struct GNUNET_CRYPTO_RsaPrivateKey *key,
296 struct GNUNET_TIME_Relative timeout,
297 RecordLookupProcessor proc,
301 * Shortens a name if possible. If the shortening fails
302 * name will be returned as shortened string. Else
303 * a shorter version of the name will be returned.
304 * There is no guarantee that the shortened name will
305 * actually be canonical/short etc.
307 * @param zone the zone to perform the operation in
308 * @param pzone the private local zone
309 * @param name name to shorten
310 * @param key optional private key for background lookups and PSEU import
311 * @param proc the processor to call on shorten result
312 * @param proc_cls the closure to pass to proc
315 gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone,
316 struct GNUNET_CRYPTO_ShortHashCode pzone,
318 struct GNUNET_CRYPTO_RsaPrivateKey *key,
319 ShortenResultProcessor proc,
323 * Tries to resolve the authority for name
326 * @param zone the root zone to look up for
327 * @param pzone the private local zone
328 * @param name the name to lookup up
329 * @param proc the processor to call when finished
330 * @param proc_cls the closure to pass to the processor
333 gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone,
334 struct GNUNET_CRYPTO_ShortHashCode pzone,
336 GetAuthorityResultProcessor proc,
340 * Generic function to check for TLDs
342 * @param name the name to check
343 * @param tld the tld to check
344 * @return GNUNET_YES or GNUNET_NO
347 is_tld(const char* name, const char* tld);
350 * Checks for gnunet/zkey
352 #define is_gnunet_tld(name) is_tld(name, GNUNET_GNS_TLD)
353 #define is_zkey_tld(name) is_tld(name, GNUNET_GNS_TLD_ZKEY)