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
91 * RSL_DELEGATE_VPN: Found VPN delegation
92 * RSL_DELEGATE_NS: Found NS delegation
93 * RSL_DELEGATE_PKEY: Found PKEY delegation
94 * RSL_CNAME_FOUND: Found CNAME record
95 * RSL_PKEY_REVOKED: Found PKEY has been revoked
99 RSL_RECORD_EXISTS = 1,
100 RSL_RECORD_EXPIRED = 2,
102 RSL_DELEGATE_VPN = 8,
103 RSL_DELEGATE_NS = 16,
104 RSL_DELEGATE_PKEY = 32,
105 RSL_CNAME_FOUND = 64,
106 RSL_PKEY_REVOKED = 128
110 * Handle to a currenty pending resolution
111 * a ResolverHandle is passed to, for example
112 * resolve_record_ns to resolve a record in the namestore.
113 * On result (positive or negative) the ResolutionResultProcessor
115 * If a timeout is set timeout_cont will be called.
116 * If no timeout is set (ie timeout forever) then background resolutions
117 * might be triggered.
119 struct ResolverHandle
121 /* The name to resolve */
122 char name[MAX_DNS_NAME_LENGTH];
124 /* has this query been answered? how many matches */
130 /* the authoritative zone to query */
131 struct GNUNET_CRYPTO_ShortHashCode authority;
133 /* the name of the authoritative zone to query */
134 char authority_name[MAX_DNS_LABEL_LENGTH];
136 /* a handle for dht lookups. should be NULL if no lookups are in progress */
137 struct GNUNET_DHT_GetHandle *get_handle;
139 /* timeout set for this lookup task */
140 struct GNUNET_TIME_Relative timeout;
142 /* a handle to a vpn request */
143 struct GNUNET_VPN_RedirectionRequest *vpn_handle;
145 /* a socket for a dns request */
146 struct GNUNET_NETWORK_Handle *dns_sock;
148 /* a synthesized dns name */
149 char dns_name[MAX_DNS_NAME_LENGTH];
151 /* the authoritative dns zone */
152 char dns_zone[MAX_DNS_NAME_LENGTH];
154 /* the address of the DNS server FIXME not needed? */
155 struct sockaddr_in dns_addr;
157 /* handle to the local stub resolver request */
158 struct GNUNET_RESOLVER_RequestHandle *dns_resolver_handle;
160 /* select task for DNS */
161 GNUNET_SCHEDULER_TaskIdentifier dns_read_task;
163 /* pointer to raw dns query payload FIXME needs to be freed/NULL */
164 char *dns_raw_packet;
166 /* size of the raw dns query */
167 size_t dns_raw_packet_size;
169 /* timeout task for the lookup */
170 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
172 /* continuation to call on timeout */
173 GNUNET_SCHEDULER_Task timeout_cont;
175 /* closure for timeout cont */
176 void* timeout_cont_cls;
178 /* called when resolution phase finishes */
179 ResolutionResultProcessor proc;
181 /* closure passed to proc */
184 /* DLL to store the authority chain */
185 struct AuthorityChain *authority_chain_head;
187 /* DLL to store the authority chain */
188 struct AuthorityChain *authority_chain_tail;
190 /* status of the resolution result */
191 enum ResolutionStatus status;
193 /* The provate local zone of this request */
194 struct GNUNET_CRYPTO_ShortHashCode private_local_zone;
197 * private key of an/our authoritative zone
198 * can be NULL but automatical PKEY import will not work
200 struct GNUNET_CRYPTO_RsaPrivateKey *priv_key;
203 * the heap node associated with this lookup, null if timeout is set
204 * used for DHT background lookups.
206 struct GNUNET_CONTAINER_HeapNode *dht_heap_node;
209 * Id for resolution process
211 unsigned long long id;
217 * Handle to a record lookup
219 struct RecordLookupHandle
221 /* the record type to look up */
222 enum GNUNET_GNS_RecordType record_type;
224 /* the name to look up */
225 char name[MAX_DNS_NAME_LENGTH];
227 /* Method to call on record resolution result */
228 RecordLookupProcessor proc;
230 /* closure to pass to proc */
237 * Handle to a shorten context
239 struct NameShortenHandle
241 /* Method to call on shorten result */
242 ShortenResultProcessor proc;
244 /* closure to pass to proc */
247 /* result of shorten */
248 char result[MAX_DNS_NAME_LENGTH];
251 struct GNUNET_CRYPTO_ShortHashCode *root_zone;
254 struct GNUNET_CRYPTO_ShortHashCode *private_zone;
256 /* name of private zone */
257 char private_zone_name[MAX_DNS_LABEL_LENGTH];
260 struct GNUNET_CRYPTO_ShortHashCode *shorten_zone;
262 /* name of shorten zone */
263 char shorten_zone_name[MAX_DNS_LABEL_LENGTH];
268 * Handle to a get authority context
270 struct GetNameAuthorityHandle
272 /* the name to look up authority for */
273 char name[MAX_DNS_NAME_LENGTH];
275 /* Method to call on result */
276 GetAuthorityResultProcessor proc;
278 /* closure to pass to proc */
283 * Handle to a pseu lookup
285 struct GetPseuAuthorityHandle
287 /* the name to store the zone under */
288 char name[MAX_DNS_LABEL_LENGTH];
290 /* test name to store the zone under */
291 char test_name[MAX_DNS_LABEL_LENGTH];
293 /* the zone of our authority */
294 struct GNUNET_CRYPTO_ShortHashCode our_zone;
296 /* the private key of the zone to store the pseu in */
297 struct GNUNET_CRYPTO_RsaPrivateKey *key;
299 /* a handle for dht lookups. should be NULL if no lookups are in progress */
300 struct GNUNET_DHT_GetHandle *get_handle;
302 /* timeout task for lookup */
303 GNUNET_SCHEDULER_TaskIdentifier timeout;
305 /* Head of the authority list */
306 struct AuthorityChain *ahead;
310 * Initialize the resolver
311 * MUST be called before other gns_resolver_* methods
313 * @param nh handle to the namestore
314 * @param dh handle to the dht
315 * @param lz the local zone
316 * @param cfg configuration handle
317 * @param max_bg_queries maximum amount of background queries
318 * @param ignore_pending ignore records that still require user confirmation
320 * @returns GNUNET_OK on success
323 gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh,
324 struct GNUNET_DHT_Handle *dh,
325 struct GNUNET_CRYPTO_ShortHashCode lz,
326 const struct GNUNET_CONFIGURATION_Handle *cfg,
327 unsigned long long max_bg_queries,
331 * Cleanup resolver: Terminate pending lookups
333 * @param cont continuation to call when finished
336 gns_resolver_cleanup(ResolverCleanupContinuation cont);
339 * Lookup of a record in a specific zone
340 * calls RecordLookupProcessor on result or timeout
342 * @param zone the root zone
343 * @param pzone the private local zone
344 * @param record_type the record type to look up
345 * @param name the name to look up
346 * @param key optional private key for authority caching
347 * @param timeout timeout for the resolution
348 * @param only_cached GNUNET_NO to only check locally not DHT for performance
349 * @param proc the processor to call
350 * @param cls the closure to pass to proc
353 gns_resolver_lookup_record(struct GNUNET_CRYPTO_ShortHashCode zone,
354 struct GNUNET_CRYPTO_ShortHashCode pzone,
355 uint32_t record_type,
357 struct GNUNET_CRYPTO_RsaPrivateKey *key,
358 struct GNUNET_TIME_Relative timeout,
360 RecordLookupProcessor proc,
364 * Shortens a name if possible. If the shortening fails
365 * name will be returned as shortened string. Else
366 * a shorter version of the name will be returned.
367 * There is no guarantee that the shortened name will
368 * actually be canonical/short etc.
370 * @param zone the root zone to use
371 * @param pzone the private zone to use
372 * @param szone the shorten zone to use
373 * @param name name to shorten
374 * @param private_zone_name name of the private zone
375 * @param shorten_zone_name name of the shorten zone
376 * @param proc the processor to call on shorten result
377 * @param proc_cls the closure to pass to proc
380 gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode *zone,
381 struct GNUNET_CRYPTO_ShortHashCode *pzone,
382 struct GNUNET_CRYPTO_ShortHashCode *szone,
384 const char* private_zone_name,
385 const char* shorten_zone_name,
386 ShortenResultProcessor proc,
390 * Tries to resolve the authority for name
393 * @param zone the root zone to look up for
394 * @param pzone the private local zone
395 * @param name the name to lookup up
396 * @param proc the processor to call when finished
397 * @param proc_cls the closure to pass to the processor
400 gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone,
401 struct GNUNET_CRYPTO_ShortHashCode pzone,
403 GetAuthorityResultProcessor proc,
407 * Generic function to check for TLDs
409 * @param name the name to check
410 * @param tld the tld to check
411 * @return GNUNET_YES or GNUNET_NO
414 is_tld(const char* name, const char* tld);
417 * Checks for gnunet/zkey
419 #define is_gnunet_tld(name) is_tld(name, GNUNET_GNS_TLD)
420 #define is_zkey_tld(name) is_tld(name, GNUNET_GNS_TLD_ZKEY)