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,
101 * Handle to a currenty pending resolution
102 * a ResolverHandle is passed to, for example
103 * resolve_record_ns to resolve a record in the namestore.
104 * On result (positive or negative) the ResolutionResultProcessor
106 * If a timeout is set timeout_cont will be called.
107 * If no timeout is set (ie timeout forever) then background resolutions
108 * might be triggered.
110 struct ResolverHandle
112 /* The name to resolve */
113 char name[MAX_DNS_NAME_LENGTH];
115 /* has this query been answered? how many matches */
121 /* the authoritative zone to query */
122 struct GNUNET_CRYPTO_ShortHashCode authority;
124 /* the name of the authoritative zone to query */
125 char authority_name[MAX_DNS_LABEL_LENGTH];
127 /* a handle for dht lookups. should be NULL if no lookups are in progress */
128 struct GNUNET_DHT_GetHandle *get_handle;
130 /* timeout set for this lookup task */
131 struct GNUNET_TIME_Relative timeout;
133 /* a handle to a vpn request */
134 struct GNUNET_VPN_RedirectionRequest *vpn_handle;
136 /* timeout task for the lookup */
137 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
139 /* continuation to call on timeout */
140 GNUNET_SCHEDULER_Task timeout_cont;
142 /* closure for timeout cont */
143 void* timeout_cont_cls;
145 /* called when resolution phase finishes */
146 ResolutionResultProcessor proc;
148 /* closure passed to proc */
151 /* DLL to store the authority chain */
152 struct AuthorityChain *authority_chain_head;
154 /* DLL to store the authority chain */
155 struct AuthorityChain *authority_chain_tail;
157 /* status of the resolution result */
158 enum ResolutionStatus status;
160 /* The provate local zone of this request */
161 struct GNUNET_CRYPTO_ShortHashCode private_local_zone;
164 * private key of an/our authoritative zone
165 * can be NULL but automatical PKEY import will not work
167 struct GNUNET_CRYPTO_RsaPrivateKey *priv_key;
170 * the heap node associated with this lookup, null if timeout is set
171 * used for DHT background lookups.
173 struct GNUNET_CONTAINER_HeapNode *dht_heap_node;
176 * Id for resolution process
178 unsigned long long id;
184 * Handle to a record lookup
186 struct RecordLookupHandle
188 /* the record type to look up */
189 enum GNUNET_GNS_RecordType record_type;
191 /* the name to look up */
192 char name[MAX_DNS_NAME_LENGTH];
194 /* Method to call on record resolution result */
195 RecordLookupProcessor proc;
197 /* closure to pass to proc */
204 * Handle to a shorten context
206 struct NameShortenHandle
208 /* Method to call on shorten result */
209 ShortenResultProcessor proc;
211 /* closure to pass to proc */
214 /* result of shorten */
215 char result[MAX_DNS_NAME_LENGTH];
218 struct GNUNET_CRYPTO_ShortHashCode *root_zone;
221 struct GNUNET_CRYPTO_ShortHashCode *private_zone;
223 /* name of private zone */
224 char private_zone_name[MAX_DNS_LABEL_LENGTH];
227 struct GNUNET_CRYPTO_ShortHashCode *shorten_zone;
229 /* name of shorten zone */
230 char shorten_zone_name[MAX_DNS_LABEL_LENGTH];
235 * Handle to a get authority context
237 struct GetNameAuthorityHandle
239 /* the name to look up authority for */
240 char name[MAX_DNS_NAME_LENGTH];
242 /* Method to call on result */
243 GetAuthorityResultProcessor proc;
245 /* closure to pass to proc */
250 * Handle to a pseu lookup
252 struct GetPseuAuthorityHandle
254 /* the name to store the zone under */
255 char name[MAX_DNS_LABEL_LENGTH];
257 /* test name to store the zone under */
258 char test_name[MAX_DNS_LABEL_LENGTH];
260 /* the zone of our authority */
261 struct GNUNET_CRYPTO_ShortHashCode our_zone;
263 /* the private key of the zone to store the pseu in */
264 struct GNUNET_CRYPTO_RsaPrivateKey *key;
266 /* a handle for dht lookups. should be NULL if no lookups are in progress */
267 struct GNUNET_DHT_GetHandle *get_handle;
269 /* timeout task for lookup */
270 GNUNET_SCHEDULER_TaskIdentifier timeout;
272 /* Head of the authority list */
273 struct AuthorityChain *ahead;
277 * Initialize the resolver
278 * MUST be called before other gns_resolver_* methods
280 * @param nh handle to the namestore
281 * @param dh handle to the dht
282 * @param lz the local zone
283 * @param max_bg_queries maximum amount of background queries
284 * @param ignore_pending ignore records that still require user confirmation
286 * @returns GNUNET_OK on success
289 gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh,
290 struct GNUNET_DHT_Handle *dh,
291 struct GNUNET_CRYPTO_ShortHashCode lz,
292 unsigned long long max_bg_queries,
296 * Cleanup resolver: Terminate pending lookups
298 * @param cont continuation to call when finished
301 gns_resolver_cleanup(ResolverCleanupContinuation cont);
304 * Lookup of a record in a specific zone
305 * calls RecordLookupProcessor on result or timeout
307 * @param zone the root zone
308 * @param pzone the private local zone
309 * @param record_type the record type to look up
310 * @param name the name to look up
311 * @param key optional private key for authority caching
312 * @param timeout timeout for the resolution
313 * @param only_cached GNUNET_NO to only check locally not DHT for performance
314 * @param proc the processor to call
315 * @param cls the closure to pass to proc
318 gns_resolver_lookup_record(struct GNUNET_CRYPTO_ShortHashCode zone,
319 struct GNUNET_CRYPTO_ShortHashCode pzone,
320 uint32_t record_type,
322 struct GNUNET_CRYPTO_RsaPrivateKey *key,
323 struct GNUNET_TIME_Relative timeout,
325 RecordLookupProcessor proc,
329 * Shortens a name if possible. If the shortening fails
330 * name will be returned as shortened string. Else
331 * a shorter version of the name will be returned.
332 * There is no guarantee that the shortened name will
333 * actually be canonical/short etc.
335 * @param zone the root zone to use
336 * @param pzone the private zone to use
337 * @param szone the shorten zone to use
338 * @param name name to shorten
339 * @param private_zone_name name of the private zone
340 * @param shorten_zone_name name of the shorten zone
341 * @param proc the processor to call on shorten result
342 * @param proc_cls the closure to pass to proc
345 gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode *zone,
346 struct GNUNET_CRYPTO_ShortHashCode *pzone,
347 struct GNUNET_CRYPTO_ShortHashCode *szone,
349 const char* private_zone_name,
350 const char* shorten_zone_name,
351 ShortenResultProcessor proc,
355 * Tries to resolve the authority for name
358 * @param zone the root zone to look up for
359 * @param pzone the private local zone
360 * @param name the name to lookup up
361 * @param proc the processor to call when finished
362 * @param proc_cls the closure to pass to the processor
365 gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone,
366 struct GNUNET_CRYPTO_ShortHashCode pzone,
368 GetAuthorityResultProcessor proc,
372 * Generic function to check for TLDs
374 * @param name the name to check
375 * @param tld the tld to check
376 * @return GNUNET_YES or GNUNET_NO
379 is_tld(const char* name, const char* tld);
382 * Checks for gnunet/zkey
384 #define is_gnunet_tld(name) is_tld(name, GNUNET_GNS_TLD)
385 #define is_zkey_tld(name) is_tld(name, GNUNET_GNS_TLD_ZKEY)