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