Split out callout-cache handling from do_callout()
[exim.git] / src / src / verify.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
80fea873 5/* Copyright (c) University of Cambridge 1995 - 2016 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* Functions concerned with verifying things. The original code for callout
9caching was contributed by Kevin Fleming (but I hacked it around a bit). */
10
11
12#include "exim.h"
817d9f57 13#include "transports/smtp.h"
059ec3d9 14
e4bdf652
JH
15#define CUTTHROUGH_CMD_TIMEOUT 30 /* timeout for cutthrough-routing calls */
16#define CUTTHROUGH_DATA_TIMEOUT 60 /* timeout for cutthrough-routing calls */
817d9f57
JH
17static smtp_outblock ctblock;
18uschar ctbuffer[8192];
19
059ec3d9
PH
20
21/* Structure for caching DNSBL lookups */
22
23typedef struct dnsbl_cache_block {
14b3c5bc 24 time_t expiry;
059ec3d9
PH
25 dns_address *rhs;
26 uschar *text;
27 int rc;
28 BOOL text_set;
29} dnsbl_cache_block;
30
31
32/* Anchor for DNSBL cache */
33
34static tree_node *dnsbl_cache = NULL;
35
36
431b7361
PH
37/* Bits for match_type in one_check_dnsbl() */
38
39#define MT_NOT 1
40#define MT_ALL 2
41
2760b518 42static uschar cutthrough_response(char, uschar **, int);
431b7361 43
8d330698 44
059ec3d9
PH
45
46/*************************************************
47* Retrieve a callout cache record *
48*************************************************/
49
50/* If a record exists, check whether it has expired.
51
52Arguments:
53 dbm_file an open hints file
54 key the record key
55 type "address" or "domain"
56 positive_expire expire time for positive records
57 negative_expire expire time for negative records
58
59Returns: the cache record if a non-expired one exists, else NULL
60*/
61
62static dbdata_callout_cache *
55414b25 63get_callout_cache_record(open_db *dbm_file, const uschar *key, uschar *type,
059ec3d9
PH
64 int positive_expire, int negative_expire)
65{
66BOOL negative;
67int length, expire;
68time_t now;
69dbdata_callout_cache *cache_record;
70
71cache_record = dbfn_read_with_length(dbm_file, key, &length);
72
73if (cache_record == NULL)
74 {
6f4d5ad3 75 HDEBUG(D_verify) debug_printf("callout cache: no %s record found for %s\n", type, key);
059ec3d9
PH
76 return NULL;
77 }
78
79/* We treat a record as "negative" if its result field is not positive, or if
80it is a domain record and the postmaster field is negative. */
81
82negative = cache_record->result != ccache_accept ||
83 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
84expire = negative? negative_expire : positive_expire;
85now = time(NULL);
86
87if (now - cache_record->time_stamp > expire)
88 {
6f4d5ad3 89 HDEBUG(D_verify) debug_printf("callout cache: %s record expired for %s\n", type, key);
059ec3d9
PH
90 return NULL;
91 }
92
93/* If this is a non-reject domain record, check for the obsolete format version
94that doesn't have the postmaster and random timestamps, by looking at the
95length. If so, copy it to a new-style block, replicating the record's
96timestamp. Then check the additional timestamps. (There's no point wasting
97effort if connections are rejected.) */
98
99if (type[0] == 'd' && cache_record->result != ccache_reject)
100 {
101 if (length == sizeof(dbdata_callout_cache_obs))
102 {
103 dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache));
104 memcpy(new, cache_record, length);
105 new->postmaster_stamp = new->random_stamp = new->time_stamp;
106 cache_record = new;
107 }
108
109 if (now - cache_record->postmaster_stamp > expire)
110 cache_record->postmaster_result = ccache_unknown;
111
112 if (now - cache_record->random_stamp > expire)
113 cache_record->random_result = ccache_unknown;
114 }
115
6f4d5ad3 116HDEBUG(D_verify) debug_printf("callout cache: found %s record for %s\n", type, key);
059ec3d9
PH
117return cache_record;
118}
119
120
121
707ee5b1
JH
122/* Check the callout cache.
123Options * pm_mailfrom may be modified by cache partial results.
059ec3d9 124
707ee5b1 125Return: TRUE if result found
059ec3d9
PH
126*/
127
707ee5b1
JH
128static BOOL
129cached_callout_lookup(address_item * addr, uschar * address_key,
130 uschar * from_address, int * opt_ptr, uschar ** pm_ptr,
131 int * yield, uschar ** failure_ptr,
132 dbdata_callout_cache * new_domain_record, int * old_domain_res)
059ec3d9 133{
707ee5b1 134int options = *opt_ptr;
059ec3d9
PH
135open_db dbblock;
136open_db *dbm_file = NULL;
059ec3d9
PH
137
138/* Open the callout cache database, it it exists, for reading only at this
139stage, unless caching has been disabled. */
140
8b9476ba 141if (options & vopt_callout_no_cache)
059ec3d9
PH
142 {
143 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
144 }
707ee5b1 145else if (!(dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)))
059ec3d9
PH
146 {
147 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
148 }
707ee5b1 149else
059ec3d9 150 {
707ee5b1
JH
151 /* If a cache database is available see if we can avoid the need to do an
152 actual callout by making use of previously-obtained data. */
153
154 dbdata_callout_cache_address * cache_address_record;
155 dbdata_callout_cache * cache_record = get_callout_cache_record(dbm_file,
156 addr->domain, US"domain",
157 callout_cache_domain_positive_expire, callout_cache_domain_negative_expire);
059ec3d9
PH
158
159 /* If an unexpired cache record was found for this domain, see if the callout
160 process can be short-circuited. */
161
ff5929e3 162 if (cache_record)
059ec3d9 163 {
2b1c6e3a
PH
164 /* In most cases, if an early command (up to and including MAIL FROM:<>)
165 was rejected, there is no point carrying on. The callout fails. However, if
166 we are doing a recipient verification with use_sender or use_postmaster
167 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
168 will be using a non-empty sender. We have to remember this situation so as
169 not to disturb the cached domain value if this whole verification succeeds
170 (we don't want it turning into "accept"). */
171
707ee5b1 172 *old_domain_res = cache_record->result;
2b1c6e3a 173
707ee5b1
JH
174 if ( cache_record->result == ccache_reject
175 || *from_address == 0 && cache_record->result == ccache_reject_mfnull)
059ec3d9
PH
176 {
177 setflag(addr, af_verify_nsfail);
178 HDEBUG(D_verify)
707ee5b1
JH
179 debug_printf("callout cache: domain gave initial rejection, or "
180 "does not accept HELO or MAIL FROM:<>\n");
059ec3d9
PH
181 setflag(addr, af_verify_nsfail);
182 addr->user_message = US"(result of an earlier callout reused).";
707ee5b1 183 *yield = FAIL;
8e669ac1 184 *failure_ptr = US"mail";
707ee5b1
JH
185 dbfn_close(dbm_file);
186 return TRUE;
059ec3d9
PH
187 }
188
189 /* If a previous check on a "random" local part was accepted, we assume
190 that the server does not do any checking on local parts. There is therefore
191 no point in doing the callout, because it will always be successful. If a
192 random check previously failed, arrange not to do it again, but preserve
193 the data in the new record. If a random check is required but hasn't been
194 done, skip the remaining cache processing. */
195
8b9476ba 196 if (options & vopt_callout_random) switch(cache_record->random_result)
059ec3d9
PH
197 {
198 case ccache_accept:
8b9476ba
JH
199 HDEBUG(D_verify)
200 debug_printf("callout cache: domain accepts random addresses\n");
707ee5b1
JH
201 dbfn_close(dbm_file);
202 return TRUE; /* Default yield is OK */
059ec3d9
PH
203
204 case ccache_reject:
8b9476ba
JH
205 HDEBUG(D_verify)
206 debug_printf("callout cache: domain rejects random addresses\n");
707ee5b1
JH
207 *opt_ptr = options & ~vopt_callout_random;
208 new_domain_record->random_result = ccache_reject;
209 new_domain_record->random_stamp = cache_record->random_stamp;
8b9476ba 210 break;
059ec3d9
PH
211
212 default:
8b9476ba
JH
213 HDEBUG(D_verify)
214 debug_printf("callout cache: need to check random address handling "
215 "(not cached or cache expired)\n");
707ee5b1
JH
216 dbfn_close(dbm_file);
217 return FALSE;
059ec3d9
PH
218 }
219
220 /* If a postmaster check is requested, but there was a previous failure,
221 there is again no point in carrying on. If a postmaster check is required,
222 but has not been done before, we are going to have to do a callout, so skip
223 remaining cache processing. */
224
707ee5b1 225 if (*pm_ptr)
059ec3d9
PH
226 {
227 if (cache_record->postmaster_result == ccache_reject)
707ee5b1
JH
228 {
229 setflag(addr, af_verify_pmfail);
230 HDEBUG(D_verify)
231 debug_printf("callout cache: domain does not accept "
232 "RCPT TO:<postmaster@domain>\n");
233 *yield = FAIL;
234 *failure_ptr = US"postmaster";
235 setflag(addr, af_verify_pmfail);
236 addr->user_message = US"(result of earlier verification reused).";
237 dbfn_close(dbm_file);
238 return TRUE;
239 }
059ec3d9 240 if (cache_record->postmaster_result == ccache_unknown)
707ee5b1
JH
241 {
242 HDEBUG(D_verify)
243 debug_printf("callout cache: need to check RCPT "
244 "TO:<postmaster@domain> (not cached or cache expired)\n");
245 dbfn_close(dbm_file);
246 return FALSE;
247 }
059ec3d9
PH
248
249 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
250 postmaster check if the address itself has to be checked. Also ensure
251 that the value in the cache record is preserved (with its old timestamp).
252 */
253
254 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
707ee5b1
JH
255 "TO:<postmaster@domain>\n");
256 *pm_ptr = NULL;
257 new_domain_record->postmaster_result = ccache_accept;
258 new_domain_record->postmaster_stamp = cache_record->postmaster_stamp;
059ec3d9
PH
259 }
260 }
261
262 /* We can't give a result based on information about the domain. See if there
263 is an unexpired cache record for this specific address (combined with the
264 sender address if we are doing a recipient callout with a non-empty sender).
265 */
266
707ee5b1
JH
267 if (!(cache_address_record = (dbdata_callout_cache_address *)
268 get_callout_cache_record(dbm_file, address_key, US"address",
269 callout_cache_positive_expire, callout_cache_negative_expire)))
270 {
271 dbfn_close(dbm_file);
272 return FALSE;
273 }
059ec3d9 274
707ee5b1 275 if (cache_address_record->result == ccache_accept)
059ec3d9 276 {
707ee5b1
JH
277 HDEBUG(D_verify)
278 debug_printf("callout cache: address record is positive\n");
279 }
280 else
281 {
282 HDEBUG(D_verify)
283 debug_printf("callout cache: address record is negative\n");
284 addr->user_message = US"Previous (cached) callout verification failure";
285 *failure_ptr = US"recipient";
286 *yield = FAIL;
059ec3d9
PH
287 }
288
289 /* Close the cache database while we actually do the callout for real. */
290
059ec3d9 291 dbfn_close(dbm_file);
707ee5b1
JH
292 return TRUE;
293 }
294return FALSE;
295}
296
297
298/* Write results to callout cache
299*/
300static void
301cache_callout_write(dbdata_callout_cache * dom_rec, const uschar * domain,
302 int done, dbdata_callout_cache_address * addr_rec, uschar * address_key)
303{
304open_db dbblock;
305open_db *dbm_file = NULL;
306
307/* If we get here with done == TRUE, a successful callout happened, and yield
308will be set OK or FAIL according to the response to the RCPT command.
309Otherwise, we looped through the hosts but couldn't complete the business.
310However, there may be domain-specific information to cache in both cases.
311
312The value of the result field in the new_domain record is ccache_unknown if
313there was an error before or with MAIL FROM:, and errno was not zero,
314implying some kind of I/O error. We don't want to write the cache in that case.
315Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
316
317if (dom_rec->result != ccache_unknown)
318 if (!(dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE)))
319 {
320 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
321 }
322 else
323 {
324 (void)dbfn_write(dbm_file, domain, dom_rec,
325 (int)sizeof(dbdata_callout_cache));
326 HDEBUG(D_verify) debug_printf("wrote callout cache domain record for %s:\n"
327 " result=%d postmaster=%d random=%d\n",
328 domain,
329 dom_rec->result,
330 dom_rec->postmaster_result,
331 dom_rec->random_result);
332 }
333
334/* If a definite result was obtained for the callout, cache it unless caching
335is disabled. */
336
337if (done && addr_rec->result != ccache_unknown)
338 {
339 if (!dbm_file)
340 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
341 if (!dbm_file)
342 {
343 HDEBUG(D_verify) debug_printf("no callout cache available\n");
344 }
345 else
346 {
347 (void)dbfn_write(dbm_file, address_key, addr_rec,
348 (int)sizeof(dbdata_callout_cache_address));
349 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record for %s\n",
350 addr_rec->result == ccache_accept ? "positive" : "negative",
351 address_key);
352 }
353 }
354
355if (dbm_file) dbfn_close(dbm_file);
356}
357
358
359/*************************************************
360* Do callout verification for an address *
361*************************************************/
362
363/* This function is called from verify_address() when the address has routed to
364a host list, and a callout has been requested. Callouts are expensive; that is
365why a cache is used to improve the efficiency.
366
367Arguments:
368 addr the address that's been routed
369 host_list the list of hosts to try
370 tf the transport feedback block
371
372 ifstring "interface" option from transport, or NULL
373 portstring "port" option from transport, or NULL
374 protocolstring "protocol" option from transport, or NULL
375 callout the per-command callout timeout
376 callout_overall the overall callout timeout (if < 0 use 4*callout)
377 callout_connect the callout connection timeout (if < 0 use callout)
378 options the verification options - these bits are used:
379 vopt_is_recipient => this is a recipient address
380 vopt_callout_no_cache => don't use callout cache
381 vopt_callout_fullpm => if postmaster check, do full one
382 vopt_callout_random => do the "random" thing
383 vopt_callout_recipsender => use real sender for recipient
384 vopt_callout_recippmaster => use postmaster for recipient
385 se_mailfrom MAIL FROM address for sender verify; NULL => ""
386 pm_mailfrom if non-NULL, do the postmaster check with this sender
387
388Returns: OK/FAIL/DEFER
389*/
390
391static int
392do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
393 int callout, int callout_overall, int callout_connect, int options,
394 uschar *se_mailfrom, uschar *pm_mailfrom)
395{
396int yield = OK;
397int old_domain_cache_result = ccache_accept;
398BOOL done = FALSE;
399uschar *address_key;
400uschar *from_address;
401uschar *random_local_part = NULL;
402const uschar *save_deliver_domain = deliver_domain;
403uschar **failure_ptr = options & vopt_is_recipient
404 ? &recipient_verify_failure : &sender_verify_failure;
405dbdata_callout_cache new_domain_record;
406dbdata_callout_cache_address new_address_record;
407host_item *host;
408time_t callout_start_time;
409
410new_domain_record.result = ccache_unknown;
411new_domain_record.postmaster_result = ccache_unknown;
412new_domain_record.random_result = ccache_unknown;
413
414memset(&new_address_record, 0, sizeof(new_address_record));
415
416/* For a recipient callout, the key used for the address cache record must
417include the sender address if we are using the real sender in the callout,
418because that may influence the result of the callout. */
419
420if (options & vopt_is_recipient)
421 if (options & vopt_callout_recipsender)
422 {
423 from_address = sender_address;
424 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
425 if (cutthrough.delivery) options |= vopt_callout_no_cache;
426 }
427 else if (options & vopt_callout_recippmaster)
428 {
429 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
430 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
431 qualify_domain_sender);
432 }
433 else
434 {
435 from_address = US"";
436 address_key = addr->address;
437 }
438
439/* For a sender callout, we must adjust the key if the mailfrom address is not
440empty. */
441
442else
443 {
444 from_address = se_mailfrom ? se_mailfrom : US"";
445 address_key = *from_address
446 ? string_sprintf("%s/<%s>", addr->address, from_address) : addr->address;
059ec3d9
PH
447 }
448
707ee5b1
JH
449if (cached_callout_lookup(addr, address_key, from_address,
450 &options, &pm_mailfrom, &yield, failure_ptr,
451 &new_domain_record, &old_domain_cache_result))
452 goto END_CALLOUT;
453
193e3acd 454if (!addr->transport)
059ec3d9 455 {
193e3acd 456 HDEBUG(D_verify) debug_printf("cannot callout via null transport\n");
059ec3d9 457 }
6681531a
HSHR
458else if (Ustrcmp(addr->transport->driver_name, "smtp") != 0)
459 log_write(0, LOG_MAIN|LOG_PANIC|LOG_CONFIG_FOR, "callout transport '%s': %s is non-smtp",
460 addr->transport->name, addr->transport->driver_name);
193e3acd
JH
461else
462 {
463 smtp_transport_options_block *ob =
9d9c3746 464 (smtp_transport_options_block *)addr->transport->options_block;
059ec3d9 465
193e3acd
JH
466 /* The information wasn't available in the cache, so we have to do a real
467 callout and save the result in the cache for next time, unless no_cache is set,
468 or unless we have a previously cached negative random result. If we are to test
469 with a random local part, ensure that such a local part is available. If not,
4c04137d 470 log the fact, but carry on without randomising. */
059ec3d9 471
707ee5b1 472 if (options & vopt_callout_random && callout_random_local_part)
65f1c92a 473 if (!(random_local_part = expand_string(callout_random_local_part)))
193e3acd
JH
474 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
475 "callout_random_local_part: %s", expand_string_message);
059ec3d9 476
193e3acd
JH
477 /* Default the connect and overall callout timeouts if not set, and record the
478 time we are starting so that we can enforce it. */
4c590bd1 479
193e3acd
JH
480 if (callout_overall < 0) callout_overall = 4 * callout;
481 if (callout_connect < 0) callout_connect = callout;
482 callout_start_time = time(NULL);
4c590bd1 483
193e3acd
JH
484 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
485 output because a callout might take some time. When PIPELINING is active and
486 there are many recipients, the total time for doing lots of callouts can add up
487 and cause the client to time out. So in this case we forgo the PIPELINING
488 optimization. */
817d9f57 489
ff5929e3 490 if (smtp_out && !disable_callout_flush) mac_smtp_fflush();
059ec3d9 491
5032d1cf
JH
492/* cutthrough-multi: if a nonfirst rcpt has the same routing as the first,
493and we are holding a cutthrough conn open, we can just append the rcpt to
494that conn for verification purposes (and later delivery also). Simplest
495coding means skipping this whole loop and doing the append separately.
496
497We will need to remember it has been appended so that rcpt-acl tail code
498can do it there for the non-rcpt-verify case. For this we keep an addresscount.
499*/
500
501 /* Can we re-use an open cutthrough connection? */
502 if ( cutthrough.fd >= 0
503 && (options & (vopt_callout_recipsender | vopt_callout_recippmaster))
504 == vopt_callout_recipsender
505 && !random_local_part
506 && !pm_mailfrom
507 )
508 {
509 if (addr->transport == cutthrough.addr.transport)
510 for (host = host_list; host; host = host->next)
511 if (Ustrcmp(host->address, cutthrough.host.address) == 0)
512 {
513 int host_af;
514 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
515 int port = 25;
516
517 deliver_host = host->name;
518 deliver_host_address = host->address;
519 deliver_host_port = host->port;
520 deliver_domain = addr->domain;
521 transport_name = addr->transport->name;
522
523 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
524
6f6dedcc 525 if (!smtp_get_interface(tf->interface, host_af, addr, &interface,
5032d1cf
JH
526 US"callout") ||
527 !smtp_get_port(tf->port, addr, &port, US"callout"))
528 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
529 addr->message);
530
531 if ( ( interface == cutthrough.interface
532 || ( interface
533 && cutthrough.interface
534 && Ustrcmp(interface, cutthrough.interface) == 0
535 ) )
536 && port == cutthrough.host.port
537 )
538 {
806c3df9 539 uschar * resp = NULL;
5032d1cf
JH
540
541 /* Match! Send the RCPT TO, append the addr, set done */
542 done =
543 smtp_write_command(&ctblock, FALSE, "RCPT TO:<%.1000s>\r\n",
544 transport_rcpt_address(addr,
545 (addr->transport == NULL)? FALSE :
546 addr->transport->rcpt_include_affixes)) >= 0 &&
2760b518 547 cutthrough_response('2', &resp, CUTTHROUGH_DATA_TIMEOUT) == '2';
5032d1cf
JH
548
549 /* This would go horribly wrong if a callout fail was ignored by ACL.
550 We punt by abandoning cutthrough on a reject, like the
551 first-rcpt does. */
552
553 if (done)
554 {
555 address_item * na = store_get(sizeof(address_item));
556 *na = cutthrough.addr;
557 cutthrough.addr = *addr;
558 cutthrough.addr.host_used = &cutthrough.host;
559 cutthrough.addr.next = na;
560
561 cutthrough.nrcpt++;
562 }
563 else
564 {
565 cancel_cutthrough_connection("recipient rejected");
806c3df9 566 if (!resp || errno == ETIMEDOUT)
5032d1cf
JH
567 {
568 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
569 }
570 else if (errno == 0)
571 {
572 if (*resp == 0)
573 Ustrcpy(resp, US"connection dropped");
574
575 addr->message =
576 string_sprintf("response to \"%s\" from %s [%s] was: %s",
577 big_buffer, host->name, host->address,
578 string_printing(resp));
579
580 addr->user_message =
581 string_sprintf("Callout verification failed:\n%s", resp);
582
583 /* Hard rejection ends the process */
584
585 if (resp[0] == '5') /* Address rejected */
586 {
587 yield = FAIL;
588 done = TRUE;
589 }
590 }
591 }
592 }
02b41d71 593 break; /* host_list */
5032d1cf
JH
594 }
595 if (!done)
596 cancel_cutthrough_connection("incompatible connection");
597 }
598
193e3acd
JH
599 /* Now make connections to the hosts and do real callouts. The list of hosts
600 is passed in as an argument. */
059ec3d9 601
ff5929e3 602 for (host = host_list; host && !done; host = host->next)
059ec3d9 603 {
193e3acd
JH
604 int host_af;
605 int port = 25;
193e3acd 606 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
02b41d71 607 smtp_context sx;
193e3acd
JH
608 uschar responsebuffer[4096];
609
610 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
611 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
612
613 /* Skip this host if we don't have an IP address for it. */
614
ff5929e3 615 if (!host->address)
193e3acd
JH
616 {
617 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
618 host->name);
619 continue;
620 }
059ec3d9 621
193e3acd 622 /* Check the overall callout timeout */
059ec3d9 623
193e3acd
JH
624 if (time(NULL) - callout_start_time >= callout_overall)
625 {
626 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
627 break;
628 }
059ec3d9 629
193e3acd 630 /* Set IPv4 or IPv6 */
059ec3d9 631
ff5929e3 632 host_af = Ustrchr(host->address, ':') == NULL ? AF_INET : AF_INET6;
de3a88fb 633
193e3acd
JH
634 /* Expand and interpret the interface and port strings. The latter will not
635 be used if there is a host-specific port (e.g. from a manualroute router).
636 This has to be delayed till now, because they may expand differently for
637 different hosts. If there's a failure, log it, but carry on with the
638 defaults. */
de3a88fb 639
193e3acd
JH
640 deliver_host = host->name;
641 deliver_host_address = host->address;
a7538db1 642 deliver_host_port = host->port;
193e3acd 643 deliver_domain = addr->domain;
aec45841 644 transport_name = addr->transport->name;
059ec3d9 645
6f6dedcc 646 if ( !smtp_get_interface(tf->interface, host_af, addr, &interface,
bf7aabb4
JH
647 US"callout")
648 || !smtp_get_port(tf->port, addr, &port, US"callout")
649 )
193e3acd
JH
650 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
651 addr->message);
059ec3d9 652
02b41d71
JH
653 sx.addrlist = addr;
654 sx.host = host;
655 sx.host_af = host_af,
656 sx.port = port;
657 sx.interface = interface;
658 sx.helo_data = tf->helo_data;
659 sx.tblock = addr->transport;
660
661tls_retry_connection:
662 /* Set the address state so that errors are recorded in it */
663
664 addr->transport_return = PENDING_DEFER;
665 ob->connect_timeout = callout_connect;
666 ob->command_timeout = callout;
667
668 /* Get the channel set up ready for a message (MAIL FROM being the next
669 SMTP command to send. If we tried TLS but it failed, try again without
670 if permitted */
671
672 if ( (yield = smtp_setup_conn(&sx, FALSE, TRUE)) == DEFER
673 && addr->basic_errno == ERRNO_TLSFAILURE
674 && ob->tls_tempfail_tryclear
675 && verify_check_given_host(&ob->hosts_require_tls, host) != OK
676 )
193e3acd 677 {
02b41d71
JH
678 log_write(0, LOG_MAIN, "TLS session failure:"
679 " callout unencrypted to %s [%s] (not in hosts_require_tls)",
680 host->name, host->address);
681 yield = smtp_setup_conn(&sx, TRUE, TRUE);
682 }
683 if (yield != OK)
684 {
685 if (addr->message) addr->message = string_sprintf("%s [%s] %s",
686 host->name, host->address, addr->message);
687 errno = addr->basic_errno;
aec45841 688 transport_name = NULL;
193e3acd
JH
689 deliver_host = deliver_host_address = NULL;
690 deliver_domain = save_deliver_domain;
bf7aabb4 691
02b41d71
JH
692 /* Failure to accept HELO is cached; this blocks the whole domain for all
693 senders. I/O errors and defer responses are not cached. */
770747fd 694
02b41d71 695 if (yield == FAIL && (errno == 0 || errno == ERRNO_SMTPCLOSED))
a7538db1 696 {
02b41d71
JH
697 setflag(addr, af_verify_nsfail);
698 new_domain_record.result = ccache_reject;
699 done = TRUE;
a7538db1 700 }
193e3acd 701 else
02b41d71
JH
702 done = FALSE;
703 goto no_conn;
3c8b3577 704 }
9bfc60eb 705
02b41d71
JH
706 /* If we needed to authenticate, smtp_setup_conn() did that. Copy
707 the AUTH info for logging */
fcc8e047 708
02b41d71
JH
709 addr->authenticator = client_authenticator;
710 addr->auth_id = client_authenticated_id;
b4a2b536 711
fcc8e047 712 /* Build a mail-AUTH string (re-using responsebuffer for convenience */
b4a2b536 713
02b41d71
JH
714 done =
715 !smtp_mail_auth_str(responsebuffer, sizeof(responsebuffer), addr, ob)
716 && (
717 (addr->auth_sndr = client_authenticated_sender),
fcc8e047 718
193e3acd 719 /* Send the MAIL command */
02b41d71
JH
720
721 (smtp_write_command(&sx.outblock, FALSE,
8c5d388a 722#ifdef SUPPORT_I18N
02b41d71
JH
723 addr->prop.utf8_msg && !addr->prop.utf8_downcvt
724 ? "MAIL FROM:<%s>%s%s SMTPUTF8\r\n"
725 :
9bfc60eb 726#endif
02b41d71
JH
727 "MAIL FROM:<%s>%s%s\r\n",
728 from_address,
729 responsebuffer,
730 options & vopt_is_recipient && sx.peer_offered & PEER_OFFERED_SIZE
731 ? string_sprintf(" SIZE=%d", message_size + ob->size_addition)
732 : US""
733
734 ) >= 0)
735 )
2b1c6e3a 736
02b41d71
JH
737 && smtp_read_response(&sx.inblock, responsebuffer, sizeof(responsebuffer),
738 '2', callout);
059ec3d9 739
00bff6f6
JH
740 deliver_host = deliver_host_address = NULL;
741 deliver_domain = save_deliver_domain;
742
193e3acd
JH
743 /* If the host does not accept MAIL FROM:<>, arrange to cache this
744 information, but again, don't record anything for an I/O error or a defer. Do
745 not cache rejections of MAIL when a non-empty sender has been used, because
746 that blocks the whole domain for all senders. */
059ec3d9 747
193e3acd 748 if (!done)
059ec3d9 749 {
193e3acd
JH
750 *failure_ptr = US"mail"; /* At or before MAIL */
751 if (errno == 0 && responsebuffer[0] == '5')
752 {
753 setflag(addr, af_verify_nsfail);
754 if (from_address[0] == 0)
755 new_domain_record.result = ccache_reject_mfnull;
756 }
059ec3d9 757 }
059ec3d9 758
193e3acd
JH
759 /* Otherwise, proceed to check a "random" address (if required), then the
760 given address, and the postmaster address (if required). Between each check,
761 issue RSET, because some servers accept only one recipient after MAIL
762 FROM:<>.
2b1c6e3a 763
193e3acd
JH
764 Before doing this, set the result in the domain cache record to "accept",
765 unless its previous value was ccache_reject_mfnull. In that case, the domain
766 rejects MAIL FROM:<> and we want to continue to remember that. When that is
767 the case, we have got here only in the case of a recipient verification with
768 a non-null sender. */
059ec3d9 769
193e3acd 770 else
059ec3d9 771 {
921dfc11
JH
772 const uschar * rcpt_domain = addr->domain;
773
8c5d388a 774#ifdef SUPPORT_I18N
921dfc11
JH
775 uschar * errstr = NULL;
776 if ( testflag(addr, af_utf8_downcvt)
777 && (rcpt_domain = string_domain_utf8_to_alabel(rcpt_domain,
778 &errstr), errstr)
779 )
780 {
781 addr->message = errstr;
782 errno = ERRNO_EXPANDFAIL;
783 setflag(addr, af_verify_nsfail);
784 done = FALSE;
785 rcpt_domain = US""; /*XXX errorhandling! */
786 }
787#endif
788
707ee5b1
JH
789 new_domain_record.result = old_domain_cache_result == ccache_reject_mfnull
790 ? ccache_reject_mfnull : ccache_accept;
059ec3d9 791
193e3acd 792 /* Do the random local part check first */
059ec3d9 793
193e3acd 794 if (random_local_part != NULL)
059ec3d9 795 {
193e3acd
JH
796 uschar randombuffer[1024];
797 BOOL random_ok =
02b41d71 798 smtp_write_command(&sx.outblock, FALSE,
193e3acd 799 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
921dfc11 800 rcpt_domain) >= 0 &&
02b41d71 801 smtp_read_response(&sx.inblock, randombuffer,
193e3acd 802 sizeof(randombuffer), '2', callout);
059ec3d9 803
193e3acd 804 /* Remember when we last did a random test */
059ec3d9 805
193e3acd 806 new_domain_record.random_stamp = time(NULL);
059ec3d9 807
193e3acd 808 /* If accepted, we aren't going to do any further tests below. */
059ec3d9 809
193e3acd 810 if (random_ok)
193e3acd 811 new_domain_record.random_result = ccache_accept;
059ec3d9 812
193e3acd
JH
813 /* Otherwise, cache a real negative response, and get back to the right
814 state to send RCPT. Unless there's some problem such as a dropped
65f1c92a
JH
815 connection, we expect to succeed, because the commands succeeded above.
816 However, some servers drop the connection after responding to an
817 invalid recipient, so on (any) error we drop and remake the connection.
818 */
059ec3d9 819
193e3acd
JH
820 else if (errno == 0)
821 {
65f1c92a
JH
822 /* This would be ok for 1st rcpt a cutthrough, but no way to
823 handle a subsequent. So refuse to support any */
5032d1cf
JH
824 cancel_cutthrough_connection("random-recipient");
825
193e3acd
JH
826 if (randombuffer[0] == '5')
827 new_domain_record.random_result = ccache_reject;
828
829 done =
02b41d71
JH
830 smtp_write_command(&sx.outblock, FALSE, "RSET\r\n") >= 0 &&
831 smtp_read_response(&sx.inblock, responsebuffer, sizeof(responsebuffer),
193e3acd
JH
832 '2', callout) &&
833
02b41d71 834 smtp_write_command(&sx.outblock, FALSE,
8c5d388a 835#ifdef SUPPORT_I18N
921dfc11 836 addr->prop.utf8_msg && !addr->prop.utf8_downcvt
9bfc60eb
JH
837 ? "MAIL FROM:<%s> SMTPUTF8\r\n"
838 :
839#endif
840 "MAIL FROM:<%s>\r\n",
193e3acd 841 from_address) >= 0 &&
02b41d71 842 smtp_read_response(&sx.inblock, responsebuffer, sizeof(responsebuffer),
193e3acd 843 '2', callout);
65f1c92a
JH
844
845 if (!done)
846 {
847 HDEBUG(D_acl|D_v)
848 debug_printf("problem after random/rset/mfrom; reopen conn\n");
849 random_local_part = NULL;
850#ifdef SUPPORT_TLS
851 tls_close(FALSE, TRUE);
852#endif
ae5afa61 853 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP(close)>>\n");
02b41d71 854 (void)close(sx.inblock.sock);
0cbf2b82 855#ifndef DISABLE_EVENT
65f1c92a
JH
856 (void) event_raise(addr->transport->event_action,
857 US"tcp:close", NULL);
858#endif
859 goto tls_retry_connection;
860 }
193e3acd
JH
861 }
862 else done = FALSE; /* Some timeout/connection problem */
863 } /* Random check */
059ec3d9 864
193e3acd
JH
865 /* If the host is accepting all local parts, as determined by the "random"
866 check, we don't need to waste time doing any further checking. */
059ec3d9 867
193e3acd 868 if (new_domain_record.random_result != ccache_accept && done)
059ec3d9 869 {
193e3acd
JH
870 /* Get the rcpt_include_affixes flag from the transport if there is one,
871 but assume FALSE if there is not. */
e4bdf652 872
921dfc11
JH
873 uschar * rcpt = transport_rcpt_address(addr,
874 addr->transport ? addr->transport->rcpt_include_affixes : FALSE);
875
8c5d388a 876#ifdef SUPPORT_I18N
921dfc11 877 /*XXX should the conversion be moved into transport_rcpt_address() ? */
921dfc11 878 if ( testflag(addr, af_utf8_downcvt)
9427e879
JH
879 && !(rcpt = string_address_utf8_to_alabel(rcpt, NULL))
880 )
881 {
882 errno = ERRNO_EXPANDFAIL;
883 *failure_ptr = US"recipient";
884 done = FALSE;
885 }
921dfc11
JH
886 else
887#endif
888
059ec3d9 889 done =
02b41d71 890 smtp_write_command(&sx.outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
921dfc11 891 rcpt) >= 0 &&
02b41d71 892 smtp_read_response(&sx.inblock, responsebuffer, sizeof(responsebuffer),
193e3acd 893 '2', callout);
059ec3d9 894
193e3acd
JH
895 if (done)
896 new_address_record.result = ccache_accept;
897 else if (errno == 0 && responsebuffer[0] == '5')
898 {
899 *failure_ptr = US"recipient";
900 new_address_record.result = ccache_reject;
901 }
059ec3d9 902
193e3acd
JH
903 /* Do postmaster check if requested; if a full check is required, we
904 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
2a4be8f9 905
02b41d71 906 if (done && pm_mailfrom)
193e3acd 907 {
65f1c92a
JH
908 /* Could possibly shift before main verify, just above, and be ok
909 for cutthrough. But no way to handle a subsequent rcpt, so just
910 refuse any */
5032d1cf 911 cancel_cutthrough_connection("postmaster verify");
193e3acd
JH
912 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of postmaster verify\n");
913
914 done =
02b41d71
JH
915 smtp_write_command(&sx.outblock, FALSE, "RSET\r\n") >= 0 &&
916 smtp_read_response(&sx.inblock, responsebuffer,
193e3acd
JH
917 sizeof(responsebuffer), '2', callout) &&
918
02b41d71 919 smtp_write_command(&sx.outblock, FALSE,
193e3acd 920 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
02b41d71 921 smtp_read_response(&sx.inblock, responsebuffer,
193e3acd
JH
922 sizeof(responsebuffer), '2', callout) &&
923
924 /* First try using the current domain */
925
926 ((
02b41d71 927 smtp_write_command(&sx.outblock, FALSE,
921dfc11 928 "RCPT TO:<postmaster@%.1000s>\r\n", rcpt_domain) >= 0 &&
02b41d71 929 smtp_read_response(&sx.inblock, responsebuffer,
193e3acd
JH
930 sizeof(responsebuffer), '2', callout)
931 )
932
933 ||
934
935 /* If that doesn't work, and a full check is requested,
936 try without the domain. */
937
938 (
939 (options & vopt_callout_fullpm) != 0 &&
02b41d71 940 smtp_write_command(&sx.outblock, FALSE,
193e3acd 941 "RCPT TO:<postmaster>\r\n") >= 0 &&
02b41d71 942 smtp_read_response(&sx.inblock, responsebuffer,
193e3acd
JH
943 sizeof(responsebuffer), '2', callout)
944 ));
945
946 /* Sort out the cache record */
947
948 new_domain_record.postmaster_stamp = time(NULL);
949
950 if (done)
951 new_domain_record.postmaster_result = ccache_accept;
952 else if (errno == 0 && responsebuffer[0] == '5')
953 {
954 *failure_ptr = US"postmaster";
955 setflag(addr, af_verify_pmfail);
956 new_domain_record.postmaster_result = ccache_reject;
957 }
958 }
959 } /* Random not accepted */
960 } /* MAIL FROM: accepted */
2a4be8f9 961
193e3acd
JH
962 /* For any failure of the main check, other than a negative response, we just
963 close the connection and carry on. We can identify a negative response by the
964 fact that errno is zero. For I/O errors it will be non-zero
2a4be8f9 965
193e3acd
JH
966 Set up different error texts for logging and for sending back to the caller
967 as an SMTP response. Log in all cases, using a one-line format. For sender
968 callouts, give a full response to the caller, but for recipient callouts,
969 don't give the IP address because this may be an internal host whose identity
970 is not to be widely broadcast. */
2a4be8f9 971
02b41d71
JH
972no_conn:
973 if (!done) switch(errno)
193e3acd 974 {
02b41d71
JH
975 case ETIMEDOUT:
976 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
977 sx.send_quit = FALSE;
978 break;
979
8c5d388a 980#ifdef SUPPORT_I18N
02b41d71 981 case ERRNO_UTF8_FWD:
9bfc60eb
JH
982 {
983 extern int acl_where; /* src/acl.c */
984 errno = 0;
985 addr->message = string_sprintf(
02b41d71
JH
986 "response to \"EHLO\" from %s [%s] did not include SMTPUTF8",
987 host->name, host->address);
988 addr->user_message = acl_where == ACL_WHERE_RCPT
989 ? US"533 no support for internationalised mailbox name"
9bfc60eb
JH
990 : US"550 mailbox unavailable";
991 yield = FAIL;
992 done = TRUE;
993 }
02b41d71 994 break;
9bfc60eb 995#endif
02b41d71
JH
996 case ECONNREFUSED:
997 sx.send_quit = FALSE;
998 break;
2a4be8f9 999
02b41d71
JH
1000 case 0:
1001 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
059ec3d9 1002
02b41d71
JH
1003 addr->message =
1004 string_sprintf("response to \"%s\" from %s [%s] was: %s",
1005 big_buffer, host->name, host->address,
1006 string_printing(responsebuffer));
1007
1008 addr->user_message = options & vopt_is_recipient
8b9476ba 1009 ? string_sprintf("Callout verification failed:\n%s", responsebuffer)
02b41d71
JH
1010 : string_sprintf("Called: %s\nSent: %s\nResponse: %s",
1011 host->address, big_buffer, responsebuffer);
059ec3d9 1012
02b41d71 1013 /* Hard rejection ends the process */
193e3acd 1014
02b41d71
JH
1015 if (responsebuffer[0] == '5') /* Address rejected */
1016 {
1017 yield = FAIL;
1018 done = TRUE;
1019 }
1020 break;
193e3acd 1021 }
059ec3d9 1022
193e3acd
JH
1023 /* End the SMTP conversation and close the connection. */
1024
4c04137d 1025 /* Cutthrough - on a successful connect and recipient-verify with
5032d1cf 1026 use-sender and we are 1st rcpt and have no cutthrough conn so far
193e3acd 1027 here is where we want to leave the conn open */
5032d1cf
JH
1028 if ( cutthrough.delivery
1029 && rcpt_count == 1
193e3acd
JH
1030 && done
1031 && yield == OK
98c82a3d
JH
1032 && (options & (vopt_callout_recipsender|vopt_callout_recippmaster|vopt_success_on_redirect))
1033 == vopt_callout_recipsender
193e3acd
JH
1034 && !random_local_part
1035 && !pm_mailfrom
5032d1cf 1036 && cutthrough.fd < 0
02b41d71 1037 && !sx.lmtp
193e3acd 1038 )
059ec3d9 1039 {
8b9476ba
JH
1040 HDEBUG(D_acl|D_v) debug_printf("holding verify callout open for cutthrough delivery\n");
1041
02b41d71 1042 cutthrough.fd = sx.outblock.sock; /* We assume no buffer in use in the outblock */
5032d1cf
JH
1043 cutthrough.nrcpt = 1;
1044 cutthrough.interface = interface;
1045 cutthrough.host = *host;
1046 cutthrough.addr = *addr; /* Save the address_item for later logging */
1047 cutthrough.addr.next = NULL;
1048 cutthrough.addr.host_used = &cutthrough.host;
193e3acd 1049 if (addr->parent)
5032d1cf
JH
1050 *(cutthrough.addr.parent = store_get(sizeof(address_item))) =
1051 *addr->parent;
193e3acd
JH
1052 ctblock.buffer = ctbuffer;
1053 ctblock.buffersize = sizeof(ctbuffer);
1054 ctblock.ptr = ctbuffer;
1055 /* ctblock.cmd_count = 0; ctblock.authenticating = FALSE; */
5032d1cf 1056 ctblock.sock = cutthrough.fd;
059ec3d9 1057 }
193e3acd 1058 else
059ec3d9 1059 {
2e5b33cd 1060 /* Ensure no cutthrough on multiple address verifies */
193e3acd 1061 if (options & vopt_callout_recipsender)
ff5929e3 1062 cancel_cutthrough_connection("not usable for cutthrough");
02b41d71 1063 if (sx.send_quit)
2760b518 1064 {
02b41d71 1065 (void) smtp_write_command(&sx.outblock, FALSE, "QUIT\r\n");
059ec3d9 1066
2760b518 1067 /* Wait a short time for response, and discard it */
02b41d71 1068 smtp_read_response(&sx.inblock, responsebuffer, sizeof(responsebuffer),
2760b518
JH
1069 '2', 1);
1070 }
1071
02b41d71
JH
1072 if (sx.inblock.sock >= 0)
1073 {
a7538db1 1074#ifdef SUPPORT_TLS
02b41d71 1075 tls_close(FALSE, TRUE);
a7538db1 1076#endif
02b41d71
JH
1077 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP(close)>>\n");
1078 (void)close(sx.inblock.sock);
1079 sx.inblock.sock = sx.outblock.sock = -1;
0cbf2b82 1080#ifndef DISABLE_EVENT
02b41d71 1081 (void) event_raise(addr->transport->event_action, US"tcp:close", NULL);
a7538db1 1082#endif
02b41d71 1083 }
059ec3d9 1084 }
059ec3d9 1085
193e3acd
JH
1086 } /* Loop through all hosts, while !done */
1087 }
059ec3d9
PH
1088
1089/* If we get here with done == TRUE, a successful callout happened, and yield
1090will be set OK or FAIL according to the response to the RCPT command.
1091Otherwise, we looped through the hosts but couldn't complete the business.
707ee5b1 1092However, there may be domain-specific information to cache in both cases. */
059ec3d9 1093
707ee5b1
JH
1094if (!(options & vopt_callout_no_cache))
1095 cache_callout_write(&new_domain_record, addr->domain,
1096 done, &new_address_record, address_key);
059ec3d9
PH
1097
1098/* Failure to connect to any host, or any response other than 2xx or 5xx is a
1099temporary error. If there was only one host, and a response was received, leave
1100it alone if supplying details. Otherwise, give a generic response. */
1101
707ee5b1 1102if (!done)
059ec3d9 1103 {
ff5929e3 1104 uschar * dullmsg = string_sprintf("Could not complete %s verify callout",
8b9476ba 1105 options & vopt_is_recipient ? "recipient" : "sender");
059ec3d9
PH
1106 yield = DEFER;
1107
02b41d71
JH
1108 addr->message = host_list->next || !addr->message
1109 ? dullmsg : string_sprintf("%s: %s", dullmsg, addr->message);
059ec3d9 1110
ff5929e3
JH
1111 addr->user_message = smtp_return_error_details
1112 ? string_sprintf("%s for <%s>.\n"
059ec3d9
PH
1113 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1114 "they may be permanently unreachable from this server. In the latter case,\n%s",
1115 dullmsg, addr->address,
8b9476ba 1116 options & vopt_is_recipient
ff5929e3 1117 ? "the address will never be accepted."
8b9476ba
JH
1118 : "you need to change the address or create an MX record for its domain\n"
1119 "if it is supposed to be generally accessible from the Internet.\n"
ff5929e3
JH
1120 "Talk to your mail administrator for details.")
1121 : dullmsg;
059ec3d9
PH
1122
1123 /* Force a specific error code */
1124
1125 addr->basic_errno = ERRNO_CALLOUTDEFER;
1126 }
1127
1128/* Come here from within the cache-reading code on fast-track exit. */
1129
1130END_CALLOUT:
02b41d71 1131tls_modify_variables(&tls_in);
059ec3d9
PH
1132return yield;
1133}
1134
1135
1136
817d9f57
JH
1137/* Called after recipient-acl to get a cutthrough connection open when
1138 one was requested and a recipient-verify wasn't subsequently done.
1139*/
f9334a28 1140int
e4bdf652
JH
1141open_cutthrough_connection( address_item * addr )
1142{
1143address_item addr2;
f9334a28 1144int rc;
e4bdf652
JH
1145
1146/* Use a recipient-verify-callout to set up the cutthrough connection. */
1147/* We must use a copy of the address for verification, because it might
1148get rewritten. */
1149
1150addr2 = *addr;
5032d1cf
JH
1151HDEBUG(D_acl) debug_printf("----------- %s cutthrough setup ------------\n",
1152 rcpt_count > 1 ? "more" : "start");
ff5929e3 1153rc = verify_address(&addr2, NULL,
e4bdf652
JH
1154 vopt_is_recipient | vopt_callout_recipsender | vopt_callout_no_cache,
1155 CUTTHROUGH_CMD_TIMEOUT, -1, -1,
1156 NULL, NULL, NULL);
ff5929e3
JH
1157addr->message = addr2.message;
1158addr->user_message = addr2.user_message;
e4bdf652 1159HDEBUG(D_acl) debug_printf("----------- end cutthrough setup ------------\n");
f9334a28 1160return rc;
e4bdf652
JH
1161}
1162
1163
e4bdf652 1164
817d9f57
JH
1165/* Send given number of bytes from the buffer */
1166static BOOL
1167cutthrough_send(int n)
e4bdf652 1168{
5032d1cf 1169if(cutthrough.fd < 0)
817d9f57 1170 return TRUE;
e4bdf652 1171
817d9f57
JH
1172if(
1173#ifdef SUPPORT_TLS
5032d1cf 1174 (tls_out.active == cutthrough.fd) ? tls_write(FALSE, ctblock.buffer, n) :
817d9f57 1175#endif
5032d1cf 1176 send(cutthrough.fd, ctblock.buffer, n, 0) > 0
817d9f57
JH
1177 )
1178{
1179 transport_count += n;
1180 ctblock.ptr= ctblock.buffer;
1181 return TRUE;
1182}
e4bdf652 1183
817d9f57
JH
1184HDEBUG(D_transport|D_acl) debug_printf("cutthrough_send failed: %s\n", strerror(errno));
1185return FALSE;
e4bdf652
JH
1186}
1187
1188
1189
817d9f57
JH
1190static BOOL
1191_cutthrough_puts(uschar * cp, int n)
1192{
1193while(n--)
1194 {
1195 if(ctblock.ptr >= ctblock.buffer+ctblock.buffersize)
1196 if(!cutthrough_send(ctblock.buffersize))
1197 return FALSE;
1198
1199 *ctblock.ptr++ = *cp++;
1200 }
1201return TRUE;
1202}
1203
1204/* Buffered output of counted data block. Return boolean success */
e4bdf652
JH
1205BOOL
1206cutthrough_puts(uschar * cp, int n)
1207{
5032d1cf 1208if (cutthrough.fd < 0) return TRUE;
817d9f57 1209if (_cutthrough_puts(cp, n)) return TRUE;
2e5b33cd 1210cancel_cutthrough_connection("transmit failed");
817d9f57
JH
1211return FALSE;
1212}
e4bdf652 1213
e4bdf652 1214
817d9f57 1215static BOOL
5032d1cf 1216_cutthrough_flush_send(void)
817d9f57
JH
1217{
1218int n= ctblock.ptr-ctblock.buffer;
e4bdf652 1219
817d9f57
JH
1220if(n>0)
1221 if(!cutthrough_send(n))
1222 return FALSE;
1223return TRUE;
e4bdf652
JH
1224}
1225
817d9f57
JH
1226
1227/* Send out any bufferred output. Return boolean success. */
e4bdf652 1228BOOL
5032d1cf 1229cutthrough_flush_send(void)
e4bdf652 1230{
817d9f57 1231if (_cutthrough_flush_send()) return TRUE;
2e5b33cd 1232cancel_cutthrough_connection("transmit failed");
e4bdf652
JH
1233return FALSE;
1234}
1235
1236
1237BOOL
5032d1cf 1238cutthrough_put_nl(void)
e4bdf652
JH
1239{
1240return cutthrough_puts(US"\r\n", 2);
1241}
1242
1243
1244/* Get and check response from cutthrough target */
1245static uschar
2760b518 1246cutthrough_response(char expect, uschar ** copy, int timeout)
e4bdf652
JH
1247{
1248smtp_inblock inblock;
1249uschar inbuffer[4096];
1250uschar responsebuffer[4096];
1251
1252inblock.buffer = inbuffer;
1253inblock.buffersize = sizeof(inbuffer);
1254inblock.ptr = inbuffer;
1255inblock.ptrend = inbuffer;
5032d1cf 1256inblock.sock = cutthrough.fd;
817d9f57 1257/* this relies on (inblock.sock == tls_out.active) */
2760b518 1258if(!smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer), expect, timeout))
2e5b33cd 1259 cancel_cutthrough_connection("target timeout on read");
e4bdf652
JH
1260
1261if(copy != NULL)
1262 {
1263 uschar * cp;
5032d1cf 1264 *copy = cp = string_copy(responsebuffer);
e4bdf652
JH
1265 /* Trim the trailing end of line */
1266 cp += Ustrlen(responsebuffer);
1267 if(cp > *copy && cp[-1] == '\n') *--cp = '\0';
1268 if(cp > *copy && cp[-1] == '\r') *--cp = '\0';
1269 }
1270
1271return responsebuffer[0];
1272}
1273
1274
1275/* Negotiate dataphase with the cutthrough target, returning success boolean */
1276BOOL
5032d1cf 1277cutthrough_predata(void)
e4bdf652 1278{
5032d1cf 1279if(cutthrough.fd < 0)
e4bdf652
JH
1280 return FALSE;
1281
1282HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> DATA\n");
817d9f57
JH
1283cutthrough_puts(US"DATA\r\n", 6);
1284cutthrough_flush_send();
e4bdf652
JH
1285
1286/* Assume nothing buffered. If it was it gets ignored. */
2760b518 1287return cutthrough_response('3', NULL, CUTTHROUGH_DATA_TIMEOUT) == '3';
e4bdf652
JH
1288}
1289
1290
6d5c916c 1291/* fd and tctx args only to match write_chunk() */
511a6c14 1292static BOOL
6d5c916c 1293cutthrough_write_chunk(int fd, transport_ctx * tctx, uschar * s, int len)
511a6c14
JH
1294{
1295uschar * s2;
1296while(s && (s2 = Ustrchr(s, '\n')))
1297 {
1298 if(!cutthrough_puts(s, s2-s) || !cutthrough_put_nl())
1299 return FALSE;
1300 s = s2+1;
1301 }
1302return TRUE;
1303}
1304
1305
e4bdf652 1306/* Buffered send of headers. Return success boolean. */
817d9f57 1307/* Expands newlines to wire format (CR,NL). */
e4bdf652 1308/* Also sends header-terminating blank line. */
e4bdf652 1309BOOL
5032d1cf 1310cutthrough_headers_send(void)
e4bdf652 1311{
6d5c916c
JH
1312transport_ctx tctx;
1313
5032d1cf 1314if(cutthrough.fd < 0)
e4bdf652
JH
1315 return FALSE;
1316
511a6c14
JH
1317/* We share a routine with the mainline transport to handle header add/remove/rewrites,
1318 but having a separate buffered-output function (for now)
1319*/
1320HDEBUG(D_acl) debug_printf("----------- start cutthrough headers send -----------\n");
e4bdf652 1321
6d5c916c
JH
1322tctx.tblock = cutthrough.addr.transport;
1323tctx.addr = &cutthrough.addr;
1324tctx.check_string = US".";
1325tctx.escape_string = US"..";
1326tctx.options = topt_use_crlf;
1327
1328if (!transport_headers_send(cutthrough.fd, &tctx, &cutthrough_write_chunk))
511a6c14
JH
1329 return FALSE;
1330
1331HDEBUG(D_acl) debug_printf("----------- done cutthrough headers send ------------\n");
1332return TRUE;
817d9f57
JH
1333}
1334
1335
1336static void
5032d1cf 1337close_cutthrough_connection(const char * why)
817d9f57 1338{
5032d1cf 1339if(cutthrough.fd >= 0)
817d9f57
JH
1340 {
1341 /* We could be sending this after a bunch of data, but that is ok as
1342 the only way to cancel the transfer in dataphase is to drop the tcp
1343 conn before the final dot.
1344 */
1345 ctblock.ptr = ctbuffer;
1346 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> QUIT\n");
1347 _cutthrough_puts(US"QUIT\r\n", 6); /* avoid recursion */
1348 _cutthrough_flush_send();
2760b518
JH
1349
1350 /* Wait a short time for response, and discard it */
1351 cutthrough_response('2', NULL, 1);
817d9f57
JH
1352
1353 #ifdef SUPPORT_TLS
1354 tls_close(FALSE, TRUE);
1355 #endif
ae5afa61 1356 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP(close)>>\n");
5032d1cf
JH
1357 (void)close(cutthrough.fd);
1358 cutthrough.fd = -1;
2e5b33cd 1359 HDEBUG(D_acl) debug_printf("----------- cutthrough shutdown (%s) ------------\n", why);
817d9f57
JH
1360 }
1361ctblock.ptr = ctbuffer;
e4bdf652
JH
1362}
1363
817d9f57 1364void
5032d1cf 1365cancel_cutthrough_connection(const char * why)
817d9f57 1366{
2e5b33cd 1367close_cutthrough_connection(why);
5032d1cf 1368cutthrough.delivery = FALSE;
817d9f57
JH
1369}
1370
1371
1372
e4bdf652
JH
1373
1374/* Have senders final-dot. Send one to cutthrough target, and grab the response.
1375 Log an OK response as a transmission.
817d9f57 1376 Close the connection.
e4bdf652 1377 Return smtp response-class digit.
e4bdf652
JH
1378*/
1379uschar *
5032d1cf 1380cutthrough_finaldot(void)
e4bdf652 1381{
5032d1cf
JH
1382uschar res;
1383address_item * addr;
e4bdf652
JH
1384HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> .\n");
1385
1386/* Assume data finshed with new-line */
5032d1cf
JH
1387if( !cutthrough_puts(US".", 1)
1388 || !cutthrough_put_nl()
1389 || !cutthrough_flush_send()
1390 )
1391 return cutthrough.addr.message;
e4bdf652 1392
2760b518 1393res = cutthrough_response('2', &cutthrough.addr.message, CUTTHROUGH_DATA_TIMEOUT);
5032d1cf 1394for (addr = &cutthrough.addr; addr; addr = addr->next)
817d9f57 1395 {
5032d1cf
JH
1396 addr->message = cutthrough.addr.message;
1397 switch(res)
1398 {
1399 case '2':
1400 delivery_log(LOG_MAIN, addr, (int)'>', NULL);
1401 close_cutthrough_connection("delivered");
1402 break;
817d9f57 1403
5032d1cf
JH
1404 case '4':
1405 delivery_log(LOG_MAIN, addr, 0,
1406 US"tmp-reject from cutthrough after DATA:");
1407 break;
e4bdf652 1408
5032d1cf
JH
1409 case '5':
1410 delivery_log(LOG_MAIN|LOG_REJECT, addr, 0,
1411 US"rejected after DATA:");
1412 break;
e4bdf652 1413
5032d1cf
JH
1414 default:
1415 break;
1416 }
817d9f57 1417 }
5032d1cf 1418return cutthrough.addr.message;
e4bdf652
JH
1419}
1420
1421
817d9f57 1422
059ec3d9
PH
1423/*************************************************
1424* Copy error to toplevel address *
1425*************************************************/
1426
1427/* This function is used when a verify fails or defers, to ensure that the
1428failure or defer information is in the original toplevel address. This applies
1429when an address is redirected to a single new address, and the failure or
1430deferral happens to the child address.
1431
1432Arguments:
1433 vaddr the verify address item
1434 addr the final address item
1435 yield FAIL or DEFER
1436
1437Returns: the value of YIELD
1438*/
1439
1440static int
1441copy_error(address_item *vaddr, address_item *addr, int yield)
1442{
1443if (addr != vaddr)
1444 {
1445 vaddr->message = addr->message;
1446 vaddr->user_message = addr->user_message;
1447 vaddr->basic_errno = addr->basic_errno;
1448 vaddr->more_errno = addr->more_errno;
d43cbe25 1449 vaddr->prop.address_data = addr->prop.address_data;
42855d71 1450 copyflag(vaddr, addr, af_pass_message);
059ec3d9
PH
1451 }
1452return yield;
1453}
1454
1455
1456
1457
ce552449
NM
1458/**************************************************
1459* printf that automatically handles TLS if needed *
1460***************************************************/
1461
1462/* This function is used by verify_address() as a substitute for all fprintf()
1463calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1464as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1465that assumes that we always use the smtp_out FILE* when not using TLS or the
1466ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1467that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1468fprintf().
1469
1470Arguments:
1471 f the candidate FILE* to write to
1472 format format string
1473 ... optional arguments
1474
1475Returns:
1476 nothing
1477*/
1478
1479static void PRINTF_FUNCTION(2,3)
1ba28e2b 1480respond_printf(FILE *f, const char *format, ...)
ce552449
NM
1481{
1482va_list ap;
1483
1484va_start(ap, format);
1485if (smtp_out && (f == smtp_out))
1486 smtp_vprintf(format, ap);
1487else
513afc6a 1488 vfprintf(f, format, ap);
ce552449
NM
1489va_end(ap);
1490}
1491
1492
1493
059ec3d9
PH
1494/*************************************************
1495* Verify an email address *
1496*************************************************/
1497
1498/* This function is used both for verification (-bv and at other times) and
1499address testing (-bt), which is indicated by address_test_mode being set.
1500
1501Arguments:
1502 vaddr contains the address to verify; the next field in this block
1503 must be NULL
1504 f if not NULL, write the result to this file
1505 options various option bits:
1506 vopt_fake_sender => this sender verify is not for the real
1507 sender (it was verify=sender=xxxx or an address from a
1508 header line) - rewriting must not change sender_address
1509 vopt_is_recipient => this is a recipient address, otherwise
1510 it's a sender address - this affects qualification and
1511 rewriting and messages from callouts
1512 vopt_qualify => qualify an unqualified address; else error
1513 vopt_expn => called from SMTP EXPN command
eafd343b
TK
1514 vopt_success_on_redirect => when a new address is generated
1515 the verification instantly succeeds
059ec3d9
PH
1516
1517 These ones are used by do_callout() -- the options variable
1518 is passed to it.
1519
2a4be8f9 1520 vopt_callout_fullpm => if postmaster check, do full one
059ec3d9
PH
1521 vopt_callout_no_cache => don't use callout cache
1522 vopt_callout_random => do the "random" thing
1523 vopt_callout_recipsender => use real sender for recipient
1524 vopt_callout_recippmaster => use postmaster for recipient
1525
1526 callout if > 0, specifies that callout is required, and gives timeout
4deaf07d 1527 for individual commands
059ec3d9
PH
1528 callout_overall if > 0, gives overall timeout for the callout function;
1529 if < 0, a default is used (see do_callout())
8e669ac1 1530 callout_connect the connection timeout for callouts
059ec3d9
PH
1531 se_mailfrom when callout is requested to verify a sender, use this
1532 in MAIL FROM; NULL => ""
1533 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1534 thing and use this as the sender address (may be "")
1535
1536 routed if not NULL, set TRUE if routing succeeded, so we can
1537 distinguish between routing failed and callout failed
1538
1539Returns: OK address verified
1540 FAIL address failed to verify
1541 DEFER can't tell at present
1542*/
1543
1544int
1545verify_address(address_item *vaddr, FILE *f, int options, int callout,
8e669ac1 1546 int callout_overall, int callout_connect, uschar *se_mailfrom,
4deaf07d 1547 uschar *pm_mailfrom, BOOL *routed)
059ec3d9
PH
1548{
1549BOOL allok = TRUE;
1550BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
059ec3d9 1551BOOL expn = (options & vopt_expn) != 0;
eafd343b 1552BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
059ec3d9
PH
1553int i;
1554int yield = OK;
1555int verify_type = expn? v_expn :
1556 address_test_mode? v_none :
8b9476ba 1557 options & vopt_is_recipient? v_recipient : v_sender;
059ec3d9
PH
1558address_item *addr_list;
1559address_item *addr_new = NULL;
1560address_item *addr_remote = NULL;
1561address_item *addr_local = NULL;
1562address_item *addr_succeed = NULL;
8b9476ba
JH
1563uschar **failure_ptr = options & vopt_is_recipient
1564 ? &recipient_verify_failure : &sender_verify_failure;
059ec3d9
PH
1565uschar *ko_prefix, *cr;
1566uschar *address = vaddr->address;
1567uschar *save_sender;
1568uschar null_sender[] = { 0 }; /* Ensure writeable memory */
1569
2c7db3f5
PH
1570/* Clear, just in case */
1571
1572*failure_ptr = NULL;
1573
059ec3d9
PH
1574/* Set up a prefix and suffix for error message which allow us to use the same
1575output statements both in EXPN mode (where an SMTP response is needed) and when
1576debugging with an output file. */
1577
1578if (expn)
1579 {
1580 ko_prefix = US"553 ";
1581 cr = US"\r";
1582 }
1583else ko_prefix = cr = US"";
1584
1585/* Add qualify domain if permitted; otherwise an unqualified address fails. */
1586
1587if (parse_find_at(address) == NULL)
1588 {
1589 if ((options & vopt_qualify) == 0)
1590 {
1591 if (f != NULL)
ce552449
NM
1592 respond_printf(f, "%sA domain is required for \"%s\"%s\n",
1593 ko_prefix, address, cr);
8e669ac1 1594 *failure_ptr = US"qualify";
059ec3d9
PH
1595 return FAIL;
1596 }
8b9476ba 1597 address = rewrite_address_qualify(address, options & vopt_is_recipient);
059ec3d9
PH
1598 }
1599
1600DEBUG(D_verify)
1601 {
1602 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1603 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
1604 }
1605
1606/* Rewrite and report on it. Clear the domain and local part caches - these
1607may have been set by domains and local part tests during an ACL. */
1608
1609if (global_rewrite_rules != NULL)
1610 {
1611 uschar *old = address;
8b9476ba 1612 address = rewrite_address(address, options & vopt_is_recipient, FALSE,
059ec3d9
PH
1613 global_rewrite_rules, rewrite_existflags);
1614 if (address != old)
1615 {
1616 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1617 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1618 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
1619 }
1620 }
1621
1622/* If this is the real sender address, we must update sender_address at
1623this point, because it may be referred to in the routers. */
1624
1625if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
1626 sender_address = address;
1627
1628/* If the address was rewritten to <> no verification can be done, and we have
1629to return OK. This rewriting is permitted only for sender addresses; for other
1630addresses, such rewriting fails. */
1631
1632if (address[0] == 0) return OK;
1633
d9b2312b
JH
1634/* Flip the legacy TLS-related variables over to the outbound set in case
1635they're used in the context of a transport used by verification. Reset them
ea90b718 1636at exit from this routine (so no returns allowed from here on). */
d9b2312b 1637
35aba663 1638tls_modify_variables(&tls_out);
d9b2312b 1639
059ec3d9
PH
1640/* Save a copy of the sender address for re-instating if we change it to <>
1641while verifying a sender address (a nice bit of self-reference there). */
1642
1643save_sender = sender_address;
1644
ea90b718
JH
1645/* Observability variable for router/transport use */
1646
8b9476ba 1647verify_mode = options & vopt_is_recipient ? US"R" : US"S";
ea90b718 1648
059ec3d9
PH
1649/* Update the address structure with the possibly qualified and rewritten
1650address. Set it up as the starting address on the chain of new addresses. */
1651
1652vaddr->address = address;
1653addr_new = vaddr;
1654
1655/* We need a loop, because an address can generate new addresses. We must also
1656cope with generated pipes and files at the top level. (See also the code and
1657comment in deliver.c.) However, it is usually the case that the router for
1658user's .forward files has its verify flag turned off.
1659
1660If an address generates more than one child, the loop is used only when
1661full_info is set, and this can only be set locally. Remote enquiries just get
1662information about the top level address, not anything that it generated. */
1663
ea90b718 1664while (addr_new)
059ec3d9
PH
1665 {
1666 int rc;
1667 address_item *addr = addr_new;
1668
1669 addr_new = addr->next;
1670 addr->next = NULL;
1671
1672 DEBUG(D_verify)
1673 {
1674 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1675 debug_printf("Considering %s\n", addr->address);
1676 }
1677
1678 /* Handle generated pipe, file or reply addresses. We don't get these
1679 when handling EXPN, as it does only one level of expansion. */
1680
1681 if (testflag(addr, af_pfr))
1682 {
1683 allok = FALSE;
1684 if (f != NULL)
1685 {
1686 BOOL allow;
1687
1688 if (addr->address[0] == '>')
1689 {
1690 allow = testflag(addr, af_allow_reply);
1691 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
1692 }
1693 else
1694 {
1695 allow = (addr->address[0] == '|')?
1696 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1697 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
1698 }
1699
1700 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1701 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
1702 "%s\n", addr->message);
1703 else if (allow)
1704 fprintf(f, "\n transport = %s\n", addr->transport->name);
1705 else
1706 fprintf(f, " *** forbidden ***\n");
1707 }
1708 continue;
1709 }
1710
1711 /* Just in case some router parameter refers to it. */
1712
2f682e45
JH
1713 return_path = addr->prop.errors_address
1714 ? addr->prop.errors_address : sender_address;
059ec3d9
PH
1715
1716 /* Split the address into domain and local part, handling the %-hack if
1717 necessary, and then route it. While routing a sender address, set
1718 $sender_address to <> because that is what it will be if we were trying to
1719 send a bounce to the sender. */
1720
2f682e45 1721 if (routed) *routed = FALSE;
059ec3d9
PH
1722 if ((rc = deliver_split_address(addr)) == OK)
1723 {
8b9476ba 1724 if (!(options & vopt_is_recipient)) sender_address = null_sender;
059ec3d9
PH
1725 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1726 &addr_succeed, verify_type);
1727 sender_address = save_sender; /* Put back the real sender */
1728 }
1729
1730 /* If routing an address succeeded, set the flag that remembers, for use when
1731 an ACL cached a sender verify (in case a callout fails). Then if routing set
1732 up a list of hosts or the transport has a host list, and the callout option
1733 is set, and we aren't in a host checking run, do the callout verification,
1734 and set another flag that notes that a callout happened. */
1735
1736 if (rc == OK)
1737 {
2f682e45 1738 if (routed) *routed = TRUE;
059ec3d9
PH
1739 if (callout > 0)
1740 {
08f3b11b 1741 transport_instance * tp;
2f682e45 1742 host_item * host_list = addr->host_list;
059ec3d9 1743
26da7e20
PH
1744 /* Make up some data for use in the case where there is no remote
1745 transport. */
1746
1747 transport_feedback tf = {
1748 NULL, /* interface (=> any) */
1749 US"smtp", /* port */
1750 US"smtp", /* protocol */
1751 NULL, /* hosts */
1752 US"$smtp_active_hostname", /* helo_data */
1753 FALSE, /* hosts_override */
1754 FALSE, /* hosts_randomize */
1755 FALSE, /* gethostbyname */
1756 TRUE, /* qualify_single */
1757 FALSE /* search_parents */
1758 };
059ec3d9
PH
1759
1760 /* If verification yielded a remote transport, we want to use that
1761 transport's options, so as to mimic what would happen if we were really
1762 sending a message to this address. */
1763
08f3b11b 1764 if ((tp = addr->transport) && !tp->info->local)
059ec3d9 1765 {
08f3b11b 1766 (void)(tp->setup)(tp, addr, &tf, 0, 0, NULL);
059ec3d9
PH
1767
1768 /* If the transport has hosts and the router does not, or if the
1769 transport is configured to override the router's hosts, we must build a
1770 host list of the transport's hosts, and find the IP addresses */
1771
2f682e45 1772 if (tf.hosts && (!host_list || tf.hosts_override))
059ec3d9
PH
1773 {
1774 uschar *s;
55414b25 1775 const uschar *save_deliver_domain = deliver_domain;
750af86e 1776 uschar *save_deliver_localpart = deliver_localpart;
059ec3d9
PH
1777
1778 host_list = NULL; /* Ignore the router's hosts */
1779
1780 deliver_domain = addr->domain;
1781 deliver_localpart = addr->local_part;
1782 s = expand_string(tf.hosts);
750af86e
PH
1783 deliver_domain = save_deliver_domain;
1784 deliver_localpart = save_deliver_localpart;
059ec3d9 1785
2f682e45 1786 if (!s)
059ec3d9
PH
1787 {
1788 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1789 "\"%s\" in %s transport for callout: %s", tf.hosts,
08f3b11b 1790 tp->name, expand_string_message);
059ec3d9
PH
1791 }
1792 else
1793 {
322050c2 1794 int flags;
d8ef3577 1795 host_item *host, *nexthost;
059ec3d9
PH
1796 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1797
1798 /* Just ignore failures to find a host address. If we don't manage
8e669ac1
PH
1799 to find any addresses, the callout will defer. Note that more than
1800 one address may be found for a single host, which will result in
1801 additional host items being inserted into the chain. Hence we must
d8ef3577 1802 save the next host first. */
059ec3d9 1803
322050c2
PH
1804 flags = HOST_FIND_BY_A;
1805 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1806 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1807
2f682e45 1808 for (host = host_list; host; host = nexthost)
059ec3d9 1809 {
d8ef3577 1810 nexthost = host->next;
8e669ac1 1811 if (tf.gethostbyname ||
7e66e54d 1812 string_is_ip_address(host->name, NULL) != 0)
55414b25 1813 (void)host_find_byname(host, NULL, flags, NULL, TRUE);
059ec3d9 1814 else
9d9c3746 1815 {
7cd171b7 1816 dnssec_domains * dnssec_domains = NULL;
08f3b11b 1817 if (Ustrcmp(tp->driver_name, "smtp") == 0)
9d9c3746
JH
1818 {
1819 smtp_transport_options_block * ob =
08f3b11b 1820 (smtp_transport_options_block *) tp->options_block;
7cd171b7 1821 dnssec_domains = &ob->dnssec;
9d9c3746
JH
1822 }
1823
059ec3d9 1824 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
7cd171b7 1825 dnssec_domains, NULL, NULL);
9d9c3746 1826 }
059ec3d9
PH
1827 }
1828 }
1829 }
1830 }
1831
8e669ac1 1832 /* Can only do a callout if we have at least one host! If the callout
2c7db3f5 1833 fails, it will have set ${sender,recipient}_verify_failure. */
059ec3d9 1834
2f682e45 1835 if (host_list)
059ec3d9
PH
1836 {
1837 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1838 if (host_checking && !host_checking_callout)
1839 {
1840 HDEBUG(D_verify)
1841 debug_printf("... callout omitted by default when host testing\n"
1842 "(Use -bhc if you want the callouts to happen.)\n");
1843 }
1844 else
1845 {
4ed8d31a
JH
1846#ifdef SUPPORT_TLS
1847 deliver_set_expansions(addr);
1848#endif
059ec3d9 1849 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
4deaf07d 1850 callout_connect, options, se_mailfrom, pm_mailfrom);
059ec3d9
PH
1851 }
1852 }
1853 else
1854 {
1855 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1856 "transport provided a host list\n");
1857 }
1858 }
1859 }
8e669ac1 1860
2c7db3f5 1861 /* Otherwise, any failure is a routing failure */
8e669ac1
PH
1862
1863 else *failure_ptr = US"route";
059ec3d9
PH
1864
1865 /* A router may return REROUTED if it has set up a child address as a result
1866 of a change of domain name (typically from widening). In this case we always
1867 want to continue to verify the new child. */
1868
1869 if (rc == REROUTED) continue;
8e669ac1 1870
059ec3d9
PH
1871 /* Handle hard failures */
1872
1873 if (rc == FAIL)
1874 {
1875 allok = FALSE;
2f682e45 1876 if (f)
059ec3d9 1877 {
e6f6568e
PH
1878 address_item *p = addr->parent;
1879
ce552449 1880 respond_printf(f, "%s%s %s", ko_prefix,
2f682e45
JH
1881 full_info ? addr->address : address,
1882 address_test_mode ? "is undeliverable" : "failed to verify");
059ec3d9
PH
1883 if (!expn && admin_user)
1884 {
1885 if (addr->basic_errno > 0)
ce552449 1886 respond_printf(f, ": %s", strerror(addr->basic_errno));
2f682e45 1887 if (addr->message)
ce552449 1888 respond_printf(f, ": %s", addr->message);
e6f6568e
PH
1889 }
1890
1891 /* Show parents iff doing full info */
1892
2f682e45 1893 if (full_info) while (p)
e6f6568e 1894 {
ce552449 1895 respond_printf(f, "%s\n <-- %s", cr, p->address);
e6f6568e 1896 p = p->parent;
059ec3d9 1897 }
ce552449 1898 respond_printf(f, "%s\n", cr);
059ec3d9 1899 }
2e5b33cd 1900 cancel_cutthrough_connection("routing hard fail");
059ec3d9 1901
d9b2312b 1902 if (!full_info)
2f682e45 1903 {
d9b2312b
JH
1904 yield = copy_error(vaddr, addr, FAIL);
1905 goto out;
2f682e45
JH
1906 }
1907 yield = FAIL;
059ec3d9
PH
1908 }
1909
1910 /* Soft failure */
1911
1912 else if (rc == DEFER)
1913 {
1914 allok = FALSE;
2f682e45 1915 if (f)
059ec3d9 1916 {
e6f6568e 1917 address_item *p = addr->parent;
ce552449 1918 respond_printf(f, "%s%s cannot be resolved at this time", ko_prefix,
322050c2 1919 full_info? addr->address : address);
059ec3d9
PH
1920 if (!expn && admin_user)
1921 {
1922 if (addr->basic_errno > 0)
ce552449 1923 respond_printf(f, ": %s", strerror(addr->basic_errno));
2f682e45 1924 if (addr->message)
ce552449 1925 respond_printf(f, ": %s", addr->message);
059ec3d9 1926 else if (addr->basic_errno <= 0)
ce552449 1927 respond_printf(f, ": unknown error");
059ec3d9
PH
1928 }
1929
e6f6568e
PH
1930 /* Show parents iff doing full info */
1931
2f682e45 1932 if (full_info) while (p)
e6f6568e 1933 {
ce552449 1934 respond_printf(f, "%s\n <-- %s", cr, p->address);
e6f6568e
PH
1935 p = p->parent;
1936 }
ce552449 1937 respond_printf(f, "%s\n", cr);
059ec3d9 1938 }
2e5b33cd 1939 cancel_cutthrough_connection("routing soft fail");
e4bdf652 1940
d9b2312b
JH
1941 if (!full_info)
1942 {
1943 yield = copy_error(vaddr, addr, DEFER);
1944 goto out;
1945 }
2f682e45 1946 if (yield == OK) yield = DEFER;
059ec3d9
PH
1947 }
1948
1949 /* If we are handling EXPN, we do not want to continue to route beyond
e6f6568e 1950 the top level (whose address is in "address"). */
059ec3d9
PH
1951
1952 else if (expn)
1953 {
1954 uschar *ok_prefix = US"250-";
2f682e45
JH
1955
1956 if (!addr_new)
1957 if (!addr_local && !addr_remote)
ce552449 1958 respond_printf(f, "250 mail to <%s> is discarded\r\n", address);
059ec3d9 1959 else
ce552449 1960 respond_printf(f, "250 <%s>\r\n", address);
2f682e45
JH
1961
1962 else do
059ec3d9
PH
1963 {
1964 address_item *addr2 = addr_new;
1965 addr_new = addr2->next;
2f682e45 1966 if (!addr_new) ok_prefix = US"250 ";
ce552449 1967 respond_printf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
2f682e45 1968 } while (addr_new);
d9b2312b
JH
1969 yield = OK;
1970 goto out;
059ec3d9
PH
1971 }
1972
1973 /* Successful routing other than EXPN. */
1974
1975 else
1976 {
1977 /* Handle successful routing when short info wanted. Otherwise continue for
1978 other (generated) addresses. Short info is the operational case. Full info
1979 can be requested only when debug_selector != 0 and a file is supplied.
1980
1981 There is a conflict between the use of aliasing as an alternate email
1982 address, and as a sort of mailing list. If an alias turns the incoming
1983 address into just one address (e.g. J.Caesar->jc44) you may well want to
1984 carry on verifying the generated address to ensure it is valid when
1985 checking incoming mail. If aliasing generates multiple addresses, you
1986 probably don't want to do this. Exim therefore treats the generation of
1987 just a single new address as a special case, and continues on to verify the
1988 generated address. */
1989
2f682e45
JH
1990 if ( !full_info /* Stop if short info wanted AND */
1991 && ( ( !addr_new /* No new address OR */
1992 || addr_new->next /* More than one new address OR */
1993 || testflag(addr_new, af_pfr) /* New address is pfr */
1994 )
1995 || /* OR */
1996 ( addr_new /* At least one new address AND */
1997 && success_on_redirect /* success_on_redirect is set */
1998 ) )
1999 )
059ec3d9 2000 {
2f682e45
JH
2001 if (f) fprintf(f, "%s %s\n",
2002 address, address_test_mode ? "is deliverable" : "verified");
059ec3d9
PH
2003
2004 /* If we have carried on to verify a child address, we want the value
2005 of $address_data to be that of the child */
2006
d43cbe25 2007 vaddr->prop.address_data = addr->prop.address_data;
98c82a3d
JH
2008
2009 /* If stopped because more than one new address, cannot cutthrough */
2010
2011 if (addr_new && addr_new->next)
2012 cancel_cutthrough_connection("multiple addresses from routing");
2013
d9b2312b
JH
2014 yield = OK;
2015 goto out;
059ec3d9
PH
2016 }
2017 }
2018 } /* Loop for generated addresses */
2019
2020/* Display the full results of the successful routing, including any generated
2021addresses. Control gets here only when full_info is set, which requires f not
2022to be NULL, and this occurs only when a top-level verify is called with the
2023debugging switch on.
2024
2025If there are no local and no remote addresses, and there were no pipes, files,
2026or autoreplies, and there were no errors or deferments, the message is to be
2027discarded, usually because of the use of :blackhole: in an alias file. */
2028
2f682e45 2029if (allok && !addr_local && !addr_remote)
dbcef0ea 2030 {
059ec3d9 2031 fprintf(f, "mail to %s is discarded\n", address);
d9b2312b 2032 goto out;
dbcef0ea 2033 }
059ec3d9 2034
dbcef0ea 2035for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
08f3b11b 2036 while (addr_list)
059ec3d9
PH
2037 {
2038 address_item *addr = addr_list;
2039 address_item *p = addr->parent;
08f3b11b
JH
2040 transport_instance * tp = addr->transport;
2041
059ec3d9
PH
2042 addr_list = addr->next;
2043
2044 fprintf(f, "%s", CS addr->address);
384152a6 2045#ifdef EXPERIMENTAL_SRS
d43cbe25
JH
2046 if(addr->prop.srs_sender)
2047 fprintf(f, " [srs = %s]", addr->prop.srs_sender);
384152a6 2048#endif
dbcef0ea
PH
2049
2050 /* If the address is a duplicate, show something about it. */
2051
2052 if (!testflag(addr, af_pfr))
2053 {
2054 tree_node *tnode;
08f3b11b 2055 if ((tnode = tree_search(tree_duplicates, addr->unique)))
dbcef0ea
PH
2056 fprintf(f, " [duplicate, would not be delivered]");
2057 else tree_add_duplicate(addr->unique, addr);
2058 }
2059
2060 /* Now show its parents */
2061
08f3b11b 2062 for (p = addr->parent; p; p = p->parent)
059ec3d9 2063 fprintf(f, "\n <-- %s", p->address);
059ec3d9
PH
2064 fprintf(f, "\n ");
2065
2066 /* Show router, and transport */
2067
08f3b11b
JH
2068 fprintf(f, "router = %s, transport = %s\n",
2069 addr->router->name, tp ? tp->name : US"unset");
059ec3d9
PH
2070
2071 /* Show any hosts that are set up by a router unless the transport
2072 is going to override them; fiddle a bit to get a nice format. */
2073
08f3b11b 2074 if (addr->host_list && tp && !tp->overrides_hosts)
059ec3d9
PH
2075 {
2076 host_item *h;
2077 int maxlen = 0;
2078 int maxaddlen = 0;
08f3b11b
JH
2079 for (h = addr->host_list; h; h = h->next)
2080 { /* get max lengths of host names, addrs */
059ec3d9
PH
2081 int len = Ustrlen(h->name);
2082 if (len > maxlen) maxlen = len;
08f3b11b 2083 len = h->address ? Ustrlen(h->address) : 7;
059ec3d9
PH
2084 if (len > maxaddlen) maxaddlen = len;
2085 }
08f3b11b
JH
2086 for (h = addr->host_list; h; h = h->next)
2087 {
2088 fprintf(f, " host %-*s ", maxlen, h->name);
2089
2090 if (h->address)
2091 fprintf(f, "[%s%-*c", h->address, maxaddlen+1 - Ustrlen(h->address), ']');
2092 else if (tp->info->local)
2093 fprintf(f, " %-*s ", maxaddlen, ""); /* Omit [unknown] for local */
2094 else
2095 fprintf(f, "[%s%-*c", "unknown", maxaddlen+1 - 7, ']');
2096
2097 if (h->mx >= 0) fprintf(f, " MX=%d", h->mx);
059ec3d9 2098 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
08f3b11b
JH
2099 if (running_in_test_harness && h->dnssec == DS_YES) fputs(" AD", f);
2100 if (h->status == hstatus_unusable) fputs(" ** unusable **", f);
2101 fputc('\n', f);
059ec3d9
PH
2102 }
2103 }
2104 }
059ec3d9 2105
d9b2312b 2106/* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2c7db3f5
PH
2107the -bv or -bt case). */
2108
d9b2312b 2109out:
ea90b718 2110verify_mode = NULL;
35aba663 2111tls_modify_variables(&tls_in);
d9b2312b 2112
8e669ac1 2113return yield;
059ec3d9
PH
2114}
2115
2116
2117
2118
2119/*************************************************
2120* Check headers for syntax errors *
2121*************************************************/
2122
2123/* This function checks those header lines that contain addresses, and verifies
2124that all the addresses therein are syntactially correct.
2125
2126Arguments:
2127 msgptr where to put an error message
2128
2129Returns: OK
2130 FAIL
2131*/
2132
2133int
2134verify_check_headers(uschar **msgptr)
2135{
2136header_line *h;
2137uschar *colon, *s;
1eccaa59 2138int yield = OK;
059ec3d9 2139
1eccaa59 2140for (h = header_list; h != NULL && yield == OK; h = h->next)
059ec3d9
PH
2141 {
2142 if (h->type != htype_from &&
2143 h->type != htype_reply_to &&
2144 h->type != htype_sender &&
2145 h->type != htype_to &&
2146 h->type != htype_cc &&
2147 h->type != htype_bcc)
2148 continue;
2149
2150 colon = Ustrchr(h->text, ':');
2151 s = colon + 1;
2152 while (isspace(*s)) s++;
2153
1eccaa59
PH
2154 /* Loop for multiple addresses in the header, enabling group syntax. Note
2155 that we have to reset this after the header has been scanned. */
059ec3d9 2156
1eccaa59 2157 parse_allow_group = TRUE;
059ec3d9
PH
2158
2159 while (*s != 0)
2160 {
2161 uschar *ss = parse_find_address_end(s, FALSE);
2162 uschar *recipient, *errmess;
2163 int terminator = *ss;
2164 int start, end, domain;
2165
2166 /* Temporarily terminate the string at this point, and extract the
1eccaa59 2167 operative address within, allowing group syntax. */
059ec3d9
PH
2168
2169 *ss = 0;
2170 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2171 *ss = terminator;
2172
2173 /* Permit an unqualified address only if the message is local, or if the
2174 sending host is configured to be permitted to send them. */
2175
2176 if (recipient != NULL && domain == 0)
2177 {
2178 if (h->type == htype_from || h->type == htype_sender)
2179 {
2180 if (!allow_unqualified_sender) recipient = NULL;
2181 }
2182 else
2183 {
2184 if (!allow_unqualified_recipient) recipient = NULL;
2185 }
2186 if (recipient == NULL) errmess = US"unqualified address not permitted";
2187 }
2188
2189 /* It's an error if no address could be extracted, except for the special
2190 case of an empty address. */
2191
2192 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
2193 {
2194 uschar *verb = US"is";
2195 uschar *t = ss;
1ab95fa6 2196 uschar *tt = colon;
059ec3d9
PH
2197 int len;
2198
2199 /* Arrange not to include any white space at the end in the
1ab95fa6 2200 error message or the header name. */
059ec3d9
PH
2201
2202 while (t > s && isspace(t[-1])) t--;
1ab95fa6 2203 while (tt > h->text && isspace(tt[-1])) tt--;
059ec3d9 2204
1ab95fa6 2205 /* Add the address that failed to the error message, since in a
059ec3d9
PH
2206 header with very many addresses it is sometimes hard to spot
2207 which one is at fault. However, limit the amount of address to
2208 quote - cases have been seen where, for example, a missing double
2209 quote in a humungous To: header creates an "address" that is longer
2210 than string_sprintf can handle. */
2211
2212 len = t - s;
2213 if (len > 1024)
2214 {
2215 len = 1024;
2216 verb = US"begins";
2217 }
2218
55414b25
JH
2219 /* deconst cast ok as we're passing a non-const to string_printing() */
2220 *msgptr = US string_printing(
1ab95fa6
PH
2221 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2222 errmess, tt - h->text, h->text, verb, len, s));
059ec3d9 2223
1eccaa59
PH
2224 yield = FAIL;
2225 break; /* Out of address loop */
059ec3d9
PH
2226 }
2227
2228 /* Advance to the next address */
2229
2230 s = ss + (terminator? 1:0);
2231 while (isspace(*s)) s++;
2232 } /* Next address */
059ec3d9 2233
1eccaa59
PH
2234 parse_allow_group = FALSE;
2235 parse_found_group = FALSE;
2236 } /* Next header unless yield has been set FALSE */
2237
2238return yield;
059ec3d9
PH
2239}
2240
2241
770747fd
MFM
2242/*************************************************
2243* Check header names for 8-bit characters *
2244*************************************************/
2245
4c04137d 2246/* This function checks for invalid characters in header names. See
770747fd
MFM
2247RFC 5322, 2.2. and RFC 6532, 3.
2248
2249Arguments:
2250 msgptr where to put an error message
2251
2252Returns: OK
2253 FAIL
2254*/
2255
2256int
2257verify_check_header_names_ascii(uschar **msgptr)
2258{
2259header_line *h;
2260uschar *colon, *s;
2261
2262for (h = header_list; h != NULL; h = h->next)
2263 {
2264 colon = Ustrchr(h->text, ':');
2265 for(s = h->text; s < colon; s++)
2266 {
2267 if ((*s < 33) || (*s > 126))
2268 {
2269 *msgptr = string_sprintf("Invalid character in header \"%.*s\" found",
2270 colon - h->text, h->text);
2271 return FAIL;
2272 }
2273 }
2274 }
2275return OK;
2276}
059ec3d9 2277
1c41c9cc
PH
2278/*************************************************
2279* Check for blind recipients *
2280*************************************************/
2281
2282/* This function checks that every (envelope) recipient is mentioned in either
2283the To: or Cc: header lines, thus detecting blind carbon copies.
2284
2285There are two ways of scanning that could be used: either scan the header lines
2286and tick off the recipients, or scan the recipients and check the header lines.
2287The original proposed patch did the former, but I have chosen to do the latter,
2288because (a) it requires no memory and (b) will use fewer resources when there
2289are many addresses in To: and/or Cc: and only one or two envelope recipients.
2290
2291Arguments: none
2292Returns: OK if there are no blind recipients
2293 FAIL if there is at least one blind recipient
2294*/
2295
2296int
2297verify_check_notblind(void)
2298{
2299int i;
2300for (i = 0; i < recipients_count; i++)
2301 {
2302 header_line *h;
2303 BOOL found = FALSE;
2304 uschar *address = recipients_list[i].address;
2305
2306 for (h = header_list; !found && h != NULL; h = h->next)
2307 {
2308 uschar *colon, *s;
2309
2310 if (h->type != htype_to && h->type != htype_cc) continue;
2311
2312 colon = Ustrchr(h->text, ':');
2313 s = colon + 1;
2314 while (isspace(*s)) s++;
2315
1eccaa59
PH
2316 /* Loop for multiple addresses in the header, enabling group syntax. Note
2317 that we have to reset this after the header has been scanned. */
1c41c9cc 2318
1eccaa59 2319 parse_allow_group = TRUE;
1c41c9cc
PH
2320
2321 while (*s != 0)
2322 {
2323 uschar *ss = parse_find_address_end(s, FALSE);
2324 uschar *recipient,*errmess;
2325 int terminator = *ss;
2326 int start, end, domain;
2327
2328 /* Temporarily terminate the string at this point, and extract the
1eccaa59 2329 operative address within, allowing group syntax. */
1c41c9cc
PH
2330
2331 *ss = 0;
2332 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2333 *ss = terminator;
2334
2335 /* If we found a valid recipient that has a domain, compare it with the
2336 envelope recipient. Local parts are compared case-sensitively, domains
2337 case-insensitively. By comparing from the start with length "domain", we
2338 include the "@" at the end, which ensures that we are comparing the whole
2339 local part of each address. */
2340
2341 if (recipient != NULL && domain != 0)
2342 {
2343 found = Ustrncmp(recipient, address, domain) == 0 &&
2344 strcmpic(recipient + domain, address + domain) == 0;
2345 if (found) break;
2346 }
2347
2348 /* Advance to the next address */
2349
2350 s = ss + (terminator? 1:0);
2351 while (isspace(*s)) s++;
2352 } /* Next address */
1eccaa59
PH
2353
2354 parse_allow_group = FALSE;
2355 parse_found_group = FALSE;
1c41c9cc
PH
2356 } /* Next header (if found is false) */
2357
2358 if (!found) return FAIL;
2359 } /* Next recipient */
2360
2361return OK;
2362}
2363
2364
059ec3d9
PH
2365
2366/*************************************************
2367* Find if verified sender *
2368*************************************************/
2369
2370/* Usually, just a single address is verified as the sender of the message.
2371However, Exim can be made to verify other addresses as well (often related in
2372some way), and this is useful in some environments. There may therefore be a
2373chain of such addresses that have previously been tested. This function finds
2374whether a given address is on the chain.
2375
2376Arguments: the address to be verified
2377Returns: pointer to an address item, or NULL
2378*/
2379
2380address_item *
2381verify_checked_sender(uschar *sender)
2382{
2383address_item *addr;
2384for (addr = sender_verified_list; addr != NULL; addr = addr->next)
2385 if (Ustrcmp(sender, addr->address) == 0) break;
2386return addr;
2387}
2388
2389
2390
2391
2392
2393/*************************************************
2394* Get valid header address *
2395*************************************************/
2396
2397/* Scan the originator headers of the message, looking for an address that
2398verifies successfully. RFC 822 says:
2399
2400 o The "Sender" field mailbox should be sent notices of
2401 any problems in transport or delivery of the original
2402 messages. If there is no "Sender" field, then the
2403 "From" field mailbox should be used.
2404
2405 o If the "Reply-To" field exists, then the reply should
2406 go to the addresses indicated in that field and not to
2407 the address(es) indicated in the "From" field.
2408
2409So we check a Sender field if there is one, else a Reply_to field, else a From
2410field. As some strange messages may have more than one of these fields,
2411especially if they are resent- fields, check all of them if there is more than
2412one.
2413
2414Arguments:
2415 user_msgptr points to where to put a user error message
2416 log_msgptr points to where to put a log error message
2417 callout timeout for callout check (passed to verify_address())
2418 callout_overall overall callout timeout (ditto)
8e669ac1 2419 callout_connect connect callout timeout (ditto)
059ec3d9
PH
2420 se_mailfrom mailfrom for verify; NULL => ""
2421 pm_mailfrom sender for pm callout check (passed to verify_address())
2422 options callout options (passed to verify_address())
8e669ac1 2423 verrno where to put the address basic_errno
059ec3d9
PH
2424
2425If log_msgptr is set to something without setting user_msgptr, the caller
2426normally uses log_msgptr for both things.
2427
2428Returns: result of the verification attempt: OK, FAIL, or DEFER;
2429 FAIL is given if no appropriate headers are found
2430*/
2431
2432int
2433verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
8e669ac1 2434 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
fe5b5d0b 2435 uschar *pm_mailfrom, int options, int *verrno)
059ec3d9
PH
2436{
2437static int header_types[] = { htype_sender, htype_reply_to, htype_from };
1eccaa59 2438BOOL done = FALSE;
059ec3d9
PH
2439int yield = FAIL;
2440int i;
2441
1eccaa59 2442for (i = 0; i < 3 && !done; i++)
059ec3d9
PH
2443 {
2444 header_line *h;
1eccaa59 2445 for (h = header_list; h != NULL && !done; h = h->next)
059ec3d9
PH
2446 {
2447 int terminator, new_ok;
2448 uschar *s, *ss, *endname;
2449
2450 if (h->type != header_types[i]) continue;
2451 s = endname = Ustrchr(h->text, ':') + 1;
2452
1eccaa59
PH
2453 /* Scan the addresses in the header, enabling group syntax. Note that we
2454 have to reset this after the header has been scanned. */
2455
2456 parse_allow_group = TRUE;
2457
059ec3d9
PH
2458 while (*s != 0)
2459 {
2460 address_item *vaddr;
2461
2462 while (isspace(*s) || *s == ',') s++;
2463 if (*s == 0) break; /* End of header */
2464
2465 ss = parse_find_address_end(s, FALSE);
2466
2467 /* The terminator is a comma or end of header, but there may be white
2468 space preceding it (including newline for the last address). Move back
2469 past any white space so we can check against any cached envelope sender
2470 address verifications. */
2471
2472 while (isspace(ss[-1])) ss--;
2473 terminator = *ss;
2474 *ss = 0;
2475
2476 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
2477 (int)(endname - h->text), h->text, s);
2478
2479 /* See if we have already verified this address as an envelope sender,
2480 and if so, use the previous answer. */
2481
2482 vaddr = verify_checked_sender(s);
2483
2484 if (vaddr != NULL && /* Previously checked */
2485 (callout <= 0 || /* No callout needed; OR */
2486 vaddr->special_action > 256)) /* Callout was done */
2487 {
2488 new_ok = vaddr->special_action & 255;
2489 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
2490 *ss = terminator; /* Restore shortened string */
2491 }
2492
2493 /* Otherwise we run the verification now. We must restore the shortened
2494 string before running the verification, so the headers are correct, in
2495 case there is any rewriting. */
2496
2497 else
2498 {
2499 int start, end, domain;
1eccaa59
PH
2500 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
2501 &domain, FALSE);
059ec3d9
PH
2502
2503 *ss = terminator;
2504
1eccaa59
PH
2505 /* If we found an empty address, just carry on with the next one, but
2506 kill the message. */
2507
2508 if (address == NULL && Ustrcmp(*log_msgptr, "empty address") == 0)
2509 {
2510 *log_msgptr = NULL;
2511 s = ss;
2512 continue;
2513 }
2514
059ec3d9
PH
2515 /* If verification failed because of a syntax error, fail this
2516 function, and ensure that the failing address gets added to the error
2517 message. */
2518
2519 if (address == NULL)
2520 {
2521 new_ok = FAIL;
1eccaa59
PH
2522 while (ss > s && isspace(ss[-1])) ss--;
2523 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
2524 "scanning for sender: %s in \"%.*s\"",
2525 endname - h->text, h->text, *log_msgptr, ss - s, s);
2526 yield = FAIL;
2527 done = TRUE;
2528 break;
059ec3d9
PH
2529 }
2530
2f6603e1 2531 /* Else go ahead with the sender verification. But it isn't *the*
059ec3d9
PH
2532 sender of the message, so set vopt_fake_sender to stop sender_address
2533 being replaced after rewriting or qualification. */
2534
2535 else
2536 {
2537 vaddr = deliver_make_addr(address, FALSE);
2538 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
8e669ac1 2539 callout, callout_overall, callout_connect, se_mailfrom,
4deaf07d 2540 pm_mailfrom, NULL);
059ec3d9
PH
2541 }
2542 }
2543
2544 /* We now have the result, either newly found, or cached. If we are
2545 giving out error details, set a specific user error. This means that the
2546 last of these will be returned to the user if all three fail. We do not
2547 set a log message - the generic one below will be used. */
2548
fe5b5d0b 2549 if (new_ok != OK)
059ec3d9 2550 {
8e669ac1 2551 *verrno = vaddr->basic_errno;
fe5b5d0b
PH
2552 if (smtp_return_error_details)
2553 {
2554 *user_msgptr = string_sprintf("Rejected after DATA: "
2555 "could not verify \"%.*s\" header address\n%s: %s",
2556 endname - h->text, h->text, vaddr->address, vaddr->message);
2557 }
8e669ac1 2558 }
059ec3d9
PH
2559
2560 /* Success or defer */
2561
1eccaa59
PH
2562 if (new_ok == OK)
2563 {
2564 yield = OK;
2565 done = TRUE;
2566 break;
2567 }
2568
059ec3d9
PH
2569 if (new_ok == DEFER) yield = DEFER;
2570
2571 /* Move on to any more addresses in the header */
2572
2573 s = ss;
1eccaa59
PH
2574 } /* Next address */
2575
2576 parse_allow_group = FALSE;
2577 parse_found_group = FALSE;
2578 } /* Next header, unless done */
2579 } /* Next header type unless done */
059ec3d9
PH
2580
2581if (yield == FAIL && *log_msgptr == NULL)
2582 *log_msgptr = US"there is no valid sender in any header line";
2583
2584if (yield == DEFER && *log_msgptr == NULL)
2585 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
2586
2587return yield;
2588}
2589
2590
2591
2592
2593/*************************************************
2594* Get RFC 1413 identification *
2595*************************************************/
2596
2597/* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2598the timeout is set to zero, then the query is not done. There may also be lists
2599of hosts and nets which are exempt. To guard against malefactors sending
2600non-printing characters which could, for example, disrupt a message's headers,
2601make sure the string consists of printing characters only.
2602
2603Argument:
2604 port the port to connect to; usually this is IDENT_PORT (113), but when
2605 running in the test harness with -bh a different value is used.
2606
2607Returns: nothing
2608
2609Side effect: any received ident value is put in sender_ident (NULL otherwise)
2610*/
2611
2612void
2613verify_get_ident(int port)
2614{
2615int sock, host_af, qlen;
2616int received_sender_port, received_interface_port, n;
2617uschar *p;
2618uschar buffer[2048];
2619
2620/* Default is no ident. Check whether we want to do an ident check for this
2621host. */
2622
2623sender_ident = NULL;
2624if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
2625 return;
2626
2627DEBUG(D_ident) debug_printf("doing ident callback\n");
2628
2629/* Set up a connection to the ident port of the remote host. Bind the local end
2630to the incoming interface address. If the sender host address is an IPv6
2631address, the incoming interface address will also be IPv6. */
2632
fb05276a
JH
2633host_af = Ustrchr(sender_host_address, ':') == NULL ? AF_INET : AF_INET6;
2634if ((sock = ip_socket(SOCK_STREAM, host_af)) < 0) return;
059ec3d9
PH
2635
2636if (ip_bind(sock, host_af, interface_address, 0) < 0)
2637 {
2638 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
2639 strerror(errno));
2640 goto END_OFF;
2641 }
2642
fb05276a
JH
2643if (ip_connect(sock, host_af, sender_host_address, port,
2644 rfc1413_query_timeout, TRUE) < 0)
059ec3d9 2645 {
6c6d6e48 2646 if (errno == ETIMEDOUT && LOGGING(ident_timeout))
059ec3d9
PH
2647 log_write(0, LOG_MAIN, "ident connection to %s timed out",
2648 sender_host_address);
059ec3d9 2649 else
059ec3d9
PH
2650 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
2651 sender_host_address, strerror(errno));
059ec3d9
PH
2652 goto END_OFF;
2653 }
2654
2655/* Construct and send the query. */
2656
2657sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
2658qlen = Ustrlen(buffer);
2659if (send(sock, buffer, qlen, 0) < 0)
2660 {
2661 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
2662 goto END_OFF;
2663 }
2664
2665/* Read a response line. We put it into the rest of the buffer, using several
2666recv() calls if necessary. */
2667
2668p = buffer + qlen;
2669
2670for (;;)
2671 {
2672 uschar *pp;
2673 int count;
2674 int size = sizeof(buffer) - (p - buffer);
2675
2676 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2677 count = ip_recv(sock, p, size, rfc1413_query_timeout);
2678 if (count <= 0) goto END_OFF; /* Read error or EOF */
2679
2680 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2681 generous, and accept a plain \n terminator as well. The only illegal
2682 character is 0. */
2683
2684 for (pp = p; pp < p + count; pp++)
2685 {
2686 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2687 if (*pp == '\n')
2688 {
2689 if (pp[-1] == '\r') pp--;
2690 *pp = 0;
2691 goto GOT_DATA; /* Break out of both loops */
2692 }
2693 }
2694
2695 /* Reached the end of the data without finding \n. Let the loop continue to
2696 read some more, if there is room. */
2697
2698 p = pp;
2699 }
2700
2701GOT_DATA:
2702
2703/* We have received a line of data. Check it carefully. It must start with the
2704same two port numbers that we sent, followed by data as defined by the RFC. For
2705example,
2706
2707 12345 , 25 : USERID : UNIX :root
2708
2709However, the amount of white space may be different to what we sent. In the
2710"osname" field there may be several sub-fields, comma separated. The data we
2711actually want to save follows the third colon. Some systems put leading spaces
2712in it - we discard those. */
2713
2714if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2715 &received_interface_port, &n) != 2 ||
2716 received_sender_port != sender_host_port ||
2717 received_interface_port != interface_port)
2718 goto END_OFF;
2719
2720p = buffer + qlen + n;
2721while(isspace(*p)) p++;
2722if (*p++ != ':') goto END_OFF;
2723while(isspace(*p)) p++;
2724if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
2725p += 6;
2726while(isspace(*p)) p++;
2727if (*p++ != ':') goto END_OFF;
2728while (*p != 0 && *p != ':') p++;
2729if (*p++ == 0) goto END_OFF;
2730while(isspace(*p)) p++;
2731if (*p == 0) goto END_OFF;
2732
2733/* The rest of the line is the data we want. We turn it into printing
2734characters when we save it, so that it cannot mess up the format of any logging
2735or Received: lines into which it gets inserted. We keep a maximum of 127
55414b25 2736characters. The deconst cast is ok as we fed a nonconst to string_printing() */
059ec3d9 2737
55414b25 2738sender_ident = US string_printing(string_copyn(p, 127));
059ec3d9
PH
2739DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
2740
2741END_OFF:
f1e894f3 2742(void)close(sock);
059ec3d9
PH
2743return;
2744}
2745
2746
2747
2748
2749/*************************************************
2750* Match host to a single host-list item *
2751*************************************************/
2752
2753/* This function compares a host (name or address) against a single item
2754from a host list. The host name gets looked up if it is needed and is not
2755already known. The function is called from verify_check_this_host() via
2756match_check_list(), which is why most of its arguments are in a single block.
2757
2758Arguments:
2759 arg the argument block (see below)
2760 ss the host-list item
2761 valueptr where to pass back looked up data, or NULL
2762 error for error message when returning ERROR
2763
2764The block contains:
32d668a5
PH
2765 host_name (a) the host name, or
2766 (b) NULL, implying use sender_host_name and
2767 sender_host_aliases, looking them up if required, or
2768 (c) the empty string, meaning that only IP address matches
2769 are permitted
059ec3d9
PH
2770 host_address the host address
2771 host_ipv4 the IPv4 address taken from an IPv6 one
2772
2773Returns: OK matched
2774 FAIL did not match
2775 DEFER lookup deferred
32d668a5
PH
2776 ERROR (a) failed to find the host name or IP address, or
2777 (b) unknown lookup type specified, or
2778 (c) host name encountered when only IP addresses are
2779 being matched
059ec3d9
PH
2780*/
2781
32d668a5 2782int
55414b25 2783check_host(void *arg, const uschar *ss, const uschar **valueptr, uschar **error)
059ec3d9
PH
2784{
2785check_host_block *cb = (check_host_block *)arg;
32d668a5 2786int mlen = -1;
059ec3d9 2787int maskoffset;
32d668a5 2788BOOL iplookup = FALSE;
059ec3d9 2789BOOL isquery = FALSE;
32d668a5 2790BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
55414b25 2791const uschar *t;
32d668a5 2792uschar *semicolon;
059ec3d9
PH
2793uschar **aliases;
2794
2795/* Optimize for the special case when the pattern is "*". */
2796
2797if (*ss == '*' && ss[1] == 0) return OK;
2798
2799/* If the pattern is empty, it matches only in the case when there is no host -
2800this can occur in ACL checking for SMTP input using the -bs option. In this
2801situation, the host address is the empty string. */
2802
2803if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
2804if (*ss == 0) return FAIL;
2805
32d668a5
PH
2806/* If the pattern is precisely "@" then match against the primary host name,
2807provided that host name matching is permitted; if it's "@[]" match against the
2808local host's IP addresses. */
059ec3d9
PH
2809
2810if (*ss == '@')
2811 {
32d668a5
PH
2812 if (ss[1] == 0)
2813 {
2814 if (isiponly) return ERROR;
2815 ss = primary_hostname;
2816 }
059ec3d9
PH
2817 else if (Ustrcmp(ss, "@[]") == 0)
2818 {
2819 ip_address_item *ip;
2820 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
2821 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
2822 return FAIL;
2823 }
2824 }
2825
2826/* If the pattern is an IP address, optionally followed by a bitmask count, do
4c04137d 2827a (possibly masked) comparison with the current IP address. */
059ec3d9 2828
7e66e54d 2829if (string_is_ip_address(ss, &maskoffset) != 0)
059ec3d9
PH
2830 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
2831
1688f43b
PH
2832/* The pattern is not an IP address. A common error that people make is to omit
2833one component of an IPv4 address, either by accident, or believing that, for
2834example, 1.2.3/24 is the same as 1.2.3.0/24, or 1.2.3 is the same as 1.2.3.0,
2835which it isn't. (Those applications that do accept 1.2.3 as an IP address
2836interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2837ancient specification.) To aid in debugging these cases, we give a specific
2838error if the pattern contains only digits and dots or contains a slash preceded
2839only by digits and dots (a slash at the start indicates a file name and of
2840course slashes may be present in lookups, but not preceded only by digits and
2841dots). */
2842
2843for (t = ss; isdigit(*t) || *t == '.'; t++);
2844if (*t == 0 || (*t == '/' && t != ss))
2845 {
2846 *error = US"malformed IPv4 address or address mask";
2847 return ERROR;
2848 }
2849
32d668a5 2850/* See if there is a semicolon in the pattern */
059ec3d9 2851
32d668a5
PH
2852semicolon = Ustrchr(ss, ';');
2853
2854/* If we are doing an IP address only match, then all lookups must be IP
df199fec 2855address lookups, even if there is no "net-". */
32d668a5
PH
2856
2857if (isiponly)
059ec3d9 2858 {
32d668a5
PH
2859 iplookup = semicolon != NULL;
2860 }
059ec3d9 2861
32d668a5 2862/* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
df199fec
PH
2863a lookup on a masked IP network, in textual form. We obey this code even if we
2864have already set iplookup, so as to skip over the "net-" prefix and to set the
2865mask length. The net- stuff really only applies to single-key lookups where the
2866key is implicit. For query-style lookups the key is specified in the query.
2867From release 4.30, the use of net- for query style is no longer needed, but we
2868retain it for backward compatibility. */
2869
2870if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
32d668a5
PH
2871 {
2872 mlen = 0;
2873 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
2874 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
2875 iplookup = (*t++ == '-');
2876 }
1688f43b 2877else t = ss;
059ec3d9 2878
32d668a5 2879/* Do the IP address lookup if that is indeed what we have */
059ec3d9 2880
32d668a5
PH
2881if (iplookup)
2882 {
2883 int insize;
2884 int search_type;
2885 int incoming[4];
2886 void *handle;
2887 uschar *filename, *key, *result;
2888 uschar buffer[64];
059ec3d9 2889
32d668a5 2890 /* Find the search type */
059ec3d9 2891
32d668a5 2892 search_type = search_findtype(t, semicolon - t);
059ec3d9 2893
32d668a5
PH
2894 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2895 search_error_message);
059ec3d9 2896
13b685f9
PH
2897 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2898 is no file name, and the "key" is just the query. For query-style with a file
2899 name, we have to fish the file off the start of the query. For a single-key
2900 lookup, the key is the current IP address, masked appropriately, and
2901 reconverted to text form, with the mask appended. For IPv6 addresses, specify
6a3bceb1
PH
2902 dot separators instead of colons, except when the lookup type is "iplsearch".
2903 */
059ec3d9 2904
13b685f9
PH
2905 if (mac_islookup(search_type, lookup_absfilequery))
2906 {
2907 filename = semicolon + 1;
2908 key = filename;
2909 while (*key != 0 && !isspace(*key)) key++;
2910 filename = string_copyn(filename, key - filename);
2911 while (isspace(*key)) key++;
2912 }
2913 else if (mac_islookup(search_type, lookup_querystyle))
32d668a5
PH
2914 {
2915 filename = NULL;
2916 key = semicolon + 1;
2917 }
6a3bceb1 2918 else /* Single-key style */
32d668a5 2919 {
e6d225ae 2920 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
6a3bceb1 2921 ':' : '.';
32d668a5
PH
2922 insize = host_aton(cb->host_address, incoming);
2923 host_mask(insize, incoming, mlen);
6a3bceb1 2924 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
32d668a5
PH
2925 key = buffer;
2926 filename = semicolon + 1;
059ec3d9 2927 }
32d668a5
PH
2928
2929 /* Now do the actual lookup; note that there is no search_close() because
2930 of the caching arrangements. */
2931
d4ff61d1
JH
2932 if (!(handle = search_open(filename, search_type, 0, NULL, NULL)))
2933 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", search_error_message);
2934
32d668a5
PH
2935 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
2936 if (valueptr != NULL) *valueptr = result;
2937 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
059ec3d9
PH
2938 }
2939
2940/* The pattern is not an IP address or network reference of any kind. That is,
32d668a5
PH
2941it is a host name pattern. If this is an IP only match, there's an error in the
2942host list. */
2943
2944if (isiponly)
2945 {
2946 *error = US"cannot match host name in match_ip list";
2947 return ERROR;
2948 }
2949
2950/* Check the characters of the pattern to see if they comprise only letters,
2951digits, full stops, and hyphens (the constituents of domain names). Allow
2952underscores, as they are all too commonly found. Sigh. Also, if
2953allow_utf8_domains is set, allow top-bit characters. */
059ec3d9
PH
2954
2955for (t = ss; *t != 0; t++)
2956 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
2957 (!allow_utf8_domains || *t < 128)) break;
2958
2959/* If the pattern is a complete domain name, with no fancy characters, look up
2960its IP address and match against that. Note that a multi-homed host will add
2961items to the chain. */
2962
2963if (*t == 0)
2964 {
2965 int rc;
2966 host_item h;
2967 h.next = NULL;
2968 h.name = ss;
2969 h.address = NULL;
2970 h.mx = MX_NONE;
9b8fadde 2971
1f155f8e
JH
2972 /* Using byname rather than bydns here means we cannot determine dnssec
2973 status. On the other hand it is unclear how that could be either
2974 propagated up or enforced. */
2975
322050c2 2976 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
059ec3d9
PH
2977 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
2978 {
2979 host_item *hh;
2980 for (hh = &h; hh != NULL; hh = hh->next)
2981 {
96776534 2982 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
059ec3d9
PH
2983 }
2984 return FAIL;
2985 }
2986 if (rc == HOST_FIND_AGAIN) return DEFER;
2987 *error = string_sprintf("failed to find IP address for %s", ss);
2988 return ERROR;
2989 }
2990
2991/* Almost all subsequent comparisons require the host name, and can be done
2992using the general string matching function. When this function is called for
2993outgoing hosts, the name is always given explicitly. If it is NULL, it means we
2994must use sender_host_name and its aliases, looking them up if necessary. */
2995
2996if (cb->host_name != NULL) /* Explicit host name given */
2997 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
2998 valueptr);
2999
3000/* Host name not given; in principle we need the sender host name and its
3001aliases. However, for query-style lookups, we do not need the name if the
3002query does not contain $sender_host_name. From release 4.23, a reference to
3003$sender_host_name causes it to be looked up, so we don't need to do the lookup
3004on spec. */
3005
3006if ((semicolon = Ustrchr(ss, ';')) != NULL)
3007 {
55414b25 3008 const uschar *affix;
059ec3d9
PH
3009 int partial, affixlen, starflags, id;
3010
3011 *semicolon = 0;
3012 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
3013 *semicolon=';';
3014
3015 if (id < 0) /* Unknown lookup type */
3016 {
3017 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
3018 search_error_message, ss);
3019 return DEFER;
3020 }
13b685f9 3021 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
059ec3d9
PH
3022 }
3023
3024if (isquery)
3025 {
3026 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
3027 {
3028 case OK: return OK;
3029 case DEFER: return DEFER;
3030 default: return FAIL;
3031 }
3032 }
3033
3034/* Not a query-style lookup; must ensure the host name is present, and then we
3035do a check on the name and all its aliases. */
3036
3037if (sender_host_name == NULL)
3038 {
3039 HDEBUG(D_host_lookup)
3040 debug_printf("sender host name required, to match against %s\n", ss);
3041 if (host_lookup_failed || host_name_lookup() != OK)
3042 {
3043 *error = string_sprintf("failed to find host name for %s",
3044 sender_host_address);;
3045 return ERROR;
3046 }
3047 host_build_sender_fullhost();
3048 }
3049
3050/* Match on the sender host name, using the general matching function */
3051
3052switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
3053 valueptr))
3054 {
3055 case OK: return OK;
3056 case DEFER: return DEFER;
3057 }
3058
3059/* If there are aliases, try matching on them. */
3060
3061aliases = sender_host_aliases;
3062while (*aliases != NULL)
3063 {
3064 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
3065 {
3066 case OK: return OK;
3067 case DEFER: return DEFER;
3068 }
3069 }
3070return FAIL;
3071}
3072
3073
3074
3075
3076/*************************************************
3077* Check a specific host matches a host list *
3078*************************************************/
3079
3080/* This function is passed a host list containing items in a number of
3081different formats and the identity of a host. Its job is to determine whether
3082the given host is in the set of hosts defined by the list. The host name is
3083passed as a pointer so that it can be looked up if needed and not already
3084known. This is commonly the case when called from verify_check_host() to check
3085an incoming connection. When called from elsewhere the host name should usually
3086be set.
3087
3088This function is now just a front end to match_check_list(), which runs common
3089code for scanning a list. We pass it the check_host() function to perform a
3090single test.
3091
3092Arguments:
3093 listptr pointer to the host list
3094 cache_bits pointer to cache for named lists, or NULL
3095 host_name the host name or NULL, implying use sender_host_name and
3096 sender_host_aliases, looking them up if required
3097 host_address the IP address
3098 valueptr if not NULL, data from a lookup is passed back here
3099
3100Returns: OK if the host is in the defined set
3101 FAIL if the host is not in the defined set,
3102 DEFER if a data lookup deferred (not a host lookup)
3103
3104If the host name was needed in order to make a comparison, and could not be
3105determined from the IP address, the result is FAIL unless the item
3106"+allow_unknown" was met earlier in the list, in which case OK is returned. */
3107
3108int
55414b25
JH
3109verify_check_this_host(const uschar **listptr, unsigned int *cache_bits,
3110 const uschar *host_name, const uschar *host_address, const uschar **valueptr)
059ec3d9 3111{
d4eb88df 3112int rc;
059ec3d9 3113unsigned int *local_cache_bits = cache_bits;
55414b25 3114const uschar *save_host_address = deliver_host_address;
059ec3d9
PH
3115check_host_block cb;
3116cb.host_name = host_name;
3117cb.host_address = host_address;
3118
3119if (valueptr != NULL) *valueptr = NULL;
3120
3121/* If the host address starts off ::ffff: it is an IPv6 address in
3122IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3123addresses. */
3124
3125cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
3126 host_address + 7 : host_address;
3127
8e669ac1
PH
3128/* During the running of the check, put the IP address into $host_address. In
3129the case of calls from the smtp transport, it will already be there. However,
3130in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
d4eb88df
PH
3131the safe side, any existing setting is preserved, though as I write this
3132(November 2004) I can't see any cases where it is actually needed. */
3133
3134deliver_host_address = host_address;
3135rc = match_check_list(
3136 listptr, /* the list */
3137 0, /* separator character */
3138 &hostlist_anchor, /* anchor pointer */
3139 &local_cache_bits, /* cache pointer */
3140 check_host, /* function for testing */
3141 &cb, /* argument for function */
3142 MCL_HOST, /* type of check */
8e669ac1 3143 (host_address == sender_host_address)?
d4eb88df
PH
3144 US"host" : host_address, /* text for debugging */
3145 valueptr); /* where to pass back data */
3146deliver_host_address = save_host_address;
8e669ac1 3147return rc;
059ec3d9
PH
3148}
3149
3150
3151
3152
3153/*************************************************
5130845b
JH
3154* Check the given host item matches a list *
3155*************************************************/
3156int
3157verify_check_given_host(uschar **listptr, host_item *host)
3158{
55414b25 3159return verify_check_this_host(CUSS listptr, NULL, host->name, host->address, NULL);
5130845b
JH
3160}
3161
3162/*************************************************
059ec3d9
PH
3163* Check the remote host matches a list *
3164*************************************************/
3165
3166/* This is a front end to verify_check_this_host(), created because checking
3167the remote host is a common occurrence. With luck, a good compiler will spot
3168the tail recursion and optimize it. If there's no host address, this is
3169command-line SMTP input - check against an empty string for the address.
3170
3171Arguments:
3172 listptr pointer to the host list
3173
3174Returns: the yield of verify_check_this_host(),
3175 i.e. OK, FAIL, or DEFER
3176*/
3177
3178int
3179verify_check_host(uschar **listptr)
3180{
55414b25 3181return verify_check_this_host(CUSS listptr, sender_host_cache, NULL,
059ec3d9
PH
3182 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
3183}
3184
3185
3186
3187
3188
3189/*************************************************
83e029d5 3190* Invert an IP address *
059ec3d9
PH
3191*************************************************/
3192
83e029d5
PP
3193/* Originally just used for DNS xBL lists, now also used for the
3194reverse_ip expansion operator.
3195
059ec3d9
PH
3196Arguments:
3197 buffer where to put the answer
3198 address the address to invert
3199*/
3200
83e029d5 3201void
059ec3d9
PH
3202invert_address(uschar *buffer, uschar *address)
3203{
3204int bin[4];
3205uschar *bptr = buffer;
3206
3207/* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3208to the IPv4 part only. */
3209
3210if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
3211
3212/* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3213always 1. */
3214
3215if (host_aton(address, bin) == 1)
3216 {
3217 int i;
3218 int x = bin[0];
3219 for (i = 0; i < 4; i++)
3220 {
3221 sprintf(CS bptr, "%d.", x & 255);
3222 while (*bptr) bptr++;
3223 x >>= 8;
3224 }
3225 }
3226
3227/* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3228in any DNS black lists, and the format in which they will be looked up is
3229unknown. This is just a guess. */
3230
3231#if HAVE_IPV6
3232else
3233 {
3234 int i, j;
3235 for (j = 3; j >= 0; j--)
3236 {
3237 int x = bin[j];
3238 for (i = 0; i < 8; i++)
3239 {
3240 sprintf(CS bptr, "%x.", x & 15);
3241 while (*bptr) bptr++;
3242 x >>= 4;
3243 }
3244 }
3245 }
3246#endif
d6f6e0dc
PH
3247
3248/* Remove trailing period -- this is needed so that both arbitrary
3249dnsbl keydomains and inverted addresses may be combined with the
3250same format string, "%s.%s" */
3251
3252*(--bptr) = 0;
059ec3d9
PH
3253}
3254
3255
3256
3257/*************************************************
0bcb2a0e
PH
3258* Perform a single dnsbl lookup *
3259*************************************************/
3260
d6f6e0dc
PH
3261/* This function is called from verify_check_dnsbl() below. It is also called
3262recursively from within itself when domain and domain_txt are different
3263pointers, in order to get the TXT record from the alternate domain.
0bcb2a0e
PH
3264
3265Arguments:
d6f6e0dc
PH
3266 domain the outer dnsbl domain
3267 domain_txt alternate domain to lookup TXT record on success; when the
3268 same domain is to be used, domain_txt == domain (that is,
3269 the pointers must be identical, not just the text)
8e669ac1 3270 keydomain the current keydomain (for debug message)
d6f6e0dc
PH
3271 prepend subdomain to lookup (like keydomain, but
3272 reversed if IP address)
3273 iplist the list of matching IP addresses, or NULL for "any"
8e669ac1 3274 bitmask true if bitmask matching is wanted
431b7361
PH
3275 match_type condition for 'succeed' result
3276 0 => Any RR in iplist (=)
3277 1 => No RR in iplist (!=)
3278 2 => All RRs in iplist (==)
3279 3 => Some RRs not in iplist (!==)
3280 the two bits are defined as MT_NOT and MT_ALL
8e669ac1 3281 defer_return what to return for a defer
0bcb2a0e
PH
3282
3283Returns: OK if lookup succeeded
3284 FAIL if not
3285*/
3286
3287static int
d6f6e0dc 3288one_check_dnsbl(uschar *domain, uschar *domain_txt, uschar *keydomain,
431b7361 3289 uschar *prepend, uschar *iplist, BOOL bitmask, int match_type,
d6f6e0dc 3290 int defer_return)
8e669ac1 3291{
0bcb2a0e
PH
3292dns_answer dnsa;
3293dns_scan dnss;
3294tree_node *t;
3295dnsbl_cache_block *cb;
3296int old_pool = store_pool;
d6f6e0dc
PH
3297uschar query[256]; /* DNS domain max length */
3298
3299/* Construct the specific query domainname */
3300
3301if (!string_format(query, sizeof(query), "%s.%s", prepend, domain))
3302 {
3303 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
3304 "(ignored): %s...", query);
3305 return FAIL;
3306 }
0bcb2a0e
PH
3307
3308/* Look for this query in the cache. */
3309
14b3c5bc
JH
3310if ( (t = tree_search(dnsbl_cache, query))
3311 && (cb = t->data.ptr)->expiry > time(NULL)
3312 )
3313
3314/* Previous lookup was cached */
3315
3316 {
3317 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
3318 }
0bcb2a0e
PH
3319
3320/* If not cached from a previous lookup, we must do a DNS lookup, and
3321cache the result in permanent memory. */
3322
14b3c5bc 3323else
0bcb2a0e 3324 {
e162fc97 3325 uint ttl = 3600;
14b3c5bc 3326
0bcb2a0e
PH
3327 store_pool = POOL_PERM;
3328
14b3c5bc
JH
3329 if (t)
3330 {
3331 HDEBUG(D_dnsbl) debug_printf("cached data found but past valid time; ");
3332 }
0bcb2a0e 3333
14b3c5bc
JH
3334 else
3335 { /* Set up a tree entry to cache the lookup */
3336 t = store_get(sizeof(tree_node) + Ustrlen(query));
3337 Ustrcpy(t->name, query);
3338 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
3339 (void)tree_insertnode(&dnsbl_cache, t);
3340 }
0bcb2a0e 3341
4c04137d 3342 /* Do the DNS lookup . */
0bcb2a0e
PH
3343
3344 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
3345 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
3346 cb->text_set = FALSE;
3347 cb->text = NULL;
3348 cb->rhs = NULL;
3349
3350 /* If the lookup succeeded, cache the RHS address. The code allows for
3351 more than one address - this was for complete generality and the possible
3352 use of A6 records. However, A6 records have been reduced to experimental
3353 status (August 2001) and may die out. So they may never get used at all,
3354 let alone in dnsbl records. However, leave the code here, just in case.
3355
3356 Quite apart from one A6 RR generating multiple addresses, there are DNS
3357 lists that return more than one A record, so we must handle multiple
e162fc97
JH
3358 addresses generated in that way as well.
3359
3360 Mark the cache entry with the "now" plus the minimum of the address TTLs,
3361 or some suitably far-future time if none were found. */
0bcb2a0e
PH
3362
3363 if (cb->rc == DNS_SUCCEED)
3364 {
3365 dns_record *rr;
3366 dns_address **addrp = &(cb->rhs);
3367 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
e1a3f32f 3368 rr;
0bcb2a0e
PH
3369 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
3370 {
3371 if (rr->type == T_A)
3372 {
3373 dns_address *da = dns_address_from_rr(&dnsa, rr);
e1a3f32f 3374 if (da)
0bcb2a0e
PH
3375 {
3376 *addrp = da;
3377 while (da->next != NULL) da = da->next;
3378 addrp = &(da->next);
14b3c5bc 3379 if (ttl > rr->ttl) ttl = rr->ttl;
0bcb2a0e
PH
3380 }
3381 }
3382 }
3383
3384 /* If we didn't find any A records, change the return code. This can
3385 happen when there is a CNAME record but there are no A records for what
3386 it points to. */
3387
3388 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
3389 }
3390
14b3c5bc 3391 cb->expiry = time(NULL)+ttl;
0bcb2a0e
PH
3392 store_pool = old_pool;
3393 }
3394
0bcb2a0e
PH
3395/* We now have the result of the DNS lookup, either newly done, or cached
3396from a previous call. If the lookup succeeded, check against the address
3397list if there is one. This may be a positive equality list (introduced by
3398"="), a negative equality list (introduced by "!="), a positive bitmask
3399list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
3400
3401if (cb->rc == DNS_SUCCEED)
3402 {
3403 dns_address *da = NULL;
3404 uschar *addlist = cb->rhs->address;
3405
3406 /* For A and AAAA records, there may be multiple addresses from multiple
3407 records. For A6 records (currently not expected to be used) there may be
3408 multiple addresses from a single record. */
3409
3410 for (da = cb->rhs->next; da != NULL; da = da->next)
3411 addlist = string_sprintf("%s, %s", addlist, da->address);
3412
3413 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
3414 query, addlist);
3415
3416 /* Address list check; this can be either for equality, or via a bitmask.
3417 In the latter case, all the bits must match. */
3418
3419 if (iplist != NULL)
3420 {
431b7361 3421 for (da = cb->rhs; da != NULL; da = da->next)
0bcb2a0e 3422 {
431b7361
PH
3423 int ipsep = ',';
3424 uschar ip[46];
55414b25 3425 const uschar *ptr = iplist;
431b7361
PH
3426 uschar *res;
3427
0bcb2a0e 3428 /* Handle exact matching */
431b7361 3429
0bcb2a0e
PH
3430 if (!bitmask)
3431 {
431b7361 3432 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
0bcb2a0e
PH
3433 {
3434 if (Ustrcmp(CS da->address, ip) == 0) break;
3435 }
3436 }
431b7361 3437
0bcb2a0e 3438 /* Handle bitmask matching */
431b7361 3439
0bcb2a0e
PH
3440 else
3441 {
3442 int address[4];
3443 int mask = 0;
3444
3445 /* At present, all known DNS blocking lists use A records, with
3446 IPv4 addresses on the RHS encoding the information they return. I
3447 wonder if this will linger on as the last vestige of IPv4 when IPv6
3448 is ubiquitous? Anyway, for now we use paranoia code to completely
3449 ignore IPv6 addresses. The default mask is 0, which always matches.
3450 We change this only for IPv4 addresses in the list. */
3451
431b7361 3452 if (host_aton(da->address, address) == 1) mask = address[0];
0bcb2a0e
PH
3453
3454 /* Scan the returned addresses, skipping any that are IPv6 */
3455
431b7361 3456 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
0bcb2a0e 3457 {
431b7361
PH
3458 if (host_aton(ip, address) != 1) continue;
3459 if ((address[0] & mask) == address[0]) break;
0bcb2a0e
PH
3460 }
3461 }
3462
431b7361
PH
3463 /* If either
3464
3465 (a) An IP address in an any ('=') list matched, or
3466 (b) No IP address in an all ('==') list matched
0bcb2a0e 3467
431b7361
PH
3468 then we're done searching. */
3469
3470 if (((match_type & MT_ALL) != 0) == (res == NULL)) break;
0bcb2a0e
PH
3471 }
3472
431b7361 3473 /* If da == NULL, either
0bcb2a0e 3474
431b7361
PH
3475 (a) No IP address in an any ('=') list matched, or
3476 (b) An IP address in an all ('==') list didn't match
0bcb2a0e 3477
431b7361
PH
3478 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
3479 the list. */
0bcb2a0e 3480
431b7361 3481 if ((match_type == MT_NOT || match_type == MT_ALL) != (da == NULL))
0bcb2a0e
PH
3482 {
3483 HDEBUG(D_dnsbl)
3484 {
431b7361
PH
3485 uschar *res = NULL;
3486 switch(match_type)
3487 {
3488 case 0:
3489 res = US"was no match";
3490 break;
3491 case MT_NOT:
3492 res = US"was an exclude match";
3493 break;
3494 case MT_ALL:
3495 res = US"was an IP address that did not match";
3496 break;
3497 case MT_NOT|MT_ALL:
3498 res = US"were no IP addresses that did not match";
3499 break;
3500 }
0bcb2a0e 3501 debug_printf("=> but we are not accepting this block class because\n");
431b7361
PH
3502 debug_printf("=> there %s for %s%c%s\n",
3503 res,
3504 ((match_type & MT_ALL) == 0)? "" : "=",
3505 bitmask? '&' : '=', iplist);
0bcb2a0e 3506 }
8e669ac1 3507 return FAIL;
0bcb2a0e
PH
3508 }
3509 }
3510
d6f6e0dc
PH
3511 /* Either there was no IP list, or the record matched, implying that the
3512 domain is on the list. We now want to find a corresponding TXT record. If an
3513 alternate domain is specified for the TXT record, call this function
3514 recursively to look that up; this has the side effect of re-checking that
3515 there is indeed an A record at the alternate domain. */
3516
3517 if (domain_txt != domain)
3518 return one_check_dnsbl(domain_txt, domain_txt, keydomain, prepend, NULL,
431b7361 3519 FALSE, match_type, defer_return);
d6f6e0dc
PH
3520
3521 /* If there is no alternate domain, look up a TXT record in the main domain
3522 if it has not previously been cached. */
0bcb2a0e
PH
3523
3524 if (!cb->text_set)
3525 {
3526 cb->text_set = TRUE;
3527 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
3528 {
3529 dns_record *rr;
3530 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
3531 rr != NULL;
3532 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
3533 if (rr->type == T_TXT) break;
3534 if (rr != NULL)
3535 {
3536 int len = (rr->data)[0];
3537 if (len > 511) len = 127;
3538 store_pool = POOL_PERM;
3539 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
3540 store_pool = old_pool;
3541 }
3542 }
3543 }
3544
3545 dnslist_value = addlist;
3546 dnslist_text = cb->text;
3547 return OK;
3548 }
3549
3550/* There was a problem with the DNS lookup */
3551
3552if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
3553 {