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