(1) Patch for radius problem. (2) Include config.h inside local_scan.h.
[exim.git] / src / src / verify.c
1 /* $Cambridge: exim/src/src/verify.c,v 1.25 2005/08/22 10:49:04 ph10 Exp $ */
2
3 /*************************************************
4 *     Exim - an Internet mail transport agent    *
5 *************************************************/
6
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
8 /* See the file NOTICE for conditions of use and distribution. */
9
10 /* Functions concerned with verifying things. The original code for callout
11 caching was contributed by Kevin Fleming (but I hacked it around a bit). */
12
13
14 #include "exim.h"
15
16
17 /* Structure for caching DNSBL lookups */
18
19 typedef struct dnsbl_cache_block {
20   dns_address *rhs;
21   uschar *text;
22   int rc;
23   BOOL text_set;
24 } dnsbl_cache_block;
25
26
27 /* Anchor for DNSBL cache */
28
29 static tree_node *dnsbl_cache = NULL;
30
31
32
33 /*************************************************
34 *          Retrieve a callout cache record       *
35 *************************************************/
36
37 /* If a record exists, check whether it has expired.
38
39 Arguments:
40   dbm_file          an open hints file
41   key               the record key
42   type              "address" or "domain"
43   positive_expire   expire time for positive records
44   negative_expire   expire time for negative records
45
46 Returns:            the cache record if a non-expired one exists, else NULL
47 */
48
49 static dbdata_callout_cache *
50 get_callout_cache_record(open_db *dbm_file, uschar *key, uschar *type,
51   int positive_expire, int negative_expire)
52 {
53 BOOL negative;
54 int length, expire;
55 time_t now;
56 dbdata_callout_cache *cache_record;
57
58 cache_record = dbfn_read_with_length(dbm_file, key, &length);
59
60 if (cache_record == NULL)
61   {
62   HDEBUG(D_verify) debug_printf("callout cache: no %s record found\n", type);
63   return NULL;
64   }
65
66 /* We treat a record as "negative" if its result field is not positive, or if
67 it is a domain record and the postmaster field is negative. */
68
69 negative = cache_record->result != ccache_accept ||
70   (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
71 expire = negative? negative_expire : positive_expire;
72 now = time(NULL);
73
74 if (now - cache_record->time_stamp > expire)
75   {
76   HDEBUG(D_verify) debug_printf("callout cache: %s record expired\n", type);
77   return NULL;
78   }
79
80 /* If this is a non-reject domain record, check for the obsolete format version
81 that doesn't have the postmaster and random timestamps, by looking at the
82 length. If so, copy it to a new-style block, replicating the record's
83 timestamp. Then check the additional timestamps. (There's no point wasting
84 effort if connections are rejected.) */
85
86 if (type[0] == 'd' && cache_record->result != ccache_reject)
87   {
88   if (length == sizeof(dbdata_callout_cache_obs))
89     {
90     dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache));
91     memcpy(new, cache_record, length);
92     new->postmaster_stamp = new->random_stamp = new->time_stamp;
93     cache_record = new;
94     }
95
96   if (now - cache_record->postmaster_stamp > expire)
97     cache_record->postmaster_result = ccache_unknown;
98
99   if (now - cache_record->random_stamp > expire)
100     cache_record->random_result = ccache_unknown;
101   }
102
103 HDEBUG(D_verify) debug_printf("callout cache: found %s record\n", type);
104 return cache_record;
105 }
106
107
108
109 /*************************************************
110 *      Do callout verification for an address    *
111 *************************************************/
112
113 /* This function is called from verify_address() when the address has routed to
114 a host list, and a callout has been requested. Callouts are expensive; that is
115 why a cache is used to improve the efficiency.
116
117 Arguments:
118   addr              the address that's been routed
119   host_list         the list of hosts to try
120   tf                the transport feedback block
121
122   ifstring          "interface" option from transport, or NULL
123   portstring        "port" option from transport, or NULL
124   protocolstring    "protocol" option from transport, or NULL
125   callout           the per-command callout timeout
126   callout_overall   the overall callout timeout (if < 0 use 4*callout)
127   callout_connect   the callout connection timeout (if < 0 use callout)
128   options           the verification options - these bits are used:
129                       vopt_is_recipient => this is a recipient address
130                       vopt_callout_no_cache => don't use callout cache
131                       vopt_callout_fullpm => if postmaster check, do full one
132                       vopt_callout_random => do the "random" thing
133                       vopt_callout_recipsender => use real sender for recipient
134                       vopt_callout_recippmaster => use postmaster for recipient
135   se_mailfrom         MAIL FROM address for sender verify; NULL => ""
136   pm_mailfrom         if non-NULL, do the postmaster check with this sender
137
138 Returns:            OK/FAIL/DEFER
139 */
140
141 static int
142 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
143   int callout, int callout_overall, int callout_connect, int options,
144   uschar *se_mailfrom, uschar *pm_mailfrom)
145 {
146 BOOL is_recipient = (options & vopt_is_recipient) != 0;
147 BOOL callout_no_cache = (options & vopt_callout_no_cache) != 0;
148 BOOL callout_random = (options & vopt_callout_random) != 0;
149
150 int yield = OK;
151 BOOL done = FALSE;
152 uschar *address_key;
153 uschar *from_address;
154 uschar *random_local_part = NULL;
155 uschar *save_deliver_domain = deliver_domain;
156 uschar **failure_ptr = is_recipient?
157   &recipient_verify_failure : &sender_verify_failure;
158 open_db dbblock;
159 open_db *dbm_file = NULL;
160 dbdata_callout_cache new_domain_record;
161 dbdata_callout_cache_address new_address_record;
162 host_item *host;
163 time_t callout_start_time;
164
165 new_domain_record.result = ccache_unknown;
166 new_domain_record.postmaster_result = ccache_unknown;
167 new_domain_record.random_result = ccache_unknown;
168
169 memset(&new_address_record, 0, sizeof(new_address_record));
170
171 /* For a recipient callout, the key used for the address cache record must
172 include the sender address if we are using the real sender in the callout,
173 because that may influence the result of the callout. */
174
175 address_key = addr->address;
176 from_address = US"";
177
178 if (is_recipient)
179   {
180   if ((options & vopt_callout_recipsender) != 0)
181     {
182     address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
183     from_address = sender_address;
184     }
185   else if ((options & vopt_callout_recippmaster) != 0)
186     {
187     address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
188       qualify_domain_sender);
189     from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
190     }
191   }
192
193 /* For a sender callout, we must adjust the key if the mailfrom address is not
194 empty. */
195
196 else
197   {
198   from_address = (se_mailfrom == NULL)? US"" : se_mailfrom;
199   if (from_address[0] != 0)
200     address_key = string_sprintf("%s/<%s>", addr->address, from_address);
201   }
202
203 /* Open the callout cache database, it it exists, for reading only at this
204 stage, unless caching has been disabled. */
205
206 if (callout_no_cache)
207   {
208   HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
209   }
210 else if ((dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)) == NULL)
211   {
212   HDEBUG(D_verify) debug_printf("callout cache: not available\n");
213   }
214
215 /* If a cache database is available see if we can avoid the need to do an
216 actual callout by making use of previously-obtained data. */
217
218 if (dbm_file != NULL)
219   {
220   dbdata_callout_cache_address *cache_address_record;
221   dbdata_callout_cache *cache_record = get_callout_cache_record(dbm_file,
222     addr->domain, US"domain",
223     callout_cache_domain_positive_expire,
224     callout_cache_domain_negative_expire);
225
226   /* If an unexpired cache record was found for this domain, see if the callout
227   process can be short-circuited. */
228
229   if (cache_record != NULL)
230     {
231     /* If an early command (up to and including MAIL FROM:<>) was rejected,
232     there is no point carrying on. The callout fails. */
233
234     if (cache_record->result == ccache_reject)
235       {
236       setflag(addr, af_verify_nsfail);
237       HDEBUG(D_verify)
238         debug_printf("callout cache: domain gave initial rejection, or "
239           "does not accept HELO or MAIL FROM:<>\n");
240       setflag(addr, af_verify_nsfail);
241       addr->user_message = US"(result of an earlier callout reused).";
242       yield = FAIL;
243       *failure_ptr = US"mail";
244       goto END_CALLOUT;
245       }
246
247     /* If a previous check on a "random" local part was accepted, we assume
248     that the server does not do any checking on local parts. There is therefore
249     no point in doing the callout, because it will always be successful. If a
250     random check previously failed, arrange not to do it again, but preserve
251     the data in the new record. If a random check is required but hasn't been
252     done, skip the remaining cache processing. */
253
254     if (callout_random) switch(cache_record->random_result)
255       {
256       case ccache_accept:
257       HDEBUG(D_verify)
258         debug_printf("callout cache: domain accepts random addresses\n");
259       goto END_CALLOUT;     /* Default yield is OK */
260
261       case ccache_reject:
262       HDEBUG(D_verify)
263         debug_printf("callout cache: domain rejects random addresses\n");
264       callout_random = FALSE;
265       new_domain_record.random_result = ccache_reject;
266       new_domain_record.random_stamp = cache_record->random_stamp;
267       break;
268
269       default:
270       HDEBUG(D_verify)
271         debug_printf("callout cache: need to check random address handling "
272           "(not cached or cache expired)\n");
273       goto END_CACHE;
274       }
275
276     /* If a postmaster check is requested, but there was a previous failure,
277     there is again no point in carrying on. If a postmaster check is required,
278     but has not been done before, we are going to have to do a callout, so skip
279     remaining cache processing. */
280
281     if (pm_mailfrom != NULL)
282       {
283       if (cache_record->postmaster_result == ccache_reject)
284         {
285         setflag(addr, af_verify_pmfail);
286         HDEBUG(D_verify)
287           debug_printf("callout cache: domain does not accept "
288             "RCPT TO:<postmaster@domain>\n");
289         yield = FAIL;
290         *failure_ptr = US"postmaster";
291         setflag(addr, af_verify_pmfail);
292         addr->user_message = US"(result of earlier verification reused).";
293         goto END_CALLOUT;
294         }
295       if (cache_record->postmaster_result == ccache_unknown)
296         {
297         HDEBUG(D_verify)
298           debug_printf("callout cache: need to check RCPT "
299             "TO:<postmaster@domain> (not cached or cache expired)\n");
300         goto END_CACHE;
301         }
302
303       /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
304       postmaster check if the address itself has to be checked. Also ensure
305       that the value in the cache record is preserved (with its old timestamp).
306       */
307
308       HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
309         "TO:<postmaster@domain>\n");
310       pm_mailfrom = NULL;
311       new_domain_record.postmaster_result = ccache_accept;
312       new_domain_record.postmaster_stamp = cache_record->postmaster_stamp;
313       }
314     }
315
316   /* We can't give a result based on information about the domain. See if there
317   is an unexpired cache record for this specific address (combined with the
318   sender address if we are doing a recipient callout with a non-empty sender).
319   */
320
321   cache_address_record = (dbdata_callout_cache_address *)
322     get_callout_cache_record(dbm_file,
323       address_key, US"address",
324       callout_cache_positive_expire,
325       callout_cache_negative_expire);
326
327   if (cache_address_record != NULL)
328     {
329     if (cache_address_record->result == ccache_accept)
330       {
331       HDEBUG(D_verify)
332         debug_printf("callout cache: address record is positive\n");
333       }
334     else
335       {
336       HDEBUG(D_verify)
337         debug_printf("callout cache: address record is negative\n");
338       addr->user_message = US"Previous (cached) callout verification failure";
339       *failure_ptr = US"recipient";
340       yield = FAIL;
341       }
342     goto END_CALLOUT;
343     }
344
345   /* Close the cache database while we actually do the callout for real. */
346
347   END_CACHE:
348   dbfn_close(dbm_file);
349   dbm_file = NULL;
350   }
351
352 /* The information wasn't available in the cache, so we have to do a real
353 callout and save the result in the cache for next time, unless no_cache is set,
354 or unless we have a previously cached negative random result. If we are to test
355 with a random local part, ensure that such a local part is available. If not,
356 log the fact, but carry on without randomming. */
357
358 if (callout_random && callout_random_local_part != NULL)
359   {
360   random_local_part = expand_string(callout_random_local_part);
361   if (random_local_part == NULL)
362     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
363       "callout_random_local_part: %s", expand_string_message);
364   }
365
366 /* Default the connect and overall callout timeouts if not set, and record the
367 time we are starting so that we can enforce it. */
368
369 if (callout_overall < 0) callout_overall = 4 * callout;
370 if (callout_connect < 0) callout_connect = callout;
371 callout_start_time = time(NULL);
372
373 /* Now make connections to the hosts and do real callouts. The list of hosts
374 is passed in as an argument. */
375
376 for (host = host_list; host != NULL && !done; host = host->next)
377   {
378   smtp_inblock inblock;
379   smtp_outblock outblock;
380   int host_af;
381   int port = 25;
382   BOOL send_quit = TRUE;
383   uschar *helo = US"HELO";
384   uschar *interface = NULL;  /* Outgoing interface to use; NULL => any */
385   uschar inbuffer[4096];
386   uschar outbuffer[1024];
387   uschar responsebuffer[4096];
388
389   clearflag(addr, af_verify_pmfail);  /* postmaster callout flag */
390   clearflag(addr, af_verify_nsfail);  /* null sender callout flag */
391
392   /* Skip this host if we don't have an IP address for it. */
393
394   if (host->address == NULL)
395     {
396     DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
397       host->name);
398     continue;
399     }
400
401   /* Check the overall callout timeout */
402
403   if (time(NULL) - callout_start_time >= callout_overall)
404     {
405     HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
406     break;
407     }
408
409   /* Set IPv4 or IPv6 */
410
411   host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
412
413   /* Expand and interpret the interface and port strings. This has to
414   be delayed till now, because they may expand differently for different
415   hosts. If there's a failure, log it, but carry on with the defaults. */
416
417   deliver_host = host->name;
418   deliver_host_address = host->address;
419   deliver_domain = addr->domain;
420   if (!smtp_get_interface(tf->interface, host_af, addr, NULL, &interface,
421           US"callout") ||
422       !smtp_get_port(tf->port, addr, &port, US"callout"))
423     log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
424       addr->message);
425   deliver_host = deliver_host_address = NULL;
426   deliver_domain = save_deliver_domain;
427
428   /* Set HELO string according to the protocol */
429
430   if (Ustrcmp(tf->protocol, "lmtp") == 0) helo = US"LHLO";
431
432   HDEBUG(D_verify) debug_printf("interface=%s port=%d\n", interface, port);
433
434   /* Set up the buffer for reading SMTP response packets. */
435
436   inblock.buffer = inbuffer;
437   inblock.buffersize = sizeof(inbuffer);
438   inblock.ptr = inbuffer;
439   inblock.ptrend = inbuffer;
440
441   /* Set up the buffer for holding SMTP commands while pipelining */
442
443   outblock.buffer = outbuffer;
444   outblock.buffersize = sizeof(outbuffer);
445   outblock.ptr = outbuffer;
446   outblock.cmd_count = 0;
447   outblock.authenticating = FALSE;
448
449   /* Connect to the host; on failure, just loop for the next one, but we
450   set the error for the last one. Use the callout_connect timeout. */
451
452   inblock.sock = outblock.sock =
453     smtp_connect(host, host_af, port, interface, callout_connect, TRUE);
454   if (inblock.sock < 0)
455     {
456     addr->message = string_sprintf("could not connect to %s [%s]: %s",
457         host->name, host->address, strerror(errno));
458     continue;
459     }
460
461   /* Wait for initial response, and then run the initial SMTP commands. The
462   smtp_write_command() function leaves its command in big_buffer. This is
463   used in error responses. Initialize it in case the connection is
464   rejected. */
465
466   Ustrcpy(big_buffer, "initial connection");
467
468   done =
469     smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
470       '2', callout) &&
471
472     smtp_write_command(&outblock, FALSE, "%s %s\r\n", helo,
473       smtp_active_hostname) >= 0 &&
474     smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
475       '2', callout) &&
476
477     smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
478       from_address) >= 0 &&
479     smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
480       '2', callout);
481
482   /* If the host gave an initial error, or does not accept HELO or MAIL
483   FROM:<>, arrange to cache this information, but don't record anything for an
484   I/O error or a defer. Do not cache rejections when a non-empty sender has
485   been used, because that blocks the whole domain for all senders. */
486
487   if (!done)
488     {
489     *failure_ptr = US"mail";
490     if (errno == 0 && responsebuffer[0] == '5')
491       {
492       setflag(addr, af_verify_nsfail);
493       if (from_address[0] == 0) new_domain_record.result = ccache_reject;
494       }
495     }
496
497   /* Otherwise, proceed to check a "random" address (if required), then the
498   given address, and the postmaster address (if required). Between each check,
499   issue RSET, because some servers accept only one recipient after MAIL
500   FROM:<>. */
501
502   else
503     {
504     new_domain_record.result = ccache_accept;
505
506     /* Do the random local part check first */
507
508     if (random_local_part != NULL)
509       {
510       uschar randombuffer[1024];
511       BOOL random_ok =
512         smtp_write_command(&outblock, FALSE,
513           "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
514           addr->domain) >= 0 &&
515         smtp_read_response(&inblock, randombuffer,
516           sizeof(randombuffer), '2', callout);
517
518       /* Remember when we last did a random test */
519
520       new_domain_record.random_stamp = time(NULL);
521
522       /* If accepted, we aren't going to do any further tests below. */
523
524       if (random_ok)
525         {
526         new_domain_record.random_result = ccache_accept;
527         }
528
529       /* Otherwise, cache a real negative response, and get back to the right
530       state to send RCPT. Unless there's some problem such as a dropped
531       connection, we expect to succeed, because the commands succeeded above. */
532
533       else if (errno == 0)
534         {
535         if (randombuffer[0] == '5')
536           new_domain_record.random_result = ccache_reject;
537
538         done =
539           smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
540           smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
541             '2', callout) &&
542
543           smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
544             from_address) >= 0 &&
545           smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
546             '2', callout);
547         }
548       else done = FALSE;    /* Some timeout/connection problem */
549       }                     /* Random check */
550
551     /* If the host is accepting all local parts, as determined by the "random"
552     check, we don't need to waste time doing any further checking. */
553
554     if (new_domain_record.random_result != ccache_accept && done)
555       {
556       /* Get the rcpt_include_affixes flag from the transport if there is one,
557       but assume FALSE if there is not. */
558
559       done =
560         smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
561           transport_rcpt_address(addr,
562             (addr->transport == NULL)? FALSE :
563              addr->transport->rcpt_include_affixes)) >= 0 &&
564         smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
565           '2', callout);
566
567       if (done)
568         new_address_record.result = ccache_accept;
569       else if (errno == 0 && responsebuffer[0] == '5')
570         {
571         *failure_ptr = US"recipient";
572         new_address_record.result = ccache_reject;
573         }
574
575       /* Do postmaster check if requested; if a full check is required, we
576       check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
577
578       if (done && pm_mailfrom != NULL)
579         {
580         done =
581           smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
582           smtp_read_response(&inblock, responsebuffer,
583             sizeof(responsebuffer), '2', callout) &&
584
585           smtp_write_command(&outblock, FALSE,
586             "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
587           smtp_read_response(&inblock, responsebuffer,
588             sizeof(responsebuffer), '2', callout) &&
589
590           /* First try using the current domain */
591
592           ((
593           smtp_write_command(&outblock, FALSE,
594             "RCPT TO:<postmaster@%.1000s>\r\n", addr->domain) >= 0 &&
595           smtp_read_response(&inblock, responsebuffer,
596             sizeof(responsebuffer), '2', callout)
597           )
598
599           ||
600
601           /* If that doesn't work, and a full check is requested,
602           try without the domain. */
603
604           (
605           (options & vopt_callout_fullpm) != 0 &&
606           smtp_write_command(&outblock, FALSE,
607             "RCPT TO:<postmaster>\r\n") >= 0 &&
608           smtp_read_response(&inblock, responsebuffer,
609             sizeof(responsebuffer), '2', callout)
610           ));
611
612         /* Sort out the cache record */
613
614         new_domain_record.postmaster_stamp = time(NULL);
615
616         if (done)
617           new_domain_record.postmaster_result = ccache_accept;
618         else if (errno == 0 && responsebuffer[0] == '5')
619           {
620           *failure_ptr = US"postmaster";
621           setflag(addr, af_verify_pmfail);
622           new_domain_record.postmaster_result = ccache_reject;
623           }
624         }
625       }           /* Random not accepted */
626     }             /* MAIL FROM: accepted */
627
628   /* For any failure of the main check, other than a negative response, we just
629   close the connection and carry on. We can identify a negative response by the
630   fact that errno is zero. For I/O errors it will be non-zero
631
632   Set up different error texts for logging and for sending back to the caller
633   as an SMTP response. Log in all cases, using a one-line format. For sender
634   callouts, give a full response to the caller, but for recipient callouts,
635   don't give the IP address because this may be an internal host whose identity
636   is not to be widely broadcast. */
637
638   if (!done)
639     {
640     if (errno == ETIMEDOUT)
641       {
642       HDEBUG(D_verify) debug_printf("SMTP timeout\n");
643       send_quit = FALSE;
644       }
645     else if (errno == 0)
646       {
647       if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
648
649       addr->message =
650         string_sprintf("response to \"%s\" from %s [%s] was: %s",
651           big_buffer, host->name, host->address,
652           string_printing(responsebuffer));
653
654       addr->user_message = is_recipient?
655         string_sprintf("Callout verification failed:\n%s", responsebuffer)
656         :
657         string_sprintf("Called:   %s\nSent:     %s\nResponse: %s",
658           host->address, big_buffer, responsebuffer);
659
660       /* Hard rejection ends the process */
661
662       if (responsebuffer[0] == '5')   /* Address rejected */
663         {
664         yield = FAIL;
665         done = TRUE;
666         }
667       }
668     }
669
670   /* End the SMTP conversation and close the connection. */
671
672   if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
673   (void)close(inblock.sock);
674   }    /* Loop through all hosts, while !done */
675
676 /* If we get here with done == TRUE, a successful callout happened, and yield
677 will be set OK or FAIL according to the response to the RCPT command.
678 Otherwise, we looped through the hosts but couldn't complete the business.
679 However, there may be domain-specific information to cache in both cases.
680
681 The value of the result field in the new_domain record is ccache_unknown if
682 there was an error before or with MAIL FROM:, and errno was not zero,
683 implying some kind of I/O error. We don't want to write the cache in that case.
684 Otherwise the value is ccache_accept or ccache_reject. */
685
686 if (!callout_no_cache && new_domain_record.result != ccache_unknown)
687   {
688   if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
689        == NULL)
690     {
691     HDEBUG(D_verify) debug_printf("callout cache: not available\n");
692     }
693   else
694     {
695     (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
696       (int)sizeof(dbdata_callout_cache));
697     HDEBUG(D_verify) debug_printf("wrote callout cache domain record:\n"
698       "  result=%d postmaster=%d random=%d\n",
699       new_domain_record.result,
700       new_domain_record.postmaster_result,
701       new_domain_record.random_result);
702     }
703   }
704
705 /* If a definite result was obtained for the callout, cache it unless caching
706 is disabled. */
707
708 if (done)
709   {
710   if (!callout_no_cache && new_address_record.result != ccache_unknown)
711     {
712     if (dbm_file == NULL)
713       dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
714     if (dbm_file == NULL)
715       {
716       HDEBUG(D_verify) debug_printf("no callout cache available\n");
717       }
718     else
719       {
720       (void)dbfn_write(dbm_file, address_key, &new_address_record,
721         (int)sizeof(dbdata_callout_cache_address));
722       HDEBUG(D_verify) debug_printf("wrote %s callout cache address record\n",
723         (new_address_record.result == ccache_accept)? "positive" : "negative");
724       }
725     }
726   }    /* done */
727
728 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
729 temporary error. If there was only one host, and a response was received, leave
730 it alone if supplying details. Otherwise, give a generic response. */
731
732 else   /* !done */
733   {
734   uschar *dullmsg = string_sprintf("Could not complete %s verify callout",
735     is_recipient? "recipient" : "sender");
736   yield = DEFER;
737
738   if (host_list->next != NULL || addr->message == NULL) addr->message = dullmsg;
739
740   addr->user_message = (!smtp_return_error_details)? dullmsg :
741     string_sprintf("%s for <%s>.\n"
742       "The mail server(s) for the domain may be temporarily unreachable, or\n"
743       "they may be permanently unreachable from this server. In the latter case,\n%s",
744       dullmsg, addr->address,
745       is_recipient?
746         "the address will never be accepted."
747         :
748         "you need to change the address or create an MX record for its domain\n"
749         "if it is supposed to be generally accessible from the Internet.\n"
750         "Talk to your mail administrator for details.");
751
752   /* Force a specific error code */
753
754   addr->basic_errno = ERRNO_CALLOUTDEFER;
755   }
756
757 /* Come here from within the cache-reading code on fast-track exit. */
758
759 END_CALLOUT:
760 if (dbm_file != NULL) dbfn_close(dbm_file);
761 return yield;
762 }
763
764
765
766 /*************************************************
767 *           Copy error to toplevel address       *
768 *************************************************/
769
770 /* This function is used when a verify fails or defers, to ensure that the
771 failure or defer information is in the original toplevel address. This applies
772 when an address is redirected to a single new address, and the failure or
773 deferral happens to the child address.
774
775 Arguments:
776   vaddr       the verify address item
777   addr        the final address item
778   yield       FAIL or DEFER
779
780 Returns:      the value of YIELD
781 */
782
783 static int
784 copy_error(address_item *vaddr, address_item *addr, int yield)
785 {
786 if (addr != vaddr)
787   {
788   vaddr->message = addr->message;
789   vaddr->user_message = addr->user_message;
790   vaddr->basic_errno = addr->basic_errno;
791   vaddr->more_errno = addr->more_errno;
792   }
793 return yield;
794 }
795
796
797
798
799 /*************************************************
800 *            Verify an email address             *
801 *************************************************/
802
803 /* This function is used both for verification (-bv and at other times) and
804 address testing (-bt), which is indicated by address_test_mode being set.
805
806 Arguments:
807   vaddr            contains the address to verify; the next field in this block
808                      must be NULL
809   f                if not NULL, write the result to this file
810   options          various option bits:
811                      vopt_fake_sender => this sender verify is not for the real
812                        sender (it was verify=sender=xxxx or an address from a
813                        header line) - rewriting must not change sender_address
814                      vopt_is_recipient => this is a recipient address, otherwise
815                        it's a sender address - this affects qualification and
816                        rewriting and messages from callouts
817                      vopt_qualify => qualify an unqualified address; else error
818                      vopt_expn => called from SMTP EXPN command
819                      vopt_success_on_redirect => when a new address is generated
820                        the verification instantly succeeds
821
822                      These ones are used by do_callout() -- the options variable
823                        is passed to it.
824
825                      vopt_callout_fullpm => if postmaster check, do full one
826                      vopt_callout_no_cache => don't use callout cache
827                      vopt_callout_random => do the "random" thing
828                      vopt_callout_recipsender => use real sender for recipient
829                      vopt_callout_recippmaster => use postmaster for recipient
830
831   callout          if > 0, specifies that callout is required, and gives timeout
832                      for individual commands
833   callout_overall  if > 0, gives overall timeout for the callout function;
834                    if < 0, a default is used (see do_callout())
835   callout_connect  the connection timeout for callouts
836   se_mailfrom      when callout is requested to verify a sender, use this
837                      in MAIL FROM; NULL => ""
838   pm_mailfrom      when callout is requested, if non-NULL, do the postmaster
839                      thing and use this as the sender address (may be "")
840
841   routed           if not NULL, set TRUE if routing succeeded, so we can
842                      distinguish between routing failed and callout failed
843
844 Returns:           OK      address verified
845                    FAIL    address failed to verify
846                    DEFER   can't tell at present
847 */
848
849 int
850 verify_address(address_item *vaddr, FILE *f, int options, int callout,
851   int callout_overall, int callout_connect, uschar *se_mailfrom,
852   uschar *pm_mailfrom, BOOL *routed)
853 {
854 BOOL allok = TRUE;
855 BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
856 BOOL is_recipient = (options & vopt_is_recipient) != 0;
857 BOOL expn         = (options & vopt_expn) != 0;
858 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
859 int i;
860 int yield = OK;
861 int verify_type = expn? v_expn :
862      address_test_mode? v_none :
863           is_recipient? v_recipient : v_sender;
864 address_item *addr_list;
865 address_item *addr_new = NULL;
866 address_item *addr_remote = NULL;
867 address_item *addr_local = NULL;
868 address_item *addr_succeed = NULL;
869 uschar **failure_ptr = is_recipient?
870   &recipient_verify_failure : &sender_verify_failure;
871 uschar *ko_prefix, *cr;
872 uschar *address = vaddr->address;
873 uschar *save_sender;
874 uschar null_sender[] = { 0 };             /* Ensure writeable memory */
875
876 /* Clear, just in case */
877
878 *failure_ptr = NULL;
879
880 /* Set up a prefix and suffix for error message which allow us to use the same
881 output statements both in EXPN mode (where an SMTP response is needed) and when
882 debugging with an output file. */
883
884 if (expn)
885   {
886   ko_prefix = US"553 ";
887   cr = US"\r";
888   }
889 else ko_prefix = cr = US"";
890
891 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
892
893 if (parse_find_at(address) == NULL)
894   {
895   if ((options & vopt_qualify) == 0)
896     {
897     if (f != NULL)
898       fprintf(f, "%sA domain is required for \"%s\"%s\n", ko_prefix, address,
899         cr);
900     *failure_ptr = US"qualify";
901     return FAIL;
902     }
903   address = rewrite_address_qualify(address, is_recipient);
904   }
905
906 DEBUG(D_verify)
907   {
908   debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
909   debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
910   }
911
912 /* Rewrite and report on it. Clear the domain and local part caches - these
913 may have been set by domains and local part tests during an ACL. */
914
915 if (global_rewrite_rules != NULL)
916   {
917   uschar *old = address;
918   address = rewrite_address(address, is_recipient, FALSE,
919     global_rewrite_rules, rewrite_existflags);
920   if (address != old)
921     {
922     for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
923     for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
924     if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
925     }
926   }
927
928 /* If this is the real sender address, we must update sender_address at
929 this point, because it may be referred to in the routers. */
930
931 if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
932   sender_address = address;
933
934 /* If the address was rewritten to <> no verification can be done, and we have
935 to return OK. This rewriting is permitted only for sender addresses; for other
936 addresses, such rewriting fails. */
937
938 if (address[0] == 0) return OK;
939
940 /* Save a copy of the sender address for re-instating if we change it to <>
941 while verifying a sender address (a nice bit of self-reference there). */
942
943 save_sender = sender_address;
944
945 /* Update the address structure with the possibly qualified and rewritten
946 address. Set it up as the starting address on the chain of new addresses. */
947
948 vaddr->address = address;
949 addr_new = vaddr;
950
951 /* We need a loop, because an address can generate new addresses. We must also
952 cope with generated pipes and files at the top level. (See also the code and
953 comment in deliver.c.) However, it is usually the case that the router for
954 user's .forward files has its verify flag turned off.
955
956 If an address generates more than one child, the loop is used only when
957 full_info is set, and this can only be set locally. Remote enquiries just get
958 information about the top level address, not anything that it generated. */
959
960 while (addr_new != NULL)
961   {
962   int rc;
963   address_item *addr = addr_new;
964
965   addr_new = addr->next;
966   addr->next = NULL;
967
968   DEBUG(D_verify)
969     {
970     debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
971     debug_printf("Considering %s\n", addr->address);
972     }
973
974   /* Handle generated pipe, file or reply addresses. We don't get these
975   when handling EXPN, as it does only one level of expansion. */
976
977   if (testflag(addr, af_pfr))
978     {
979     allok = FALSE;
980     if (f != NULL)
981       {
982       BOOL allow;
983
984       if (addr->address[0] == '>')
985         {
986         allow = testflag(addr, af_allow_reply);
987         fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
988         }
989       else
990         {
991         allow = (addr->address[0] == '|')?
992           testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
993         fprintf(f, "%s -> %s", addr->parent->address, addr->address);
994         }
995
996       if (addr->basic_errno == ERRNO_BADTRANSPORT)
997         fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
998           "%s\n", addr->message);
999       else if (allow)
1000         fprintf(f, "\n  transport = %s\n", addr->transport->name);
1001       else
1002         fprintf(f, " *** forbidden ***\n");
1003       }
1004     continue;
1005     }
1006
1007   /* Just in case some router parameter refers to it. */
1008
1009   return_path = (addr->p.errors_address != NULL)?
1010     addr->p.errors_address : sender_address;
1011
1012   /* Split the address into domain and local part, handling the %-hack if
1013   necessary, and then route it. While routing a sender address, set
1014   $sender_address to <> because that is what it will be if we were trying to
1015   send a bounce to the sender. */
1016
1017   if (routed != NULL) *routed = FALSE;
1018   if ((rc = deliver_split_address(addr)) == OK)
1019     {
1020     if (!is_recipient) sender_address = null_sender;
1021     rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1022       &addr_succeed, verify_type);
1023     sender_address = save_sender;     /* Put back the real sender */
1024     }
1025
1026   /* If routing an address succeeded, set the flag that remembers, for use when
1027   an ACL cached a sender verify (in case a callout fails). Then if routing set
1028   up a list of hosts or the transport has a host list, and the callout option
1029   is set, and we aren't in a host checking run, do the callout verification,
1030   and set another flag that notes that a callout happened. */
1031
1032   if (rc == OK)
1033     {
1034     if (routed != NULL) *routed = TRUE;
1035     if (callout > 0)
1036       {
1037       host_item *host_list = addr->host_list;
1038
1039       /* Default, if no remote transport, to NULL for the interface (=> any),
1040       "smtp" for the port, and "smtp" for the protocol. */
1041
1042       transport_feedback tf = { NULL, US"smtp", US"smtp", NULL, FALSE, FALSE };
1043
1044       /* If verification yielded a remote transport, we want to use that
1045       transport's options, so as to mimic what would happen if we were really
1046       sending a message to this address. */
1047
1048       if (addr->transport != NULL && !addr->transport->info->local)
1049         {
1050         (void)(addr->transport->setup)(addr->transport, addr, &tf, NULL);
1051
1052         /* If the transport has hosts and the router does not, or if the
1053         transport is configured to override the router's hosts, we must build a
1054         host list of the transport's hosts, and find the IP addresses */
1055
1056         if (tf.hosts != NULL && (host_list == NULL || tf.hosts_override))
1057           {
1058           uschar *s;
1059           uschar *save_deliver_domain = deliver_domain;
1060           uschar *save_deliver_localpart = deliver_localpart;
1061
1062           host_list = NULL;    /* Ignore the router's hosts */
1063
1064           deliver_domain = addr->domain;
1065           deliver_localpart = addr->local_part;
1066           s = expand_string(tf.hosts);
1067           deliver_domain = save_deliver_domain;
1068           deliver_localpart = save_deliver_localpart;
1069
1070           if (s == NULL)
1071             {
1072             log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1073               "\"%s\" in %s transport for callout: %s", tf.hosts,
1074               addr->transport->name, expand_string_message);
1075             }
1076           else
1077             {
1078             uschar *canonical_name;
1079             host_item *host, *nexthost;
1080             host_build_hostlist(&host_list, s, tf.hosts_randomize);
1081
1082             /* Just ignore failures to find a host address. If we don't manage
1083             to find any addresses, the callout will defer. Note that more than
1084             one address may be found for a single host, which will result in
1085             additional host items being inserted into the chain. Hence we must
1086             save the next host first. */
1087
1088             for (host = host_list; host != NULL; host = nexthost)
1089               {
1090               nexthost = host->next;
1091               if (tf.gethostbyname ||
1092                   string_is_ip_address(host->name, NULL) > 0)
1093                 (void)host_find_byname(host, NULL, &canonical_name, TRUE);
1094               else
1095                 {
1096                 int flags = HOST_FIND_BY_A;
1097                 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1098                 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1099                 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1100                   &canonical_name, NULL);
1101                 }
1102               }
1103             }
1104           }
1105         }
1106
1107       /* Can only do a callout if we have at least one host! If the callout
1108       fails, it will have set ${sender,recipient}_verify_failure. */
1109
1110       if (host_list != NULL)
1111         {
1112         HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1113         if (host_checking && !host_checking_callout)
1114           {
1115           HDEBUG(D_verify)
1116             debug_printf("... callout omitted by default when host testing\n"
1117               "(Use -bhc if you want the callouts to happen.)\n");
1118           }
1119         else
1120           {
1121           rc = do_callout(addr, host_list, &tf, callout, callout_overall,
1122             callout_connect, options, se_mailfrom, pm_mailfrom);
1123           }
1124         }
1125       else
1126         {
1127         HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1128           "transport provided a host list\n");
1129         }
1130       }
1131     }
1132
1133   /* Otherwise, any failure is a routing failure */
1134
1135   else *failure_ptr = US"route";
1136
1137   /* A router may return REROUTED if it has set up a child address as a result
1138   of a change of domain name (typically from widening). In this case we always
1139   want to continue to verify the new child. */
1140
1141   if (rc == REROUTED) continue;
1142
1143   /* Handle hard failures */
1144
1145   if (rc == FAIL)
1146     {
1147     allok = FALSE;
1148     if (f != NULL)
1149       {
1150       fprintf(f, "%s%s %s", ko_prefix, address,
1151         address_test_mode? "is undeliverable" : "failed to verify");
1152       if (!expn && admin_user)
1153         {
1154         if (addr->basic_errno > 0)
1155           fprintf(f, ": %s", strerror(addr->basic_errno));
1156         if (addr->message != NULL)
1157           fprintf(f, ":\n  %s", addr->message);
1158         }
1159       fprintf(f, "%s\n", cr);
1160       }
1161
1162     if (!full_info) return copy_error(vaddr, addr, FAIL);
1163       else yield = FAIL;
1164     }
1165
1166   /* Soft failure */
1167
1168   else if (rc == DEFER)
1169     {
1170     allok = FALSE;
1171     if (f != NULL)
1172       {
1173       fprintf(f, "%s%s cannot be resolved at this time", ko_prefix, address);
1174       if (!expn && admin_user)
1175         {
1176         if (addr->basic_errno > 0)
1177           fprintf(f, ":\n  %s", strerror(addr->basic_errno));
1178         if (addr->message != NULL)
1179           fprintf(f, ":\n  %s", addr->message);
1180         else if (addr->basic_errno <= 0)
1181           fprintf(f, ":\n  unknown error");
1182         }
1183
1184       fprintf(f, "%s\n", cr);
1185       }
1186     if (!full_info) return copy_error(vaddr, addr, DEFER);
1187       else if (yield == OK) yield = DEFER;
1188     }
1189
1190   /* If we are handling EXPN, we do not want to continue to route beyond
1191   the top level. */
1192
1193   else if (expn)
1194     {
1195     uschar *ok_prefix = US"250-";
1196     if (addr_new == NULL)
1197       {
1198       if (addr_local == NULL && addr_remote == NULL)
1199         fprintf(f, "250 mail to <%s> is discarded\r\n", address);
1200       else
1201         fprintf(f, "250 <%s>\r\n", address);
1202       }
1203     else while (addr_new != NULL)
1204       {
1205       address_item *addr2 = addr_new;
1206       addr_new = addr2->next;
1207       if (addr_new == NULL) ok_prefix = US"250 ";
1208       fprintf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
1209       }
1210     return OK;
1211     }
1212
1213   /* Successful routing other than EXPN. */
1214
1215   else
1216     {
1217     /* Handle successful routing when short info wanted. Otherwise continue for
1218     other (generated) addresses. Short info is the operational case. Full info
1219     can be requested only when debug_selector != 0 and a file is supplied.
1220
1221     There is a conflict between the use of aliasing as an alternate email
1222     address, and as a sort of mailing list. If an alias turns the incoming
1223     address into just one address (e.g. J.Caesar->jc44) you may well want to
1224     carry on verifying the generated address to ensure it is valid when
1225     checking incoming mail. If aliasing generates multiple addresses, you
1226     probably don't want to do this. Exim therefore treats the generation of
1227     just a single new address as a special case, and continues on to verify the
1228     generated address. */
1229
1230     if (!full_info &&                    /* Stop if short info wanted AND */
1231          (((addr_new == NULL ||          /* No new address OR */
1232            addr_new->next != NULL ||     /* More than one new address OR */
1233            testflag(addr_new, af_pfr)))  /* New address is pfr */
1234          ||                              /* OR */
1235          (addr_new != NULL &&            /* At least one new address AND */
1236           success_on_redirect)))         /* success_on_redirect is set */
1237       {
1238       if (f != NULL) fprintf(f, "%s %s\n", address,
1239         address_test_mode? "is deliverable" : "verified");
1240
1241       /* If we have carried on to verify a child address, we want the value
1242       of $address_data to be that of the child */
1243
1244       vaddr->p.address_data = addr->p.address_data;
1245       return OK;
1246       }
1247     }
1248   }     /* Loop for generated addresses */
1249
1250 /* Display the full results of the successful routing, including any generated
1251 addresses. Control gets here only when full_info is set, which requires f not
1252 to be NULL, and this occurs only when a top-level verify is called with the
1253 debugging switch on.
1254
1255 If there are no local and no remote addresses, and there were no pipes, files,
1256 or autoreplies, and there were no errors or deferments, the message is to be
1257 discarded, usually because of the use of :blackhole: in an alias file. */
1258
1259 if (allok && addr_local == NULL && addr_remote == NULL)
1260   fprintf(f, "mail to %s is discarded\n", address);
1261
1262 else for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
1263   {
1264   while (addr_list != NULL)
1265     {
1266     address_item *addr = addr_list;
1267     address_item *p = addr->parent;
1268     addr_list = addr->next;
1269
1270     fprintf(f, "%s", CS addr->address);
1271 #ifdef EXPERIMENTAL_SRS
1272     if(addr->p.srs_sender)
1273       fprintf(f, "    [srs = %s]", addr->p.srs_sender);
1274 #endif
1275     while (p != NULL)
1276       {
1277       fprintf(f, "\n    <-- %s", p->address);
1278       p = p->parent;
1279       }
1280     fprintf(f, "\n  ");
1281
1282     /* Show router, and transport */
1283
1284     fprintf(f, "router = %s, ", addr->router->name);
1285     fprintf(f, "transport = %s\n", (addr->transport == NULL)? US"unset" :
1286       addr->transport->name);
1287
1288     /* Show any hosts that are set up by a router unless the transport
1289     is going to override them; fiddle a bit to get a nice format. */
1290
1291     if (addr->host_list != NULL && addr->transport != NULL &&
1292         !addr->transport->overrides_hosts)
1293       {
1294       host_item *h;
1295       int maxlen = 0;
1296       int maxaddlen = 0;
1297       for (h = addr->host_list; h != NULL; h = h->next)
1298         {
1299         int len = Ustrlen(h->name);
1300         if (len > maxlen) maxlen = len;
1301         len = (h->address != NULL)? Ustrlen(h->address) : 7;
1302         if (len > maxaddlen) maxaddlen = len;
1303         }
1304       for (h = addr->host_list; h != NULL; h = h->next)
1305         {
1306         int len = Ustrlen(h->name);
1307         fprintf(f, "  host %s ", h->name);
1308         while (len++ < maxlen) fprintf(f, " ");
1309         if (h->address != NULL)
1310           {
1311           fprintf(f, "[%s] ", h->address);
1312           len = Ustrlen(h->address);
1313           }
1314         else if (!addr->transport->info->local)  /* Omit [unknown] for local */
1315           {
1316           fprintf(f, "[unknown] ");
1317           len = 7;
1318           }
1319         else len = -3;
1320         while (len++ < maxaddlen) fprintf(f," ");
1321         if (h->mx >= 0) fprintf(f, "MX=%d", h->mx);
1322         if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
1323         if (h->status == hstatus_unusable) fprintf(f, " ** unusable **");
1324         fprintf(f, "\n");
1325         }
1326       }
1327     }
1328   }
1329
1330 /* Will be DEFER or FAIL if any one address has, only for full_info (which is
1331 the -bv or -bt case). */
1332
1333 return yield;
1334 }
1335
1336
1337
1338
1339 /*************************************************
1340 *      Check headers for syntax errors           *
1341 *************************************************/
1342
1343 /* This function checks those header lines that contain addresses, and verifies
1344 that all the addresses therein are syntactially correct.
1345
1346 Arguments:
1347   msgptr     where to put an error message
1348
1349 Returns:     OK
1350              FAIL
1351 */
1352
1353 int
1354 verify_check_headers(uschar **msgptr)
1355 {
1356 header_line *h;
1357 uschar *colon, *s;
1358
1359 for (h = header_list; h != NULL; h = h->next)
1360   {
1361   if (h->type != htype_from &&
1362       h->type != htype_reply_to &&
1363       h->type != htype_sender &&
1364       h->type != htype_to &&
1365       h->type != htype_cc &&
1366       h->type != htype_bcc)
1367     continue;
1368
1369   colon = Ustrchr(h->text, ':');
1370   s = colon + 1;
1371   while (isspace(*s)) s++;
1372
1373   parse_allow_group = TRUE;     /* Allow group syntax */
1374
1375   /* Loop for multiple addresses in the header */
1376
1377   while (*s != 0)
1378     {
1379     uschar *ss = parse_find_address_end(s, FALSE);
1380     uschar *recipient, *errmess;
1381     int terminator = *ss;
1382     int start, end, domain;
1383
1384     /* Temporarily terminate the string at this point, and extract the
1385     operative address within. */
1386
1387     *ss = 0;
1388     recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1389     *ss = terminator;
1390
1391     /* Permit an unqualified address only if the message is local, or if the
1392     sending host is configured to be permitted to send them. */
1393
1394     if (recipient != NULL && domain == 0)
1395       {
1396       if (h->type == htype_from || h->type == htype_sender)
1397         {
1398         if (!allow_unqualified_sender) recipient = NULL;
1399         }
1400       else
1401         {
1402         if (!allow_unqualified_recipient) recipient = NULL;
1403         }
1404       if (recipient == NULL) errmess = US"unqualified address not permitted";
1405       }
1406
1407     /* It's an error if no address could be extracted, except for the special
1408     case of an empty address. */
1409
1410     if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
1411       {
1412       uschar *verb = US"is";
1413       uschar *t = ss;
1414       int len;
1415
1416       /* Arrange not to include any white space at the end in the
1417       error message. */
1418
1419       while (t > s && isspace(t[-1])) t--;
1420
1421       /* Add the address which failed to the error message, since in a
1422       header with very many addresses it is sometimes hard to spot
1423       which one is at fault. However, limit the amount of address to
1424       quote - cases have been seen where, for example, a missing double
1425       quote in a humungous To: header creates an "address" that is longer
1426       than string_sprintf can handle. */
1427
1428       len = t - s;
1429       if (len > 1024)
1430         {
1431         len = 1024;
1432         verb = US"begins";
1433         }
1434
1435       *msgptr = string_printing(
1436         string_sprintf("%s: failing address in \"%.*s\" header %s: %.*s",
1437           errmess, colon - h->text, h->text, verb, len, s));
1438
1439       return FAIL;
1440       }
1441
1442     /* Advance to the next address */
1443
1444     s = ss + (terminator? 1:0);
1445     while (isspace(*s)) s++;
1446     }   /* Next address */
1447   }     /* Next header */
1448
1449 return OK;
1450 }
1451
1452
1453
1454
1455 /*************************************************
1456 *          Find if verified sender               *
1457 *************************************************/
1458
1459 /* Usually, just a single address is verified as the sender of the message.
1460 However, Exim can be made to verify other addresses as well (often related in
1461 some way), and this is useful in some environments. There may therefore be a
1462 chain of such addresses that have previously been tested. This function finds
1463 whether a given address is on the chain.
1464
1465 Arguments:   the address to be verified
1466 Returns:     pointer to an address item, or NULL
1467 */
1468
1469 address_item *
1470 verify_checked_sender(uschar *sender)
1471 {
1472 address_item *addr;
1473 for (addr = sender_verified_list; addr != NULL; addr = addr->next)
1474   if (Ustrcmp(sender, addr->address) == 0) break;
1475 return addr;
1476 }
1477
1478
1479
1480
1481
1482 /*************************************************
1483 *             Get valid header address           *
1484 *************************************************/
1485
1486 /* Scan the originator headers of the message, looking for an address that
1487 verifies successfully. RFC 822 says:
1488
1489     o   The "Sender" field mailbox should be sent  notices  of
1490         any  problems in transport or delivery of the original
1491         messages.  If there is no  "Sender"  field,  then  the
1492         "From" field mailbox should be used.
1493
1494     o   If the "Reply-To" field exists, then the reply  should
1495         go to the addresses indicated in that field and not to
1496         the address(es) indicated in the "From" field.
1497
1498 So we check a Sender field if there is one, else a Reply_to field, else a From
1499 field. As some strange messages may have more than one of these fields,
1500 especially if they are resent- fields, check all of them if there is more than
1501 one.
1502
1503 Arguments:
1504   user_msgptr      points to where to put a user error message
1505   log_msgptr       points to where to put a log error message
1506   callout          timeout for callout check (passed to verify_address())
1507   callout_overall  overall callout timeout (ditto)
1508   callout_connect  connect callout timeout (ditto)
1509   se_mailfrom      mailfrom for verify; NULL => ""
1510   pm_mailfrom      sender for pm callout check (passed to verify_address())
1511   options          callout options (passed to verify_address())
1512   verrno           where to put the address basic_errno
1513
1514 If log_msgptr is set to something without setting user_msgptr, the caller
1515 normally uses log_msgptr for both things.
1516
1517 Returns:           result of the verification attempt: OK, FAIL, or DEFER;
1518                    FAIL is given if no appropriate headers are found
1519 */
1520
1521 int
1522 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
1523   int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
1524   uschar *pm_mailfrom, int options, int *verrno)
1525 {
1526 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
1527 int yield = FAIL;
1528 int i;
1529
1530 for (i = 0; i < 3; i++)
1531   {
1532   header_line *h;
1533   for (h = header_list; h != NULL; h = h->next)
1534     {
1535     int terminator, new_ok;
1536     uschar *s, *ss, *endname;
1537
1538     if (h->type != header_types[i]) continue;
1539     s = endname = Ustrchr(h->text, ':') + 1;
1540
1541     while (*s != 0)
1542       {
1543       address_item *vaddr;
1544
1545       while (isspace(*s) || *s == ',') s++;
1546       if (*s == 0) break;        /* End of header */
1547
1548       ss = parse_find_address_end(s, FALSE);
1549
1550       /* The terminator is a comma or end of header, but there may be white
1551       space preceding it (including newline for the last address). Move back
1552       past any white space so we can check against any cached envelope sender
1553       address verifications. */
1554
1555       while (isspace(ss[-1])) ss--;
1556       terminator = *ss;
1557       *ss = 0;
1558
1559       HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
1560         (int)(endname - h->text), h->text, s);
1561
1562       /* See if we have already verified this address as an envelope sender,
1563       and if so, use the previous answer. */
1564
1565       vaddr = verify_checked_sender(s);
1566
1567       if (vaddr != NULL &&                   /* Previously checked */
1568            (callout <= 0 ||                  /* No callout needed; OR */
1569             vaddr->special_action > 256))    /* Callout was done */
1570         {
1571         new_ok = vaddr->special_action & 255;
1572         HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
1573         *ss = terminator;  /* Restore shortened string */
1574         }
1575
1576       /* Otherwise we run the verification now. We must restore the shortened
1577       string before running the verification, so the headers are correct, in
1578       case there is any rewriting. */
1579
1580       else
1581         {
1582         int start, end, domain;
1583         uschar *address = parse_extract_address(s, log_msgptr, &start,
1584           &end, &domain, FALSE);
1585
1586         *ss = terminator;
1587
1588         /* If verification failed because of a syntax error, fail this
1589         function, and ensure that the failing address gets added to the error
1590         message. */
1591
1592         if (address == NULL)
1593           {
1594           new_ok = FAIL;
1595           if (*log_msgptr != NULL)
1596             {
1597             while (ss > s && isspace(ss[-1])) ss--;
1598             *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
1599               "scanning for sender: %s in \"%.*s\"",
1600               endname - h->text, h->text, *log_msgptr, ss - s, s);
1601             return FAIL;
1602             }
1603           }
1604
1605         /* Else go ahead with the sender verification. But it isn't *the*
1606         sender of the message, so set vopt_fake_sender to stop sender_address
1607         being replaced after rewriting or qualification. */
1608
1609         else
1610           {
1611           vaddr = deliver_make_addr(address, FALSE);
1612           new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
1613             callout, callout_overall, callout_connect, se_mailfrom,
1614             pm_mailfrom, NULL);
1615           }
1616         }
1617
1618       /* We now have the result, either newly found, or cached. If we are
1619       giving out error details, set a specific user error. This means that the
1620       last of these will be returned to the user if all three fail. We do not
1621       set a log message - the generic one below will be used. */
1622
1623       if (new_ok != OK)
1624         {
1625         *verrno = vaddr->basic_errno;
1626         if (smtp_return_error_details)
1627           {
1628           *user_msgptr = string_sprintf("Rejected after DATA: "
1629             "could not verify \"%.*s\" header address\n%s: %s",
1630             endname - h->text, h->text, vaddr->address, vaddr->message);
1631           }
1632         }
1633
1634       /* Success or defer */
1635
1636       if (new_ok == OK) return OK;
1637       if (new_ok == DEFER) yield = DEFER;
1638
1639       /* Move on to any more addresses in the header */
1640
1641       s = ss;
1642       }
1643     }
1644   }
1645
1646 if (yield == FAIL && *log_msgptr == NULL)
1647   *log_msgptr = US"there is no valid sender in any header line";
1648
1649 if (yield == DEFER && *log_msgptr == NULL)
1650   *log_msgptr = US"all attempts to verify a sender in a header line deferred";
1651
1652 return yield;
1653 }
1654
1655
1656
1657
1658 /*************************************************
1659 *            Get RFC 1413 identification         *
1660 *************************************************/
1661
1662 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
1663 the timeout is set to zero, then the query is not done. There may also be lists
1664 of hosts and nets which are exempt. To guard against malefactors sending
1665 non-printing characters which could, for example, disrupt a message's headers,
1666 make sure the string consists of printing characters only.
1667
1668 Argument:
1669   port    the port to connect to; usually this is IDENT_PORT (113), but when
1670           running in the test harness with -bh a different value is used.
1671
1672 Returns:  nothing
1673
1674 Side effect: any received ident value is put in sender_ident (NULL otherwise)
1675 */
1676
1677 void
1678 verify_get_ident(int port)
1679 {
1680 int sock, host_af, qlen;
1681 int received_sender_port, received_interface_port, n;
1682 uschar *p;
1683 uschar buffer[2048];
1684
1685 /* Default is no ident. Check whether we want to do an ident check for this
1686 host. */
1687
1688 sender_ident = NULL;
1689 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
1690   return;
1691
1692 DEBUG(D_ident) debug_printf("doing ident callback\n");
1693
1694 /* Set up a connection to the ident port of the remote host. Bind the local end
1695 to the incoming interface address. If the sender host address is an IPv6
1696 address, the incoming interface address will also be IPv6. */
1697
1698 host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
1699 sock = ip_socket(SOCK_STREAM, host_af);
1700 if (sock < 0) return;
1701
1702 if (ip_bind(sock, host_af, interface_address, 0) < 0)
1703   {
1704   DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
1705     strerror(errno));
1706   goto END_OFF;
1707   }
1708
1709 if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
1710      < 0)
1711   {
1712   if (errno == ETIMEDOUT && (log_extra_selector & LX_ident_timeout) != 0)
1713     {
1714     log_write(0, LOG_MAIN, "ident connection to %s timed out",
1715       sender_host_address);
1716     }
1717   else
1718     {
1719     DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
1720       sender_host_address, strerror(errno));
1721     }
1722   goto END_OFF;
1723   }
1724
1725 /* Construct and send the query. */
1726
1727 sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
1728 qlen = Ustrlen(buffer);
1729 if (send(sock, buffer, qlen, 0) < 0)
1730   {
1731   DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
1732   goto END_OFF;
1733   }
1734
1735 /* Read a response line. We put it into the rest of the buffer, using several
1736 recv() calls if necessary. */
1737
1738 p = buffer + qlen;
1739
1740 for (;;)
1741   {
1742   uschar *pp;
1743   int count;
1744   int size = sizeof(buffer) - (p - buffer);
1745
1746   if (size <= 0) goto END_OFF;   /* Buffer filled without seeing \n. */
1747   count = ip_recv(sock, p, size, rfc1413_query_timeout);
1748   if (count <= 0) goto END_OFF;  /* Read error or EOF */
1749
1750   /* Scan what we just read, to see if we have reached the terminating \r\n. Be
1751   generous, and accept a plain \n terminator as well. The only illegal
1752   character is 0. */
1753
1754   for (pp = p; pp < p + count; pp++)
1755     {
1756     if (*pp == 0) goto END_OFF;   /* Zero octet not allowed */
1757     if (*pp == '\n')
1758       {
1759       if (pp[-1] == '\r') pp--;
1760       *pp = 0;
1761       goto GOT_DATA;             /* Break out of both loops */
1762       }
1763     }
1764
1765   /* Reached the end of the data without finding \n. Let the loop continue to
1766   read some more, if there is room. */
1767
1768   p = pp;
1769   }
1770
1771 GOT_DATA:
1772
1773 /* We have received a line of data. Check it carefully. It must start with the
1774 same two port numbers that we sent, followed by data as defined by the RFC. For
1775 example,
1776
1777   12345 , 25 : USERID : UNIX :root
1778
1779 However, the amount of white space may be different to what we sent. In the
1780 "osname" field there may be several sub-fields, comma separated. The data we
1781 actually want to save follows the third colon. Some systems put leading spaces
1782 in it - we discard those. */
1783
1784 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
1785       &received_interface_port, &n) != 2 ||
1786     received_sender_port != sender_host_port ||
1787     received_interface_port != interface_port)
1788   goto END_OFF;
1789
1790 p = buffer + qlen + n;
1791 while(isspace(*p)) p++;
1792 if (*p++ != ':') goto END_OFF;
1793 while(isspace(*p)) p++;
1794 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
1795 p += 6;
1796 while(isspace(*p)) p++;
1797 if (*p++ != ':') goto END_OFF;
1798 while (*p != 0 && *p != ':') p++;
1799 if (*p++ == 0) goto END_OFF;
1800 while(isspace(*p)) p++;
1801 if (*p == 0) goto END_OFF;
1802
1803 /* The rest of the line is the data we want. We turn it into printing
1804 characters when we save it, so that it cannot mess up the format of any logging
1805 or Received: lines into which it gets inserted. We keep a maximum of 127
1806 characters. */
1807
1808 sender_ident = string_printing(string_copyn(p, 127));
1809 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
1810
1811 END_OFF:
1812 (void)close(sock);
1813 return;
1814 }
1815
1816
1817
1818
1819 /*************************************************
1820 *      Match host to a single host-list item     *
1821 *************************************************/
1822
1823 /* This function compares a host (name or address) against a single item
1824 from a host list. The host name gets looked up if it is needed and is not
1825 already known. The function is called from verify_check_this_host() via
1826 match_check_list(), which is why most of its arguments are in a single block.
1827
1828 Arguments:
1829   arg            the argument block (see below)
1830   ss             the host-list item
1831   valueptr       where to pass back looked up data, or NULL
1832   error          for error message when returning ERROR
1833
1834 The block contains:
1835   host_name      (a) the host name, or
1836                  (b) NULL, implying use sender_host_name and
1837                        sender_host_aliases, looking them up if required, or
1838                  (c) the empty string, meaning that only IP address matches
1839                        are permitted
1840   host_address   the host address
1841   host_ipv4      the IPv4 address taken from an IPv6 one
1842
1843 Returns:         OK      matched
1844                  FAIL    did not match
1845                  DEFER   lookup deferred
1846                  ERROR   (a) failed to find the host name or IP address, or
1847                          (b) unknown lookup type specified, or
1848                          (c) host name encountered when only IP addresses are
1849                                being matched
1850 */
1851
1852 int
1853 check_host(void *arg, uschar *ss, uschar **valueptr, uschar **error)
1854 {
1855 check_host_block *cb = (check_host_block *)arg;
1856 int mlen = -1;
1857 int maskoffset;
1858 BOOL iplookup = FALSE;
1859 BOOL isquery = FALSE;
1860 BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
1861 uschar *t = ss;
1862 uschar *semicolon;
1863 uschar **aliases;
1864
1865 /* Optimize for the special case when the pattern is "*". */
1866
1867 if (*ss == '*' && ss[1] == 0) return OK;
1868
1869 /* If the pattern is empty, it matches only in the case when there is no host -
1870 this can occur in ACL checking for SMTP input using the -bs option. In this
1871 situation, the host address is the empty string. */
1872
1873 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
1874 if (*ss == 0) return FAIL;
1875
1876 /* If the pattern is precisely "@" then match against the primary host name,
1877 provided that host name matching is permitted; if it's "@[]" match against the
1878 local host's IP addresses. */
1879
1880 if (*ss == '@')
1881   {
1882   if (ss[1] == 0)
1883     {
1884     if (isiponly) return ERROR;
1885     ss = primary_hostname;
1886     }
1887   else if (Ustrcmp(ss, "@[]") == 0)
1888     {
1889     ip_address_item *ip;
1890     for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
1891       if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
1892     return FAIL;
1893     }
1894   }
1895
1896 /* If the pattern is an IP address, optionally followed by a bitmask count, do
1897 a (possibly masked) comparision with the current IP address. */
1898
1899 if (string_is_ip_address(ss, &maskoffset) > 0)
1900   return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
1901
1902 /* See if there is a semicolon in the pattern */
1903
1904 semicolon = Ustrchr(ss, ';');
1905
1906 /* If we are doing an IP address only match, then all lookups must be IP
1907 address lookups. */
1908
1909 if (isiponly)
1910   {
1911   iplookup = semicolon != NULL;
1912   }
1913
1914 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
1915 a lookup on a masked IP network, in textual form. The net- stuff really only
1916 applies to single-key lookups where the key is implicit. For query-style
1917 lookups the key is specified in the query. From release 4.30, the use of net-
1918 for query style is no longer needed, but we retain it for backward
1919 compatibility. */
1920
1921 else if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
1922   {
1923   mlen = 0;
1924   for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
1925   if (mlen == 0 && t == ss+3) mlen = -1;  /* No mask supplied */
1926   iplookup = (*t++ == '-');
1927   }
1928
1929 /* Do the IP address lookup if that is indeed what we have */
1930
1931 if (iplookup)
1932   {
1933   int insize;
1934   int search_type;
1935   int incoming[4];
1936   void *handle;
1937   uschar *filename, *key, *result;
1938   uschar buffer[64];
1939
1940   /* Find the search type */
1941
1942   search_type = search_findtype(t, semicolon - t);
1943
1944   if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
1945     search_error_message);
1946
1947   /* Adjust parameters for the type of lookup. For a query-style lookup, there
1948   is no file name, and the "key" is just the query. For query-style with a file
1949   name, we have to fish the file off the start of the query. For a single-key
1950   lookup, the key is the current IP address, masked appropriately, and
1951   reconverted to text form, with the mask appended. For IPv6 addresses, specify
1952   dot separators instead of colons. */
1953
1954   if (mac_islookup(search_type, lookup_absfilequery))
1955     {
1956     filename = semicolon + 1;
1957     key = filename;
1958     while (*key != 0 && !isspace(*key)) key++;
1959     filename = string_copyn(filename, key - filename);
1960     while (isspace(*key)) key++;
1961     }
1962   else if (mac_islookup(search_type, lookup_querystyle))
1963     {
1964     filename = NULL;
1965     key = semicolon + 1;
1966     }
1967   else
1968     {
1969     insize = host_aton(cb->host_address, incoming);
1970     host_mask(insize, incoming, mlen);
1971     (void)host_nmtoa(insize, incoming, mlen, buffer, '.');
1972     key = buffer;
1973     filename = semicolon + 1;
1974     }
1975
1976   /* Now do the actual lookup; note that there is no search_close() because
1977   of the caching arrangements. */
1978
1979   handle = search_open(filename, search_type, 0, NULL, NULL);
1980   if (handle == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
1981     search_error_message);
1982   result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
1983   if (valueptr != NULL) *valueptr = result;
1984   return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
1985   }
1986
1987 /* The pattern is not an IP address or network reference of any kind. That is,
1988 it is a host name pattern. If this is an IP only match, there's an error in the
1989 host list. */
1990
1991 if (isiponly)
1992   {
1993   *error = US"cannot match host name in match_ip list";
1994   return ERROR;
1995   }
1996
1997 /* Check the characters of the pattern to see if they comprise only letters,
1998 digits, full stops, and hyphens (the constituents of domain names). Allow
1999 underscores, as they are all too commonly found. Sigh. Also, if
2000 allow_utf8_domains is set, allow top-bit characters. */
2001
2002 for (t = ss; *t != 0; t++)
2003   if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
2004       (!allow_utf8_domains || *t < 128)) break;
2005
2006 /* If the pattern is a complete domain name, with no fancy characters, look up
2007 its IP address and match against that. Note that a multi-homed host will add
2008 items to the chain. */
2009
2010 if (*t == 0)
2011   {
2012   int rc;
2013   host_item h;
2014   h.next = NULL;
2015   h.name = ss;
2016   h.address = NULL;
2017   h.mx = MX_NONE;
2018   rc = host_find_byname(&h, NULL, NULL, FALSE);
2019   if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
2020     {
2021     host_item *hh;
2022     for (hh = &h; hh != NULL; hh = hh->next)
2023       {
2024       if (Ustrcmp(hh->address, (Ustrchr(hh->address, ':') == NULL)?
2025         cb->host_ipv4 : cb->host_address) == 0)
2026           return OK;
2027       }
2028     return FAIL;
2029     }
2030   if (rc == HOST_FIND_AGAIN) return DEFER;
2031   *error = string_sprintf("failed to find IP address for %s", ss);
2032   return ERROR;
2033   }
2034
2035 /* Almost all subsequent comparisons require the host name, and can be done
2036 using the general string matching function. When this function is called for
2037 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
2038 must use sender_host_name and its aliases, looking them up if necessary. */
2039
2040 if (cb->host_name != NULL)   /* Explicit host name given */
2041   return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
2042     valueptr);
2043
2044 /* Host name not given; in principle we need the sender host name and its
2045 aliases. However, for query-style lookups, we do not need the name if the
2046 query does not contain $sender_host_name. From release 4.23, a reference to
2047 $sender_host_name causes it to be looked up, so we don't need to do the lookup
2048 on spec. */
2049
2050 if ((semicolon = Ustrchr(ss, ';')) != NULL)
2051   {
2052   uschar *affix;
2053   int partial, affixlen, starflags, id;
2054
2055   *semicolon = 0;
2056   id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
2057   *semicolon=';';
2058
2059   if (id < 0)                           /* Unknown lookup type */
2060     {
2061     log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
2062       search_error_message, ss);
2063     return DEFER;
2064     }
2065   isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
2066   }
2067
2068 if (isquery)
2069   {
2070   switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
2071     {
2072     case OK:    return OK;
2073     case DEFER: return DEFER;
2074     default:    return FAIL;
2075     }
2076   }
2077
2078 /* Not a query-style lookup; must ensure the host name is present, and then we
2079 do a check on the name and all its aliases. */
2080
2081 if (sender_host_name == NULL)
2082   {
2083   HDEBUG(D_host_lookup)
2084     debug_printf("sender host name required, to match against %s\n", ss);
2085   if (host_lookup_failed || host_name_lookup() != OK)
2086     {
2087     *error = string_sprintf("failed to find host name for %s",
2088       sender_host_address);;
2089     return ERROR;
2090     }
2091   host_build_sender_fullhost();
2092   }
2093
2094 /* Match on the sender host name, using the general matching function */
2095
2096 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
2097        valueptr))
2098   {
2099   case OK:    return OK;
2100   case DEFER: return DEFER;
2101   }
2102
2103 /* If there are aliases, try matching on them. */
2104
2105 aliases = sender_host_aliases;
2106 while (*aliases != NULL)
2107   {
2108   switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
2109     {
2110     case OK:    return OK;
2111     case DEFER: return DEFER;
2112     }
2113   }
2114 return FAIL;
2115 }
2116
2117
2118
2119
2120 /*************************************************
2121 *    Check a specific host matches a host list   *
2122 *************************************************/
2123
2124 /* This function is passed a host list containing items in a number of
2125 different formats and the identity of a host. Its job is to determine whether
2126 the given host is in the set of hosts defined by the list. The host name is
2127 passed as a pointer so that it can be looked up if needed and not already
2128 known. This is commonly the case when called from verify_check_host() to check
2129 an incoming connection. When called from elsewhere the host name should usually
2130 be set.
2131
2132 This function is now just a front end to match_check_list(), which runs common
2133 code for scanning a list. We pass it the check_host() function to perform a
2134 single test.
2135
2136 Arguments:
2137   listptr              pointer to the host list
2138   cache_bits           pointer to cache for named lists, or NULL
2139   host_name            the host name or NULL, implying use sender_host_name and
2140                          sender_host_aliases, looking them up if required
2141   host_address         the IP address
2142   valueptr             if not NULL, data from a lookup is passed back here
2143
2144 Returns:    OK    if the host is in the defined set
2145             FAIL  if the host is not in the defined set,
2146             DEFER if a data lookup deferred (not a host lookup)
2147
2148 If the host name was needed in order to make a comparison, and could not be
2149 determined from the IP address, the result is FAIL unless the item
2150 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
2151
2152 int
2153 verify_check_this_host(uschar **listptr, unsigned int *cache_bits,
2154   uschar *host_name, uschar *host_address, uschar **valueptr)
2155 {
2156 int rc;
2157 unsigned int *local_cache_bits = cache_bits;
2158 uschar *save_host_address = deliver_host_address;
2159 check_host_block cb;
2160 cb.host_name = host_name;
2161 cb.host_address = host_address;
2162
2163 if (valueptr != NULL) *valueptr = NULL;
2164
2165 /* If the host address starts off ::ffff: it is an IPv6 address in
2166 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2167 addresses. */
2168
2169 cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
2170   host_address + 7 : host_address;
2171
2172 /* During the running of the check, put the IP address into $host_address. In
2173 the case of calls from the smtp transport, it will already be there. However,
2174 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
2175 the safe side, any existing setting is preserved, though as I write this
2176 (November 2004) I can't see any cases where it is actually needed. */
2177
2178 deliver_host_address = host_address;
2179 rc = match_check_list(
2180        listptr,                                /* the list */
2181        0,                                      /* separator character */
2182        &hostlist_anchor,                       /* anchor pointer */
2183        &local_cache_bits,                      /* cache pointer */
2184        check_host,                             /* function for testing */
2185        &cb,                                    /* argument for function */
2186        MCL_HOST,                               /* type of check */
2187        (host_address == sender_host_address)?
2188          US"host" : host_address,              /* text for debugging */
2189        valueptr);                              /* where to pass back data */
2190 deliver_host_address = save_host_address;
2191 return rc;
2192 }
2193
2194
2195
2196
2197 /*************************************************
2198 *      Check the remote host matches a list      *
2199 *************************************************/
2200
2201 /* This is a front end to verify_check_this_host(), created because checking
2202 the remote host is a common occurrence. With luck, a good compiler will spot
2203 the tail recursion and optimize it. If there's no host address, this is
2204 command-line SMTP input - check against an empty string for the address.
2205
2206 Arguments:
2207   listptr              pointer to the host list
2208
2209 Returns:               the yield of verify_check_this_host(),
2210                        i.e. OK, FAIL, or DEFER
2211 */
2212
2213 int
2214 verify_check_host(uschar **listptr)
2215 {
2216 return verify_check_this_host(listptr, sender_host_cache, NULL,
2217   (sender_host_address == NULL)? US"" : sender_host_address, NULL);
2218 }
2219
2220
2221
2222
2223
2224 /*************************************************
2225 *    Invert an IP address for a DNS black list   *
2226 *************************************************/
2227
2228 /*
2229 Arguments:
2230   buffer         where to put the answer
2231   address        the address to invert
2232 */
2233
2234 static void
2235 invert_address(uschar *buffer, uschar *address)
2236 {
2237 int bin[4];
2238 uschar *bptr = buffer;
2239
2240 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
2241 to the IPv4 part only. */
2242
2243 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
2244
2245 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
2246 always 1. */
2247
2248 if (host_aton(address, bin) == 1)
2249   {
2250   int i;
2251   int x = bin[0];
2252   for (i = 0; i < 4; i++)
2253     {
2254     sprintf(CS bptr, "%d.", x & 255);
2255     while (*bptr) bptr++;
2256     x >>= 8;
2257     }
2258   }
2259
2260 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
2261 in any DNS black lists, and the format in which they will be looked up is
2262 unknown. This is just a guess. */
2263
2264 #if HAVE_IPV6
2265 else
2266   {
2267   int i, j;
2268   for (j = 3; j >= 0; j--)
2269     {
2270     int x = bin[j];
2271     for (i = 0; i < 8; i++)
2272       {
2273       sprintf(CS bptr, "%x.", x & 15);
2274       while (*bptr) bptr++;
2275       x >>= 4;
2276       }
2277     }
2278   }
2279 #endif
2280 }
2281
2282
2283
2284 /*************************************************
2285 *          Perform a single dnsbl lookup         *
2286 *************************************************/
2287
2288 /* This function is called from verify_check_dnsbl() below.
2289
2290 Arguments:
2291   domain         the outer dnsbl domain (for debug message)
2292   keydomain      the current keydomain (for debug message)
2293   query          the domain to be looked up
2294   iplist         the list of matching IP addresses
2295   bitmask        true if bitmask matching is wanted
2296   invert_result  true if result to be inverted
2297   defer_return   what to return for a defer
2298
2299 Returns:         OK if lookup succeeded
2300                  FAIL if not
2301 */
2302
2303 static int
2304 one_check_dnsbl(uschar *domain, uschar *keydomain, uschar *query,
2305   uschar *iplist, BOOL bitmask, BOOL invert_result, int defer_return)
2306 {
2307 dns_answer dnsa;
2308 dns_scan dnss;
2309 tree_node *t;
2310 dnsbl_cache_block *cb;
2311 int old_pool = store_pool;
2312
2313 /* Look for this query in the cache. */
2314
2315 t = tree_search(dnsbl_cache, query);
2316
2317 /* If not cached from a previous lookup, we must do a DNS lookup, and
2318 cache the result in permanent memory. */
2319
2320 if (t == NULL)
2321   {
2322   store_pool = POOL_PERM;
2323
2324   /* Set up a tree entry to cache the lookup */
2325
2326   t = store_get(sizeof(tree_node) + Ustrlen(query));
2327   Ustrcpy(t->name, query);
2328   t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
2329   (void)tree_insertnode(&dnsbl_cache, t);
2330
2331   /* Do the DNS loopup . */
2332
2333   HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
2334   cb->rc = dns_basic_lookup(&dnsa, query, T_A);
2335   cb->text_set = FALSE;
2336   cb->text = NULL;
2337   cb->rhs = NULL;
2338
2339   /* If the lookup succeeded, cache the RHS address. The code allows for
2340   more than one address - this was for complete generality and the possible
2341   use of A6 records. However, A6 records have been reduced to experimental
2342   status (August 2001) and may die out. So they may never get used at all,
2343   let alone in dnsbl records. However, leave the code here, just in case.
2344
2345   Quite apart from one A6 RR generating multiple addresses, there are DNS
2346   lists that return more than one A record, so we must handle multiple
2347   addresses generated in that way as well. */
2348
2349   if (cb->rc == DNS_SUCCEED)
2350     {
2351     dns_record *rr;
2352     dns_address **addrp = &(cb->rhs);
2353     for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2354          rr != NULL;
2355          rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2356       {
2357       if (rr->type == T_A)
2358         {
2359         dns_address *da = dns_address_from_rr(&dnsa, rr);
2360         if (da != NULL)
2361           {
2362           *addrp = da;
2363           while (da->next != NULL) da = da->next;
2364           addrp = &(da->next);
2365           }
2366         }
2367       }
2368
2369     /* If we didn't find any A records, change the return code. This can
2370     happen when there is a CNAME record but there are no A records for what
2371     it points to. */
2372
2373     if (cb->rhs == NULL) cb->rc = DNS_NODATA;
2374     }
2375
2376   store_pool = old_pool;
2377   }
2378
2379 /* Previous lookup was cached */
2380
2381 else
2382   {
2383   HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
2384   cb = t->data.ptr;
2385   }
2386
2387 /* We now have the result of the DNS lookup, either newly done, or cached
2388 from a previous call. If the lookup succeeded, check against the address
2389 list if there is one. This may be a positive equality list (introduced by
2390 "="), a negative equality list (introduced by "!="), a positive bitmask
2391 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
2392
2393 if (cb->rc == DNS_SUCCEED)
2394   {
2395   dns_address *da = NULL;
2396   uschar *addlist = cb->rhs->address;
2397
2398   /* For A and AAAA records, there may be multiple addresses from multiple
2399   records. For A6 records (currently not expected to be used) there may be
2400   multiple addresses from a single record. */
2401
2402   for (da = cb->rhs->next; da != NULL; da = da->next)
2403     addlist = string_sprintf("%s, %s", addlist, da->address);
2404
2405   HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
2406     query, addlist);
2407
2408   /* Address list check; this can be either for equality, or via a bitmask.
2409   In the latter case, all the bits must match. */
2410
2411   if (iplist != NULL)
2412     {
2413     int ipsep = ',';
2414     uschar ip[46];
2415     uschar *ptr = iplist;
2416
2417     while (string_nextinlist(&ptr, &ipsep, ip, sizeof(ip)) != NULL)
2418       {
2419       /* Handle exact matching */
2420       if (!bitmask)
2421         {
2422         for (da = cb->rhs; da != NULL; da = da->next)
2423           {
2424           if (Ustrcmp(CS da->address, ip) == 0) break;
2425           }
2426         }
2427       /* Handle bitmask matching */
2428       else
2429         {
2430         int address[4];
2431         int mask = 0;
2432
2433         /* At present, all known DNS blocking lists use A records, with
2434         IPv4 addresses on the RHS encoding the information they return. I
2435         wonder if this will linger on as the last vestige of IPv4 when IPv6
2436         is ubiquitous? Anyway, for now we use paranoia code to completely
2437         ignore IPv6 addresses. The default mask is 0, which always matches.
2438         We change this only for IPv4 addresses in the list. */
2439
2440         if (host_aton(ip, address) == 1) mask = address[0];
2441
2442         /* Scan the returned addresses, skipping any that are IPv6 */
2443
2444         for (da = cb->rhs; da != NULL; da = da->next)
2445           {
2446           if (host_aton(da->address, address) != 1) continue;
2447           if ((address[0] & mask) == mask) break;
2448           }
2449         }
2450
2451       /* Break out if a match has been found */
2452
2453       if (da != NULL) break;
2454       }
2455
2456     /* If either
2457
2458        (a) No IP address in a positive list matched, or
2459        (b) An IP address in a negative list did match
2460
2461     then behave as if the DNSBL lookup had not succeeded, i.e. the host is
2462     not on the list. */
2463
2464     if (invert_result != (da == NULL))
2465       {
2466       HDEBUG(D_dnsbl)
2467         {
2468         debug_printf("=> but we are not accepting this block class because\n");
2469         debug_printf("=> there was %s match for %c%s\n",
2470           invert_result? "an exclude":"no", bitmask? '&' : '=', iplist);
2471         }
2472       return FAIL;
2473       }
2474     }
2475
2476   /* Either there was no IP list, or the record matched. Look up a TXT record
2477   if it hasn't previously been done. */
2478
2479   if (!cb->text_set)
2480     {
2481     cb->text_set = TRUE;
2482     if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
2483       {
2484       dns_record *rr;
2485       for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2486            rr != NULL;
2487            rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2488         if (rr->type == T_TXT) break;
2489       if (rr != NULL)
2490         {
2491         int len = (rr->data)[0];
2492         if (len > 511) len = 127;
2493         store_pool = POOL_PERM;
2494         cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
2495         store_pool = old_pool;
2496         }
2497       }
2498     }
2499
2500   dnslist_value = addlist;
2501   dnslist_text = cb->text;
2502   return OK;
2503   }
2504
2505 /* There was a problem with the DNS lookup */
2506
2507 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
2508   {
2509   log_write(L_dnslist_defer, LOG_MAIN,
2510     "DNS list lookup defer (probably timeout) for %s: %s", query,
2511     (defer_return == OK)?   US"assumed in list" :
2512     (defer_return == FAIL)? US"assumed not in list" :
2513                             US"returned DEFER");
2514   return defer_return;
2515   }
2516
2517 /* No entry was found in the DNS; continue for next domain */
2518
2519 HDEBUG(D_dnsbl)
2520   {
2521   debug_printf("DNS lookup for %s failed\n", query);
2522   debug_printf("=> that means %s is not listed at %s\n",
2523      keydomain, domain);
2524   }
2525
2526 return FAIL;
2527 }
2528
2529
2530
2531
2532 /*************************************************
2533 *        Check host against DNS black lists      *
2534 *************************************************/
2535
2536 /* This function runs checks against a list of DNS black lists, until one
2537 matches. Each item on the list can be of the form
2538
2539   domain=ip-address/key
2540
2541 The domain is the right-most domain that is used for the query, for example,
2542 blackholes.mail-abuse.org. If the IP address is present, there is a match only
2543 if the DNS lookup returns a matching IP address. Several addresses may be
2544 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
2545
2546 If no key is given, what is looked up in the domain is the inverted IP address
2547 of the current client host. If a key is given, it is used to construct the
2548 domain for the lookup. For example,
2549
2550   dsn.rfc-ignorant.org/$sender_address_domain
2551
2552 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
2553 then we check for a TXT record for an error message, and if found, save its
2554 value in $dnslist_text. We also cache everything in a tree, to optimize
2555 multiple lookups.
2556
2557 Note: an address for testing RBL is 192.203.178.39
2558 Note: an address for testing DUL is 192.203.178.4
2559 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
2560
2561 Arguments:
2562   listptr      the domain/address/data list
2563
2564 Returns:    OK      successful lookup (i.e. the address is on the list), or
2565                       lookup deferred after +include_unknown
2566             FAIL    name not found, or no data found for the given type, or
2567                       lookup deferred after +exclude_unknown (default)
2568             DEFER   lookup failure, if +defer_unknown was set
2569 */
2570
2571 int
2572 verify_check_dnsbl(uschar **listptr)
2573 {
2574 int sep = 0;
2575 int defer_return = FAIL;
2576 BOOL invert_result = FALSE;
2577 uschar *list = *listptr;
2578 uschar *domain;
2579 uschar *s;
2580 uschar buffer[1024];
2581 uschar query[256];         /* DNS domain max length */
2582 uschar revadd[128];        /* Long enough for IPv6 address */
2583
2584 /* Indicate that the inverted IP address is not yet set up */
2585
2586 revadd[0] = 0;
2587
2588 /* In case this is the first time the DNS resolver is being used. */
2589
2590 dns_init(FALSE, FALSE);
2591
2592 /* Loop through all the domains supplied, until something matches */
2593
2594 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
2595   {
2596   int rc;
2597   BOOL frc;
2598   BOOL bitmask = FALSE;
2599   uschar *iplist;
2600   uschar *key;
2601
2602   HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
2603
2604   /* Deal with special values that change the behaviour on defer */
2605
2606   if (domain[0] == '+')
2607     {
2608     if      (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
2609     else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
2610     else if (strcmpic(domain, US"+defer_unknown") == 0)   defer_return = DEFER;
2611     else
2612       log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
2613         domain);
2614     continue;
2615     }
2616
2617   /* See if there's explicit data to be looked up */
2618
2619   key = Ustrchr(domain, '/');
2620   if (key != NULL) *key++ = 0;
2621
2622   /* See if there's a list of addresses supplied after the domain name. This is
2623   introduced by an = or a & character; if preceded by ! we invert the result.
2624   */
2625
2626   iplist = Ustrchr(domain, '=');
2627   if (iplist == NULL)
2628     {
2629     bitmask = TRUE;
2630     iplist = Ustrchr(domain, '&');
2631     }
2632
2633   if (iplist != NULL)
2634     {
2635     if (iplist > domain && iplist[-1] == '!')
2636       {
2637       invert_result = TRUE;
2638       iplist[-1] = 0;
2639       }
2640     *iplist++ = 0;
2641     }
2642
2643   /* Check that what we have left is a sensible domain name. There is no reason
2644   why these domains should in fact use the same syntax as hosts and email
2645   domains, but in practice they seem to. However, there is little point in
2646   actually causing an error here, because that would no doubt hold up incoming
2647   mail. Instead, I'll just log it. */
2648
2649   for (s = domain; *s != 0; s++)
2650     {
2651     if (!isalnum(*s) && *s != '-' && *s != '.')
2652       {
2653       log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
2654         "strange characters - is this right?", domain);
2655       break;
2656       }
2657     }
2658
2659   /* If there is no key string, construct the query by adding the domain name
2660   onto the inverted host address, and perform a single DNS lookup. */
2661
2662   if (key == NULL)
2663     {
2664     if (sender_host_address == NULL) return FAIL;    /* can never match */
2665     if (revadd[0] == 0) invert_address(revadd, sender_host_address);
2666     frc = string_format(query, sizeof(query), "%s%s", revadd, domain);
2667
2668     if (!frc)
2669       {
2670       log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2671         "(ignored): %s...", query);
2672       continue;
2673       }
2674
2675     rc = one_check_dnsbl(domain, sender_host_address, query, iplist, bitmask,
2676       invert_result, defer_return);
2677
2678     if (rc == OK)
2679       {
2680       dnslist_domain = string_copy(domain);
2681       HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
2682         sender_host_address, domain);
2683       }
2684
2685     if (rc != FAIL) return rc;     /* OK or DEFER */
2686     }
2687
2688   /* If there is a key string, it can be a list of domains or IP addresses to
2689   be concatenated with the main domain. */
2690
2691   else
2692     {
2693     int keysep = 0;
2694     BOOL defer = FALSE;
2695     uschar *keydomain;
2696     uschar keybuffer[256];
2697
2698     while ((keydomain = string_nextinlist(&key, &keysep, keybuffer,
2699             sizeof(keybuffer))) != NULL)
2700       {
2701       if (string_is_ip_address(keydomain, NULL) > 0)
2702         {
2703         uschar keyrevadd[128];
2704         invert_address(keyrevadd, keydomain);
2705         frc = string_format(query, sizeof(query), "%s%s", keyrevadd, domain);
2706         }
2707       else
2708         {
2709         frc = string_format(query, sizeof(query), "%s.%s", keydomain, domain);
2710         }
2711
2712       if (!frc)
2713         {
2714         log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2715           "(ignored): %s...", query);
2716         continue;
2717         }
2718
2719       rc = one_check_dnsbl(domain, keydomain, query, iplist, bitmask,
2720         invert_result, defer_return);
2721
2722       if (rc == OK)
2723         {
2724         dnslist_domain = string_copy(domain);
2725         HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
2726           keydomain, domain);
2727         return OK;
2728         }
2729
2730       /* If the lookup deferred, remember this fact. We keep trying the rest
2731       of the list to see if we get a useful result, and if we don't, we return
2732       DEFER at the end. */
2733
2734       if (rc == DEFER) defer = TRUE;
2735       }    /* continue with next keystring domain/address */
2736
2737     if (defer) return DEFER;
2738     }
2739   }        /* continue with next dnsdb outer domain */
2740
2741 return FAIL;
2742 }
2743
2744 /* End of verify.c */