src/src/host.c

   1 /* $Cambridge: exim/src/src/host.c,v 1.24 2006/04/04 11:18:31 ph10 Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2006 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10 /* Functions for finding hosts, either by gethostbyname(), gethostbyaddr(), or
  11 directly via the DNS. When IPv6 is supported, getipnodebyname() and
  12 getipnodebyaddr() may be used instead of gethostbyname() and gethostbyaddr(),
  13 if the newer functions are available. This module also contains various other
  14 functions concerned with hosts and addresses, and a random number function,
  15 used for randomizing hosts with equal MXs but available for use in other parts
  16 of Exim. */
  17
  18
  19 #include "exim.h"
  20
  21
  22 /* Static variable for preserving the list of interface addresses in case it is
  23 used more than once. */
  24
  25 static ip_address_item *local_interface_data = NULL;
  26
  27
  28 #ifdef USE_INET_NTOA_FIX
  29 /*************************************************
  30 *         Replacement for broken inet_ntoa()     *
  31 *************************************************/
  32
  33 /* On IRIX systems, gcc uses a different structure passing convention to the
  34 native libraries. This causes inet_ntoa() to always yield 0.0.0.0 or
  35 255.255.255.255. To get round this, we provide a private version of the
  36 function here. It is used only if USE_INET_NTOA_FIX is set, which should happen
  37 only when gcc is in use on an IRIX system. Code send to me by J.T. Breitner,
  38 with these comments:
  39
  40   code by Stuart Levy
  41   as seen in comp.sys.sgi.admin
  42
  43 August 2005: Apparently this is also needed for AIX systems; USE_INET_NTOA_FIX
  44 should now be set for them as well.
  45
  46 Arguments:  sa  an in_addr structure
  47 Returns:        pointer to static text string
  48 */
  49
  50 char *
  51 inet_ntoa(struct in_addr sa)
  52 {
  53 static uschar addr[20];
  54 sprintf(addr, "%d.%d.%d.%d",
  55         (US &sa.s_addr)[0],
  56         (US &sa.s_addr)[1],
  57         (US &sa.s_addr)[2],
  58         (US &sa.s_addr)[3]);
  59   return addr;
  60 }
  61 #endif
  62
  63
  64
  65 /*************************************************
  66 *              Random number generator           *
  67 *************************************************/
  68
  69 /* This is a simple pseudo-random number generator. It does not have to be
  70 very good for the uses to which it is put. When running the regression tests,
  71 start with a fixed seed.
  72
  73 Arguments:
  74   limit:    one more than the largest number required
  75
  76 Returns:    a pseudo-random number in the range 0 to limit-1
  77 */
  78
  79 int
  80 random_number(int limit)
  81 {
  82 if (random_seed == 0)
  83   {
  84   if (running_in_test_harness) random_seed = 42; else
  85     {
  86     int p = (int)getpid();
  87     random_seed = (int)time(NULL) ^ ((p << 16) | p);
  88     }
  89   }
  90 random_seed = 1103515245 * random_seed + 12345;
  91 return (unsigned int)(random_seed >> 16) % limit;
  92 }
  93
  94
  95
  96 /*************************************************
  97 *       Replace gethostbyname() when testing     *
  98 *************************************************/
  99
 100 /* This function is called instead of gethostbyname(), gethostbyname2(), or
 101 getipnodebyname() when running in the test harness. It recognizes the name
 102 "manyhome.test.ex" and generates a humungous number of IP addresses. It also
 103 recognizes an unqualified "localhost" and forces it to the appropriate loopback
 104 address. IP addresses are treated as literals. For other names, it uses the DNS
 105 to find the host name. In the test harness, this means it will access only the
 106 fake DNS resolver.
 107
 108 Arguments:
 109   name          the host name or a textual IP address
 110   af            AF_INET or AF_INET6
 111   error_num     where to put an error code:
 112                 HOST_NOT_FOUND/TRY_AGAIN/NO_RECOVERY/NO_DATA
 113
 114 Returns:        a hostent structure or NULL for an error
 115 */
 116
 117 static struct hostent *
 118 host_fake_gethostbyname(uschar *name, int af, int *error_num)
 119 {
 120 #if HAVE_IPV6
 121 int alen = (af == AF_INET)? sizeof(struct in_addr):sizeof(struct in6_addr);
 122 #else
 123 int alen = sizeof(struct in_addr);
 124 #endif
 125
 126 int ipa;
 127 uschar *lname = name;
 128 uschar *adds;
 129 uschar **alist;
 130 struct hostent *yield;
 131 dns_answer dnsa;
 132 dns_scan dnss;
 133 dns_record *rr;
 134
 135 DEBUG(D_host_lookup)
 136   debug_printf("using host_fake_gethostbyname for %s (%s)\n", name,
 137     (af == AF_INET)? "IPv4" : "IPv6");
 138
 139 /* Handle the name that needs a vast number of IP addresses */
 140
 141 if (Ustrcmp(name, "manyhome.test.ex") == 0 && af == AF_INET)
 142   {
 143   int i, j;
 144   yield = store_get(sizeof(struct hostent));
 145   alist = store_get(2049 * sizeof(char *));
 146   adds  = store_get(2048 * alen);
 147   yield->h_name = CS name;
 148   yield->h_aliases = NULL;
 149   yield->h_addrtype = af;
 150   yield->h_length = alen;
 151   yield->h_addr_list = CSS alist;
 152   for (i = 104; i <= 111; i++)
 153     {
 154     for (j = 0; j <= 255; j++)
 155       {
 156       *alist++ = adds;
 157       *adds++ = 10;
 158       *adds++ = 250;
 159       *adds++ = i;
 160       *adds++ = j;
 161       }
 162     }
 163   *alist = NULL;
 164   return yield;
 165   }
 166
 167 /* Handle unqualified "localhost" */
 168
 169 if (Ustrcmp(name, "localhost") == 0)
 170   lname = (af == AF_INET)? US"127.0.0.1" : US"::1";
 171
 172 /* Handle a literal IP address */
 173
 174 ipa = string_is_ip_address(lname, NULL);
 175 if (ipa != 0)
 176   {
 177   if ((ipa == 4 && af == AF_INET) ||
 178       (ipa == 6 && af == AF_INET6))
 179     {
 180     int i, n;
 181     int x[4];
 182     yield = store_get(sizeof(struct hostent));
 183     alist = store_get(2 * sizeof(char *));
 184     adds  = store_get(alen);
 185     yield->h_name = CS name;
 186     yield->h_aliases = NULL;
 187     yield->h_addrtype = af;
 188     yield->h_length = alen;
 189     yield->h_addr_list = CSS alist;
 190     *alist++ = adds;
 191     n = host_aton(lname, x);
 192     for (i = 0; i < n; i++)
 193       {
 194       int y = x[i];
 195       *adds++ = (y >> 24) & 255;
 196       *adds++ = (y >> 16) & 255;
 197       *adds++ = (y >> 8) & 255;
 198       *adds++ = y & 255;
 199       }
 200     *alist = NULL;
 201     }
 202
 203   /* Wrong kind of literal address */
 204
 205   else
 206     {
 207     *error_num = HOST_NOT_FOUND;
 208     return NULL;
 209     }
 210   }
 211
 212 /* Handle a host name */
 213
 214 else
 215   {
 216   int type = (af == AF_INET)? T_A:T_AAAA;
 217   int rc = dns_lookup(&dnsa, lname, type, NULL);
 218   int count = 0;
 219
 220   switch(rc)
 221     {
 222     case DNS_SUCCEED: break;
 223     case DNS_NOMATCH: *error_num = HOST_NOT_FOUND; return NULL;
 224     case DNS_NODATA:  *error_num = NO_DATA; return NULL;
 225     case DNS_AGAIN:   *error_num = TRY_AGAIN; return NULL;
 226     default:
 227     case DNS_FAIL:    *error_num = NO_RECOVERY; return NULL;
 228     }
 229
 230   for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
 231        rr != NULL;
 232        rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
 233     {
 234     if (rr->type == type) count++;
 235     }
 236
 237   yield = store_get(sizeof(struct hostent));
 238   alist = store_get((count + 1) * sizeof(char **));
 239   adds  = store_get(count *alen);
 240
 241   yield->h_name = CS name;
 242   yield->h_aliases = NULL;
 243   yield->h_addrtype = af;
 244   yield->h_length = alen;
 245   yield->h_addr_list = CSS alist;
 246
 247   for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
 248        rr != NULL;
 249        rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
 250     {
 251     int i, n;
 252     int x[4];
 253     dns_address *da;
 254     if (rr->type != type) continue;
 255     da = dns_address_from_rr(&dnsa, rr);
 256     *alist++ = adds;
 257     n = host_aton(da->address, x);
 258     for (i = 0; i < n; i++)
 259       {
 260       int y = x[i];
 261       *adds++ = (y >> 24) & 255;
 262       *adds++ = (y >> 16) & 255;
 263       *adds++ = (y >> 8) & 255;
 264       *adds++ = y & 255;
 265       }
 266     }
 267   *alist = NULL;
 268   }
 269
 270 return yield;
 271 }
 272
 273
 274
 275 /*************************************************
 276 *       Build chain of host items from list      *
 277 *************************************************/
 278
 279 /* This function builds a chain of host items from a textual list of host
 280 names. It does not do any lookups. If randomize is true, the chain is build in
 281 a randomized order. There may be multiple groups of independently randomized
 282 hosts; they are delimited by a host name consisting of just "+".
 283
 284 Arguments:
 285   anchor      anchor for the chain
 286   list        text list
 287   randomize   TRUE for randomizing
 288
 289 Returns:      nothing
 290 */
 291
 292 void
 293 host_build_hostlist(host_item **anchor, uschar *list, BOOL randomize)
 294 {
 295 int sep = 0;
 296 int fake_mx = MX_NONE;          /* This value is actually -1 */
 297 uschar *name;
 298 uschar buffer[1024];
 299
 300 if (list == NULL) return;
 301 if (randomize) fake_mx--;       /* Start at -2 for randomizing */
 302
 303 *anchor = NULL;
 304
 305 while ((name = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
 306   {
 307   host_item *h;
 308
 309   if (name[0] == '+' && name[1] == 0)   /* "+" delimits a randomized group */
 310     {                                   /* ignore if not randomizing */
 311     if (randomize) fake_mx--;
 312     continue;
 313     }
 314
 315   h = store_get(sizeof(host_item));
 316   h->name = string_copy(name);
 317   h->address = NULL;
 318   h->port = PORT_NONE;
 319   h->mx = fake_mx;
 320   h->sort_key = randomize? (-fake_mx)*1000 + random_number(1000) : 0;
 321   h->status = hstatus_unknown;
 322   h->why = hwhy_unknown;
 323   h->last_try = 0;
 324
 325   if (*anchor == NULL)
 326     {
 327     h->next = NULL;
 328     *anchor = h;
 329     }
 330   else
 331     {
 332     host_item *hh = *anchor;
 333     if (h->sort_key < hh->sort_key)
 334       {
 335       h->next = hh;
 336       *anchor = h;
 337       }
 338     else
 339       {
 340       while (hh->next != NULL && h->sort_key >= (hh->next)->sort_key)
 341         hh = hh->next;
 342       h->next = hh->next;
 343       hh->next = h;
 344       }
 345     }
 346   }
 347 }
 348
 349
 350
 351
 352
 353 /*************************************************
 354 *        Extract port from address string        *
 355 *************************************************/
 356
 357 /* In the spool file, and in the -oMa and -oMi options, a host plus port is
 358 given as an IP address followed by a dot and a port number. This function
 359 decodes this.
 360
 361 An alternative format for the -oMa and -oMi options is [ip address]:port which
 362 is what Exim 4 uses for output, because it seems to becoming commonly used,
 363 whereas the dot form confuses some programs/people. So we recognize that form
 364 too.
 365
 366 Argument:
 367   address    points to the string; if there is a port, the '.' in the string
 368              is overwritten with zero to terminate the address; if the string
 369              is in the [xxx]:ppp format, the address is shifted left and the
 370              brackets are removed
 371
 372 Returns:     0 if there is no port, else the port number. If there's a syntax
 373              error, leave the incoming address alone, and return 0.
 374 */
 375
 376 int
 377 host_address_extract_port(uschar *address)
 378 {
 379 int port = 0;
 380 uschar *endptr;
 381
 382 /* Handle the "bracketed with colon on the end" format */
 383
 384 if (*address == '[')
 385   {
 386   uschar *rb = address + 1;
 387   while (*rb != 0 && *rb != ']') rb++;
 388   if (*rb++ == 0) return 0;        /* Missing ]; leave invalid address */
 389   if (*rb == ':')
 390     {
 391     port = Ustrtol(rb + 1, &endptr, 10);
 392     if (*endptr != 0) return 0;    /* Invalid port; leave invalid address */
 393     }
 394   else if (*rb != 0) return 0;     /* Bad syntax; leave invalid address */
 395   memmove(address, address + 1, rb - address - 2);
 396   rb[-2] = 0;
 397   }
 398
 399 /* Handle the "dot on the end" format */
 400
 401 else
 402   {
 403   int skip = -3;                   /* Skip 3 dots in IPv4 addresses */
 404   address--;
 405   while (*(++address) != 0)
 406     {
 407     int ch = *address;
 408     if (ch == ':') skip = 0;       /* Skip 0 dots in IPv6 addresses */
 409       else if (ch == '.' && skip++ >= 0) break;
 410     }
 411   if (*address == 0) return 0;
 412   port = Ustrtol(address + 1, &endptr, 10);
 413   if (*endptr != 0) return 0;      /* Invalid port; leave invalid address */
 414   *address = 0;
 415   }
 416
 417 return port;
 418 }
 419
 420
 421 /*************************************************
 422 *         Get port from a host item's name       *
 423 *************************************************/
 424
 425 /* This function is called when finding the IP address for a host that is in a
 426 list of hosts explicitly configured, such as in the manualroute router, or in a
 427 fallback hosts list. We see if there is a port specification at the end of the
 428 host name, and if so, remove it. A minimum length of 3 is required for the
 429 original name; nothing shorter is recognized as having a port.
 430
 431 We test for a name ending with a sequence of digits; if preceded by colon we
 432 have a port if the character before the colon is ] and the name starts with [
 433 or if there are no other colons in the name (i.e. it's not an IPv6 address).
 434
 435 Arguments:  pointer to the host item
 436 Returns:    a port number or PORT_NONE
 437 */
 438
 439 int
 440 host_item_get_port(host_item *h)
 441 {
 442 uschar *p;
 443 int port, x;
 444 int len = Ustrlen(h->name);
 445
 446 if (len < 3 || (p = h->name + len - 1, !isdigit(*p))) return PORT_NONE;
 447
 448 /* Extract potential port number */
 449
 450 port = *p-- - '0';
 451 x = 10;
 452
 453 while (p > h->name + 1 && isdigit(*p))
 454   {
 455   port += (*p-- - '0') * x;
 456   x *= 10;
 457   }
 458
 459 /* The smallest value of p at this point is h->name + 1. */
 460
 461 if (*p != ':') return PORT_NONE;
 462
 463 if (p[-1] == ']' && h->name[0] == '[')
 464   h->name = string_copyn(h->name + 1, p - h->name - 2);
 465 else if (Ustrchr(h->name, ':') == p)
 466   h->name = string_copyn(h->name, p - h->name);
 467 else return PORT_NONE;
 468
 469 DEBUG(D_route|D_host_lookup) debug_printf("host=%s port=%d\n", h->name, port);
 470 return port;
 471 }
 472
 473
 474
 475 #ifndef STAND_ALONE    /* Omit when standalone testing */
 476
 477 /*************************************************
 478 *     Build sender_fullhost and sender_rcvhost   *
 479 *************************************************/
 480
 481 /* This function is called when sender_host_name and/or sender_helo_name
 482 have been set. Or might have been set - for a local message read off the spool
 483 they won't be. In that case, do nothing. Otherwise, set up the fullhost string
 484 as follows:
 485
 486 (a) No sender_host_name or sender_helo_name: "[ip address]"
 487 (b) Just sender_host_name: "host_name [ip address]"
 488 (c) Just sender_helo_name: "(helo_name) [ip address]" unless helo is IP
 489             in which case: "[ip address}"
 490 (d) The two are identical: "host_name [ip address]" includes helo = IP
 491 (e) The two are different: "host_name (helo_name) [ip address]"
 492
 493 If log_incoming_port is set, the sending host's port number is added to the IP
 494 address.
 495
 496 This function also builds sender_rcvhost for use in Received: lines, whose
 497 syntax is a bit different. This value also includes the RFC 1413 identity.
 498 There wouldn't be two different variables if I had got all this right in the
 499 first place.
 500
 501 Because this data may survive over more than one incoming SMTP message, it has
 502 to be in permanent store.
 503
 504 Arguments:  none
 505 Returns:    nothing
 506 */
 507
 508 void
 509 host_build_sender_fullhost(void)
 510 {
 511 BOOL show_helo = TRUE;
 512 uschar *address;
 513 int len;
 514 int old_pool = store_pool;
 515
 516 if (sender_host_address == NULL) return;
 517
 518 store_pool = POOL_PERM;
 519
 520 /* Set up address, with or without the port. After discussion, it seems that
 521 the only format that doesn't cause trouble is [aaaa]:pppp. However, we can't
 522 use this directly as the first item for Received: because it ain't an RFC 2822
 523 domain. Sigh. */
 524
 525 address = string_sprintf("[%s]:%d", sender_host_address, sender_host_port);
 526 if ((log_extra_selector & LX_incoming_port) == 0 || sender_host_port <= 0)
 527   *(Ustrrchr(address, ':')) = 0;
 528
 529 /* If there's no EHLO/HELO data, we can't show it. */
 530
 531 if (sender_helo_name == NULL) show_helo = FALSE;
 532
 533 /* If HELO/EHLO was followed by an IP literal, it's messy because of two
 534 features of IPv6. Firstly, there's the "IPv6:" prefix (Exim is liberal and
 535 doesn't require this, for historical reasons). Secondly, IPv6 addresses may not
 536 be given in canonical form, so we have to canonicize them before comparing. As
 537 it happens, the code works for both IPv4 and IPv6. */
 538
 539 else if (sender_helo_name[0] == '[' &&
 540          sender_helo_name[(len=Ustrlen(sender_helo_name))-1] == ']')
 541   {
 542   int offset = 1;
 543   uschar *helo_ip;
 544
 545   if (strncmpic(sender_helo_name + 1, US"IPv6:", 5) == 0) offset += 5;
 546   if (strncmpic(sender_helo_name + 1, US"IPv4:", 5) == 0) offset += 5;
 547
 548   helo_ip = string_copyn(sender_helo_name + offset, len - offset - 1);
 549
 550   if (string_is_ip_address(helo_ip, NULL) != 0)
 551     {
 552     int x[4], y[4];
 553     int sizex, sizey;
 554     uschar ipx[48], ipy[48];    /* large enough for full IPv6 */
 555
 556     sizex = host_aton(helo_ip, x);
 557     sizey = host_aton(sender_host_address, y);
 558
 559     (void)host_nmtoa(sizex, x, -1, ipx, ':');
 560     (void)host_nmtoa(sizey, y, -1, ipy, ':');
 561
 562     if (strcmpic(ipx, ipy) == 0) show_helo = FALSE;
 563     }
 564   }
 565
 566 /* Host name is not verified */
 567
 568 if (sender_host_name == NULL)
 569   {
 570   uschar *portptr = Ustrstr(address, "]:");
 571   int size = 0;
 572   int ptr = 0;
 573   int adlen;    /* Sun compiler doesn't like ++ in initializers */
 574
 575   adlen = (portptr == NULL)? Ustrlen(address) : (++portptr - address);
 576   sender_fullhost = (sender_helo_name == NULL)? address :
 577     string_sprintf("(%s) %s", sender_helo_name, address);
 578
 579   sender_rcvhost = string_cat(NULL, &size, &ptr, address, adlen);
 580
 581   if (sender_ident != NULL || show_helo || portptr != NULL)
 582     {
 583     int firstptr;
 584     sender_rcvhost = string_cat(sender_rcvhost, &size, &ptr, US" (", 2);
 585     firstptr = ptr;
 586
 587     if (portptr != NULL)
 588       sender_rcvhost = string_append(sender_rcvhost, &size, &ptr, 2, US"port=",
 589         portptr + 1);
 590
 591     if (show_helo)
 592       sender_rcvhost = string_append(sender_rcvhost, &size, &ptr, 2,
 593         (firstptr == ptr)? US"helo=" : US" helo=", sender_helo_name);
 594
 595     if (sender_ident != NULL)
 596       sender_rcvhost = string_append(sender_rcvhost, &size, &ptr, 2,
 597         (firstptr == ptr)? US"ident=" : US" ident=", sender_ident);
 598
 599     sender_rcvhost = string_cat(sender_rcvhost, &size, &ptr, US")", 1);
 600     }
 601
 602   sender_rcvhost[ptr] = 0;   /* string_cat() always leaves room */
 603
 604   /* Release store, because string_cat allocated a minimum of 100 bytes that
 605   are rarely completely used. */
 606
 607   store_reset(sender_rcvhost + ptr + 1);
 608   }
 609
 610 /* Host name is known and verified. Unless we've already found that the HELO
 611 data matches the IP address, compare it with the name. */
 612
 613 else
 614   {
 615   if (show_helo && strcmpic(sender_host_name, sender_helo_name) == 0)
 616     show_helo = FALSE;
 617
 618   if (show_helo)
 619     {
 620     sender_fullhost = string_sprintf("%s (%s) %s", sender_host_name,
 621       sender_helo_name, address);
 622     sender_rcvhost = (sender_ident == NULL)?
 623       string_sprintf("%s (%s helo=%s)", sender_host_name,
 624         address, sender_helo_name) :
 625       string_sprintf("%s\n\t(%s helo=%s ident=%s)", sender_host_name,
 626         address, sender_helo_name, sender_ident);
 627     }
 628   else
 629     {
 630     sender_fullhost = string_sprintf("%s %s", sender_host_name, address);
 631     sender_rcvhost = (sender_ident == NULL)?
 632       string_sprintf("%s (%s)", sender_host_name, address) :
 633       string_sprintf("%s (%s ident=%s)", sender_host_name, address,
 634         sender_ident);
 635     }
 636   }
 637
 638 store_pool = old_pool;
 639
 640 DEBUG(D_host_lookup) debug_printf("sender_fullhost = %s\n", sender_fullhost);
 641 DEBUG(D_host_lookup) debug_printf("sender_rcvhost = %s\n", sender_rcvhost);
 642 }
 643
 644
 645
 646 /*************************************************
 647 *          Build host+ident message              *
 648 *************************************************/
 649
 650 /* Used when logging rejections and various ACL and SMTP incidents. The text
 651 return depends on whether sender_fullhost and sender_ident are set or not:
 652
 653   no ident, no host   => U=unknown
 654   no ident, host set  => H=sender_fullhost
 655   ident set, no host  => U=ident
 656   ident set, host set => H=sender_fullhost U=ident
 657
 658 Arguments:
 659   useflag   TRUE if first item to be flagged (H= or U=); if there are two
 660               items, the second is always flagged
 661
 662 Returns:    pointer to a string in big_buffer
 663 */
 664
 665 uschar *
 666 host_and_ident(BOOL useflag)
 667 {
 668 if (sender_fullhost == NULL)
 669   {
 670   (void)string_format(big_buffer, big_buffer_size, "%s%s", useflag? "U=" : "",
 671      (sender_ident == NULL)? US"unknown" : sender_ident);
 672   }
 673 else
 674   {
 675   uschar *flag = useflag? US"H=" : US"";
 676   uschar *iface = US"";
 677   if ((log_extra_selector & LX_incoming_interface) != 0 &&
 678        interface_address != NULL)
 679     iface = string_sprintf(" I=[%s]:%d", interface_address, interface_port);
 680   if (sender_ident == NULL)
 681     (void)string_format(big_buffer, big_buffer_size, "%s%s%s",
 682       flag, sender_fullhost, iface);
 683   else
 684     (void)string_format(big_buffer, big_buffer_size, "%s%s%s U=%s",
 685       flag, sender_fullhost, iface, sender_ident);
 686   }
 687 return big_buffer;
 688 }
 689
 690 #endif   /* STAND_ALONE */
 691
 692
 693
 694
 695 /*************************************************
 696 *         Build list of local interfaces         *
 697 *************************************************/
 698
 699 /* This function interprets the contents of the local_interfaces or
 700 extra_local_interfaces options, and creates an ip_address_item block for each
 701 item on the list. There is no special interpretation of any IP addresses; in
 702 particular, 0.0.0.0 and ::0 are returned without modification. If any address
 703 includes a port, it is set in the block. Otherwise the port value is set to
 704 zero.
 705
 706 Arguments:
 707   list        the list
 708   name        the name of the option being expanded
 709
 710 Returns:      a chain of ip_address_items, each containing to a textual
 711               version of an IP address, and a port number (host order) or
 712               zero if no port was given with the address
 713 */
 714
 715 ip_address_item *
 716 host_build_ifacelist(uschar *list, uschar *name)
 717 {
 718 int sep = 0;
 719 uschar *s;
 720 uschar buffer[64];
 721 ip_address_item *yield = NULL;
 722 ip_address_item *last = NULL;
 723 ip_address_item *next;
 724
 725 while ((s = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
 726   {
 727   int ipv;
 728   int port = host_address_extract_port(s);            /* Leaves just the IP address */
 729   if ((ipv = string_is_ip_address(s, NULL)) == 0)
 730     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Malformed IP address \"%s\" in %s",
 731       s, name);
 732
 733   /* Skip IPv6 addresses if IPv6 is disabled. */
 734
 735   if (disable_ipv6 && ipv == 6) continue;
 736
 737   /* This use of strcpy() is OK because we have checked that s is a valid IP
 738   address above. The field in the ip_address_item is large enough to hold an
 739   IPv6 address. */
 740
 741   next = store_get(sizeof(ip_address_item));
 742   next->next = NULL;
 743   Ustrcpy(next->address, s);
 744   next->port = port;
 745   next->v6_include_v4 = FALSE;
 746
 747   if (yield == NULL) yield = last = next; else
 748     {
 749     last->next = next;
 750     last = next;
 751     }
 752   }
 753
 754 return yield;
 755 }
 756
 757
 758
 759
 760
 761 /*************************************************
 762 *         Find addresses on local interfaces     *
 763 *************************************************/
 764
 765 /* This function finds the addresses of local IP interfaces. These are used
 766 when testing for routing to the local host. As the function may be called more
 767 than once, the list is preserved in permanent store, pointed to by a static
 768 variable, to save doing the work more than once per process.
 769
 770 The generic list of interfaces is obtained by calling host_build_ifacelist()
 771 for local_interfaces and extra_local_interfaces. This list scanned to remove
 772 duplicates (which may exist with different ports - not relevant here). If
 773 either of the wildcard IP addresses (0.0.0.0 and ::0) are encountered, they are
 774 replaced by the appropriate (IPv4 or IPv6) list of actual local interfaces,
 775 obtained from os_find_running_interfaces().
 776
 777 Arguments:    none
 778 Returns:      a chain of ip_address_items, each containing to a textual
 779               version of an IP address; the port numbers are not relevant
 780 */
 781
 782
 783 /* First, a local subfunction to add an interface to a list in permanent store,
 784 but only if there isn't a previous copy of that address on the list. */
 785
 786 static ip_address_item *
 787 add_unique_interface(ip_address_item *list, ip_address_item *ipa)
 788 {
 789 ip_address_item *ipa2;
 790 for (ipa2 = list; ipa2 != NULL; ipa2 = ipa2->next)
 791   if (Ustrcmp(ipa2->address, ipa->address) == 0) return list;
 792 ipa2 = store_get_perm(sizeof(ip_address_item));
 793 *ipa2 = *ipa;
 794 ipa2->next = list;
 795 return ipa2;
 796 }
 797
 798
 799 /* This is the globally visible function */
 800
 801 ip_address_item *
 802 host_find_interfaces(void)
 803 {
 804 ip_address_item *running_interfaces = NULL;
 805
 806 if (local_interface_data == NULL)
 807   {
 808   void *reset_item = store_get(0);
 809   ip_address_item *dlist = host_build_ifacelist(local_interfaces,
 810     US"local_interfaces");
 811   ip_address_item *xlist = host_build_ifacelist(extra_local_interfaces,
 812     US"extra_local_interfaces");
 813   ip_address_item *ipa;
 814
 815   if (dlist == NULL) dlist = xlist; else
 816     {
 817     for (ipa = dlist; ipa->next != NULL; ipa = ipa->next);
 818     ipa->next = xlist;
 819     }
 820
 821   for (ipa = dlist; ipa != NULL; ipa = ipa->next)
 822     {
 823     if (Ustrcmp(ipa->address, "0.0.0.0") == 0 ||
 824         Ustrcmp(ipa->address, "::0") == 0)
 825       {
 826       ip_address_item *ipa2;
 827       BOOL ipv6 = ipa->address[0] == ':';
 828       if (running_interfaces == NULL)
 829         running_interfaces = os_find_running_interfaces();
 830       for (ipa2 = running_interfaces; ipa2 != NULL; ipa2 = ipa2->next)
 831         {
 832         if ((Ustrchr(ipa2->address, ':') != NULL) == ipv6)
 833           local_interface_data = add_unique_interface(local_interface_data,
 834           ipa2);
 835         }
 836       }
 837     else
 838       {
 839       local_interface_data = add_unique_interface(local_interface_data, ipa);
 840       DEBUG(D_interface)
 841         {
 842         debug_printf("Configured local interface: address=%s", ipa->address);
 843         if (ipa->port != 0) debug_printf(" port=%d", ipa->port);
 844         debug_printf("\n");
 845         }
 846       }
 847     }
 848   store_reset(reset_item);
 849   }
 850
 851 return local_interface_data;
 852 }
 853
 854
 855
 856
 857
 858 /*************************************************
 859 *        Convert network IP address to text      *
 860 *************************************************/
 861
 862 /* Given an IPv4 or IPv6 address in binary, convert it to a text
 863 string and return the result in a piece of new store. The address can
 864 either be given directly, or passed over in a sockaddr structure. Note
 865 that this isn't the converse of host_aton() because of byte ordering
 866 differences. See host_nmtoa() below.
 867
 868 Arguments:
 869   type       if < 0 then arg points to a sockaddr, else
 870              either AF_INET or AF_INET6
 871   arg        points to a sockaddr if type is < 0, or
 872              points to an IPv4 address (32 bits), or
 873              points to an IPv6 address (128 bits),
 874              in both cases, in network byte order
 875   buffer     if NULL, the result is returned in gotten store;
 876              else points to a buffer to hold the answer
 877   portptr    points to where to put the port number, if non NULL; only
 878              used when type < 0
 879
 880 Returns:     pointer to character string
 881 */
 882
 883 uschar *
 884 host_ntoa(int type, const void *arg, uschar *buffer, int *portptr)
 885 {
 886 uschar *yield;
 887
 888 /* The new world. It is annoying that we have to fish out the address from
 889 different places in the block, depending on what kind of address it is. It
 890 is also a pain that inet_ntop() returns a const uschar *, whereas the IPv4
 891 function inet_ntoa() returns just uschar *, and some picky compilers insist
 892 on warning if one assigns a const uschar * to a uschar *. Hence the casts. */
 893
 894 #if HAVE_IPV6
 895 uschar addr_buffer[46];
 896 if (type < 0)
 897   {
 898   int family = ((struct sockaddr *)arg)->sa_family;
 899   if (family == AF_INET6)
 900     {
 901     struct sockaddr_in6 *sk = (struct sockaddr_in6 *)arg;
 902     yield = (uschar *)inet_ntop(family, &(sk->sin6_addr), CS addr_buffer,
 903       sizeof(addr_buffer));
 904     if (portptr != NULL) *portptr = ntohs(sk->sin6_port);
 905     }
 906   else
 907     {
 908     struct sockaddr_in *sk = (struct sockaddr_in *)arg;
 909     yield = (uschar *)inet_ntop(family, &(sk->sin_addr), CS addr_buffer,
 910       sizeof(addr_buffer));
 911     if (portptr != NULL) *portptr = ntohs(sk->sin_port);
 912     }
 913   }
 914 else
 915   {
 916   yield = (uschar *)inet_ntop(type, arg, CS addr_buffer, sizeof(addr_buffer));
 917   }
 918
 919 /* If the result is a mapped IPv4 address, show it in V4 format. */
 920
 921 if (Ustrncmp(yield, "::ffff:", 7) == 0) yield += 7;
 922
 923 #else  /* HAVE_IPV6 */
 924
 925 /* The old world */
 926
 927 if (type < 0)
 928   {
 929   yield = US inet_ntoa(((struct sockaddr_in *)arg)->sin_addr);
 930   if (portptr != NULL) *portptr = ntohs(((struct sockaddr_in *)arg)->sin_port);
 931   }
 932 else
 933   yield = US inet_ntoa(*((struct in_addr *)arg));
 934 #endif
 935
 936 /* If there is no buffer, put the string into some new store. */
 937
 938 if (buffer == NULL) return string_copy(yield);
 939
 940 /* Callers of this function with a non-NULL buffer must ensure that it is
 941 large enough to hold an IPv6 address, namely, at least 46 bytes. That's what
 942 makes this use of strcpy() OK. */
 943
 944 Ustrcpy(buffer, yield);
 945 return buffer;
 946 }
 947
 948
 949
 950
 951 /*************************************************
 952 *         Convert address text to binary         *
 953 *************************************************/
 954
 955 /* Given the textual form of an IP address, convert it to binary in an
 956 array of ints. IPv4 addresses occupy one int; IPv6 addresses occupy 4 ints.
 957 The result has the first byte in the most significant byte of the first int. In
 958 other words, the result is not in network byte order, but in host byte order.
 959 As a result, this is not the converse of host_ntoa(), which expects network
 960 byte order. See host_nmtoa() below.
 961
 962 Arguments:
 963   address    points to the textual address, checked for syntax
 964   bin        points to an array of 4 ints
 965
 966 Returns:     the number of ints used
 967 */
 968
 969 int
 970 host_aton(uschar *address, int *bin)
 971 {
 972 int x[4];
 973 int v4offset = 0;
 974
 975 /* Handle IPv6 address, which may end with an IPv4 address. It may also end
 976 with a "scope", introduced by a percent sign. This code is NOT enclosed in #if
 977 HAVE_IPV6 in order that IPv6 addresses are recognized even if IPv6 is not
 978 supported. */
 979
 980 if (Ustrchr(address, ':') != NULL)
 981   {
 982   uschar *p = address;
 983   uschar *component[8];
 984   BOOL ipv4_ends = FALSE;
 985   int ci = 0;
 986   int nulloffset = 0;
 987   int v6count = 8;
 988   int i;
 989
 990   /* If the address starts with a colon, it will start with two colons.
 991   Just lose the first one, which will leave a null first component. */
 992
 993   if (*p == ':') p++;
 994
 995   /* Split the address into components separated by colons. The input address
 996   is supposed to be checked for syntax. There was a case where this was
 997   overlooked; to guard against that happening again, check here and crash if
 998   there are too many components. */
 999
1000   while (*p != 0 && *p != '%')
1001     {
1002     int len = Ustrcspn(p, ":%");
1003     if (len == 0) nulloffset = ci;
1004     if (ci > 7) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1005       "Internal error: invalid IPv6 address \"%s\" passed to host_aton()",
1006       address);
1007     component[ci++] = p;
1008     p += len;
1009     if (*p == ':') p++;
1010     }
1011
1012   /* If the final component contains a dot, it is a trailing v4 address.
1013   As the syntax is known to be checked, just set up for a trailing
1014   v4 address and restrict the v6 part to 6 components. */
1015
1016   if (Ustrchr(component[ci-1], '.') != NULL)
1017     {
1018     address = component[--ci];
1019     ipv4_ends = TRUE;
1020     v4offset = 3;
1021     v6count = 6;
1022     }
1023
1024   /* If there are fewer than 6 or 8 components, we have to insert some
1025   more empty ones in the middle. */
1026
1027   if (ci < v6count)
1028     {
1029     int insert_count = v6count - ci;
1030     for (i = v6count-1; i > nulloffset + insert_count; i--)
1031       component[i] = component[i - insert_count];
1032     while (i > nulloffset) component[i--] = US"";
1033     }
1034
1035   /* Now turn the components into binary in pairs and bung them
1036   into the vector of ints. */
1037
1038   for (i = 0; i < v6count; i += 2)
1039     bin[i/2] = (Ustrtol(component[i], NULL, 16) << 16) +
1040       Ustrtol(component[i+1], NULL, 16);
1041
1042   /* If there was no terminating v4 component, we are done. */
1043
1044   if (!ipv4_ends) return 4;
1045   }
1046
1047 /* Handle IPv4 address */
1048
1049 (void)sscanf(CS address, "%d.%d.%d.%d", x, x+1, x+2, x+3);
1050 bin[v4offset] = (x[0] << 24) + (x[1] << 16) + (x[2] << 8) + x[3];
1051 return v4offset+1;
1052 }
1053
1054
1055 /*************************************************
1056 *           Apply mask to an IP address          *
1057 *************************************************/
1058
1059 /* Mask an address held in 1 or 4 ints, with the ms bit in the ms bit of the
1060 first int, etc.
1061
1062 Arguments:
1063   count        the number of ints
1064   binary       points to the ints to be masked
1065   mask         the count of ms bits to leave, or -1 if no masking
1066
1067 Returns:       nothing
1068 */
1069
1070 void
1071 host_mask(int count, int *binary, int mask)
1072 {
1073 int i;
1074 if (mask < 0) mask = 99999;
1075 for (i = 0; i < count; i++)
1076   {
1077   int wordmask;
1078   if (mask == 0) wordmask = 0;
1079   else if (mask < 32)
1080     {
1081     wordmask = (-1) << (32 - mask);
1082     mask = 0;
1083     }
1084   else
1085     {
1086     wordmask = -1;
1087     mask -= 32;
1088     }
1089   binary[i] &= wordmask;
1090   }
1091 }
1092
1093
1094
1095
1096 /*************************************************
1097 *     Convert masked IP address in ints to text  *
1098 *************************************************/
1099
1100 /* We can't use host_ntoa() because it assumes the binary values are in network
1101 byte order, and these are the result of host_aton(), which puts them in ints in
1102 host byte order. Also, we really want IPv6 addresses to be in a canonical
1103 format, so we output them with no abbreviation. In a number of cases we can't
1104 use the normal colon separator in them because it terminates keys in lsearch
1105 files, so we want to use dot instead. There's an argument that specifies what
1106 to use for IPv6 addresses.
1107
1108 Arguments:
1109   count       1 or 4 (number of ints)
1110   binary      points to the ints
1111   mask        mask value; if < 0 don't add to result
1112   buffer      big enough to hold the result
1113   sep         component separator character for IPv6 addresses
1114
1115 Returns:      the number of characters placed in buffer, not counting
1116               the final nul.
1117 */
1118
1119 int
1120 host_nmtoa(int count, int *binary, int mask, uschar *buffer, int sep)
1121 {
1122 int i, j;
1123 uschar *tt = buffer;
1124
1125 if (count == 1)
1126   {
1127   j = binary[0];
1128   for (i = 24; i >= 0; i -= 8)
1129     {
1130     sprintf(CS tt, "%d.", (j >> i) & 255);
1131     while (*tt) tt++;
1132     }
1133   }
1134 else
1135   {
1136   for (i = 0; i < 4; i++)
1137     {
1138     j = binary[i];
1139     sprintf(CS tt, "%04x%c%04x%c", (j >> 16) & 0xffff, sep, j & 0xffff, sep);
1140     while (*tt) tt++;
1141     }
1142   }
1143
1144 tt--;   /* lose final separator */
1145
1146 if (mask < 0)
1147   *tt = 0;
1148 else
1149   {
1150   sprintf(CS tt, "/%d", mask);
1151   while (*tt) tt++;
1152   }
1153
1154 return tt - buffer;
1155 }
1156
1157
1158
1159 /*************************************************
1160 *        Check port for tls_on_connect           *
1161 *************************************************/
1162
1163 /* This function checks whether a given incoming port is configured for tls-
1164 on-connect. It is called from the daemon and from inetd handling. If the global
1165 option tls_on_connect is already set, all ports operate this way. Otherwise, we
1166 check the tls_on_connect_ports option for a list of ports.
1167
1168 Argument:  a port number
1169 Returns:   TRUE or FALSE
1170 */
1171
1172 BOOL
1173 host_is_tls_on_connect_port(int port)
1174 {
1175 int sep = 0;
1176 uschar buffer[32];
1177 uschar *list = tls_on_connect_ports;
1178 uschar *s;
1179
1180 if (tls_on_connect) return TRUE;
1181
1182 while ((s = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
1183   {
1184   uschar *end;
1185   int lport = Ustrtol(s, &end, 10);
1186   if (*end != 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "tls_on_connect_ports "
1187     "contains \"%s\", which is not a port number: exim abandoned", s);
1188   if (lport == port) return TRUE;
1189   }
1190
1191 return FALSE;
1192 }
1193
1194
1195
1196 /*************************************************
1197 *        Check whether host is in a network      *
1198 *************************************************/
1199
1200 /* This function checks whether a given IP address matches a pattern that
1201 represents either a single host, or a network (using CIDR notation). The caller
1202 of this function must check the syntax of the arguments before calling it.
1203
1204 Arguments:
1205   host        string representation of the ip-address to check
1206   net         string representation of the network, with optional CIDR mask
1207   maskoffset  offset to the / that introduces the mask in the key
1208               zero if there is no mask
1209
1210 Returns:
1211   TRUE   the host is inside the network
1212   FALSE  the host is NOT inside the network
1213 */
1214
1215 BOOL
1216 host_is_in_net(uschar *host, uschar *net, int maskoffset)
1217 {
1218 int i;
1219 int address[4];
1220 int incoming[4];
1221 int mlen;
1222 int size = host_aton(net, address);
1223 int insize;
1224
1225 /* No mask => all bits to be checked */
1226
1227 if (maskoffset == 0) mlen = 99999;    /* Big number */
1228   else mlen = Uatoi(net + maskoffset + 1);
1229
1230 /* Convert the incoming address to binary. */
1231
1232 insize = host_aton(host, incoming);
1233
1234 /* Convert IPv4 addresses given in IPv6 compatible mode, which represent
1235    connections from IPv4 hosts to IPv6 hosts, that is, addresses of the form
1236    ::ffff:<v4address>, to IPv4 format. */
1237
1238 if (insize == 4 && incoming[0] == 0 && incoming[1] == 0 &&
1239     incoming[2] == 0xffff)
1240   {
1241   insize = 1;
1242   incoming[0] = incoming[3];
1243   }
1244
1245 /* No match if the sizes don't agree. */
1246
1247 if (insize != size) return FALSE;
1248
1249 /* Else do the masked comparison. */
1250
1251 for (i = 0; i < size; i++)
1252   {
1253   int mask;
1254   if (mlen == 0) mask = 0;
1255   else if (mlen < 32)
1256     {
1257     mask = (-1) << (32 - mlen);
1258     mlen = 0;
1259     }
1260   else
1261     {
1262     mask = -1;
1263     mlen -= 32;
1264     }
1265   if ((incoming[i] & mask) != (address[i] & mask)) return FALSE;
1266   }
1267
1268 return TRUE;
1269 }
1270
1271
1272
1273 /*************************************************
1274 *       Scan host list for local hosts           *
1275 *************************************************/
1276
1277 /* Scan through a chain of addresses and check whether any of them is the
1278 address of an interface on the local machine. If so, remove that address and
1279 any previous ones with the same MX value, and all subsequent ones (which will
1280 have greater or equal MX values) from the chain. Note: marking them as unusable
1281 is NOT the right thing to do because it causes the hosts not to be used for
1282 other domains, for which they may well be correct.
1283
1284 The hosts may be part of a longer chain; we only process those between the
1285 initial pointer and the "last" pointer.
1286
1287 There is also a list of "pseudo-local" host names which are checked against the
1288 host names. Any match causes that host item to be treated the same as one which
1289 matches a local IP address.
1290
1291 If the very first host is a local host, then all MX records had a precedence
1292 greater than or equal to that of the local host. Either there's a problem in
1293 the DNS, or an apparently remote name turned out to be an abbreviation for the
1294 local host. Give a specific return code, and let the caller decide what to do.
1295 Otherwise, give a success code if at least one host address has been found.
1296
1297 Arguments:
1298   host        pointer to the first host in the chain
1299   lastptr     pointer to pointer to the last host in the chain (may be updated)
1300   removed     if not NULL, set TRUE if some local addresses were removed
1301                 from the list
1302
1303 Returns:
1304   HOST_FOUND       if there is at least one host with an IP address on the chain
1305                      and an MX value less than any MX value associated with the
1306                      local host
1307   HOST_FOUND_LOCAL if a local host is among the lowest-numbered MX hosts; when
1308                      the host addresses were obtained from A records or
1309                      gethostbyname(), the MX values are set to -1.
1310   HOST_FIND_FAILED if no valid hosts with set IP addresses were found
1311 */
1312
1313 int
1314 host_scan_for_local_hosts(host_item *host, host_item **lastptr, BOOL *removed)
1315 {
1316 int yield = HOST_FIND_FAILED;
1317 host_item *last = *lastptr;
1318 host_item *prev = NULL;
1319 host_item *h;
1320
1321 if (removed != NULL) *removed = FALSE;
1322
1323 if (local_interface_data == NULL) local_interface_data = host_find_interfaces();
1324
1325 for (h = host; h != last->next; h = h->next)
1326   {
1327   #ifndef STAND_ALONE
1328   if (hosts_treat_as_local != NULL)
1329     {
1330     int rc;
1331     uschar *save = deliver_domain;
1332     deliver_domain = h->name;   /* set $domain */
1333     rc = match_isinlist(string_copylc(h->name), &hosts_treat_as_local, 0,
1334       &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL);
1335     deliver_domain = save;
1336     if (rc == OK) goto FOUND_LOCAL;
1337     }
1338   #endif
1339
1340   /* It seems that on many operating systems, 0.0.0.0 is treated as a synonym
1341   for 127.0.0.1 and refers to the local host. We therefore force it always to
1342   be treated as local. */
1343
1344   if (h->address != NULL)
1345     {
1346     ip_address_item *ip;
1347     if (Ustrcmp(h->address, "0.0.0.0") == 0) goto FOUND_LOCAL;
1348     for (ip = local_interface_data; ip != NULL; ip = ip->next)
1349       if (Ustrcmp(h->address, ip->address) == 0) goto FOUND_LOCAL;
1350     yield = HOST_FOUND;  /* At least one remote address has been found */
1351     }
1352
1353   /* Update prev to point to the last host item before any that have
1354   the same MX value as the one we have just considered. */
1355
1356   if (h->next == NULL || h->next->mx != h->mx) prev = h;
1357   }
1358
1359 return yield;  /* No local hosts found: return HOST_FOUND or HOST_FIND_FAILED */
1360
1361 /* A host whose IP address matches a local IP address, or whose name matches
1362 something in hosts_treat_as_local has been found. */
1363
1364 FOUND_LOCAL:
1365
1366 if (prev == NULL)
1367   {
1368   HDEBUG(D_host_lookup) debug_printf((h->mx >= 0)?
1369     "local host has lowest MX\n" :
1370     "local host found for non-MX address\n");
1371   return HOST_FOUND_LOCAL;
1372   }
1373
1374 HDEBUG(D_host_lookup)
1375   {
1376   debug_printf("local host in host list - removed hosts:\n");
1377   for (h = prev->next; h != last->next; h = h->next)
1378     debug_printf("  %s %s %d\n", h->name, h->address, h->mx);
1379   }
1380
1381 if (removed != NULL) *removed = TRUE;
1382 prev->next = last->next;
1383 *lastptr = prev;
1384 return yield;
1385 }
1386
1387
1388
1389
1390 /*************************************************
1391 *        Remove duplicate IPs in host list       *
1392 *************************************************/
1393
1394 /* You would think that administrators could set up their DNS records so that
1395 one ended up with a list of unique IP addresses after looking up A or MX
1396 records, but apparently duplication is common. So we scan such lists and
1397 remove the later duplicates. Note that we may get lists in which some host
1398 addresses are not set.
1399
1400 Arguments:
1401   host        pointer to the first host in the chain
1402   lastptr     pointer to pointer to the last host in the chain (may be updated)
1403
1404 Returns:      nothing
1405 */
1406
1407 static void
1408 host_remove_duplicates(host_item *host, host_item **lastptr)
1409 {
1410 while (host != *lastptr)
1411   {
1412   if (host->address != NULL)
1413     {
1414     host_item *h = host;
1415     while (h != *lastptr)
1416       {
1417       if (h->next->address != NULL &&
1418           Ustrcmp(h->next->address, host->address) == 0)
1419         {
1420         DEBUG(D_host_lookup) debug_printf("duplicate IP address %s (MX=%d) "
1421           "removed\n", host->address, h->next->mx);
1422         if (h->next == *lastptr) *lastptr = h;
1423         h->next = h->next->next;
1424         }
1425       else h = h->next;
1426       }
1427     }
1428   /* If the last item was removed, host may have become == *lastptr */
1429   if (host != *lastptr) host = host->next;
1430   }
1431 }
1432
1433
1434
1435
1436 /*************************************************
1437 *    Find sender host name by gethostbyaddr()    *
1438 *************************************************/
1439
1440 /* This used to be the only way it was done, but it turns out that not all
1441 systems give aliases for calls to gethostbyaddr() - or one of the modern
1442 equivalents like getipnodebyaddr(). Fortunately, multiple PTR records are rare,
1443 but they can still exist. This function is now used only when a DNS lookup of
1444 the IP address fails, in order to give access to /etc/hosts.
1445
1446 Arguments:   none
1447 Returns:     OK, DEFER, FAIL
1448 */
1449
1450 static int
1451 host_name_lookup_byaddr(void)
1452 {
1453 int len;
1454 uschar *s, *t;
1455 struct hostent *hosts;
1456 struct in_addr addr;
1457
1458 /* Lookup on IPv6 system */
1459
1460 #if HAVE_IPV6
1461 if (Ustrchr(sender_host_address, ':') != NULL)
1462   {
1463   struct in6_addr addr6;
1464   if (inet_pton(AF_INET6, CS sender_host_address, &addr6) != 1)
1465     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "unable to parse \"%s\" as an "
1466       "IPv6 address", sender_host_address);
1467   #if HAVE_GETIPNODEBYADDR
1468   hosts = getipnodebyaddr(CS &addr6, sizeof(addr6), AF_INET6, &h_errno);
1469   #else
1470   hosts = gethostbyaddr(CS &addr6, sizeof(addr6), AF_INET6);
1471   #endif
1472   }
1473 else
1474   {
1475   if (inet_pton(AF_INET, CS sender_host_address, &addr) != 1)
1476     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "unable to parse \"%s\" as an "
1477       "IPv4 address", sender_host_address);
1478   #if HAVE_GETIPNODEBYADDR
1479   hosts = getipnodebyaddr(CS &addr, sizeof(addr), AF_INET, &h_errno);
1480   #else
1481   hosts = gethostbyaddr(CS &addr, sizeof(addr), AF_INET);
1482   #endif
1483   }
1484
1485 /* Do lookup on IPv4 system */
1486
1487 #else
1488 addr.s_addr = (S_ADDR_TYPE)inet_addr(CS sender_host_address);
1489 hosts = gethostbyaddr(CS(&addr), sizeof(addr), AF_INET);
1490 #endif
1491
1492 /* Failed to look up the host. */
1493
1494 if (hosts == NULL)
1495   {
1496   HDEBUG(D_host_lookup) debug_printf("IP address lookup failed: h_errno=%d\n",
1497     h_errno);
1498   return (h_errno == TRY_AGAIN || h_errno == NO_RECOVERY) ? DEFER : FAIL;
1499   }
1500
1501 /* It seems there are some records in the DNS that yield an empty name. We
1502 treat this as non-existent. In some operating systems, this is returned as an
1503 empty string; in others as a single dot. */
1504
1505 if (hosts->h_name[0] == 0 || hosts->h_name[0] == '.')
1506   {
1507   HDEBUG(D_host_lookup) debug_printf("IP address lookup yielded an empty name: "
1508     "treated as non-existent host name\n");
1509   return FAIL;
1510   }
1511
1512 /* Copy and lowercase the name, which is in static storage in many systems.
1513 Put it in permanent memory. */
1514
1515 s = (uschar *)hosts->h_name;
1516 len = Ustrlen(s) + 1;
1517 t = sender_host_name = store_get_perm(len);
1518 while (*s != 0) *t++ = tolower(*s++);
1519 *t = 0;
1520
1521 /* If the host has aliases, build a copy of the alias list */
1522
1523 if (hosts->h_aliases != NULL)
1524   {
1525   int count = 1;
1526   uschar **aliases, **ptr;
1527   for (aliases = USS hosts->h_aliases; *aliases != NULL; aliases++) count++;
1528   ptr = sender_host_aliases = store_get_perm(count * sizeof(uschar *));
1529   for (aliases = USS hosts->h_aliases; *aliases != NULL; aliases++)
1530     {
1531     uschar *s = *aliases;
1532     int len = Ustrlen(s) + 1;
1533     uschar *t = *ptr++ = store_get_perm(len);
1534     while (*s != 0) *t++ = tolower(*s++);
1535     *t = 0;
1536     }
1537   *ptr = NULL;
1538   }
1539
1540 return OK;
1541 }
1542
1543
1544
1545 /*************************************************
1546 *        Find host name for incoming call        *
1547 *************************************************/
1548
1549 /* Put the name in permanent store, pointed to by sender_host_name. We also set
1550 up a list of alias names, pointed to by sender_host_alias. The list is
1551 NULL-terminated. The incoming address is in sender_host_address, either in
1552 dotted-quad form for IPv4 or in colon-separated form for IPv6.
1553
1554 This function does a thorough check that the names it finds point back to the
1555 incoming IP address. Any that do not are discarded. Note that this is relied on
1556 by the ACL reverse_host_lookup check.
1557
1558 On some systems, get{host,ipnode}byaddr() appears to do this internally, but
1559 this it not universally true. Also, for release 4.30, this function was changed
1560 to do a direct DNS lookup first, by default[1], because it turns out that that
1561 is the only guaranteed way to find all the aliases on some systems. My
1562 experiments indicate that Solaris gethostbyaddr() gives the aliases for but
1563 Linux does not.
1564
1565 [1] The actual order is controlled by the host_lookup_order option.
1566
1567 Arguments:    none
1568 Returns:      OK on success, the answer being placed in the global variable
1569                 sender_host_name, with any aliases in a list hung off
1570                 sender_host_aliases
1571               FAIL if no host name can be found
1572               DEFER if a temporary error was encountered
1573
1574 The variable host_lookup_msg is set to an empty string on sucess, or to a
1575 reason for the failure otherwise, in a form suitable for tagging onto an error
1576 message, and also host_lookup_failed is set TRUE if the lookup failed. If there
1577 was a defer, host_lookup_deferred is set TRUE.
1578
1579 Any dynamically constructed string for host_lookup_msg must be in permanent
1580 store, because it might be used for several incoming messages on the same SMTP
1581 connection. */
1582
1583 int
1584 host_name_lookup(void)
1585 {
1586 int old_pool, rc;
1587 int sep = 0;
1588 uschar *hname, *save_hostname;
1589 uschar **aliases;
1590 uschar buffer[256];
1591 uschar *ordername;
1592 uschar *list = host_lookup_order;
1593 dns_record *rr;
1594 dns_answer dnsa;
1595 dns_scan dnss;
1596
1597 host_lookup_deferred = host_lookup_failed = FALSE;
1598
1599 HDEBUG(D_host_lookup)
1600   debug_printf("looking up host name for %s\n", sender_host_address);
1601
1602 /* For testing the case when a lookup does not complete, we have a special
1603 reserved IP address. */
1604
1605 if (running_in_test_harness &&
1606     Ustrcmp(sender_host_address, "99.99.99.99") == 0)
1607   {
1608   HDEBUG(D_host_lookup)
1609     debug_printf("Test harness: host name lookup returns DEFER\n");
1610   host_lookup_deferred = TRUE;
1611   return DEFER;
1612   }
1613
1614 /* Do lookups directly in the DNS or via gethostbyaddr() (or equivalent), in
1615 the order specified by the host_lookup_order option. */
1616
1617 while ((ordername = string_nextinlist(&list, &sep, buffer, sizeof(buffer)))
1618         != NULL)
1619   {
1620   if (strcmpic(ordername, US"bydns") == 0)
1621     {
1622     dns_init(FALSE, FALSE);
1623     dns_build_reverse(sender_host_address, buffer);
1624     rc = dns_lookup(&dnsa, buffer, T_PTR, NULL);
1625
1626     /* The first record we come across is used for the name; others are
1627     considered to be aliases. We have to scan twice, in order to find out the
1628     number of aliases. However, if all the names are empty, we will behave as
1629     if failure. (PTR records that yield empty names have been encountered in
1630     the DNS.) */
1631
1632     if (rc == DNS_SUCCEED)
1633       {
1634       uschar **aptr = NULL;
1635       int ssize = 264;
1636       int count = 0;
1637       int old_pool = store_pool;
1638
1639       store_pool = POOL_PERM;        /* Save names in permanent storage */
1640
1641       for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
1642            rr != NULL;
1643            rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
1644         {
1645         if (rr->type == T_PTR) count++;
1646         }
1647
1648       /* Get store for the list of aliases. For compatibility with
1649       gethostbyaddr, we make an empty list if there are none. */
1650
1651       aptr = sender_host_aliases = store_get(count * sizeof(uschar *));
1652
1653       /* Re-scan and extract the names */
1654
1655       for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
1656            rr != NULL;
1657            rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
1658         {
1659         uschar *s = NULL;
1660         if (rr->type != T_PTR) continue;
1661         s = store_get(ssize);
1662
1663         /* If an overlong response was received, the data will have been
1664         truncated and dn_expand may fail. */
1665
1666         if (dn_expand(dnsa.answer, dnsa.answer + dnsa.answerlen,
1667              (uschar *)(rr->data), (DN_EXPAND_ARG4_TYPE)(s), ssize) < 0)
1668           {
1669           log_write(0, LOG_MAIN, "host name alias list truncated for %s",
1670             sender_host_address);
1671           break;
1672           }
1673
1674         store_reset(s + Ustrlen(s) + 1);
1675         if (s[0] == 0)
1676           {
1677           HDEBUG(D_host_lookup) debug_printf("IP address lookup yielded an "
1678             "empty name: treated as non-existent host name\n");
1679           continue;
1680           }
1681         if (sender_host_name == NULL) sender_host_name = s;
1682           else *aptr++ = s;
1683         while (*s != 0) { *s = tolower(*s); s++; }
1684         }
1685
1686       *aptr = NULL;            /* End of alias list */
1687       store_pool = old_pool;   /* Reset store pool */
1688
1689       /* If we've found a names, break out of the "order" loop */
1690
1691       if (sender_host_name != NULL) break;
1692       }
1693
1694     /* If the DNS lookup deferred, we must also defer. */
1695
1696     if (rc == DNS_AGAIN)
1697       {
1698       HDEBUG(D_host_lookup)
1699         debug_printf("IP address PTR lookup gave temporary error\n");
1700       host_lookup_deferred = TRUE;
1701       return DEFER;
1702       }
1703     }
1704
1705   /* Do a lookup using gethostbyaddr() - or equivalent */
1706
1707   else if (strcmpic(ordername, US"byaddr") == 0)
1708     {
1709     HDEBUG(D_host_lookup)
1710       debug_printf("IP address lookup using gethostbyaddr()\n");
1711     rc = host_name_lookup_byaddr();
1712     if (rc == DEFER)
1713       {
1714       host_lookup_deferred = TRUE;
1715       return rc;                       /* Can't carry on */
1716       }
1717     if (rc == OK) break;               /* Found a name */
1718     }
1719   }      /* Loop for bydns/byaddr scanning */
1720
1721 /* If we have failed to find a name, return FAIL and log when required.
1722 NB host_lookup_msg must be in permanent store.  */
1723
1724 if (sender_host_name == NULL)
1725   {
1726   if (host_checking || !log_testing_mode)
1727     log_write(L_host_lookup_failed, LOG_MAIN, "no host name found for IP "
1728       "address %s", sender_host_address);
1729   host_lookup_msg = US" (failed to find host name from IP address)";
1730   host_lookup_failed = TRUE;
1731   return FAIL;
1732   }
1733
1734 HDEBUG(D_host_lookup)
1735   {
1736   uschar **aliases = sender_host_aliases;
1737   debug_printf("IP address lookup yielded %s\n", sender_host_name);
1738   while (*aliases != NULL) debug_printf("  alias %s\n", *aliases++);
1739   }
1740
1741 /* We need to verify that a forward lookup on the name we found does indeed
1742 correspond to the address. This is for security: in principle a malefactor who
1743 happened to own a reverse zone could set it to point to any names at all.
1744
1745 This code was present in versions of Exim before 3.20. At that point I took it
1746 out because I thought that gethostbyaddr() did the check anyway. It turns out
1747 that this isn't always the case, so it's coming back in at 4.01. This version
1748 is actually better, because it also checks aliases.
1749
1750 The code was made more robust at release 4.21. Prior to that, it accepted all
1751 the names if any of them had the correct IP address. Now the code checks all
1752 the names, and accepts only those that have the correct IP address. */
1753
1754 save_hostname = sender_host_name;   /* Save for error messages */
1755 aliases = sender_host_aliases;
1756 for (hname = sender_host_name; hname != NULL; hname = *aliases++)
1757   {
1758   int rc;
1759   BOOL ok = FALSE;
1760   host_item h;
1761   h.next = NULL;
1762   h.name = hname;
1763   h.mx = MX_NONE;
1764   h.address = NULL;
1765
1766   /* When called with the 5th argument FALSE, host_find_byname() won't return
1767   HOST_FOUND_LOCAL. If the incoming address is an IPv4 address expressed in
1768   IPv6 format, we must compare the IPv4 part to any IPv4 addresses. */
1769
1770   if ((rc = host_find_byname(&h, NULL, NULL, FALSE)) == HOST_FOUND)
1771     {
1772     host_item *hh;
1773     HDEBUG(D_host_lookup) debug_printf("checking addresses for %s\n", hname);
1774     for (hh = &h; hh != NULL; hh = hh->next)
1775       {
1776       if (host_is_in_net(hh->address, sender_host_address, 0))
1777         {
1778         HDEBUG(D_host_lookup) debug_printf("  %s OK\n", hh->address);
1779         ok = TRUE;
1780         break;
1781         }
1782       else
1783         {
1784         HDEBUG(D_host_lookup) debug_printf("  %s\n", hh->address);
1785         }
1786       }
1787     if (!ok) HDEBUG(D_host_lookup)
1788       debug_printf("no IP address for %s matched %s\n", hname,
1789         sender_host_address);
1790     }
1791   else if (rc == HOST_FIND_AGAIN)
1792     {
1793     HDEBUG(D_host_lookup) debug_printf("temporary error for host name lookup\n");
1794     host_lookup_deferred = TRUE;
1795     return DEFER;
1796     }
1797   else
1798     {
1799     HDEBUG(D_host_lookup) debug_printf("no IP addresses found for %s\n", hname);
1800     }
1801
1802   /* If this name is no good, and it's the sender name, set it null pro tem;
1803   if it's an alias, just remove it from the list. */
1804
1805   if (!ok)
1806     {
1807     if (hname == sender_host_name) sender_host_name = NULL; else
1808       {
1809       uschar **a;                              /* Don't amalgamate - some */
1810       a = --aliases;                           /* compilers grumble */
1811       while (*a != NULL) { *a = a[1]; a++; }
1812       }
1813     }
1814   }
1815
1816 /* If sender_host_name == NULL, it means we didn't like the name. Replace
1817 it with the first alias, if there is one. */
1818
1819 if (sender_host_name == NULL && *sender_host_aliases != NULL)
1820   sender_host_name = *sender_host_aliases++;
1821
1822 /* If we now have a main name, all is well. */
1823
1824 if (sender_host_name != NULL) return OK;
1825
1826 /* We have failed to find an address that matches. */
1827
1828 HDEBUG(D_host_lookup)
1829   debug_printf("%s does not match any IP address for %s\n",
1830     sender_host_address, save_hostname);
1831
1832 /* This message must be in permanent store */
1833
1834 old_pool = store_pool;
1835 store_pool = POOL_PERM;
1836 host_lookup_msg = string_sprintf(" (%s does not match any IP address for %s)",
1837   sender_host_address, save_hostname);
1838 store_pool = old_pool;
1839 host_lookup_failed = TRUE;
1840 return FAIL;
1841 }
1842
1843
1844
1845
1846 /*************************************************
1847 *    Find IP address(es) for host by name        *
1848 *************************************************/
1849
1850 /* The input is a host_item structure with the name filled in and the address
1851 field set to NULL. We use gethostbyname(). Of course, gethostbyname() may use
1852 the DNS, but it doesn't do MX processing. If more than one address is given,
1853 chain on additional host items, with other relevant fields copied.
1854
1855 The second argument provides a host list (usually an IP list) of hosts to
1856 ignore. This makes it possible to ignore IPv6 link-local addresses or loopback
1857 addresses in unreasonable places.
1858
1859 The lookup may result in a change of name. For compatibility with the dns
1860 lookup, return this via fully_qualified_name as well as updating the host item.
1861 The lookup may also yield more than one IP address, in which case chain on
1862 subsequent host_item structures.
1863
1864 Arguments:
1865   host                   a host item with the name and MX filled in;
1866                            the address is to be filled in;
1867                            multiple IP addresses cause other host items to be
1868                              chained on.
1869   ignore_target_hosts    a list of hosts to ignore
1870   fully_qualified_name   if not NULL, set to point to host name for
1871                          compatibility with host_find_bydns
1872   local_host_check       TRUE if a check for the local host is wanted
1873
1874 Returns:                 HOST_FIND_FAILED  Failed to find the host or domain
1875                          HOST_FIND_AGAIN   Try again later
1876                          HOST_FOUND        Host found - data filled in
1877                          HOST_FOUND_LOCAL  Host found and is the local host
1878 */
1879
1880 int
1881 host_find_byname(host_item *host, uschar *ignore_target_hosts,
1882   uschar **fully_qualified_name, BOOL local_host_check)
1883 {
1884 int i, yield, times;
1885 uschar **addrlist;
1886 host_item *last = NULL;
1887 BOOL temp_error = FALSE;
1888 #if HAVE_IPV6
1889 int af;
1890 #endif
1891
1892 /* If we are in the test harness, a name ending in .test.again.dns always
1893 forces a temporary error response, unless the name is in
1894 dns_again_means_nonexist. */
1895
1896 if (running_in_test_harness)
1897   {
1898   uschar *endname = host->name + Ustrlen(host->name);
1899   if (Ustrcmp(endname - 14, "test.again.dns") == 0) goto RETURN_AGAIN;
1900   }
1901
1902 /* In an IPv6 world, unless IPv6 has been disabled, we need to scan for both
1903 kinds of address, so go round the loop twice. Note that we have ensured that
1904 AF_INET6 is defined even in an IPv4 world, which makes for slightly tidier
1905 code. However, if dns_ipv4_lookup matches the domain, we also just do IPv4
1906 lookups here (except when testing standalone). */
1907
1908 #if HAVE_IPV6
1909   #ifndef STAND_ALONE
1910   if (disable_ipv6 || (dns_ipv4_lookup != NULL &&
1911         match_isinlist(host->name, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
1912           TRUE, NULL) == OK))
1913     { af = AF_INET; times = 1; }
1914   else
1915   #endif  /* STAND_ALONE */
1916
1917     { af = AF_INET6; times = 2; }
1918
1919 /* No IPv6 support */
1920
1921 #else   /* HAVE_IPV6 */
1922   times = 1;
1923 #endif  /* HAVE_IPV6 */
1924
1925 /* Initialize the flag that gets set for DNS syntax check errors, so that the
1926 interface to this function can be similar to host_find_bydns. */
1927
1928 host_find_failed_syntax = FALSE;
1929
1930 /* Loop to look up both kinds of address in an IPv6 world */
1931
1932 for (i = 1; i <= times;
1933      #if HAVE_IPV6
1934        af = AF_INET,     /* If 2 passes, IPv4 on the second */
1935      #endif
1936      i++)
1937   {
1938   BOOL ipv4_addr;
1939   int error_num;
1940   struct hostent *hostdata;
1941
1942   #if HAVE_IPV6
1943   if (running_in_test_harness)
1944     hostdata = host_fake_gethostbyname(host->name, af, &error_num);
1945   else
1946     {
1947     #if HAVE_GETIPNODEBYNAME
1948     hostdata = getipnodebyname(CS host->name, af, 0, &error_num);
1949     #else
1950     hostdata = gethostbyname2(CS host->name, af);
1951     error_num = h_errno;
1952     #endif
1953     }
1954
1955   #else    /* not HAVE_IPV6 */
1956   if (running_in_test_harness)
1957     hostdata = host_fake_gethostbyname(host->name, AF_INET, &error_num);
1958   else
1959     {
1960     hostdata = gethostbyname(CS host->name);
1961     error_num = h_errno;
1962     }
1963   #endif   /* HAVE_IPV6 */
1964
1965   if (hostdata == NULL)
1966     {
1967     uschar *error;
1968     switch (error_num)
1969       {
1970       case HOST_NOT_FOUND: error = US"HOST_NOT_FOUND"; break;
1971       case TRY_AGAIN: error = US"TRY_AGAIN"; break;
1972       case NO_RECOVERY: error = US"NO_RECOVERY"; break;
1973       case NO_DATA: error = US"NO_DATA"; break;
1974       #if NO_DATA != NO_ADDRESS
1975       case NO_ADDRESS: error = US"NO_ADDRESS"; break;
1976       #endif
1977       default: error = US"?"; break;
1978       }
1979
1980     DEBUG(D_host_lookup) debug_printf("%s returned %d (%s)\n",
1981       #if HAVE_IPV6
1982         #if HAVE_GETIPNODEBYNAME
1983         (af == AF_INET6)? "getipnodebyname(af=inet6)" : "getipnodebyname(af=inet)",
1984         #else
1985         (af == AF_INET6)? "gethostbyname2(af=inet6)" : "gethostbyname2(af=inet)",
1986         #endif
1987       #else
1988       "gethostbyname",
1989       #endif
1990       error_num, error);
1991
1992     if (error_num == TRY_AGAIN || error_num == NO_RECOVERY) temp_error = TRUE;
1993     continue;
1994     }
1995   if ((hostdata->h_addr_list)[0] == NULL) continue;
1996
1997   /* Replace the name with the fully qualified one if necessary, and fill in
1998   the fully_qualified_name pointer. */
1999
2000   if (hostdata->h_name[0] != 0 &&
2001       Ustrcmp(host->name, hostdata->h_name) != 0)
2002     host->name = string_copy_dnsdomain((uschar *)hostdata->h_name);
2003   if (fully_qualified_name != NULL) *fully_qualified_name = host->name;
2004
2005   /* Get the list of addresses. IPv4 and IPv6 addresses can be distinguished
2006   by their different lengths. Scan the list, ignoring any that are to be
2007   ignored, and build a chain from the rest. */
2008
2009   ipv4_addr = hostdata->h_length == sizeof(struct in_addr);
2010
2011   for (addrlist = USS hostdata->h_addr_list; *addrlist != NULL; addrlist++)
2012     {
2013     uschar *text_address =
2014       host_ntoa(ipv4_addr? AF_INET:AF_INET6, *addrlist, NULL, NULL);
2015
2016     #ifndef STAND_ALONE
2017     if (ignore_target_hosts != NULL &&
2018         verify_check_this_host(&ignore_target_hosts, NULL, host->name,
2019           text_address, NULL) == OK)
2020       {
2021       DEBUG(D_host_lookup)
2022         debug_printf("ignored host %s [%s]\n", host->name, text_address);
2023       continue;
2024       }
2025     #endif
2026
2027     /* If this is the first address, last == NULL and we put the data in the
2028     original block. */
2029
2030     if (last == NULL)
2031       {
2032       host->address = text_address;
2033       host->port = PORT_NONE;
2034       host->status = hstatus_unknown;
2035       host->why = hwhy_unknown;
2036       last = host;
2037       }
2038
2039     /* Else add further host item blocks for any other addresses, keeping
2040     the order. */
2041
2042     else
2043       {
2044       host_item *next = store_get(sizeof(host_item));
2045       next->name = host->name;
2046       next->mx = host->mx;
2047       next->address = text_address;
2048       next->port = PORT_NONE;
2049       next->status = hstatus_unknown;
2050       next->why = hwhy_unknown;
2051       next->last_try = 0;
2052       next->next = last->next;
2053       last->next = next;
2054       last = next;
2055       }
2056     }
2057   }
2058
2059 /* If no hosts were found, the address field in the original host block will be
2060 NULL. If temp_error is set, at least one of the lookups gave a temporary error,
2061 so we pass that back. */
2062
2063 if (host->address == NULL)
2064   {
2065   uschar *msg =
2066     #ifndef STAND_ALONE
2067     (message_id[0] == 0 && smtp_in != NULL)?
2068       string_sprintf("no IP address found for host %s (during %s)", host->name,
2069           smtp_get_connection_info()) :
2070     #endif
2071     string_sprintf("no IP address found for host %s", host->name);
2072
2073   HDEBUG(D_host_lookup) debug_printf("%s\n", msg);
2074   if (temp_error) goto RETURN_AGAIN;
2075   if (host_checking || !log_testing_mode)
2076     log_write(L_host_lookup_failed, LOG_MAIN, "%s", msg);
2077   return HOST_FIND_FAILED;
2078   }
2079
2080 /* Remove any duplicate IP addresses, then check to see if this is the local
2081 host if required. */
2082
2083 host_remove_duplicates(host, &last);
2084 yield = local_host_check?
2085   host_scan_for_local_hosts(host, &last, NULL) : HOST_FOUND;
2086
2087 HDEBUG(D_host_lookup)
2088   {
2089   host_item *h;
2090   if (fully_qualified_name != NULL)
2091     debug_printf("fully qualified name = %s\n", *fully_qualified_name);
2092   debug_printf("%s looked up these IP addresses:\n",
2093     #if HAVE_IPV6
2094       #if HAVE_GETIPNODEBYNAME
2095       "getipnodebyname"
2096       #else
2097       "gethostbyname2"
2098       #endif
2099     #else
2100     "gethostbyname"
2101     #endif
2102     );
2103   for (h = host; h != last->next; h = h->next)
2104     debug_printf("  name=%s address=%s\n", h->name,
2105       (h->address == NULL)? US"<null>" : h->address);
2106   }
2107
2108 /* Return the found status. */
2109
2110 return yield;
2111
2112 /* Handle the case when there is a temporary error. If the name matches
2113 dns_again_means_nonexist, return permanent rather than temporary failure. */
2114
2115 RETURN_AGAIN:
2116   {
2117   #ifndef STAND_ALONE
2118   int rc;
2119   uschar *save = deliver_domain;
2120   deliver_domain = host->name;  /* set $domain */
2121   rc = match_isinlist(host->name, &dns_again_means_nonexist, 0, NULL, NULL,
2122     MCL_DOMAIN, TRUE, NULL);
2123   deliver_domain = save;
2124   if (rc == OK)
2125     {
2126     DEBUG(D_host_lookup) debug_printf("%s is in dns_again_means_nonexist: "
2127       "returning HOST_FIND_FAILED\n", host->name);
2128     return HOST_FIND_FAILED;
2129     }
2130   #endif
2131   return HOST_FIND_AGAIN;
2132   }
2133 }
2134
2135
2136
2137 /*************************************************
2138 *        Fill in a host address from the DNS     *
2139 *************************************************/
2140
2141 /* Given a host item, with its name, port and mx fields set, and its address
2142 field set to NULL, fill in its IP address from the DNS. If it is multi-homed,
2143 create additional host items for the additional addresses, copying all the
2144 other fields, and randomizing the order.
2145
2146 On IPv6 systems, A6 records are sought first (but only if support for A6 is
2147 configured - they may never become mainstream), then AAAA records are sought,
2148 and finally A records are sought as well.
2149
2150 The host name may be changed if the DNS returns a different name - e.g. fully
2151 qualified or changed via CNAME. If fully_qualified_name is not NULL, dns_lookup
2152 ensures that it points to the fully qualified name. However, this is the fully
2153 qualified version of the original name; if a CNAME is involved, the actual
2154 canonical host name may be different again, and so we get it directly from the
2155 relevant RR. Note that we do NOT change the mx field of the host item in this
2156 function as it may be called to set the addresses of hosts taken from MX
2157 records.
2158
2159 Arguments:
2160   host                  points to the host item we're filling in
2161   lastptr               points to pointer to last host item in a chain of
2162                           host items (may be updated if host is last and gets
2163                           extended because multihomed)
2164   ignore_target_hosts   list of hosts to ignore
2165   allow_ip              if TRUE, recognize an IP address and return it
2166   fully_qualified_name  if not NULL, return fully qualified name here if
2167                           the contents are different (i.e. it must be preset
2168                           to something)
2169
2170 Returns:       HOST_FIND_FAILED     couldn't find A record
2171                HOST_FIND_AGAIN      try again later
2172                HOST_FOUND           found AAAA and/or A record(s)
2173                HOST_IGNORED         found, but all IPs ignored
2174 */
2175
2176 static int
2177 set_address_from_dns(host_item *host, host_item **lastptr,
2178   uschar *ignore_target_hosts, BOOL allow_ip, uschar **fully_qualified_name)
2179 {
2180 dns_record *rr;
2181 host_item *thishostlast = NULL;    /* Indicates not yet filled in anything */
2182 BOOL v6_find_again = FALSE;
2183 int i;
2184
2185 /* If allow_ip is set, a name which is an IP address returns that value
2186 as its address. This is used for MX records when allow_mx_to_ip is set, for
2187 those sites that feel they have to flaunt the RFC rules. */
2188
2189 if (allow_ip && string_is_ip_address(host->name, NULL) != 0)
2190   {
2191   #ifndef STAND_ALONE
2192   if (ignore_target_hosts != NULL &&
2193         verify_check_this_host(&ignore_target_hosts, NULL, host->name,
2194         host->name, NULL) == OK)
2195     return HOST_IGNORED;
2196   #endif
2197
2198   host->address = host->name;
2199   return HOST_FOUND;
2200   }
2201
2202 /* On an IPv6 system, unless IPv6 is disabled, go round the loop up to three
2203 times, looking for A6 and AAAA records the first two times. However, unless
2204 doing standalone testing, we force an IPv4 lookup if the domain matches
2205 dns_ipv4_lookup is set. Since A6 records look like being abandoned, support
2206 them only if explicitly configured to do so. On an IPv4 system, go round the
2207 loop once only, looking only for A records. */
2208
2209 #if HAVE_IPV6
2210   #ifndef STAND_ALONE
2211     if (disable_ipv6 || (dns_ipv4_lookup != NULL &&
2212         match_isinlist(host->name, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2213         TRUE, NULL) == OK))
2214       i = 0;    /* look up A records only */
2215     else
2216   #endif        /* STAND_ALONE */
2217
2218   #ifdef SUPPORT_A6
2219   i = 2;        /* look up A6 and AAAA and A records */
2220   #else
2221   i = 1;        /* look up AAAA and A records */
2222   #endif        /* SUPPORT_A6 */
2223
2224 /* The IPv4 world */
2225
2226 #else           /* HAVE_IPV6 */
2227   i = 0;        /* look up A records only */
2228 #endif          /* HAVE_IPV6 */
2229
2230 for (; i >= 0; i--)
2231   {
2232   static int types[] = { T_A, T_AAAA, T_A6 };
2233   int type = types[i];
2234   int randoffset = (i == 0)? 500 : 0;  /* Ensures v6 sorts before v4 */
2235   dns_answer dnsa;
2236   dns_scan dnss;
2237
2238   int rc = dns_lookup(&dnsa, host->name, type, fully_qualified_name);
2239
2240   /* We want to return HOST_FIND_AGAIN if one of the A, A6, or AAAA lookups
2241   fails or times out, but not if another one succeeds. (In the early
2242   IPv6 days there are name servers that always fail on AAAA, but are happy
2243   to give out an A record. We want to proceed with that A record.) */
2244
2245   if (rc != DNS_SUCCEED)
2246     {
2247     if (i == 0)  /* Just tried for an A record, i.e. end of loop */
2248       {
2249       if (host->address != NULL) return HOST_FOUND;  /* A6 or AAAA was found */
2250       if (rc == DNS_AGAIN || rc == DNS_FAIL || v6_find_again)
2251         return HOST_FIND_AGAIN;
2252       return HOST_FIND_FAILED;    /* DNS_NOMATCH or DNS_NODATA */
2253       }
2254
2255     /* Tried for an A6 or AAAA record: remember if this was a temporary
2256     error, and look for the next record type. */
2257
2258     if (rc != DNS_NOMATCH && rc != DNS_NODATA) v6_find_again = TRUE;
2259     continue;
2260     }
2261
2262   /* Lookup succeeded: fill in the given host item with the first non-ignored
2263   address found; create additional items for any others. A single A6 record
2264   may generate more than one address. */
2265
2266   for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2267        rr != NULL;
2268        rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2269     {
2270     if (rr->type == type)
2271       {
2272       /* dns_address *da = dns_address_from_rr(&dnsa, rr); */
2273
2274       dns_address *da;
2275       da = dns_address_from_rr(&dnsa, rr);
2276
2277       DEBUG(D_host_lookup)
2278         {
2279         if (da == NULL)
2280           debug_printf("no addresses extracted from A6 RR for %s\n",
2281             host->name);
2282         }
2283
2284       /* This loop runs only once for A and AAAA records, but may run
2285       several times for an A6 record that generated multiple addresses. */
2286
2287       for (; da != NULL; da = da->next)
2288         {
2289         #ifndef STAND_ALONE
2290         if (ignore_target_hosts != NULL &&
2291               verify_check_this_host(&ignore_target_hosts, NULL,
2292                 host->name, da->address, NULL) == OK)
2293           {
2294           DEBUG(D_host_lookup)
2295             debug_printf("ignored host %s [%s]\n", host->name, da->address);
2296           continue;
2297           }
2298         #endif
2299
2300         /* If this is the first address, stick it in the given host block,
2301         and change the name if the returned RR has a different name. */
2302
2303         if (thishostlast == NULL)
2304           {
2305           if (strcmpic(host->name, rr->name) != 0)
2306             host->name = string_copy_dnsdomain(rr->name);
2307           host->address = da->address;
2308           host->sort_key = host->mx * 1000 + random_number(500) + randoffset;
2309           host->status = hstatus_unknown;
2310           host->why = hwhy_unknown;
2311           thishostlast = host;
2312           }
2313
2314         /* Not the first address. Check for, and ignore, duplicates. Then
2315         insert in the chain at a random point. */
2316
2317         else
2318           {
2319           int new_sort_key;
2320           host_item *next;
2321
2322           /* End of our local chain is specified by "thishostlast". */
2323
2324           for (next = host;; next = next->next)
2325             {
2326             if (Ustrcmp(CS da->address, next->address) == 0) break;
2327             if (next == thishostlast) { next = NULL; break; }
2328             }
2329           if (next != NULL) continue;  /* With loop for next address */
2330
2331           /* Not a duplicate */
2332
2333           new_sort_key = host->mx * 1000 + random_number(500) + randoffset;
2334           next = store_get(sizeof(host_item));
2335
2336           /* New address goes first: insert the new block after the first one
2337           (so as not to disturb the original pointer) but put the new address
2338           in the original block. */
2339
2340           if (new_sort_key < host->sort_key)
2341             {
2342             *next = *host;                                  /* Copies port */
2343             host->next = next;
2344             host->address = da->address;
2345             host->sort_key = new_sort_key;
2346             if (thishostlast == host) thishostlast = next;  /* Local last */
2347             if (*lastptr == host) *lastptr = next;          /* Global last */
2348             }
2349
2350           /* Otherwise scan down the addresses for this host to find the
2351           one to insert after. */
2352
2353           else
2354             {
2355             host_item *h = host;
2356             while (h != thishostlast)
2357               {
2358               if (new_sort_key < h->next->sort_key) break;
2359               h = h->next;
2360               }
2361             *next = *h;                                 /* Copies port */
2362             h->next = next;
2363             next->address = da->address;
2364             next->sort_key = new_sort_key;
2365             if (h == thishostlast) thishostlast = next; /* Local last */
2366             if (h == *lastptr) *lastptr = next;         /* Global last */
2367             }
2368           }
2369         }
2370       }
2371     }
2372   }
2373
2374 /* Control gets here only if the third lookup (the A record) succeeded.
2375 However, the address may not be filled in if it was ignored. */
2376
2377 return (host->address == NULL)? HOST_IGNORED : HOST_FOUND;
2378 }
2379
2380
2381
2382
2383 /*************************************************
2384 *    Find IP addresses and host names via DNS    *
2385 *************************************************/
2386
2387 /* The input is a host_item structure with the name field filled in and the
2388 address field set to NULL. This may be in a chain of other host items. The
2389 lookup may result in more than one IP address, in which case we must created
2390 new host blocks for the additional addresses, and insert them into the chain.
2391 The original name may not be fully qualified. Use the fully_qualified_name
2392 argument to return the official name, as returned by the resolver.
2393
2394 Arguments:
2395   host                  point to initial host item
2396   ignore_target_hosts   a list of hosts to ignore
2397   whichrrs              flags indicating which RRs to look for:
2398                           HOST_FIND_BY_SRV  => look for SRV
2399                           HOST_FIND_BY_MX   => look for MX
2400                           HOST_FIND_BY_A    => look for A or AAAA
2401                         also flags indicating how the lookup is done
2402                           HOST_FIND_QUALIFY_SINGLE   ) passed to the
2403                           HOST_FIND_SEARCH_PARENTS   )   resolver
2404   srv_service           when SRV used, the service name
2405   srv_fail_domains      DNS errors for these domains => assume nonexist
2406   mx_fail_domains       DNS errors for these domains => assume nonexist
2407   fully_qualified_name  if not NULL, return fully-qualified name
2408   removed               set TRUE if local host was removed from the list
2409
2410 Returns:                HOST_FIND_FAILED  Failed to find the host or domain;
2411                                           if there was a syntax error,
2412                                           host_find_failed_syntax is set.
2413                         HOST_FIND_AGAIN   Could not resolve at this time
2414                         HOST_FOUND        Host found
2415                         HOST_FOUND_LOCAL  The lowest MX record points to this
2416                                           machine, if MX records were found, or
2417                                           an A record that was found contains
2418                                           an address of the local host
2419 */
2420
2421 int
2422 host_find_bydns(host_item *host, uschar *ignore_target_hosts, int whichrrs,
2423   uschar *srv_service, uschar *srv_fail_domains, uschar *mx_fail_domains,
2424   uschar **fully_qualified_name, BOOL *removed)
2425 {
2426 host_item *h, *last;
2427 dns_record *rr;
2428 int rc = DNS_FAIL;
2429 int ind_type = 0;
2430 int yield;
2431 dns_answer dnsa;
2432 dns_scan dnss;
2433
2434 /* Set the default fully qualified name to the incoming name, initialize the
2435 resolver if necessary, set up the relevant options, and initialize the flag
2436 that gets set for DNS syntax check errors. */
2437
2438 if (fully_qualified_name != NULL) *fully_qualified_name = host->name;
2439 dns_init((whichrrs & HOST_FIND_QUALIFY_SINGLE) != 0,
2440          (whichrrs & HOST_FIND_SEARCH_PARENTS) != 0);
2441 host_find_failed_syntax = FALSE;
2442
2443 /* First, if requested, look for SRV records. The service name is given; we
2444 assume TCP progocol. DNS domain names are constrained to a maximum of 256
2445 characters, so the code below should be safe. */
2446
2447 if ((whichrrs & HOST_FIND_BY_SRV) != 0)
2448   {
2449   uschar buffer[300];
2450   uschar *temp_fully_qualified_name = buffer;
2451   int prefix_length;
2452
2453   (void)sprintf(CS buffer, "_%s._tcp.%n%.256s", srv_service, &prefix_length,
2454     host->name);
2455   ind_type = T_SRV;
2456
2457   /* Search for SRV records. If the fully qualified name is different to
2458   the input name, pass back the new original domain, without the prepended
2459   magic. */
2460
2461   rc = dns_lookup(&dnsa, buffer, ind_type, &temp_fully_qualified_name);
2462   if (temp_fully_qualified_name != buffer && fully_qualified_name != NULL)
2463     *fully_qualified_name = temp_fully_qualified_name + prefix_length;
2464
2465   /* On DNS failures, we give the "try again" error unless the domain is
2466   listed as one for which we continue. */
2467
2468   if (rc == DNS_FAIL || rc == DNS_AGAIN)
2469     {
2470     #ifndef STAND_ALONE
2471     if (match_isinlist(host->name, &srv_fail_domains, 0, NULL, NULL, MCL_DOMAIN,
2472         TRUE, NULL) != OK)
2473     #endif
2474       return HOST_FIND_AGAIN;
2475     DEBUG(D_host_lookup) debug_printf("DNS_%s treated as DNS_NODATA "
2476       "(domain in srv_fail_domains)\n", (rc == DNS_FAIL)? "FAIL":"AGAIN");
2477     }
2478   }
2479
2480 /* If we did not find any SRV records, search the DNS for MX records, if
2481 requested to do so. If the result is DNS_NOMATCH, it means there is no such
2482 domain, and there's no point in going on to look for address records with the
2483 same domain. The result will be DNS_NODATA if the domain exists but has no MX
2484 records. On DNS failures, we give the "try again" error unless the domain is
2485 listed as one for which we continue. */
2486
2487 if (rc != DNS_SUCCEED && (whichrrs & HOST_FIND_BY_MX) != 0)
2488   {
2489   ind_type = T_MX;
2490   rc = dns_lookup(&dnsa, host->name, ind_type, fully_qualified_name);
2491   if (rc == DNS_NOMATCH) return HOST_FIND_FAILED;
2492   if (rc == DNS_FAIL || rc == DNS_AGAIN)
2493     {
2494     #ifndef STAND_ALONE
2495     if (match_isinlist(host->name, &mx_fail_domains, 0, NULL, NULL, MCL_DOMAIN,
2496         TRUE, NULL) != OK)
2497     #endif
2498       return HOST_FIND_AGAIN;
2499     DEBUG(D_host_lookup) debug_printf("DNS_%s treated as DNS_NODATA "
2500       "(domain in mx_fail_domains)\n", (rc == DNS_FAIL)? "FAIL":"AGAIN");
2501     }
2502   }
2503
2504 /* If we haven't found anything yet, and we are requested to do so, try for an
2505 A or AAAA record. If we find it (or them) check to see that it isn't the local
2506 host. */
2507
2508 if (rc != DNS_SUCCEED)
2509   {
2510   if ((whichrrs & HOST_FIND_BY_A) == 0)
2511     {
2512     DEBUG(D_host_lookup) debug_printf("Address records are not being sought\n");
2513     return HOST_FIND_FAILED;
2514     }
2515
2516   last = host;        /* End of local chainlet */
2517   host->mx = MX_NONE;
2518   host->port = PORT_NONE;
2519   rc = set_address_from_dns(host, &last, ignore_target_hosts, FALSE,
2520     fully_qualified_name);
2521
2522   /* If one or more address records have been found, check that none of them
2523   are local. Since we know the host items all have their IP addresses
2524   inserted, host_scan_for_local_hosts() can only return HOST_FOUND or
2525   HOST_FOUND_LOCAL. We do not need to scan for duplicate IP addresses here,
2526   because set_address_from_dns() removes them. */
2527
2528   if (rc == HOST_FOUND)
2529     rc = host_scan_for_local_hosts(host, &last, removed);
2530   else
2531     if (rc == HOST_IGNORED) rc = HOST_FIND_FAILED;  /* No special action */
2532
2533   DEBUG(D_host_lookup)
2534     {
2535     host_item *h;
2536     if (host->address != NULL)
2537       {
2538       if (fully_qualified_name != NULL)
2539         debug_printf("fully qualified name = %s\n", *fully_qualified_name);
2540       for (h = host; h != last->next; h = h->next)
2541         debug_printf("%s %s mx=%d sort=%d %s\n", h->name,
2542           (h->address == NULL)? US"<null>" : h->address, h->mx, h->sort_key,
2543           (h->status >= hstatus_unusable)? US"*" : US"");
2544       }
2545     }
2546
2547   return rc;
2548   }
2549
2550 /* We have found one or more MX or SRV records. Sort them according to
2551 precedence. Put the data for the first one into the existing host block, and
2552 insert new host_item blocks into the chain for the remainder. For equal
2553 precedences one is supposed to randomize the order. To make this happen, the
2554 sorting is actually done on the MX value * 1000 + a random number. This is put
2555 into a host field called sort_key.
2556
2557 In the case of hosts with both IPv6 and IPv4 addresses, we want to choose the
2558 IPv6 address in preference. At this stage, we don't know what kind of address
2559 the host has. We choose a random number < 500; if later we find an A record
2560 first, we add 500 to the random number. Then for any other address records, we
2561 use random numbers in the range 0-499 for AAAA records and 500-999 for A
2562 records.
2563
2564 At this point we remove any duplicates that point to the same host, retaining
2565 only the one with the lowest precedence. We cannot yet check for precedence
2566 greater than that of the local host, because that test cannot be properly done
2567 until the addresses have been found - an MX record may point to a name for this
2568 host which is not the primary hostname. */
2569
2570 last = NULL;    /* Indicates that not even the first item is filled yet */
2571
2572 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2573      rr != NULL;
2574      rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2575   {
2576   int precedence;
2577   int weight = 0;        /* For SRV records */
2578   int port = PORT_NONE;
2579   uschar *s;             /* MUST be unsigned for GETSHORT */
2580   uschar data[256];
2581
2582   if (rr->type != ind_type) continue;
2583   s = rr->data;
2584   GETSHORT(precedence, s);      /* Pointer s is advanced */
2585
2586   /* For MX records, we use a random "weight" which causes multiple records of
2587   the same precedence to sort randomly. */
2588
2589   if (ind_type == T_MX)
2590     {
2591     weight = random_number(500);
2592     }
2593
2594   /* SRV records are specified with a port and a weight. The weight is used
2595   in a special algorithm. However, to start with, we just use it to order the
2596   records of equal priority (precedence). */
2597
2598   else
2599     {
2600     GETSHORT(weight, s);
2601     GETSHORT(port, s);
2602     }
2603
2604   /* Get the name of the host pointed to. */
2605
2606   (void)dn_expand(dnsa.answer, dnsa.answer + dnsa.answerlen, s,
2607     (DN_EXPAND_ARG4_TYPE)data, sizeof(data));
2608
2609   /* Check that we haven't already got this host on the chain; if we have,
2610   keep only the lower precedence. This situation shouldn't occur, but you
2611   never know what junk might get into the DNS (and this case has been seen on
2612   more than one occasion). */
2613
2614   if (last != NULL)       /* This is not the first record */
2615     {
2616     host_item *prev = NULL;
2617
2618     for (h = host; h != last->next; prev = h, h = h->next)
2619       {
2620       if (strcmpic(h->name, data) == 0)
2621         {
2622         DEBUG(D_host_lookup)
2623           debug_printf("discarded duplicate host %s (MX=%d)\n", data,
2624             (precedence > h->mx)? precedence : h->mx);
2625         if (precedence >= h->mx) goto NEXT_MX_RR; /* Skip greater precedence */
2626         if (h == host)                            /* Override first item */
2627           {
2628           h->mx = precedence;
2629           host->sort_key = precedence * 1000 + weight;
2630           goto NEXT_MX_RR;
2631           }
2632
2633         /* Unwanted host item is not the first in the chain, so we can get
2634         get rid of it by cutting it out. */
2635
2636         prev->next = h->next;
2637         if (h == last) last = prev;
2638         break;
2639         }
2640       }
2641     }
2642
2643   /* If this is the first MX or SRV record, put the data into the existing host
2644   block. Otherwise, add a new block in the correct place; if it has to be
2645   before the first block, copy the first block's data to a new second block. */
2646
2647   if (last == NULL)
2648     {
2649     host->name = string_copy_dnsdomain(data);
2650     host->address = NULL;
2651     host->port = port;
2652     host->mx = precedence;
2653     host->sort_key = precedence * 1000 + weight;
2654     host->status = hstatus_unknown;
2655     host->why = hwhy_unknown;
2656     last = host;
2657     }
2658
2659   /* Make a new host item and seek the correct insertion place */
2660
2661   else
2662     {
2663     int sort_key = precedence * 1000 + weight;
2664     host_item *next = store_get(sizeof(host_item));
2665     next->name = string_copy_dnsdomain(data);
2666     next->address = NULL;
2667     next->port = port;
2668     next->mx = precedence;
2669     next->sort_key = sort_key;
2670     next->status = hstatus_unknown;
2671     next->why = hwhy_unknown;
2672     next->last_try = 0;
2673
2674     /* Handle the case when we have to insert before the first item. */
2675
2676     if (sort_key < host->sort_key)
2677       {
2678       host_item htemp;
2679       htemp = *host;
2680       *host = *next;
2681       *next = htemp;
2682       host->next = next;
2683       if (last == host) last = next;
2684       }
2685
2686     /* Else scan down the items we have inserted as part of this exercise;
2687     don't go further. */
2688
2689     else
2690       {
2691       for (h = host; h != last; h = h->next)
2692         {
2693         if (sort_key < h->next->sort_key)
2694           {
2695           next->next = h->next;
2696           h->next = next;
2697           break;
2698           }
2699         }
2700
2701       /* Join on after the last host item that's part of this
2702       processing if we haven't stopped sooner. */
2703
2704       if (h == last)
2705         {
2706         next->next = last->next;
2707         last->next = next;
2708         last = next;
2709         }
2710       }
2711     }
2712
2713   NEXT_MX_RR: continue;
2714   }
2715
2716 /* If the list of hosts was obtained from SRV records, there are two things to
2717 do. First, if there is only one host, and it's name is ".", it means there is
2718 no SMTP service at this domain. Otherwise, we have to sort the hosts of equal
2719 priority according to their weights, using an algorithm that is defined in RFC
2720 2782. The hosts are currently sorted by priority and weight. For each priority
2721 group we have to pick off one host and put it first, and then repeat for any
2722 remaining in the same priority group. */
2723
2724 if (ind_type == T_SRV)
2725   {
2726   host_item **pptr;
2727
2728   if (host == last && host->name[0] == 0)
2729     {
2730     DEBUG(D_host_lookup) debug_printf("the single SRV record is \".\"\n");
2731     return HOST_FIND_FAILED;
2732     }
2733
2734   DEBUG(D_host_lookup)
2735     {
2736     debug_printf("original ordering of hosts from SRV records:\n");
2737     for (h = host; h != last->next; h = h->next)
2738       debug_printf("  %s P=%d W=%d\n", h->name, h->mx, h->sort_key % 1000);
2739     }
2740
2741   for (pptr = &host, h = host; h != last; pptr = &(h->next), h = h->next)
2742     {
2743     int sum = 0;
2744     host_item *hh;
2745
2746     /* Find the last following host that has the same precedence. At the same
2747     time, compute the sum of the weights and the running totals. These can be
2748     stored in the sort_key field. */
2749
2750     for (hh = h; hh != last; hh = hh->next)
2751       {
2752       int weight = hh->sort_key % 1000;   /* was precedence * 1000 + weight */
2753       sum += weight;
2754       hh->sort_key = sum;
2755       if (hh->mx != hh->next->mx) break;
2756       }
2757
2758     /* If there's more than one host at this precedence (priority), we need to
2759     pick one to go first. */
2760
2761     if (hh != h)
2762       {
2763       host_item *hhh;
2764       host_item **ppptr;
2765       int randomizer = random_number(sum + 1);
2766
2767       for (ppptr = pptr, hhh = h;
2768            hhh != hh;
2769            ppptr = &(hhh->next), hhh = hhh->next)
2770         {
2771         if (hhh->sort_key >= randomizer) break;
2772         }
2773
2774       /* hhh now points to the host that should go first; ppptr points to the
2775       place that points to it. Unfortunately, if the start of the minilist is
2776       the start of the entire list, we can't just swap the items over, because
2777       we must not change the value of host, since it is passed in from outside.
2778       One day, this could perhaps be changed.
2779
2780       The special case is fudged by putting the new item *second* in the chain,
2781       and then transferring the data between the first and second items. We
2782       can't just swap the first and the chosen item, because that would mean
2783       that an item with zero weight might no longer be first. */
2784
2785       if (hhh != h)
2786         {
2787         *ppptr = hhh->next;          /* Cuts it out of the chain */
2788
2789         if (h == host)
2790           {
2791           host_item temp = *h;
2792           *h = *hhh;
2793           *hhh = temp;
2794           hhh->next = temp.next;
2795           h->next = hhh;
2796           }
2797
2798         else
2799           {
2800           hhh->next = h;               /* The rest of the chain follows it */
2801           *pptr = hhh;                 /* It takes the place of h */
2802           h = hhh;                     /* It's now the start of this minilist */
2803           }
2804         }
2805       }
2806
2807     /* A host has been chosen to be first at this priority and h now points
2808     to this host. There may be others at the same priority, or others at a
2809     different priority. Before we leave this host, we need to put back a sort
2810     key of the traditional MX kind, in case this host is multihomed, because
2811     the sort key is used for ordering the multiple IP addresses. We do not need
2812     to ensure that these new sort keys actually reflect the order of the hosts,
2813     however. */
2814
2815     h->sort_key = h->mx * 1000 + random_number(500);
2816     }   /* Move on to the next host */
2817   }
2818
2819 /* Now we have to find IP addresses for all the hosts. We have ensured above
2820 that the names in all the host items are unique. Before release 4.61 we used to
2821 process records from the additional section in the DNS packet that returned the
2822 MX or SRV records. However, a DNS name server is free to drop any resource
2823 records from the additional section. In theory, this has always been a
2824 potential problem, but it is exacerbated by the advent of IPv6. If a host had
2825 several IPv4 addresses and some were not in the additional section, at least
2826 Exim would try the others. However, if a host had both IPv4 and IPv6 addresses
2827 and all the IPv4 (say) addresses were absent, Exim would try only for a IPv6
2828 connection, and never try an IPv4 address. When there was only IPv4
2829 connectivity, this was a disaster that did in practice occur.
2830
2831 So, from release 4.61 onwards, we always search for A and AAAA records
2832 explicitly. The names shouldn't point to CNAMES, but we use the general lookup
2833 function that handles them, just in case. If any lookup gives a soft error,
2834 change the default yield.
2835
2836 For these DNS lookups, we must disable qualify_single and search_parents;
2837 otherwise invalid host names obtained from MX or SRV records can cause trouble
2838 if they happen to match something local. */
2839
2840 yield = HOST_FIND_FAILED;    /* Default yield */
2841 dns_init(FALSE, FALSE);      /* Disable qualify_single and search_parents */
2842
2843 for (h = host; h != last->next; h = h->next)
2844   {
2845   if (h->address != NULL) continue;  /* Inserted by a multihomed host */
2846   rc = set_address_from_dns(h, &last, ignore_target_hosts, allow_mx_to_ip, NULL);
2847   if (rc != HOST_FOUND)
2848     {
2849     h->status = hstatus_unusable;
2850     if (rc == HOST_FIND_AGAIN)
2851       {
2852       yield = rc;
2853       h->why = hwhy_deferred;
2854       }
2855     else
2856       h->why = (rc == HOST_IGNORED)? hwhy_ignored : hwhy_failed;
2857     }
2858   }
2859
2860 /* Scan the list for any hosts that are marked unusable because they have
2861 been explicitly ignored, and remove them from the list, as if they did not
2862 exist. If we end up with just a single, ignored host, flatten its fields as if
2863 nothing was found. */
2864
2865 if (ignore_target_hosts != NULL)
2866   {
2867   host_item *prev = NULL;
2868   for (h = host; h != last->next; h = h->next)
2869     {
2870     REDO:
2871     if (h->why != hwhy_ignored)        /* Non ignored host, just continue */
2872       prev = h;
2873     else if (prev == NULL)             /* First host is ignored */
2874       {
2875       if (h != last)                   /* First is not last */
2876         {
2877         if (h->next == last) last = h; /* Overwrite it with next */
2878         *h = *(h->next);               /* and reprocess it. */
2879         goto REDO;                     /* C should have redo, like Perl */
2880         }
2881       }
2882     else                               /* Ignored host is not first - */
2883       {                                /*   cut it out */
2884       prev->next = h->next;
2885       if (h == last) last = prev;
2886       }
2887     }
2888
2889   if (host->why == hwhy_ignored) host->address = NULL;
2890   }
2891
2892 /* There is still one complication in the case of IPv6. Although the code above
2893 arranges that IPv6 addresses take precedence over IPv4 addresses for multihomed
2894 hosts, it doesn't do this for addresses that apply to different hosts with the
2895 same MX precedence, because the sorting on MX precedence happens first. So we
2896 have to make another pass to check for this case. We ensure that, within a
2897 single MX preference value, IPv6 addresses come first. This can separate the
2898 addresses of a multihomed host, but that should not matter. */
2899
2900 #if HAVE_IPV6
2901 if (h != last && !disable_ipv6)
2902   {
2903   for (h = host; h != last; h = h->next)
2904     {
2905     host_item temp;
2906     host_item *next = h->next;
2907     if (h->mx != next->mx ||                   /* If next is different MX */
2908         h->address == NULL ||                  /* OR this one is unset */
2909         Ustrchr(h->address, ':') != NULL ||    /* OR this one is IPv6 */
2910         (next->address != NULL &&
2911          Ustrchr(next->address, ':') == NULL)) /* OR next is IPv4 */
2912       continue;                                /* move on to next */
2913     temp = *h;                                 /* otherwise, swap */
2914     temp.next = next->next;
2915     *h = *next;
2916     h->next = next;
2917     *next = temp;
2918     }
2919   }
2920 #endif
2921
2922 /* Remove any duplicate IP addresses and then scan the list of hosts for any
2923 whose IP addresses are on the local host. If any are found, all hosts with the
2924 same or higher MX values are removed. However, if the local host has the lowest
2925 numbered MX, then HOST_FOUND_LOCAL is returned. Otherwise, if at least one host
2926 with an IP address is on the list, HOST_FOUND is returned. Otherwise,
2927 HOST_FIND_FAILED is returned, but in this case do not update the yield, as it
2928 might have been set to HOST_FIND_AGAIN just above here. If not, it will already
2929 be HOST_FIND_FAILED. */
2930
2931 host_remove_duplicates(host, &last);
2932 rc = host_scan_for_local_hosts(host, &last, removed);
2933 if (rc != HOST_FIND_FAILED) yield = rc;
2934
2935 DEBUG(D_host_lookup)
2936   {
2937   if (fully_qualified_name != NULL)
2938     debug_printf("fully qualified name = %s\n", *fully_qualified_name);
2939   debug_printf("host_find_bydns yield = %s (%d); returned hosts:\n",
2940     (yield == HOST_FOUND)? "HOST_FOUND" :
2941     (yield == HOST_FOUND_LOCAL)? "HOST_FOUND_LOCAL" :
2942     (yield == HOST_FIND_AGAIN)? "HOST_FIND_AGAIN" :
2943     (yield == HOST_FIND_FAILED)? "HOST_FIND_FAILED" : "?",
2944     yield);
2945   for (h = host; h != last->next; h = h->next)
2946     {
2947     debug_printf("  %s %s MX=%d ", h->name,
2948       (h->address == NULL)? US"<null>" : h->address, h->mx);
2949     if (h->port != PORT_NONE) debug_printf("port=%d ", h->port);
2950     if (h->status >= hstatus_unusable) debug_printf("*");
2951     debug_printf("\n");
2952     }
2953   }
2954
2955 return yield;
2956 }
2957
2958
2959
2960
2961 /*************************************************
2962 **************************************************
2963 *             Stand-alone test program           *
2964 **************************************************
2965 *************************************************/
2966
2967 #ifdef STAND_ALONE
2968
2969 int main(int argc, char **cargv)
2970 {
2971 host_item h;
2972 int whichrrs = HOST_FIND_BY_MX | HOST_FIND_BY_A;
2973 BOOL byname = FALSE;
2974 BOOL qualify_single = TRUE;
2975 BOOL search_parents = FALSE;
2976 uschar **argv = USS cargv;
2977 uschar buffer[256];
2978
2979 primary_hostname = US"";
2980 store_pool = POOL_MAIN;
2981 debug_selector = D_host_lookup|D_interface;
2982 debug_file = stdout;
2983 debug_fd = fileno(debug_file);
2984
2985 printf("Exim stand-alone host functions test\n");
2986
2987 host_find_interfaces();
2988 debug_selector = D_host_lookup | D_dns;
2989
2990 if (argc > 1) primary_hostname = argv[1];
2991
2992 /* So that debug level changes can be done first */
2993
2994 dns_init(qualify_single, search_parents);
2995
2996 printf("Testing host lookup\n");
2997 printf("> ");
2998 while (Ufgets(buffer, 256, stdin) != NULL)
2999   {
3000   int rc;
3001   int len = Ustrlen(buffer);
3002   uschar *fully_qualified_name;
3003
3004   while (len > 0 && isspace(buffer[len-1])) len--;
3005   buffer[len] = 0;
3006
3007   if (Ustrcmp(buffer, "q") == 0) break;
3008
3009   if (Ustrcmp(buffer, "byname") == 0) byname = TRUE;
3010   else if (Ustrcmp(buffer, "no_byname") == 0) byname = FALSE;
3011   else if (Ustrcmp(buffer, "a_only") == 0) whichrrs = HOST_FIND_BY_A;
3012   else if (Ustrcmp(buffer, "mx_only") == 0) whichrrs = HOST_FIND_BY_MX;
3013   else if (Ustrcmp(buffer, "srv_only") == 0) whichrrs = HOST_FIND_BY_SRV;
3014   else if (Ustrcmp(buffer, "srv+a") == 0)
3015     whichrrs = HOST_FIND_BY_SRV | HOST_FIND_BY_A;
3016   else if (Ustrcmp(buffer, "srv+mx") == 0)
3017     whichrrs = HOST_FIND_BY_SRV | HOST_FIND_BY_MX;
3018   else if (Ustrcmp(buffer, "srv+mx+a") == 0)
3019     whichrrs = HOST_FIND_BY_SRV | HOST_FIND_BY_MX | HOST_FIND_BY_A;
3020   else if (Ustrcmp(buffer, "qualify_single") == 0) qualify_single = TRUE;
3021   else if (Ustrcmp(buffer, "no_qualify_single") == 0) qualify_single = FALSE;
3022   else if (Ustrcmp(buffer, "search_parents") == 0) search_parents = TRUE;
3023   else if (Ustrcmp(buffer, "no_search_parents") == 0) search_parents = FALSE;
3024   else if (Ustrcmp(buffer, "test_harness") == 0)
3025     running_in_test_harness = !running_in_test_harness;
3026   else if (Ustrcmp(buffer, "res_debug") == 0)
3027     {
3028     _res.options ^= RES_DEBUG;
3029     }
3030   else if (Ustrncmp(buffer, "retrans", 7) == 0)
3031     {
3032     (void)sscanf(CS(buffer+8), "%d", &dns_retrans);
3033     _res.retrans = dns_retrans;
3034     }
3035   else if (Ustrncmp(buffer, "retry", 5) == 0)
3036     {
3037     (void)sscanf(CS(buffer+6), "%d", &dns_retry);
3038     _res.retry = dns_retry;
3039     }
3040   else
3041     {
3042     int flags = whichrrs;
3043
3044     h.name = buffer;
3045     h.next = NULL;
3046     h.mx = MX_NONE;
3047     h.port = PORT_NONE;
3048     h.status = hstatus_unknown;
3049     h.why = hwhy_unknown;
3050     h.address = NULL;
3051
3052     if (qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
3053     if (search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
3054
3055     rc = byname?
3056       host_find_byname(&h, NULL, &fully_qualified_name, TRUE)
3057       :
3058       host_find_bydns(&h, NULL, flags, US"smtp", NULL, NULL,
3059         &fully_qualified_name, NULL);
3060
3061     if (rc == HOST_FIND_FAILED) printf("Failed\n");
3062       else if (rc == HOST_FIND_AGAIN) printf("Again\n");
3063         else if (rc == HOST_FOUND_LOCAL) printf("Local\n");
3064     }
3065
3066   printf("\n> ");
3067   }
3068
3069 printf("Testing host_aton\n");
3070 printf("> ");
3071 while (Ufgets(buffer, 256, stdin) != NULL)
3072   {
3073   int i;
3074   int x[4];
3075   int len = Ustrlen(buffer);
3076
3077   while (len > 0 && isspace(buffer[len-1])) len--;
3078   buffer[len] = 0;
3079
3080   if (Ustrcmp(buffer, "q") == 0) break;
3081
3082   len = host_aton(buffer, x);
3083   printf("length = %d ", len);
3084   for (i = 0; i < len; i++)
3085     {
3086     printf("%04x ", (x[i] >> 16) & 0xffff);
3087     printf("%04x ", x[i] & 0xffff);
3088     }
3089   printf("\n> ");
3090   }
3091
3092 printf("\n");
3093
3094 printf("Testing host_name_lookup\n");
3095 printf("> ");
3096 while (Ufgets(buffer, 256, stdin) != NULL)
3097   {
3098   int len = Ustrlen(buffer);
3099   while (len > 0 && isspace(buffer[len-1])) len--;
3100   buffer[len] = 0;
3101   if (Ustrcmp(buffer, "q") == 0) break;
3102   sender_host_address = buffer;
3103   sender_host_name = NULL;
3104   sender_host_aliases = NULL;
3105   host_lookup_msg = US"";
3106   host_lookup_failed = FALSE;
3107   if (host_name_lookup() == FAIL)  /* Debug causes printing */
3108     printf("Lookup failed:%s\n", host_lookup_msg);
3109   printf("\n> ");
3110   }
3111
3112 printf("\n");
3113
3114 return 0;
3115 }
3116 #endif  /* STAND_ALONE */
3117
3118 /* End of host.c */