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