ares_gethostbyname.c

   1
   2 /* Copyright 1998 by the Massachusetts Institute of Technology.
   3  *
   4  * Permission to use, copy, modify, and distribute this
   5  * software and its documentation for any purpose and without
   6  * fee is hereby granted, provided that the above copyright
   7  * notice appear in all copies and that both that copyright
   8  * notice and this permission notice appear in supporting
   9  * documentation, and that the name of M.I.T. not be used in
  10  * advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.
  12  * M.I.T. makes no representations about the suitability of
  13  * this software for any purpose.  It is provided "as is"
  14  * without express or implied warranty.
  15  */
  16
  17 #include "ares_setup.h"
  18
  19 #ifdef HAVE_SYS_SOCKET_H
  20 #  include <sys/socket.h>
  21 #endif
  22 #ifdef HAVE_NETINET_IN_H
  23 #  include <netinet/in.h>
  24 #endif
  25 #ifdef HAVE_NETDB_H
  26 #  include <netdb.h>
  27 #endif
  28 #ifdef HAVE_ARPA_INET_H
  29 #  include <arpa/inet.h>
  30 #endif
  31 #ifdef HAVE_ARPA_NAMESER_H
  32 #  include <arpa/nameser.h>
  33 #else
  34 #  include "nameser.h"
  35 #endif
  36 #ifdef HAVE_ARPA_NAMESER_COMPAT_H
  37 #  include <arpa/nameser_compat.h>
  38 #endif
  39
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <ctype.h>
  44 #ifdef HAVE_STRINGS_H
  45 #include <strings.h>
  46 #endif
  47
  48 #include "ares.h"
  49 #include "inet_net_pton.h"
  50 #include "bitncmp.h"
  51 #include "ares_platform.h"
  52 #include "ares_private.h"
  53
  54 #ifdef WATT32
  55 #undef WIN32
  56 #endif
  57
  58 struct host_query {
  59   /* Arguments passed to ares_gethostbyname() */
  60   ares_channel channel;
  61   char *name;
  62   ares_host_callback callback;
  63   void *arg;
  64   int sent_family; /* this family is what was is being used */
  65   int want_family; /* this family is what is asked for in the API */
  66   const char *remaining_lookups;
  67   int timeouts;
  68 };
  69
  70 static void next_lookup(struct host_query *hquery, int status_code);
  71 static void host_callback(void *arg, int status, int timeouts,
  72                           unsigned char *abuf, int alen);
  73 static void end_hquery(struct host_query *hquery, int status,
  74                        struct hostent *host);
  75 static int fake_hostent(const char *name, int family,
  76                         ares_host_callback callback, void *arg);
  77 static int file_lookup(const char *name, int family, struct hostent **host);
  78 static void sort_addresses(struct hostent *host,
  79                            const struct apattern *sortlist, int nsort);
  80 static void sort6_addresses(struct hostent *host,
  81                             const struct apattern *sortlist, int nsort);
  82 static int get_address_index(const struct in_addr *addr,
  83                              const struct apattern *sortlist, int nsort);
  84 static int get6_address_index(const struct ares_in6_addr *addr,
  85                               const struct apattern *sortlist, int nsort);
  86
  87 void ares_gethostbyname(ares_channel channel, const char *name, int family,
  88                         ares_host_callback callback, void *arg)
  89 {
  90   struct host_query *hquery;
  91
  92   /* Right now we only know how to look up Internet addresses - and unspec
  93      means try both basically. */
  94   switch (family) {
  95   case AF_INET:
  96   case AF_INET6:
  97   case AF_UNSPEC:
  98     break;
  99   default:
 100     callback(arg, ARES_ENOTIMP, 0, NULL);
 101     return;
 102   }
 103
 104   if (fake_hostent(name, family, callback, arg))
 105     return;
 106
 107   /* Allocate and fill in the host query structure. */
 108   hquery = malloc(sizeof(struct host_query));
 109   if (!hquery)
 110     {
 111       callback(arg, ARES_ENOMEM, 0, NULL);
 112       return;
 113     }
 114   hquery->channel = channel;
 115   hquery->name = strdup(name);
 116   hquery->want_family = family;
 117   hquery->sent_family = -1; /* nothing is sent yet */
 118   if (!hquery->name) {
 119     free(hquery);
 120     callback(arg, ARES_ENOMEM, 0, NULL);
 121     return;
 122   }
 123   hquery->callback = callback;
 124   hquery->arg = arg;
 125   hquery->remaining_lookups = channel->lookups;
 126   hquery->timeouts = 0;
 127
 128   /* Start performing lookups according to channel->lookups. */
 129   next_lookup(hquery, ARES_ECONNREFUSED /* initial error code */);
 130 }
 131
 132 static void next_lookup(struct host_query *hquery, int status_code)
 133 {
 134   const char *p;
 135   struct hostent *host;
 136   int status = status_code;
 137
 138   for (p = hquery->remaining_lookups; *p; p++)
 139     {
 140       switch (*p)
 141         {
 142         case 'b':
 143           /* DNS lookup */
 144           hquery->remaining_lookups = p + 1;
 145           if ((hquery->want_family == AF_INET6) ||
 146               (hquery->want_family == AF_UNSPEC)) {
 147             /* if inet6 or unspec, start out with AAAA */
 148             hquery->sent_family = AF_INET6;
 149             ares_search(hquery->channel, hquery->name, C_IN, T_AAAA,
 150                         host_callback, hquery);
 151           }
 152           else {
 153             hquery->sent_family = AF_INET;
 154             ares_search(hquery->channel, hquery->name, C_IN, T_A,
 155                         host_callback, hquery);
 156           }
 157           return;
 158
 159         case 'f':
 160           /* Host file lookup */
 161           status = file_lookup(hquery->name, hquery->want_family, &host);
 162
 163           /* this status check below previously checked for !ARES_ENOTFOUND,
 164              but we should not assume that this single error code is the one
 165              that can occur, as that is in fact no longer the case */
 166           if (status == ARES_SUCCESS)
 167             {
 168               end_hquery(hquery, status, host);
 169               return;
 170             }
 171           status = status_code;   /* Use original status code */
 172           break;
 173         }
 174     }
 175   end_hquery(hquery, status, NULL);
 176 }
 177
 178 static void host_callback(void *arg, int status, int timeouts,
 179                           unsigned char *abuf, int alen)
 180 {
 181   struct host_query *hquery = (struct host_query *) arg;
 182   ares_channel channel = hquery->channel;
 183   struct hostent *host = NULL;
 184
 185   hquery->timeouts += timeouts;
 186   if (status == ARES_SUCCESS)
 187     {
 188       if (hquery->sent_family == AF_INET)
 189         {
 190           status = ares_parse_a_reply(abuf, alen, &host, NULL, NULL);
 191           if (host && channel->nsort)
 192             sort_addresses(host, channel->sortlist, channel->nsort);
 193         }
 194       else if (hquery->sent_family == AF_INET6)
 195         {
 196           status = ares_parse_aaaa_reply(abuf, alen, &host, NULL, NULL);
 197           if (status == ARES_ENODATA || status == ARES_EBADRESP) {
 198             /* The query returned something but either there were no AAAA
 199                records (e.g. just CNAME) or the response was malformed.  Try
 200                looking up A instead.  We should possibly limit this
 201                attempt-next logic to AF_UNSPEC lookups only. */
 202             hquery->sent_family = AF_INET;
 203             ares_search(hquery->channel, hquery->name, C_IN, T_A,
 204                         host_callback, hquery);
 205             return;
 206           }
 207           if (host && channel->nsort)
 208             sort6_addresses(host, channel->sortlist, channel->nsort);
 209         }
 210       end_hquery(hquery, status, host);
 211     }
 212   else if ((status == ARES_ENODATA || status == ARES_EBADRESP ||
 213             status == ARES_ETIMEOUT) && hquery->sent_family == AF_INET6)
 214     {
 215       /* The AAAA query yielded no useful result.  Now look up an A instead.
 216          We should possibly limit this attempt-next logic to AF_UNSPEC lookups
 217          only. */
 218       hquery->sent_family = AF_INET;
 219       ares_search(hquery->channel, hquery->name, C_IN, T_A, host_callback,
 220                   hquery);
 221     }
 222   else if (status == ARES_EDESTRUCTION)
 223     end_hquery(hquery, status, NULL);
 224   else
 225     next_lookup(hquery, status);
 226 }
 227
 228 static void end_hquery(struct host_query *hquery, int status,
 229                        struct hostent *host)
 230 {
 231   hquery->callback(hquery->arg, status, hquery->timeouts, host);
 232   if (host)
 233     ares_free_hostent(host);
 234   free(hquery->name);
 235   free(hquery);
 236 }
 237
 238 /* If the name looks like an IP address, fake up a host entry, end the
 239  * query immediately, and return true.  Otherwise return false.
 240  */
 241 static int fake_hostent(const char *name, int family,
 242                         ares_host_callback callback, void *arg)
 243 {
 244   struct hostent hostent;
 245   char *aliases[1] = { NULL };
 246   char *addrs[2];
 247   int result = 0;
 248   struct in_addr in;
 249   struct ares_in6_addr in6;
 250
 251   if (family == AF_INET || family == AF_INET6)
 252     {
 253       /* It only looks like an IP address if it's all numbers and dots. */
 254       int numdots = 0, valid = 1;
 255       const char *p;
 256       for (p = name; *p; p++)
 257         {
 258           if (!ISDIGIT(*p) && *p != '.') {
 259             valid = 0;
 260             break;
 261           } else if (*p == '.') {
 262             numdots++;
 263           }
 264         }
 265
 266       /* if we don't have 3 dots, it is illegal
 267        * (although inet_addr doesn't think so).
 268        */
 269       if (numdots != 3 || !valid)
 270         result = 0;
 271       else
 272         result = ((in.s_addr = inet_addr(name)) == INADDR_NONE ? 0 : 1);
 273
 274       if (result)
 275         family = AF_INET;
 276     }
 277   if (family == AF_INET6)
 278     result = (ares_inet_pton(AF_INET6, name, &in6) < 1 ? 0 : 1);
 279
 280   if (!result)
 281     return 0;
 282
 283   if (family == AF_INET)
 284     {
 285       hostent.h_length = (int)sizeof(struct in_addr);
 286       addrs[0] = (char *)&in;
 287     }
 288   else if (family == AF_INET6)
 289     {
 290       hostent.h_length = (int)sizeof(struct ares_in6_addr);
 291       addrs[0] = (char *)&in6;
 292     }
 293   /* Duplicate the name, to avoid a constness violation. */
 294   hostent.h_name = strdup(name);
 295   if (!hostent.h_name)
 296     {
 297       callback(arg, ARES_ENOMEM, 0, NULL);
 298       return 1;
 299     }
 300
 301   /* Fill in the rest of the host structure and terminate the query. */
 302   addrs[1] = NULL;
 303   hostent.h_aliases = aliases;
 304   hostent.h_addrtype = family;
 305   hostent.h_addr_list = addrs;
 306   callback(arg, ARES_SUCCESS, 0, &hostent);
 307
 308   free((char *)(hostent.h_name));
 309   return 1;
 310 }
 311
 312 /* This is an API method */
 313 int ares_gethostbyname_file(ares_channel channel, const char *name,
 314                             int family, struct hostent **host)
 315 {
 316   int result;
 317
 318   /* We only take the channel to ensure that ares_init() been called. */
 319   if(channel == NULL)
 320     {
 321       /* Anything will do, really.  This seems fine, and is consistent with
 322          other error cases. */
 323       *host = NULL;
 324       return ARES_ENOTFOUND;
 325     }
 326
 327   /* Just chain to the internal implementation we use here; it's exactly
 328    * what we want.
 329    */
 330   result = file_lookup(name, family, host);
 331   if(result != ARES_SUCCESS)
 332     {
 333       /* We guarantee a NULL hostent on failure. */
 334       *host = NULL;
 335     }
 336   return result;
 337 }
 338
 339 static int file_lookup(const char *name, int family, struct hostent **host)
 340 {
 341   FILE *fp;
 342   char **alias;
 343   int status;
 344   int error;
 345
 346 #ifdef WIN32
 347   char PATH_HOSTS[MAX_PATH];
 348   win_platform platform;
 349
 350   PATH_HOSTS[0] = '\0';
 351
 352   platform = ares__getplatform();
 353
 354   if (platform == WIN_NT) {
 355     char tmp[MAX_PATH];
 356     HKEY hkeyHosts;
 357
 358     if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, WIN_NS_NT_KEY, 0, KEY_READ,
 359                      &hkeyHosts) == ERROR_SUCCESS)
 360     {
 361       DWORD dwLength = MAX_PATH;
 362       RegQueryValueEx(hkeyHosts, DATABASEPATH, NULL, NULL, (LPBYTE)tmp,
 363                       &dwLength);
 364       ExpandEnvironmentStrings(tmp, PATH_HOSTS, MAX_PATH);
 365       RegCloseKey(hkeyHosts);
 366     }
 367   }
 368   else if (platform == WIN_9X)
 369     GetWindowsDirectory(PATH_HOSTS, MAX_PATH);
 370   else
 371     return ARES_ENOTFOUND;
 372
 373   strcat(PATH_HOSTS, WIN_PATH_HOSTS);
 374
 375 #elif defined(WATT32)
 376   extern const char *_w32_GetHostsFile (void);
 377   const char *PATH_HOSTS = _w32_GetHostsFile();
 378
 379   if (!PATH_HOSTS)
 380     return ARES_ENOTFOUND;
 381 #endif
 382
 383   fp = fopen(PATH_HOSTS, "r");
 384   if (!fp)
 385     {
 386       error = ERRNO;
 387       switch(error)
 388         {
 389         case ENOENT:
 390         case ESRCH:
 391           return ARES_ENOTFOUND;
 392         default:
 393           DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
 394                          error, strerror(error)));
 395           DEBUGF(fprintf(stderr, "Error opening file: %s\n",
 396                          PATH_HOSTS));
 397           *host = NULL;
 398           return ARES_EFILE;
 399         }
 400     }
 401   while ((status = ares__get_hostent(fp, family, host)) == ARES_SUCCESS)
 402     {
 403       if (strcasecmp((*host)->h_name, name) == 0)
 404         break;
 405       for (alias = (*host)->h_aliases; *alias; alias++)
 406         {
 407           if (strcasecmp(*alias, name) == 0)
 408             break;
 409         }
 410       if (*alias)
 411         break;
 412       ares_free_hostent(*host);
 413     }
 414   fclose(fp);
 415   if (status == ARES_EOF)
 416     status = ARES_ENOTFOUND;
 417   if (status != ARES_SUCCESS)
 418     *host = NULL;
 419   return status;
 420 }
 421
 422 static void sort_addresses(struct hostent *host,
 423                            const struct apattern *sortlist, int nsort)
 424 {
 425   struct in_addr a1, a2;
 426   int i1, i2, ind1, ind2;
 427
 428   /* This is a simple insertion sort, not optimized at all.  i1 walks
 429    * through the address list, with the loop invariant that everything
 430    * to the left of i1 is sorted.  In the loop body, the value at i1 is moved
 431    * back through the list (via i2) until it is in sorted order.
 432    */
 433   for (i1 = 0; host->h_addr_list[i1]; i1++)
 434     {
 435       memcpy(&a1, host->h_addr_list[i1], sizeof(struct in_addr));
 436       ind1 = get_address_index(&a1, sortlist, nsort);
 437       for (i2 = i1 - 1; i2 >= 0; i2--)
 438         {
 439           memcpy(&a2, host->h_addr_list[i2], sizeof(struct in_addr));
 440           ind2 = get_address_index(&a2, sortlist, nsort);
 441           if (ind2 <= ind1)
 442             break;
 443           memcpy(host->h_addr_list[i2 + 1], &a2, sizeof(struct in_addr));
 444         }
 445       memcpy(host->h_addr_list[i2 + 1], &a1, sizeof(struct in_addr));
 446     }
 447 }
 448
 449 /* Find the first entry in sortlist which matches addr.  Return nsort
 450  * if none of them match.
 451  */
 452 static int get_address_index(const struct in_addr *addr,
 453                              const struct apattern *sortlist,
 454                              int nsort)
 455 {
 456   int i;
 457
 458   for (i = 0; i < nsort; i++)
 459     {
 460       if (sortlist[i].family != AF_INET)
 461         continue;
 462       if (sortlist[i].type == PATTERN_MASK)
 463         {
 464           if ((addr->s_addr & sortlist[i].mask.addr4.s_addr)
 465               == sortlist[i].addrV4.s_addr)
 466             break;
 467         }
 468       else
 469         {
 470           if (!ares_bitncmp(&addr->s_addr, &sortlist[i].addrV4.s_addr,
 471                             sortlist[i].mask.bits))
 472             break;
 473         }
 474     }
 475   return i;
 476 }
 477
 478 static void sort6_addresses(struct hostent *host,
 479                             const struct apattern *sortlist, int nsort)
 480 {
 481   struct ares_in6_addr a1, a2;
 482   int i1, i2, ind1, ind2;
 483
 484   /* This is a simple insertion sort, not optimized at all.  i1 walks
 485    * through the address list, with the loop invariant that everything
 486    * to the left of i1 is sorted.  In the loop body, the value at i1 is moved
 487    * back through the list (via i2) until it is in sorted order.
 488    */
 489   for (i1 = 0; host->h_addr_list[i1]; i1++)
 490     {
 491       memcpy(&a1, host->h_addr_list[i1], sizeof(struct ares_in6_addr));
 492       ind1 = get6_address_index(&a1, sortlist, nsort);
 493       for (i2 = i1 - 1; i2 >= 0; i2--)
 494         {
 495           memcpy(&a2, host->h_addr_list[i2], sizeof(struct ares_in6_addr));
 496           ind2 = get6_address_index(&a2, sortlist, nsort);
 497           if (ind2 <= ind1)
 498             break;
 499           memcpy(host->h_addr_list[i2 + 1], &a2, sizeof(struct ares_in6_addr));
 500         }
 501       memcpy(host->h_addr_list[i2 + 1], &a1, sizeof(struct ares_in6_addr));
 502     }
 503 }
 504
 505 /* Find the first entry in sortlist which matches addr.  Return nsort
 506  * if none of them match.
 507  */
 508 static int get6_address_index(const struct ares_in6_addr *addr,
 509                               const struct apattern *sortlist,
 510                               int nsort)
 511 {
 512   int i;
 513
 514   for (i = 0; i < nsort; i++)
 515     {
 516       if (sortlist[i].family != AF_INET6)
 517         continue;
 518         if (!ares_bitncmp(addr,
 519                           &sortlist[i].addrV6,
 520                           sortlist[i].mask.bits))
 521           break;
 522     }
 523   return i;
 524 }