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