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