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