Merge branch 'master' of git+ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / util / gnunet-service-resolver.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2007-2016 GNUnet e.V.
4
5      GNUnet is free software: you can redistribute it and/or modify it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      Affero General Public License for more details.
14
15      You should have received a copy of the GNU Affero General Public License
16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18      SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
21 /**
22  * @file util/gnunet-service-resolver.c
23  * @brief code to do DNS resolution
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_protocols.h"
29 #include "gnunet_statistics_service.h"
30 #include "resolver.h"
31
32
33 /**
34  * How long do we wait for DNS answers?
35  */
36 #define DNS_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
37
38 /**
39  * Maximum number of hostnames we cache results for.
40  */
41 #define MAX_CACHE 1024
42
43 /**
44  * Entry in list of cached DNS records for a hostname.
45  */
46 struct RecordListEntry
47 {
48   /**
49    * This is a doubly linked list.
50    */
51   struct RecordListEntry *next;
52
53   /**
54    * This is a doubly linked list.
55    */
56   struct RecordListEntry *prev;
57
58   /**
59    * Cached data.
60    */
61   struct GNUNET_DNSPARSER_Record *record;
62
63 };
64
65
66 /**
67  * A cached DNS lookup result.
68  */
69 struct ResolveCache
70 {
71   /**
72    * This is a doubly linked list.
73    */
74   struct ResolveCache *next;
75
76   /**
77    * This is a doubly linked list.
78    */
79   struct ResolveCache *prev;
80
81   /**
82    * Which hostname is this cache for?
83    */
84   char *hostname;
85
86   /**
87    * head of a double linked list containing the lookup results
88    */
89   struct RecordListEntry *records_head;
90
91   /**
92    * tail of a double linked list containing the lookup results
93    */
94   struct RecordListEntry *records_tail;
95
96 };
97
98
99 /**
100  * Information about pending lookups.
101  */
102 struct ActiveLookup
103 {
104   /**
105    * Stored in a DLL.
106    */
107   struct ActiveLookup *next;
108
109   /**
110    * Stored in a DLL.
111    */
112   struct ActiveLookup *prev;
113
114   /**
115    * The client that queried the records contained in this cache entry.
116    */
117   struct GNUNET_SERVICE_Client *client;
118
119   /**
120    * handle for cancelling a request
121    */
122   struct GNUNET_DNSSTUB_RequestSocket *resolve_handle;
123
124   /**
125    * handle for the resolution timeout task
126    */
127   struct GNUNET_SCHEDULER_Task *timeout_task;
128
129   /**
130    * Which hostname are we resolving?
131    */
132   char *hostname;
133
134   /**
135    * If @a record_type is #GNUNET_DNSPARSER_TYPE_ALL, did we go again
136    * for the AAAA records yet?
137    */
138   int did_aaaa;
139
140   /**
141    * type of queried DNS record
142    */
143   uint16_t record_type;
144
145   /**
146    * Unique request ID of a client if a query for this hostname/record_type
147    * is currently pending, undefined otherwise.
148    */
149   uint32_t client_request_id;
150
151   /**
152    * Unique DNS request ID of a client if a query for this hostname/record_type
153    * is currently pending, undefined otherwise.
154    */
155   uint16_t dns_id;
156
157 };
158
159
160 /**
161  * Start of the linked list of cached DNS lookup results.
162  */
163 static struct ResolveCache *cache_head;
164
165 /**
166  * Tail of the linked list of cached DNS lookup results.
167  */
168 static struct ResolveCache *cache_tail;
169
170 /**
171  * Head of the linked list of DNS lookup results from /etc/hosts.
172  */
173 static struct ResolveCache *hosts_head;
174
175 /**
176  * Tail of the linked list of DNS lookup results from /etc/hosts.
177  */
178 static struct ResolveCache *hosts_tail;
179
180 /**
181  * Start of the linked list of active DNS lookups.
182  */
183 static struct ActiveLookup *lookup_head;
184
185 /**
186  * Tail of the linked list of active DNS lookups.
187  */
188 static struct ActiveLookup *lookup_tail;
189
190 /**
191  * context of dnsstub library
192  */
193 static struct GNUNET_DNSSTUB_Context *dnsstub_ctx;
194
195 /**
196  * My domain, to be appended to the hostname to get a FQDN.
197  */
198 static char *my_domain;
199
200 /**
201  * How many entries do we have in #cache_head DLL?
202  */
203 static unsigned int cache_size;
204
205
206 /**
207  * Remove @a entry from cache.
208  *
209  * @param rc entry to free
210  */
211 static void
212 free_cache_entry (struct ResolveCache *rc)
213 {
214   struct RecordListEntry *pos;
215
216   while (NULL != (pos = rc->records_head))
217   {
218     GNUNET_CONTAINER_DLL_remove (rc->records_head,
219                                  rc->records_tail,
220                                  pos);
221     GNUNET_DNSPARSER_free_record (pos->record);
222     GNUNET_free (pos->record);
223     GNUNET_free (pos);
224   }
225   GNUNET_free_non_null (rc->hostname);
226   GNUNET_CONTAINER_DLL_remove (cache_head,
227                                cache_tail,
228                                rc);
229   cache_size--;
230   GNUNET_free (rc);
231 }
232
233
234 /**
235  * Remove @a entry from cache.
236  *
237  * @param rc entry to free
238  */
239 static void
240 free_hosts_entry (struct ResolveCache *rc)
241 {
242   struct RecordListEntry *pos;
243
244   while (NULL != (pos = rc->records_head))
245   {
246     GNUNET_CONTAINER_DLL_remove (rc->records_head,
247                                  rc->records_tail,
248                                  pos);
249     GNUNET_DNSPARSER_free_record (pos->record);
250     GNUNET_free (pos->record);
251     GNUNET_free (pos);
252   }
253   GNUNET_free_non_null (rc->hostname);
254   GNUNET_CONTAINER_DLL_remove (hosts_head,
255                                hosts_tail,
256                                rc);
257   cache_size--;
258   GNUNET_free (rc);
259 }
260
261
262 /**
263  * Release resources associated with @a al
264  *
265  * @param al an active lookup
266  */
267 static void
268 free_active_lookup (struct ActiveLookup *al)
269 {
270   GNUNET_CONTAINER_DLL_remove (lookup_head,
271                                lookup_tail,
272                                al);
273   if (NULL != al->resolve_handle)
274   {
275     GNUNET_DNSSTUB_resolve_cancel (al->resolve_handle);
276     al->resolve_handle = NULL;
277   }
278   if (NULL != al->timeout_task)
279   {
280     GNUNET_SCHEDULER_cancel (al->timeout_task);
281     al->timeout_task = NULL;
282   }
283   GNUNET_free_non_null (al->hostname);
284   GNUNET_free (al);
285 }
286
287
288
289 /**
290  * Find out if the configuration file line contains a string
291  * starting with "nameserver ", and if so, return a copy of
292  * the nameserver's IP.
293  *
294  * @param line line to parse
295  * @param line_len number of characters in @a line
296  * @return NULL if no nameserver is configured in this @a line
297  */
298 static char *
299 extract_dns_server (const char* line,
300                     size_t line_len)
301 {
302   if (0 == strncmp (line,
303                     "nameserver ",
304                     strlen ("nameserver ")))
305     return GNUNET_strndup (line + strlen ("nameserver "),
306                            line_len - strlen ("nameserver "));
307   return NULL;
308 }
309
310
311 /**
312  * Find out if the configuration file line contains a string
313  * starting with "search ", and if so, return a copy of
314  * the machine's search domain.
315  *
316  * @param line line to parse
317  * @param line_len number of characters in @a line
318  * @return NULL if no nameserver is configured in this @a line
319  */
320 static char *
321 extract_search_domain (const char* line,
322                        size_t line_len)
323 {
324   if (0 == strncmp (line,
325                     "search ",
326                     strlen ("search ")))
327     return GNUNET_strndup (line + strlen ("search "),
328                            line_len - strlen ("search "));
329   return NULL;
330 }
331
332
333 /**
334  * Reads the list of nameservers from /etc/resolve.conf
335  *
336  * @param server_addrs[out] a list of null-terminated server address strings
337  * @return the number of server addresses in @server_addrs, -1 on error
338  */
339 static int
340 lookup_dns_servers (char ***server_addrs)
341 {
342   struct GNUNET_DISK_FileHandle *fh;
343   struct GNUNET_DISK_MapHandle *mh;
344   off_t bytes_read;
345   const char *buf;
346   size_t read_offset;
347   unsigned int num_dns_servers;
348
349   fh = GNUNET_DISK_file_open ("/etc/resolv.conf",
350                               GNUNET_DISK_OPEN_READ,
351                               GNUNET_DISK_PERM_NONE);
352   if (NULL == fh)
353   {
354     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
355                 "Could not open /etc/resolv.conf. "
356                 "DNS resolution will not be possible.\n");
357     return -1;
358   }
359   if (GNUNET_OK !=
360       GNUNET_DISK_file_handle_size (fh,
361                                     &bytes_read))
362   {
363     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
364                 "Could not determine size of /etc/resolv.conf. "
365                 "DNS resolution will not be possible.\n");
366     GNUNET_DISK_file_close (fh);
367     return -1;
368   }
369   if ((size_t) bytes_read > SIZE_MAX)
370   {
371     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
372                 "/etc/resolv.conf file too large to mmap. "
373                 "DNS resolution will not be possible.\n");
374     GNUNET_DISK_file_close (fh);
375     return -1;
376   }
377   buf = GNUNET_DISK_file_map (fh,
378                               &mh,
379                               GNUNET_DISK_MAP_TYPE_READ,
380                               (size_t) bytes_read);
381   *server_addrs = NULL;
382   read_offset = 0;
383   num_dns_servers = 0;
384   while (read_offset < (size_t) bytes_read)
385   {
386     const char *newline;
387     size_t line_len;
388     char *dns_server;
389
390     newline = strchr (buf + read_offset,
391                       '\n');
392     if (NULL == newline)
393       break;
394     line_len = newline - buf - read_offset;
395     dns_server = extract_dns_server (buf + read_offset,
396                                      line_len);
397     if (NULL != dns_server)
398     {
399       GNUNET_array_append (*server_addrs,
400                            num_dns_servers,
401                            dns_server);
402     }
403     else if (NULL == my_domain)
404     {
405       my_domain = extract_search_domain (buf + read_offset,
406                                          line_len);
407     }
408     read_offset += line_len + 1;
409   }
410   GNUNET_DISK_file_unmap (mh);
411   GNUNET_DISK_file_close (fh);
412   return (int) num_dns_servers;
413 }
414
415
416 /**
417  * Compute name to use for DNS reverse lookups from @a ip.
418  *
419  * @param ip IP address to resolve, in binary format, network byte order
420  * @param af address family of @a ip, AF_INET or AF_INET6
421  */
422 static char *
423 make_reverse_hostname (const void *ip,
424                        int af)
425 {
426   char *buf = GNUNET_new_array (80,
427                                 char);
428   int pos = 0;
429
430   if (AF_INET == af)
431   {
432     struct in_addr *addr = (struct in_addr *)ip;
433     uint32_t ip_int = addr->s_addr;
434
435     for (int i = 3; i >= 0; i--)
436     {
437       int n = GNUNET_snprintf (buf + pos,
438                                80 - pos,
439                                "%u.",
440                                ((uint8_t *)&ip_int)[i]);
441       if (n < 0)
442       {
443         GNUNET_free (buf);
444         return NULL;
445       }
446       pos += n;
447     }
448     pos += GNUNET_snprintf (buf + pos,
449                             80 - pos,
450                             "in-addr.arpa");
451   }
452   else if (AF_INET6 == af)
453   {
454     struct in6_addr *addr = (struct in6_addr *)ip;
455     for (int i = 15; i >= 0; i--)
456     {
457       int n = GNUNET_snprintf (buf + pos,
458                                80 - pos,
459                                "%x.",
460                                addr->s6_addr[i] & 0xf);
461       if (n < 0)
462       {
463         GNUNET_free (buf);
464         return NULL;
465       }
466       pos += n;
467       n = GNUNET_snprintf (buf + pos,
468                            80 - pos,
469                            "%x.",
470                            addr->s6_addr[i] >> 4);
471       if (n < 0)
472       {
473         GNUNET_free (buf);
474         return NULL;
475       }
476       pos += n;
477     }
478     pos += GNUNET_snprintf (buf + pos,
479                             80 - pos,
480                             "ip6.arpa");
481   }
482   buf[pos] = '\0';
483   return buf;
484 }
485
486
487 /**
488  * Send DNS @a record back to our @a client.
489  *
490  * @param record information to transmit
491  * @param record_type requested record type from client
492  * @param client_request_id to which request are we responding
493  * @param client where to send @a record
494  * @return #GNUNET_YES if we sent a reply,
495  *         #GNUNET_NO if the record type is not understood or
496  *         does not match @a record_type
497  */
498 static int
499 send_reply (struct GNUNET_DNSPARSER_Record *record,
500             uint16_t record_type,
501             uint32_t client_request_id,
502             struct GNUNET_SERVICE_Client *client)
503 {
504   struct GNUNET_RESOLVER_ResponseMessage *msg;
505   struct GNUNET_MQ_Envelope *env;
506   const void *payload;
507   size_t payload_len;
508
509   switch (record->type)
510   {
511   case GNUNET_DNSPARSER_TYPE_CNAME:
512     if (GNUNET_DNSPARSER_TYPE_CNAME != record_type)
513       return GNUNET_NO;
514     payload = record->data.hostname;
515     payload_len = strlen (record->data.hostname) + 1;
516     break;
517   case GNUNET_DNSPARSER_TYPE_PTR:
518     if (GNUNET_DNSPARSER_TYPE_PTR != record_type)
519       return GNUNET_NO;
520     payload = record->data.hostname;
521     payload_len = strlen (record->data.hostname) + 1;
522     break;
523   case GNUNET_DNSPARSER_TYPE_A:
524     if ( (GNUNET_DNSPARSER_TYPE_A != record_type) &&
525          (GNUNET_DNSPARSER_TYPE_ALL != record_type) )
526       return GNUNET_NO;
527     payload = record->data.raw.data;
528     payload_len = record->data.raw.data_len;
529     break;
530   case GNUNET_DNSPARSER_TYPE_AAAA:
531     if ( (GNUNET_DNSPARSER_TYPE_AAAA != record_type) &&
532          (GNUNET_DNSPARSER_TYPE_ALL != record_type) )
533       return GNUNET_NO;
534     payload = record->data.raw.data;
535     payload_len = record->data.raw.data_len;
536     break;
537   default:
538     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
539                 "Cannot handle DNS response type %u: not supported here\n",
540                 record->type);
541     return GNUNET_NO;
542   }
543   env = GNUNET_MQ_msg_extra (msg,
544                              payload_len,
545                              GNUNET_MESSAGE_TYPE_RESOLVER_RESPONSE);
546   msg->client_id = client_request_id;
547   GNUNET_memcpy (&msg[1],
548                  payload,
549                  payload_len);
550   GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
551                   env);
552   return GNUNET_YES;
553 }
554
555
556 /**
557  * Send message to @a client that we transmitted all
558  * responses for @a client_request_id
559  *
560  * @param client_request_id to which request are we responding
561  * @param client where to send @a record
562  */
563 static void
564 send_end_msg (uint32_t client_request_id,
565               struct GNUNET_SERVICE_Client *client)
566 {
567   struct GNUNET_RESOLVER_ResponseMessage *msg;
568   struct GNUNET_MQ_Envelope *env;
569
570   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
571               "Sending END message\n");
572   env = GNUNET_MQ_msg (msg,
573                        GNUNET_MESSAGE_TYPE_RESOLVER_RESPONSE);
574   msg->client_id = client_request_id;
575   GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
576                   env);
577 }
578
579
580 /**
581  * Remove expired entries from @a rc
582  *
583  * @param rc entry in resolver cache
584  * @return #GNUNET_YES if @a rc was completely expired
585  *         #GNUNET_NO if some entries are left
586  */
587 static int
588 remove_expired (struct ResolveCache *rc)
589 {
590   struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
591   struct RecordListEntry *n;
592
593   for (struct RecordListEntry *pos = rc->records_head;
594        NULL != pos;
595        pos = n)
596   {
597     n = pos->next;
598     if (now.abs_value_us > pos->record->expiration_time.abs_value_us)
599     {
600       GNUNET_CONTAINER_DLL_remove (rc->records_head,
601                                    rc->records_tail,
602                                    pos);
603       GNUNET_DNSPARSER_free_record (pos->record);
604       GNUNET_free (pos->record);
605       GNUNET_free (pos);
606     }
607   }
608   if (NULL == rc->records_head)
609   {
610     free_cache_entry (rc);
611     return GNUNET_YES;
612   }
613   return GNUNET_NO;
614 }
615
616
617 /**
618  * Process DNS request for @a hostname with request ID @a request_id
619  * from @a client demanding records of type @a record_type.
620  *
621  * @param hostname DNS name to resolve
622  * @param record_type desired record type
623  * @param client_request_id client's request ID
624  * @param client who should get the result?
625  */
626 static void
627 process_get (const char *hostname,
628              uint16_t record_type,
629              uint32_t client_request_id,
630              struct GNUNET_SERVICE_Client *client);
631
632
633 /**
634  * Get an IP address as a string (works for both IPv4 and IPv6).  Note
635  * that the resolution happens asynchronously and that the first call
636  * may not immediately result in the FQN (but instead in a
637  * human-readable IP address).
638  *
639  * @param hostname what hostname was to be resolved
640  * @param record_type what type of record was requested
641  * @param client_request_id unique identification of the client's request
642  * @param client handle to the client making the request (for sending the reply)
643  */
644 static int
645 try_cache (const char *hostname,
646            uint16_t record_type,
647            uint32_t client_request_id,
648            struct GNUNET_SERVICE_Client *client)
649 {
650   struct ResolveCache *pos;
651   struct ResolveCache *next;
652   int found;
653   int in_hosts;
654
655   in_hosts = GNUNET_NO;
656   for (pos = hosts_head; NULL != pos; pos = pos->next)
657     if (0 == strcmp (pos->hostname,
658                      hostname))
659     {
660       in_hosts = GNUNET_YES;
661       break;
662     }
663   if (NULL == pos)
664   {
665     next = cache_head;
666     for (pos = next; NULL != pos; pos = next)
667     {
668       next = pos->next;
669       if (GNUNET_YES == remove_expired (pos))
670         continue;
671       if (0 == strcmp (pos->hostname,
672                        hostname))
673         break;
674     }
675   }
676   if (NULL == pos)
677   {
678     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
679                 "No cache entry for '%s'\n",
680                 hostname);
681     return GNUNET_NO;
682   }
683   if ( (GNUNET_NO == in_hosts) &&
684        (cache_head != pos) )
685   {
686     /* move result to head to achieve LRU for cache eviction */
687     GNUNET_CONTAINER_DLL_remove (cache_head,
688                                  cache_tail,
689                                  pos);
690     GNUNET_CONTAINER_DLL_insert (cache_head,
691                                  cache_tail,
692                                  pos);
693   }
694   found = GNUNET_NO;
695   for (struct RecordListEntry *rle = pos->records_head;
696        NULL != rle;
697        rle = rle->next)
698   {
699     const struct GNUNET_DNSPARSER_Record *record = rle->record;
700
701     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
702                 "Found cache entry for '%s', record type '%u'\n",
703                 hostname,
704                 record_type);
705     if ( (GNUNET_DNSPARSER_TYPE_CNAME == record->type) &&
706          (GNUNET_DNSPARSER_TYPE_CNAME != record_type) &&
707          (GNUNET_NO == found) )
708     {
709       const char *hostname = record->data.hostname;
710
711       process_get (hostname,
712                    record_type,
713                    client_request_id,
714                    client);
715       return GNUNET_YES; /* counts as a cache "hit" */
716     }
717     found |= send_reply (rle->record,
718                          record_type,
719                          client_request_id,
720                          client);
721   }
722   if (GNUNET_NO == found)
723     return GNUNET_NO; /* had records, but none matched! */
724   send_end_msg (client_request_id,
725                 client);
726   return GNUNET_YES;
727 }
728
729
730 /**
731  * Create DNS query for @a hostname of type @a type
732  * with DNS request ID @a dns_id.
733  *
734  * @param hostname DNS name to query
735  * @param type requested DNS record type
736  * @param dns_id what should be the DNS request ID
737  * @param packet_buf[out] where to write the request packet
738  * @param packet_size[out] set to size of @a packet_buf on success
739  * @return #GNUNET_OK on success
740  */
741 static int
742 pack (const char *hostname,
743       uint16_t type,
744       uint16_t dns_id,
745       char **packet_buf,
746       size_t *packet_size)
747 {
748   struct GNUNET_DNSPARSER_Query query;
749   struct GNUNET_DNSPARSER_Packet packet;
750
751   query.name = (char *)hostname;
752   query.type = type;
753   query.dns_traffic_class = GNUNET_TUN_DNS_CLASS_INTERNET;
754   memset (&packet,
755           0,
756           sizeof (packet));
757   packet.num_queries = 1;
758   packet.queries = &query;
759   packet.id = htons (dns_id);
760   packet.flags.recursion_desired = 1;
761   if (GNUNET_OK !=
762       GNUNET_DNSPARSER_pack (&packet,
763                              UINT16_MAX,
764                              packet_buf,
765                              packet_size))
766   {
767     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
768                 "Failed to pack query for hostname `%s'\n",
769                 hostname);
770     packet_buf = NULL;
771     return GNUNET_SYSERR;
772   }
773   return GNUNET_OK;
774 }
775
776 static void
777 cache_answers(const char* name,
778               struct GNUNET_DNSPARSER_Record *records,
779               unsigned int num_records)
780 {
781   struct ResolveCache *rc;
782   struct GNUNET_DNSPARSER_Record *record;
783   struct RecordListEntry *rle;
784
785   for (unsigned int i = 0; i != num_records; i++)
786   {
787     record = &records[i];
788
789     for (rc = cache_head; NULL != rc; rc = rc->next)
790       if (0 == strcasecmp (rc->hostname,
791                            name))
792         break;
793     if (NULL == rc)
794     {
795       rc = GNUNET_new (struct ResolveCache);
796       rc->hostname = GNUNET_strdup (name);
797       GNUNET_CONTAINER_DLL_insert (cache_head,
798                                    cache_tail,
799                                    rc);
800       cache_size++;
801     }
802     /* TODO: ought to check first if we have this exact record
803        already in the cache! */
804     rle = GNUNET_new (struct RecordListEntry);
805     rle->record = GNUNET_DNSPARSER_duplicate_record (record);
806     GNUNET_CONTAINER_DLL_insert (rc->records_head,
807                                  rc->records_tail,
808                                  rle);
809   }
810 }
811
812 /**
813  * We got a result from DNS. Add it to the cache and
814  * see if we can make our client happy...
815  *
816  * @param cls the `struct ActiveLookup`
817  * @param dns the DNS response
818  * @param dns_len number of bytes in @a dns
819  */
820 static void
821 handle_resolve_result (void *cls,
822                        const struct GNUNET_TUN_DnsHeader *dns,
823                        size_t dns_len)
824 {
825   struct ActiveLookup *al = cls;
826   struct GNUNET_DNSPARSER_Packet *parsed;
827
828   parsed = GNUNET_DNSPARSER_parse ((const char *)dns,
829                                    dns_len);
830   if (NULL == parsed)
831   {
832     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
833                 "Failed to parse DNS reply (hostname %s, request ID %u)\n",
834                 al->hostname,
835                 al->dns_id);
836     return;
837   }
838   if (al->dns_id != ntohs (parsed->id))
839   {
840     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
841                 "Request ID in DNS reply does not match\n");
842     GNUNET_DNSPARSER_free_packet (parsed);
843     return;
844   }
845   if (0 == parsed->num_answers + parsed->num_authority_records + parsed->num_additional_records)
846   {
847     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
848                 "DNS reply (hostname %s, request ID %u) contains no answers\n",
849                 al->hostname,
850                 (unsigned int) al->client_request_id);
851     /* resume by trying again from cache */
852     if (GNUNET_NO ==
853         try_cache (al->hostname,
854                    al->record_type,
855                    al->client_request_id,
856                    al->client))
857       /* cache failed, tell client we could not get an answer */
858     {
859       send_end_msg (al->client_request_id,
860                     al->client);
861     }
862     GNUNET_DNSPARSER_free_packet (parsed);
863     free_active_lookup (al);
864     return;
865   }
866   /* LRU-based cache eviction: we remove from tail */
867   while (cache_size > MAX_CACHE)
868     free_cache_entry (cache_tail);
869
870   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
871               "Got reply for hostname %s and request ID %u\n",
872               al->hostname,
873               (unsigned int) al->client_request_id);
874   /* add to cache */
875   cache_answers(al->hostname,
876                 parsed->answers, parsed->num_answers);
877   cache_answers(al->hostname,
878                 parsed->authority_records, parsed->num_authority_records);
879   cache_answers(al->hostname,
880                 parsed->additional_records, parsed->num_additional_records);
881
882   /* see if we need to do the 2nd request for AAAA records */
883   if ( (GNUNET_DNSPARSER_TYPE_ALL == al->record_type) &&
884        (GNUNET_NO == al->did_aaaa) )
885   {
886     char *packet_buf;
887     size_t packet_size;
888     uint16_t dns_id;
889
890     dns_id = (uint16_t) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
891                                                   UINT16_MAX);
892     if (GNUNET_OK ==
893         pack (al->hostname,
894               GNUNET_DNSPARSER_TYPE_AAAA,
895               dns_id,
896               &packet_buf,
897               &packet_size))
898     {
899       al->did_aaaa = GNUNET_YES;
900       al->dns_id = dns_id;
901       GNUNET_DNSSTUB_resolve_cancel (al->resolve_handle);
902       al->resolve_handle =
903         GNUNET_DNSSTUB_resolve (dnsstub_ctx,
904                                 packet_buf,
905                                 packet_size,
906                                 &handle_resolve_result,
907                                 al);
908       GNUNET_free (packet_buf);
909       GNUNET_DNSPARSER_free_packet (parsed);
910       return;
911     }
912   }
913
914   /* resume by trying again from cache */
915   if (GNUNET_NO ==
916       try_cache (al->hostname,
917                  al->record_type,
918                  al->client_request_id,
919                  al->client))
920     /* cache failed, tell client we could not get an answer */
921   {
922     send_end_msg (al->client_request_id,
923                   al->client);
924   }
925   free_active_lookup (al);
926   GNUNET_DNSPARSER_free_packet (parsed);
927 }
928
929
930 /**
931  * We encountered a timeout trying to perform a
932  * DNS lookup.
933  *
934  * @param cls a `struct ActiveLookup`
935  */
936 static void
937 handle_resolve_timeout (void *cls)
938 {
939   struct ActiveLookup *al = cls;
940
941   al->timeout_task = NULL;
942   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
943               "DNS lookup timeout!\n");
944   send_end_msg (al->client_request_id,
945                 al->client);
946   free_active_lookup (al);
947 }
948
949
950 /**
951  * Initiate an active lookup, then cache the result and
952  * try to then complete the resolution.
953  *
954  * @param hostname DNS name to resolve
955  * @param record_type record type to locate
956  * @param client_request_id client request ID
957  * @param client handle to the client
958  * @return #GNUNET_OK if the DNS query is now pending
959  */
960 static int
961 resolve_and_cache (const char* hostname,
962                    uint16_t record_type,
963                    uint32_t client_request_id,
964                    struct GNUNET_SERVICE_Client *client)
965 {
966   char *packet_buf;
967   size_t packet_size;
968   struct ActiveLookup *al;
969   uint16_t dns_id;
970   uint16_t type;
971
972   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
973               "resolve_and_cache `%s'\n",
974               hostname);
975   dns_id = (uint16_t) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
976                                                 UINT16_MAX);
977
978   if (GNUNET_DNSPARSER_TYPE_ALL == record_type)
979     type = GNUNET_DNSPARSER_TYPE_A;
980   else
981     type = record_type;
982   if (GNUNET_OK !=
983       pack (hostname,
984             type,
985             dns_id,
986             &packet_buf,
987             &packet_size))
988   {
989     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
990                 "Failed to pack query for hostname `%s'\n",
991                 hostname);
992     return GNUNET_SYSERR;
993   }
994
995   al = GNUNET_new (struct ActiveLookup);
996   al->hostname = GNUNET_strdup (hostname);
997   al->record_type = record_type;
998   al->client_request_id = client_request_id;
999   al->dns_id = dns_id;
1000   al->client = client;
1001   al->timeout_task = GNUNET_SCHEDULER_add_delayed (DNS_TIMEOUT,
1002                                                    &handle_resolve_timeout,
1003                                                    al);
1004   al->resolve_handle =
1005     GNUNET_DNSSTUB_resolve (dnsstub_ctx,
1006                             packet_buf,
1007                             packet_size,
1008                             &handle_resolve_result,
1009                             al);
1010   GNUNET_free (packet_buf);
1011   GNUNET_CONTAINER_DLL_insert (lookup_head,
1012                                lookup_tail,
1013                                al);
1014   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1015               "Resolving %s, client_request_id = %u, dns_id = %u\n",
1016               hostname,
1017               (unsigned int) client_request_id,
1018               (unsigned int) dns_id);
1019   return GNUNET_OK;
1020 }
1021
1022
1023 /**
1024  * Process DNS request for @a hostname with request ID @a client_request_id
1025  * from @a client demanding records of type @a record_type.
1026  *
1027  * @param hostname DNS name to resolve
1028  * @param record_type desired record type
1029  * @param client_request_id client's request ID
1030  * @param client who should get the result?
1031  */
1032 static void
1033 process_get (const char *hostname,
1034              uint16_t record_type,
1035              uint32_t client_request_id,
1036              struct GNUNET_SERVICE_Client *client)
1037 {
1038   char fqdn[255];
1039
1040   if (GNUNET_NO !=
1041       try_cache (hostname,
1042                  record_type,
1043                  client_request_id,
1044                  client))
1045     return;
1046   if (  (NULL != my_domain) &&
1047         (NULL == strchr (hostname,
1048                          (unsigned char) '.')) &&
1049         (strlen (hostname) + strlen (my_domain) <= 253) )
1050   {
1051     GNUNET_snprintf (fqdn,
1052                      sizeof (fqdn),
1053                      "%s.%s",
1054                      hostname,
1055                      my_domain);
1056   }
1057   else if (strlen (hostname) < 255)
1058   {
1059     GNUNET_snprintf (fqdn,
1060                      sizeof (fqdn),
1061                      "%s",
1062                      hostname);
1063   }
1064   else
1065   {
1066     GNUNET_break (0);
1067     GNUNET_SERVICE_client_drop (client);
1068     return;
1069   }
1070   if (GNUNET_NO ==
1071       try_cache (fqdn,
1072                  record_type,
1073                  client_request_id,
1074                  client))
1075   {
1076     if (GNUNET_OK !=
1077         resolve_and_cache (fqdn,
1078                            record_type,
1079                            client_request_id,
1080                            client))
1081     {
1082       send_end_msg (client_request_id,
1083                     client);
1084     }
1085   }
1086 }
1087
1088
1089 /**
1090  * Verify well-formedness of GET-message.
1091  *
1092  * @param cls closure, unused
1093  * @param get the actual message
1094  * @return #GNUNET_OK if @a get is well-formed
1095  */
1096 static int
1097 check_get (void *cls,
1098            const struct GNUNET_RESOLVER_GetMessage *get)
1099 {
1100   uint16_t size;
1101   int direction;
1102   int af;
1103
1104   (void) cls;
1105   size = ntohs (get->header.size) - sizeof (*get);
1106   direction = ntohl (get->direction);
1107   if (GNUNET_NO == direction)
1108   {
1109     GNUNET_MQ_check_zero_termination (get);
1110     return GNUNET_OK;
1111   }
1112   af = ntohl (get->af);
1113   switch (af)
1114   {
1115     case AF_INET:
1116       if (size != sizeof (struct in_addr))
1117       {
1118         GNUNET_break (0);
1119         return GNUNET_SYSERR;
1120       }
1121       break;
1122     case AF_INET6:
1123       if (size != sizeof (struct in6_addr))
1124       {
1125         GNUNET_break (0);
1126         return GNUNET_SYSERR;
1127       }
1128       break;
1129     default:
1130       GNUNET_break (0);
1131       return GNUNET_SYSERR;
1132   }
1133   return GNUNET_OK;
1134 }
1135
1136
1137 /**
1138  * Handle GET-message.
1139  *
1140  * @param cls identification of the client
1141  * @param msg the actual message
1142  */
1143 static void
1144 handle_get (void *cls,
1145             const struct GNUNET_RESOLVER_GetMessage *msg)
1146 {
1147   struct GNUNET_SERVICE_Client *client = cls;
1148   int direction;
1149   int af;
1150   uint32_t client_request_id;
1151   char *hostname;
1152
1153   direction = ntohl (msg->direction);
1154   af = ntohl (msg->af);
1155   client_request_id = msg->client_id;
1156   GNUNET_SERVICE_client_continue (client);
1157   if (GNUNET_NO == direction)
1158   {
1159     /* IP from hostname */
1160     hostname = GNUNET_strdup ((const char *) &msg[1]);
1161     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1162                 "Client asks to resolve `%s'\n",
1163                 hostname);
1164     switch (af)
1165     {
1166       case AF_UNSPEC:
1167         {
1168           process_get (hostname,
1169                        GNUNET_DNSPARSER_TYPE_ALL,
1170                        client_request_id,
1171                        client);
1172           break;
1173         }
1174       case AF_INET:
1175         {
1176           process_get (hostname,
1177                        GNUNET_DNSPARSER_TYPE_A,
1178                        client_request_id,
1179                        client);
1180           break;
1181         }
1182       case AF_INET6:
1183         {
1184           process_get (hostname,
1185                        GNUNET_DNSPARSER_TYPE_AAAA,
1186                        client_request_id,
1187                        client);
1188           break;
1189         }
1190       default:
1191         {
1192           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1193                       "got invalid af: %d\n",
1194                       af);
1195           GNUNET_assert (0);
1196         }
1197     }
1198   }
1199   else
1200   {
1201     /* hostname from IP */
1202     hostname = make_reverse_hostname (&msg[1],
1203                                       af);
1204     process_get (hostname,
1205                  GNUNET_DNSPARSER_TYPE_PTR,
1206                  client_request_id,
1207                  client);
1208   }
1209   GNUNET_free_non_null (hostname);
1210 }
1211
1212
1213 /**
1214  * Service is shutting down, clean up.
1215  *
1216  * @param cls NULL, unused
1217  */
1218 static void
1219 shutdown_task (void *cls)
1220 {
1221   (void) cls;
1222
1223   while (NULL != lookup_head)
1224     free_active_lookup (lookup_head);
1225   while (NULL != cache_head)
1226     free_cache_entry (cache_head);
1227   while (NULL != hosts_head)
1228     free_hosts_entry (hosts_head);
1229   GNUNET_DNSSTUB_stop (dnsstub_ctx);
1230   GNUNET_free_non_null (my_domain);
1231 }
1232
1233
1234 /**
1235  * Add information about a host from /etc/hosts
1236  * to our cache.
1237  *
1238  * @param hostname the name of the host
1239  * @param rec_type DNS record type to use
1240  * @param data payload
1241  * @param data_size number of bytes in @a data
1242  */
1243 static void
1244 add_host (const char *hostname,
1245           uint16_t rec_type,
1246           const void *data,
1247           size_t data_size)
1248 {
1249   struct ResolveCache *rc;
1250   struct RecordListEntry *rle;
1251   struct GNUNET_DNSPARSER_Record *rec;
1252
1253   rec = GNUNET_malloc (sizeof (struct GNUNET_DNSPARSER_Record));
1254   rec->expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS;
1255   rec->type = rec_type;
1256   rec->dns_traffic_class = GNUNET_TUN_DNS_CLASS_INTERNET;
1257   rec->name = GNUNET_strdup (hostname);
1258   rec->data.raw.data = GNUNET_memdup (data,
1259                                       data_size);
1260   rec->data.raw.data_len = data_size;
1261   rle = GNUNET_new (struct RecordListEntry);
1262   rle->record = rec;
1263   rc = GNUNET_new (struct ResolveCache);
1264   rc->hostname = GNUNET_strdup (hostname);
1265   GNUNET_CONTAINER_DLL_insert (rc->records_head,
1266                                rc->records_tail,
1267                                rle);
1268   GNUNET_CONTAINER_DLL_insert (hosts_head,
1269                                hosts_tail,
1270                                rc);
1271 }
1272
1273
1274 /**
1275  * Extract host information from a line in /etc/hosts
1276  *
1277  * @param line the line to parse
1278  * @param line_len number of bytes in @a line
1279  */
1280 static void
1281 extract_hosts (const char *line,
1282                size_t line_len)
1283 {
1284   const char *c;
1285   struct in_addr v4;
1286   struct in6_addr v6;
1287   char *tbuf;
1288   char *tok;
1289
1290   /* ignore everything after '#' */
1291   c = memrchr (line,
1292                (unsigned char) '#',
1293                line_len);
1294   if (NULL != c)
1295     line_len = c - line;
1296   /* ignore leading whitespace */
1297   while ( (0 < line_len) &&
1298           isspace ((unsigned char) *line) )
1299   {
1300     line++;
1301     line_len--;
1302   }
1303   tbuf = GNUNET_strndup (line,
1304                          line_len);
1305   tok = strtok (tbuf, " \t");
1306   if (NULL == tok)
1307   {
1308     GNUNET_free (tbuf);
1309     return;
1310   }
1311   if (1 == inet_pton (AF_INET,
1312                       tok,
1313                       &v4))
1314   {
1315     while (NULL != (tok = strtok (NULL, " \t")))
1316       add_host (tok,
1317                 GNUNET_DNSPARSER_TYPE_A,
1318                 &v4,
1319                 sizeof (struct in_addr));
1320   }
1321   else if (1 == inet_pton (AF_INET6,
1322                            tok,
1323                            &v6))
1324   {
1325     while (NULL != (tok = strtok (NULL, " \t")))
1326       add_host (tok,
1327                 GNUNET_DNSPARSER_TYPE_AAAA,
1328                 &v6,
1329                 sizeof (struct in6_addr));
1330   }
1331   GNUNET_free (tbuf);
1332 }
1333
1334
1335 /**
1336  * Reads the list of hosts from /etc/hosts.
1337  */
1338 static void
1339 load_etc_hosts (void)
1340 {
1341   struct GNUNET_DISK_FileHandle *fh;
1342   struct GNUNET_DISK_MapHandle *mh;
1343   off_t bytes_read;
1344   const char *buf;
1345   size_t read_offset;
1346
1347   fh = GNUNET_DISK_file_open ("/etc/hosts",
1348                               GNUNET_DISK_OPEN_READ,
1349                               GNUNET_DISK_PERM_NONE);
1350   if (NULL == fh)
1351   {
1352     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1353                 "Failed to open /etc/hosts");
1354     return;
1355   }
1356   if (GNUNET_OK !=
1357       GNUNET_DISK_file_handle_size (fh,
1358                                     &bytes_read))
1359   {
1360     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1361                 "Could not determin size of /etc/hosts. "
1362                 "DNS resolution will not be possible.\n");
1363     GNUNET_DISK_file_close (fh);
1364     return;
1365   }
1366   if ((size_t) bytes_read > SIZE_MAX)
1367   {
1368     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1369                 "/etc/hosts file too large to mmap. "
1370                 "DNS resolution will not be possible.\n");
1371     GNUNET_DISK_file_close (fh);
1372     return;
1373   }
1374   buf = GNUNET_DISK_file_map (fh,
1375                               &mh,
1376                               GNUNET_DISK_MAP_TYPE_READ,
1377                               (size_t) bytes_read);
1378   read_offset = 0;
1379   while (read_offset < (size_t) bytes_read)
1380   {
1381     const char *newline;
1382     size_t line_len;
1383
1384     newline = strchr (buf + read_offset,
1385                       '\n');
1386     if (NULL == newline)
1387       break;
1388     line_len = newline - buf - read_offset;
1389     extract_hosts (buf + read_offset,
1390                    line_len);
1391     read_offset += line_len + 1;
1392   }
1393   GNUNET_DISK_file_unmap (mh);
1394   GNUNET_DISK_file_close (fh);
1395 }
1396
1397
1398 /**
1399  * Service is starting, initialize everything.
1400  *
1401  * @param cls NULL, unused
1402  * @param cfg our configuration
1403  * @param sh service handle
1404  */
1405 static void
1406 init_cb (void *cls,
1407          const struct GNUNET_CONFIGURATION_Handle *cfg,
1408          struct GNUNET_SERVICE_Handle *sh)
1409 {
1410   char **dns_servers;
1411   int num_dns_servers;
1412
1413   (void) cfg;
1414   (void) sh;
1415   load_etc_hosts ();
1416   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
1417                                  cls);
1418   dnsstub_ctx = GNUNET_DNSSTUB_start (128);
1419   dns_servers = NULL;
1420   num_dns_servers = lookup_dns_servers (&dns_servers);
1421   if (0 >= num_dns_servers)
1422   {
1423     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1424                 _("No DNS server available. DNS resolution will not be possible.\n"));
1425     return;
1426   }
1427   for (int i = 0; i < num_dns_servers; i++)
1428   {
1429     int result = GNUNET_DNSSTUB_add_dns_ip (dnsstub_ctx, dns_servers[i]);
1430     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1431                 "Adding DNS server '%s': %s\n",
1432                 dns_servers[i],
1433                 GNUNET_OK == result ? "success" : "failure");
1434     GNUNET_free (dns_servers[i]);
1435   }
1436   GNUNET_free_non_null (dns_servers);
1437 }
1438
1439
1440 /**
1441  * Callback called when a client connects to the service.
1442  *
1443  * @param cls closure for the service, unused
1444  * @param c the new client that connected to the service
1445  * @param mq the message queue used to send messages to the client
1446  * @return @a c
1447  */
1448 static void *
1449 connect_cb (void *cls,
1450             struct GNUNET_SERVICE_Client *c,
1451             struct GNUNET_MQ_Handle *mq)
1452 {
1453   (void) cls;
1454   (void) mq;
1455
1456   return c;
1457 }
1458
1459
1460 /**
1461  * Callback called when a client disconnected from the service
1462  *
1463  * @param cls closure for the service
1464  * @param c the client that disconnected
1465  * @param internal_cls should be equal to @a c
1466  */
1467 static void
1468 disconnect_cb (void *cls,
1469                struct GNUNET_SERVICE_Client *c,
1470                void *internal_cls)
1471 {
1472   struct ActiveLookup *n;
1473   (void) cls;
1474
1475   GNUNET_assert (c == internal_cls);
1476   n = lookup_head;
1477   for (struct ActiveLookup *al = n;
1478        NULL != al;
1479        al = n)
1480   {
1481     n = al->next;
1482     if (al->client == c)
1483       free_active_lookup (al);
1484   }
1485 }
1486
1487
1488 /**
1489  * Define "main" method using service macro.
1490  */
1491 GNUNET_SERVICE_MAIN
1492 ("resolver",
1493  GNUNET_SERVICE_OPTION_NONE,
1494  &init_cb,
1495  &connect_cb,
1496  &disconnect_cb,
1497  NULL,
1498  GNUNET_MQ_hd_var_size (get,
1499                         GNUNET_MESSAGE_TYPE_RESOLVER_REQUEST,
1500                         struct GNUNET_RESOLVER_GetMessage,
1501                         NULL),
1502  GNUNET_MQ_handler_end ());
1503
1504
1505 #if defined(LINUX) && defined(__GLIBC__)
1506 #include <malloc.h>
1507
1508 /**
1509  * MINIMIZE heap size (way below 128k) since this process doesn't need much.
1510  */
1511 void __attribute__ ((constructor))
1512 GNUNET_RESOLVER_memory_init ()
1513 {
1514   mallopt (M_TRIM_THRESHOLD, 4 * 1024);
1515   mallopt (M_TOP_PAD, 1 * 1024);
1516   malloc_trim (0);
1517 }
1518 #endif
1519
1520
1521 /* end of gnunet-service-resolver.c */